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 */
101 SIDE_TYPE_FLOAT_BINARY16
,
102 SIDE_TYPE_FLOAT_BINARY32
,
103 SIDE_TYPE_FLOAT_BINARY64
,
104 SIDE_TYPE_FLOAT_BINARY128
,
107 /* Stack-copy compound types */
111 SIDE_TYPE_VLA_VISITOR
,
113 /* Stack-copy enumeration types */
115 SIDE_TYPE_ENUM_BITMAP
,
117 /* Stack-copy place holder for dynamic types */
120 /* Gather basic types */
121 SIDE_TYPE_GATHER_BOOL
,
122 SIDE_TYPE_GATHER_UNSIGNED_INT
,
123 SIDE_TYPE_GATHER_SIGNED_INT
,
124 SIDE_TYPE_GATHER_BYTE
,
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_POINTER32
,
145 SIDE_TYPE_DYNAMIC_POINTER64
,
146 SIDE_TYPE_DYNAMIC_FLOAT_BINARY16
,
147 SIDE_TYPE_DYNAMIC_FLOAT_BINARY32
,
148 SIDE_TYPE_DYNAMIC_FLOAT_BINARY64
,
149 SIDE_TYPE_DYNAMIC_FLOAT_BINARY128
,
150 SIDE_TYPE_DYNAMIC_STRING
,
152 /* Dynamic compound types */
153 SIDE_TYPE_DYNAMIC_STRUCT
,
154 SIDE_TYPE_DYNAMIC_STRUCT_VISITOR
,
155 SIDE_TYPE_DYNAMIC_VLA
,
156 SIDE_TYPE_DYNAMIC_VLA_VISITOR
,
159 enum side_attr_type
{
170 SIDE_ATTR_TYPE_POINTER32
,
171 SIDE_ATTR_TYPE_POINTER64
,
172 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
173 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
174 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
175 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
176 SIDE_ATTR_TYPE_STRING
,
180 SIDE_LOGLEVEL_EMERG
= 0,
181 SIDE_LOGLEVEL_ALERT
= 1,
182 SIDE_LOGLEVEL_CRIT
= 2,
183 SIDE_LOGLEVEL_ERR
= 3,
184 SIDE_LOGLEVEL_WARNING
= 4,
185 SIDE_LOGLEVEL_NOTICE
= 5,
186 SIDE_LOGLEVEL_INFO
= 6,
187 SIDE_LOGLEVEL_DEBUG
= 7,
190 enum side_visitor_status
{
191 SIDE_VISITOR_STATUS_OK
= 0,
192 SIDE_VISITOR_STATUS_ERROR
= -1,
197 SIDE_ERROR_INVAL
= 1,
198 SIDE_ERROR_EXIST
= 2,
199 SIDE_ERROR_NOMEM
= 3,
200 SIDE_ERROR_NOENT
= 4,
201 SIDE_ERROR_EXITING
= 5,
204 enum side_type_label_byte_order
{
205 SIDE_TYPE_BYTE_ORDER_LE
= 0,
206 SIDE_TYPE_BYTE_ORDER_BE
= 1,
209 #if (SIDE_BYTE_ORDER == SIDE_LITTLE_ENDIAN)
210 # define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
212 # define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
215 #if (SIDE_FLOAT_WORD_ORDER == SIDE_LITTLE_ENDIAN)
216 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
218 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
221 enum side_type_gather_access_mode
{
222 SIDE_TYPE_GATHER_ACCESS_DIRECT
,
223 SIDE_TYPE_GATHER_ACCESS_POINTER
, /* Pointer dereference */
226 typedef enum side_visitor_status (*side_visitor_func
)(
227 const struct side_tracer_visitor_ctx
*tracer_ctx
,
229 typedef enum side_visitor_status (*side_dynamic_struct_visitor_func
)(
230 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
233 union side_integer_value
{
244 union side_bool_value
{
246 uint16_t side_bool16
;
247 uint32_t side_bool32
;
248 uint64_t side_bool64
;
251 union side_float_value
{
253 _Float16 side_float_binary16
;
256 _Float32 side_float_binary32
;
259 _Float64 side_float_binary64
;
262 _Float128 side_float_binary128
;
266 struct side_attr_value
{
267 uint32_t type
; /* enum side_attr_type */
270 uint64_t string_value
; /* const char * */
271 union side_integer_value integer_value
;
272 union side_float_value float_value
;
276 /* User attributes. */
279 const struct side_attr_value value
;
282 /* Type descriptions */
283 struct side_type_null
{
284 const struct side_attr
*attr
;
288 struct side_type_bool
{
289 const struct side_attr
*attr
;
291 uint16_t bool_size
; /* bytes */
292 uint16_t len_bits
; /* bits. 0 for (bool_size * CHAR_BITS) */
293 uint8_t byte_order
; /* enum side_type_label_byte_order */
296 struct side_type_byte
{
297 const struct side_attr
*attr
;
301 struct side_type_string
{
302 const struct side_attr
*attr
;
306 struct side_type_integer
{
307 const struct side_attr
*attr
;
309 uint16_t integer_size
; /* bytes */
310 uint16_t len_bits
; /* bits. 0 for (integer_size * CHAR_BITS) */
311 uint8_t signedness
; /* true/false */
312 uint8_t byte_order
; /* enum side_type_label_byte_order */
315 struct side_type_float
{
316 const struct side_attr
*attr
;
318 uint16_t float_size
; /* bytes */
319 uint8_t byte_order
; /* enum side_type_label_byte_order */
322 struct side_enum_mapping
{
328 struct side_enum_mappings
{
329 const struct side_enum_mapping
*mappings
;
330 const struct side_attr
*attr
;
331 uint32_t nr_mappings
;
335 struct side_enum_bitmap_mapping
{
336 uint64_t range_begin
;
341 struct side_enum_bitmap_mappings
{
342 const struct side_enum_bitmap_mapping
*mappings
;
343 const struct side_attr
*attr
;
344 uint32_t nr_mappings
;
348 struct side_type_struct
{
349 const struct side_event_field
*fields
;
350 const struct side_attr
*attr
;
355 struct side_type_array
{
356 const struct side_type
*elem_type
;
357 const struct side_attr
*attr
;
362 struct side_type_vla
{
363 const struct side_type
*elem_type
;
364 const struct side_attr
*attr
;
368 struct side_type_vla_visitor
{
369 const struct side_type
*elem_type
;
370 side_visitor_func visitor
;
371 const struct side_attr
*attr
;
375 struct side_type_enum
{
376 const struct side_enum_mappings
*mappings
;
377 const struct side_type
*elem_type
;
380 struct side_type_enum_bitmap
{
381 const struct side_enum_bitmap_mappings
*mappings
;
382 const struct side_type
*elem_type
;
385 struct side_type_gather_bool
{
386 uint64_t offset
; /* bytes */
387 uint8_t access_mode
; /* enum side_type_gather_access_mode */
388 struct side_type_bool type
;
389 uint16_t offset_bits
; /* bits */
392 struct side_type_gather_byte
{
393 uint64_t offset
; /* bytes */
394 uint8_t access_mode
; /* enum side_type_gather_access_mode */
395 struct side_type_byte type
;
398 struct side_type_gather_integer
{
399 uint64_t offset
; /* bytes */
400 uint8_t access_mode
; /* enum side_type_gather_access_mode */
401 struct side_type_integer type
;
402 uint16_t offset_bits
; /* bits */
405 struct side_type_gather_float
{
406 uint64_t offset
; /* bytes */
407 uint8_t access_mode
; /* enum side_type_gather_access_mode */
408 struct side_type_float type
;
411 struct side_type_gather_struct
{
412 uint64_t offset
; /* bytes */
413 uint8_t access_mode
; /* enum side_type_gather_access_mode */
414 const struct side_type_struct
*type
;
415 uint32_t size
; /* bytes */
418 struct side_type_gather_array
{
419 uint64_t offset
; /* bytes */
420 uint8_t access_mode
; /* enum side_type_gather_access_mode */
421 struct side_type_array type
;
424 struct side_type_gather_vla
{
425 const struct side_type
*length_type
; /* side_length() */
427 uint64_t offset
; /* bytes */
428 uint8_t access_mode
; /* enum side_type_gather_access_mode */
429 struct side_type_vla type
;
432 struct side_type_gather
{
434 struct side_type_gather_bool side_bool
;
435 struct side_type_gather_byte side_byte
;
436 struct side_type_gather_integer side_integer
;
437 struct side_type_gather_float side_float
;
438 struct side_type_gather_array side_array
;
439 struct side_type_gather_vla side_vla
;
440 struct side_type_gather_struct side_struct
;
445 uint32_t type
; /* enum side_type_label */
447 /* Stack-copy basic types */
448 struct side_type_null side_null
;
449 struct side_type_bool side_bool
;
450 struct side_type_byte side_byte
;
451 struct side_type_string side_string
;
452 struct side_type_integer side_integer
;
453 struct side_type_float side_float
;
455 /* Stack-copy compound types */
456 struct side_type_array side_array
;
457 struct side_type_vla side_vla
;
458 struct side_type_vla_visitor side_vla_visitor
;
459 const struct side_type_struct
*side_struct
;
461 /* Stack-copy enumeration types */
462 struct side_type_enum side_enum
;
463 struct side_type_enum_bitmap side_enum_bitmap
;
466 struct side_type_gather side_gather
;
470 struct side_event_field
{
471 const char *field_name
;
472 struct side_type side_type
;
475 enum side_event_flags
{
476 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
479 struct side_callback
{
481 void (*call
)(const struct side_event_description
*desc
,
482 const struct side_arg_vec
*side_arg_vec
,
484 void (*call_variadic
)(const struct side_event_description
*desc
,
485 const struct side_arg_vec
*side_arg_vec
,
486 const struct side_arg_dynamic_struct
*var_struct
,
492 struct side_arg_static
{
493 /* Stack-copy basic types */
494 union side_bool_value bool_value
;
496 uint64_t string_value
; /* const char * */
497 union side_integer_value integer_value
;
498 union side_float_value float_value
;
500 /* Stack-copy compound types */
501 const struct side_arg_vec
*side_struct
;
502 const struct side_arg_vec
*side_array
;
503 const struct side_arg_vec
*side_vla
;
504 void *side_vla_app_visitor_ctx
;
506 /* Gather basic types */
507 void *side_bool_gather_ptr
;
508 void *side_byte_gather_ptr
;
509 void *side_integer_gather_ptr
;
510 void *side_float_gather_ptr
;
512 /* Gather compound types */
513 void *side_array_gather_ptr
;
514 void *side_struct_gather_ptr
;
518 } SIDE_PACKED side_vla_gather
;
521 struct side_arg_dynamic_vla
{
522 const struct side_arg
*sav
;
523 const struct side_attr
*attr
;
528 struct side_arg_dynamic_struct
{
529 const struct side_arg_dynamic_field
*fields
;
530 const struct side_attr
*attr
;
535 struct side_dynamic_struct_visitor
{
537 side_dynamic_struct_visitor_func visitor
;
538 const struct side_attr
*attr
;
542 struct side_dynamic_vla_visitor
{
544 side_visitor_func visitor
;
545 const struct side_attr
*attr
;
549 struct side_arg_dynamic
{
550 /* Dynamic basic types */
551 struct side_type_null side_null
;
553 struct side_type_bool type
;
554 union side_bool_value value
;
555 } SIDE_PACKED side_bool
;
557 struct side_type_byte type
;
559 } SIDE_PACKED side_byte
;
561 struct side_type_string type
;
562 uint64_t value
; /* const char * */
563 } SIDE_PACKED side_string
;
565 struct side_type_integer type
;
566 union side_integer_value value
;
567 } SIDE_PACKED side_integer
;
569 struct side_type_float type
;
570 union side_float_value value
;
571 } SIDE_PACKED side_float
;
573 /* Dynamic compound types */
574 const struct side_arg_dynamic_struct
*side_dynamic_struct
;
575 const struct side_arg_dynamic_vla
*side_dynamic_vla
;
577 struct side_dynamic_struct_visitor side_dynamic_struct_visitor
;
578 struct side_dynamic_vla_visitor side_dynamic_vla_visitor
;
582 enum side_type_label type
;
584 struct side_arg_static side_static
;
585 struct side_arg_dynamic side_dynamic
;
589 struct side_arg_vec
{
590 const struct side_arg
*sav
;
594 struct side_arg_dynamic_field
{
595 const char *field_name
;
596 const struct side_arg elem
;
599 /* The visitor pattern is a double-dispatch visitor. */
600 struct side_tracer_visitor_ctx
{
601 enum side_visitor_status (*write_elem
)(
602 const struct side_tracer_visitor_ctx
*tracer_ctx
,
603 const struct side_arg
*elem
);
604 void *priv
; /* Private tracer context. */
607 struct side_tracer_dynamic_struct_visitor_ctx
{
608 enum side_visitor_status (*write_field
)(
609 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
610 const struct side_arg_dynamic_field
*dynamic_field
);
611 void *priv
; /* Private tracer context. */
614 struct side_event_description
{
616 const char *provider_name
;
617 const char *event_name
;
618 const struct side_event_field
*fields
;
619 const struct side_attr
*attr
;
620 const struct side_callback
*callbacks
;
623 uint32_t loglevel
; /* enum side_loglevel */
626 uint32_t nr_callbacks
;
629 /* Event and type attributes */
631 #if SIDE_BITS_PER_LONG == 64
632 # define SIDE_TYPE_POINTER_HOST SIDE_TYPE_POINTER64
633 # define SIDE_TYPE_ARRAY_POINTER_HOST SIDE_TYPE_ARRAY_POINTER64
634 # define SIDE_TYPE_VLA_POINTER_HOST SIDE_TYPE_VLA_POINTER64
635 # define SIDE_TYPE_DYNAMIC_POINTER_HOST SIDE_TYPE_DYNAMIC_POINTER64
636 # define SIDE_ATTR_TYPE_POINTER_HOST SIDE_ATTR_TYPE_POINTER64
637 # define SIDE_PTR_HOST .side_u64
639 # define SIDE_TYPE_POINTER_HOST SIDE_TYPE_POINTER32
640 # define SIDE_TYPE_ARRAY_POINTER_HOST SIDE_TYPE_ARRAY_POINTER32
641 # define SIDE_TYPE_VLA_POINTER_HOST SIDE_TYPE_VLA_POINTER32
642 # define SIDE_TYPE_DYNAMIC_POINTER_HOST SIDE_TYPE_DYNAMIC_POINTER32
643 # define SIDE_ATTR_TYPE_POINTER_HOST SIDE_ATTR_TYPE_POINTER32
644 # define SIDE_PTR_HOST .side_u32
647 #define side_attr(_key, _value) \
650 .value = SIDE_PARAM(_value), \
653 #define side_attr_list(...) \
654 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
656 #define side_attr_null(_val) { .type = SIDE_ATTR_TYPE_NULL }
657 #define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .bool_value = !!(_val) } }
658 #define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .integer_value = { .side_u8 = (_val) } } }
659 #define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .integer_value = { .side_u16 = (_val) } } }
660 #define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .integer_value = { .side_u32 = (_val) } } }
661 #define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .integer_value = { .side_u64 = (_val) } } }
662 #define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .integer_value = { .side_s8 = (_val) } } }
663 #define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .integer_value = { .side_s16 = (_val) } } }
664 #define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .integer_value = { .side_s32 = (_val) } } }
665 #define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .integer_value = { .side_s64 = (_val) } } }
666 #define side_attr_pointer(_val) { .type = SIDE_ATTR_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
667 #define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .float_value = { .side_float_binary16 = (_val) } } }
668 #define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .float_value = { .side_float_binary32 = (_val) } } }
669 #define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .float_value = { .side_float_binary64 = (_val) } } }
670 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .float_value = { .side_float_binary128 = (_val) } } }
671 #define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string_value = (uintptr_t) (_val) } }
673 /* Stack-copy enumeration type definitions */
675 #define side_define_enum(_identifier, _mappings, _attr) \
676 const struct side_enum_mappings _identifier = { \
677 .mappings = _mappings, \
679 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
680 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
683 #define side_enum_mapping_list(...) \
684 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
686 #define side_enum_mapping_range(_label, _begin, _end) \
688 .range_begin = _begin, \
693 #define side_enum_mapping_value(_label, _value) \
695 .range_begin = _value, \
696 .range_end = _value, \
700 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
701 const struct side_enum_bitmap_mappings _identifier = { \
702 .mappings = _mappings, \
704 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
705 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
708 #define side_enum_bitmap_mapping_list(...) \
709 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
711 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
713 .range_begin = _begin, \
718 #define side_enum_bitmap_mapping_value(_label, _value) \
720 .range_begin = _value, \
721 .range_end = _value, \
725 /* Stack-copy field and type definitions */
727 #define side_type_null(_attr) \
729 .type = SIDE_TYPE_NULL, \
733 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
738 #define side_type_bool(_attr) \
740 .type = SIDE_TYPE_BOOL, \
744 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
745 .bool_size = sizeof(uint8_t), \
747 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
752 #define side_type_byte(_attr) \
754 .type = SIDE_TYPE_BYTE, \
758 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
763 #define side_type_string(_attr) \
765 .type = SIDE_TYPE_STRING, \
769 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
774 #define side_type_dynamic() \
776 .type = SIDE_TYPE_DYNAMIC, \
779 #define _side_type_integer(_type, _signedness, _byte_order, _integer_size, _len_bits, _attr) \
785 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
786 .integer_size = _integer_size, \
787 .len_bits = _len_bits, \
788 .signedness = _signedness, \
789 .byte_order = _byte_order, \
794 #define _side_type_float(_type, _byte_order, _float_size, _attr) \
800 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
801 .float_size = _float_size, \
802 .byte_order = _byte_order, \
807 #define _side_field(_name, _type) \
809 .field_name = _name, \
810 .side_type = _type, \
814 #define side_type_u8(_attr) _side_type_integer(SIDE_TYPE_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint8_t), 0, SIDE_PARAM(_attr))
815 #define side_type_u16(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
816 #define side_type_u32(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
817 #define side_type_u64(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
818 #define side_type_s8(_attr) _side_type_integer(SIDE_TYPE_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int8_t), 0, SIDE_PARAM(_attr))
819 #define side_type_s16(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int16_t), 0, SIDE_PARAM(_attr))
820 #define side_type_s32(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int32_t), 0, SIDE_PARAM(_attr))
821 #define side_type_s64(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int64_t), 0, SIDE_PARAM(_attr))
822 #define side_type_pointer(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
823 #define side_type_float_binary16(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float16), SIDE_PARAM(_attr))
824 #define side_type_float_binary32(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float32), SIDE_PARAM(_attr))
825 #define side_type_float_binary64(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float64), SIDE_PARAM(_attr))
826 #define side_type_float_binary128(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float128), SIDE_PARAM(_attr))
828 #define side_field_null(_name, _attr) _side_field(_name, side_type_null(SIDE_PARAM(_attr)))
829 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
830 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
831 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
832 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
833 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
834 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
835 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
836 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
837 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
838 #define side_field_byte(_name, _attr) _side_field(_name, side_type_byte(SIDE_PARAM(_attr)))
839 #define side_field_pointer(_name, _attr) _side_field(_name, side_type_pointer(SIDE_PARAM(_attr)))
840 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
841 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
842 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
843 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
844 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
845 #define side_field_dynamic(_name) _side_field(_name, side_type_dynamic())
848 #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))
849 #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))
850 #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))
851 #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))
852 #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))
853 #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))
854 #define side_type_pointer_le(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
855 #define side_type_float_binary16_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float16), SIDE_PARAM(_attr))
856 #define side_type_float_binary32_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float32), SIDE_PARAM(_attr))
857 #define side_type_float_binary64_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float64), SIDE_PARAM(_attr))
858 #define side_type_float_binary128_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float128), SIDE_PARAM(_attr))
860 #define side_field_u16_le(_name, _attr) _side_field(_name, side_type_u16_le(SIDE_PARAM(_attr)))
861 #define side_field_u32_le(_name, _attr) _side_field(_name, side_type_u32_le(SIDE_PARAM(_attr)))
862 #define side_field_u64_le(_name, _attr) _side_field(_name, side_type_u64_le(SIDE_PARAM(_attr)))
863 #define side_field_s16_le(_name, _attr) _side_field(_name, side_type_s16_le(SIDE_PARAM(_attr)))
864 #define side_field_s32_le(_name, _attr) _side_field(_name, side_type_s32_le(SIDE_PARAM(_attr)))
865 #define side_field_s64_le(_name, _attr) _side_field(_name, side_type_s64_le(SIDE_PARAM(_attr)))
866 #define side_field_pointer_le(_name, _attr) _side_field(_name, side_type_pointer_le(SIDE_PARAM(_attr)))
867 #define side_field_float_binary16_le(_name, _attr) _side_field(_name, side_type_float_binary16_le(SIDE_PARAM(_attr)))
868 #define side_field_float_binary32_le(_name, _attr) _side_field(_name, side_type_float_binary32_le(SIDE_PARAM(_attr)))
869 #define side_field_float_binary64_le(_name, _attr) _side_field(_name, side_type_float_binary64_le(SIDE_PARAM(_attr)))
870 #define side_field_float_binary128_le(_name, _attr) _side_field(_name, side_type_float_binary128_le(SIDE_PARAM(_attr)))
873 #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))
874 #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))
875 #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))
876 #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))
877 #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))
878 #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))
879 #define side_type_pointer_be(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
880 #define side_type_float_binary16_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float16), SIDE_PARAM(_attr))
881 #define side_type_float_binary32_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float32), SIDE_PARAM(_attr))
882 #define side_type_float_binary64_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float64), SIDE_PARAM(_attr))
883 #define side_type_float_binary128_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float128), SIDE_PARAM(_attr))
885 #define side_field_u16_be(_name, _attr) _side_field(_name, side_type_u16_be(SIDE_PARAM(_attr)))
886 #define side_field_u32_be(_name, _attr) _side_field(_name, side_type_u32_be(SIDE_PARAM(_attr)))
887 #define side_field_u64_be(_name, _attr) _side_field(_name, side_type_u64_be(SIDE_PARAM(_attr)))
888 #define side_field_s16_be(_name, _attr) _side_field(_name, side_type_s16_be(SIDE_PARAM(_attr)))
889 #define side_field_s32_be(_name, _attr) _side_field(_name, side_type_s32_be(SIDE_PARAM(_attr)))
890 #define side_field_s64_be(_name, _attr) _side_field(_name, side_type_s64_be(SIDE_PARAM(_attr)))
891 #define side_field_pointer_be(_name, _attr) _side_field(_name, side_type_pointer_be(SIDE_PARAM(_attr)))
892 #define side_field_float_binary16_be(_name, _attr) _side_field(_name, side_type_float_binary16_be(SIDE_PARAM(_attr)))
893 #define side_field_float_binary32_be(_name, _attr) _side_field(_name, side_type_float_binary32_be(SIDE_PARAM(_attr)))
894 #define side_field_float_binary64_be(_name, _attr) _side_field(_name, side_type_float_binary64_be(SIDE_PARAM(_attr)))
895 #define side_field_float_binary128_be(_name, _attr) _side_field(_name, side_type_float_binary128_be(SIDE_PARAM(_attr)))
897 #define side_type_enum(_mappings, _elem_type) \
899 .type = SIDE_TYPE_ENUM, \
902 .mappings = _mappings, \
903 .elem_type = _elem_type, \
907 #define side_field_enum(_name, _mappings, _elem_type) \
908 _side_field(_name, side_type_enum(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
910 #define side_type_enum_bitmap(_mappings, _elem_type) \
912 .type = SIDE_TYPE_ENUM_BITMAP, \
914 .side_enum_bitmap = { \
915 .mappings = _mappings, \
916 .elem_type = _elem_type, \
920 #define side_field_enum_bitmap(_name, _mappings, _elem_type) \
921 _side_field(_name, side_type_enum_bitmap(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
923 #define side_type_struct(_struct) \
925 .type = SIDE_TYPE_STRUCT, \
927 .side_struct = _struct, \
930 #define side_field_struct(_name, _struct) \
931 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
933 #define _side_type_struct_define(_fields, _attr) \
937 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
938 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
941 #define side_define_struct(_identifier, _fields, _attr) \
942 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
944 #define side_struct_literal(_fields, _attr) \
945 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
946 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
948 #define side_type_array(_elem_type, _length, _attr) \
950 .type = SIDE_TYPE_ARRAY, \
953 .elem_type = _elem_type, \
956 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
960 #define side_field_array(_name, _elem_type, _length, _attr) \
961 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
963 #define side_type_vla(_elem_type, _attr) \
965 .type = SIDE_TYPE_VLA, \
968 .elem_type = _elem_type, \
970 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
974 #define side_field_vla(_name, _elem_type, _attr) \
975 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
977 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
979 .type = SIDE_TYPE_VLA_VISITOR, \
981 .side_vla_visitor = { \
982 .elem_type = SIDE_PARAM(_elem_type), \
983 .visitor = _visitor, \
985 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
989 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
990 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
992 /* Gather field and type definitions */
994 #define side_type_gather_byte(_offset, _access_mode, _attr) \
996 .type = SIDE_TYPE_GATHER_BYTE, \
1001 .offset = _offset, \
1002 .access_mode = _access_mode, \
1005 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1012 #define side_field_gather_byte(_name, _offset, _access_mode, _attr) \
1013 _side_field(_name, side_type_gather_byte(_offset, _access_mode, SIDE_PARAM(_attr)))
1015 #define _side_type_gather_bool(_byte_order, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1017 .type = SIDE_TYPE_GATHER_BOOL, \
1022 .offset = _offset, \
1023 .access_mode = _access_mode, \
1026 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1027 .bool_size = _bool_size, \
1028 .len_bits = _len_bits, \
1029 .byte_order = _byte_order, \
1031 .offset_bits = _offset_bits, \
1037 #define side_type_gather_bool(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1038 _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_HOST, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1039 #define side_type_gather_bool_le(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1040 _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_LE, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1041 #define side_type_gather_bool_be(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1042 _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_BE, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1044 #define side_field_gather_bool(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1045 _side_field(_name, side_type_gather_bool(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1046 #define side_field_gather_bool_le(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1047 _side_field(_name, side_type_gather_bool_le(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1048 #define side_field_gather_bool_be(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1049 _side_field(_name, side_type_gather_bool_be(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1051 #define _side_type_gather_integer(_type, _signedness, _byte_order, _offset, \
1052 _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1059 .offset = _offset, \
1060 .access_mode = _access_mode, \
1063 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1064 .integer_size = _integer_size, \
1065 .len_bits = _len_bits, \
1066 .signedness = _signedness, \
1067 .byte_order = _byte_order, \
1069 .offset_bits = _offset_bits, \
1076 #define side_type_gather_unsigned_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1077 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_HOST, \
1078 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1079 #define side_type_gather_signed_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1080 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_HOST, \
1081 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1083 #define side_type_gather_unsigned_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1084 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_LE, \
1085 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1086 #define side_type_gather_signed_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1087 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_LE, \
1088 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1090 #define side_type_gather_unsigned_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1091 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_BE, \
1092 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1093 #define side_type_gather_signed_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1094 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_BE, \
1095 _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1097 #define side_field_gather_unsigned_integer(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1098 _side_field(_name, side_type_gather_unsigned_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1099 #define side_field_gather_signed_integer(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1100 _side_field(_name, side_type_gather_signed_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1102 #define side_field_gather_unsigned_integer_le(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1103 _side_field(_name, side_type_gather_unsigned_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1104 #define side_field_gather_signed_integer_le(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1105 _side_field(_name, side_type_gather_signed_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1107 #define side_field_gather_unsigned_integer_be(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1108 _side_field(_name, side_type_gather_unsigned_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1109 #define side_field_gather_signed_integer_be(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1110 _side_field(_name, side_type_gather_signed_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1112 #define _side_type_gather_float(_byte_order, _offset, _float_size, _access_mode, _attr) \
1114 .type = SIDE_TYPE_GATHER_FLOAT, \
1119 .offset = _offset, \
1120 .access_mode = _access_mode, \
1123 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1124 .float_size = _float_size, \
1125 .byte_order = _byte_order, \
1133 #define side_type_gather_float(_offset, _float_size, _access_mode, _attr) \
1134 _side_type_gather_float(SIDE_TYPE_FLOAT_WORD_ORDER_HOST, _offset, _float_size, _access_mode, _attr)
1135 #define side_type_gather_float_le(_offset, _float_size, _access_mode, _attr) \
1136 _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_LE, _offset, _float_size, _access_mode, _attr)
1137 #define side_type_gather_float_be(_offset, _float_size, _access_mode, _attr) \
1138 _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_BE, _offset, _float_size, _access_mode, _attr)
1140 #define side_field_gather_float(_name, _offset, _float_size, _access_mode, _attr) \
1141 _side_field(_name, side_type_gather_float(_offset, _float_size, _access_mode, _attr))
1142 #define side_field_gather_float_le(_name, _offset, _float_size, _access_mode, _attr) \
1143 _side_field(_name, side_type_gather_float_le(_offset, _float_size, _access_mode, _attr))
1144 #define side_field_gather_float_be(_name, _offset, _float_size, _access_mode, _attr) \
1145 _side_field(_name, side_type_gather_float_be(_offset, _float_size, _access_mode, _attr))
1147 #define side_type_gather_struct(_struct_gather, _offset, _size, _access_mode) \
1149 .type = SIDE_TYPE_GATHER_STRUCT, \
1154 .offset = _offset, \
1155 .access_mode = _access_mode, \
1156 .type = _struct_gather, \
1163 #define side_field_gather_struct(_name, _struct_gather, _offset, _size, _access_mode) \
1164 _side_field(_name, side_type_gather_struct(SIDE_PARAM(_struct_gather), _offset, _size, _access_mode))
1166 #define side_type_gather_array(_elem_type_gather, _length, _offset, _access_mode, _attr) \
1168 .type = SIDE_TYPE_GATHER_ARRAY, \
1173 .offset = _offset, \
1174 .access_mode = _access_mode, \
1176 .elem_type = _elem_type_gather, \
1178 .length = _length, \
1179 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1186 #define side_field_gather_array(_name, _elem_type, _length, _offset, _access_mode, _attr) \
1187 _side_field(_name, side_type_gather_array(SIDE_PARAM(_elem_type), _length, _offset, _access_mode, SIDE_PARAM(_attr)))
1189 #define side_type_gather_vla(_elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1191 .type = SIDE_TYPE_GATHER_VLA, \
1196 .offset = _offset, \
1197 .access_mode = _access_mode, \
1199 .elem_type = _elem_type_gather, \
1201 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1203 .length_type = _length_type_gather, \
1209 #define side_field_gather_vla(_name, _elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1210 _side_field(_name, side_type_gather_vla(SIDE_PARAM(_elem_type_gather), _offset, _access_mode, SIDE_PARAM(_length_type_gather), SIDE_PARAM(_attr)))
1212 #define side_elem(...) \
1213 SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1215 #define side_length(...) \
1216 SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1218 #define side_field_list(...) \
1219 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
1221 /* Stack-copy field arguments */
1223 #define side_arg_null(_val) { .type = SIDE_TYPE_NULL }
1224 #define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .side_static = { .bool_value.side_bool8 = !!(_val) } } }
1225 #define side_arg_byte(_val) { .type = SIDE_TYPE_BYTE, .u = { .side_static = { .byte_value = (_val) } } }
1226 #define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .side_static = { .string_value = (uintptr_t) (_val) } } }
1228 #define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1229 #define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1230 #define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1231 #define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1232 #define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .side_static = { .integer_value = { .side_s8 = (_val) } } } }
1233 #define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .side_static = { .integer_value = { .side_s16 = (_val) } } } }
1234 #define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .side_static = { .integer_value = { .side_s32 = (_val) } } } }
1235 #define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .side_static = { .integer_value = { .side_s64 = (_val) } } } }
1236 #define side_arg_pointer(_val) { .type = SIDE_TYPE_POINTER_HOST, .u = { .side_static = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } } }
1237 #define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1238 #define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1239 #define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1240 #define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1241 #define side_arg_enum_bitmap_array(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1242 #define side_arg_enum_bitmap_vla(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1243 #define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_static = { .float_value = { .side_float_binary16 = (_val) } } } }
1244 #define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_static = { .float_value = { .side_float_binary32 = (_val) } } } }
1245 #define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_static = { .float_value = { .side_float_binary64 = (_val) } } } }
1246 #define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_static = { .float_value = { .side_float_binary128 = (_val) } } } }
1248 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_static = { .side_struct = (_side_type) } } }
1249 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1250 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1251 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_static = { .side_vla_app_visitor_ctx = (_ctx) } } }
1253 /* Gather field arguments */
1255 #define side_arg_gather_bool(_ptr) { .type = SIDE_TYPE_GATHER_BOOL, .u = { .side_static = { .side_bool_gather_ptr = (_ptr) } } }
1256 #define side_arg_gather_byte(_ptr) { .type = SIDE_TYPE_GATHER_BYTE, .u = { .side_static = { .side_byte_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_PTR_HOST, (uintptr_t) (_val), SIDE_TYPE_DYNAMIC_POINTER_HOST, 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 */