Commit | Line | Data |
---|---|---|
97ee3a89 | 1 | /* |
ab5be9fa MJ |
2 | * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca> |
3 | * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
97ee3a89 | 4 | * |
ab5be9fa | 5 | * SPDX-License-Identifier: GPL-2.0-only |
97ee3a89 | 6 | * |
97ee3a89 DG |
7 | */ |
8 | ||
9 | #ifndef _LTT_TRACE_UST_H | |
10 | #define _LTT_TRACE_UST_H | |
11 | ||
12 | #include <limits.h> | |
13 | #include <urcu/list.h> | |
bec39940 | 14 | |
ce2a9e76 | 15 | #include <common/defaults.h> |
159b042f JG |
16 | #include <common/hashtable/hashtable.h> |
17 | #include <common/tracker.h> | |
18 | #include <lttng/lttng.h> | |
3bd1e081 | 19 | |
00e2e675 | 20 | #include "consumer.h" |
75018ab6 | 21 | #include "lttng-ust-ctl.h" |
97ee3a89 | 22 | |
7c1d2758 JG |
23 | struct agent; |
24 | ||
18eace3b DG |
25 | struct ltt_ust_ht_key { |
26 | const char *name; | |
27 | const struct lttng_filter_bytecode *filter; | |
2106efa0 | 28 | enum lttng_ust_loglevel_type loglevel_type; |
b953b8cd | 29 | int loglevel_value; |
7724731b | 30 | const struct lttng_event_exclusion *exclusion; |
18eace3b DG |
31 | }; |
32 | ||
f6a9efaa DG |
33 | /* Context hash table nodes */ |
34 | struct ltt_ust_context { | |
bdf64013 | 35 | struct lttng_ust_context_attr ctx; |
bec39940 | 36 | struct lttng_ht_node_ulong node; |
31746f93 | 37 | struct cds_list_head list; |
97ee3a89 DG |
38 | }; |
39 | ||
40 | /* UST event */ | |
41 | struct ltt_ust_event { | |
37357452 | 42 | unsigned int enabled; |
f6a9efaa | 43 | struct lttng_ust_event attr; |
bec39940 | 44 | struct lttng_ht_node_str node; |
6b453b5e | 45 | char *filter_expression; |
51755dc8 | 46 | struct lttng_filter_bytecode *filter; |
40024f8a | 47 | struct lttng_event_exclusion *exclusion; |
5b37cc51 JG |
48 | /* |
49 | * An internal event is an event which was created by the session daemon | |
50 | * through which, for example, events emitted in Agent domains are | |
51 | * "funelled". This is used to hide internal events from external | |
52 | * clients as they should never be modified by the external world. | |
53 | */ | |
88f06f15 | 54 | bool internal; |
2bdd86d4 MD |
55 | }; |
56 | ||
97ee3a89 DG |
57 | /* UST channel */ |
58 | struct ltt_ust_channel { | |
7972aab2 | 59 | uint64_t id; /* unique id per session. */ |
37357452 | 60 | unsigned int enabled; |
51755dc8 JG |
61 | /* |
62 | * A UST channel can be part of a userspace sub-domain such as JUL, | |
63 | * Log4j, Python. | |
64 | */ | |
65 | enum lttng_domain_type domain; | |
44d3bd01 | 66 | char name[LTTNG_UST_SYM_NAME_LEN]; |
ffe60014 | 67 | struct lttng_ust_channel_attr attr; |
bec39940 | 68 | struct lttng_ht *ctx; |
31746f93 | 69 | struct cds_list_head ctx_list; |
bec39940 DG |
70 | struct lttng_ht *events; |
71 | struct lttng_ht_node_str node; | |
1624d5b7 JD |
72 | uint64_t tracefile_size; |
73 | uint64_t tracefile_count; | |
fb83fe64 JD |
74 | uint64_t per_pid_closed_app_discarded; |
75 | uint64_t per_pid_closed_app_lost; | |
e9404c27 | 76 | uint64_t monitor_timer_interval; |
97ee3a89 DG |
77 | }; |
78 | ||
f6a9efaa DG |
79 | /* UST domain global (LTTNG_DOMAIN_UST) */ |
80 | struct ltt_ust_domain_global { | |
bec39940 | 81 | struct lttng_ht *channels; |
7972aab2 | 82 | struct cds_list_head registry_buffer_uid_list; |
f6a9efaa DG |
83 | }; |
84 | ||
55c9e7ca | 85 | struct ust_id_tracker_node { |
a9ad0c8f MD |
86 | struct lttng_ht_node_ulong node; |
87 | }; | |
88 | ||
55c9e7ca | 89 | struct ust_id_tracker { |
a9ad0c8f MD |
90 | struct lttng_ht *ht; |
91 | }; | |
92 | ||
97ee3a89 DG |
93 | /* UST session */ |
94 | struct ltt_ust_session { | |
d9bf3ca4 | 95 | uint64_t id; /* Unique identifier of session */ |
f6a9efaa | 96 | struct ltt_ust_domain_global domain_global; |
fefd409b DG |
97 | /* Hash table of agent indexed by agent domain. */ |
98 | struct lttng_ht *agents; | |
6df2e2c9 MD |
99 | /* UID/GID of the user owning the session */ |
100 | uid_t uid; | |
101 | gid_t gid; | |
14fb1ebe DG |
102 | /* Is the session active meaning has is been started or stopped. */ |
103 | unsigned int active:1; | |
00e2e675 | 104 | struct consumer_output *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 | 131 | |
82b69413 JG |
132 | /* Current trace chunk of the ltt_session. */ |
133 | struct lttng_trace_chunk *current_trace_chunk; | |
55c9e7ca JR |
134 | |
135 | /* Trackers used for actual lookup on app registration. */ | |
136 | struct ust_id_tracker vpid_tracker; | |
137 | struct ust_id_tracker vuid_tracker; | |
138 | struct ust_id_tracker vgid_tracker; | |
139 | ||
140 | /* Tracker list of keys requested by users. */ | |
159b042f JG |
141 | struct process_attr_tracker *tracker_vpid; |
142 | struct process_attr_tracker *tracker_vuid; | |
143 | struct process_attr_tracker *tracker_vgid; | |
97ee3a89 DG |
144 | }; |
145 | ||
7972aab2 DG |
146 | /* |
147 | * Validate that the id has reached the maximum allowed or not. | |
148 | * | |
149 | * Return 0 if NOT else 1. | |
150 | */ | |
151 | static inline int trace_ust_is_max_id(uint64_t id) | |
152 | { | |
153 | return (id == UINT64_MAX) ? 1 : 0; | |
154 | } | |
155 | ||
156 | /* | |
157 | * Return next available channel id and increment the used counter. The | |
158 | * trace_ust_is_max_id function MUST be called before in order to validate if | |
159 | * the maximum number of IDs have been reached. If not, it is safe to call this | |
160 | * function. | |
161 | * | |
162 | * Return a unique channel ID. If max is reached, the used_channel_id counter | |
163 | * is returned. | |
164 | */ | |
165 | static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s) | |
166 | { | |
167 | if (trace_ust_is_max_id(s->used_channel_id)) { | |
168 | return s->used_channel_id; | |
169 | } | |
170 | ||
171 | s->used_channel_id++; | |
172 | return s->next_channel_id++; | |
173 | } | |
174 | ||
74d0b642 | 175 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 176 | |
18eace3b DG |
177 | int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key); |
178 | int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
179 | const void *_key); | |
180 | ||
97ee3a89 DG |
181 | /* |
182 | * Lookup functions. NULL is returned if not found. | |
183 | */ | |
18eace3b | 184 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
2106efa0 | 185 | char *name, struct lttng_filter_bytecode *filter, |
b953b8cd PP |
186 | enum lttng_ust_loglevel_type loglevel_type, int loglevel_value, |
187 | struct lttng_event_exclusion *exclusion); | |
bec39940 | 188 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
df4f5a87 | 189 | const char *name); |
fefd409b DG |
190 | struct agent *trace_ust_find_agent(struct ltt_ust_session *session, |
191 | enum lttng_domain_type domain_type); | |
97ee3a89 DG |
192 | |
193 | /* | |
194 | * Create functions malloc() the data structure. | |
195 | */ | |
d9bf3ca4 | 196 | struct ltt_ust_session *trace_ust_create_session(uint64_t session_id); |
51755dc8 JG |
197 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr, |
198 | enum lttng_domain_type domain); | |
39687410 | 199 | enum lttng_error_code trace_ust_create_event(struct lttng_event *ev, |
6b453b5e | 200 | char *filter_expression, |
561c6897 | 201 | struct lttng_filter_bytecode *filter, |
88f06f15 | 202 | struct lttng_event_exclusion *exclusion, |
39687410 | 203 | bool internal_event, struct ltt_ust_event **ust_event); |
55cc08a6 | 204 | struct ltt_ust_context *trace_ust_create_context( |
df4f5a87 JG |
205 | const struct lttng_event_context *ctx); |
206 | int trace_ust_match_context(const struct ltt_ust_context *uctx, | |
207 | const struct lttng_event_context *ctx); | |
d5979e4a DG |
208 | void trace_ust_delete_channel(struct lttng_ht *ht, |
209 | struct ltt_ust_channel *channel); | |
97ee3a89 DG |
210 | |
211 | /* | |
212 | * Destroy functions free() the data structure and remove from linked list if | |
213 | * it's applies. | |
214 | */ | |
215 | void trace_ust_destroy_session(struct ltt_ust_session *session); | |
97ee3a89 DG |
216 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel); |
217 | void trace_ust_destroy_event(struct ltt_ust_event *event); | |
bdf64013 | 218 | void trace_ust_destroy_context(struct ltt_ust_context *ctx); |
d070c424 | 219 | void trace_ust_free_session(struct ltt_ust_session *session); |
97ee3a89 | 220 | |
159b042f | 221 | int trace_ust_id_tracker_lookup(enum lttng_process_attr process_attr, |
55c9e7ca | 222 | struct ltt_ust_session *session, |
159b042f JG |
223 | int id); |
224 | enum lttng_error_code trace_ust_process_attr_tracker_set_tracking_policy( | |
55c9e7ca | 225 | struct ltt_ust_session *session, |
159b042f JG |
226 | enum lttng_process_attr process_attr, |
227 | enum lttng_tracking_policy policy); | |
228 | enum lttng_error_code trace_ust_process_attr_tracker_inclusion_set_add_value( | |
55c9e7ca | 229 | struct ltt_ust_session *session, |
159b042f JG |
230 | enum lttng_process_attr process_attr, |
231 | const struct process_attr_value *value); | |
232 | enum lttng_error_code trace_ust_process_attr_tracker_inclusion_set_remove_value( | |
233 | struct ltt_ust_session *session, | |
234 | enum lttng_process_attr process_attr, | |
235 | const struct process_attr_value *value); | |
236 | const struct process_attr_tracker *trace_ust_get_process_attr_tracker( | |
55c9e7ca | 237 | struct ltt_ust_session *session, |
159b042f | 238 | enum lttng_process_attr process_attr); |
a5dfbb9d | 239 | |
74d0b642 | 240 | #else /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 241 | |
37a86c61 DG |
242 | static inline int trace_ust_ht_match_event(struct cds_lfht_node *node, |
243 | const void *_key) | |
244 | { | |
245 | return 0; | |
246 | } | |
247 | static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
248 | const void *_key) | |
249 | { | |
250 | return 0; | |
251 | } | |
3bd1e081 | 252 | static inline |
bec39940 | 253 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
df4f5a87 | 254 | const char *name) |
3bd1e081 MD |
255 | { |
256 | return NULL; | |
257 | } | |
f6a9efaa | 258 | |
3bd1e081 | 259 | static inline |
dec56f6c | 260 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id) |
3bd1e081 MD |
261 | { |
262 | return NULL; | |
263 | } | |
264 | static inline | |
51755dc8 JG |
265 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr, |
266 | enum lttng_domain_type domain) | |
3bd1e081 MD |
267 | { |
268 | return NULL; | |
269 | } | |
270 | static inline | |
39687410 | 271 | enum lttng_error_code trace_ust_create_event(struct lttng_event *ev, |
6b453b5e | 272 | const char *filter_expression, |
561c6897 | 273 | struct lttng_filter_bytecode *filter, |
88f06f15 | 274 | struct lttng_event_exclusion *exclusion, |
39687410 | 275 | bool internal_event, struct ltt_ust_event **ust_event) |
3bd1e081 | 276 | { |
39687410 | 277 | return LTTNG_ERR_NO_UST; |
3bd1e081 | 278 | } |
3bd1e081 MD |
279 | static inline |
280 | void trace_ust_destroy_session(struct ltt_ust_session *session) | |
281 | { | |
282 | } | |
48842b30 | 283 | |
3bd1e081 MD |
284 | static inline |
285 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel) | |
286 | { | |
287 | } | |
48842b30 | 288 | |
3bd1e081 MD |
289 | static inline |
290 | void trace_ust_destroy_event(struct ltt_ust_event *event) | |
291 | { | |
292 | } | |
d070c424 MD |
293 | |
294 | static inline | |
295 | void trace_ust_free_session(struct ltt_ust_session *session) | |
296 | { | |
297 | } | |
298 | ||
34378f76 DG |
299 | static inline |
300 | struct ltt_ust_context *trace_ust_create_context( | |
df4f5a87 | 301 | const struct lttng_event_context *ctx) |
34378f76 DG |
302 | { |
303 | return NULL; | |
304 | } | |
aa3514e9 | 305 | static inline |
df4f5a87 JG |
306 | int trace_ust_match_context(const struct ltt_ust_context *uctx, |
307 | const struct lttng_event_context *ctx) | |
aa3514e9 MD |
308 | { |
309 | return 0; | |
310 | } | |
b953b8cd PP |
311 | static inline |
312 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, | |
2106efa0 | 313 | char *name, struct lttng_filter_bytecode *filter, |
b953b8cd PP |
314 | enum lttng_ust_loglevel_type loglevel_type, int loglevel_value, |
315 | struct lttng_event_exclusion *exclusion) | |
37a86c61 DG |
316 | { |
317 | return NULL; | |
318 | } | |
d5979e4a DG |
319 | static inline |
320 | void trace_ust_delete_channel(struct lttng_ht *ht, | |
321 | struct ltt_ust_channel *channel) | |
322 | { | |
323 | return; | |
324 | } | |
fefd409b DG |
325 | static inline |
326 | struct agent *trace_ust_find_agent(struct ltt_ust_session *session, | |
327 | enum lttng_domain_type domain_type) | |
328 | { | |
329 | return NULL; | |
330 | } | |
159b042f JG |
331 | static inline int trace_ust_id_tracker_lookup( |
332 | enum lttng_process_attr process_attr, | |
55c9e7ca | 333 | struct ltt_ust_session *session, |
159b042f | 334 | int id) |
a9ad0c8f MD |
335 | { |
336 | return 0; | |
337 | } | |
159b042f JG |
338 | static inline enum lttng_error_code |
339 | trace_ust_process_attr_tracker_set_tracking_policy( | |
55c9e7ca | 340 | struct ltt_ust_session *session, |
159b042f JG |
341 | enum lttng_process_attr process_attr, |
342 | enum lttng_tracking_policy policy) | |
a9ad0c8f | 343 | { |
159b042f | 344 | return LTTNG_OK; |
a9ad0c8f | 345 | } |
159b042f JG |
346 | static inline enum lttng_error_code |
347 | trace_ust_process_attr_tracker_inclusion_set_add_value( | |
55c9e7ca | 348 | struct ltt_ust_session *session, |
159b042f JG |
349 | enum lttng_process_attr process_attr, |
350 | const struct process_attr_value *value) | |
b4650bd0 | 351 | { |
159b042f | 352 | return LTTNG_OK; |
b4650bd0 | 353 | } |
159b042f JG |
354 | static inline enum lttng_error_code |
355 | trace_ust_process_attr_tracker_inclusion_set_remove_value( | |
55c9e7ca | 356 | struct ltt_ust_session *session, |
159b042f JG |
357 | enum lttng_process_attr process_attr, |
358 | const struct process_attr_value *value) | |
a5dfbb9d | 359 | { |
159b042f | 360 | return LTTNG_OK; |
a5dfbb9d | 361 | } |
159b042f JG |
362 | static inline const struct process_attr_tracker * |
363 | trace_ust_get_process_attr_tracker(struct ltt_ust_session *session, | |
364 | enum lttng_process_attr process_attr) | |
365 | { | |
366 | return NULL; | |
367 | } | |
368 | ||
74d0b642 | 369 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 370 | |
97ee3a89 | 371 | #endif /* _LTT_TRACE_UST_H */ |