1 // SPDX-License-Identifier: MIT
3 * Copyright 2022 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
14 #include <side/macros.h>
15 #include <side/endian.h>
18 * SIDE stands for "Static Instrumentation Dynamically Enabled"
20 * This is an instrumentation API for Linux user-space, which exposes an
21 * instrumentation type system and facilities allowing a kernel or
22 * user-space tracer to consume user-space instrumentation.
24 * This instrumentation API exposes 3 type systems:
26 * * Stack-copy type system: This is the core type system which can
27 * represent all supported types and into which all other type systems
28 * can be nested. This type system requires that every type is
29 * statically or dynamically declared and then registered, thus giving
30 * tracers a complete description of the events and their associated
31 * fields before the associated instrumentation is invoked. The
32 * application needs to copy each argument (side_arg_...()) onto the
33 * stack when calling the instrumentation.
35 * This is the most expressive of the 3 type systems, althrough not the
36 * fastest due to the extra copy of the arguments.
38 * * Data-gathering type system: This type system requires every type to
39 * be statically or dynamically declared and registered, but does not
40 * require the application to copy its arguments onto the stack.
41 * Instead, the type description contains all the required information
42 * to fetch the data from the application memory. The only argument
43 * required from the instrumentation is the base pointer from which
44 * the data should be fetched.
46 * This type system can be used as an event field, or nested within
47 * the stack-copy type system. Nesting of gather-vla within
48 * gather-array and gather-vla types is not allowed.
50 * This type system is has the least overhead of the 3 type systems.
52 * * Dynamic type system: This type system receives both type
53 * description and actual data onto the stack at runtime. It has more
54 * overhead that the 2 other type systems, but does not require a
55 * prior registration of event field description. This makes it useful
56 * for seldom used types which are not performance critical, but for
57 * which registering each individual events would needlessly grow the
58 * number of events to declare and register.
60 * Another use-case for this type system is for use by dynamically
61 * typed language runtimes, where the field type is only known when
62 * the instrumentation is called.
64 * Those dynamic types can be either used as arguments to a variadic
65 * field list, or as on-stack instrumentation argument for a static
66 * type SIDE_TYPE_DYNAMIC place holder in the stack-copy type system.
69 //TODO: as those structures will be ABI, we need to either consider them
70 //fixed forever, or think of a scheme that would allow their binary
71 //representation to be extended if need be.
75 struct side_arg_dynamic
;
76 struct side_arg_dynamic_field
;
77 struct side_arg_dynamic_vla
;
79 struct side_event_field
;
80 struct side_tracer_visitor_ctx
;
81 struct side_tracer_dynamic_struct_visitor_ctx
;
82 struct side_event_description
;
83 struct side_arg_dynamic_struct
;
84 struct side_events_register_handle
;
86 enum side_type_label
{
87 /* Stack-copy basic types */
100 SIDE_TYPE_FLOAT_BINARY16
,
101 SIDE_TYPE_FLOAT_BINARY32
,
102 SIDE_TYPE_FLOAT_BINARY64
,
103 SIDE_TYPE_FLOAT_BINARY128
,
106 /* Stack-copy compound types */
110 SIDE_TYPE_VLA_VISITOR
,
112 /* Stack-copy enumeration types */
114 SIDE_TYPE_ENUM_BITMAP
,
116 /* Stack-copy place holder for dynamic types */
119 /* Gather basic types */
120 SIDE_TYPE_GATHER_BOOL
,
121 SIDE_TYPE_GATHER_UNSIGNED_INT
,
122 SIDE_TYPE_GATHER_SIGNED_INT
,
123 SIDE_TYPE_GATHER_BYTE
,
124 SIDE_TYPE_GATHER_POINTER
,
125 SIDE_TYPE_GATHER_FLOAT
,
127 /* Gather compound types */
128 SIDE_TYPE_GATHER_STRUCT
,
129 SIDE_TYPE_GATHER_ARRAY
,
130 SIDE_TYPE_GATHER_VLA
,
132 /* Dynamic basic types */
133 SIDE_TYPE_DYNAMIC_NULL
,
134 SIDE_TYPE_DYNAMIC_BOOL
,
135 SIDE_TYPE_DYNAMIC_U8
,
136 SIDE_TYPE_DYNAMIC_U16
,
137 SIDE_TYPE_DYNAMIC_U32
,
138 SIDE_TYPE_DYNAMIC_U64
,
139 SIDE_TYPE_DYNAMIC_S8
,
140 SIDE_TYPE_DYNAMIC_S16
,
141 SIDE_TYPE_DYNAMIC_S32
,
142 SIDE_TYPE_DYNAMIC_S64
,
143 SIDE_TYPE_DYNAMIC_BYTE
,
144 SIDE_TYPE_DYNAMIC_POINTER
,
145 SIDE_TYPE_DYNAMIC_FLOAT_BINARY16
,
146 SIDE_TYPE_DYNAMIC_FLOAT_BINARY32
,
147 SIDE_TYPE_DYNAMIC_FLOAT_BINARY64
,
148 SIDE_TYPE_DYNAMIC_FLOAT_BINARY128
,
149 SIDE_TYPE_DYNAMIC_STRING
,
151 /* Dynamic compound types */
152 SIDE_TYPE_DYNAMIC_STRUCT
,
153 SIDE_TYPE_DYNAMIC_STRUCT_VISITOR
,
154 SIDE_TYPE_DYNAMIC_VLA
,
155 SIDE_TYPE_DYNAMIC_VLA_VISITOR
,
158 enum side_attr_type
{
169 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
170 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
171 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
172 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
173 SIDE_ATTR_TYPE_STRING
,
177 SIDE_LOGLEVEL_EMERG
= 0,
178 SIDE_LOGLEVEL_ALERT
= 1,
179 SIDE_LOGLEVEL_CRIT
= 2,
180 SIDE_LOGLEVEL_ERR
= 3,
181 SIDE_LOGLEVEL_WARNING
= 4,
182 SIDE_LOGLEVEL_NOTICE
= 5,
183 SIDE_LOGLEVEL_INFO
= 6,
184 SIDE_LOGLEVEL_DEBUG
= 7,
187 enum side_visitor_status
{
188 SIDE_VISITOR_STATUS_OK
= 0,
189 SIDE_VISITOR_STATUS_ERROR
= -1,
194 SIDE_ERROR_INVAL
= 1,
195 SIDE_ERROR_EXIST
= 2,
196 SIDE_ERROR_NOMEM
= 3,
197 SIDE_ERROR_NOENT
= 4,
198 SIDE_ERROR_EXITING
= 5,
201 enum side_type_label_byte_order
{
202 SIDE_TYPE_BYTE_ORDER_LE
= 0,
203 SIDE_TYPE_BYTE_ORDER_BE
= 1,
206 #if (SIDE_BYTE_ORDER == SIDE_LITTLE_ENDIAN)
207 # define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
209 # define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
212 #if (SIDE_FLOAT_WORD_ORDER == SIDE_LITTLE_ENDIAN)
213 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
215 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
218 enum side_type_gather_access_mode
{
219 SIDE_TYPE_GATHER_ACCESS_DIRECT
,
220 SIDE_TYPE_GATHER_ACCESS_POINTER
, /* Pointer dereference */
223 typedef enum side_visitor_status (*side_visitor_func
)(
224 const struct side_tracer_visitor_ctx
*tracer_ctx
,
226 typedef enum side_visitor_status (*side_dynamic_struct_visitor_func
)(
227 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
230 union side_integer_value
{
242 union side_bool_value
{
244 uint16_t side_bool16
;
245 uint32_t side_bool32
;
246 uint64_t side_bool64
;
249 union side_float_value
{
251 _Float16 side_float_binary16
;
254 _Float32 side_float_binary32
;
257 _Float64 side_float_binary64
;
260 _Float128 side_float_binary128
;
264 struct side_attr_value
{
265 uint32_t type
; /* enum side_attr_type */
268 uint64_t string_value
; /* const char * */
269 union side_integer_value integer_value
;
270 union side_float_value float_value
;
274 /* User attributes. */
277 const struct side_attr_value value
;
280 /* Type descriptions */
281 struct side_type_null
{
282 const struct side_attr
*attr
;
286 struct side_type_bool
{
287 const struct side_attr
*attr
;
289 uint16_t bool_size
; /* bytes */
290 uint16_t len_bits
; /* bits. 0 for (bool_size * CHAR_BITS) */
291 uint8_t byte_order
; /* enum side_type_label_byte_order */
294 struct side_type_byte
{
295 const struct side_attr
*attr
;
299 struct side_type_string
{
300 const struct side_attr
*attr
;
304 struct side_type_integer
{
305 const struct side_attr
*attr
;
307 uint16_t integer_size
; /* bytes */
308 uint16_t len_bits
; /* bits. 0 for (integer_size * CHAR_BITS) */
309 uint8_t signedness
; /* true/false */
310 uint8_t byte_order
; /* enum side_type_label_byte_order */
313 struct side_type_float
{
314 const struct side_attr
*attr
;
316 uint16_t float_size
; /* bytes */
317 uint8_t byte_order
; /* enum side_type_label_byte_order */
320 struct side_enum_mapping
{
326 struct side_enum_mappings
{
327 const struct side_enum_mapping
*mappings
;
328 const struct side_attr
*attr
;
329 uint32_t nr_mappings
;
333 struct side_enum_bitmap_mapping
{
334 uint64_t range_begin
;
339 struct side_enum_bitmap_mappings
{
340 const struct side_enum_bitmap_mapping
*mappings
;
341 const struct side_attr
*attr
;
342 uint32_t nr_mappings
;
346 struct side_type_struct
{
347 const struct side_event_field
*fields
;
348 const struct side_attr
*attr
;
353 struct side_type_array
{
354 const struct side_type
*elem_type
;
355 const struct side_attr
*attr
;
360 struct side_type_vla
{
361 const struct side_type
*elem_type
;
362 const struct side_attr
*attr
;
366 struct side_type_vla_visitor
{
367 const struct side_type
*elem_type
;
368 side_visitor_func visitor
;
369 const struct side_attr
*attr
;
373 struct side_type_enum
{
374 const struct side_enum_mappings
*mappings
;
375 const struct side_type
*elem_type
;
378 struct side_type_enum_bitmap
{
379 const struct side_enum_bitmap_mappings
*mappings
;
380 const struct side_type
*elem_type
;
383 struct side_type_gather_bool
{
384 uint64_t offset
; /* bytes */
385 uint8_t access_mode
; /* enum side_type_gather_access_mode */
386 struct side_type_bool type
;
387 uint16_t offset_bits
; /* bits */
390 struct side_type_gather_byte
{
391 uint64_t offset
; /* bytes */
392 uint8_t access_mode
; /* enum side_type_gather_access_mode */
393 struct side_type_byte type
;
396 struct side_type_gather_integer
{
397 uint64_t offset
; /* bytes */
398 uint8_t access_mode
; /* enum side_type_gather_access_mode */
399 struct side_type_integer type
;
400 uint16_t offset_bits
; /* bits */
403 struct side_type_gather_float
{
404 uint64_t offset
; /* bytes */
405 uint8_t access_mode
; /* enum side_type_gather_access_mode */
406 struct side_type_float type
;
409 struct side_type_gather_struct
{
410 uint64_t offset
; /* bytes */
411 uint8_t access_mode
; /* enum side_type_gather_access_mode */
412 const struct side_type_struct
*type
;
413 uint32_t size
; /* bytes */
416 struct side_type_gather_array
{
417 uint64_t offset
; /* bytes */
418 uint8_t access_mode
; /* enum side_type_gather_access_mode */
419 struct side_type_array type
;
422 struct side_type_gather_vla
{
423 const struct side_type
*length_type
; /* side_length() */
425 uint64_t offset
; /* bytes */
426 uint8_t access_mode
; /* enum side_type_gather_access_mode */
427 struct side_type_vla type
;
430 struct side_type_gather
{
432 struct side_type_gather_bool side_bool
;
433 struct side_type_gather_byte side_byte
;
434 struct side_type_gather_integer side_integer
;
435 struct side_type_gather_float side_float
;
436 struct side_type_gather_array side_array
;
437 struct side_type_gather_vla side_vla
;
438 struct side_type_gather_struct side_struct
;
443 uint32_t type
; /* enum side_type_label */
445 /* Stack-copy basic types */
446 struct side_type_null side_null
;
447 struct side_type_bool side_bool
;
448 struct side_type_byte side_byte
;
449 struct side_type_string side_string
;
450 struct side_type_integer side_integer
;
451 struct side_type_float side_float
;
453 /* Stack-copy compound types */
454 struct side_type_array side_array
;
455 struct side_type_vla side_vla
;
456 struct side_type_vla_visitor side_vla_visitor
;
457 const struct side_type_struct
*side_struct
;
459 /* Stack-copy enumeration types */
460 struct side_type_enum side_enum
;
461 struct side_type_enum_bitmap side_enum_bitmap
;
464 struct side_type_gather side_gather
;
468 struct side_event_field
{
469 const char *field_name
;
470 struct side_type side_type
;
473 enum side_event_flags
{
474 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
477 struct side_callback
{
479 void (*call
)(const struct side_event_description
*desc
,
480 const struct side_arg_vec
*side_arg_vec
,
482 void (*call_variadic
)(const struct side_event_description
*desc
,
483 const struct side_arg_vec
*side_arg_vec
,
484 const struct side_arg_dynamic_struct
*var_struct
,
490 struct side_arg_static
{
491 /* Stack-copy basic types */
492 union side_bool_value bool_value
;
494 uint64_t string_value
; /* const char * */
495 union side_integer_value integer_value
;
496 union side_float_value float_value
;
498 /* Stack-copy compound types */
499 const struct side_arg_vec
*side_struct
;
500 const struct side_arg_vec
*side_array
;
501 const struct side_arg_vec
*side_vla
;
502 void *side_vla_app_visitor_ctx
;
504 /* Gather basic types */
505 void *side_bool_gather_ptr
;
506 void *side_byte_gather_ptr
;
507 void *side_integer_gather_ptr
;
508 void *side_float_gather_ptr
;
510 /* Gather compound types */
511 void *side_array_gather_ptr
;
512 void *side_struct_gather_ptr
;
516 } SIDE_PACKED side_vla_gather
;
519 struct side_arg_dynamic_vla
{
520 const struct side_arg
*sav
;
521 const struct side_attr
*attr
;
526 struct side_arg_dynamic_struct
{
527 const struct side_arg_dynamic_field
*fields
;
528 const struct side_attr
*attr
;
533 struct side_dynamic_struct_visitor
{
535 side_dynamic_struct_visitor_func visitor
;
536 const struct side_attr
*attr
;
540 struct side_dynamic_vla_visitor
{
542 side_visitor_func visitor
;
543 const struct side_attr
*attr
;
547 struct side_arg_dynamic
{
548 /* Dynamic basic types */
549 struct side_type_null side_null
;
551 struct side_type_bool type
;
552 union side_bool_value value
;
553 } SIDE_PACKED side_bool
;
555 struct side_type_byte type
;
557 } SIDE_PACKED side_byte
;
559 struct side_type_string type
;
560 uint64_t value
; /* const char * */
561 } SIDE_PACKED side_string
;
563 struct side_type_integer type
;
564 union side_integer_value value
;
565 } SIDE_PACKED side_integer
;
567 struct side_type_float type
;
568 union side_float_value value
;
569 } SIDE_PACKED side_float
;
571 /* Dynamic compound types */
572 const struct side_arg_dynamic_struct
*side_dynamic_struct
;
573 const struct side_arg_dynamic_vla
*side_dynamic_vla
;
575 struct side_dynamic_struct_visitor side_dynamic_struct_visitor
;
576 struct side_dynamic_vla_visitor side_dynamic_vla_visitor
;
580 enum side_type_label type
;
582 struct side_arg_static side_static
;
583 struct side_arg_dynamic side_dynamic
;
587 struct side_arg_vec
{
588 const struct side_arg
*sav
;
592 struct side_arg_dynamic_field
{
593 const char *field_name
;
594 const struct side_arg elem
;
597 /* The visitor pattern is a double-dispatch visitor. */
598 struct side_tracer_visitor_ctx
{
599 enum side_visitor_status (*write_elem
)(
600 const struct side_tracer_visitor_ctx
*tracer_ctx
,
601 const struct side_arg
*elem
);
602 void *priv
; /* Private tracer context. */
605 struct side_tracer_dynamic_struct_visitor_ctx
{
606 enum side_visitor_status (*write_field
)(
607 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
608 const struct side_arg_dynamic_field
*dynamic_field
);
609 void *priv
; /* Private tracer context. */
612 struct side_event_description
{
614 const char *provider_name
;
615 const char *event_name
;
616 const struct side_event_field
*fields
;
617 const struct side_attr
*attr
;
618 const struct side_callback
*callbacks
;
621 uint32_t loglevel
; /* enum side_loglevel */
624 uint32_t nr_callbacks
;
627 /* Event and type attributes */
629 #define side_attr(_key, _value) \
632 .value = SIDE_PARAM(_value), \
635 #define side_attr_list(...) \
636 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
638 #define side_attr_null(_val) { .type = SIDE_ATTR_TYPE_NULL }
639 #define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .bool_value = !!(_val) } }
640 #define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .integer_value = { .side_u8 = (_val) } } }
641 #define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .integer_value = { .side_u16 = (_val) } } }
642 #define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .integer_value = { .side_u32 = (_val) } } }
643 #define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .integer_value = { .side_u64 = (_val) } } }
644 #define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .integer_value = { .side_s8 = (_val) } } }
645 #define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .integer_value = { .side_s16 = (_val) } } }
646 #define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .integer_value = { .side_s32 = (_val) } } }
647 #define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .integer_value = { .side_s64 = (_val) } } }
648 #define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .float_value = { .side_float_binary16 = (_val) } } }
649 #define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .float_value = { .side_float_binary32 = (_val) } } }
650 #define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .float_value = { .side_float_binary64 = (_val) } } }
651 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .float_value = { .side_float_binary128 = (_val) } } }
652 #define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string_value = (uintptr_t) (_val) } }
654 /* Stack-copy enumeration type definitions */
656 #define side_define_enum(_identifier, _mappings, _attr) \
657 const struct side_enum_mappings _identifier = { \
658 .mappings = _mappings, \
660 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
661 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
664 #define side_enum_mapping_list(...) \
665 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
667 #define side_enum_mapping_range(_label, _begin, _end) \
669 .range_begin = _begin, \
674 #define side_enum_mapping_value(_label, _value) \
676 .range_begin = _value, \
677 .range_end = _value, \
681 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
682 const struct side_enum_bitmap_mappings _identifier = { \
683 .mappings = _mappings, \
685 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
686 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
689 #define side_enum_bitmap_mapping_list(...) \
690 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
692 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
694 .range_begin = _begin, \
699 #define side_enum_bitmap_mapping_value(_label, _value) \
701 .range_begin = _value, \
702 .range_end = _value, \
706 /* Stack-copy field and type definitions */
708 #define side_type_null(_attr) \
710 .type = SIDE_TYPE_NULL, \
714 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
719 #define side_type_bool(_attr) \
721 .type = SIDE_TYPE_BOOL, \
725 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
726 .bool_size = sizeof(uint8_t), \
728 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
733 #define side_type_byte(_attr) \
735 .type = SIDE_TYPE_BYTE, \
739 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
744 #define side_type_string(_attr) \
746 .type = SIDE_TYPE_STRING, \
750 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
755 #define side_type_dynamic() \
757 .type = SIDE_TYPE_DYNAMIC, \
760 #define _side_type_integer(_type, _signedness, _byte_order, _integer_size, _len_bits, _attr) \
766 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
767 .integer_size = _integer_size, \
768 .len_bits = _len_bits, \
769 .signedness = _signedness, \
770 .byte_order = _byte_order, \
775 #define _side_type_float(_type, _byte_order, _float_size, _attr) \
781 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
782 .float_size = _float_size, \
783 .byte_order = _byte_order, \
788 #define _side_field(_name, _type) \
790 .field_name = _name, \
791 .side_type = _type, \
795 #define side_type_u8(_attr) _side_type_integer(SIDE_TYPE_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint8_t), 0, SIDE_PARAM(_attr))
796 #define side_type_u16(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
797 #define side_type_u32(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
798 #define side_type_u64(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
799 #define side_type_s8(_attr) _side_type_integer(SIDE_TYPE_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int8_t), 0, SIDE_PARAM(_attr))
800 #define side_type_s16(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int16_t), 0, SIDE_PARAM(_attr))
801 #define side_type_s32(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int32_t), 0, SIDE_PARAM(_attr))
802 #define side_type_s64(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int64_t), 0, SIDE_PARAM(_attr))
803 #define side_type_pointer(_attr) _side_type_integer(SIDE_TYPE_POINTER, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
804 #define side_type_float_binary16(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float16), SIDE_PARAM(_attr))
805 #define side_type_float_binary32(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float32), SIDE_PARAM(_attr))
806 #define side_type_float_binary64(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float64), SIDE_PARAM(_attr))
807 #define side_type_float_binary128(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float128), SIDE_PARAM(_attr))
809 #define side_field_null(_name, _attr) _side_field(_name, side_type_null(SIDE_PARAM(_attr)))
810 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
811 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
812 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
813 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
814 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
815 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
816 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
817 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
818 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
819 #define side_field_byte(_name, _attr) _side_field(_name, side_type_byte(SIDE_PARAM(_attr)))
820 #define side_field_pointer(_name, _attr) _side_field(_name, side_type_pointer(SIDE_PARAM(_attr)))
821 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
822 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
823 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
824 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
825 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
826 #define side_field_dynamic(_name) _side_field(_name, side_type_dynamic())
829 #define side_type_u16_le(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
830 #define side_type_u32_le(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
831 #define side_type_u64_le(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
832 #define side_type_s16_le(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_LE, sizeof(int16_t), 0, SIDE_PARAM(_attr))
833 #define side_type_s32_le(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_LE, sizeof(int32_t), 0, SIDE_PARAM(_attr))
834 #define side_type_s64_le(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_LE, sizeof(int64_t), 0, SIDE_PARAM(_attr))
835 #define side_type_pointer_le(_attr) _side_type_integer(SIDE_TYPE_POINTER, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
836 #define side_type_float_binary16_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float16), SIDE_PARAM(_attr))
837 #define side_type_float_binary32_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float32), SIDE_PARAM(_attr))
838 #define side_type_float_binary64_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float64), SIDE_PARAM(_attr))
839 #define side_type_float_binary128_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float128), SIDE_PARAM(_attr))
841 #define side_field_u16_le(_name, _attr) _side_field(_name, side_type_u16_le(SIDE_PARAM(_attr)))
842 #define side_field_u32_le(_name, _attr) _side_field(_name, side_type_u32_le(SIDE_PARAM(_attr)))
843 #define side_field_u64_le(_name, _attr) _side_field(_name, side_type_u64_le(SIDE_PARAM(_attr)))
844 #define side_field_s16_le(_name, _attr) _side_field(_name, side_type_s16_le(SIDE_PARAM(_attr)))
845 #define side_field_s32_le(_name, _attr) _side_field(_name, side_type_s32_le(SIDE_PARAM(_attr)))
846 #define side_field_s64_le(_name, _attr) _side_field(_name, side_type_s64_le(SIDE_PARAM(_attr)))
847 #define side_field_pointer_le(_name, _attr) _side_field(_name, side_type_pointer_le(SIDE_PARAM(_attr)))
848 #define side_field_float_binary16_le(_name, _attr) _side_field(_name, side_type_float_binary16_le(SIDE_PARAM(_attr)))
849 #define side_field_float_binary32_le(_name, _attr) _side_field(_name, side_type_float_binary32_le(SIDE_PARAM(_attr)))
850 #define side_field_float_binary64_le(_name, _attr) _side_field(_name, side_type_float_binary64_le(SIDE_PARAM(_attr)))
851 #define side_field_float_binary128_le(_name, _attr) _side_field(_name, side_type_float_binary128_le(SIDE_PARAM(_attr)))
854 #define side_type_u16_be(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
855 #define side_type_u32_be(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
856 #define side_type_u64_be(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
857 #define side_type_s16_be(_attr) _side_type_integer(SIDE_TYPE_S16, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(int16_t), 0, SIDE_PARAM(_attr))
858 #define side_type_s32_be(_attr) _side_type_integer(SIDE_TYPE_S32, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(int32_t), 0, SIDE_PARAM(_attr))
859 #define side_type_s64_be(_attr) _side_type_integer(SIDE_TYPE_S64, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(int64_t), 0, SIDE_PARAM(_attr))
860 #define side_type_pointer_be(_attr) _side_type_integer(SIDE_TYPE_POINTER, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
861 #define side_type_float_binary16_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float16), SIDE_PARAM(_attr))
862 #define side_type_float_binary32_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float32), SIDE_PARAM(_attr))
863 #define side_type_float_binary64_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float64), SIDE_PARAM(_attr))
864 #define side_type_float_binary128_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float128), SIDE_PARAM(_attr))
866 #define side_field_u16_be(_name, _attr) _side_field(_name, side_type_u16_be(SIDE_PARAM(_attr)))
867 #define side_field_u32_be(_name, _attr) _side_field(_name, side_type_u32_be(SIDE_PARAM(_attr)))
868 #define side_field_u64_be(_name, _attr) _side_field(_name, side_type_u64_be(SIDE_PARAM(_attr)))
869 #define side_field_s16_be(_name, _attr) _side_field(_name, side_type_s16_be(SIDE_PARAM(_attr)))
870 #define side_field_s32_be(_name, _attr) _side_field(_name, side_type_s32_be(SIDE_PARAM(_attr)))
871 #define side_field_s64_be(_name, _attr) _side_field(_name, side_type_s64_be(SIDE_PARAM(_attr)))
872 #define side_field_pointer_be(_name, _attr) _side_field(_name, side_type_pointer_be(SIDE_PARAM(_attr)))
873 #define side_field_float_binary16_be(_name, _attr) _side_field(_name, side_type_float_binary16_be(SIDE_PARAM(_attr)))
874 #define side_field_float_binary32_be(_name, _attr) _side_field(_name, side_type_float_binary32_be(SIDE_PARAM(_attr)))
875 #define side_field_float_binary64_be(_name, _attr) _side_field(_name, side_type_float_binary64_be(SIDE_PARAM(_attr)))
876 #define side_field_float_binary128_be(_name, _attr) _side_field(_name, side_type_float_binary128_be(SIDE_PARAM(_attr)))
878 #define side_type_enum(_mappings, _elem_type) \
880 .type = SIDE_TYPE_ENUM, \
883 .mappings = _mappings, \
884 .elem_type = _elem_type, \
888 #define side_field_enum(_name, _mappings, _elem_type) \
889 _side_field(_name, side_type_enum(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
891 #define side_type_enum_bitmap(_mappings, _elem_type) \
893 .type = SIDE_TYPE_ENUM_BITMAP, \
895 .side_enum_bitmap = { \
896 .mappings = _mappings, \
897 .elem_type = _elem_type, \
901 #define side_field_enum_bitmap(_name, _mappings, _elem_type) \
902 _side_field(_name, side_type_enum_bitmap(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
904 #define side_type_struct(_struct) \
906 .type = SIDE_TYPE_STRUCT, \
908 .side_struct = _struct, \
911 #define side_field_struct(_name, _struct) \
912 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
914 #define _side_type_struct_define(_fields, _attr) \
918 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
919 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
922 #define side_define_struct(_identifier, _fields, _attr) \
923 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
925 #define side_struct_literal(_fields, _attr) \
926 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
927 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
929 #define side_type_array(_elem_type, _length, _attr) \
931 .type = SIDE_TYPE_ARRAY, \
934 .elem_type = _elem_type, \
937 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
941 #define side_field_array(_name, _elem_type, _length, _attr) \
942 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
944 #define side_type_vla(_elem_type, _attr) \
946 .type = SIDE_TYPE_VLA, \
949 .elem_type = _elem_type, \
951 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
955 #define side_field_vla(_name, _elem_type, _attr) \
956 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
958 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
960 .type = SIDE_TYPE_VLA_VISITOR, \
962 .side_vla_visitor = { \
963 .elem_type = SIDE_PARAM(_elem_type), \
964 .visitor = _visitor, \
966 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
970 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
971 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
973 /* Gather field and type definitions */
975 #define side_type_gather_byte(_offset, _access_mode, _attr) \
977 .type = SIDE_TYPE_GATHER_BYTE, \
983 .access_mode = _access_mode, \
986 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
993 #define side_field_gather_byte(_name, _offset, _access_mode, _attr) \
994 _side_field(_name, side_type_gather_byte(_offset, _access_mode, SIDE_PARAM(_attr)))
996 #define _side_type_gather_bool(_byte_order, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
998 .type = SIDE_TYPE_GATHER_BOOL, \
1003 .offset = _offset, \
1004 .access_mode = _access_mode, \
1007 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1008 .bool_size = _bool_size, \
1009 .len_bits = _len_bits, \
1010 .byte_order = _byte_order, \
1012 .offset_bits = _offset_bits, \
1018 #define side_type_gather_bool(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1019 _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_HOST, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1020 #define side_type_gather_bool_le(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1021 _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_LE, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1022 #define side_type_gather_bool_be(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1023 _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_BE, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1025 #define side_field_gather_bool(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1026 _side_field(_name, side_type_gather_bool(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1027 #define side_field_gather_bool_le(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1028 _side_field(_name, side_type_gather_bool_le(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1029 #define side_field_gather_bool_be(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1030 _side_field(_name, side_type_gather_bool_be(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1032 #define _side_type_gather_integer(_type, _signedness, _byte_order, _offset, \
1033 _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1040 .offset = _offset, \
1041 .access_mode = _access_mode, \
1044 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1045 .integer_size = _integer_size, \
1046 .len_bits = _len_bits, \
1047 .signedness = _signedness, \
1048 .byte_order = _byte_order, \
1050 .offset_bits = _offset_bits, \
1057 #define side_type_gather_unsigned_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1058 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_HOST, \
1059 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1060 #define side_type_gather_signed_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1061 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_HOST, \
1062 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1064 #define side_type_gather_unsigned_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1065 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_LE, \
1066 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1067 #define side_type_gather_signed_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1068 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_LE, \
1069 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1071 #define side_type_gather_unsigned_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1072 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_BE, \
1073 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1074 #define side_type_gather_signed_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1075 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_BE, \
1076 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1078 #define side_field_gather_unsigned_integer(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1079 _side_field(_name, side_type_gather_unsigned_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1080 #define side_field_gather_signed_integer(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1081 _side_field(_name, side_type_gather_signed_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1083 #define side_field_gather_unsigned_integer_le(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1084 _side_field(_name, side_type_gather_unsigned_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1085 #define side_field_gather_signed_integer_le(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1086 _side_field(_name, side_type_gather_signed_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1088 #define side_field_gather_unsigned_integer_be(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1089 _side_field(_name, side_type_gather_unsigned_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1090 #define side_field_gather_signed_integer_be(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1091 _side_field(_name, side_type_gather_signed_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1093 #define side_type_gather_pointer(_offset, _access_mode, _attr) \
1094 _side_type_gather_integer(SIDE_TYPE_GATHER_POINTER, false, SIDE_TYPE_BYTE_ORDER_HOST, \
1095 _offset, sizeof(uintptr_t), 0, 0, _access_mode, SIDE_PARAM(_attr))
1096 #define side_field_gather_pointer(_name, _offset, _access_mode, _attr) \
1097 _side_field(_name, side_type_gather_pointer(_offset, _access_mode, SIDE_PARAM(_attr)))
1099 #define side_type_gather_pointer_le(_offset, _access_mode, _attr) \
1100 _side_type_gather_integer(SIDE_TYPE_GATHER_POINTER, false, SIDE_TYPE_BYTE_ORDER_LE, \
1101 _offset, sizeof(uintptr_t), 0, 0, _access_mode, SIDE_PARAM(_attr))
1102 #define side_field_gather_pointer_le(_name, _offset, _access_mode, _attr) \
1103 _side_field(_name, side_type_gather_pointer_le(_offset, _access_mode, SIDE_PARAM(_attr)))
1105 #define side_type_gather_pointer_be(_offset, _access_mode, _attr) \
1106 _side_type_gather_integer(SIDE_TYPE_GATHER_POINTER, false, SIDE_TYPE_BYTE_ORDER_BE, \
1107 _offset, sizeof(uintptr_t), 0, 0, _access_mode, SIDE_PARAM(_attr))
1108 #define side_field_gather_pointer_be(_name, _offset, _access_mode, _attr) \
1109 _side_field(_name, side_type_gather_pointer_be(_offset, _access_mode, SIDE_PARAM(_attr)))
1111 #define _side_type_gather_float(_byte_order, _offset, _float_size, _access_mode, _attr) \
1113 .type = SIDE_TYPE_GATHER_FLOAT, \
1118 .offset = _offset, \
1119 .access_mode = _access_mode, \
1122 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1123 .float_size = _float_size, \
1124 .byte_order = _byte_order, \
1132 #define side_type_gather_float(_offset, _float_size, _access_mode, _attr) \
1133 _side_type_gather_float(SIDE_TYPE_FLOAT_WORD_ORDER_HOST, _offset, _float_size, _access_mode, _attr)
1134 #define side_type_gather_float_le(_offset, _float_size, _access_mode, _attr) \
1135 _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_LE, _offset, _float_size, _access_mode, _attr)
1136 #define side_type_gather_float_be(_offset, _float_size, _access_mode, _attr) \
1137 _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_BE, _offset, _float_size, _access_mode, _attr)
1139 #define side_field_gather_float(_name, _offset, _float_size, _access_mode, _attr) \
1140 _side_field(_name, side_type_gather_float(_offset, _float_size, _access_mode, _attr))
1141 #define side_field_gather_float_le(_name, _offset, _float_size, _access_mode, _attr) \
1142 _side_field(_name, side_type_gather_float_le(_offset, _float_size, _access_mode, _attr))
1143 #define side_field_gather_float_be(_name, _offset, _float_size, _access_mode, _attr) \
1144 _side_field(_name, side_type_gather_float_be(_offset, _float_size, _access_mode, _attr))
1146 #define side_type_gather_struct(_struct_gather, _offset, _size, _access_mode) \
1148 .type = SIDE_TYPE_GATHER_STRUCT, \
1153 .offset = _offset, \
1154 .access_mode = _access_mode, \
1155 .type = _struct_gather, \
1162 #define side_field_gather_struct(_name, _struct_gather, _offset, _size, _access_mode) \
1163 _side_field(_name, side_type_gather_struct(SIDE_PARAM(_struct_gather), _offset, _size, _access_mode))
1165 #define side_type_gather_array(_elem_type_gather, _length, _offset, _access_mode, _attr) \
1167 .type = SIDE_TYPE_GATHER_ARRAY, \
1172 .offset = _offset, \
1173 .access_mode = _access_mode, \
1175 .elem_type = _elem_type_gather, \
1177 .length = _length, \
1178 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1185 #define side_field_gather_array(_name, _elem_type, _length, _offset, _access_mode, _attr) \
1186 _side_field(_name, side_type_gather_array(SIDE_PARAM(_elem_type), _length, _offset, _access_mode, SIDE_PARAM(_attr)))
1188 #define side_type_gather_vla(_elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1190 .type = SIDE_TYPE_GATHER_VLA, \
1195 .offset = _offset, \
1196 .access_mode = _access_mode, \
1198 .elem_type = _elem_type_gather, \
1200 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1202 .length_type = _length_type_gather, \
1208 #define side_field_gather_vla(_name, _elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1209 _side_field(_name, side_type_gather_vla(SIDE_PARAM(_elem_type_gather), _offset, _access_mode, SIDE_PARAM(_length_type_gather), SIDE_PARAM(_attr)))
1211 #define side_elem(...) \
1212 SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1214 #define side_length(...) \
1215 SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1217 #define side_field_list(...) \
1218 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
1220 /* Stack-copy field arguments */
1222 #define side_arg_null(_val) { .type = SIDE_TYPE_NULL }
1223 #define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .side_static = { .bool_value.side_bool8 = !!(_val) } } }
1224 #define side_arg_byte(_val) { .type = SIDE_TYPE_BYTE, .u = { .side_static = { .byte_value = (_val) } } }
1225 #define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .side_static = { .string_value = (uintptr_t) (_val) } } }
1227 #define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1228 #define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1229 #define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1230 #define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1231 #define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .side_static = { .integer_value = { .side_s8 = (_val) } } } }
1232 #define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .side_static = { .integer_value = { .side_s16 = (_val) } } } }
1233 #define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .side_static = { .integer_value = { .side_s32 = (_val) } } } }
1234 #define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .side_static = { .integer_value = { .side_s64 = (_val) } } } }
1235 #define side_arg_pointer(_val) { .type = SIDE_TYPE_POINTER, .u = { .side_static = { .integer_value = { .side_uptr = (uintptr_t) (_val) } } } }
1236 #define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1237 #define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1238 #define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1239 #define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1240 #define side_arg_enum_bitmap_array(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1241 #define side_arg_enum_bitmap_vla(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1242 #define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_static = { .float_value = { .side_float_binary16 = (_val) } } } }
1243 #define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_static = { .float_value = { .side_float_binary32 = (_val) } } } }
1244 #define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_static = { .float_value = { .side_float_binary64 = (_val) } } } }
1245 #define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_static = { .float_value = { .side_float_binary128 = (_val) } } } }
1247 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_static = { .side_struct = (_side_type) } } }
1248 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1249 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1250 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_static = { .side_vla_app_visitor_ctx = (_ctx) } } }
1252 /* Gather field arguments */
1254 #define side_arg_gather_bool(_ptr) { .type = SIDE_TYPE_GATHER_BOOL, .u = { .side_static = { .side_bool_gather_ptr = (_ptr) } } }
1255 #define side_arg_gather_byte(_ptr) { .type = SIDE_TYPE_GATHER_BYTE, .u = { .side_static = { .side_byte_gather_ptr = (_ptr) } } }
1256 #define side_arg_gather_pointer(_ptr) { .type = SIDE_TYPE_GATHER_POINTER, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1257 #define side_arg_gather_unsigned_integer(_ptr) { .type = SIDE_TYPE_GATHER_UNSIGNED_INT, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1258 #define side_arg_gather_signed_integer(_ptr) { .type = SIDE_TYPE_GATHER_SIGNED_INT, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1259 #define side_arg_gather_float(_ptr) { .type = SIDE_TYPE_GATHER_FLOAT, .u = { .side_static = { .side_float_gather_ptr = (_ptr) } } }
1260 #define side_arg_gather_struct(_ptr) { .type = SIDE_TYPE_GATHER_STRUCT, .u = { .side_static = { .side_struct_gather_ptr = (_ptr) } } }
1261 #define side_arg_gather_array(_ptr) { .type = SIDE_TYPE_GATHER_ARRAY, .u = { .side_static = { .side_array_gather_ptr = (_ptr) } } }
1262 #define side_arg_gather_vla(_ptr, _length_ptr) { .type = SIDE_TYPE_GATHER_VLA, .u = { .side_static = { .side_vla_gather = { .ptr = (_ptr), .length_ptr = (_length_ptr) } } } }
1264 /* Dynamic field arguments */
1266 #define side_arg_dynamic_null(_attr) \
1268 .type = SIDE_TYPE_DYNAMIC_NULL, \
1273 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1279 #define side_arg_dynamic_bool(_val, _attr) \
1281 .type = SIDE_TYPE_DYNAMIC_BOOL, \
1287 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1288 .bool_size = sizeof(uint8_t), \
1290 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
1293 .side_bool8 = !!(_val), \
1300 #define side_arg_dynamic_byte(_val, _attr) \
1302 .type = SIDE_TYPE_DYNAMIC_BYTE, \
1308 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1315 #define side_arg_dynamic_string(_val, _attr) \
1317 .type = SIDE_TYPE_DYNAMIC_STRING, \
1323 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1325 .value = (uintptr_t) (_val), \
1331 #define _side_arg_dynamic_integer(_field, _val, _type, _signedness, _byte_order, _integer_size, _len_bits, _attr) \
1339 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1340 .integer_size = _integer_size, \
1341 .len_bits = _len_bits, \
1342 .signedness = _signedness, \
1343 .byte_order = _byte_order, \
1353 #define side_arg_dynamic_u8(_val, _attr) \
1354 _side_arg_dynamic_integer(.side_u8, _val, SIDE_TYPE_DYNAMIC_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint8_t), 0, SIDE_PARAM(_attr))
1355 #define side_arg_dynamic_s8(_val, _attr) \
1356 _side_arg_dynamic_integer(.side_s8, _val, SIDE_TYPE_DYNAMIC_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int8_t), 0, SIDE_PARAM(_attr))
1358 #define _side_arg_dynamic_u16(_val, _byte_order, _attr) \
1359 _side_arg_dynamic_integer(.side_u16, _val, SIDE_TYPE_DYNAMIC_U16, false, _byte_order, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
1360 #define _side_arg_dynamic_u32(_val, _byte_order, _attr) \
1361 _side_arg_dynamic_integer(.side_u32, _val, SIDE_TYPE_DYNAMIC_U32, false, _byte_order, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
1362 #define _side_arg_dynamic_u64(_val, _byte_order, _attr) \
1363 _side_arg_dynamic_integer(.side_u64, _val, SIDE_TYPE_DYNAMIC_U64, false, _byte_order, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
1365 #define _side_arg_dynamic_s16(_val, _byte_order, _attr) \
1366 _side_arg_dynamic_integer(.side_s16, _val, SIDE_TYPE_DYNAMIC_S16, true, _byte_order, sizeof(int16_t), 0, SIDE_PARAM(_attr))
1367 #define _side_arg_dynamic_s32(_val, _byte_order, _attr) \
1368 _side_arg_dynamic_integer(.side_s32, _val, SIDE_TYPE_DYNAMIC_S32, true, _byte_order, sizeof(int32_t), 0, SIDE_PARAM(_attr))
1369 #define _side_arg_dynamic_s64(_val, _byte_order, _attr) \
1370 _side_arg_dynamic_integer(.side_s64, _val, SIDE_TYPE_DYNAMIC_S64, true, _byte_order, sizeof(int64_t), 0, SIDE_PARAM(_attr))
1372 #define _side_arg_dynamic_pointer(_val, _byte_order, _attr) \
1373 _side_arg_dynamic_integer(.side_uptr, (uintptr_t) (_val), SIDE_TYPE_DYNAMIC_POINTER, false, _byte_order, \
1374 sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
1376 #define _side_arg_dynamic_float(_field, _val, _type, _byte_order, _float_size, _attr) \
1384 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1385 .float_size = _float_size, \
1386 .byte_order = _byte_order, \
1396 #define _side_arg_dynamic_float_binary16(_val, _byte_order, _attr) \
1397 _side_arg_dynamic_float(.side_float_binary16, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY16, _byte_order, sizeof(_Float16), SIDE_PARAM(_attr))
1398 #define _side_arg_dynamic_float_binary32(_val, _byte_order, _attr) \
1399 _side_arg_dynamic_float(.side_float_binary32, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY32, _byte_order, sizeof(_Float32), SIDE_PARAM(_attr))
1400 #define _side_arg_dynamic_float_binary64(_val, _byte_order, _attr) \
1401 _side_arg_dynamic_float(.side_float_binary64, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY64, _byte_order, sizeof(_Float64), SIDE_PARAM(_attr))
1402 #define _side_arg_dynamic_float_binary128(_val, _byte_order, _attr) \
1403 _side_arg_dynamic_float(.side_float_binary128, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY128, _byte_order, sizeof(_Float128), SIDE_PARAM(_attr))
1406 #define side_arg_dynamic_u16(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1407 #define side_arg_dynamic_u32(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1408 #define side_arg_dynamic_u64(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1409 #define side_arg_dynamic_s16(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1410 #define side_arg_dynamic_s32(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1411 #define side_arg_dynamic_s64(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1412 #define side_arg_dynamic_pointer(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1413 #define side_arg_dynamic_float_binary16(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1414 #define side_arg_dynamic_float_binary32(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1415 #define side_arg_dynamic_float_binary64(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1416 #define side_arg_dynamic_float_binary128(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1419 #define side_arg_dynamic_u16_le(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1420 #define side_arg_dynamic_u32_le(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1421 #define side_arg_dynamic_u64_le(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1422 #define side_arg_dynamic_s16_le(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1423 #define side_arg_dynamic_s32_le(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1424 #define side_arg_dynamic_s64_le(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1425 #define side_arg_dynamic_pointer_le(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1426 #define side_arg_dynamic_float_binary16_le(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1427 #define side_arg_dynamic_float_binary32_le(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1428 #define side_arg_dynamic_float_binary64_le(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1429 #define side_arg_dynamic_float_binary128_le(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1432 #define side_arg_dynamic_u16_be(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1433 #define side_arg_dynamic_u32_be(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1434 #define side_arg_dynamic_u64_be(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1435 #define side_arg_dynamic_s16_be(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1436 #define side_arg_dynamic_s32_be(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1437 #define side_arg_dynamic_s64_be(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1438 #define side_arg_dynamic_pointer_be(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1439 #define side_arg_dynamic_float_binary16_be(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1440 #define side_arg_dynamic_float_binary32_be(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1441 #define side_arg_dynamic_float_binary64_be(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1442 #define side_arg_dynamic_float_binary128_be(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1444 #define side_arg_dynamic_vla(_vla) \
1446 .type = SIDE_TYPE_DYNAMIC_VLA, \
1449 .side_dynamic_vla = (_vla), \
1454 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
1456 .type = SIDE_TYPE_DYNAMIC_VLA_VISITOR, \
1459 .side_dynamic_vla_visitor = { \
1461 .visitor = _dynamic_vla_visitor, \
1463 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1469 #define side_arg_dynamic_struct(_struct) \
1471 .type = SIDE_TYPE_DYNAMIC_STRUCT, \
1474 .side_dynamic_struct = (_struct), \
1479 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
1481 .type = SIDE_TYPE_DYNAMIC_STRUCT_VISITOR, \
1484 .side_dynamic_struct_visitor = { \
1486 .visitor = _dynamic_struct_visitor, \
1488 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1494 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
1495 const struct side_arg _identifier##_vec[] = { _sav }; \
1496 const struct side_arg_dynamic_vla _identifier = { \
1497 .sav = _identifier##_vec, \
1499 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1500 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1503 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
1504 const struct side_arg_dynamic_field _identifier##_fields[] = { _struct_fields }; \
1505 const struct side_arg_dynamic_struct _identifier = { \
1506 .fields = _identifier##_fields, \
1508 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
1509 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1512 #define side_arg_define_vec(_identifier, _sav) \
1513 const struct side_arg _identifier##_vec[] = { _sav }; \
1514 const struct side_arg_vec _identifier = { \
1515 .sav = _identifier##_vec, \
1516 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1519 #define side_arg_dynamic_field(_name, _elem) \
1521 .field_name = _name, \
1526 * Event instrumentation description registration, runtime enabled state
1527 * check, and instrumentation invocation.
1530 #define side_arg_list(...) __VA_ARGS__
1532 #define side_event_cond(_identifier) \
1533 if (side_unlikely(__atomic_load_n(&side_event_enable__##_identifier, \
1536 #define side_event_call(_identifier, _sav) \
1538 const struct side_arg side_sav[] = { _sav }; \
1539 const struct side_arg_vec side_arg_vec = { \
1541 .len = SIDE_ARRAY_SIZE(side_sav), \
1543 side_call(&(_identifier), &side_arg_vec); \
1546 #define side_event(_identifier, _sav) \
1547 side_event_cond(_identifier) \
1548 side_event_call(_identifier, SIDE_PARAM(_sav))
1550 #define side_event_call_variadic(_identifier, _sav, _var_fields, _attr) \
1552 const struct side_arg side_sav[] = { _sav }; \
1553 const struct side_arg_vec side_arg_vec = { \
1555 .len = SIDE_ARRAY_SIZE(side_sav), \
1557 const struct side_arg_dynamic_field side_fields[] = { _var_fields }; \
1558 const struct side_arg_dynamic_struct var_struct = { \
1559 .fields = side_fields, \
1561 .len = SIDE_ARRAY_SIZE(side_fields), \
1562 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1564 side_call_variadic(&(_identifier), &side_arg_vec, &var_struct); \
1567 #define side_event_variadic(_identifier, _sav, _var, _attr) \
1568 side_event_cond(_identifier) \
1569 side_event_call_variadic(_identifier, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1571 #define _side_define_event(_linkage, _identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1572 _linkage uintptr_t side_event_enable__##_identifier __attribute__((section("side_event_enable"))); \
1573 _linkage struct side_event_description __attribute__((section("side_event_description"))) \
1575 .enabled = &(side_event_enable__##_identifier), \
1576 .provider_name = _provider, \
1577 .event_name = _event, \
1578 .fields = _fields, \
1580 .callbacks = &side_empty_callback, \
1581 .flags = (_flags), \
1583 .loglevel = _loglevel, \
1584 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1585 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1586 .nr_callbacks = 0, \
1588 static const struct side_event_description *side_event_ptr__##_identifier \
1589 __attribute__((section("side_event_description_ptr"), used)) = &(_identifier);
1591 #define side_static_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1592 _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1593 SIDE_PARAM(_attr), 0)
1595 #define side_static_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1596 _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1597 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1599 #define side_hidden_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1600 _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, \
1601 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), 0)
1603 #define side_hidden_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1604 _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, \
1605 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1607 #define side_export_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1608 _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, \
1609 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), 0)
1611 #define side_export_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1612 _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, \
1613 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1615 #define side_declare_event(_identifier) \
1616 extern uintptr_t side_event_enable_##_identifier; \
1617 extern struct side_event_description _identifier
1619 extern const struct side_callback side_empty_callback
;
1621 void side_call(const struct side_event_description
*desc
,
1622 const struct side_arg_vec
*side_arg_vec
);
1623 void side_call_variadic(const struct side_event_description
*desc
,
1624 const struct side_arg_vec
*side_arg_vec
,
1625 const struct side_arg_dynamic_struct
*var_struct
);
1627 struct side_events_register_handle
*side_events_register(struct side_event_description
**events
,
1628 uint32_t nr_events
);
1629 void side_events_unregister(struct side_events_register_handle
*handle
);
1632 * Userspace tracer registration API. This allows userspace tracers to
1633 * register event notification callbacks to be notified of the currently
1634 * registered instrumentation, and to register their callbacks to
1637 typedef void (*side_tracer_callback_func
)(const struct side_event_description
*desc
,
1638 const struct side_arg_vec
*side_arg_vec
,
1640 typedef void (*side_tracer_callback_variadic_func
)(const struct side_event_description
*desc
,
1641 const struct side_arg_vec
*side_arg_vec
,
1642 const struct side_arg_dynamic_struct
*var_struct
,
1645 int side_tracer_callback_register(struct side_event_description
*desc
,
1646 side_tracer_callback_func call
,
1648 int side_tracer_callback_variadic_register(struct side_event_description
*desc
,
1649 side_tracer_callback_variadic_func call_variadic
,
1651 int side_tracer_callback_unregister(struct side_event_description
*desc
,
1652 side_tracer_callback_func call
,
1654 int side_tracer_callback_variadic_unregister(struct side_event_description
*desc
,
1655 side_tracer_callback_variadic_func call_variadic
,
1658 enum side_tracer_notification
{
1659 SIDE_TRACER_NOTIFICATION_INSERT_EVENTS
,
1660 SIDE_TRACER_NOTIFICATION_REMOVE_EVENTS
,
1663 /* Callback is invoked with side library internal lock held. */
1664 struct side_tracer_handle
*side_tracer_event_notification_register(
1665 void (*cb
)(enum side_tracer_notification notif
,
1666 struct side_event_description
**events
, uint32_t nr_events
, void *priv
),
1668 void side_tracer_event_notification_unregister(struct side_tracer_handle
*handle
);
1671 * Explicit hooks to initialize/finalize the side instrumentation
1672 * library. Those are also library constructor/destructor.
1674 void side_init(void);
1675 void side_exit(void);
1678 * The following constructors/destructors perform automatic registration
1679 * of the declared side events. Those may have to be called explicitly
1680 * in a statically linked library.
1684 * These weak symbols, the constructor, and destructor take care of
1685 * registering only _one_ instance of the side instrumentation per
1686 * shared-ojbect (or for the whole main program).
1688 extern struct side_event_description
* __start_side_event_description_ptr
[]
1689 __attribute__((weak
, visibility("hidden")));
1690 extern struct side_event_description
* __stop_side_event_description_ptr
[]
1691 __attribute__((weak
, visibility("hidden")));
1692 int side_event_description_ptr_registered
1693 __attribute__((weak
, visibility("hidden")));
1694 struct side_events_register_handle
*side_events_handle
1695 __attribute__((weak
, visibility("hidden")));
1698 side_event_description_ptr_init(void)
1699 __attribute__((no_instrument_function
))
1700 __attribute__((constructor
));
1702 side_event_description_ptr_init(void)
1704 if (side_event_description_ptr_registered
++)
1706 side_events_handle
= side_events_register(__start_side_event_description_ptr
,
1707 __stop_side_event_description_ptr
- __start_side_event_description_ptr
);
1711 side_event_description_ptr_exit(void)
1712 __attribute__((no_instrument_function
))
1713 __attribute__((destructor
));
1715 side_event_description_ptr_exit(void)
1717 if (--side_event_description_ptr_registered
)
1719 side_events_unregister(side_events_handle
);
1720 side_events_handle
= NULL
;
1723 #endif /* _SIDE_TRACE_H */