1 // SPDX-License-Identifier: MIT
3 * Copyright 2022 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
14 #include <side/macros.h>
15 #include <side/endian.h>
17 /* SIDE stands for "Static Instrumentation Dynamically Enabled" */
19 //TODO: as those structures will be ABI, we need to either consider them
20 //fixed forever, or think of a scheme that would allow their binary
21 //representation to be extended if need be.
24 struct side_arg_vec_description
;
25 struct side_arg_dynamic_vec
;
26 struct side_arg_dynamic_vec_vla
;
27 struct side_type_description
;
28 struct side_event_field
;
29 struct side_event_field_sg
;
30 struct side_tracer_visitor_ctx
;
31 struct side_tracer_dynamic_struct_visitor_ctx
;
32 struct side_tracer_dynamic_vla_visitor_ctx
;
33 struct side_event_description
;
34 struct side_arg_dynamic_event_struct
;
35 struct side_events_register_handle
;
51 SIDE_TYPE_FLOAT_BINARY16
,
52 SIDE_TYPE_FLOAT_BINARY32
,
53 SIDE_TYPE_FLOAT_BINARY64
,
54 SIDE_TYPE_FLOAT_BINARY128
,
62 SIDE_TYPE_VLA_VISITOR
,
73 SIDE_TYPE_ARRAY_POINTER32
,
74 SIDE_TYPE_ARRAY_POINTER64
,
85 SIDE_TYPE_VLA_POINTER32
,
86 SIDE_TYPE_VLA_POINTER64
,
88 /* Enumeration types */
90 SIDE_TYPE_ENUM_BITMAP
,
96 enum side_dynamic_type
{
98 SIDE_DYNAMIC_TYPE_NULL
,
99 SIDE_DYNAMIC_TYPE_BOOL
,
100 SIDE_DYNAMIC_TYPE_U8
,
101 SIDE_DYNAMIC_TYPE_U16
,
102 SIDE_DYNAMIC_TYPE_U32
,
103 SIDE_DYNAMIC_TYPE_U64
,
104 SIDE_DYNAMIC_TYPE_S8
,
105 SIDE_DYNAMIC_TYPE_S16
,
106 SIDE_DYNAMIC_TYPE_S32
,
107 SIDE_DYNAMIC_TYPE_S64
,
108 SIDE_DYNAMIC_TYPE_BYTE
,
109 SIDE_DYNAMIC_TYPE_POINTER32
,
110 SIDE_DYNAMIC_TYPE_POINTER64
,
111 SIDE_DYNAMIC_TYPE_FLOAT_BINARY16
,
112 SIDE_DYNAMIC_TYPE_FLOAT_BINARY32
,
113 SIDE_DYNAMIC_TYPE_FLOAT_BINARY64
,
114 SIDE_DYNAMIC_TYPE_FLOAT_BINARY128
,
115 SIDE_DYNAMIC_TYPE_STRING
,
118 SIDE_DYNAMIC_TYPE_STRUCT
,
119 SIDE_DYNAMIC_TYPE_STRUCT_VISITOR
,
120 SIDE_DYNAMIC_TYPE_VLA
,
121 SIDE_DYNAMIC_TYPE_VLA_VISITOR
,
124 enum side_attr_type
{
135 SIDE_ATTR_TYPE_POINTER32
,
136 SIDE_ATTR_TYPE_POINTER64
,
137 SIDE_ATTR_TYPE_FLOAT_BINARY16
,
138 SIDE_ATTR_TYPE_FLOAT_BINARY32
,
139 SIDE_ATTR_TYPE_FLOAT_BINARY64
,
140 SIDE_ATTR_TYPE_FLOAT_BINARY128
,
141 SIDE_ATTR_TYPE_STRING
,
145 SIDE_TYPE_SG_UNSIGNED_INT
,
146 SIDE_TYPE_SG_SIGNED_INT
,
150 SIDE_LOGLEVEL_EMERG
= 0,
151 SIDE_LOGLEVEL_ALERT
= 1,
152 SIDE_LOGLEVEL_CRIT
= 2,
153 SIDE_LOGLEVEL_ERR
= 3,
154 SIDE_LOGLEVEL_WARNING
= 4,
155 SIDE_LOGLEVEL_NOTICE
= 5,
156 SIDE_LOGLEVEL_INFO
= 6,
157 SIDE_LOGLEVEL_DEBUG
= 7,
160 enum side_visitor_status
{
161 SIDE_VISITOR_STATUS_OK
= 0,
162 SIDE_VISITOR_STATUS_ERROR
= -1,
167 SIDE_ERROR_INVAL
= 1,
168 SIDE_ERROR_EXIST
= 2,
169 SIDE_ERROR_NOMEM
= 3,
170 SIDE_ERROR_NOENT
= 4,
171 SIDE_ERROR_EXITING
= 5,
174 enum side_type_byte_order
{
175 SIDE_TYPE_BYTE_ORDER_LE
= 0,
176 SIDE_TYPE_BYTE_ORDER_BE
= 1,
179 #if (SIDE_BYTE_ORDER == SIDE_LITTLE_ENDIAN)
180 # define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
182 # define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
185 #if (SIDE_FLOAT_WORD_ORDER == SIDE_LITTLE_ENDIAN)
186 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
188 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
191 typedef enum side_visitor_status (*side_visitor
)(
192 const struct side_tracer_visitor_ctx
*tracer_ctx
,
194 typedef enum side_visitor_status (*side_dynamic_struct_visitor
)(
195 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
197 typedef enum side_visitor_status (*side_dynamic_vla_visitor
)(
198 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
201 union side_integer_value
{
212 union side_float_value
{
214 _Float16 side_float_binary16
;
217 _Float32 side_float_binary32
;
220 _Float64 side_float_binary64
;
223 _Float128 side_float_binary128
;
227 struct side_attr_value
{
228 uint32_t type
; /* enum side_attr_type */
231 uint64_t string_value
; /* const char * */
232 union side_integer_value integer_value
;
233 union side_float_value float_value
;
237 /* User attributes. */
240 const struct side_attr_value value
;
243 struct side_type_integer
{
244 const struct side_attr
*attr
;
246 uint16_t integer_size_bits
; /* bits */
247 uint16_t len_bits
; /* bits */
248 uint8_t signedness
; /* true/false */
249 uint8_t byte_order
; /* enum side_type_byte_order */
252 struct side_type_float
{
253 const struct side_attr
*attr
;
255 uint32_t byte_order
; /* enum side_type_byte_order */
256 uint16_t float_size_bits
; /* bits */
259 struct side_enum_mapping
{
265 struct side_enum_mappings
{
266 const struct side_enum_mapping
*mappings
;
267 const struct side_attr
*attr
;
268 uint32_t nr_mappings
;
272 struct side_enum_bitmap_mapping
{
273 uint64_t range_begin
;
278 struct side_enum_bitmap_mappings
{
279 const struct side_enum_bitmap_mapping
*mappings
;
280 const struct side_attr
*attr
;
281 uint32_t nr_mappings
;
285 struct side_type_struct
{
288 const struct side_event_field
*fields
;
289 const struct side_attr
*attr
;
292 struct side_type_null
{
293 const struct side_attr
*attr
;
297 struct side_type_bool
{
298 const struct side_attr
*attr
;
302 struct side_type_byte
{
303 const struct side_attr
*attr
;
307 struct side_type_dynamic
{
308 const struct side_attr
*attr
;
312 struct side_type_string
{
313 const struct side_attr
*attr
;
317 struct side_type_sg_description
{
318 uint64_t offset
; /* bytes */
319 uint32_t type
; /* enum side_type_sg */
322 struct side_type_integer type
;
323 uint16_t offset_bits
; /* bits */
328 struct side_struct_field_sg
{
329 const char *field_name
;
330 struct side_type_sg_description side_type
;
333 /* Structure fields scatter-gather. */
334 struct side_type_struct_sg
{
337 const struct side_struct_field_sg
*fields_sg
;
338 const struct side_attr
*attr
;
341 struct side_type_description
{
342 uint32_t type
; /* enum side_type */
345 struct side_type_bool side_bool
;
346 struct side_type_byte side_byte
;
347 struct side_type_dynamic side_dynamic
;
348 struct side_type_string side_string
;
349 struct side_type_integer side_integer
;
350 struct side_type_float side_float
;
354 const struct side_type_description
*elem_type
;
355 const struct side_attr
*attr
;
360 const struct side_type_description
*elem_type
;
361 const struct side_attr
*attr
;
365 const struct side_type_description
*elem_type
;
366 side_visitor visitor
;
367 const struct side_attr
*attr
;
370 const struct side_type_struct
*side_struct
;
371 const struct side_type_struct_sg
*side_struct_sg
;
373 /* Enumeration types */
375 const struct side_enum_mappings
*mappings
;
376 const struct side_type_description
*elem_type
;
379 const struct side_enum_bitmap_mappings
*mappings
;
380 const struct side_type_description
*elem_type
;
385 struct side_event_field
{
386 const char *field_name
;
387 struct side_type_description side_type
;
390 enum side_event_flags
{
391 SIDE_EVENT_FLAG_VARIADIC
= (1 << 0),
394 struct side_callback
{
396 void (*call
)(const struct side_event_description
*desc
,
397 const struct side_arg_vec_description
*sav_desc
,
399 void (*call_variadic
)(const struct side_event_description
*desc
,
400 const struct side_arg_vec_description
*sav_desc
,
401 const struct side_arg_dynamic_event_struct
*var_struct
,
407 struct side_event_description
{
409 const char *provider_name
;
410 const char *event_name
;
411 const struct side_event_field
*fields
;
412 const struct side_attr
*attr
;
413 const struct side_callback
*callbacks
;
416 uint32_t loglevel
; /* enum side_loglevel */
419 uint32_t nr_callbacks
;
422 struct side_arg_dynamic_vec
{
423 uint32_t dynamic_type
; /* enum side_dynamic_type */
425 struct side_type_null side_null_type
;
429 struct side_type_bool type
;
434 struct side_type_byte type
;
439 struct side_type_string type
;
440 uint64_t value
; /* const char * */
445 struct side_type_integer type
;
446 union side_integer_value value
;
450 struct side_type_float type
;
451 union side_float_value value
;
455 const struct side_arg_dynamic_event_struct
*side_dynamic_struct
;
458 side_dynamic_struct_visitor visitor
;
459 const struct side_attr
*attr
;
461 } side_dynamic_struct_visitor
;
462 const struct side_arg_dynamic_vec_vla
*side_dynamic_vla
;
465 side_dynamic_vla_visitor visitor
;
466 const struct side_attr
*attr
;
468 } side_dynamic_vla_visitor
;
472 struct side_arg_dynamic_vec_vla
{
473 const struct side_arg_dynamic_vec
*sav
;
474 const struct side_attr
*attr
;
479 struct side_arg_dynamic_event_field
{
480 const char *field_name
;
481 const struct side_arg_dynamic_vec elem
;
484 struct side_arg_dynamic_event_struct
{
485 const struct side_arg_dynamic_event_field
*fields
;
486 const struct side_attr
*attr
;
491 struct side_arg_vec
{
497 uint64_t string_value
; /* const char * */
498 union side_integer_value integer_value
;
499 union side_float_value float_value
;
502 const struct side_arg_vec_description
*side_struct
;
503 const struct side_arg_vec_description
*side_array
;
504 const struct side_arg_vec_description
*side_vla
;
505 void *side_vla_app_visitor_ctx
;
506 void *side_array_fixint
;
511 void *side_struct_sg_ptr
;
514 struct side_arg_dynamic_vec dynamic_value
;
518 struct side_arg_vec_description
{
519 const struct side_arg_vec
*sav
;
523 /* The visitor pattern is a double-dispatch visitor. */
524 struct side_tracer_visitor_ctx
{
525 enum side_visitor_status (*write_elem
)(
526 const struct side_tracer_visitor_ctx
*tracer_ctx
,
527 const struct side_arg_vec
*elem
);
528 void *priv
; /* Private tracer context. */
531 struct side_tracer_dynamic_struct_visitor_ctx
{
532 enum side_visitor_status (*write_field
)(
533 const struct side_tracer_dynamic_struct_visitor_ctx
*tracer_ctx
,
534 const struct side_arg_dynamic_event_field
*dynamic_field
);
535 void *priv
; /* Private tracer context. */
538 struct side_tracer_dynamic_vla_visitor_ctx
{
539 enum side_visitor_status (*write_elem
)(
540 const struct side_tracer_dynamic_vla_visitor_ctx
*tracer_ctx
,
541 const struct side_arg_dynamic_vec
*elem
);
542 void *priv
; /* Private tracer context. */
545 /* Event and type attributes */
547 #if SIDE_BITS_PER_LONG == 64
548 # define SIDE_TYPE_POINTER_HOST SIDE_TYPE_POINTER64
549 # define SIDE_TYPE_ARRAY_POINTER_HOST SIDE_TYPE_ARRAY_POINTER64
550 # define SIDE_TYPE_VLA_POINTER_HOST SIDE_TYPE_VLA_POINTER64
551 # define SIDE_DYNAMIC_TYPE_POINTER_HOST SIDE_DYNAMIC_TYPE_POINTER64
552 # define SIDE_ATTR_TYPE_POINTER_HOST SIDE_ATTR_TYPE_POINTER64
553 # define SIDE_PTR_HOST .side_u64
555 # define SIDE_TYPE_POINTER_HOST SIDE_TYPE_POINTER32
556 # define SIDE_TYPE_ARRAY_POINTER_HOST SIDE_TYPE_ARRAY_POINTER32
557 # define SIDE_TYPE_VLA_POINTER_HOST SIDE_TYPE_VLA_POINTER32
558 # define SIDE_DYNAMIC_TYPE_POINTER_HOST SIDE_DYNAMIC_TYPE_POINTER32
559 # define SIDE_ATTR_TYPE_POINTER_HOST SIDE_ATTR_TYPE_POINTER32
560 # define SIDE_PTR_HOST .side_u32
563 #define side_attr(_key, _value) \
566 .value = SIDE_PARAM(_value), \
569 #define side_attr_list(...) \
570 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
572 #define side_attr_null(_val) { .type = SIDE_ATTR_TYPE_NULL }
573 #define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .bool_value = !!(_val) } }
574 #define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .integer_value = { .side_u8 = (_val) } } }
575 #define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .integer_value = { .side_u16 = (_val) } } }
576 #define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .integer_value = { .side_u32 = (_val) } } }
577 #define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .integer_value = { .side_u64 = (_val) } } }
578 #define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .integer_value = { .side_s8 = (_val) } } }
579 #define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .integer_value = { .side_s16 = (_val) } } }
580 #define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .integer_value = { .side_s32 = (_val) } } }
581 #define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .integer_value = { .side_s64 = (_val) } } }
582 #define side_attr_pointer(_val) { .type = SIDE_ATTR_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
583 #define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .float_value = { .side_float_binary16 = (_val) } } }
584 #define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .float_value = { .side_float_binary32 = (_val) } } }
585 #define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .float_value = { .side_float_binary64 = (_val) } } }
586 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .float_value = { .side_float_binary128 = (_val) } } }
587 #define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string_value = (uintptr_t) (_val) } }
589 /* Static field definition */
591 #define side_type_bool(_attr) \
593 .type = SIDE_TYPE_BOOL, \
597 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
602 #define side_type_byte(_attr) \
604 .type = SIDE_TYPE_BYTE, \
608 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
613 #define side_type_string(_attr) \
615 .type = SIDE_TYPE_STRING, \
619 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
624 #define side_type_dynamic(_attr) \
626 .type = SIDE_TYPE_DYNAMIC, \
630 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
635 #define _side_type_integer(_type, _signedness, _byte_order, _integer_size_bits, _len_bits, _attr) \
641 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
642 .integer_size_bits = _integer_size_bits, \
643 .len_bits = _len_bits, \
644 .signedness = _signedness, \
645 .byte_order = _byte_order, \
650 #define _side_type_float(_type, _byte_order, _float_size_bits, _attr) \
656 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
657 .byte_order = _byte_order, \
658 .float_size_bits = _float_size_bits, \
663 #define _side_field(_name, _type) \
665 .field_name = _name, \
666 .side_type = _type, \
670 #define side_type_u8(_attr) _side_type_integer(SIDE_TYPE_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
671 #define side_type_u16(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_HOST, 16, 16, SIDE_PARAM(_attr))
672 #define side_type_u32(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_HOST, 32, 32, SIDE_PARAM(_attr))
673 #define side_type_u64(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_HOST, 64, 64, SIDE_PARAM(_attr))
674 #define side_type_s8(_attr) _side_type_integer(SIDE_TYPE_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
675 #define side_type_s16(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_HOST, 16, 16, SIDE_PARAM(_attr))
676 #define side_type_s32(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_HOST, 32, 32, SIDE_PARAM(_attr))
677 #define side_type_s64(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_HOST, 64, 64, SIDE_PARAM(_attr))
678 #define side_type_pointer(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_BITS_PER_LONG, \
679 SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
680 #define side_type_float_binary16(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 16, SIDE_PARAM(_attr))
681 #define side_type_float_binary32(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 32, SIDE_PARAM(_attr))
682 #define side_type_float_binary64(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 64, SIDE_PARAM(_attr))
683 #define side_type_float_binary128(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 128, SIDE_PARAM(_attr))
685 #define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
686 #define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
687 #define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
688 #define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
689 #define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
690 #define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
691 #define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
692 #define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
693 #define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
694 #define side_field_byte(_name, _attr) _side_field(_name, side_type_byte(SIDE_PARAM(_attr)))
695 #define side_field_pointer(_name, _attr) _side_field(_name, side_type_pointer(SIDE_PARAM(_attr)))
696 #define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
697 #define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
698 #define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
699 #define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
700 #define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
701 #define side_field_dynamic(_name, _attr) _side_field(_name, side_type_dynamic(SIDE_PARAM(_attr)))
704 #define side_type_u16_le(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_LE, 16, 16, SIDE_PARAM(_attr))
705 #define side_type_u32_le(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_LE, 32, 32, SIDE_PARAM(_attr))
706 #define side_type_u64_le(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_LE, 64, 64, SIDE_PARAM(_attr))
707 #define side_type_s16_le(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_LE, 16, 16, SIDE_PARAM(_attr))
708 #define side_type_s32_le(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_LE, 32, 32, SIDE_PARAM(_attr))
709 #define side_type_s64_le(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_LE, 64, 64, SIDE_PARAM(_attr))
710 #define side_type_pointer_le(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_LE, SIDE_BITS_PER_LONG, \
711 SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
712 #define side_type_float_binary16_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_LE, 16, SIDE_PARAM(_attr))
713 #define side_type_float_binary32_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_LE, 32, SIDE_PARAM(_attr))
714 #define side_type_float_binary64_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_LE, 64, SIDE_PARAM(_attr))
715 #define side_type_float_binary128_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_LE, 128, SIDE_PARAM(_attr))
717 #define side_field_u16_le(_name, _attr) _side_field(_name, side_type_u16_le(SIDE_PARAM(_attr)))
718 #define side_field_u32_le(_name, _attr) _side_field(_name, side_type_u32_le(SIDE_PARAM(_attr)))
719 #define side_field_u64_le(_name, _attr) _side_field(_name, side_type_u64_le(SIDE_PARAM(_attr)))
720 #define side_field_s16_le(_name, _attr) _side_field(_name, side_type_s16_le(SIDE_PARAM(_attr)))
721 #define side_field_s32_le(_name, _attr) _side_field(_name, side_type_s32_le(SIDE_PARAM(_attr)))
722 #define side_field_s64_le(_name, _attr) _side_field(_name, side_type_s64_le(SIDE_PARAM(_attr)))
723 #define side_field_pointer_le(_name, _attr) _side_field(_name, side_type_pointer_le(SIDE_PARAM(_attr)))
724 #define side_field_float_binary16_le(_name, _attr) _side_field(_name, side_type_float_binary16_le(SIDE_PARAM(_attr)))
725 #define side_field_float_binary32_le(_name, _attr) _side_field(_name, side_type_float_binary32_le(SIDE_PARAM(_attr)))
726 #define side_field_float_binary64_le(_name, _attr) _side_field(_name, side_type_float_binary64_le(SIDE_PARAM(_attr)))
727 #define side_field_float_binary128_le(_name, _attr) _side_field(_name, side_type_float_binary128_le(SIDE_PARAM(_attr)))
730 #define side_type_u16_be(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_BE, 16, 16, SIDE_PARAM(_attr))
731 #define side_type_u32_be(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_BE, 32, 32, SIDE_PARAM(_attr))
732 #define side_type_u64_be(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_BE, 64, 64, SIDE_PARAM(_attr))
733 #define side_type_s16_be(_attr) _side_type_integer(SIDE_TYPE_S16, false, SIDE_TYPE_BYTE_ORDER_BE, 16, 16, SIDE_PARAM(_attr))
734 #define side_type_s32_be(_attr) _side_type_integer(SIDE_TYPE_S32, false, SIDE_TYPE_BYTE_ORDER_BE, 32, 32, SIDE_PARAM(_attr))
735 #define side_type_s64_be(_attr) _side_type_integer(SIDE_TYPE_S64, false, SIDE_TYPE_BYTE_ORDER_BE, 64, 64, SIDE_PARAM(_attr))
736 #define side_type_pointer_be(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_BE, SIDE_BITS_PER_LONG, \
737 SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
738 #define side_type_float_binary16_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_BE, 16, SIDE_PARAM(_attr))
739 #define side_type_float_binary32_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_BE, 32, SIDE_PARAM(_attr))
740 #define side_type_float_binary64_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_BE, 64, SIDE_PARAM(_attr))
741 #define side_type_float_binary128_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_BE, 128, SIDE_PARAM(_attr))
743 #define side_field_u16_be(_name, _attr) _side_field(_name, side_type_u16_be(SIDE_PARAM(_attr)))
744 #define side_field_u32_be(_name, _attr) _side_field(_name, side_type_u32_be(SIDE_PARAM(_attr)))
745 #define side_field_u64_be(_name, _attr) _side_field(_name, side_type_u64_be(SIDE_PARAM(_attr)))
746 #define side_field_s16_be(_name, _attr) _side_field(_name, side_type_s16_be(SIDE_PARAM(_attr)))
747 #define side_field_s32_be(_name, _attr) _side_field(_name, side_type_s32_be(SIDE_PARAM(_attr)))
748 #define side_field_s64_be(_name, _attr) _side_field(_name, side_type_s64_be(SIDE_PARAM(_attr)))
749 #define side_field_pointer_be(_name, _attr) _side_field(_name, side_type_pointer_be(SIDE_PARAM(_attr)))
750 #define side_field_float_binary16_be(_name, _attr) _side_field(_name, side_type_float_binary16_be(SIDE_PARAM(_attr)))
751 #define side_field_float_binary32_be(_name, _attr) _side_field(_name, side_type_float_binary32_be(SIDE_PARAM(_attr)))
752 #define side_field_float_binary64_be(_name, _attr) _side_field(_name, side_type_float_binary64_be(SIDE_PARAM(_attr)))
753 #define side_field_float_binary128_be(_name, _attr) _side_field(_name, side_type_float_binary128_be(SIDE_PARAM(_attr)))
755 #define side_type_enum(_mappings, _elem_type) \
757 .type = SIDE_TYPE_ENUM, \
760 .mappings = _mappings, \
761 .elem_type = _elem_type, \
765 #define side_field_enum(_name, _mappings, _elem_type) \
766 _side_field(_name, side_type_enum(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
768 #define side_type_enum_bitmap(_mappings, _elem_type) \
770 .type = SIDE_TYPE_ENUM_BITMAP, \
772 .side_enum_bitmap = { \
773 .mappings = _mappings, \
774 .elem_type = _elem_type, \
778 #define side_field_enum_bitmap(_name, _mappings, _elem_type) \
779 _side_field(_name, side_type_enum_bitmap(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
781 #define side_type_struct(_struct) \
783 .type = SIDE_TYPE_STRUCT, \
785 .side_struct = _struct, \
788 #define side_field_struct(_name, _struct) \
789 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
791 #define _side_type_struct_define(_fields, _attr) \
793 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
794 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
799 #define side_define_struct(_identifier, _fields, _attr) \
800 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
802 #define side_struct_literal(_fields, _attr) \
803 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
804 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
806 /* Scatter-gather struct */
808 #define _side_type_sg_integer(_type, _signedness, _byte_order, _offset, _integer_size_bits, _offset_bits, _len_bits, _attr) \
816 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
817 .integer_size_bits = _integer_size_bits, \
818 .len_bits = _len_bits, \
819 .signedness = _signedness, \
820 .byte_order = _byte_order, \
822 .offset_bits = _offset_bits, \
827 #define _side_field_sg(_name, _type) \
829 .field_name = _name, \
830 .side_type = _type, \
833 #define side_type_sg_unsigned_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _attr) \
834 _side_type_sg_integer(SIDE_TYPE_SG_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_HOST, \
835 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, SIDE_PARAM(_attr))
836 #define side_type_sg_signed_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _attr) \
837 _side_type_sg_integer(SIDE_TYPE_SG_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_HOST, \
838 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, SIDE_PARAM(_attr))
840 #define side_field_sg_unsigned_integer(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _attr) \
841 _side_field_sg(_name, side_type_sg_unsigned_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, SIDE_PARAM(_attr)))
842 #define side_field_sg_signed_integer(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _attr) \
843 _side_field_sg(_name, side_type_sg_signed_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, SIDE_PARAM(_attr)))
845 #define side_type_struct_sg(_struct_sg) \
847 .type = SIDE_TYPE_STRUCT_SG, \
849 .side_struct_sg = _struct_sg, \
852 #define side_field_struct_sg(_name, _struct_sg) \
853 _side_field(_name, side_type_struct_sg(SIDE_PARAM(_struct_sg)))
855 #define _side_type_struct_sg_define(_fields_sg, _attr) \
857 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields_sg)), \
858 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
859 .fields_sg = _fields_sg, \
863 #define side_define_struct_sg(_identifier, _fields_sg, _attr) \
864 const struct side_type_struct_sg _identifier = _side_type_struct_sg_define(SIDE_PARAM(_fields_sg), SIDE_PARAM(_attr))
866 #define side_struct_sg_literal(_fields_sg, _attr) \
867 SIDE_COMPOUND_LITERAL(const struct side_type_struct_sg, \
868 _side_type_struct_sg_define(SIDE_PARAM(_fields_sg), SIDE_PARAM(_attr)))
870 #define side_type_array(_elem_type, _length, _attr) \
872 .type = SIDE_TYPE_ARRAY, \
875 .elem_type = _elem_type, \
878 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
882 #define side_field_array(_name, _elem_type, _length, _attr) \
883 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
885 #define side_type_vla(_elem_type, _attr) \
887 .type = SIDE_TYPE_VLA, \
890 .elem_type = _elem_type, \
892 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
896 #define side_field_vla(_name, _elem_type, _attr) \
897 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
899 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
901 .type = SIDE_TYPE_VLA_VISITOR, \
903 .side_vla_visitor = { \
904 .elem_type = SIDE_PARAM(_elem_type), \
905 .visitor = _visitor, \
907 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
911 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
912 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
914 #define side_elem(...) \
915 SIDE_COMPOUND_LITERAL(const struct side_type_description, __VA_ARGS__)
917 #define side_field_list(...) \
918 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
920 #define side_field_sg_list(...) \
921 SIDE_COMPOUND_LITERAL(const struct side_struct_field_sg, __VA_ARGS__)
923 /* Static field arguments */
925 #define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .bool_value = !!(_val) } }
926 #define side_arg_byte(_val) { .type = SIDE_TYPE_BYTE, .u = { .byte_value = (_val) } }
927 #define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .string_value = (uintptr_t) (_val) } }
928 #define side_arg_dynamic(_dynamic_arg_type) { .type = SIDE_TYPE_DYNAMIC, .u = { .dynamic_value = _dynamic_arg_type } }
930 #define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .integer_value = { .side_u8 = (_val) } } }
931 #define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .integer_value = { .side_u16 = (_val) } } }
932 #define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .integer_value = { .side_u32 = (_val) } } }
933 #define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .integer_value = { .side_u64 = (_val) } } }
934 #define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .integer_value = { .side_s8 = (_val) } } }
935 #define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .integer_value = { .side_s16 = (_val) } } }
936 #define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .integer_value = { .side_s32 = (_val) } } }
937 #define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .integer_value = { .side_s64 = (_val) } } }
938 #define side_arg_pointer(_val) { .type = SIDE_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
939 #define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .integer_value = { .side_u8 = (_val) } } }
940 #define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .integer_value = { .side_u16 = (_val) } } }
941 #define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .integer_value = { .side_u32 = (_val) } } }
942 #define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .integer_value = { .side_u64 = (_val) } } }
943 #define side_arg_enum_bitmap_array(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_array = (_side_type) } }
944 #define side_arg_enum_bitmap_vla(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_vla = (_side_type) } }
945 #define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .float_value = { .side_float_binary16 = (_val) } } }
946 #define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .float_value = { .side_float_binary32 = (_val) } } }
947 #define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .float_value = { .side_float_binary64 = (_val) } } }
948 #define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .float_value = { .side_float_binary128 = (_val) } } }
950 #define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_struct = (_side_type) } }
951 #define side_arg_struct_sg(_ptr) { .type = SIDE_TYPE_STRUCT_SG, .u = { .side_struct_sg_ptr = (_ptr) } }
952 #define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_array = (_side_type) } }
953 #define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_vla = (_side_type) } }
954 #define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_vla_app_visitor_ctx = (_ctx) } }
956 #define side_arg_array_u8(_ptr) { .type = SIDE_TYPE_ARRAY_U8, .u = { .side_array_fixint = (_ptr) } }
957 #define side_arg_array_u16(_ptr) { .type = SIDE_TYPE_ARRAY_U16, .u = { .side_array_fixint = (_ptr) } }
958 #define side_arg_array_u32(_ptr) { .type = SIDE_TYPE_ARRAY_U32, .u = { .side_array_fixint = (_ptr) } }
959 #define side_arg_array_u64(_ptr) { .type = SIDE_TYPE_ARRAY_U64, .u = { .side_array_fixint = (_ptr) } }
960 #define side_arg_array_s8(_ptr) { .type = SIDE_TYPE_ARRAY_S8, .u = { .side_array_fixint = (_ptr) } }
961 #define side_arg_array_s16(_ptr) { .type = SIDE_TYPE_ARRAY_S16, .u = { .side_array_fixint = (_ptr) } }
962 #define side_arg_array_s32(_ptr) { .type = SIDE_TYPE_ARRAY_S32, .u = { .side_array_fixint = (_ptr) } }
963 #define side_arg_array_s64(_ptr) { .type = SIDE_TYPE_ARRAY_S64, .u = { .side_array_fixint = (_ptr) } }
964 #define side_arg_array_byte(_ptr) { .type = SIDE_TYPE_ARRAY_BYTE, .u = { .side_array_fixint = (_ptr) } }
965 #define side_arg_array_pointer(_ptr) { .type = SIDE_TYPE_ARRAY_POINTER_HOST, .u = { .side_array_fixint = (_ptr) } }
967 #define side_arg_vla_u8(_ptr, _length) { .type = SIDE_TYPE_VLA_U8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } }
968 #define side_arg_vla_u16(_ptr, _length) { .type = SIDE_TYPE_VLA_U16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
969 #define side_arg_vla_u32(_ptr, _length) { .type = SIDE_TYPE_VLA_U32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
970 #define side_arg_vla_u64(_ptr, _length) { .type = SIDE_TYPE_VLA_U64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
971 #define side_arg_vla_s8(_ptr, _length) { .type = SIDE_TYPE_VLA_S8, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
972 #define side_arg_vla_s16(_ptr, _length) { .type = SIDE_TYPE_VLA_S16, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
973 #define side_arg_vla_s32(_ptr, _length) { .type = SIDE_TYPE_VLA_S32, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
974 #define side_arg_vla_s64(_ptr, _length) { .type = SIDE_TYPE_VLA_S64, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
975 #define side_arg_vla_byte(_ptr, _length) { .type = SIDE_TYPE_VLA_BYTE, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
976 #define side_arg_vla_pointer(_ptr, _length) { .type = SIDE_TYPE_VLA_POINTER_HOST, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
978 /* Dynamic field arguments */
980 #define side_arg_dynamic_null(_attr) \
982 .dynamic_type = SIDE_DYNAMIC_TYPE_NULL, \
984 .side_null_type = { \
986 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
991 #define side_arg_dynamic_bool(_val, _attr) \
993 .dynamic_type = SIDE_DYNAMIC_TYPE_BOOL, \
998 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1000 .value = !!(_val), \
1005 #define side_arg_dynamic_byte(_val, _attr) \
1007 .dynamic_type = SIDE_DYNAMIC_TYPE_BYTE, \
1012 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1018 #define side_arg_dynamic_string(_val, _attr) \
1020 .dynamic_type = SIDE_DYNAMIC_TYPE_STRING, \
1025 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1027 .value = (uintptr_t) (_val), \
1032 #define _side_arg_dynamic_integer(_field, _val, _type, _signedness, _byte_order, _integer_size_bits, _len_bits, _attr) \
1034 .dynamic_type = _type, \
1039 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1040 .integer_size_bits = _integer_size_bits, \
1041 .len_bits = _len_bits, \
1042 .signedness = _signedness, \
1043 .byte_order = _byte_order, \
1052 #define side_arg_dynamic_u8(_val, _attr) \
1053 _side_arg_dynamic_integer(.side_u8, _val, SIDE_DYNAMIC_TYPE_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
1054 #define side_arg_dynamic_s8(_val, _attr) \
1055 _side_arg_dynamic_integer(.side_s8, _val, SIDE_DYNAMIC_TYPE_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
1057 #define _side_arg_dynamic_u16(_val, _byte_order, _attr) \
1058 _side_arg_dynamic_integer(.side_u16, _val, SIDE_DYNAMIC_TYPE_U16, false, _byte_order, 16, 16, SIDE_PARAM(_attr))
1059 #define _side_arg_dynamic_u32(_val, _byte_order, _attr) \
1060 _side_arg_dynamic_integer(.side_u32, _val, SIDE_DYNAMIC_TYPE_U32, false, _byte_order, 32, 32, SIDE_PARAM(_attr))
1061 #define _side_arg_dynamic_u64(_val, _byte_order, _attr) \
1062 _side_arg_dynamic_integer(.side_u64, _val, SIDE_DYNAMIC_TYPE_U64, false, _byte_order, 64, 64, SIDE_PARAM(_attr))
1064 #define _side_arg_dynamic_s16(_val, _byte_order, _attr) \
1065 _side_arg_dynamic_integer(.side_s16, _val, SIDE_DYNAMIC_TYPE_S16, true, _byte_order, 16, 16, SIDE_PARAM(_attr))
1066 #define _side_arg_dynamic_s32(_val, _byte_order, _attr) \
1067 _side_arg_dynamic_integer(.side_s32, _val, SIDE_DYNAMIC_TYPE_S32, true, _byte_order, 32, 32, SIDE_PARAM(_attr))
1068 #define _side_arg_dynamic_s64(_val, _byte_order, _attr) \
1069 _side_arg_dynamic_integer(.side_s64, _val, SIDE_DYNAMIC_TYPE_S64, true, _byte_order, 64, 64, SIDE_PARAM(_attr))
1071 #define _side_arg_dynamic_pointer(_val, _byte_order, _attr) \
1072 _side_arg_dynamic_integer(SIDE_PTR_HOST, (uintptr_t) (_val), SIDE_DYNAMIC_TYPE_POINTER_HOST, false, _byte_order, \
1073 SIDE_BITS_PER_LONG, SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
1075 #define _side_arg_dynamic_float(_field, _val, _type, _byte_order, _float_size_bits, _attr) \
1077 .dynamic_type = _type, \
1082 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1083 .byte_order = _byte_order, \
1084 .float_size_bits = _float_size_bits, \
1093 #define _side_arg_dynamic_float_binary16(_val, _byte_order, _attr) \
1094 _side_arg_dynamic_float(.side_float_binary16, _val, SIDE_DYNAMIC_TYPE_FLOAT_BINARY16, _byte_order, 16, SIDE_PARAM(_attr))
1095 #define _side_arg_dynamic_float_binary32(_val, _byte_order, _attr) \
1096 _side_arg_dynamic_float(.side_float_binary32, _val, SIDE_DYNAMIC_TYPE_FLOAT_BINARY32, _byte_order, 32, SIDE_PARAM(_attr))
1097 #define _side_arg_dynamic_float_binary64(_val, _byte_order, _attr) \
1098 _side_arg_dynamic_float(.side_float_binary64, _val, SIDE_DYNAMIC_TYPE_FLOAT_BINARY64, _byte_order, 64, SIDE_PARAM(_attr))
1099 #define _side_arg_dynamic_float_binary128(_val, _byte_order, _attr) \
1100 _side_arg_dynamic_float(.side_float_binary128, _val, SIDE_DYNAMIC_TYPE_FLOAT_BINARY128, _byte_order, 128, SIDE_PARAM(_attr))
1103 #define side_arg_dynamic_u16(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1104 #define side_arg_dynamic_u32(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1105 #define side_arg_dynamic_u64(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1106 #define side_arg_dynamic_s16(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1107 #define side_arg_dynamic_s32(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1108 #define side_arg_dynamic_s64(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1109 #define side_arg_dynamic_pointer(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1110 #define side_arg_dynamic_float_binary16(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1111 #define side_arg_dynamic_float_binary32(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1112 #define side_arg_dynamic_float_binary64(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1113 #define side_arg_dynamic_float_binary128(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1116 #define side_arg_dynamic_u16_le(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1117 #define side_arg_dynamic_u32_le(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1118 #define side_arg_dynamic_u64_le(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1119 #define side_arg_dynamic_s16_le(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1120 #define side_arg_dynamic_s32_le(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1121 #define side_arg_dynamic_s64_le(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1122 #define side_arg_dynamic_pointer_le(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1123 #define side_arg_dynamic_float_binary16_le(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1124 #define side_arg_dynamic_float_binary32_le(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1125 #define side_arg_dynamic_float_binary64_le(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1126 #define side_arg_dynamic_float_binary128_le(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1129 #define side_arg_dynamic_u16_be(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1130 #define side_arg_dynamic_u32_be(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1131 #define side_arg_dynamic_u64_be(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1132 #define side_arg_dynamic_s16_be(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1133 #define side_arg_dynamic_s32_be(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1134 #define side_arg_dynamic_s64_be(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1135 #define side_arg_dynamic_pointer_be(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1136 #define side_arg_dynamic_float_binary16_be(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1137 #define side_arg_dynamic_float_binary32_be(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1138 #define side_arg_dynamic_float_binary64_be(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1139 #define side_arg_dynamic_float_binary128_be(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1141 #define side_arg_dynamic_vla(_vla) \
1143 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA, \
1145 .side_dynamic_vla = (_vla), \
1149 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
1151 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA_VISITOR, \
1153 .side_dynamic_vla_visitor = { \
1155 .visitor = _dynamic_vla_visitor, \
1157 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1162 #define side_arg_dynamic_struct(_struct) \
1164 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT, \
1166 .side_dynamic_struct = (_struct), \
1170 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
1172 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT_VISITOR, \
1174 .side_dynamic_struct_visitor = { \
1176 .visitor = _dynamic_struct_visitor, \
1178 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1183 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
1184 const struct side_arg_dynamic_vec _identifier##_vec[] = { _sav }; \
1185 const struct side_arg_dynamic_vec_vla _identifier = { \
1186 .sav = _identifier##_vec, \
1188 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1189 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1192 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
1193 const struct side_arg_dynamic_event_field _identifier##_fields[] = { _struct_fields }; \
1194 const struct side_arg_dynamic_event_struct _identifier = { \
1195 .fields = _identifier##_fields, \
1197 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
1198 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1201 #define side_arg_define_vec(_identifier, _sav) \
1202 const struct side_arg_vec _identifier##_vec[] = { _sav }; \
1203 const struct side_arg_vec_description _identifier = { \
1204 .sav = _identifier##_vec, \
1205 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1208 #define side_arg_dynamic_field(_name, _elem) \
1210 .field_name = _name, \
1214 #define side_arg_list(...) __VA_ARGS__
1216 #define side_define_enum(_identifier, _mappings, _attr) \
1217 const struct side_enum_mappings _identifier = { \
1218 .mappings = _mappings, \
1220 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1221 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1224 #define side_enum_mapping_list(...) \
1225 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
1227 #define side_enum_mapping_range(_label, _begin, _end) \
1229 .range_begin = _begin, \
1230 .range_end = _end, \
1234 #define side_enum_mapping_value(_label, _value) \
1236 .range_begin = _value, \
1237 .range_end = _value, \
1241 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
1242 const struct side_enum_bitmap_mappings _identifier = { \
1243 .mappings = _mappings, \
1245 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1246 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1249 #define side_enum_bitmap_mapping_list(...) \
1250 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
1252 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
1254 .range_begin = _begin, \
1255 .range_end = _end, \
1259 #define side_enum_bitmap_mapping_value(_label, _value) \
1261 .range_begin = _value, \
1262 .range_end = _value, \
1266 #define side_event_cond(_identifier) \
1267 if (side_unlikely(__atomic_load_n(&side_event_enable__##_identifier, \
1270 #define side_event_call(_identifier, _sav) \
1272 const struct side_arg_vec side_sav[] = { _sav }; \
1273 const struct side_arg_vec_description sav_desc = { \
1275 .len = SIDE_ARRAY_SIZE(side_sav), \
1277 side_call(&(_identifier), &sav_desc); \
1280 #define side_event(_identifier, _sav) \
1281 side_event_cond(_identifier) \
1282 side_event_call(_identifier, SIDE_PARAM(_sav))
1284 #define side_event_call_variadic(_identifier, _sav, _var_fields, _attr) \
1286 const struct side_arg_vec side_sav[] = { _sav }; \
1287 const struct side_arg_vec_description sav_desc = { \
1289 .len = SIDE_ARRAY_SIZE(side_sav), \
1291 const struct side_arg_dynamic_event_field side_fields[] = { _var_fields }; \
1292 const struct side_arg_dynamic_event_struct var_struct = { \
1293 .fields = side_fields, \
1295 .len = SIDE_ARRAY_SIZE(side_fields), \
1296 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1298 side_call_variadic(&(_identifier), &sav_desc, &var_struct); \
1301 #define side_event_variadic(_identifier, _sav, _var, _attr) \
1302 side_event_cond(_identifier) \
1303 side_event_call_variadic(_identifier, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1305 #define _side_define_event(_linkage, _identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1306 _linkage uintptr_t side_event_enable__##_identifier __attribute__((section("side_event_enable"))); \
1307 _linkage struct side_event_description __attribute__((section("side_event_description"))) \
1309 .enabled = &(side_event_enable__##_identifier), \
1310 .provider_name = _provider, \
1311 .event_name = _event, \
1312 .fields = _fields, \
1314 .callbacks = &side_empty_callback, \
1315 .flags = (_flags), \
1317 .loglevel = _loglevel, \
1318 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1319 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1320 .nr_callbacks = 0, \
1322 static const struct side_event_description *side_event_ptr__##_identifier \
1323 __attribute__((section("side_event_description_ptr"), used)) = &(_identifier);
1325 #define side_static_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1326 _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1327 SIDE_PARAM(_attr), 0)
1329 #define side_static_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1330 _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1331 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1333 #define side_hidden_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1334 _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1335 SIDE_PARAM(_attr), 0)
1337 #define side_hidden_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1338 _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1339 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1341 #define side_export_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1342 _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1343 SIDE_PARAM(_attr), 0)
1345 #define side_export_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1346 _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1347 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1349 #define side_declare_event(_identifier) \
1350 extern uintptr_t side_event_enable_##_identifier; \
1351 extern struct side_event_description _identifier
1353 extern const struct side_callback side_empty_callback
;
1355 void side_call(const struct side_event_description
*desc
,
1356 const struct side_arg_vec_description
*sav_desc
);
1357 void side_call_variadic(const struct side_event_description
*desc
,
1358 const struct side_arg_vec_description
*sav_desc
,
1359 const struct side_arg_dynamic_event_struct
*var_struct
);
1361 int side_tracer_callback_register(struct side_event_description
*desc
,
1362 void (*call
)(const struct side_event_description
*desc
,
1363 const struct side_arg_vec_description
*sav_desc
,
1366 int side_tracer_callback_variadic_register(struct side_event_description
*desc
,
1367 void (*call_variadic
)(const struct side_event_description
*desc
,
1368 const struct side_arg_vec_description
*sav_desc
,
1369 const struct side_arg_dynamic_event_struct
*var_struct
,
1372 int side_tracer_callback_unregister(struct side_event_description
*desc
,
1373 void (*call
)(const struct side_event_description
*desc
,
1374 const struct side_arg_vec_description
*sav_desc
,
1377 int side_tracer_callback_variadic_unregister(struct side_event_description
*desc
,
1378 void (*call_variadic
)(const struct side_event_description
*desc
,
1379 const struct side_arg_vec_description
*sav_desc
,
1380 const struct side_arg_dynamic_event_struct
*var_struct
,
1384 struct side_events_register_handle
*side_events_register(struct side_event_description
**events
, uint32_t nr_events
);
1385 void side_events_unregister(struct side_events_register_handle
*handle
);
1387 enum side_tracer_notification
{
1388 SIDE_TRACER_NOTIFICATION_INSERT_EVENTS
,
1389 SIDE_TRACER_NOTIFICATION_REMOVE_EVENTS
,
1392 /* Callback is invoked with side library internal lock held. */
1393 struct side_tracer_handle
*side_tracer_event_notification_register(
1394 void (*cb
)(enum side_tracer_notification notif
,
1395 struct side_event_description
**events
, uint32_t nr_events
, void *priv
),
1397 void side_tracer_event_notification_unregister(struct side_tracer_handle
*handle
);
1399 void side_init(void);
1400 void side_exit(void);
1403 * These weak symbols, the constructor, and destructor take care of
1404 * registering only _one_ instance of the side instrumentation per
1405 * shared-ojbect (or for the whole main program).
1407 extern struct side_event_description
* __start_side_event_description_ptr
[]
1408 __attribute__((weak
, visibility("hidden")));
1409 extern struct side_event_description
* __stop_side_event_description_ptr
[]
1410 __attribute__((weak
, visibility("hidden")));
1411 int side_event_description_ptr_registered
1412 __attribute__((weak
, visibility("hidden")));
1413 struct side_events_register_handle
*side_events_handle
1414 __attribute__((weak
, visibility("hidden")));
1417 side_event_description_ptr_init(void)
1418 __attribute__((no_instrument_function
))
1419 __attribute__((constructor
));
1421 side_event_description_ptr_init(void)
1423 if (side_event_description_ptr_registered
++)
1425 side_events_handle
= side_events_register(__start_side_event_description_ptr
,
1426 __stop_side_event_description_ptr
- __start_side_event_description_ptr
);
1430 side_event_description_ptr_exit(void)
1431 __attribute__((no_instrument_function
))
1432 __attribute__((destructor
));
1434 side_event_description_ptr_exit(void)
1436 if (--side_event_description_ptr_registered
)
1438 side_events_unregister(side_events_handle
);
1439 side_events_handle
= NULL
;
1442 #endif /* _SIDE_TRACE_H */