Commit | Line | Data |
---|---|---|
97ee3a89 DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License, version 2 only, | |
6 | * as published by the Free Software Foundation. | |
97ee3a89 DG |
7 | * |
8 | * This program is distributed in the hope that it will be useful, | |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
12 | * | |
d14d33bf AM |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
97ee3a89 DG |
16 | */ |
17 | ||
18 | #ifndef _LTT_TRACE_UST_H | |
19 | #define _LTT_TRACE_UST_H | |
20 | ||
3bd1e081 | 21 | #include <config.h> |
97ee3a89 DG |
22 | #include <limits.h> |
23 | #include <urcu/list.h> | |
bec39940 | 24 | |
97ee3a89 | 25 | #include <lttng/lttng.h> |
10a8a223 | 26 | #include <common/hashtable/hashtable.h> |
ce2a9e76 | 27 | #include <common/defaults.h> |
3bd1e081 | 28 | |
00e2e675 | 29 | #include "consumer.h" |
48842b30 | 30 | #include "ust-ctl.h" |
97ee3a89 | 31 | |
7c1d2758 JG |
32 | struct agent; |
33 | ||
18eace3b DG |
34 | struct ltt_ust_ht_key { |
35 | const char *name; | |
36 | const struct lttng_filter_bytecode *filter; | |
37 | enum lttng_ust_loglevel_type loglevel; | |
7724731b | 38 | const struct lttng_event_exclusion *exclusion; |
18eace3b DG |
39 | }; |
40 | ||
f6a9efaa DG |
41 | /* Context hash table nodes */ |
42 | struct ltt_ust_context { | |
43 | struct lttng_ust_context ctx; | |
bec39940 | 44 | struct lttng_ht_node_ulong node; |
31746f93 | 45 | struct cds_list_head list; |
97ee3a89 DG |
46 | }; |
47 | ||
48 | /* UST event */ | |
49 | struct ltt_ust_event { | |
37357452 | 50 | unsigned int enabled; |
f6a9efaa | 51 | struct lttng_ust_event attr; |
bec39940 | 52 | struct lttng_ht_node_str node; |
6b453b5e | 53 | char *filter_expression; |
53a80697 | 54 | struct lttng_ust_filter_bytecode *filter; |
40024f8a | 55 | struct lttng_event_exclusion *exclusion; |
2bdd86d4 MD |
56 | }; |
57 | ||
97ee3a89 DG |
58 | /* UST channel */ |
59 | struct ltt_ust_channel { | |
7972aab2 | 60 | uint64_t id; /* unique id per session. */ |
37357452 | 61 | unsigned int enabled; |
44d3bd01 | 62 | char name[LTTNG_UST_SYM_NAME_LEN]; |
ffe60014 | 63 | struct lttng_ust_channel_attr attr; |
bec39940 | 64 | struct lttng_ht *ctx; |
31746f93 | 65 | struct cds_list_head ctx_list; |
bec39940 DG |
66 | struct lttng_ht *events; |
67 | struct lttng_ht_node_str node; | |
1624d5b7 JD |
68 | uint64_t tracefile_size; |
69 | uint64_t tracefile_count; | |
97ee3a89 DG |
70 | }; |
71 | ||
f6a9efaa DG |
72 | /* UST domain global (LTTNG_DOMAIN_UST) */ |
73 | struct ltt_ust_domain_global { | |
bec39940 | 74 | struct lttng_ht *channels; |
7972aab2 | 75 | struct cds_list_head registry_buffer_uid_list; |
f6a9efaa DG |
76 | }; |
77 | ||
a9ad0c8f MD |
78 | struct ust_pid_tracker_node { |
79 | struct lttng_ht_node_ulong node; | |
80 | }; | |
81 | ||
82 | struct ust_pid_tracker { | |
83 | struct lttng_ht *ht; | |
84 | }; | |
85 | ||
97ee3a89 DG |
86 | /* UST session */ |
87 | struct ltt_ust_session { | |
d9bf3ca4 | 88 | uint64_t id; /* Unique identifier of session */ |
f6a9efaa | 89 | struct ltt_ust_domain_global domain_global; |
fefd409b DG |
90 | /* Hash table of agent indexed by agent domain. */ |
91 | struct lttng_ht *agents; | |
6df2e2c9 MD |
92 | /* UID/GID of the user owning the session */ |
93 | uid_t uid; | |
94 | gid_t gid; | |
14fb1ebe DG |
95 | /* Is the session active meaning has is been started or stopped. */ |
96 | unsigned int active:1; | |
00e2e675 DG |
97 | /* |
98 | * Two consumer_output object are needed where one is for the current | |
99 | * output object and the second one is the temporary object used to store | |
100 | * URI being set by the lttng_set_consumer_uri call. Once | |
101 | * lttng_enable_consumer is called, the two pointers are swapped. | |
102 | */ | |
103 | struct consumer_output *consumer; | |
104 | struct consumer_output *tmp_consumer; | |
f3f0db50 DG |
105 | /* Sequence number for filters so the tracer knows the ordering. */ |
106 | uint64_t filter_seq_num; | |
7972aab2 DG |
107 | /* This indicates which type of buffer this session is set for. */ |
108 | enum lttng_buffer_type buffer_type; | |
109 | /* If set to 1, the buffer_type can not be changed anymore. */ | |
110 | int buffer_type_changed; | |
111 | /* For per UID buffer, every buffer reg object is kept of this session */ | |
112 | struct cds_list_head buffer_reg_uid_list; | |
113 | /* Next channel ID available for a newly registered channel. */ | |
114 | uint64_t next_channel_id; | |
115 | /* Once this value reaches UINT32_MAX, no more id can be allocated. */ | |
116 | uint64_t used_channel_id; | |
2bba9e53 DG |
117 | /* Tell or not if the session has to output the traces. */ |
118 | unsigned int output_traces; | |
27babd3a | 119 | unsigned int snapshot_mode; |
85076754 | 120 | unsigned int has_non_default_channel; |
ecc48a90 | 121 | unsigned int live_timer_interval; /* usec */ |
84ad93e8 DG |
122 | |
123 | /* Metadata channel attributes. */ | |
124 | struct lttng_ust_channel_attr metadata_attr; | |
d7ba1388 MD |
125 | |
126 | /* | |
127 | * Path where to keep the shared memory files. | |
128 | */ | |
3d071855 | 129 | char root_shm_path[PATH_MAX]; |
d7ba1388 | 130 | char shm_path[PATH_MAX]; |
a9ad0c8f MD |
131 | |
132 | struct ust_pid_tracker pid_tracker; | |
97ee3a89 DG |
133 | }; |
134 | ||
7972aab2 DG |
135 | /* |
136 | * Validate that the id has reached the maximum allowed or not. | |
137 | * | |
138 | * Return 0 if NOT else 1. | |
139 | */ | |
140 | static inline int trace_ust_is_max_id(uint64_t id) | |
141 | { | |
142 | return (id == UINT64_MAX) ? 1 : 0; | |
143 | } | |
144 | ||
145 | /* | |
146 | * Return next available channel id and increment the used counter. The | |
147 | * trace_ust_is_max_id function MUST be called before in order to validate if | |
148 | * the maximum number of IDs have been reached. If not, it is safe to call this | |
149 | * function. | |
150 | * | |
151 | * Return a unique channel ID. If max is reached, the used_channel_id counter | |
152 | * is returned. | |
153 | */ | |
154 | static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s) | |
155 | { | |
156 | if (trace_ust_is_max_id(s->used_channel_id)) { | |
157 | return s->used_channel_id; | |
158 | } | |
159 | ||
160 | s->used_channel_id++; | |
161 | return s->next_channel_id++; | |
162 | } | |
163 | ||
74d0b642 | 164 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 165 | |
18eace3b DG |
166 | int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key); |
167 | int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
168 | const void *_key); | |
169 | ||
97ee3a89 DG |
170 | /* |
171 | * Lookup functions. NULL is returned if not found. | |
172 | */ | |
18eace3b | 173 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
10646003 JI |
174 | char *name, struct lttng_filter_bytecode *filter, int loglevel, |
175 | struct lttng_event_exclusion *exclusion); | |
bec39940 | 176 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 177 | char *name); |
fefd409b DG |
178 | struct agent *trace_ust_find_agent(struct ltt_ust_session *session, |
179 | enum lttng_domain_type domain_type); | |
97ee3a89 DG |
180 | |
181 | /* | |
182 | * Create functions malloc() the data structure. | |
183 | */ | |
d9bf3ca4 | 184 | struct ltt_ust_session *trace_ust_create_session(uint64_t session_id); |
dec56f6c | 185 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr); |
025faf73 | 186 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
6b453b5e | 187 | char *filter_expression, |
561c6897 JI |
188 | struct lttng_filter_bytecode *filter, |
189 | struct lttng_event_exclusion *exclusion); | |
55cc08a6 DG |
190 | struct ltt_ust_context *trace_ust_create_context( |
191 | struct lttng_event_context *ctx); | |
aa3514e9 MD |
192 | int trace_ust_match_context(struct ltt_ust_context *uctx, |
193 | struct lttng_event_context *ctx); | |
d5979e4a DG |
194 | void trace_ust_delete_channel(struct lttng_ht *ht, |
195 | struct ltt_ust_channel *channel); | |
97ee3a89 DG |
196 | |
197 | /* | |
198 | * Destroy functions free() the data structure and remove from linked list if | |
199 | * it's applies. | |
200 | */ | |
201 | void trace_ust_destroy_session(struct ltt_ust_session *session); | |
97ee3a89 DG |
202 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel); |
203 | void trace_ust_destroy_event(struct ltt_ust_event *event); | |
204 | ||
a9ad0c8f MD |
205 | int trace_ust_track_pid(struct ltt_ust_session *session, int pid); |
206 | int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid); | |
207 | ||
b4650bd0 MD |
208 | int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid); |
209 | ||
a5dfbb9d MD |
210 | ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session, |
211 | int32_t **_pids); | |
212 | ||
74d0b642 | 213 | #else /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 214 | |
37a86c61 DG |
215 | static inline int trace_ust_ht_match_event(struct cds_lfht_node *node, |
216 | const void *_key) | |
217 | { | |
218 | return 0; | |
219 | } | |
220 | static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
221 | const void *_key) | |
222 | { | |
223 | return 0; | |
224 | } | |
3bd1e081 | 225 | static inline |
bec39940 | 226 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 227 | char *name) |
3bd1e081 MD |
228 | { |
229 | return NULL; | |
230 | } | |
f6a9efaa | 231 | |
3bd1e081 | 232 | static inline |
dec56f6c | 233 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id) |
3bd1e081 MD |
234 | { |
235 | return NULL; | |
236 | } | |
237 | static inline | |
dec56f6c | 238 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr) |
3bd1e081 MD |
239 | { |
240 | return NULL; | |
241 | } | |
242 | static inline | |
025faf73 | 243 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
6b453b5e | 244 | const char *filter_expression, |
561c6897 JI |
245 | struct lttng_filter_bytecode *filter, |
246 | struct lttng_event_exclusion *exclusion) | |
3bd1e081 MD |
247 | { |
248 | return NULL; | |
249 | } | |
3bd1e081 MD |
250 | static inline |
251 | void trace_ust_destroy_session(struct ltt_ust_session *session) | |
252 | { | |
253 | } | |
48842b30 | 254 | |
3bd1e081 MD |
255 | static inline |
256 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel) | |
257 | { | |
258 | } | |
48842b30 | 259 | |
3bd1e081 MD |
260 | static inline |
261 | void trace_ust_destroy_event(struct ltt_ust_event *event) | |
262 | { | |
263 | } | |
34378f76 DG |
264 | static inline |
265 | struct ltt_ust_context *trace_ust_create_context( | |
266 | struct lttng_event_context *ctx) | |
267 | { | |
268 | return NULL; | |
269 | } | |
aa3514e9 MD |
270 | static inline |
271 | int trace_ust_match_context(struct ltt_ust_context *uctx, | |
272 | struct lttng_event_context *ctx) | |
273 | { | |
274 | return 0; | |
275 | } | |
37a86c61 | 276 | static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
10646003 JI |
277 | char *name, struct lttng_filter_bytecode *filter, int loglevel, |
278 | struct lttng_event_exclusion *exclusion) | |
37a86c61 DG |
279 | { |
280 | return NULL; | |
281 | } | |
d5979e4a DG |
282 | static inline |
283 | void trace_ust_delete_channel(struct lttng_ht *ht, | |
284 | struct ltt_ust_channel *channel) | |
285 | { | |
286 | return; | |
287 | } | |
fefd409b DG |
288 | static inline |
289 | struct agent *trace_ust_find_agent(struct ltt_ust_session *session, | |
290 | enum lttng_domain_type domain_type) | |
291 | { | |
292 | return NULL; | |
293 | } | |
a9ad0c8f MD |
294 | static inline |
295 | int trace_ust_track_pid(struct ltt_ust_session *session, int pid) | |
296 | { | |
297 | return 0; | |
298 | } | |
299 | static inline | |
300 | int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid) | |
301 | { | |
302 | return 0; | |
303 | } | |
b4650bd0 MD |
304 | static inline |
305 | int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid) | |
306 | { | |
307 | return 0; | |
308 | } | |
3646a051 | 309 | static inline |
a5dfbb9d MD |
310 | ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session, |
311 | int32_t **_pids) | |
312 | { | |
313 | return -1; | |
314 | } | |
74d0b642 | 315 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 316 | |
97ee3a89 | 317 | #endif /* _LTT_TRACE_UST_H */ |