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
;
56 SIDE_TYPE_ENUM_BITMAP8
,
57 SIDE_TYPE_ENUM_BITMAP16
,
58 SIDE_TYPE_ENUM_BITMAP32
,
59 SIDE_TYPE_ENUM_BITMAP64
,
61 SIDE_TYPE_FLOAT_BINARY16
,
62 SIDE_TYPE_FLOAT_BINARY32
,
63 SIDE_TYPE_FLOAT_BINARY64
,
64 SIDE_TYPE_FLOAT_BINARY128
,
71 SIDE_TYPE_VLA_VISITOR
,
96 enum side_dynamic_type
{
97 SIDE_DYNAMIC_TYPE_NULL
,
99 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
,
111 SIDE_DYNAMIC_TYPE_FLOAT_BINARY16
,
112 SIDE_DYNAMIC_TYPE_FLOAT_BINARY32
,
113 SIDE_DYNAMIC_TYPE_FLOAT_BINARY64
,
114 SIDE_DYNAMIC_TYPE_FLOAT_BINARY128
,
116 SIDE_DYNAMIC_TYPE_STRING
,
118 SIDE_DYNAMIC_TYPE_STRUCT
,
119 SIDE_DYNAMIC_TYPE_STRUCT_VISITOR
,
121 SIDE_DYNAMIC_TYPE_VLA
,
122 SIDE_DYNAMIC_TYPE_VLA_VISITOR
,
125 enum side_attr_type
{
137 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
138 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
139 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
140 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
142 SIDE_ATTR_TYPE_STRING
,
146 SIDE_LOGLEVEL_EMERG
= 0,
147 SIDE_LOGLEVEL_ALERT
= 1,
148 SIDE_LOGLEVEL_CRIT
= 2,
149 SIDE_LOGLEVEL_ERR
= 3,
150 SIDE_LOGLEVEL_WARNING
= 4,
151 SIDE_LOGLEVEL_NOTICE
= 5,
152 SIDE_LOGLEVEL_INFO
= 6,
153 SIDE_LOGLEVEL_DEBUG
= 7,
156 enum side_visitor_status
{
157 SIDE_VISITOR_STATUS_OK
= 0,
158 SIDE_VISITOR_STATUS_ERROR
= -1,
161 typedef enum side_visitor_status (*side_visitor
)(
162 const struct side_tracer_visitor_ctx
*tracer_ctx
,
164 typedef enum side_visitor_status (*side_dynamic_struct_visitor
)(
165 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
167 typedef enum side_visitor_status (*side_dynamic_vla_visitor
)(
168 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
171 struct side_attr_value
{
172 uint32_t type
; /* enum side_attr_type */
186 _Float16 side_float_binary16
;
189 _Float32 side_float_binary32
;
192 _Float64 side_float_binary64
;
195 _Float128 side_float_binary128
;
202 /* User attributes. */
205 const struct side_attr_value value
;
208 struct side_enum_mapping
{
214 struct side_enum_mappings
{
215 const struct side_enum_mapping
*mappings
;
216 uint32_t nr_mappings
;
219 struct side_enum_bitmap_mapping
{
225 struct side_enum_bitmap_mappings
{
226 const struct side_enum_bitmap_mapping
*mappings
;
227 uint32_t nr_mappings
;
230 struct side_type_description
{
231 uint32_t type
; /* enum side_type */
233 const struct side_attr
*attr
;
237 const struct side_event_field
*fields
;
241 const struct side_type_description
*elem_type
;
244 const struct side_type_description
*elem_type
;
247 const struct side_type_description
*elem_type
;
248 side_visitor visitor
;
250 const struct side_enum_mappings
*side_enum_mappings
;
251 const struct side_enum_bitmap_mappings
*side_enum_bitmap_mappings
;
255 struct side_event_field
{
256 const char *field_name
;
257 struct side_type_description side_type
;
260 enum side_event_flags
{
261 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
264 struct side_callback
{
266 void (*call
)(const struct side_event_description
*desc
,
267 const struct side_arg_vec_description
*sav_desc
,
269 void (*call_variadic
)(const struct side_event_description
*desc
,
270 const struct side_arg_vec_description
*sav_desc
,
271 const struct side_arg_dynamic_event_struct
*var_struct
,
277 struct side_callbacks
{
278 struct side_callback
*cb
;
282 struct side_event_description
{
285 uint32_t loglevel
; /* enum side_loglevel */
290 const char *provider_name
;
291 const char *event_name
;
292 const struct side_event_field
*fields
;
293 const struct side_attr
*attr
;
294 struct side_callbacks
*callbacks
;
297 struct side_arg_dynamic_vec_vla
{
298 const struct side_arg_dynamic_vec
*sav
;
302 struct side_arg_dynamic_vec
{
303 uint32_t dynamic_type
; /* enum side_dynamic_type */
305 const struct side_attr
*attr
;
320 _Float16 side_float_binary16
;
323 _Float32 side_float_binary32
;
326 _Float64 side_float_binary64
;
329 _Float128 side_float_binary128
;
334 const struct side_arg_dynamic_event_struct
*side_dynamic_struct
;
337 side_dynamic_struct_visitor visitor
;
338 } side_dynamic_struct_visitor
;
340 const struct side_arg_dynamic_vec_vla
*side_dynamic_vla
;
343 side_dynamic_vla_visitor visitor
;
344 } side_dynamic_vla_visitor
;
348 struct side_arg_dynamic_event_field
{
349 const char *field_name
;
350 const struct side_arg_dynamic_vec elem
;
353 struct side_arg_dynamic_event_struct
{
354 const struct side_arg_dynamic_event_field
*fields
;
358 struct side_arg_vec
{
374 _Float16 side_float_binary16
;
377 _Float32 side_float_binary32
;
380 _Float64 side_float_binary64
;
383 _Float128 side_float_binary128
;
387 const struct side_arg_vec_description
*side_struct
;
388 const struct side_arg_vec_description
*side_array
;
389 const struct side_arg_vec_description
*side_vla
;
390 void *side_vla_app_visitor_ctx
;
392 void *side_array_fixint
;
398 struct side_arg_dynamic_vec dynamic
;
402 struct side_arg_vec_description
{
403 const struct side_arg_vec
*sav
;
407 /* The visitor pattern is a double-dispatch visitor. */
408 struct side_tracer_visitor_ctx
{
409 enum side_visitor_status (*write_elem
)(
410 const struct side_tracer_visitor_ctx
*tracer_ctx
,
411 const struct side_arg_vec
*elem
);
412 void *priv
; /* Private tracer context. */
415 struct side_tracer_dynamic_struct_visitor_ctx
{
416 enum side_visitor_status (*write_field
)(
417 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
418 const struct side_arg_dynamic_event_field
*dynamic_field
);
419 void *priv
; /* Private tracer context. */
422 struct side_tracer_dynamic_vla_visitor_ctx
{
423 enum side_visitor_status (*write_elem
)(
424 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
425 const struct side_arg_dynamic_vec
*elem
);
426 void *priv
; /* Private tracer context. */
429 #define side_attr(_key, _value) \
432 .value = SIDE_PARAM(_value), \
435 #define side_attr_list(...) \
436 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
438 #define _side_type(_type, _attr) \
441 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
445 #define side_type_bool(_attr) _side_type(SIDE_TYPE_BOOL, SIDE_PARAM(_attr))
446 #define side_type_u8(_attr) _side_type(SIDE_TYPE_U8, SIDE_PARAM(_attr))
447 #define side_type_u16(_attr) _side_type(SIDE_TYPE_U16, SIDE_PARAM(_attr))
448 #define side_type_u32(_attr) _side_type(SIDE_TYPE_U32, SIDE_PARAM(_attr))
449 #define side_type_u64(_attr) _side_type(SIDE_TYPE_U64, SIDE_PARAM(_attr))
450 #define side_type_s8(_attr) _side_type(SIDE_TYPE_S8, SIDE_PARAM(_attr))
451 #define side_type_s16(_attr) _side_type(SIDE_TYPE_S16, SIDE_PARAM(_attr))
452 #define side_type_s32(_attr) _side_type(SIDE_TYPE_S32, SIDE_PARAM(_attr))
453 #define side_type_s64(_attr) _side_type(SIDE_TYPE_S64, SIDE_PARAM(_attr))
454 #define side_type_blob(_attr) _side_type(SIDE_TYPE_BLOB, SIDE_PARAM(_attr))
455 #define side_type_float_binary16(_attr) _side_type(SIDE_TYPE_FLOAT_BINARY16, SIDE_PARAM(_attr))
456 #define side_type_float_binary32(_attr) _side_type(SIDE_TYPE_FLOAT_BINARY32, SIDE_PARAM(_attr))
457 #define side_type_float_binary64(_attr) _side_type(SIDE_TYPE_FLOAT_BINARY64, SIDE_PARAM(_attr))
458 #define side_type_float_binary128(_attr) _side_type(SIDE_TYPE_FLOAT_BINARY128, SIDE_PARAM(_attr))
459 #define side_type_string(_attr) _side_type(SIDE_TYPE_STRING, SIDE_PARAM(_attr))
460 #define side_type_dynamic(_attr) _side_type(SIDE_TYPE_DYNAMIC, SIDE_PARAM(_attr))
462 #define _side_field(_name, _type) \
464 .field_name = _name, \
465 .side_type = _type, \
468 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
469 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
470 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
471 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
472 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
473 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
474 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
475 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
476 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
477 #define side_field_blob(_name, _attr) _side_field(_name, side_type_blob(SIDE_PARAM(_attr)))
478 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
479 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
480 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
481 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
482 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
483 #define side_field_dynamic(_name, _attr) _side_field(_name, side_type_dynamic(SIDE_PARAM(_attr)))
485 #define side_type_enum(_type, _mappings, _attr) \
488 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
491 .side_enum_mappings = _mappings, \
494 #define _side_field_enum(_name, _type, _mappings, _attr) \
495 _side_field(_name, side_type_enum(_type, SIDE_PARAM(_mappings), SIDE_PARAM(_attr)))
497 #define side_field_enum_u8(_name, _mappings, _attr) \
498 _side_field_enum(_name, SIDE_TYPE_ENUM_U8, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
499 #define side_field_enum_u16(_name, _mappings, _attr) \
500 _side_field_enum(_name, SIDE_TYPE_ENUM_U16, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
501 #define side_field_enum_u32(_name, _mappings, _attr) \
502 _side_field_enum(_name, SIDE_TYPE_ENUM_U32, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
503 #define side_field_enum_u64(_name, _mappings, _attr) \
504 _side_field_enum(_name, SIDE_TYPE_ENUM_U64, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
505 #define side_field_enum_s8(_name, _mappings, _attr) \
506 _side_field_enum(_name, SIDE_TYPE_ENUM_S8, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
507 #define side_field_enum_s16(_name, _mappings, _attr) \
508 _side_field_enum(_name, SIDE_TYPE_ENUM_S16, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
509 #define side_field_enum_s32(_name, _mappings, _attr) \
510 _side_field_enum(_name, SIDE_TYPE_ENUM_S32, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
511 #define side_field_enum_s64(_name, _mappings, _attr) \
512 _side_field_enum(_name, SIDE_TYPE_ENUM_S64, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
514 #define side_type_enum_bitmap(_type, _mappings, _attr) \
517 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
520 .side_enum_bitmap_mappings = _mappings, \
523 #define _side_field_enum_bitmap(_name, _type, _mappings, _attr) \
524 _side_field(_name, side_type_enum_bitmap(_type, SIDE_PARAM(_mappings), SIDE_PARAM(_attr)))
526 #define side_field_enum_bitmap8(_name, _mappings, _attr) \
527 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP8, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
528 #define side_field_enum_bitmap16(_name, _mappings, _attr) \
529 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP16, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
530 #define side_field_enum_bitmap32(_name, _mappings, _attr) \
531 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP32, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
532 #define side_field_enum_bitmap64(_name, _mappings, _attr) \
533 _side_field_enum_bitmap(_name, SIDE_TYPE_ENUM_BITMAP64, SIDE_PARAM(_mappings), SIDE_PARAM(_attr))
535 #define side_type_struct(_fields, _attr) \
537 .type = SIDE_TYPE_STRUCT, \
538 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
542 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
547 #define side_field_struct(_name, _fields, _attr) \
548 _side_field(_name, side_type_struct(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
550 #define side_type_array(_elem_type, _length, _attr) \
552 .type = SIDE_TYPE_ARRAY, \
553 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
558 .elem_type = _elem_type, \
562 #define side_field_array(_name, _elem_type, _length, _attr) \
563 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
565 #define side_type_vla(_elem_type, _attr) \
567 .type = SIDE_TYPE_VLA, \
568 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
572 .elem_type = _elem_type, \
576 #define side_field_vla(_name, _elem_type, _attr) \
577 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
579 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
581 .type = SIDE_TYPE_VLA_VISITOR, \
582 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
585 .side_vla_visitor = { \
586 .elem_type = SIDE_PARAM(_elem_type), \
587 .visitor = _visitor, \
591 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
592 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
594 #define side_elem(...) \
595 SIDE_COMPOUND_LITERAL(const struct side_type_description, __VA_ARGS__)
597 #define side_field_list(...) \
598 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
600 #define side_arg_bool(val) { .type = SIDE_TYPE_BOOL, .u = { .side_bool = !!(val) } }
601 #define side_arg_u8(val) { .type = SIDE_TYPE_U8, .u = { .side_u8 = (val) } }
602 #define side_arg_u16(val) { .type = SIDE_TYPE_U16, .u = { .side_u16 = (val) } }
603 #define side_arg_u32(val) { .type = SIDE_TYPE_U32, .u = { .side_u32 = (val) } }
604 #define side_arg_u64(val) { .type = SIDE_TYPE_U64, .u = { .side_u64 = (val) } }
605 #define side_arg_s8(val) { .type = SIDE_TYPE_S8, .u = { .side_s8 = (val) } }
606 #define side_arg_s16(val) { .type = SIDE_TYPE_S16, .u = { .side_s16 = (val) } }
607 #define side_arg_s32(val) { .type = SIDE_TYPE_S32, .u = { .side_s32 = (val) } }
608 #define side_arg_s64(val) { .type = SIDE_TYPE_S64, .u = { .side_s64 = (val) } }
609 #define side_arg_blob(val) { .type = SIDE_TYPE_BLOB, .u = { .side_blob = (val) } }
610 #define side_arg_enum_u8(val) { .type = SIDE_TYPE_ENUM_U8, .u = { .side_u8 = (val) } }
611 #define side_arg_enum_u16(val) { .type = SIDE_TYPE_ENUM_U16, .u = { .side_u16 = (val) } }
612 #define side_arg_enum_u32(val) { .type = SIDE_TYPE_ENUM_U32, .u = { .side_u32 = (val) } }
613 #define side_arg_enum_u64(val) { .type = SIDE_TYPE_ENUM_U64, .u = { .side_u64 = (val) } }
614 #define side_arg_enum_s8(val) { .type = SIDE_TYPE_ENUM_S8, .u = { .side_s8 = (val) } }
615 #define side_arg_enum_s16(val) { .type = SIDE_TYPE_ENUM_S16, .u = { .side_s16 = (val) } }
616 #define side_arg_enum_s32(val) { .type = SIDE_TYPE_ENUM_S32, .u = { .side_s32 = (val) } }
617 #define side_arg_enum_s64(val) { .type = SIDE_TYPE_ENUM_S64, .u = { .side_s64 = (val) } }
618 #define side_arg_enum_bitmap8(val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_u8 = (val) } }
619 #define side_arg_enum_bitmap16(val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_u16 = (val) } }
620 #define side_arg_enum_bitmap32(val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_u32 = (val) } }
621 #define side_arg_enum_bitmap64(val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_u64 = (val) } }
622 #define side_arg_float_binary16(val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (val) } }
623 #define side_arg_float_binary32(val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (val) } }
624 #define side_arg_float_binary64(val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (val) } }
625 #define side_arg_float_binary128(val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (val) } }
627 #define side_arg_string(val) { .type = SIDE_TYPE_STRING, .u = { .string = (val) } }
628 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_struct = (_side_type) } }
629 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_array = (_side_type) } }
630 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_vla = (_side_type) } }
631 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_vla_app_visitor_ctx = (_ctx) } }
633 #define side_arg_array_u8(_ptr) { .type = SIDE_TYPE_ARRAY_U8, .u = { .side_array_fixint = (_ptr) } }
634 #define side_arg_array_u16(_ptr) { .type = SIDE_TYPE_ARRAY_U16, .u = { .side_array_fixint = (_ptr) } }
635 #define side_arg_array_u32(_ptr) { .type = SIDE_TYPE_ARRAY_U32, .u = { .side_array_fixint = (_ptr) } }
636 #define side_arg_array_u64(_ptr) { .type = SIDE_TYPE_ARRAY_U64, .u = { .side_array_fixint = (_ptr) } }
637 #define side_arg_array_s8(_ptr) { .type = SIDE_TYPE_ARRAY_S8, .u = { .side_array_fixint = (_ptr) } }
638 #define side_arg_array_s16(_ptr) { .type = SIDE_TYPE_ARRAY_S16, .u = { .side_array_fixint = (_ptr) } }
639 #define side_arg_array_s32(_ptr) { .type = SIDE_TYPE_ARRAY_S32, .u = { .side_array_fixint = (_ptr) } }
640 #define side_arg_array_s64(_ptr) { .type = SIDE_TYPE_ARRAY_S64, .u = { .side_array_fixint = (_ptr) } }
641 #define side_arg_array_blob(_ptr) { .type = SIDE_TYPE_ARRAY_BLOB, .u = { .side_array_fixint = (_ptr) } }
643 #define side_arg_vla_u8(_ptr, _length) { .type = SIDE_TYPE_VLA_U8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } }
644 #define side_arg_vla_u16(_ptr, _length) { .type = SIDE_TYPE_VLA_U16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
645 #define side_arg_vla_u32(_ptr, _length) { .type = SIDE_TYPE_VLA_U32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
646 #define side_arg_vla_u64(_ptr, _length) { .type = SIDE_TYPE_VLA_U64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
647 #define side_arg_vla_s8(_ptr, _length) { .type = SIDE_TYPE_VLA_S8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
648 #define side_arg_vla_s16(_ptr, _length) { .type = SIDE_TYPE_VLA_S16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
649 #define side_arg_vla_s32(_ptr, _length) { .type = SIDE_TYPE_VLA_S32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
650 #define side_arg_vla_s64(_ptr, _length) { .type = SIDE_TYPE_VLA_S64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
651 #define side_arg_vla_blob(_ptr, _length) { .type = SIDE_TYPE_VLA_BLOB, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
653 #define side_arg_dynamic(dynamic_arg_type) \
655 .type = SIDE_TYPE_DYNAMIC, \
657 .dynamic = dynamic_arg_type, \
661 #define side_arg_dynamic_null(_attr) \
663 .dynamic_type = SIDE_DYNAMIC_TYPE_NULL, \
664 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
668 #define side_arg_dynamic_bool(_val, _attr) \
670 .dynamic_type = SIDE_DYNAMIC_TYPE_BOOL, \
671 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
674 .side_bool = !!(_val), \
678 #define side_arg_dynamic_u8(_val, _attr) \
680 .dynamic_type = SIDE_DYNAMIC_TYPE_U8, \
681 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
687 #define side_arg_dynamic_u16(_val, _attr) \
689 .dynamic_type = SIDE_DYNAMIC_TYPE_U16, \
690 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
693 .side_u16 = (_val), \
696 #define side_arg_dynamic_u32(_val, _attr) \
698 .dynamic_type = SIDE_DYNAMIC_TYPE_U32, \
699 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
702 .side_u32 = (_val), \
705 #define side_arg_dynamic_u64(_val, _attr) \
707 .dynamic_type = SIDE_DYNAMIC_TYPE_U64, \
708 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
711 .side_u64 = (_val), \
715 #define side_arg_dynamic_s8(_val, _attr) \
717 .dynamic_type = SIDE_DYNAMIC_TYPE_S8, \
718 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
724 #define side_arg_dynamic_s16(_val, _attr) \
726 .dynamic_type = SIDE_DYNAMIC_TYPE_S16, \
727 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
730 .side_s16 = (_val), \
733 #define side_arg_dynamic_s32(_val, _attr) \
735 .dynamic_type = SIDE_DYNAMIC_TYPE_S32, \
736 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
739 .side_s32 = (_val), \
742 #define side_arg_dynamic_s64(_val, _attr) \
744 .dynamic_type = SIDE_DYNAMIC_TYPE_S64, \
745 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
748 .side_s64 = (_val), \
751 #define side_arg_dynamic_blob(_val, _attr) \
753 .dynamic_type = SIDE_DYNAMIC_TYPE_BLOB, \
754 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
757 .side_blob = (_val), \
761 #define side_arg_dynamic_float_binary16(_val, _attr) \
763 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY16, \
764 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
767 .side_float_binary16 = (_val), \
770 #define side_arg_dynamic_float_binary32(_val, _attr) \
772 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY32, \
773 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
776 .side_float_binary32 = (_val), \
779 #define side_arg_dynamic_float_binary64(_val, _attr) \
781 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY64, \
782 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
785 .side_float_binary64 = (_val), \
788 #define side_arg_dynamic_float_binary128(_val, _attr) \
790 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY128, \
791 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
794 .side_float_binary128 = (_val), \
798 #define side_arg_dynamic_string(_val, _attr) \
800 .dynamic_type = SIDE_DYNAMIC_TYPE_STRING, \
801 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
808 #define side_arg_dynamic_vla(_vla, _attr) \
810 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA, \
811 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
814 .side_dynamic_vla = (_vla), \
818 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
820 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA_VISITOR, \
821 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
824 .side_dynamic_vla_visitor = { \
826 .visitor = _dynamic_vla_visitor, \
831 #define side_arg_dynamic_struct(_struct, _attr) \
833 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT, \
834 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
837 .side_dynamic_struct = (_struct), \
841 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
843 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT_VISITOR, \
844 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
847 .side_dynamic_struct_visitor = { \
849 .visitor = _dynamic_struct_visitor, \
854 #define side_arg_dynamic_define_vec(_identifier, _sav) \
855 const struct side_arg_dynamic_vec _identifier##_vec[] = { _sav }; \
856 const struct side_arg_dynamic_vec_vla _identifier = { \
857 .sav = _identifier##_vec, \
858 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
861 #define side_arg_dynamic_define_struct(_identifier, _struct_fields) \
862 const struct side_arg_dynamic_event_field _identifier##_fields[] = { _struct_fields }; \
863 const struct side_arg_dynamic_event_struct _identifier = { \
864 .fields = _identifier##_fields, \
865 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
868 #define side_arg_define_vec(_identifier, _sav) \
869 const struct side_arg_vec _identifier##_vec[] = { _sav }; \
870 const struct side_arg_vec_description _identifier = { \
871 .sav = _identifier##_vec, \
872 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
875 #define side_arg_dynamic_field(_name, _elem) \
877 .field_name = _name, \
881 #define side_arg_list(...) __VA_ARGS__
883 #define side_attr_bool(val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .side_bool = !!(val) } }
884 #define side_attr_u8(val) { .type = SIDE_ATTR_TYPE_U8, .u = { .side_u8 = (val) } }
885 #define side_attr_u16(val) { .type = SIDE_ATTR_TYPE_U16, .u = { .side_u16 = (val) } }
886 #define side_attr_u32(val) { .type = SIDE_ATTR_TYPE_U32, .u = { .side_u32 = (val) } }
887 #define side_attr_u64(val) { .type = SIDE_ATTR_TYPE_U64, .u = { .side_u64 = (val) } }
888 #define side_attr_s8(val) { .type = SIDE_ATTR_TYPE_S8, .u = { .side_s8 = (val) } }
889 #define side_attr_s16(val) { .type = SIDE_ATTR_TYPE_S16, .u = { .side_s16 = (val) } }
890 #define side_attr_s32(val) { .type = SIDE_ATTR_TYPE_S32, .u = { .side_s32 = (val) } }
891 #define side_attr_s64(val) { .type = SIDE_ATTR_TYPE_S64, .u = { .side_s64 = (val) } }
892 #define side_attr_float_binary16(val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (val) } }
893 #define side_attr_float_binary32(val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (val) } }
894 #define side_attr_float_binary64(val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (val) } }
895 #define side_attr_float_binary128(val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (val) } }
896 #define side_attr_string(val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string = (val) } }
898 #define side_event_cond(_desc) if (side_unlikely(_desc##_enabled))
900 #define side_event_call(_desc, _sav) \
902 const struct side_arg_vec side_sav[] = { _sav }; \
903 const struct side_arg_vec_description sav_desc = { \
905 .len = SIDE_ARRAY_SIZE(side_sav), \
907 side_call(&(_desc), &sav_desc); \
910 #define side_event(_desc, _sav) \
911 side_event_cond(_desc) \
912 side_event_call(_desc, SIDE_PARAM(_sav))
914 #define side_event_call_variadic(_desc, _sav, _var_fields) \
916 const struct side_arg_vec side_sav[] = { _sav }; \
917 const struct side_arg_vec_description sav_desc = { \
919 .len = SIDE_ARRAY_SIZE(side_sav), \
921 const struct side_arg_dynamic_event_field side_fields[] = { _var_fields }; \
922 const struct side_arg_dynamic_event_struct var_struct = { \
923 .fields = side_fields, \
924 .len = SIDE_ARRAY_SIZE(side_fields), \
926 side_call_variadic(&(_desc), &sav_desc, &var_struct); \
929 #define side_event_variadic(_desc, _sav, _var) \
930 side_event_cond(_desc) \
931 side_event_call_variadic(_desc, SIDE_PARAM(_sav), SIDE_PARAM(_var))
933 #define side_define_enum(_identifier, _mappings) \
934 const struct side_enum_mappings _identifier = { \
935 .mappings = _mappings, \
936 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
939 #define side_enum_mapping_list(...) \
940 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
942 #define side_enum_mapping_range(_label, _begin, _end) \
944 .range_begin = _begin, \
949 #define side_enum_mapping_value(_label, _value) \
951 .range_begin = _value, \
952 .range_end = _value, \
956 #define side_define_enum_bitmap(_identifier, _mappings) \
957 const struct side_enum_bitmap_mappings _identifier = { \
958 .mappings = _mappings, \
959 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
962 #define side_enum_bitmap_mapping_list(...) \
963 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
965 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
967 .range_begin = _begin, \
972 #define side_enum_bitmap_mapping_value(_label, _value) \
974 .range_begin = _value, \
975 .range_end = _value, \
979 #define _side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
980 uint32_t _identifier##_enabled __attribute__((section("side_event_enable"))); \
981 struct side_callbacks _identifier##_callbacks __attribute__((section("side_event_callbacks"))); \
982 const struct side_event_description _identifier = { \
984 .enabled = &(_identifier##_enabled), \
985 .loglevel = _loglevel, \
986 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
987 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
989 .provider_name = _provider, \
990 .event_name = _event, \
993 .callbacks = &(_identifier##_callbacks), \
995 const struct side_event_description *_identifier##_ptr \
996 __attribute__((section("side_event_description"), used)) = &(_identifier);
998 #define side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
999 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1000 SIDE_PARAM(_attr), 0)
1002 #define side_define_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1003 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1004 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1006 #define side_declare_event(_identifier) \
1007 struct side_event_description _identifier
1009 void side_call(const struct side_event_description
*desc
,
1010 const struct side_arg_vec_description
*sav_desc
);
1011 void side_call_variadic(const struct side_event_description
*desc
,
1012 const struct side_arg_vec_description
*sav_desc
,
1013 const struct side_arg_dynamic_event_struct
*var_struct
);
1015 #endif /* _SIDE_TRACE_H */