Commit | Line | Data |
---|---|---|
d871c65b | 1 | /* |
c0c0989a | 2 | * SPDX-License-Identifier: MIT |
d871c65b | 3 | * |
c0c0989a | 4 | * Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com> |
d871c65b FD |
5 | */ |
6 | ||
c0c0989a MJ |
7 | #ifndef _LTTNG_UST_EVENTS_INTERNAL_H |
8 | #define _LTTNG_UST_EVENTS_INTERNAL_H | |
9 | ||
d871c65b FD |
10 | #include <stdint.h> |
11 | ||
12 | #include <urcu/list.h> | |
13 | #include <urcu/hlist.h> | |
14 | ||
864a1eda | 15 | #include <ust-helper.h> |
d871c65b FD |
16 | #include <lttng/ust-events.h> |
17 | ||
8665f6a4 MJ |
18 | enum lttng_enabler_format_type { |
19 | LTTNG_ENABLER_FORMAT_STAR_GLOB, | |
20 | LTTNG_ENABLER_FORMAT_EVENT, | |
21 | }; | |
22 | ||
23 | /* | |
24 | * Enabler field, within whatever object is enabling an event. Target of | |
25 | * backward reference. | |
26 | */ | |
27 | struct lttng_enabler { | |
28 | enum lttng_enabler_format_type format_type; | |
29 | ||
30 | /* head list of struct lttng_ust_filter_bytecode_node */ | |
31 | struct cds_list_head filter_bytecode_head; | |
32 | /* head list of struct lttng_ust_excluder_node */ | |
33 | struct cds_list_head excluder_head; | |
34 | ||
35 | struct lttng_ust_event event_param; | |
36 | unsigned int enabled:1; | |
37 | }; | |
38 | ||
d871c65b FD |
39 | struct lttng_event_enabler { |
40 | struct lttng_enabler base; | |
41 | struct cds_list_head node; /* per-session list of enablers */ | |
42 | struct lttng_channel *chan; | |
43 | /* | |
44 | * Unused, but kept around to make it explicit that the tracer can do | |
45 | * it. | |
46 | */ | |
47 | struct lttng_ctx *ctx; | |
48 | }; | |
49 | ||
d8d2416d FD |
50 | struct lttng_event_notifier_enabler { |
51 | struct lttng_enabler base; | |
6566528b | 52 | uint64_t error_counter_index; |
d37ecb3f FD |
53 | struct cds_list_head node; /* per-app list of event_notifier enablers */ |
54 | struct cds_list_head capture_bytecode_head; | |
d8d2416d FD |
55 | struct lttng_event_notifier_group *group; /* weak ref */ |
56 | uint64_t user_token; /* User-provided token */ | |
d37ecb3f | 57 | uint64_t num_captures; |
d8d2416d FD |
58 | }; |
59 | ||
ab249ecf FD |
60 | enum lttng_ust_bytecode_node_type { |
61 | LTTNG_UST_BYTECODE_NODE_TYPE_FILTER, | |
d37ecb3f | 62 | LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE, |
ab249ecf FD |
63 | }; |
64 | ||
65 | struct lttng_ust_bytecode_node { | |
66 | enum lttng_ust_bytecode_node_type type; | |
92495593 FD |
67 | struct cds_list_head node; |
68 | struct lttng_enabler *enabler; | |
ab249ecf FD |
69 | struct { |
70 | uint32_t len; | |
71 | uint32_t reloc_offset; | |
72 | uint64_t seqnum; | |
73 | char data[]; | |
74 | } bc; | |
92495593 FD |
75 | }; |
76 | ||
77 | struct lttng_ust_excluder_node { | |
78 | struct cds_list_head node; | |
79 | struct lttng_enabler *enabler; | |
80 | /* | |
81 | * struct lttng_ust_event_exclusion had variable sized array, | |
82 | * must be last field. | |
83 | */ | |
84 | struct lttng_ust_event_exclusion excluder; | |
85 | }; | |
86 | ||
bb7ad29d MJ |
87 | /* Data structures used by the tracer. */ |
88 | ||
89 | struct tp_list_entry { | |
90 | struct lttng_ust_tracepoint_iter tp; | |
91 | struct cds_list_head head; | |
92 | }; | |
93 | ||
94 | struct lttng_ust_tracepoint_list { | |
95 | struct tp_list_entry *iter; | |
96 | struct cds_list_head head; | |
97 | }; | |
98 | ||
99 | struct tp_field_list_entry { | |
100 | struct lttng_ust_field_iter field; | |
101 | struct cds_list_head head; | |
102 | }; | |
103 | ||
104 | struct lttng_ust_field_list { | |
105 | struct tp_field_list_entry *iter; | |
106 | struct cds_list_head head; | |
107 | }; | |
108 | ||
109 | /* | |
110 | * Objects in a linked-list of enablers, owned by an event or event_notifier. | |
111 | * This is used because an event (or a event_notifier) can be enabled by more | |
112 | * than one enabler and we want a quick way to iterate over all enablers of an | |
113 | * object. | |
114 | * | |
115 | * For example, event rules "my_app:a*" and "my_app:ab*" will both match the | |
116 | * event with the name "my_app:abc". | |
117 | */ | |
118 | struct lttng_enabler_ref { | |
119 | struct cds_list_head node; /* enabler ref list */ | |
120 | struct lttng_enabler *ref; /* backward ref */ | |
121 | }; | |
122 | ||
123 | #define LTTNG_COUNTER_DIMENSION_MAX 8 | |
124 | struct lttng_counter_dimension { | |
125 | uint64_t size; | |
126 | uint64_t underflow_index; | |
127 | uint64_t overflow_index; | |
128 | uint8_t has_underflow; | |
129 | uint8_t has_overflow; | |
130 | }; | |
131 | ||
132 | struct lttng_counter { | |
133 | int objd; | |
134 | struct lttng_event_notifier_group *event_notifier_group; /* owner */ | |
135 | struct lttng_counter_transport *transport; | |
136 | struct lib_counter *counter; | |
137 | struct lttng_counter_ops *ops; | |
138 | }; | |
139 | ||
140 | struct lttng_event_notifier_group { | |
141 | int objd; | |
142 | void *owner; | |
143 | int notification_fd; | |
144 | struct cds_list_head node; /* Event notifier group handle list */ | |
145 | struct cds_list_head enablers_head; | |
146 | struct cds_list_head event_notifiers_head; /* list of event_notifiers */ | |
147 | struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */ | |
148 | struct lttng_ctx *ctx; /* contexts for filters. */ | |
149 | ||
150 | struct lttng_counter *error_counter; | |
151 | size_t error_counter_len; | |
152 | }; | |
153 | ||
154 | struct lttng_transport { | |
155 | char *name; | |
156 | struct cds_list_head node; | |
157 | struct lttng_channel_ops ops; | |
158 | const struct lttng_ust_lib_ring_buffer_config *client_config; | |
159 | }; | |
160 | ||
161 | struct lttng_counter_transport { | |
162 | char *name; | |
163 | struct cds_list_head node; | |
164 | struct lttng_counter_ops ops; | |
165 | const struct lib_counter_config *client_config; | |
166 | }; | |
167 | ||
68bb7559 MD |
168 | struct lttng_ust_event_private { |
169 | struct lttng_event *pub; /* Public event interface */ | |
170 | ||
171 | const struct lttng_event_desc *desc; | |
172 | enum lttng_ust_instrumentation instrumentation; | |
173 | struct cds_list_head node; /* Event list in session */ | |
174 | ||
175 | /* Backward references: list of lttng_enabler_ref (ref to enablers) */ | |
176 | struct cds_list_head enablers_ref_head; | |
177 | struct cds_hlist_node hlist; /* session ht of events */ | |
178 | int registered; /* has reg'd tracepoint probe */ | |
179 | }; | |
180 | ||
d871c65b FD |
181 | static inline |
182 | struct lttng_enabler *lttng_event_enabler_as_enabler( | |
183 | struct lttng_event_enabler *event_enabler) | |
184 | { | |
185 | return &event_enabler->base; | |
186 | } | |
187 | ||
d8d2416d FD |
188 | static inline |
189 | struct lttng_enabler *lttng_event_notifier_enabler_as_enabler( | |
190 | struct lttng_event_notifier_enabler *event_notifier_enabler) | |
191 | { | |
192 | return &event_notifier_enabler->base; | |
193 | } | |
d871c65b FD |
194 | |
195 | /* | |
196 | * Allocate and initialize a `struct lttng_event_enabler` object. | |
197 | * | |
198 | * On success, returns a `struct lttng_event_enabler`, | |
199 | * On memory error, returns NULL. | |
200 | */ | |
201 | LTTNG_HIDDEN | |
202 | struct lttng_event_enabler *lttng_event_enabler_create( | |
203 | enum lttng_enabler_format_type format_type, | |
204 | struct lttng_ust_event *event_param, | |
205 | struct lttng_channel *chan); | |
206 | ||
207 | /* | |
208 | * Destroy a `struct lttng_event_enabler` object. | |
209 | */ | |
210 | LTTNG_HIDDEN | |
211 | void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler); | |
212 | ||
213 | /* | |
214 | * Enable a `struct lttng_event_enabler` object and all events related to this | |
215 | * enabler. | |
216 | */ | |
217 | LTTNG_HIDDEN | |
218 | int lttng_event_enabler_enable(struct lttng_event_enabler *enabler); | |
219 | ||
220 | /* | |
221 | * Disable a `struct lttng_event_enabler` object and all events related to this | |
222 | * enabler. | |
223 | */ | |
224 | LTTNG_HIDDEN | |
225 | int lttng_event_enabler_disable(struct lttng_event_enabler *enabler); | |
226 | ||
227 | /* | |
228 | * Attach filter bytecode program to `struct lttng_event_enabler` and all | |
229 | * events related to this enabler. | |
230 | */ | |
231 | LTTNG_HIDDEN | |
a56fd376 FD |
232 | int lttng_event_enabler_attach_filter_bytecode( |
233 | struct lttng_event_enabler *enabler, | |
ab89263e | 234 | struct lttng_ust_bytecode_node **bytecode); |
d871c65b FD |
235 | |
236 | /* | |
237 | * Attach an application context to an event enabler. | |
238 | * | |
239 | * Not implemented. | |
240 | */ | |
241 | LTTNG_HIDDEN | |
242 | int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler, | |
243 | struct lttng_ust_context *ctx); | |
244 | ||
245 | /* | |
246 | * Attach exclusion list to `struct lttng_event_enabler` and all | |
247 | * events related to this enabler. | |
248 | */ | |
249 | LTTNG_HIDDEN | |
250 | int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler, | |
e9fe6aad | 251 | struct lttng_ust_excluder_node **excluder); |
d871c65b FD |
252 | |
253 | /* | |
d37ecb3f FD |
254 | * Synchronize bytecodes for the enabler and the instance (event or |
255 | * event_notifier). | |
d871c65b | 256 | * |
621c07fc | 257 | * This function goes over all bytecode programs of the enabler (event or |
d37ecb3f | 258 | * event_notifier enabler) to ensure each is linked to the provided instance. |
d871c65b FD |
259 | */ |
260 | LTTNG_HIDDEN | |
53b9d7db FD |
261 | void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc, |
262 | struct lttng_ctx **ctx, | |
621c07fc FD |
263 | struct cds_list_head *instance_bytecode_runtime_head, |
264 | struct cds_list_head *enabler_bytecode_runtime_head); | |
d871c65b | 265 | |
d8d2416d FD |
266 | /* |
267 | * Allocate and initialize a `struct lttng_event_notifier_group` object. | |
268 | * | |
269 | * On success, returns a `struct lttng_triggre_group`, | |
270 | * on memory error, returns NULL. | |
271 | */ | |
272 | LTTNG_HIDDEN | |
273 | struct lttng_event_notifier_group *lttng_event_notifier_group_create(void); | |
274 | ||
275 | /* | |
276 | * Destroy a `struct lttng_event_notifier_group` object. | |
277 | */ | |
278 | LTTNG_HIDDEN | |
279 | void lttng_event_notifier_group_destroy( | |
280 | struct lttng_event_notifier_group *event_notifier_group); | |
281 | ||
282 | /* | |
283 | * Allocate and initialize a `struct lttng_event_notifier_enabler` object. | |
284 | * | |
285 | * On success, returns a `struct lttng_event_notifier_enabler`, | |
286 | * On memory error, returns NULL. | |
287 | */ | |
288 | LTTNG_HIDDEN | |
289 | struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create( | |
290 | struct lttng_event_notifier_group *event_notifier_group, | |
291 | enum lttng_enabler_format_type format_type, | |
292 | struct lttng_ust_event_notifier *event_notifier_param); | |
293 | ||
294 | /* | |
295 | * Destroy a `struct lttng_event_notifier_enabler` object. | |
296 | */ | |
297 | LTTNG_HIDDEN | |
298 | void lttng_event_notifier_enabler_destroy( | |
299 | struct lttng_event_notifier_enabler *event_notifier_enabler); | |
300 | ||
301 | /* | |
302 | * Enable a `struct lttng_event_notifier_enabler` object and all event | |
303 | * notifiers related to this enabler. | |
304 | */ | |
305 | LTTNG_HIDDEN | |
306 | int lttng_event_notifier_enabler_enable( | |
307 | struct lttng_event_notifier_enabler *event_notifier_enabler); | |
308 | ||
309 | /* | |
310 | * Disable a `struct lttng_event_notifier_enabler` object and all event | |
311 | * notifiers related to this enabler. | |
312 | */ | |
313 | LTTNG_HIDDEN | |
314 | int lttng_event_notifier_enabler_disable( | |
315 | struct lttng_event_notifier_enabler *event_notifier_enabler); | |
316 | ||
317 | /* | |
318 | * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and | |
319 | * all event notifiers related to this enabler. | |
320 | */ | |
321 | LTTNG_HIDDEN | |
a56fd376 | 322 | int lttng_event_notifier_enabler_attach_filter_bytecode( |
d8d2416d | 323 | struct lttng_event_notifier_enabler *event_notifier_enabler, |
ab89263e | 324 | struct lttng_ust_bytecode_node **bytecode); |
d8d2416d | 325 | |
d37ecb3f FD |
326 | /* |
327 | * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and | |
328 | * all event_notifiers related to this enabler. | |
329 | */ | |
330 | LTTNG_HIDDEN | |
331 | int lttng_event_notifier_enabler_attach_capture_bytecode( | |
332 | struct lttng_event_notifier_enabler *event_notifier_enabler, | |
49cde654 | 333 | struct lttng_ust_bytecode_node **bytecode); |
d37ecb3f | 334 | |
d8d2416d FD |
335 | /* |
336 | * Attach exclusion list to `struct lttng_event_notifier_enabler` and all | |
337 | * event notifiers related to this enabler. | |
338 | */ | |
339 | LTTNG_HIDDEN | |
340 | int lttng_event_notifier_enabler_attach_exclusion( | |
341 | struct lttng_event_notifier_enabler *event_notifier_enabler, | |
e9fe6aad | 342 | struct lttng_ust_excluder_node **excluder); |
d8d2416d | 343 | |
7753d283 MJ |
344 | LTTNG_HIDDEN |
345 | void lttng_free_event_filter_runtime(struct lttng_event *event); | |
346 | ||
d8d2416d FD |
347 | LTTNG_HIDDEN |
348 | void lttng_free_event_notifier_filter_runtime( | |
349 | struct lttng_event_notifier *event_notifier); | |
350 | ||
351 | /* | |
352 | * Connect the probe on all enablers matching this event description. | |
353 | * Called on library load. | |
354 | */ | |
355 | LTTNG_HIDDEN | |
356 | int lttng_fix_pending_event_notifiers(void); | |
357 | ||
67d4e8f5 MJ |
358 | LTTNG_HIDDEN |
359 | struct lttng_counter *lttng_ust_counter_create( | |
360 | const char *counter_transport_name, | |
361 | size_t number_dimensions, const struct lttng_counter_dimension *dimensions); | |
362 | ||
bd8c1787 MJ |
363 | #ifdef HAVE_PERF_EVENT |
364 | ||
365 | LTTNG_HIDDEN | |
366 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
367 | uint64_t config, | |
368 | const char *name, | |
369 | struct lttng_ctx **ctx); | |
370 | LTTNG_HIDDEN | |
371 | int lttng_perf_counter_init(void); | |
372 | LTTNG_HIDDEN | |
373 | void lttng_perf_counter_exit(void); | |
374 | ||
375 | #else /* #ifdef HAVE_PERF_EVENT */ | |
376 | ||
377 | static inline | |
378 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
379 | uint64_t config, | |
380 | const char *name, | |
381 | struct lttng_ctx **ctx) | |
382 | { | |
383 | return -ENOSYS; | |
384 | } | |
385 | static inline | |
386 | int lttng_perf_counter_init(void) | |
387 | { | |
388 | return 0; | |
389 | } | |
390 | static inline | |
391 | void lttng_perf_counter_exit(void) | |
392 | { | |
393 | } | |
394 | #endif /* #else #ifdef HAVE_PERF_EVENT */ | |
395 | ||
7753d283 MJ |
396 | LTTNG_HIDDEN |
397 | int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list); | |
398 | LTTNG_HIDDEN | |
399 | void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list); | |
400 | ||
401 | LTTNG_HIDDEN | |
402 | int lttng_probes_get_field_list(struct lttng_ust_field_list *list); | |
403 | LTTNG_HIDDEN | |
404 | void lttng_probes_prune_field_list(struct lttng_ust_field_list *list); | |
405 | ||
406 | LTTNG_HIDDEN | |
407 | struct lttng_ust_tracepoint_iter * | |
408 | lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list); | |
409 | LTTNG_HIDDEN | |
410 | struct lttng_ust_field_iter * | |
411 | lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list); | |
412 | ||
413 | LTTNG_HIDDEN | |
414 | struct lttng_session *lttng_session_create(void); | |
415 | LTTNG_HIDDEN | |
416 | int lttng_session_enable(struct lttng_session *session); | |
417 | LTTNG_HIDDEN | |
418 | int lttng_session_disable(struct lttng_session *session); | |
419 | LTTNG_HIDDEN | |
420 | int lttng_session_statedump(struct lttng_session *session); | |
421 | LTTNG_HIDDEN | |
422 | void lttng_session_destroy(struct lttng_session *session); | |
423 | ||
424 | LTTNG_HIDDEN | |
425 | struct cds_list_head *lttng_get_sessions(void); | |
426 | ||
427 | LTTNG_HIDDEN | |
428 | void lttng_handle_pending_statedump(void *owner); | |
429 | ||
430 | LTTNG_HIDDEN | |
431 | struct lttng_channel *lttng_channel_create(struct lttng_session *session, | |
432 | const char *transport_name, | |
433 | void *buf_addr, | |
434 | size_t subbuf_size, size_t num_subbuf, | |
435 | unsigned int switch_timer_interval, | |
436 | unsigned int read_timer_interval, | |
437 | int **shm_fd, int **wait_fd, | |
438 | uint64_t **memory_map_size, | |
439 | struct lttng_channel *chan_priv_init); | |
440 | ||
441 | LTTNG_HIDDEN | |
442 | int lttng_channel_enable(struct lttng_channel *channel); | |
443 | LTTNG_HIDDEN | |
444 | int lttng_channel_disable(struct lttng_channel *channel); | |
445 | ||
446 | LTTNG_HIDDEN | |
447 | void lttng_transport_register(struct lttng_transport *transport); | |
448 | LTTNG_HIDDEN | |
449 | void lttng_transport_unregister(struct lttng_transport *transport); | |
450 | ||
451 | LTTNG_HIDDEN | |
452 | void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc); | |
453 | ||
454 | LTTNG_HIDDEN | |
455 | int lttng_fix_pending_events(void); | |
456 | ||
457 | LTTNG_HIDDEN | |
458 | struct cds_list_head *lttng_get_probe_list_head(void); | |
459 | ||
460 | LTTNG_HIDDEN | |
461 | struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session, | |
462 | const struct lttng_enum_desc *enum_desc); | |
463 | ||
d871c65b | 464 | #endif /* _LTTNG_UST_EVENTS_INTERNAL_H */ |