1 // SPDX-License-Identifier: MIT
3 * Copyright 2022 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
14 #include <side/macros.h>
16 /* SIDE stands for "Static Instrumentation Dynamically Enabled" */
18 //TODO: as those structures will be ABI, we need to either consider them
19 //fixed forever, or think of a scheme that would allow their binary
20 //representation to be extended if need be.
23 struct side_arg_vec_description
;
24 struct side_arg_dynamic_vec
;
25 struct side_arg_dynamic_vec_vla
;
26 struct side_type_description
;
27 struct side_event_field
;
28 struct side_tracer_visitor_ctx
;
29 struct side_tracer_dynamic_struct_visitor_ctx
;
30 struct side_tracer_dynamic_vla_visitor_ctx
;
31 struct side_event_description
;
32 struct side_arg_dynamic_event_struct
;
46 SIDE_TYPE_FLOAT_BINARY16
,
47 SIDE_TYPE_FLOAT_BINARY32
,
48 SIDE_TYPE_FLOAT_BINARY64
,
49 SIDE_TYPE_FLOAT_BINARY128
,
52 /* Enumeration types */
62 SIDE_TYPE_ENUM_BITMAP8
,
63 SIDE_TYPE_ENUM_BITMAP16
,
64 SIDE_TYPE_ENUM_BITMAP32
,
65 SIDE_TYPE_ENUM_BITMAP64
,
71 SIDE_TYPE_VLA_VISITOR
,
97 enum side_dynamic_type
{
99 SIDE_DYNAMIC_TYPE_NULL
,
100 SIDE_DYNAMIC_TYPE_BOOL
,
101 SIDE_DYNAMIC_TYPE_U8
,
102 SIDE_DYNAMIC_TYPE_U16
,
103 SIDE_DYNAMIC_TYPE_U32
,
104 SIDE_DYNAMIC_TYPE_U64
,
105 SIDE_DYNAMIC_TYPE_S8
,
106 SIDE_DYNAMIC_TYPE_S16
,
107 SIDE_DYNAMIC_TYPE_S32
,
108 SIDE_DYNAMIC_TYPE_S64
,
109 SIDE_DYNAMIC_TYPE_BLOB
,
110 SIDE_DYNAMIC_TYPE_FLOAT_BINARY16
,
111 SIDE_DYNAMIC_TYPE_FLOAT_BINARY32
,
112 SIDE_DYNAMIC_TYPE_FLOAT_BINARY64
,
113 SIDE_DYNAMIC_TYPE_FLOAT_BINARY128
,
114 SIDE_DYNAMIC_TYPE_STRING
,
117 SIDE_DYNAMIC_TYPE_STRUCT
,
118 SIDE_DYNAMIC_TYPE_STRUCT_VISITOR
,
119 SIDE_DYNAMIC_TYPE_VLA
,
120 SIDE_DYNAMIC_TYPE_VLA_VISITOR
,
123 enum side_attr_type
{
133 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
134 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
135 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
136 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
137 SIDE_ATTR_TYPE_STRING
,
141 SIDE_LOGLEVEL_EMERG
= 0,
142 SIDE_LOGLEVEL_ALERT
= 1,
143 SIDE_LOGLEVEL_CRIT
= 2,
144 SIDE_LOGLEVEL_ERR
= 3,
145 SIDE_LOGLEVEL_WARNING
= 4,
146 SIDE_LOGLEVEL_NOTICE
= 5,
147 SIDE_LOGLEVEL_INFO
= 6,
148 SIDE_LOGLEVEL_DEBUG
= 7,
151 enum side_visitor_status
{
152 SIDE_VISITOR_STATUS_OK
= 0,
153 SIDE_VISITOR_STATUS_ERROR
= -1,
156 typedef enum side_visitor_status (*side_visitor
)(
157 const struct side_tracer_visitor_ctx
*tracer_ctx
,
159 typedef enum side_visitor_status (*side_dynamic_struct_visitor
)(
160 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
162 typedef enum side_visitor_status (*side_dynamic_vla_visitor
)(
163 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
166 struct side_attr_value
{
167 uint32_t type
; /* enum side_attr_type */
179 _Float16 side_float_binary16
;
182 _Float32 side_float_binary32
;
185 _Float64 side_float_binary64
;
188 _Float128 side_float_binary128
;
194 /* User attributes. */
197 const struct side_attr_value value
;
200 struct side_enum_mapping
{
206 struct side_enum_mappings
{
207 const struct side_enum_mapping
*mappings
;
208 const struct side_attr
*attr
;
209 uint32_t nr_mappings
;
213 struct side_enum_bitmap_mapping
{
219 struct side_enum_bitmap_mappings
{
220 const struct side_enum_bitmap_mapping
*mappings
;
221 const struct side_attr
*attr
;
222 uint32_t nr_mappings
;
226 struct side_type_struct
{
229 const struct side_event_field
*fields
;
230 const struct side_attr
*attr
;
233 struct side_type_description
{
234 uint32_t type
; /* enum side_type */
238 const struct side_attr
*attr
;
242 /* Enumeration types */
243 const struct side_enum_mappings
*side_enum_mappings
;
244 const struct side_enum_bitmap_mappings
*side_enum_bitmap_mappings
;
248 const struct side_type_description
*elem_type
;
249 const struct side_attr
*attr
;
254 const struct side_type_description
*elem_type
;
255 const struct side_attr
*attr
;
259 const struct side_type_description
*elem_type
;
260 side_visitor visitor
;
261 const struct side_attr
*attr
;
264 const struct side_type_struct
*side_struct
;
268 struct side_event_field
{
269 const char *field_name
;
270 struct side_type_description side_type
;
273 enum side_event_flags
{
274 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
277 struct side_callback
{
279 void (*call
)(const struct side_event_description
*desc
,
280 const struct side_arg_vec_description
*sav_desc
,
282 void (*call_variadic
)(const struct side_event_description
*desc
,
283 const struct side_arg_vec_description
*sav_desc
,
284 const struct side_arg_dynamic_event_struct
*var_struct
,
290 struct side_callbacks
{
291 struct side_callback
*cb
;
295 struct side_event_description
{
298 uint32_t loglevel
; /* enum side_loglevel */
303 const char *provider_name
;
304 const char *event_name
;
305 const struct side_event_field
*fields
;
306 const struct side_attr
*attr
;
307 struct side_callbacks
*callbacks
;
310 struct side_arg_dynamic_vec
{
311 uint32_t dynamic_type
; /* enum side_dynamic_type */
315 const struct side_attr
*attr
;
329 _Float16 side_float_binary16
;
332 _Float32 side_float_binary32
;
335 _Float64 side_float_binary64
;
338 _Float128 side_float_binary128
;
345 const struct side_arg_dynamic_event_struct
*side_dynamic_struct
;
348 side_dynamic_struct_visitor visitor
;
349 const struct side_attr
*attr
;
351 } side_dynamic_struct_visitor
;
352 const struct side_arg_dynamic_vec_vla
*side_dynamic_vla
;
355 side_dynamic_vla_visitor visitor
;
356 const struct side_attr
*attr
;
358 } side_dynamic_vla_visitor
;
362 struct side_arg_dynamic_vec_vla
{
363 const struct side_arg_dynamic_vec
*sav
;
364 const struct side_attr
*attr
;
369 struct side_arg_dynamic_event_field
{
370 const char *field_name
;
371 const struct side_arg_dynamic_vec elem
;
374 struct side_arg_dynamic_event_struct
{
375 const struct side_arg_dynamic_event_field
*fields
;
376 const struct side_attr
*attr
;
381 struct side_arg_vec
{
396 _Float16 side_float_binary16
;
399 _Float32 side_float_binary32
;
402 _Float64 side_float_binary64
;
405 _Float128 side_float_binary128
;
410 const struct side_arg_vec_description
*side_struct
;
411 const struct side_arg_vec_description
*side_array
;
412 const struct side_arg_vec_description
*side_vla
;
413 void *side_vla_app_visitor_ctx
;
414 void *side_array_fixint
;
421 struct side_arg_dynamic_vec dynamic
;
425 struct side_arg_vec_description
{
426 const struct side_arg_vec
*sav
;
430 /* The visitor pattern is a double-dispatch visitor. */
431 struct side_tracer_visitor_ctx
{
432 enum side_visitor_status (*write_elem
)(
433 const struct side_tracer_visitor_ctx
*tracer_ctx
,
434 const struct side_arg_vec
*elem
);
435 void *priv
; /* Private tracer context. */
438 struct side_tracer_dynamic_struct_visitor_ctx
{
439 enum side_visitor_status (*write_field
)(
440 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
441 const struct side_arg_dynamic_event_field
*dynamic_field
);
442 void *priv
; /* Private tracer context. */
445 struct side_tracer_dynamic_vla_visitor_ctx
{
446 enum side_visitor_status (*write_elem
)(
447 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
448 const struct side_arg_dynamic_vec
*elem
);
449 void *priv
; /* Private tracer context. */
452 /* Event and type attributes */
454 #define side_attr(_key, _value) \
457 .value = SIDE_PARAM(_value), \
460 #define side_attr_list(...) \
461 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
463 #define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
464 #define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .side_u8 = (_val) } }
465 #define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .side_u16 = (_val) } }
466 #define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .side_u32 = (_val) } }
467 #define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .side_u64 = (_val) } }
468 #define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .side_s8 = (_val) } }
469 #define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .side_s16 = (_val) } }
470 #define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .side_s32 = (_val) } }
471 #define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .side_s64 = (_val) } }
472 #define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (_val) } }
473 #define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (_val) } }
474 #define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (_val) } }
475 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (_val) } }
476 #define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string = (_val) } }
478 /* Static field definition */
480 #define _side_type_basic(_type, _attr) \
486 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
491 #define side_type_bool(_attr) _side_type_basic(SIDE_TYPE_BOOL, SIDE_PARAM(_attr))
492 #define side_type_u8(_attr) _side_type_basic(SIDE_TYPE_U8, SIDE_PARAM(_attr))
493 #define side_type_u16(_attr) _side_type_basic(SIDE_TYPE_U16, SIDE_PARAM(_attr))
494 #define side_type_u32(_attr) _side_type_basic(SIDE_TYPE_U32, SIDE_PARAM(_attr))
495 #define side_type_u64(_attr) _side_type_basic(SIDE_TYPE_U64, SIDE_PARAM(_attr))
496 #define side_type_s8(_attr) _side_type_basic(SIDE_TYPE_S8, SIDE_PARAM(_attr))
497 #define side_type_s16(_attr) _side_type_basic(SIDE_TYPE_S16, SIDE_PARAM(_attr))
498 #define side_type_s32(_attr) _side_type_basic(SIDE_TYPE_S32, SIDE_PARAM(_attr))
499 #define side_type_s64(_attr) _side_type_basic(SIDE_TYPE_S64, SIDE_PARAM(_attr))
500 #define side_type_blob(_attr) _side_type_basic(SIDE_TYPE_BLOB, SIDE_PARAM(_attr))
501 #define side_type_float_binary16(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY16, SIDE_PARAM(_attr))
502 #define side_type_float_binary32(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY32, SIDE_PARAM(_attr))
503 #define side_type_float_binary64(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY64, SIDE_PARAM(_attr))
504 #define side_type_float_binary128(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY128, SIDE_PARAM(_attr))
505 #define side_type_string(_attr) _side_type_basic(SIDE_TYPE_STRING, SIDE_PARAM(_attr))
506 #define side_type_dynamic(_attr) _side_type_basic(SIDE_TYPE_DYNAMIC, SIDE_PARAM(_attr))
508 #define _side_field(_name, _type) \
510 .field_name = _name, \
511 .side_type = _type, \
514 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
515 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
516 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
517 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
518 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
519 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
520 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
521 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
522 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
523 #define side_field_blob(_name, _attr) _side_field(_name, side_type_blob(SIDE_PARAM(_attr)))
524 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
525 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
526 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
527 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
528 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
529 #define side_field_dynamic(_name, _attr) _side_field(_name, side_type_dynamic(SIDE_PARAM(_attr)))
531 #define side_type_enum(_type, _mappings) \
535 .side_enum_mappings = _mappings, \
538 #define _side_field_enum(_name, _type, _mappings) \
539 _side_field(_name, side_type_enum(_type, SIDE_PARAM(_mappings)))
541 #define side_field_enum_u8(_name, _mappings) \
542 _side_field_enum(_name, SIDE_TYPE_ENUM_U8, SIDE_PARAM(_mappings))
543 #define side_field_enum_u16(_name, _mappings) \
544 _side_field_enum(_name, SIDE_TYPE_ENUM_U16, SIDE_PARAM(_mappings))
545 #define side_field_enum_u32(_name, _mappings) \
546 _side_field_enum(_name, SIDE_TYPE_ENUM_U32, SIDE_PARAM(_mappings))
547 #define side_field_enum_u64(_name, _mappings) \
548 _side_field_enum(_name, SIDE_TYPE_ENUM_U64, SIDE_PARAM(_mappings))
549 #define side_field_enum_s8(_name, _mappings) \
550 _side_field_enum(_name, SIDE_TYPE_ENUM_S8, SIDE_PARAM(_mappings))
551 #define side_field_enum_s16(_name, _mappings) \
552 _side_field_enum(_name, SIDE_TYPE_ENUM_S16, SIDE_PARAM(_mappings))
553 #define side_field_enum_s32(_name, _mappings) \
554 _side_field_enum(_name, SIDE_TYPE_ENUM_S32, SIDE_PARAM(_mappings))
555 #define side_field_enum_s64(_name, _mappings) \
556 _side_field_enum(_name, SIDE_TYPE_ENUM_S64, SIDE_PARAM(_mappings))
558 #define side_type_enum_bitmap(_type, _mappings) \
562 .side_enum_bitmap_mappings = _mappings, \
565 #define _side_field_enum_bitmap(_name, _type, _mappings) \
566 _side_field(_name, side_type_enum_bitmap(_type, SIDE_PARAM(_mappings)))
568 #define side_field_enum_bitmap8(_name, _mappings) \
569 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP8, SIDE_PARAM(_mappings))
570 #define side_field_enum_bitmap16(_name, _mappings) \
571 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP16, SIDE_PARAM(_mappings))
572 #define side_field_enum_bitmap32(_name, _mappings) \
573 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP32, SIDE_PARAM(_mappings))
574 #define side_field_enum_bitmap64(_name, _mappings) \
575 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP64, SIDE_PARAM(_mappings))
577 #define side_type_struct(_struct) \
579 .type = SIDE_TYPE_STRUCT, \
581 .side_struct = _struct, \
584 #define side_field_struct(_name, _struct) \
585 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
587 #define _side_type_struct_define(_fields, _attr) \
589 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
590 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
595 #define side_define_struct(_identifier, _fields, _attr) \
596 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
598 #define side_struct_literal(_fields, _attr) \
599 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
600 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
602 #define side_type_array(_elem_type, _length, _attr) \
604 .type = SIDE_TYPE_ARRAY, \
607 .elem_type = _elem_type, \
610 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
614 #define side_field_array(_name, _elem_type, _length, _attr) \
615 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
617 #define side_type_vla(_elem_type, _attr) \
619 .type = SIDE_TYPE_VLA, \
622 .elem_type = _elem_type, \
624 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
628 #define side_field_vla(_name, _elem_type, _attr) \
629 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
631 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
633 .type = SIDE_TYPE_VLA_VISITOR, \
635 .side_vla_visitor = { \
636 .elem_type = SIDE_PARAM(_elem_type), \
637 .visitor = _visitor, \
639 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
643 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
644 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
646 #define side_elem(...) \
647 SIDE_COMPOUND_LITERAL(const struct side_type_description, __VA_ARGS__)
649 #define side_field_list(...) \
650 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
652 /* Static field arguments */
654 #define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
655 #define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .side_u8 = (_val) } }
656 #define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .side_u16 = (_val) } }
657 #define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .side_u32 = (_val) } }
658 #define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .side_u64 = (_val) } }
659 #define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .side_s8 = (_val) } }
660 #define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .side_s16 = (_val) } }
661 #define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .side_s32 = (_val) } }
662 #define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .side_s64 = (_val) } }
663 #define side_arg_blob(_val) { .type = SIDE_TYPE_BLOB, .u = { .side_blob = (_val) } }
664 #define side_arg_enum_u8(_val) { .type = SIDE_TYPE_ENUM_U8, .u = { .side_u8 = (_val) } }
665 #define side_arg_enum_u16(_val) { .type = SIDE_TYPE_ENUM_U16, .u = { .side_u16 = (_val) } }
666 #define side_arg_enum_u32(_val) { .type = SIDE_TYPE_ENUM_U32, .u = { .side_u32 = (_val) } }
667 #define side_arg_enum_u64(_val) { .type = SIDE_TYPE_ENUM_U64, .u = { .side_u64 = (_val) } }
668 #define side_arg_enum_s8(_val) { .type = SIDE_TYPE_ENUM_S8, .u = { .side_s8 = (_val) } }
669 #define side_arg_enum_s16(_val) { .type = SIDE_TYPE_ENUM_S16, .u = { .side_s16 = (_val) } }
670 #define side_arg_enum_s32(_val) { .type = SIDE_TYPE_ENUM_S32, .u = { .side_s32 = (_val) } }
671 #define side_arg_enum_s64(_val) { .type = SIDE_TYPE_ENUM_S64, .u = { .side_s64 = (_val) } }
672 #define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_u8 = (_val) } }
673 #define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_u16 = (_val) } }
674 #define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_u32 = (_val) } }
675 #define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_u64 = (_val) } }
676 #define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (_val) } }
677 #define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (_val) } }
678 #define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (_val) } }
679 #define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (_val) } }
681 #define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .string = (_val) } }
682 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_struct = (_side_type) } }
683 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_array = (_side_type) } }
684 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_vla = (_side_type) } }
685 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_vla_app_visitor_ctx = (_ctx) } }
687 #define side_arg_array_u8(_ptr) { .type = SIDE_TYPE_ARRAY_U8, .u = { .side_array_fixint = (_ptr) } }
688 #define side_arg_array_u16(_ptr) { .type = SIDE_TYPE_ARRAY_U16, .u = { .side_array_fixint = (_ptr) } }
689 #define side_arg_array_u32(_ptr) { .type = SIDE_TYPE_ARRAY_U32, .u = { .side_array_fixint = (_ptr) } }
690 #define side_arg_array_u64(_ptr) { .type = SIDE_TYPE_ARRAY_U64, .u = { .side_array_fixint = (_ptr) } }
691 #define side_arg_array_s8(_ptr) { .type = SIDE_TYPE_ARRAY_S8, .u = { .side_array_fixint = (_ptr) } }
692 #define side_arg_array_s16(_ptr) { .type = SIDE_TYPE_ARRAY_S16, .u = { .side_array_fixint = (_ptr) } }
693 #define side_arg_array_s32(_ptr) { .type = SIDE_TYPE_ARRAY_S32, .u = { .side_array_fixint = (_ptr) } }
694 #define side_arg_array_s64(_ptr) { .type = SIDE_TYPE_ARRAY_S64, .u = { .side_array_fixint = (_ptr) } }
695 #define side_arg_array_blob(_ptr) { .type = SIDE_TYPE_ARRAY_BLOB, .u = { .side_array_fixint = (_ptr) } }
697 #define side_arg_vla_u8(_ptr, _length) { .type = SIDE_TYPE_VLA_U8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } }
698 #define side_arg_vla_u16(_ptr, _length) { .type = SIDE_TYPE_VLA_U16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
699 #define side_arg_vla_u32(_ptr, _length) { .type = SIDE_TYPE_VLA_U32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
700 #define side_arg_vla_u64(_ptr, _length) { .type = SIDE_TYPE_VLA_U64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
701 #define side_arg_vla_s8(_ptr, _length) { .type = SIDE_TYPE_VLA_S8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
702 #define side_arg_vla_s16(_ptr, _length) { .type = SIDE_TYPE_VLA_S16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
703 #define side_arg_vla_s32(_ptr, _length) { .type = SIDE_TYPE_VLA_S32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
704 #define side_arg_vla_s64(_ptr, _length) { .type = SIDE_TYPE_VLA_S64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
705 #define side_arg_vla_blob(_ptr, _length) { .type = SIDE_TYPE_VLA_BLOB, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
707 #define side_arg_dynamic(_dynamic_arg_type) \
709 .type = SIDE_TYPE_DYNAMIC, \
711 .dynamic = _dynamic_arg_type, \
715 /* Dynamic field arguments */
717 #define side_arg_dynamic_null(_attr) \
719 .dynamic_type = SIDE_DYNAMIC_TYPE_NULL, \
723 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
728 #define side_arg_dynamic_bool(_val, _attr) \
730 .dynamic_type = SIDE_DYNAMIC_TYPE_BOOL, \
734 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
736 .side_bool = !!(_val), \
742 #define side_arg_dynamic_u8(_val, _attr) \
744 .dynamic_type = SIDE_DYNAMIC_TYPE_U8, \
748 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
755 #define side_arg_dynamic_u16(_val, _attr) \
757 .dynamic_type = SIDE_DYNAMIC_TYPE_U16, \
761 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
763 .side_u16 = (_val), \
768 #define side_arg_dynamic_u32(_val, _attr) \
770 .dynamic_type = SIDE_DYNAMIC_TYPE_U32, \
774 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
776 .side_u32 = (_val), \
781 #define side_arg_dynamic_u64(_val, _attr) \
783 .dynamic_type = SIDE_DYNAMIC_TYPE_U64, \
787 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
789 .side_u64 = (_val), \
795 #define side_arg_dynamic_s8(_val, _attr) \
797 .dynamic_type = SIDE_DYNAMIC_TYPE_S8, \
801 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
808 #define side_arg_dynamic_s16(_val, _attr) \
810 .dynamic_type = SIDE_DYNAMIC_TYPE_S16, \
814 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
816 .side_s16 = (_val), \
821 #define side_arg_dynamic_s32(_val, _attr) \
823 .dynamic_type = SIDE_DYNAMIC_TYPE_S32, \
827 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
829 .side_s32 = (_val), \
834 #define side_arg_dynamic_s64(_val, _attr) \
836 .dynamic_type = SIDE_DYNAMIC_TYPE_S64, \
840 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
842 .side_s64 = (_val), \
847 #define side_arg_dynamic_blob(_val, _attr) \
849 .dynamic_type = SIDE_DYNAMIC_TYPE_BLOB, \
853 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
855 .side_blob = (_val), \
861 #define side_arg_dynamic_float_binary16(_val, _attr) \
863 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY16, \
867 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
869 .side_float_binary16 = (_val), \
874 #define side_arg_dynamic_float_binary32(_val, _attr) \
876 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY32, \
880 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
882 .side_float_binary32 = (_val), \
887 #define side_arg_dynamic_float_binary64(_val, _attr) \
889 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY64, \
893 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
895 .side_float_binary64 = (_val), \
900 #define side_arg_dynamic_float_binary128(_val, _attr) \
902 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY128, \
906 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
908 .side_float_binary128 = (_val), \
914 #define side_arg_dynamic_string(_val, _attr) \
916 .dynamic_type = SIDE_DYNAMIC_TYPE_STRING, \
920 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
928 #define side_arg_dynamic_vla(_vla) \
930 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA, \
932 .side_dynamic_vla = (_vla), \
936 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
938 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA_VISITOR, \
940 .side_dynamic_vla_visitor = { \
942 .visitor = _dynamic_vla_visitor, \
944 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
949 #define side_arg_dynamic_struct(_struct) \
951 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT, \
953 .side_dynamic_struct = (_struct), \
957 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
959 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT_VISITOR, \
961 .side_dynamic_struct_visitor = { \
963 .visitor = _dynamic_struct_visitor, \
965 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
970 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
971 const struct side_arg_dynamic_vec _identifier##_vec[] = { _sav }; \
972 const struct side_arg_dynamic_vec_vla _identifier = { \
973 .sav = _identifier##_vec, \
975 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
976 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
979 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
980 const struct side_arg_dynamic_event_field _identifier##_fields[] = { _struct_fields }; \
981 const struct side_arg_dynamic_event_struct _identifier = { \
982 .fields = _identifier##_fields, \
984 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
985 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
988 #define side_arg_define_vec(_identifier, _sav) \
989 const struct side_arg_vec _identifier##_vec[] = { _sav }; \
990 const struct side_arg_vec_description _identifier = { \
991 .sav = _identifier##_vec, \
992 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
995 #define side_arg_dynamic_field(_name, _elem) \
997 .field_name = _name, \
1001 #define side_arg_list(...) __VA_ARGS__
1003 #define side_define_enum(_identifier, _mappings, _attr) \
1004 const struct side_enum_mappings _identifier = { \
1005 .mappings = _mappings, \
1007 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1008 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1011 #define side_enum_mapping_list(...) \
1012 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
1014 #define side_enum_mapping_range(_label, _begin, _end) \
1016 .range_begin = _begin, \
1017 .range_end = _end, \
1021 #define side_enum_mapping_value(_label, _value) \
1023 .range_begin = _value, \
1024 .range_end = _value, \
1028 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
1029 const struct side_enum_bitmap_mappings _identifier = { \
1030 .mappings = _mappings, \
1032 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1033 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1036 #define side_enum_bitmap_mapping_list(...) \
1037 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
1039 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
1041 .range_begin = _begin, \
1042 .range_end = _end, \
1046 #define side_enum_bitmap_mapping_value(_label, _value) \
1048 .range_begin = _value, \
1049 .range_end = _value, \
1053 #define side_event_cond(_desc) if (side_unlikely(_desc##_enabled))
1055 #define side_event_call(_desc, _sav) \
1057 const struct side_arg_vec side_sav[] = { _sav }; \
1058 const struct side_arg_vec_description sav_desc = { \
1060 .len = SIDE_ARRAY_SIZE(side_sav), \
1062 side_call(&(_desc), &sav_desc); \
1065 #define side_event(_desc, _sav) \
1066 side_event_cond(_desc) \
1067 side_event_call(_desc, SIDE_PARAM(_sav))
1069 #define side_event_call_variadic(_desc, _sav, _var_fields, _attr) \
1071 const struct side_arg_vec side_sav[] = { _sav }; \
1072 const struct side_arg_vec_description sav_desc = { \
1074 .len = SIDE_ARRAY_SIZE(side_sav), \
1076 const struct side_arg_dynamic_event_field side_fields[] = { _var_fields }; \
1077 const struct side_arg_dynamic_event_struct var_struct = { \
1078 .fields = side_fields, \
1080 .len = SIDE_ARRAY_SIZE(side_fields), \
1081 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1083 side_call_variadic(&(_desc), &sav_desc, &var_struct); \
1086 #define side_event_variadic(_desc, _sav, _var, _attr) \
1087 side_event_cond(_desc) \
1088 side_event_call_variadic(_desc, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1090 #define _side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1091 uint32_t _identifier##_enabled __attribute__((section("side_event_enable"))); \
1092 struct side_callbacks _identifier##_callbacks __attribute__((section("side_event_callbacks"))); \
1093 const struct side_event_description _identifier = { \
1095 .enabled = &(_identifier##_enabled), \
1096 .loglevel = _loglevel, \
1097 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1098 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1099 .flags = (_flags), \
1100 .provider_name = _provider, \
1101 .event_name = _event, \
1102 .fields = _fields, \
1104 .callbacks = &(_identifier##_callbacks), \
1106 const struct side_event_description *_identifier##_ptr \
1107 __attribute__((section("side_event_description"), used)) = &(_identifier);
1109 #define side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1110 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1111 SIDE_PARAM(_attr), 0)
1113 #define side_define_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1114 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1115 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1117 #define side_declare_event(_identifier) \
1118 struct side_event_description _identifier
1120 void side_call(const struct side_event_description
*desc
,
1121 const struct side_arg_vec_description
*sav_desc
);
1122 void side_call_variadic(const struct side_event_description
*desc
,
1123 const struct side_arg_vec_description
*sav_desc
,
1124 const struct side_arg_dynamic_event_struct
*var_struct
);
1126 #endif /* _SIDE_TRACE_H */