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
,
56 SIDE_TYPE_VLA_VISITOR
,
78 /* Enumeration types */
81 SIDE_TYPE_ENUM_BITMAP8
,
82 SIDE_TYPE_ENUM_BITMAP16
,
83 SIDE_TYPE_ENUM_BITMAP32
,
84 SIDE_TYPE_ENUM_BITMAP64
,
86 SIDE_TYPE_ENUM_BITMAP_ARRAY
,
87 SIDE_TYPE_ENUM_BITMAP_VLA
,
93 enum side_dynamic_type
{
95 SIDE_DYNAMIC_TYPE_NULL
,
96 SIDE_DYNAMIC_TYPE_BOOL
,
98 SIDE_DYNAMIC_TYPE_U16
,
99 SIDE_DYNAMIC_TYPE_U32
,
100 SIDE_DYNAMIC_TYPE_U64
,
101 SIDE_DYNAMIC_TYPE_S8
,
102 SIDE_DYNAMIC_TYPE_S16
,
103 SIDE_DYNAMIC_TYPE_S32
,
104 SIDE_DYNAMIC_TYPE_S64
,
105 SIDE_DYNAMIC_TYPE_BLOB
,
106 SIDE_DYNAMIC_TYPE_FLOAT_BINARY16
,
107 SIDE_DYNAMIC_TYPE_FLOAT_BINARY32
,
108 SIDE_DYNAMIC_TYPE_FLOAT_BINARY64
,
109 SIDE_DYNAMIC_TYPE_FLOAT_BINARY128
,
110 SIDE_DYNAMIC_TYPE_STRING
,
113 SIDE_DYNAMIC_TYPE_STRUCT
,
114 SIDE_DYNAMIC_TYPE_STRUCT_VISITOR
,
115 SIDE_DYNAMIC_TYPE_VLA
,
116 SIDE_DYNAMIC_TYPE_VLA_VISITOR
,
119 enum side_attr_type
{
129 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
130 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
131 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
132 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
133 SIDE_ATTR_TYPE_STRING
,
137 SIDE_LOGLEVEL_EMERG
= 0,
138 SIDE_LOGLEVEL_ALERT
= 1,
139 SIDE_LOGLEVEL_CRIT
= 2,
140 SIDE_LOGLEVEL_ERR
= 3,
141 SIDE_LOGLEVEL_WARNING
= 4,
142 SIDE_LOGLEVEL_NOTICE
= 5,
143 SIDE_LOGLEVEL_INFO
= 6,
144 SIDE_LOGLEVEL_DEBUG
= 7,
147 enum side_visitor_status
{
148 SIDE_VISITOR_STATUS_OK
= 0,
149 SIDE_VISITOR_STATUS_ERROR
= -1,
152 typedef enum side_visitor_status (*side_visitor
)(
153 const struct side_tracer_visitor_ctx
*tracer_ctx
,
155 typedef enum side_visitor_status (*side_dynamic_struct_visitor
)(
156 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
158 typedef enum side_visitor_status (*side_dynamic_vla_visitor
)(
159 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
162 struct side_attr_value
{
163 uint32_t type
; /* enum side_attr_type */
175 _Float16 side_float_binary16
;
178 _Float32 side_float_binary32
;
181 _Float64 side_float_binary64
;
184 _Float128 side_float_binary128
;
190 /* User attributes. */
193 const struct side_attr_value value
;
196 struct side_enum_mapping
{
202 struct side_enum_mappings
{
203 const struct side_enum_mapping
*mappings
;
204 const struct side_attr
*attr
;
205 uint32_t nr_mappings
;
209 struct side_enum_bitmap_mapping
{
215 struct side_enum_bitmap_mappings
{
216 const struct side_enum_bitmap_mapping
*mappings
;
217 const struct side_attr
*attr
;
218 uint32_t nr_mappings
;
222 struct side_type_struct
{
225 const struct side_event_field
*fields
;
226 const struct side_attr
*attr
;
229 struct side_type_description
{
230 uint32_t type
; /* enum side_type */
234 const struct side_attr
*attr
;
240 const struct side_type_description
*elem_type
;
241 const struct side_attr
*attr
;
246 const struct side_type_description
*elem_type
;
247 const struct side_attr
*attr
;
251 const struct side_type_description
*elem_type
;
252 side_visitor visitor
;
253 const struct side_attr
*attr
;
256 const struct side_type_struct
*side_struct
;
258 /* Enumeration types */
260 const struct side_type_description
*elem_type
;
261 const struct side_enum_mappings
*mappings
;
264 const struct side_enum_bitmap_mappings
*side_enum_bitmap_mappings
;
266 const struct side_type_description
*elem_type
;
267 const struct side_enum_bitmap_mappings
*mappings
;
269 } side_enum_bitmap_array
;
271 const struct side_type_description
*elem_type
;
272 const struct side_enum_bitmap_mappings
*mappings
;
273 } side_enum_bitmap_vla
;
277 struct side_event_field
{
278 const char *field_name
;
279 struct side_type_description side_type
;
282 enum side_event_flags
{
283 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
286 struct side_callback
{
288 void (*call
)(const struct side_event_description
*desc
,
289 const struct side_arg_vec_description
*sav_desc
,
291 void (*call_variadic
)(const struct side_event_description
*desc
,
292 const struct side_arg_vec_description
*sav_desc
,
293 const struct side_arg_dynamic_event_struct
*var_struct
,
299 struct side_callbacks
{
300 struct side_callback
*cb
;
304 struct side_event_description
{
307 uint32_t loglevel
; /* enum side_loglevel */
312 const char *provider_name
;
313 const char *event_name
;
314 const struct side_event_field
*fields
;
315 const struct side_attr
*attr
;
316 struct side_callbacks
*callbacks
;
319 struct side_arg_dynamic_vec
{
320 uint32_t dynamic_type
; /* enum side_dynamic_type */
324 const struct side_attr
*attr
;
338 _Float16 side_float_binary16
;
341 _Float32 side_float_binary32
;
344 _Float64 side_float_binary64
;
347 _Float128 side_float_binary128
;
354 const struct side_arg_dynamic_event_struct
*side_dynamic_struct
;
357 side_dynamic_struct_visitor visitor
;
358 const struct side_attr
*attr
;
360 } side_dynamic_struct_visitor
;
361 const struct side_arg_dynamic_vec_vla
*side_dynamic_vla
;
364 side_dynamic_vla_visitor visitor
;
365 const struct side_attr
*attr
;
367 } side_dynamic_vla_visitor
;
371 struct side_arg_dynamic_vec_vla
{
372 const struct side_arg_dynamic_vec
*sav
;
373 const struct side_attr
*attr
;
378 struct side_arg_dynamic_event_field
{
379 const char *field_name
;
380 const struct side_arg_dynamic_vec elem
;
383 struct side_arg_dynamic_event_struct
{
384 const struct side_arg_dynamic_event_field
*fields
;
385 const struct side_attr
*attr
;
390 struct side_arg_vec
{
405 _Float16 side_float_binary16
;
408 _Float32 side_float_binary32
;
411 _Float64 side_float_binary64
;
414 _Float128 side_float_binary128
;
419 const struct side_arg_vec_description
*side_struct
;
420 const struct side_arg_vec_description
*side_array
;
421 const struct side_arg_vec_description
*side_vla
;
422 void *side_vla_app_visitor_ctx
;
423 void *side_array_fixint
;
430 struct side_arg_dynamic_vec dynamic
;
434 struct side_arg_vec_description
{
435 const struct side_arg_vec
*sav
;
439 /* The visitor pattern is a double-dispatch visitor. */
440 struct side_tracer_visitor_ctx
{
441 enum side_visitor_status (*write_elem
)(
442 const struct side_tracer_visitor_ctx
*tracer_ctx
,
443 const struct side_arg_vec
*elem
);
444 void *priv
; /* Private tracer context. */
447 struct side_tracer_dynamic_struct_visitor_ctx
{
448 enum side_visitor_status (*write_field
)(
449 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
450 const struct side_arg_dynamic_event_field
*dynamic_field
);
451 void *priv
; /* Private tracer context. */
454 struct side_tracer_dynamic_vla_visitor_ctx
{
455 enum side_visitor_status (*write_elem
)(
456 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
457 const struct side_arg_dynamic_vec
*elem
);
458 void *priv
; /* Private tracer context. */
461 /* Event and type attributes */
463 #define side_attr(_key, _value) \
466 .value = SIDE_PARAM(_value), \
469 #define side_attr_list(...) \
470 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
472 #define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
473 #define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .side_u8 = (_val) } }
474 #define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .side_u16 = (_val) } }
475 #define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .side_u32 = (_val) } }
476 #define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .side_u64 = (_val) } }
477 #define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .side_s8 = (_val) } }
478 #define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .side_s16 = (_val) } }
479 #define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .side_s32 = (_val) } }
480 #define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .side_s64 = (_val) } }
481 #define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (_val) } }
482 #define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (_val) } }
483 #define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (_val) } }
484 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (_val) } }
485 #define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string = (_val) } }
487 /* Static field definition */
489 #define _side_type_basic(_type, _attr) \
495 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
500 #define side_type_bool(_attr) _side_type_basic(SIDE_TYPE_BOOL, SIDE_PARAM(_attr))
501 #define side_type_u8(_attr) _side_type_basic(SIDE_TYPE_U8, SIDE_PARAM(_attr))
502 #define side_type_u16(_attr) _side_type_basic(SIDE_TYPE_U16, SIDE_PARAM(_attr))
503 #define side_type_u32(_attr) _side_type_basic(SIDE_TYPE_U32, SIDE_PARAM(_attr))
504 #define side_type_u64(_attr) _side_type_basic(SIDE_TYPE_U64, SIDE_PARAM(_attr))
505 #define side_type_s8(_attr) _side_type_basic(SIDE_TYPE_S8, SIDE_PARAM(_attr))
506 #define side_type_s16(_attr) _side_type_basic(SIDE_TYPE_S16, SIDE_PARAM(_attr))
507 #define side_type_s32(_attr) _side_type_basic(SIDE_TYPE_S32, SIDE_PARAM(_attr))
508 #define side_type_s64(_attr) _side_type_basic(SIDE_TYPE_S64, SIDE_PARAM(_attr))
509 #define side_type_blob(_attr) _side_type_basic(SIDE_TYPE_BLOB, SIDE_PARAM(_attr))
510 #define side_type_float_binary16(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY16, SIDE_PARAM(_attr))
511 #define side_type_float_binary32(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY32, SIDE_PARAM(_attr))
512 #define side_type_float_binary64(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY64, SIDE_PARAM(_attr))
513 #define side_type_float_binary128(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY128, SIDE_PARAM(_attr))
514 #define side_type_string(_attr) _side_type_basic(SIDE_TYPE_STRING, SIDE_PARAM(_attr))
515 #define side_type_dynamic(_attr) _side_type_basic(SIDE_TYPE_DYNAMIC, SIDE_PARAM(_attr))
517 #define _side_field(_name, _type) \
519 .field_name = _name, \
520 .side_type = _type, \
523 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
524 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
525 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
526 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
527 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
528 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
529 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
530 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
531 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
532 #define side_field_blob(_name, _attr) _side_field(_name, side_type_blob(SIDE_PARAM(_attr)))
533 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
534 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
535 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
536 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
537 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
538 #define side_field_dynamic(_name, _attr) _side_field(_name, side_type_dynamic(SIDE_PARAM(_attr)))
540 #define side_type_enum(_elem_type, _mappings) \
542 .type = SIDE_TYPE_ENUM, \
545 .elem_type = _elem_type, \
546 .mappings = _mappings, \
550 #define side_field_enum(_name, _elem_type, _mappings) \
551 _side_field(_name, side_type_enum(SIDE_PARAM(_elem_type), SIDE_PARAM(_mappings)))
553 #define side_type_enum_bitmap(_type, _mappings) \
557 .side_enum_bitmap_mappings = _mappings, \
560 #define side_type_enum_bitmap8(_mappings) \
561 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP8, SIDE_PARAM(_mappings))
562 #define side_type_enum_bitmap16(_mappings) \
563 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP16, SIDE_PARAM(_mappings))
564 #define side_type_enum_bitmap32(_mappings) \
565 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP32, SIDE_PARAM(_mappings))
566 #define side_type_enum_bitmap64(_mappings) \
567 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP64, SIDE_PARAM(_mappings))
569 #define _side_field_enum_bitmap(_name, _type) _side_field(_name, SIDE_PARAM(_type))
571 #define side_field_enum_bitmap8(_name, _mappings) \
572 _side_field_enum_bitmap(_name, side_type_enum_bitmap8(SIDE_PARAM(_mappings)))
573 #define side_field_enum_bitmap16(_name, _mappings) \
574 _side_field_enum_bitmap(_name, side_type_enum_bitmap16(SIDE_PARAM(_mappings)))
575 #define side_field_enum_bitmap32(_name, _mappings) \
576 _side_field_enum_bitmap(_name, side_type_enum_bitmap32(SIDE_PARAM(_mappings)))
577 #define side_field_enum_bitmap64(_name, _mappings) \
578 _side_field_enum_bitmap(_name, side_type_enum_bitmap64(SIDE_PARAM(_mappings)))
580 #define side_type_enum_bitmap_array(_mappings, _elem_type, _length) \
582 .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, \
584 .side_enum_bitmap_array = { \
585 .elem_type = _elem_type, \
586 .mappings = _mappings, \
591 #define side_field_enum_bitmap_array(_name, _mappings, _elem_type, _length) \
592 _side_field(_name, side_type_enum_bitmap_array(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type), _length))
594 #define side_type_enum_bitmap_vla(_mappings, _elem_type) \
596 .type = SIDE_TYPE_ENUM_BITMAP_VLA, \
598 .side_enum_bitmap_vla = { \
599 .elem_type = _elem_type, \
600 .mappings = _mappings, \
604 #define side_field_enum_bitmap_vla(_name, _mappings, _elem_type) \
605 _side_field(_name, side_type_enum_bitmap_vla(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
607 #define side_type_struct(_struct) \
609 .type = SIDE_TYPE_STRUCT, \
611 .side_struct = _struct, \
614 #define side_field_struct(_name, _struct) \
615 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
617 #define _side_type_struct_define(_fields, _attr) \
619 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
620 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
625 #define side_define_struct(_identifier, _fields, _attr) \
626 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
628 #define side_struct_literal(_fields, _attr) \
629 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
630 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
632 #define side_type_array(_elem_type, _length, _attr) \
634 .type = SIDE_TYPE_ARRAY, \
637 .elem_type = _elem_type, \
640 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
644 #define side_field_array(_name, _elem_type, _length, _attr) \
645 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
647 #define side_type_vla(_elem_type, _attr) \
649 .type = SIDE_TYPE_VLA, \
652 .elem_type = _elem_type, \
654 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
658 #define side_field_vla(_name, _elem_type, _attr) \
659 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
661 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
663 .type = SIDE_TYPE_VLA_VISITOR, \
665 .side_vla_visitor = { \
666 .elem_type = SIDE_PARAM(_elem_type), \
667 .visitor = _visitor, \
669 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
673 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
674 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
676 #define side_elem(...) \
677 SIDE_COMPOUND_LITERAL(const struct side_type_description, __VA_ARGS__)
679 #define side_field_list(...) \
680 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
682 /* Static field arguments */
684 #define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
685 #define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .side_u8 = (_val) } }
686 #define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .side_u16 = (_val) } }
687 #define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .side_u32 = (_val) } }
688 #define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .side_u64 = (_val) } }
689 #define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .side_s8 = (_val) } }
690 #define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .side_s16 = (_val) } }
691 #define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .side_s32 = (_val) } }
692 #define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .side_s64 = (_val) } }
693 #define side_arg_blob(_val) { .type = SIDE_TYPE_BLOB, .u = { .side_blob = (_val) } }
694 #define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_u8 = (_val) } }
695 #define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_u16 = (_val) } }
696 #define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_u32 = (_val) } }
697 #define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_u64 = (_val) } }
698 #define side_arg_enum_bitmap_array(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_array = (_side_type) } }
699 #define side_arg_enum_bitmap_vla(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_vla = (_side_type) } }
700 #define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (_val) } }
701 #define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (_val) } }
702 #define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (_val) } }
703 #define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (_val) } }
705 #define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .string = (_val) } }
706 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_struct = (_side_type) } }
707 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_array = (_side_type) } }
708 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_vla = (_side_type) } }
709 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_vla_app_visitor_ctx = (_ctx) } }
711 #define side_arg_array_u8(_ptr) { .type = SIDE_TYPE_ARRAY_U8, .u = { .side_array_fixint = (_ptr) } }
712 #define side_arg_array_u16(_ptr) { .type = SIDE_TYPE_ARRAY_U16, .u = { .side_array_fixint = (_ptr) } }
713 #define side_arg_array_u32(_ptr) { .type = SIDE_TYPE_ARRAY_U32, .u = { .side_array_fixint = (_ptr) } }
714 #define side_arg_array_u64(_ptr) { .type = SIDE_TYPE_ARRAY_U64, .u = { .side_array_fixint = (_ptr) } }
715 #define side_arg_array_s8(_ptr) { .type = SIDE_TYPE_ARRAY_S8, .u = { .side_array_fixint = (_ptr) } }
716 #define side_arg_array_s16(_ptr) { .type = SIDE_TYPE_ARRAY_S16, .u = { .side_array_fixint = (_ptr) } }
717 #define side_arg_array_s32(_ptr) { .type = SIDE_TYPE_ARRAY_S32, .u = { .side_array_fixint = (_ptr) } }
718 #define side_arg_array_s64(_ptr) { .type = SIDE_TYPE_ARRAY_S64, .u = { .side_array_fixint = (_ptr) } }
719 #define side_arg_array_blob(_ptr) { .type = SIDE_TYPE_ARRAY_BLOB, .u = { .side_array_fixint = (_ptr) } }
721 #define side_arg_vla_u8(_ptr, _length) { .type = SIDE_TYPE_VLA_U8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } }
722 #define side_arg_vla_u16(_ptr, _length) { .type = SIDE_TYPE_VLA_U16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
723 #define side_arg_vla_u32(_ptr, _length) { .type = SIDE_TYPE_VLA_U32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
724 #define side_arg_vla_u64(_ptr, _length) { .type = SIDE_TYPE_VLA_U64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
725 #define side_arg_vla_s8(_ptr, _length) { .type = SIDE_TYPE_VLA_S8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
726 #define side_arg_vla_s16(_ptr, _length) { .type = SIDE_TYPE_VLA_S16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
727 #define side_arg_vla_s32(_ptr, _length) { .type = SIDE_TYPE_VLA_S32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
728 #define side_arg_vla_s64(_ptr, _length) { .type = SIDE_TYPE_VLA_S64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
729 #define side_arg_vla_blob(_ptr, _length) { .type = SIDE_TYPE_VLA_BLOB, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
731 #define side_arg_dynamic(_dynamic_arg_type) \
733 .type = SIDE_TYPE_DYNAMIC, \
735 .dynamic = _dynamic_arg_type, \
739 /* Dynamic field arguments */
741 #define side_arg_dynamic_null(_attr) \
743 .dynamic_type = SIDE_DYNAMIC_TYPE_NULL, \
747 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
752 #define side_arg_dynamic_bool(_val, _attr) \
754 .dynamic_type = SIDE_DYNAMIC_TYPE_BOOL, \
758 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
760 .side_bool = !!(_val), \
766 #define side_arg_dynamic_u8(_val, _attr) \
768 .dynamic_type = SIDE_DYNAMIC_TYPE_U8, \
772 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
779 #define side_arg_dynamic_u16(_val, _attr) \
781 .dynamic_type = SIDE_DYNAMIC_TYPE_U16, \
785 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
787 .side_u16 = (_val), \
792 #define side_arg_dynamic_u32(_val, _attr) \
794 .dynamic_type = SIDE_DYNAMIC_TYPE_U32, \
798 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
800 .side_u32 = (_val), \
805 #define side_arg_dynamic_u64(_val, _attr) \
807 .dynamic_type = SIDE_DYNAMIC_TYPE_U64, \
811 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
813 .side_u64 = (_val), \
819 #define side_arg_dynamic_s8(_val, _attr) \
821 .dynamic_type = SIDE_DYNAMIC_TYPE_S8, \
825 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
832 #define side_arg_dynamic_s16(_val, _attr) \
834 .dynamic_type = SIDE_DYNAMIC_TYPE_S16, \
838 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
840 .side_s16 = (_val), \
845 #define side_arg_dynamic_s32(_val, _attr) \
847 .dynamic_type = SIDE_DYNAMIC_TYPE_S32, \
851 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
853 .side_s32 = (_val), \
858 #define side_arg_dynamic_s64(_val, _attr) \
860 .dynamic_type = SIDE_DYNAMIC_TYPE_S64, \
864 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
866 .side_s64 = (_val), \
871 #define side_arg_dynamic_blob(_val, _attr) \
873 .dynamic_type = SIDE_DYNAMIC_TYPE_BLOB, \
877 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
879 .side_blob = (_val), \
885 #define side_arg_dynamic_float_binary16(_val, _attr) \
887 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY16, \
891 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
893 .side_float_binary16 = (_val), \
898 #define side_arg_dynamic_float_binary32(_val, _attr) \
900 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY32, \
904 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
906 .side_float_binary32 = (_val), \
911 #define side_arg_dynamic_float_binary64(_val, _attr) \
913 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY64, \
917 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
919 .side_float_binary64 = (_val), \
924 #define side_arg_dynamic_float_binary128(_val, _attr) \
926 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY128, \
930 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
932 .side_float_binary128 = (_val), \
938 #define side_arg_dynamic_string(_val, _attr) \
940 .dynamic_type = SIDE_DYNAMIC_TYPE_STRING, \
944 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
952 #define side_arg_dynamic_vla(_vla) \
954 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA, \
956 .side_dynamic_vla = (_vla), \
960 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
962 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA_VISITOR, \
964 .side_dynamic_vla_visitor = { \
966 .visitor = _dynamic_vla_visitor, \
968 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
973 #define side_arg_dynamic_struct(_struct) \
975 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT, \
977 .side_dynamic_struct = (_struct), \
981 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
983 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT_VISITOR, \
985 .side_dynamic_struct_visitor = { \
987 .visitor = _dynamic_struct_visitor, \
989 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
994 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
995 const struct side_arg_dynamic_vec _identifier##_vec[] = { _sav }; \
996 const struct side_arg_dynamic_vec_vla _identifier = { \
997 .sav = _identifier##_vec, \
999 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1000 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1003 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
1004 const struct side_arg_dynamic_event_field _identifier##_fields[] = { _struct_fields }; \
1005 const struct side_arg_dynamic_event_struct _identifier = { \
1006 .fields = _identifier##_fields, \
1008 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
1009 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1012 #define side_arg_define_vec(_identifier, _sav) \
1013 const struct side_arg_vec _identifier##_vec[] = { _sav }; \
1014 const struct side_arg_vec_description _identifier = { \
1015 .sav = _identifier##_vec, \
1016 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1019 #define side_arg_dynamic_field(_name, _elem) \
1021 .field_name = _name, \
1025 #define side_arg_list(...) __VA_ARGS__
1027 #define side_define_enum(_identifier, _mappings, _attr) \
1028 const struct side_enum_mappings _identifier = { \
1029 .mappings = _mappings, \
1031 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1032 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1035 #define side_enum_mapping_list(...) \
1036 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
1038 #define side_enum_mapping_range(_label, _begin, _end) \
1040 .range_begin = _begin, \
1041 .range_end = _end, \
1045 #define side_enum_mapping_value(_label, _value) \
1047 .range_begin = _value, \
1048 .range_end = _value, \
1052 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
1053 const struct side_enum_bitmap_mappings _identifier = { \
1054 .mappings = _mappings, \
1056 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1057 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1060 #define side_enum_bitmap_mapping_list(...) \
1061 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
1063 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
1065 .range_begin = _begin, \
1066 .range_end = _end, \
1070 #define side_enum_bitmap_mapping_value(_label, _value) \
1072 .range_begin = _value, \
1073 .range_end = _value, \
1077 #define side_event_cond(_desc) if (side_unlikely(_desc##_enabled))
1079 #define side_event_call(_desc, _sav) \
1081 const struct side_arg_vec side_sav[] = { _sav }; \
1082 const struct side_arg_vec_description sav_desc = { \
1084 .len = SIDE_ARRAY_SIZE(side_sav), \
1086 side_call(&(_desc), &sav_desc); \
1089 #define side_event(_desc, _sav) \
1090 side_event_cond(_desc) \
1091 side_event_call(_desc, SIDE_PARAM(_sav))
1093 #define side_event_call_variadic(_desc, _sav, _var_fields, _attr) \
1095 const struct side_arg_vec side_sav[] = { _sav }; \
1096 const struct side_arg_vec_description sav_desc = { \
1098 .len = SIDE_ARRAY_SIZE(side_sav), \
1100 const struct side_arg_dynamic_event_field side_fields[] = { _var_fields }; \
1101 const struct side_arg_dynamic_event_struct var_struct = { \
1102 .fields = side_fields, \
1104 .len = SIDE_ARRAY_SIZE(side_fields), \
1105 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1107 side_call_variadic(&(_desc), &sav_desc, &var_struct); \
1110 #define side_event_variadic(_desc, _sav, _var, _attr) \
1111 side_event_cond(_desc) \
1112 side_event_call_variadic(_desc, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1114 #define _side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1115 uint32_t _identifier##_enabled __attribute__((section("side_event_enable"))); \
1116 struct side_callbacks _identifier##_callbacks __attribute__((section("side_event_callbacks"))); \
1117 const struct side_event_description _identifier = { \
1119 .enabled = &(_identifier##_enabled), \
1120 .loglevel = _loglevel, \
1121 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1122 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1123 .flags = (_flags), \
1124 .provider_name = _provider, \
1125 .event_name = _event, \
1126 .fields = _fields, \
1128 .callbacks = &(_identifier##_callbacks), \
1130 const struct side_event_description *_identifier##_ptr \
1131 __attribute__((section("side_event_description"), used)) = &(_identifier);
1133 #define side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1134 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1135 SIDE_PARAM(_attr), 0)
1137 #define side_define_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1138 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1139 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1141 #define side_declare_event(_identifier) \
1142 struct side_event_description _identifier
1144 void side_call(const struct side_event_description
*desc
,
1145 const struct side_arg_vec_description
*sav_desc
);
1146 void side_call_variadic(const struct side_event_description
*desc
,
1147 const struct side_arg_vec_description
*sav_desc
,
1148 const struct side_arg_dynamic_event_struct
*var_struct
);
1150 #endif /* _SIDE_TRACE_H */