cleanup: Namespace public utils macros
[lttng-ust.git] / include / lttng / ust-events.h
1 /*
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * Holds LTTng per-session event registry.
7 */
8
9 #ifndef _LTTNG_UST_EVENTS_H
10 #define _LTTNG_UST_EVENTS_H
11
12 #include <urcu/list.h>
13 #include <urcu/hlist.h>
14 #include <stddef.h>
15 #include <stdint.h>
16 #include <lttng/ust-abi.h>
17 #include <lttng/ust-tracer.h>
18 #include <lttng/ust-endian.h>
19 #include <float.h>
20 #include <errno.h>
21 #include <urcu/ref.h>
22 #include <pthread.h>
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 #define LTTNG_UST_UUID_LEN 16
29
30 /*
31 * Tracepoint provider version. Compatibility based on the major number.
32 * Older tracepoint providers can always register to newer lttng-ust
33 * library, but the opposite is rejected: a newer tracepoint provider is
34 * rejected by an older lttng-ust library.
35 */
36 #define LTTNG_UST_PROVIDER_MAJOR 2
37 #define LTTNG_UST_PROVIDER_MINOR 0
38
39 struct lttng_ust_channel_buffer;
40 struct lttng_ust_session;
41 struct lttng_ust_lib_ring_buffer_ctx;
42 struct lttng_ust_event_field;
43
44 /*
45 * Data structures used by tracepoint event declarations, and by the
46 * tracer.
47 */
48
49 /* Type description */
50
51 enum lttng_ust_type {
52 lttng_ust_type_integer,
53 lttng_ust_type_string,
54 lttng_ust_type_float,
55 lttng_ust_type_dynamic,
56 lttng_ust_type_enum,
57 lttng_ust_type_array,
58 lttng_ust_type_sequence,
59 lttng_ust_type_struct,
60 NR_LTTNG_UST_TYPE,
61 };
62
63 enum lttng_ust_string_encoding {
64 lttng_ust_string_encoding_none = 0,
65 lttng_ust_string_encoding_UTF8 = 1,
66 lttng_ust_string_encoding_ASCII = 2,
67 NR_LTTNG_UST_STRING_ENCODING,
68 };
69
70 struct lttng_ust_enum_value {
71 unsigned long long value;
72 unsigned int signedness:1;
73 };
74
75 enum lttng_ust_enum_entry_option {
76 LTTNG_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
77 };
78
79 /*
80 * Enumeration entry description
81 *
82 * IMPORTANT: this structure is part of the ABI between the probe and
83 * UST. Fields need to be only added at the end, never reordered, never
84 * removed.
85 *
86 * The field @struct_size should be used to determine the size of the
87 * structure. It should be queried before using additional fields added
88 * at the end of the structure.
89 */
90
91 struct lttng_ust_enum_entry {
92 uint32_t struct_size;
93
94 struct lttng_ust_enum_value start, end; /* start and end are inclusive */
95 const char *string;
96 unsigned int options;
97
98 /* End of base ABI. Fields below should be used after checking struct_size. */
99 };
100
101 /*
102 * struct lttng_ust_type_common is fixed-size. Its children inherits
103 * from it by embedding struct lttng_ust_type_common as its first field.
104 */
105 struct lttng_ust_type_common {
106 enum lttng_ust_type type;
107 };
108
109 struct lttng_ust_type_integer {
110 struct lttng_ust_type_common parent;
111 uint32_t struct_size;
112 unsigned int size; /* in bits */
113 unsigned short alignment; /* in bits */
114 unsigned int signedness:1;
115 unsigned int reverse_byte_order:1;
116 unsigned int base; /* 2, 8, 10, 16, for pretty print */
117 };
118
119 #define lttng_ust_type_integer_define(_type, _byte_order, _base) \
120 ((struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(struct lttng_ust_type_integer, { \
121 .parent = { \
122 .type = lttng_ust_type_integer, \
123 }, \
124 .struct_size = sizeof(struct lttng_ust_type_integer), \
125 .size = sizeof(_type) * CHAR_BIT, \
126 .alignment = lttng_alignof(_type) * CHAR_BIT, \
127 .signedness = lttng_ust_is_signed_type(_type), \
128 .reverse_byte_order = _byte_order != BYTE_ORDER, \
129 .base = _base, \
130 }))
131
132 struct lttng_ust_type_float {
133 struct lttng_ust_type_common parent;
134 uint32_t struct_size;
135 unsigned int exp_dig; /* exponent digits, in bits */
136 unsigned int mant_dig; /* mantissa digits, in bits */
137 unsigned short alignment; /* in bits */
138 unsigned int reverse_byte_order:1;
139 };
140
141 /*
142 * Only float and double are supported. long double is not supported at
143 * the moment.
144 */
145 #define lttng_ust_float_mant_dig(_type) \
146 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
147 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
148 : 0))
149
150 #define lttng_ust_type_float_define(_type) \
151 ((struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(struct lttng_ust_type_float, { \
152 .parent = { \
153 .type = lttng_ust_type_float, \
154 }, \
155 .struct_size = sizeof(struct lttng_ust_type_float), \
156 .exp_dig = sizeof(_type) * CHAR_BIT \
157 - lttng_ust_float_mant_dig(_type), \
158 .mant_dig = lttng_ust_float_mant_dig(_type), \
159 .alignment = lttng_alignof(_type) * CHAR_BIT, \
160 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
161 }))
162
163
164 struct lttng_ust_type_string {
165 struct lttng_ust_type_common parent;
166 uint32_t struct_size;
167 enum lttng_ust_string_encoding encoding;
168 };
169
170 struct lttng_ust_type_enum {
171 struct lttng_ust_type_common parent;
172 uint32_t struct_size;
173 struct lttng_ust_enum_desc *desc; /* Enumeration mapping */
174 struct lttng_ust_type_common *container_type;
175 };
176
177 struct lttng_ust_type_array {
178 struct lttng_ust_type_common parent;
179 uint32_t struct_size;
180 struct lttng_ust_type_common *elem_type;
181 unsigned int length; /* Num. elems. */
182 unsigned int alignment;
183 enum lttng_ust_string_encoding encoding;
184 };
185
186 struct lttng_ust_type_sequence {
187 struct lttng_ust_type_common parent;
188 uint32_t struct_size;
189 const char *length_name; /* Length field name. */
190 struct lttng_ust_type_common *elem_type;
191 unsigned int alignment; /* Alignment before elements. */
192 enum lttng_ust_string_encoding encoding;
193 };
194
195 struct lttng_ust_type_struct {
196 struct lttng_ust_type_common parent;
197 uint32_t struct_size;
198 unsigned int nr_fields;
199 struct lttng_ust_event_field **fields; /* Array of pointers to fields. */
200 unsigned int alignment;
201 };
202
203 /*
204 * Enumeration description
205 *
206 * IMPORTANT: this structure is part of the ABI between the probe and
207 * UST. Fields need to be only added at the end, never reordered, never
208 * removed.
209 *
210 * The field @struct_size should be used to determine the size of the
211 * structure. It should be queried before using additional fields added
212 * at the end of the structure.
213 */
214
215 struct lttng_ust_enum_desc {
216 uint32_t struct_size;
217
218 const char *name;
219 struct lttng_ust_enum_entry **entries;
220 unsigned int nr_entries;
221
222 /* End of base ABI. Fields below should be used after checking struct_size. */
223 };
224
225 /*
226 * Event field description
227 *
228 * IMPORTANT: this structure is part of the ABI between the probe and
229 * UST. Fields need to be only added at the end, never reordered, never
230 * removed.
231 *
232 * The field @struct_size should be used to determine the size of the
233 * structure. It should be queried before using additional fields added
234 * at the end of the structure.
235 */
236
237 struct lttng_ust_event_field {
238 uint32_t struct_size;
239
240 const char *name;
241 struct lttng_ust_type_common *type;
242 unsigned int nowrite:1, /* do not write into trace */
243 nofilter:1; /* do not consider for filter */
244
245 /* End of base ABI. Fields below should be used after checking struct_size. */
246 };
247
248
249 /*
250 * IMPORTANT: this structure is part of the ABI between the probe and
251 * UST. Fields need to be only added at the end, never reordered, never
252 * removed.
253 *
254 * The field @struct_size should be used to determine the size of the
255 * structure. It should be queried before using additional fields added
256 * at the end of the structure.
257 */
258 struct lttng_ust_event_desc {
259 uint32_t struct_size; /* Size of this structure. */
260
261 const char *event_name;
262 struct lttng_ust_probe_desc *probe_desc;
263 void (*probe_callback)(void);
264 struct lttng_event_ctx *ctx; /* context */
265 struct lttng_ust_event_field **fields; /* event payload */
266 unsigned int nr_fields;
267 const int **loglevel;
268 const char *signature; /* Argument types/names received */
269 const char **model_emf_uri;
270
271 /* End of base ABI. Fields below should be used after checking struct_size. */
272 };
273
274 /*
275 * IMPORTANT: this structure is part of the ABI between the probe and
276 * UST. Fields need to be only added at the end, never reordered, never
277 * removed.
278 *
279 * The field @struct_size should be used to determine the size of the
280 * structure. It should be queried before using additional fields added
281 * at the end of the structure.
282 */
283 struct lttng_ust_probe_desc {
284 uint32_t struct_size; /* Size of this structure. */
285
286 const char *provider_name;
287 struct lttng_ust_event_desc **event_desc;
288 unsigned int nr_events;
289 struct cds_list_head head; /* chain registered probes */
290 struct cds_list_head lazy_init_head;
291 int lazy; /* lazy registration */
292 uint32_t major;
293 uint32_t minor;
294
295 /* End of base ABI. Fields below should be used after checking struct_size. */
296 };
297
298 /* Data structures used by the tracer. */
299
300 /*
301 * lttng_event structure is referred to by the tracing fast path. It
302 * must be kept small.
303 *
304 * IMPORTANT: this structure is part of the ABI between the probe and
305 * UST. Fields need to be only added at the end, never reordered, never
306 * removed.
307 */
308
309 struct lttng_ust_ctx;
310 struct lttng_ust_event_common_private;
311
312 enum lttng_ust_event_type {
313 LTTNG_UST_EVENT_TYPE_RECORDER = 0,
314 LTTNG_UST_EVENT_TYPE_NOTIFIER = 1,
315 };
316
317 /*
318 * Result of the run_filter() callback.
319 */
320 enum lttng_ust_event_filter_result {
321 LTTNG_UST_EVENT_FILTER_ACCEPT = 0,
322 LTTNG_UST_EVENT_FILTER_REJECT = 1,
323 };
324
325 /*
326 * IMPORTANT: this structure is part of the ABI between the probe and
327 * UST. Fields need to be only added at the end, never reordered, never
328 * removed.
329 *
330 * struct lttng_ust_event_common is the common ancestor of the various
331 * public event actions. Inheritance is done by composition: The parent
332 * has a pointer to its child, and the child has a pointer to its
333 * parent. Inheritance of those public structures is done by composition
334 * to ensure both parent and child structures can be extended.
335 *
336 * The field @struct_size should be used to determine the size of the
337 * structure. It should be queried before using additional fields added
338 * at the end of the structure.
339 */
340 struct lttng_ust_event_common {
341 uint32_t struct_size; /* Size of this structure. */
342
343 struct lttng_ust_event_common_private *priv; /* Private event interface */
344
345 enum lttng_ust_event_type type;
346 void *child; /* Pointer to child, for inheritance by aggregation. */
347
348 int enabled;
349 int eval_filter; /* Need to evaluate filters */
350 int (*run_filter)(struct lttng_ust_event_common *event,
351 const char *stack_data,
352 void *filter_ctx);
353
354 /* End of base ABI. Fields below should be used after checking struct_size. */
355 };
356
357 struct lttng_ust_event_recorder_private;
358
359 /*
360 * IMPORTANT: this structure is part of the ABI between the probe and
361 * UST. Fields need to be only added at the end, never reordered, never
362 * removed.
363 *
364 * struct lttng_ust_event_recorder is the action for recording events
365 * into a ring buffer. It inherits from struct lttng_ust_event_common
366 * by composition to ensure both parent and child structure are
367 * extensible.
368 *
369 * The field @struct_size should be used to determine the size of the
370 * structure. It should be queried before using additional fields added
371 * at the end of the structure.
372 */
373 struct lttng_ust_event_recorder {
374 uint32_t struct_size; /* Size of this structure. */
375
376 struct lttng_ust_event_common *parent; /* Inheritance by aggregation. */
377 struct lttng_ust_event_recorder_private *priv; /* Private event record interface */
378
379 unsigned int id;
380 struct lttng_ust_channel_buffer *chan;
381
382 /* End of base ABI. Fields below should be used after checking struct_size. */
383 };
384
385 /*
386 * IMPORTANT: this structure is part of the ABI between the probe and
387 * UST. Fields need to be only added at the end, never reordered, never
388 * removed.
389 *
390 * The field @struct_size should be used to determine the size of the
391 * structure. It should be queried before using additional fields added
392 * at the end of the structure.
393 */
394 struct lttng_ust_notification_ctx {
395 uint32_t struct_size; /* Size of this structure. */
396 int eval_capture; /* Capture evaluation available. */
397
398 /* End of base ABI. Fields below should be used after checking struct_size. */
399 };
400
401 struct lttng_ust_event_notifier_private;
402
403 /*
404 * IMPORTANT: this structure is part of the ABI between the probe and
405 * UST. Fields need to be only added at the end, never reordered, never
406 * removed.
407 *
408 * struct lttng_ust_event_notifier is the action for sending
409 * notifications. It inherits from struct lttng_ust_event_common
410 * by composition to ensure both parent and child structure are
411 * extensible.
412 *
413 * The field @struct_size should be used to determine the size of the
414 * structure. It should be queried before using additional fields added
415 * at the end of the structure.
416 */
417 struct lttng_ust_event_notifier {
418 uint32_t struct_size; /* Size of this structure. */
419
420 struct lttng_ust_event_common *parent; /* Inheritance by aggregation. */
421 struct lttng_ust_event_notifier_private *priv; /* Private event notifier interface */
422
423 int eval_capture; /* Need to evaluate capture */
424 void (*notification_send)(struct lttng_ust_event_notifier *event_notifier,
425 const char *stack_data,
426 struct lttng_ust_notification_ctx *notif_ctx);
427
428 /* End of base ABI. Fields below should be used after checking struct_size. */
429 };
430
431 struct lttng_ust_lib_ring_buffer_channel;
432 struct lttng_ust_channel_buffer_ops_private;
433
434 /*
435 * IMPORTANT: this structure is part of the ABI between the probe and
436 * UST. Fields need to be only added at the end, never reordered, never
437 * removed.
438 *
439 * The field @struct_size should be used to determine the size of the
440 * structure. It should be queried before using additional fields added
441 * at the end of the structure.
442 */
443 struct lttng_ust_channel_buffer_ops {
444 uint32_t struct_size;
445
446 struct lttng_ust_channel_buffer_ops_private *priv; /* Private channel buffer ops interface */
447
448 int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
449 uint32_t event_id);
450 void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
451 void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
452 const void *src, size_t len);
453 void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
454 const char *src, size_t len);
455 void (*event_pstrcpy_pad)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
456 const char *src, size_t len);
457
458 /* End of base ABI. Fields below should be used after checking struct_size. */
459 };
460
461 enum lttng_ust_channel_type {
462 LTTNG_UST_CHANNEL_TYPE_BUFFER = 0,
463 };
464
465 struct lttng_ust_channel_common_private;
466
467 /*
468 * IMPORTANT: this structure is part of the ABI between the probe and
469 * UST. Fields need to be only added at the end, never reordered, never
470 * removed.
471 *
472 * The field @struct_size should be used to determine the size of the
473 * structure. It should be queried before using additional fields added
474 * at the end of the structure.
475 */
476 struct lttng_ust_channel_common {
477 uint32_t struct_size; /* Size of this structure. */
478
479 struct lttng_ust_channel_common_private *priv; /* Private channel interface */
480
481 enum lttng_ust_channel_type type;
482 void *child; /* Pointer to child, for inheritance by aggregation. */
483
484 int enabled;
485 struct lttng_ust_session *session;
486
487 /* End of base ABI. Fields below should be used after checking struct_size. */
488 };
489
490 struct lttng_ust_channel_buffer_private;
491
492 /*
493 * IMPORTANT: this structure is part of the ABI between the probe and
494 * UST. Fields need to be only added at the end, never reordered, never
495 * removed.
496 *
497 * The field @struct_size should be used to determine the size of the
498 * structure. It should be queried before using additional fields added
499 * at the end of the structure.
500 */
501 struct lttng_ust_channel_buffer {
502 uint32_t struct_size; /* Size of this structure. */
503
504 struct lttng_ust_channel_common *parent; /* Inheritance by aggregation. */
505 struct lttng_ust_channel_buffer_private *priv; /* Private channel buffer interface */
506
507 struct lttng_ust_channel_buffer_ops *ops;
508
509 /* End of base ABI. Fields below should be used after checking struct_size. */
510 };
511
512 /*
513 * IMPORTANT: this structure is part of the ABI between the probe and
514 * UST. Fields need to be only added at the end, never reordered, never
515 * removed.
516 *
517 * The field @struct_size should be used to determine the size of the
518 * structure. It should be queried before using additional fields added
519 * at the end of the structure.
520 */
521 struct lttng_ust_stack_ctx {
522 uint32_t struct_size; /* Size of this structure */
523
524 struct lttng_ust_event_recorder *event_recorder;
525
526 /* End of base ABI. Fields below should be used after checking struct_size. */
527 };
528
529 struct lttng_ust_session_private;
530
531 /*
532 * IMPORTANT: this structure is part of the ABI between the probe and
533 * UST. Fields need to be only added at the end, never reordered, never
534 * removed.
535 *
536 * The field @struct_size should be used to determine the size of the
537 * structure. It should be queried before using additional fields added
538 * at the end of the structure.
539 */
540 struct lttng_ust_session {
541 uint32_t struct_size; /* Size of this structure */
542
543 struct lttng_ust_session_private *priv; /* Private session interface */
544
545 int active; /* Is trace session active ? */
546
547 /* End of base ABI. Fields below should be used after checking struct_size. */
548 };
549
550 int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc);
551 void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc);
552
553 /*
554 * Applications that change their procname and need the new value to be
555 * reflected in the procname event context have to call this function to clear
556 * the internally cached value. This should not be called from a signal
557 * handler.
558 */
559 void lttng_ust_context_procname_reset(void);
560
561 #ifdef __cplusplus
562 }
563 #endif
564
565 #endif /* _LTTNG_UST_EVENTS_H */
This page took 0.047282 seconds and 5 git commands to generate.