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 */
88 SIDE_TYPE_ENUM_BITMAP8
,
89 SIDE_TYPE_ENUM_BITMAP16
,
90 SIDE_TYPE_ENUM_BITMAP32
,
91 SIDE_TYPE_ENUM_BITMAP64
,
93 SIDE_TYPE_ENUM_BITMAP_ARRAY
,
94 SIDE_TYPE_ENUM_BITMAP_VLA
,
100 enum side_dynamic_type
{
102 SIDE_DYNAMIC_TYPE_NULL
,
103 SIDE_DYNAMIC_TYPE_BOOL
,
104 SIDE_DYNAMIC_TYPE_U8
,
105 SIDE_DYNAMIC_TYPE_U16
,
106 SIDE_DYNAMIC_TYPE_U32
,
107 SIDE_DYNAMIC_TYPE_U64
,
108 SIDE_DYNAMIC_TYPE_S8
,
109 SIDE_DYNAMIC_TYPE_S16
,
110 SIDE_DYNAMIC_TYPE_S32
,
111 SIDE_DYNAMIC_TYPE_S64
,
112 SIDE_DYNAMIC_TYPE_BLOB
,
113 SIDE_DYNAMIC_TYPE_FLOAT_BINARY16
,
114 SIDE_DYNAMIC_TYPE_FLOAT_BINARY32
,
115 SIDE_DYNAMIC_TYPE_FLOAT_BINARY64
,
116 SIDE_DYNAMIC_TYPE_FLOAT_BINARY128
,
117 SIDE_DYNAMIC_TYPE_STRING
,
120 SIDE_DYNAMIC_TYPE_STRUCT
,
121 SIDE_DYNAMIC_TYPE_STRUCT_VISITOR
,
122 SIDE_DYNAMIC_TYPE_VLA
,
123 SIDE_DYNAMIC_TYPE_VLA_VISITOR
,
126 enum side_attr_type
{
136 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
137 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
138 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
139 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
140 SIDE_ATTR_TYPE_STRING
,
144 SIDE_LOGLEVEL_EMERG
= 0,
145 SIDE_LOGLEVEL_ALERT
= 1,
146 SIDE_LOGLEVEL_CRIT
= 2,
147 SIDE_LOGLEVEL_ERR
= 3,
148 SIDE_LOGLEVEL_WARNING
= 4,
149 SIDE_LOGLEVEL_NOTICE
= 5,
150 SIDE_LOGLEVEL_INFO
= 6,
151 SIDE_LOGLEVEL_DEBUG
= 7,
154 enum side_visitor_status
{
155 SIDE_VISITOR_STATUS_OK
= 0,
156 SIDE_VISITOR_STATUS_ERROR
= -1,
159 typedef enum side_visitor_status (*side_visitor
)(
160 const struct side_tracer_visitor_ctx
*tracer_ctx
,
162 typedef enum side_visitor_status (*side_dynamic_struct_visitor
)(
163 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
165 typedef enum side_visitor_status (*side_dynamic_vla_visitor
)(
166 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
169 struct side_attr_value
{
170 uint32_t type
; /* enum side_attr_type */
182 _Float16 side_float_binary16
;
185 _Float32 side_float_binary32
;
188 _Float64 side_float_binary64
;
191 _Float128 side_float_binary128
;
197 /* User attributes. */
200 const struct side_attr_value value
;
203 struct side_enum_mapping
{
209 struct side_enum_mappings
{
210 const struct side_enum_mapping
*mappings
;
211 const struct side_attr
*attr
;
212 uint32_t nr_mappings
;
216 struct side_enum_bitmap_mapping
{
222 struct side_enum_bitmap_mappings
{
223 const struct side_enum_bitmap_mapping
*mappings
;
224 const struct side_attr
*attr
;
225 uint32_t nr_mappings
;
229 struct side_type_struct
{
232 const struct side_event_field
*fields
;
233 const struct side_attr
*attr
;
236 struct side_type_description
{
237 uint32_t type
; /* enum side_type */
241 const struct side_attr
*attr
;
247 const struct side_type_description
*elem_type
;
248 const struct side_attr
*attr
;
253 const struct side_type_description
*elem_type
;
254 const struct side_attr
*attr
;
258 const struct side_type_description
*elem_type
;
259 side_visitor visitor
;
260 const struct side_attr
*attr
;
263 const struct side_type_struct
*side_struct
;
265 /* Enumeration types */
266 const struct side_enum_mappings
*side_enum_mappings
;
267 const struct side_enum_bitmap_mappings
*side_enum_bitmap_mappings
;
269 const struct side_type_description
*elem_type
;
270 const struct side_enum_bitmap_mappings
*mappings
;
272 } side_enum_bitmap_array
;
274 const struct side_type_description
*elem_type
;
275 const struct side_enum_bitmap_mappings
*mappings
;
276 } side_enum_bitmap_vla
;
280 struct side_event_field
{
281 const char *field_name
;
282 struct side_type_description side_type
;
285 enum side_event_flags
{
286 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
289 struct side_callback
{
291 void (*call
)(const struct side_event_description
*desc
,
292 const struct side_arg_vec_description
*sav_desc
,
294 void (*call_variadic
)(const struct side_event_description
*desc
,
295 const struct side_arg_vec_description
*sav_desc
,
296 const struct side_arg_dynamic_event_struct
*var_struct
,
302 struct side_callbacks
{
303 struct side_callback
*cb
;
307 struct side_event_description
{
310 uint32_t loglevel
; /* enum side_loglevel */
315 const char *provider_name
;
316 const char *event_name
;
317 const struct side_event_field
*fields
;
318 const struct side_attr
*attr
;
319 struct side_callbacks
*callbacks
;
322 struct side_arg_dynamic_vec
{
323 uint32_t dynamic_type
; /* enum side_dynamic_type */
327 const struct side_attr
*attr
;
341 _Float16 side_float_binary16
;
344 _Float32 side_float_binary32
;
347 _Float64 side_float_binary64
;
350 _Float128 side_float_binary128
;
357 const struct side_arg_dynamic_event_struct
*side_dynamic_struct
;
360 side_dynamic_struct_visitor visitor
;
361 const struct side_attr
*attr
;
363 } side_dynamic_struct_visitor
;
364 const struct side_arg_dynamic_vec_vla
*side_dynamic_vla
;
367 side_dynamic_vla_visitor visitor
;
368 const struct side_attr
*attr
;
370 } side_dynamic_vla_visitor
;
374 struct side_arg_dynamic_vec_vla
{
375 const struct side_arg_dynamic_vec
*sav
;
376 const struct side_attr
*attr
;
381 struct side_arg_dynamic_event_field
{
382 const char *field_name
;
383 const struct side_arg_dynamic_vec elem
;
386 struct side_arg_dynamic_event_struct
{
387 const struct side_arg_dynamic_event_field
*fields
;
388 const struct side_attr
*attr
;
393 struct side_arg_vec
{
408 _Float16 side_float_binary16
;
411 _Float32 side_float_binary32
;
414 _Float64 side_float_binary64
;
417 _Float128 side_float_binary128
;
422 const struct side_arg_vec_description
*side_struct
;
423 const struct side_arg_vec_description
*side_array
;
424 const struct side_arg_vec_description
*side_vla
;
425 void *side_vla_app_visitor_ctx
;
426 void *side_array_fixint
;
433 struct side_arg_dynamic_vec dynamic
;
437 struct side_arg_vec_description
{
438 const struct side_arg_vec
*sav
;
442 /* The visitor pattern is a double-dispatch visitor. */
443 struct side_tracer_visitor_ctx
{
444 enum side_visitor_status (*write_elem
)(
445 const struct side_tracer_visitor_ctx
*tracer_ctx
,
446 const struct side_arg_vec
*elem
);
447 void *priv
; /* Private tracer context. */
450 struct side_tracer_dynamic_struct_visitor_ctx
{
451 enum side_visitor_status (*write_field
)(
452 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
453 const struct side_arg_dynamic_event_field
*dynamic_field
);
454 void *priv
; /* Private tracer context. */
457 struct side_tracer_dynamic_vla_visitor_ctx
{
458 enum side_visitor_status (*write_elem
)(
459 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
460 const struct side_arg_dynamic_vec
*elem
);
461 void *priv
; /* Private tracer context. */
464 /* Event and type attributes */
466 #define side_attr(_key, _value) \
469 .value = SIDE_PARAM(_value), \
472 #define side_attr_list(...) \
473 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
475 #define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
476 #define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .side_u8 = (_val) } }
477 #define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .side_u16 = (_val) } }
478 #define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .side_u32 = (_val) } }
479 #define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .side_u64 = (_val) } }
480 #define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .side_s8 = (_val) } }
481 #define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .side_s16 = (_val) } }
482 #define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .side_s32 = (_val) } }
483 #define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .side_s64 = (_val) } }
484 #define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (_val) } }
485 #define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (_val) } }
486 #define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (_val) } }
487 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (_val) } }
488 #define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string = (_val) } }
490 /* Static field definition */
492 #define _side_type_basic(_type, _attr) \
498 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
503 #define side_type_bool(_attr) _side_type_basic(SIDE_TYPE_BOOL, SIDE_PARAM(_attr))
504 #define side_type_u8(_attr) _side_type_basic(SIDE_TYPE_U8, SIDE_PARAM(_attr))
505 #define side_type_u16(_attr) _side_type_basic(SIDE_TYPE_U16, SIDE_PARAM(_attr))
506 #define side_type_u32(_attr) _side_type_basic(SIDE_TYPE_U32, SIDE_PARAM(_attr))
507 #define side_type_u64(_attr) _side_type_basic(SIDE_TYPE_U64, SIDE_PARAM(_attr))
508 #define side_type_s8(_attr) _side_type_basic(SIDE_TYPE_S8, SIDE_PARAM(_attr))
509 #define side_type_s16(_attr) _side_type_basic(SIDE_TYPE_S16, SIDE_PARAM(_attr))
510 #define side_type_s32(_attr) _side_type_basic(SIDE_TYPE_S32, SIDE_PARAM(_attr))
511 #define side_type_s64(_attr) _side_type_basic(SIDE_TYPE_S64, SIDE_PARAM(_attr))
512 #define side_type_blob(_attr) _side_type_basic(SIDE_TYPE_BLOB, SIDE_PARAM(_attr))
513 #define side_type_float_binary16(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY16, SIDE_PARAM(_attr))
514 #define side_type_float_binary32(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY32, SIDE_PARAM(_attr))
515 #define side_type_float_binary64(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY64, SIDE_PARAM(_attr))
516 #define side_type_float_binary128(_attr) _side_type_basic(SIDE_TYPE_FLOAT_BINARY128, SIDE_PARAM(_attr))
517 #define side_type_string(_attr) _side_type_basic(SIDE_TYPE_STRING, SIDE_PARAM(_attr))
518 #define side_type_dynamic(_attr) _side_type_basic(SIDE_TYPE_DYNAMIC, SIDE_PARAM(_attr))
520 #define _side_field(_name, _type) \
522 .field_name = _name, \
523 .side_type = _type, \
526 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
527 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
528 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
529 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
530 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
531 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
532 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
533 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
534 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
535 #define side_field_blob(_name, _attr) _side_field(_name, side_type_blob(SIDE_PARAM(_attr)))
536 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
537 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
538 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
539 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
540 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
541 #define side_field_dynamic(_name, _attr) _side_field(_name, side_type_dynamic(SIDE_PARAM(_attr)))
543 #define side_type_enum(_type, _mappings) \
547 .side_enum_mappings = _mappings, \
550 #define _side_field_enum(_name, _type, _mappings) \
551 _side_field(_name, side_type_enum(_type, SIDE_PARAM(_mappings)))
553 #define side_field_enum_u8(_name, _mappings) \
554 _side_field_enum(_name, SIDE_TYPE_ENUM_U8, SIDE_PARAM(_mappings))
555 #define side_field_enum_u16(_name, _mappings) \
556 _side_field_enum(_name, SIDE_TYPE_ENUM_U16, SIDE_PARAM(_mappings))
557 #define side_field_enum_u32(_name, _mappings) \
558 _side_field_enum(_name, SIDE_TYPE_ENUM_U32, SIDE_PARAM(_mappings))
559 #define side_field_enum_u64(_name, _mappings) \
560 _side_field_enum(_name, SIDE_TYPE_ENUM_U64, SIDE_PARAM(_mappings))
561 #define side_field_enum_s8(_name, _mappings) \
562 _side_field_enum(_name, SIDE_TYPE_ENUM_S8, SIDE_PARAM(_mappings))
563 #define side_field_enum_s16(_name, _mappings) \
564 _side_field_enum(_name, SIDE_TYPE_ENUM_S16, SIDE_PARAM(_mappings))
565 #define side_field_enum_s32(_name, _mappings) \
566 _side_field_enum(_name, SIDE_TYPE_ENUM_S32, SIDE_PARAM(_mappings))
567 #define side_field_enum_s64(_name, _mappings) \
568 _side_field_enum(_name, SIDE_TYPE_ENUM_S64, SIDE_PARAM(_mappings))
570 #define side_type_enum_bitmap(_type, _mappings) \
574 .side_enum_bitmap_mappings = _mappings, \
577 #define side_type_enum_bitmap8(_mappings) \
578 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP8, SIDE_PARAM(_mappings))
579 #define side_type_enum_bitmap16(_mappings) \
580 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP16, SIDE_PARAM(_mappings))
581 #define side_type_enum_bitmap32(_mappings) \
582 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP32, SIDE_PARAM(_mappings))
583 #define side_type_enum_bitmap64(_mappings) \
584 side_type_enum_bitmap(SIDE_TYPE_ENUM_BITMAP64, SIDE_PARAM(_mappings))
586 #define _side_field_enum_bitmap(_name, _type) _side_field(_name, SIDE_PARAM(_type))
588 #define side_field_enum_bitmap8(_name, _mappings) \
589 _side_field_enum_bitmap(_name, side_type_enum_bitmap8(SIDE_PARAM(_mappings)))
590 #define side_field_enum_bitmap16(_name, _mappings) \
591 _side_field_enum_bitmap(_name, side_type_enum_bitmap16(SIDE_PARAM(_mappings)))
592 #define side_field_enum_bitmap32(_name, _mappings) \
593 _side_field_enum_bitmap(_name, side_type_enum_bitmap32(SIDE_PARAM(_mappings)))
594 #define side_field_enum_bitmap64(_name, _mappings) \
595 _side_field_enum_bitmap(_name, side_type_enum_bitmap64(SIDE_PARAM(_mappings)))
597 #define side_type_enum_bitmap_array(_mappings, _elem_type, _length) \
599 .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, \
601 .side_enum_bitmap_array = { \
602 .elem_type = _elem_type, \
603 .mappings = _mappings, \
608 #define side_field_enum_bitmap_array(_name, _mappings, _elem_type, _length) \
609 _side_field(_name, side_type_enum_bitmap_array(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type), _length))
611 #define side_type_enum_bitmap_vla(_mappings, _elem_type) \
613 .type = SIDE_TYPE_ENUM_BITMAP_VLA, \
615 .side_enum_bitmap_vla = { \
616 .elem_type = _elem_type, \
617 .mappings = _mappings, \
621 #define side_field_enum_bitmap_vla(_name, _mappings, _elem_type) \
622 _side_field(_name, side_type_enum_bitmap_vla(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
624 #define side_type_struct(_struct) \
626 .type = SIDE_TYPE_STRUCT, \
628 .side_struct = _struct, \
631 #define side_field_struct(_name, _struct) \
632 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
634 #define _side_type_struct_define(_fields, _attr) \
636 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
637 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
642 #define side_define_struct(_identifier, _fields, _attr) \
643 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
645 #define side_struct_literal(_fields, _attr) \
646 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
647 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
649 #define side_type_array(_elem_type, _length, _attr) \
651 .type = SIDE_TYPE_ARRAY, \
654 .elem_type = _elem_type, \
657 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
661 #define side_field_array(_name, _elem_type, _length, _attr) \
662 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
664 #define side_type_vla(_elem_type, _attr) \
666 .type = SIDE_TYPE_VLA, \
669 .elem_type = _elem_type, \
671 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
675 #define side_field_vla(_name, _elem_type, _attr) \
676 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
678 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
680 .type = SIDE_TYPE_VLA_VISITOR, \
682 .side_vla_visitor = { \
683 .elem_type = SIDE_PARAM(_elem_type), \
684 .visitor = _visitor, \
686 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
690 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
691 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
693 #define side_elem(...) \
694 SIDE_COMPOUND_LITERAL(const struct side_type_description, __VA_ARGS__)
696 #define side_field_list(...) \
697 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
699 /* Static field arguments */
701 #define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
702 #define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .side_u8 = (_val) } }
703 #define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .side_u16 = (_val) } }
704 #define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .side_u32 = (_val) } }
705 #define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .side_u64 = (_val) } }
706 #define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .side_s8 = (_val) } }
707 #define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .side_s16 = (_val) } }
708 #define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .side_s32 = (_val) } }
709 #define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .side_s64 = (_val) } }
710 #define side_arg_blob(_val) { .type = SIDE_TYPE_BLOB, .u = { .side_blob = (_val) } }
711 #define side_arg_enum_u8(_val) { .type = SIDE_TYPE_ENUM_U8, .u = { .side_u8 = (_val) } }
712 #define side_arg_enum_u16(_val) { .type = SIDE_TYPE_ENUM_U16, .u = { .side_u16 = (_val) } }
713 #define side_arg_enum_u32(_val) { .type = SIDE_TYPE_ENUM_U32, .u = { .side_u32 = (_val) } }
714 #define side_arg_enum_u64(_val) { .type = SIDE_TYPE_ENUM_U64, .u = { .side_u64 = (_val) } }
715 #define side_arg_enum_s8(_val) { .type = SIDE_TYPE_ENUM_S8, .u = { .side_s8 = (_val) } }
716 #define side_arg_enum_s16(_val) { .type = SIDE_TYPE_ENUM_S16, .u = { .side_s16 = (_val) } }
717 #define side_arg_enum_s32(_val) { .type = SIDE_TYPE_ENUM_S32, .u = { .side_s32 = (_val) } }
718 #define side_arg_enum_s64(_val) { .type = SIDE_TYPE_ENUM_S64, .u = { .side_s64 = (_val) } }
719 #define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_u8 = (_val) } }
720 #define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_u16 = (_val) } }
721 #define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_u32 = (_val) } }
722 #define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_u64 = (_val) } }
723 #define side_arg_enum_bitmap_array(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_array = (_side_type) } }
724 #define side_arg_enum_bitmap_vla(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_vla = (_side_type) } }
725 #define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_float_binary16 = (_val) } }
726 #define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_float_binary32 = (_val) } }
727 #define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_float_binary64 = (_val) } }
728 #define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_float_binary128 = (_val) } }
730 #define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .string = (_val) } }
731 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_struct = (_side_type) } }
732 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_array = (_side_type) } }
733 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_vla = (_side_type) } }
734 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_vla_app_visitor_ctx = (_ctx) } }
736 #define side_arg_array_u8(_ptr) { .type = SIDE_TYPE_ARRAY_U8, .u = { .side_array_fixint = (_ptr) } }
737 #define side_arg_array_u16(_ptr) { .type = SIDE_TYPE_ARRAY_U16, .u = { .side_array_fixint = (_ptr) } }
738 #define side_arg_array_u32(_ptr) { .type = SIDE_TYPE_ARRAY_U32, .u = { .side_array_fixint = (_ptr) } }
739 #define side_arg_array_u64(_ptr) { .type = SIDE_TYPE_ARRAY_U64, .u = { .side_array_fixint = (_ptr) } }
740 #define side_arg_array_s8(_ptr) { .type = SIDE_TYPE_ARRAY_S8, .u = { .side_array_fixint = (_ptr) } }
741 #define side_arg_array_s16(_ptr) { .type = SIDE_TYPE_ARRAY_S16, .u = { .side_array_fixint = (_ptr) } }
742 #define side_arg_array_s32(_ptr) { .type = SIDE_TYPE_ARRAY_S32, .u = { .side_array_fixint = (_ptr) } }
743 #define side_arg_array_s64(_ptr) { .type = SIDE_TYPE_ARRAY_S64, .u = { .side_array_fixint = (_ptr) } }
744 #define side_arg_array_blob(_ptr) { .type = SIDE_TYPE_ARRAY_BLOB, .u = { .side_array_fixint = (_ptr) } }
746 #define side_arg_vla_u8(_ptr, _length) { .type = SIDE_TYPE_VLA_U8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } }
747 #define side_arg_vla_u16(_ptr, _length) { .type = SIDE_TYPE_VLA_U16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
748 #define side_arg_vla_u32(_ptr, _length) { .type = SIDE_TYPE_VLA_U32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
749 #define side_arg_vla_u64(_ptr, _length) { .type = SIDE_TYPE_VLA_U64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
750 #define side_arg_vla_s8(_ptr, _length) { .type = SIDE_TYPE_VLA_S8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
751 #define side_arg_vla_s16(_ptr, _length) { .type = SIDE_TYPE_VLA_S16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
752 #define side_arg_vla_s32(_ptr, _length) { .type = SIDE_TYPE_VLA_S32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
753 #define side_arg_vla_s64(_ptr, _length) { .type = SIDE_TYPE_VLA_S64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
754 #define side_arg_vla_blob(_ptr, _length) { .type = SIDE_TYPE_VLA_BLOB, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
756 #define side_arg_dynamic(_dynamic_arg_type) \
758 .type = SIDE_TYPE_DYNAMIC, \
760 .dynamic = _dynamic_arg_type, \
764 /* Dynamic field arguments */
766 #define side_arg_dynamic_null(_attr) \
768 .dynamic_type = SIDE_DYNAMIC_TYPE_NULL, \
772 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
777 #define side_arg_dynamic_bool(_val, _attr) \
779 .dynamic_type = SIDE_DYNAMIC_TYPE_BOOL, \
783 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
785 .side_bool = !!(_val), \
791 #define side_arg_dynamic_u8(_val, _attr) \
793 .dynamic_type = SIDE_DYNAMIC_TYPE_U8, \
797 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
804 #define side_arg_dynamic_u16(_val, _attr) \
806 .dynamic_type = SIDE_DYNAMIC_TYPE_U16, \
810 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
812 .side_u16 = (_val), \
817 #define side_arg_dynamic_u32(_val, _attr) \
819 .dynamic_type = SIDE_DYNAMIC_TYPE_U32, \
823 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
825 .side_u32 = (_val), \
830 #define side_arg_dynamic_u64(_val, _attr) \
832 .dynamic_type = SIDE_DYNAMIC_TYPE_U64, \
836 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
838 .side_u64 = (_val), \
844 #define side_arg_dynamic_s8(_val, _attr) \
846 .dynamic_type = SIDE_DYNAMIC_TYPE_S8, \
850 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
857 #define side_arg_dynamic_s16(_val, _attr) \
859 .dynamic_type = SIDE_DYNAMIC_TYPE_S16, \
863 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
865 .side_s16 = (_val), \
870 #define side_arg_dynamic_s32(_val, _attr) \
872 .dynamic_type = SIDE_DYNAMIC_TYPE_S32, \
876 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
878 .side_s32 = (_val), \
883 #define side_arg_dynamic_s64(_val, _attr) \
885 .dynamic_type = SIDE_DYNAMIC_TYPE_S64, \
889 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
891 .side_s64 = (_val), \
896 #define side_arg_dynamic_blob(_val, _attr) \
898 .dynamic_type = SIDE_DYNAMIC_TYPE_BLOB, \
902 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
904 .side_blob = (_val), \
910 #define side_arg_dynamic_float_binary16(_val, _attr) \
912 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY16, \
916 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
918 .side_float_binary16 = (_val), \
923 #define side_arg_dynamic_float_binary32(_val, _attr) \
925 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY32, \
929 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
931 .side_float_binary32 = (_val), \
936 #define side_arg_dynamic_float_binary64(_val, _attr) \
938 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY64, \
942 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
944 .side_float_binary64 = (_val), \
949 #define side_arg_dynamic_float_binary128(_val, _attr) \
951 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY128, \
955 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
957 .side_float_binary128 = (_val), \
963 #define side_arg_dynamic_string(_val, _attr) \
965 .dynamic_type = SIDE_DYNAMIC_TYPE_STRING, \
969 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
977 #define side_arg_dynamic_vla(_vla) \
979 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA, \
981 .side_dynamic_vla = (_vla), \
985 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
987 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA_VISITOR, \
989 .side_dynamic_vla_visitor = { \
991 .visitor = _dynamic_vla_visitor, \
993 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
998 #define side_arg_dynamic_struct(_struct) \
1000 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT, \
1002 .side_dynamic_struct = (_struct), \
1006 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
1008 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT_VISITOR, \
1010 .side_dynamic_struct_visitor = { \
1012 .visitor = _dynamic_struct_visitor, \
1014 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1019 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
1020 const struct side_arg_dynamic_vec _identifier##_vec[] = { _sav }; \
1021 const struct side_arg_dynamic_vec_vla _identifier = { \
1022 .sav = _identifier##_vec, \
1024 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1025 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1028 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
1029 const struct side_arg_dynamic_event_field _identifier##_fields[] = { _struct_fields }; \
1030 const struct side_arg_dynamic_event_struct _identifier = { \
1031 .fields = _identifier##_fields, \
1033 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
1034 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1037 #define side_arg_define_vec(_identifier, _sav) \
1038 const struct side_arg_vec _identifier##_vec[] = { _sav }; \
1039 const struct side_arg_vec_description _identifier = { \
1040 .sav = _identifier##_vec, \
1041 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1044 #define side_arg_dynamic_field(_name, _elem) \
1046 .field_name = _name, \
1050 #define side_arg_list(...) __VA_ARGS__
1052 #define side_define_enum(_identifier, _mappings, _attr) \
1053 const struct side_enum_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_mapping_list(...) \
1061 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
1063 #define side_enum_mapping_range(_label, _begin, _end) \
1065 .range_begin = _begin, \
1066 .range_end = _end, \
1070 #define side_enum_mapping_value(_label, _value) \
1072 .range_begin = _value, \
1073 .range_end = _value, \
1077 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
1078 const struct side_enum_bitmap_mappings _identifier = { \
1079 .mappings = _mappings, \
1081 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1082 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1085 #define side_enum_bitmap_mapping_list(...) \
1086 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
1088 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
1090 .range_begin = _begin, \
1091 .range_end = _end, \
1095 #define side_enum_bitmap_mapping_value(_label, _value) \
1097 .range_begin = _value, \
1098 .range_end = _value, \
1102 #define side_event_cond(_desc) if (side_unlikely(_desc##_enabled))
1104 #define side_event_call(_desc, _sav) \
1106 const struct side_arg_vec side_sav[] = { _sav }; \
1107 const struct side_arg_vec_description sav_desc = { \
1109 .len = SIDE_ARRAY_SIZE(side_sav), \
1111 side_call(&(_desc), &sav_desc); \
1114 #define side_event(_desc, _sav) \
1115 side_event_cond(_desc) \
1116 side_event_call(_desc, SIDE_PARAM(_sav))
1118 #define side_event_call_variadic(_desc, _sav, _var_fields, _attr) \
1120 const struct side_arg_vec side_sav[] = { _sav }; \
1121 const struct side_arg_vec_description sav_desc = { \
1123 .len = SIDE_ARRAY_SIZE(side_sav), \
1125 const struct side_arg_dynamic_event_field side_fields[] = { _var_fields }; \
1126 const struct side_arg_dynamic_event_struct var_struct = { \
1127 .fields = side_fields, \
1129 .len = SIDE_ARRAY_SIZE(side_fields), \
1130 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1132 side_call_variadic(&(_desc), &sav_desc, &var_struct); \
1135 #define side_event_variadic(_desc, _sav, _var, _attr) \
1136 side_event_cond(_desc) \
1137 side_event_call_variadic(_desc, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1139 #define _side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1140 uint32_t _identifier##_enabled __attribute__((section("side_event_enable"))); \
1141 struct side_callbacks _identifier##_callbacks __attribute__((section("side_event_callbacks"))); \
1142 const struct side_event_description _identifier = { \
1144 .enabled = &(_identifier##_enabled), \
1145 .loglevel = _loglevel, \
1146 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1147 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1148 .flags = (_flags), \
1149 .provider_name = _provider, \
1150 .event_name = _event, \
1151 .fields = _fields, \
1153 .callbacks = &(_identifier##_callbacks), \
1155 const struct side_event_description *_identifier##_ptr \
1156 __attribute__((section("side_event_description"), used)) = &(_identifier);
1158 #define side_define_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1159 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1160 SIDE_PARAM(_attr), 0)
1162 #define side_define_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1163 _side_define_event(_identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1164 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1166 #define side_declare_event(_identifier) \
1167 struct side_event_description _identifier
1169 void side_call(const struct side_event_description
*desc
,
1170 const struct side_arg_vec_description
*sav_desc
);
1171 void side_call_variadic(const struct side_event_description
*desc
,
1172 const struct side_arg_vec_description
*sav_desc
,
1173 const struct side_arg_dynamic_event_struct
*var_struct
);
1175 #endif /* _SIDE_TRACE_H */