Implement gather byte
[libside.git] / include / side / trace.h
CommitLineData
f611d0c3
MD
1// SPDX-License-Identifier: MIT
2/*
3 * Copyright 2022 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 */
5
6#ifndef _SIDE_TRACE_H
7#define _SIDE_TRACE_H
8
9#include <stdint.h>
10#include <inttypes.h>
11#include <stdlib.h>
12#include <stdio.h>
fb25b355 13#include <math.h>
f611d0c3 14#include <side/macros.h>
8bdd5c12 15#include <side/endian.h>
f611d0c3
MD
16
17/* SIDE stands for "Static Instrumentation Dynamically Enabled" */
18
64f5abc7
MD
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
07f35472 21//representation to be extended if need be.
64f5abc7 22
66de373e 23struct side_arg;
f611d0c3 24struct side_arg_vec;
66de373e 25struct side_arg_dynamic;
11f55862 26struct side_arg_dynamic_field;
66de373e
MD
27struct side_arg_dynamic_vla;
28struct side_type;
f611d0c3 29struct side_event_field;
352a4b77 30struct side_tracer_visitor_ctx;
c208889e 31struct side_tracer_dynamic_struct_visitor_ctx;
d89fabc8 32struct side_event_description;
0c7abe2b 33struct side_arg_dynamic_struct;
6e46f5e6 34struct side_events_register_handle;
f611d0c3 35
66de373e
MD
36enum side_type_label {
37 /* Statically declared types */
9b641221 38 SIDE_TYPE_NULL,
4f40d951 39 SIDE_TYPE_BOOL,
f611d0c3
MD
40 SIDE_TYPE_U8,
41 SIDE_TYPE_U16,
42 SIDE_TYPE_U32,
43 SIDE_TYPE_U64,
44 SIDE_TYPE_S8,
45 SIDE_TYPE_S16,
46 SIDE_TYPE_S32,
47 SIDE_TYPE_S64,
f7653b43 48 SIDE_TYPE_BYTE,
dd6e76cb
MD
49 SIDE_TYPE_POINTER32,
50 SIDE_TYPE_POINTER64,
e24949fa
MD
51 SIDE_TYPE_FLOAT_BINARY16,
52 SIDE_TYPE_FLOAT_BINARY32,
53 SIDE_TYPE_FLOAT_BINARY64,
54 SIDE_TYPE_FLOAT_BINARY128,
55 SIDE_TYPE_STRING,
ba845af5 56
66de373e 57 /* Statically declared compound types */
f611d0c3
MD
58 SIDE_TYPE_STRUCT,
59 SIDE_TYPE_ARRAY,
60 SIDE_TYPE_VLA,
61 SIDE_TYPE_VLA_VISITOR,
ba845af5
MD
62
63 SIDE_TYPE_ARRAY_U8,
64 SIDE_TYPE_ARRAY_U16,
65 SIDE_TYPE_ARRAY_U32,
66 SIDE_TYPE_ARRAY_U64,
67 SIDE_TYPE_ARRAY_S8,
68 SIDE_TYPE_ARRAY_S16,
69 SIDE_TYPE_ARRAY_S32,
70 SIDE_TYPE_ARRAY_S64,
f7653b43 71 SIDE_TYPE_ARRAY_BYTE,
dd6e76cb
MD
72 SIDE_TYPE_ARRAY_POINTER32,
73 SIDE_TYPE_ARRAY_POINTER64,
ba845af5 74
1533629f
MD
75 SIDE_TYPE_VLA_U8,
76 SIDE_TYPE_VLA_U16,
77 SIDE_TYPE_VLA_U32,
78 SIDE_TYPE_VLA_U64,
79 SIDE_TYPE_VLA_S8,
80 SIDE_TYPE_VLA_S16,
81 SIDE_TYPE_VLA_S32,
82 SIDE_TYPE_VLA_S64,
f7653b43 83 SIDE_TYPE_VLA_BYTE,
dd6e76cb
MD
84 SIDE_TYPE_VLA_POINTER32,
85 SIDE_TYPE_VLA_POINTER64,
1533629f 86
66de373e 87 /* Statically declared enumeration types */
d8be25de 88 SIDE_TYPE_ENUM,
bab5d6e4 89 SIDE_TYPE_ENUM_BITMAP,
af6aa6e1 90
bdc39c09 91 SIDE_TYPE_DYNAMIC,
bdc39c09 92
d41cb7ee
MD
93 /* Gather types */
94 SIDE_TYPE_GATHER_UNSIGNED_INT,
95 SIDE_TYPE_GATHER_SIGNED_INT,
d69918cc 96 SIDE_TYPE_GATHER_BYTE,
d41cb7ee
MD
97 SIDE_TYPE_GATHER_FLOAT,
98 SIDE_TYPE_GATHER_STRUCT,
99 SIDE_TYPE_GATHER_ARRAY,
100 SIDE_TYPE_GATHER_VLA,
33956c71 101
66de373e
MD
102 /* Dynamic types */
103 SIDE_TYPE_DYNAMIC_NULL,
104 SIDE_TYPE_DYNAMIC_BOOL,
105 SIDE_TYPE_DYNAMIC_U8,
106 SIDE_TYPE_DYNAMIC_U16,
107 SIDE_TYPE_DYNAMIC_U32,
108 SIDE_TYPE_DYNAMIC_U64,
109 SIDE_TYPE_DYNAMIC_S8,
110 SIDE_TYPE_DYNAMIC_S16,
111 SIDE_TYPE_DYNAMIC_S32,
112 SIDE_TYPE_DYNAMIC_S64,
113 SIDE_TYPE_DYNAMIC_BYTE,
114 SIDE_TYPE_DYNAMIC_POINTER32,
115 SIDE_TYPE_DYNAMIC_POINTER64,
116 SIDE_TYPE_DYNAMIC_FLOAT_BINARY16,
117 SIDE_TYPE_DYNAMIC_FLOAT_BINARY32,
118 SIDE_TYPE_DYNAMIC_FLOAT_BINARY64,
119 SIDE_TYPE_DYNAMIC_FLOAT_BINARY128,
120 SIDE_TYPE_DYNAMIC_STRING,
121
122 /* Dynamic compound types */
123 SIDE_TYPE_DYNAMIC_STRUCT,
124 SIDE_TYPE_DYNAMIC_STRUCT_VISITOR,
125 SIDE_TYPE_DYNAMIC_VLA,
126 SIDE_TYPE_DYNAMIC_VLA_VISITOR,
f611d0c3
MD
127};
128
bc3c89b3 129enum side_attr_type {
e2c978ee 130 SIDE_ATTR_TYPE_NULL,
bc3c89b3 131 SIDE_ATTR_TYPE_BOOL,
bc3c89b3
MD
132 SIDE_ATTR_TYPE_U8,
133 SIDE_ATTR_TYPE_U16,
134 SIDE_ATTR_TYPE_U32,
135 SIDE_ATTR_TYPE_U64,
136 SIDE_ATTR_TYPE_S8,
137 SIDE_ATTR_TYPE_S16,
138 SIDE_ATTR_TYPE_S32,
139 SIDE_ATTR_TYPE_S64,
dd6e76cb
MD
140 SIDE_ATTR_TYPE_POINTER32,
141 SIDE_ATTR_TYPE_POINTER64,
bc3c89b3
MD
142 SIDE_ATTR_TYPE_FLOAT_BINARY16,
143 SIDE_ATTR_TYPE_FLOAT_BINARY32,
144 SIDE_ATTR_TYPE_FLOAT_BINARY64,
145 SIDE_ATTR_TYPE_FLOAT_BINARY128,
bc3c89b3
MD
146 SIDE_ATTR_TYPE_STRING,
147};
148
f611d0c3
MD
149enum side_loglevel {
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,
158};
159
160enum side_visitor_status {
f611d0c3 161 SIDE_VISITOR_STATUS_OK = 0,
db6ecef9 162 SIDE_VISITOR_STATUS_ERROR = -1,
f611d0c3
MD
163};
164
a3f36db7
MD
165enum side_error {
166 SIDE_ERROR_OK = 0,
167 SIDE_ERROR_INVAL = 1,
168 SIDE_ERROR_EXIST = 2,
169 SIDE_ERROR_NOMEM = 3,
170 SIDE_ERROR_NOENT = 4,
6e46f5e6 171 SIDE_ERROR_EXITING = 5,
a3f36db7
MD
172};
173
66de373e 174enum side_type_label_byte_order {
8bdd5c12
MD
175 SIDE_TYPE_BYTE_ORDER_LE = 0,
176 SIDE_TYPE_BYTE_ORDER_BE = 1,
177};
178
179#if (SIDE_BYTE_ORDER == SIDE_LITTLE_ENDIAN)
180# define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
181#else
182# define SIDE_TYPE_BYTE_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
183#endif
184
185#if (SIDE_FLOAT_WORD_ORDER == SIDE_LITTLE_ENDIAN)
186# define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_LE
187#else
188# define SIDE_TYPE_FLOAT_WORD_ORDER_HOST SIDE_TYPE_BYTE_ORDER_BE
189#endif
190
e65f9ce5 191typedef enum side_visitor_status (*side_visitor_func)(
f93e01ac
MD
192 const struct side_tracer_visitor_ctx *tracer_ctx,
193 void *app_ctx);
e65f9ce5 194typedef enum side_visitor_status (*side_dynamic_struct_visitor_func)(
f93e01ac
MD
195 const struct side_tracer_dynamic_struct_visitor_ctx *tracer_ctx,
196 void *app_ctx);
f611d0c3 197
d37fe349 198union side_integer_value {
43d85239
MD
199 uint8_t side_u8;
200 uint16_t side_u16;
201 uint32_t side_u32;
202 uint64_t side_u64;
203 int8_t side_s8;
204 int16_t side_s16;
205 int32_t side_s32;
206 int64_t side_s64;
de4ae6e8 207} SIDE_PACKED;
43d85239 208
d37fe349 209union side_float_value {
bc3c89b3 210#if __HAVE_FLOAT16
11f55862 211 _Float16 side_float_binary16;
bc3c89b3
MD
212#endif
213#if __HAVE_FLOAT32
11f55862 214 _Float32 side_float_binary32;
bc3c89b3
MD
215#endif
216#if __HAVE_FLOAT64
11f55862 217 _Float64 side_float_binary64;
bc3c89b3
MD
218#endif
219#if __HAVE_FLOAT128
11f55862 220 _Float128 side_float_binary128;
bc3c89b3 221#endif
de4ae6e8 222} SIDE_PACKED;
a4969f31
MD
223
224struct side_attr_value {
225 uint32_t type; /* enum side_attr_type */
226 union {
5f82db91
MD
227 uint8_t bool_value;
228 uint64_t string_value; /* const char * */
d37fe349
MD
229 union side_integer_value integer_value;
230 union side_float_value float_value;
de4ae6e8 231 } SIDE_PACKED u;
bc3c89b3
MD
232};
233
65010f43
MD
234/* User attributes. */
235struct side_attr {
236 const char *key;
bc3c89b3 237 const struct side_attr_value value;
de4ae6e8 238} SIDE_PACKED;
65010f43 239
169a8a57
MD
240/* Type descriptions */
241struct side_type_null {
242 const struct side_attr *attr;
243 uint32_t nr_attr;
244} SIDE_PACKED;
245
246struct side_type_bool {
247 const struct side_attr *attr;
248 uint32_t nr_attr;
249} SIDE_PACKED;
250
251struct side_type_byte {
252 const struct side_attr *attr;
253 uint32_t nr_attr;
254} SIDE_PACKED;
255
169a8a57
MD
256struct side_type_string {
257 const struct side_attr *attr;
258 uint32_t nr_attr;
259} SIDE_PACKED;
260
87405d12
MD
261struct side_type_integer {
262 const struct side_attr *attr;
263 uint32_t nr_attr;
264 uint16_t integer_size_bits; /* bits */
265 uint16_t len_bits; /* bits */
266 uint8_t signedness; /* true/false */
66de373e 267 uint8_t byte_order; /* enum side_type_label_byte_order */
de4ae6e8 268} SIDE_PACKED;
87405d12
MD
269
270struct side_type_float {
271 const struct side_attr *attr;
272 uint32_t nr_attr;
87405d12 273 uint16_t float_size_bits; /* bits */
e65f9ce5 274 uint8_t byte_order; /* enum side_type_label_byte_order */
de4ae6e8 275} SIDE_PACKED;
87405d12 276
79f677ba
MD
277struct side_enum_mapping {
278 int64_t range_begin;
279 int64_t range_end;
280 const char *label;
de4ae6e8 281} SIDE_PACKED;
79f677ba
MD
282
283struct side_enum_mappings {
284 const struct side_enum_mapping *mappings;
d4328528 285 const struct side_attr *attr;
79f677ba 286 uint32_t nr_mappings;
d4328528 287 uint32_t nr_attr;
de4ae6e8 288} SIDE_PACKED;
79f677ba 289
66cff328 290struct side_enum_bitmap_mapping {
9ff49ee4
MD
291 uint64_t range_begin;
292 uint64_t range_end;
66cff328 293 const char *label;
de4ae6e8 294} SIDE_PACKED;
66cff328
MD
295
296struct side_enum_bitmap_mappings {
297 const struct side_enum_bitmap_mapping *mappings;
d4328528 298 const struct side_attr *attr;
66cff328 299 uint32_t nr_mappings;
d4328528 300 uint32_t nr_attr;
de4ae6e8 301} SIDE_PACKED;
66cff328 302
c7a14585 303struct side_type_struct {
c7a14585
MD
304 const struct side_event_field *fields;
305 const struct side_attr *attr;
809bf3aa
MD
306 uint32_t nr_fields;
307 uint32_t nr_attr;
de4ae6e8 308} SIDE_PACKED;
c7a14585 309
0ab2cbbc
MD
310struct side_type_array {
311 const struct side_type *elem_type;
312 const struct side_attr *attr;
313 uint32_t length;
314 uint32_t nr_attr;
315} SIDE_PACKED;
316
317struct side_type_vla {
318 const struct side_type *elem_type;
319 const struct side_attr *attr;
320 uint32_t nr_attr;
321} SIDE_PACKED;
322
323struct side_type_vla_visitor {
0ab2cbbc 324 const struct side_type *elem_type;
e65f9ce5 325 side_visitor_func visitor;
0ab2cbbc
MD
326 const struct side_attr *attr;
327 uint32_t nr_attr;
328} SIDE_PACKED;
329
330struct side_type_enum {
331 const struct side_enum_mappings *mappings;
332 const struct side_type *elem_type;
333} SIDE_PACKED;
334
335struct side_type_enum_bitmap {
336 const struct side_enum_bitmap_mappings *mappings;
337 const struct side_type *elem_type;
338} SIDE_PACKED;
339
d69918cc
MD
340struct side_type_gather_byte {
341 uint64_t offset; /* bytes */
342 uint8_t access_mode; /* enum side_type_gather_access_mode */
343 struct side_type_byte type;
344} SIDE_PACKED;
345
d41cb7ee 346struct side_type_gather_integer {
65b8734a 347 uint64_t offset; /* bytes */
d41cb7ee 348 uint8_t access_mode; /* enum side_type_gather_access_mode */
11f55862 349 struct side_type_integer type;
65b8734a
MD
350 uint16_t offset_bits; /* bits */
351} SIDE_PACKED;
352
d41cb7ee 353struct side_type_gather_float {
65b8734a 354 uint64_t offset; /* bytes */
d41cb7ee 355 uint8_t access_mode; /* enum side_type_gather_access_mode */
65b8734a 356 struct side_type_float type;
11f55862
MD
357} SIDE_PACKED;
358
d41cb7ee 359struct side_type_gather_struct {
65b8734a 360 uint64_t offset; /* bytes */
d41cb7ee 361 uint8_t access_mode; /* enum side_type_gather_access_mode */
dd7947bf 362 const struct side_type_struct *type;
65b8734a
MD
363 uint32_t size; /* bytes */
364} SIDE_PACKED;
365
d41cb7ee 366struct side_type_gather_array {
65b8734a 367 uint64_t offset; /* bytes */
d41cb7ee 368 uint8_t access_mode; /* enum side_type_gather_access_mode */
65b8734a
MD
369 struct side_type_array type;
370} SIDE_PACKED;
371
d41cb7ee 372struct side_type_gather_vla {
65b8734a
MD
373 const struct side_type *length_type; /* side_length() */
374
375 uint64_t offset; /* bytes */
d41cb7ee 376 uint8_t access_mode; /* enum side_type_gather_access_mode */
65b8734a 377 struct side_type_vla type;
dd7947bf
MD
378} SIDE_PACKED;
379
d41cb7ee
MD
380enum side_type_gather_access_mode {
381 SIDE_TYPE_GATHER_ACCESS_ADDRESS,
382 SIDE_TYPE_GATHER_ACCESS_POINTER,
dd7947bf
MD
383};
384
d41cb7ee 385struct side_type_gather {
7a1cb105 386 union {
d69918cc 387 struct side_type_gather_byte side_byte;
d41cb7ee
MD
388 struct side_type_gather_integer side_integer;
389 struct side_type_gather_float side_float;
390 struct side_type_gather_array side_array;
391 struct side_type_gather_vla side_vla;
392 struct side_type_gather_struct side_struct;
de4ae6e8
MD
393 } SIDE_PACKED u;
394} SIDE_PACKED;
7a1cb105 395
66de373e
MD
396/* Statically defined types. */
397struct side_type {
398 uint32_t type; /* enum side_type_label */
f611d0c3 399 union {
e24949fa 400 /* Basic types */
9b641221 401 struct side_type_null side_null;
5f82db91
MD
402 struct side_type_bool side_bool;
403 struct side_type_byte side_byte;
5f82db91 404 struct side_type_string side_string;
56c21987 405 struct side_type_integer side_integer;
d44b44d1 406 struct side_type_float side_float;
56c21987 407
e24949fa 408 /* Compound types */
0ab2cbbc
MD
409 struct side_type_array side_array;
410 struct side_type_vla side_vla;
411 struct side_type_vla_visitor side_vla_visitor;
d4328528 412 const struct side_type_struct *side_struct;
af6aa6e1
MD
413
414 /* Enumeration types */
0ab2cbbc
MD
415 struct side_type_enum side_enum;
416 struct side_type_enum_bitmap side_enum_bitmap;
33956c71 417
d41cb7ee
MD
418 /* Gather types */
419 struct side_type_gather side_gather;
de4ae6e8
MD
420 } SIDE_PACKED u;
421} SIDE_PACKED;
f611d0c3
MD
422
423struct side_event_field {
424 const char *field_name;
66de373e 425 struct side_type side_type;
de4ae6e8 426} SIDE_PACKED;
f611d0c3 427
8a25ce77
MD
428enum side_event_flags {
429 SIDE_EVENT_FLAG_VARIADIC = (1 << 0),
430};
431
d89fabc8
MD
432struct side_callback {
433 union {
434 void (*call)(const struct side_event_description *desc,
9a6ca773 435 const struct side_arg_vec *side_arg_vec,
d89fabc8
MD
436 void *priv);
437 void (*call_variadic)(const struct side_event_description *desc,
9a6ca773 438 const struct side_arg_vec *side_arg_vec,
0c7abe2b 439 const struct side_arg_dynamic_struct *var_struct,
d89fabc8 440 void *priv);
de4ae6e8 441 } SIDE_PACKED u;
d89fabc8 442 void *priv;
de4ae6e8 443} SIDE_PACKED;
d89fabc8 444
66de373e
MD
445struct side_arg_static {
446 /* Basic types */
447 uint8_t bool_value;
448 uint8_t byte_value;
449 uint64_t string_value; /* const char * */
450 union side_integer_value integer_value;
451 union side_float_value float_value;
452
453 /* Compound types */
454 const struct side_arg_vec *side_struct;
455 const struct side_arg_vec *side_array;
456 const struct side_arg_vec *side_vla;
457 void *side_vla_app_visitor_ctx;
458 void *side_array_fixint;
459 struct {
460 void *p;
461 uint32_t length;
462 } SIDE_PACKED side_vla_fixint;
33956c71 463
d41cb7ee 464 /* Gather types */
d69918cc 465 void *side_byte_gather_ptr;
d41cb7ee
MD
466 void *side_integer_gather_ptr;
467 void *side_float_gather_ptr;
468 void *side_array_gather_ptr;
469 void *side_struct_gather_ptr;
65b8734a
MD
470 struct {
471 void *ptr;
472 void *length_ptr;
d41cb7ee 473 } SIDE_PACKED side_vla_gather;
66de373e
MD
474} SIDE_PACKED;
475
11f55862
MD
476struct side_arg_dynamic_vla {
477 const struct side_arg *sav;
478 const struct side_attr *attr;
479 uint32_t len;
480 uint32_t nr_attr;
481} SIDE_PACKED;
482
483struct side_arg_dynamic_struct {
484 const struct side_arg_dynamic_field *fields;
485 const struct side_attr *attr;
486 uint32_t len;
487 uint32_t nr_attr;
488} SIDE_PACKED;
489
490struct side_dynamic_struct_visitor {
491 void *app_ctx;
e65f9ce5 492 side_dynamic_struct_visitor_func visitor;
11f55862
MD
493 const struct side_attr *attr;
494 uint32_t nr_attr;
495} SIDE_PACKED;
496
497struct side_dynamic_vla_visitor {
498 void *app_ctx;
e65f9ce5 499 side_visitor_func visitor;
11f55862
MD
500 const struct side_attr *attr;
501 uint32_t nr_attr;
502} SIDE_PACKED;
503
66de373e
MD
504struct side_arg_dynamic {
505 /* Basic types */
506 struct side_type_null side_null;
507 struct {
508 struct side_type_bool type;
509 uint8_t value;
510 } SIDE_PACKED side_bool;
511
512 struct {
513 struct side_type_byte type;
514 uint8_t value;
515 } SIDE_PACKED side_byte;
516
517 struct {
518 struct side_type_string type;
519 uint64_t value; /* const char * */
520 } SIDE_PACKED side_string;
521
522 /* Integer type */
523 struct {
524 struct side_type_integer type;
525 union side_integer_value value;
526 } SIDE_PACKED side_integer;
527
528 struct {
529 struct side_type_float type;
530 union side_float_value value;
531 } SIDE_PACKED side_float;
532
533 /* Compound types */
0c7abe2b 534 const struct side_arg_dynamic_struct *side_dynamic_struct;
66de373e 535 const struct side_arg_dynamic_vla *side_dynamic_vla;
11f55862
MD
536
537 struct side_dynamic_struct_visitor side_dynamic_struct_visitor;
538 struct side_dynamic_vla_visitor side_dynamic_vla_visitor;
66de373e
MD
539} SIDE_PACKED;
540
541struct side_arg {
542 enum side_type_label type;
543 union {
544 struct side_arg_static side_static;
545 struct side_arg_dynamic side_dynamic;
546 } SIDE_PACKED u;
547} SIDE_PACKED;
548
549struct side_arg_vec {
550 const struct side_arg *sav;
551 uint32_t len;
552} SIDE_PACKED;
553
0c7abe2b 554struct side_arg_dynamic_field {
465e5e7e 555 const char *field_name;
66de373e 556 const struct side_arg elem;
de4ae6e8 557} SIDE_PACKED;
465e5e7e 558
352a4b77
MD
559/* The visitor pattern is a double-dispatch visitor. */
560struct side_tracer_visitor_ctx {
f93e01ac
MD
561 enum side_visitor_status (*write_elem)(
562 const struct side_tracer_visitor_ctx *tracer_ctx,
66de373e 563 const struct side_arg *elem);
352a4b77 564 void *priv; /* Private tracer context. */
de4ae6e8 565} SIDE_PACKED;
352a4b77 566
c208889e 567struct side_tracer_dynamic_struct_visitor_ctx {
f93e01ac
MD
568 enum side_visitor_status (*write_field)(
569 const struct side_tracer_dynamic_struct_visitor_ctx *tracer_ctx,
0c7abe2b 570 const struct side_arg_dynamic_field *dynamic_field);
bdc39c09 571 void *priv; /* Private tracer context. */
de4ae6e8 572} SIDE_PACKED;
bdc39c09 573
11f55862
MD
574struct side_event_description {
575 uintptr_t *enabled;
576 const char *provider_name;
577 const char *event_name;
578 const struct side_event_field *fields;
579 const struct side_attr *attr;
580 const struct side_callback *callbacks;
581 uint64_t flags;
582 uint32_t version;
583 uint32_t loglevel; /* enum side_loglevel */
584 uint32_t nr_fields;
585 uint32_t nr_attr;
586 uint32_t nr_callbacks;
587} SIDE_PACKED;
588
e24949fa
MD
589/* Event and type attributes */
590
dd6e76cb
MD
591#if SIDE_BITS_PER_LONG == 64
592# define SIDE_TYPE_POINTER_HOST SIDE_TYPE_POINTER64
593# define SIDE_TYPE_ARRAY_POINTER_HOST SIDE_TYPE_ARRAY_POINTER64
594# define SIDE_TYPE_VLA_POINTER_HOST SIDE_TYPE_VLA_POINTER64
66de373e 595# define SIDE_TYPE_DYNAMIC_POINTER_HOST SIDE_TYPE_DYNAMIC_POINTER64
dd6e76cb 596# define SIDE_ATTR_TYPE_POINTER_HOST SIDE_ATTR_TYPE_POINTER64
35d25fc5 597# define SIDE_PTR_HOST .side_u64
dd6e76cb
MD
598#else
599# define SIDE_TYPE_POINTER_HOST SIDE_TYPE_POINTER32
600# define SIDE_TYPE_ARRAY_POINTER_HOST SIDE_TYPE_ARRAY_POINTER32
601# define SIDE_TYPE_VLA_POINTER_HOST SIDE_TYPE_VLA_POINTER32
66de373e 602# define SIDE_TYPE_DYNAMIC_POINTER_HOST SIDE_TYPE_DYNAMIC_POINTER32
dd6e76cb 603# define SIDE_ATTR_TYPE_POINTER_HOST SIDE_ATTR_TYPE_POINTER32
35d25fc5 604# define SIDE_PTR_HOST .side_u32
dd6e76cb
MD
605#endif
606
65010f43
MD
607#define side_attr(_key, _value) \
608 { \
609 .key = _key, \
bc3c89b3 610 .value = SIDE_PARAM(_value), \
65010f43
MD
611 }
612
613#define side_attr_list(...) \
614 SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
615
e2c978ee 616#define side_attr_null(_val) { .type = SIDE_ATTR_TYPE_NULL }
5f82db91 617#define side_attr_bool(_val) { .type = SIDE_ATTR_TYPE_BOOL, .u = { .bool_value = !!(_val) } }
35d25fc5
MD
618#define side_attr_u8(_val) { .type = SIDE_ATTR_TYPE_U8, .u = { .integer_value = { .side_u8 = (_val) } } }
619#define side_attr_u16(_val) { .type = SIDE_ATTR_TYPE_U16, .u = { .integer_value = { .side_u16 = (_val) } } }
620#define side_attr_u32(_val) { .type = SIDE_ATTR_TYPE_U32, .u = { .integer_value = { .side_u32 = (_val) } } }
621#define side_attr_u64(_val) { .type = SIDE_ATTR_TYPE_U64, .u = { .integer_value = { .side_u64 = (_val) } } }
622#define side_attr_s8(_val) { .type = SIDE_ATTR_TYPE_S8, .u = { .integer_value = { .side_s8 = (_val) } } }
623#define side_attr_s16(_val) { .type = SIDE_ATTR_TYPE_S16, .u = { .integer_value = { .side_s16 = (_val) } } }
624#define side_attr_s32(_val) { .type = SIDE_ATTR_TYPE_S32, .u = { .integer_value = { .side_s32 = (_val) } } }
625#define side_attr_s64(_val) { .type = SIDE_ATTR_TYPE_S64, .u = { .integer_value = { .side_s64 = (_val) } } }
626#define side_attr_pointer(_val) { .type = SIDE_ATTR_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
627#define side_attr_float_binary16(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .float_value = { .side_float_binary16 = (_val) } } }
628#define side_attr_float_binary32(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .float_value = { .side_float_binary32 = (_val) } } }
629#define side_attr_float_binary64(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .float_value = { .side_float_binary64 = (_val) } } }
630#define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .float_value = { .side_float_binary128 = (_val) } } }
5f82db91 631#define side_attr_string(_val) { .type = SIDE_ATTR_TYPE_STRING, .u = { .string_value = (uintptr_t) (_val) } }
e24949fa
MD
632
633/* Static field definition */
634
9b641221
MD
635#define side_type_null(_attr) \
636 { \
637 .type = SIDE_TYPE_NULL, \
638 .u = { \
639 .side_null = { \
640 .attr = _attr, \
641 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
642 }, \
643 }, \
644 }
645
5f82db91 646#define side_type_bool(_attr) \
f37a556f 647 { \
5f82db91
MD
648 .type = SIDE_TYPE_BOOL, \
649 .u = { \
650 .side_bool = { \
651 .attr = _attr, \
652 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
653 }, \
654 }, \
655 }
656
657#define side_type_byte(_attr) \
658 { \
659 .type = SIDE_TYPE_BYTE, \
d4328528 660 .u = { \
5f82db91
MD
661 .side_byte = { \
662 .attr = _attr, \
663 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
664 }, \
665 }, \
666 }
667
668#define side_type_string(_attr) \
669 { \
670 .type = SIDE_TYPE_STRING, \
671 .u = { \
672 .side_string = { \
673 .attr = _attr, \
674 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
675 }, \
676 }, \
677 }
678
66de373e 679#define side_type_dynamic() \
5f82db91
MD
680 { \
681 .type = SIDE_TYPE_DYNAMIC, \
f37a556f 682 }
f93e01ac 683
56c21987
MD
684#define _side_type_integer(_type, _signedness, _byte_order, _integer_size_bits, _len_bits, _attr) \
685 { \
686 .type = _type, \
687 .u = { \
688 .side_integer = { \
689 .attr = _attr, \
690 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
56c21987
MD
691 .integer_size_bits = _integer_size_bits, \
692 .len_bits = _len_bits, \
984bcab7
MD
693 .signedness = _signedness, \
694 .byte_order = _byte_order, \
56c21987
MD
695 }, \
696 }, \
697 }
698
d44b44d1
MD
699#define _side_type_float(_type, _byte_order, _float_size_bits, _attr) \
700 { \
701 .type = _type, \
702 .u = { \
703 .side_float = { \
704 .attr = _attr, \
705 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
d44b44d1 706 .float_size_bits = _float_size_bits, \
e65f9ce5 707 .byte_order = _byte_order, \
d44b44d1
MD
708 }, \
709 }, \
710 }
711
cb6f04c2 712#define _side_field(_name, _type) \
f93e01ac
MD
713 { \
714 .field_name = _name, \
cb6f04c2 715 .side_type = _type, \
f93e01ac 716 }
f611d0c3 717
8bdd5c12 718/* Host endian */
56c21987
MD
719#define side_type_u8(_attr) _side_type_integer(SIDE_TYPE_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
720#define side_type_u16(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_HOST, 16, 16, SIDE_PARAM(_attr))
721#define side_type_u32(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_HOST, 32, 32, SIDE_PARAM(_attr))
722#define side_type_u64(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_HOST, 64, 64, SIDE_PARAM(_attr))
723#define side_type_s8(_attr) _side_type_integer(SIDE_TYPE_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
724#define side_type_s16(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_HOST, 16, 16, SIDE_PARAM(_attr))
725#define side_type_s32(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_HOST, 32, 32, SIDE_PARAM(_attr))
726#define side_type_s64(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_HOST, 64, 64, SIDE_PARAM(_attr))
3fa64a4c
MD
727#define side_type_pointer(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_BITS_PER_LONG, \
728 SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
d44b44d1
MD
729#define side_type_float_binary16(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 16, SIDE_PARAM(_attr))
730#define side_type_float_binary32(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 32, SIDE_PARAM(_attr))
731#define side_type_float_binary64(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 64, SIDE_PARAM(_attr))
732#define side_type_float_binary128(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, 128, SIDE_PARAM(_attr))
8bdd5c12 733
9b641221 734#define side_field_null(_name, _attr) _side_field(_name, side_type_null(SIDE_PARAM(_attr)))
cb6f04c2
MD
735#define side_field_bool(_name, _attr) _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
736#define side_field_u8(_name, _attr) _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
737#define side_field_u16(_name, _attr) _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
738#define side_field_u32(_name, _attr) _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
739#define side_field_u64(_name, _attr) _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
740#define side_field_s8(_name, _attr) _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
741#define side_field_s16(_name, _attr) _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
742#define side_field_s32(_name, _attr) _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
743#define side_field_s64(_name, _attr) _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
f7653b43 744#define side_field_byte(_name, _attr) _side_field(_name, side_type_byte(SIDE_PARAM(_attr)))
f5e650d7 745#define side_field_pointer(_name, _attr) _side_field(_name, side_type_pointer(SIDE_PARAM(_attr)))
cb6f04c2
MD
746#define side_field_float_binary16(_name, _attr) _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
747#define side_field_float_binary32(_name, _attr) _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
748#define side_field_float_binary64(_name, _attr) _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
749#define side_field_float_binary128(_name, _attr) _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
750#define side_field_string(_name, _attr) _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
66de373e 751#define side_field_dynamic(_name) _side_field(_name, side_type_dynamic())
485b800a 752
8bdd5c12 753/* Little endian */
56c21987
MD
754#define side_type_u16_le(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_LE, 16, 16, SIDE_PARAM(_attr))
755#define side_type_u32_le(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_LE, 32, 32, SIDE_PARAM(_attr))
756#define side_type_u64_le(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_LE, 64, 64, SIDE_PARAM(_attr))
757#define side_type_s16_le(_attr) _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_LE, 16, 16, SIDE_PARAM(_attr))
758#define side_type_s32_le(_attr) _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_LE, 32, 32, SIDE_PARAM(_attr))
759#define side_type_s64_le(_attr) _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_LE, 64, 64, SIDE_PARAM(_attr))
3fa64a4c
MD
760#define side_type_pointer_le(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_LE, SIDE_BITS_PER_LONG, \
761 SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
d44b44d1
MD
762#define side_type_float_binary16_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_LE, 16, SIDE_PARAM(_attr))
763#define side_type_float_binary32_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_LE, 32, SIDE_PARAM(_attr))
764#define side_type_float_binary64_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_LE, 64, SIDE_PARAM(_attr))
765#define side_type_float_binary128_le(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_LE, 128, SIDE_PARAM(_attr))
8bdd5c12
MD
766
767#define side_field_u16_le(_name, _attr) _side_field(_name, side_type_u16_le(SIDE_PARAM(_attr)))
768#define side_field_u32_le(_name, _attr) _side_field(_name, side_type_u32_le(SIDE_PARAM(_attr)))
769#define side_field_u64_le(_name, _attr) _side_field(_name, side_type_u64_le(SIDE_PARAM(_attr)))
770#define side_field_s16_le(_name, _attr) _side_field(_name, side_type_s16_le(SIDE_PARAM(_attr)))
771#define side_field_s32_le(_name, _attr) _side_field(_name, side_type_s32_le(SIDE_PARAM(_attr)))
772#define side_field_s64_le(_name, _attr) _side_field(_name, side_type_s64_le(SIDE_PARAM(_attr)))
f5e650d7 773#define side_field_pointer_le(_name, _attr) _side_field(_name, side_type_pointer_le(SIDE_PARAM(_attr)))
8bdd5c12
MD
774#define side_field_float_binary16_le(_name, _attr) _side_field(_name, side_type_float_binary16_le(SIDE_PARAM(_attr)))
775#define side_field_float_binary32_le(_name, _attr) _side_field(_name, side_type_float_binary32_le(SIDE_PARAM(_attr)))
776#define side_field_float_binary64_le(_name, _attr) _side_field(_name, side_type_float_binary64_le(SIDE_PARAM(_attr)))
777#define side_field_float_binary128_le(_name, _attr) _side_field(_name, side_type_float_binary128_le(SIDE_PARAM(_attr)))
778
779/* Big endian */
56c21987
MD
780#define side_type_u16_be(_attr) _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_BE, 16, 16, SIDE_PARAM(_attr))
781#define side_type_u32_be(_attr) _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_BE, 32, 32, SIDE_PARAM(_attr))
782#define side_type_u64_be(_attr) _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_BE, 64, 64, SIDE_PARAM(_attr))
783#define side_type_s16_be(_attr) _side_type_integer(SIDE_TYPE_S16, false, SIDE_TYPE_BYTE_ORDER_BE, 16, 16, SIDE_PARAM(_attr))
784#define side_type_s32_be(_attr) _side_type_integer(SIDE_TYPE_S32, false, SIDE_TYPE_BYTE_ORDER_BE, 32, 32, SIDE_PARAM(_attr))
785#define side_type_s64_be(_attr) _side_type_integer(SIDE_TYPE_S64, false, SIDE_TYPE_BYTE_ORDER_BE, 64, 64, SIDE_PARAM(_attr))
3fa64a4c
MD
786#define side_type_pointer_be(_attr) _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_BE, SIDE_BITS_PER_LONG, \
787 SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
d44b44d1
MD
788#define side_type_float_binary16_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_BE, 16, SIDE_PARAM(_attr))
789#define side_type_float_binary32_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_BE, 32, SIDE_PARAM(_attr))
790#define side_type_float_binary64_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_BE, 64, SIDE_PARAM(_attr))
791#define side_type_float_binary128_be(_attr) _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_BE, 128, SIDE_PARAM(_attr))
8bdd5c12
MD
792
793#define side_field_u16_be(_name, _attr) _side_field(_name, side_type_u16_be(SIDE_PARAM(_attr)))
794#define side_field_u32_be(_name, _attr) _side_field(_name, side_type_u32_be(SIDE_PARAM(_attr)))
795#define side_field_u64_be(_name, _attr) _side_field(_name, side_type_u64_be(SIDE_PARAM(_attr)))
796#define side_field_s16_be(_name, _attr) _side_field(_name, side_type_s16_be(SIDE_PARAM(_attr)))
797#define side_field_s32_be(_name, _attr) _side_field(_name, side_type_s32_be(SIDE_PARAM(_attr)))
798#define side_field_s64_be(_name, _attr) _side_field(_name, side_type_s64_be(SIDE_PARAM(_attr)))
f5e650d7 799#define side_field_pointer_be(_name, _attr) _side_field(_name, side_type_pointer_be(SIDE_PARAM(_attr)))
8bdd5c12
MD
800#define side_field_float_binary16_be(_name, _attr) _side_field(_name, side_type_float_binary16_be(SIDE_PARAM(_attr)))
801#define side_field_float_binary32_be(_name, _attr) _side_field(_name, side_type_float_binary32_be(SIDE_PARAM(_attr)))
802#define side_field_float_binary64_be(_name, _attr) _side_field(_name, side_type_float_binary64_be(SIDE_PARAM(_attr)))
803#define side_field_float_binary128_be(_name, _attr) _side_field(_name, side_type_float_binary128_be(SIDE_PARAM(_attr)))
804
f89c4ad1 805#define side_type_enum(_mappings, _elem_type) \
79f677ba 806 { \
d8be25de 807 .type = SIDE_TYPE_ENUM, \
79f677ba 808 .u = { \
d8be25de 809 .side_enum = { \
d8be25de 810 .mappings = _mappings, \
f89c4ad1 811 .elem_type = _elem_type, \
d8be25de 812 }, \
79f677ba
MD
813 }, \
814 }
f89c4ad1
MD
815#define side_field_enum(_name, _mappings, _elem_type) \
816 _side_field(_name, side_type_enum(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
d4328528 817
f89c4ad1 818#define side_type_enum_bitmap(_mappings, _elem_type) \
af6aa6e1 819 { \
bab5d6e4 820 .type = SIDE_TYPE_ENUM_BITMAP, \
af6aa6e1 821 .u = { \
bab5d6e4 822 .side_enum_bitmap = { \
af6aa6e1 823 .mappings = _mappings, \
f89c4ad1 824 .elem_type = _elem_type, \
af6aa6e1
MD
825 }, \
826 }, \
827 }
f89c4ad1
MD
828#define side_field_enum_bitmap(_name, _mappings, _elem_type) \
829 _side_field(_name, side_type_enum_bitmap(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
66cff328 830
c7a14585 831#define side_type_struct(_struct) \
f611d0c3
MD
832 { \
833 .type = SIDE_TYPE_STRUCT, \
834 .u = { \
c7a14585 835 .side_struct = _struct, \
f611d0c3
MD
836 }, \
837 }
c7a14585
MD
838#define side_field_struct(_name, _struct) \
839 _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
840
841#define _side_type_struct_define(_fields, _attr) \
842 { \
c7a14585
MD
843 .fields = _fields, \
844 .attr = _attr, \
e65f9ce5
MD
845 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
846 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
c7a14585
MD
847 }
848
849#define side_define_struct(_identifier, _fields, _attr) \
850 const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
851
852#define side_struct_literal(_fields, _attr) \
853 SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
854 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
f611d0c3 855
d9359cfa
MD
856#define side_type_array(_elem_type, _length, _attr) \
857 { \
858 .type = SIDE_TYPE_ARRAY, \
859 .u = { \
860 .side_array = { \
861 .elem_type = _elem_type, \
862 .attr = _attr, \
863 .length = _length, \
864 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
865 }, \
866 }, \
867 }
868#define side_field_array(_name, _elem_type, _length, _attr) \
869 _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
870
871#define side_type_vla(_elem_type, _attr) \
872 { \
873 .type = SIDE_TYPE_VLA, \
874 .u = { \
875 .side_vla = { \
876 .elem_type = _elem_type, \
877 .attr = _attr, \
878 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
879 }, \
880 }, \
881 }
882#define side_field_vla(_name, _elem_type, _attr) \
883 _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
884
885#define side_type_vla_visitor(_elem_type, _visitor, _attr) \
886 { \
887 .type = SIDE_TYPE_VLA_VISITOR, \
888 .u = { \
889 .side_vla_visitor = { \
890 .elem_type = SIDE_PARAM(_elem_type), \
891 .visitor = _visitor, \
892 .attr = _attr, \
893 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
894 }, \
895 }, \
896 }
897#define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
898 _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
899
d41cb7ee 900/* Gather fields */
9b641221 901
d69918cc
MD
902#define side_type_gather_byte(_offset, _access_mode, _attr) \
903 { \
904 .type = SIDE_TYPE_GATHER_BYTE, \
905 .u = { \
906 .side_gather = { \
907 .u = { \
908 .side_byte = { \
909 .offset = _offset, \
910 .access_mode = _access_mode, \
911 .type = { \
912 .attr = _attr, \
913 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
914 }, \
915 }, \
916 }, \
917 }, \
918 }, \
919 }
920#define side_field_gather_byte(_name, _offset, _access_mode, _attr) \
921 _side_field(_name, side_type_gather_byte(_offset, _access_mode, SIDE_PARAM(_attr)))
922
d41cb7ee 923#define _side_type_gather_integer(_type, _signedness, _byte_order, _offset, \
dd7947bf 924 _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
7a1cb105
MD
925 { \
926 .type = _type, \
927 .u = { \
d41cb7ee 928 .side_gather = { \
33956c71
MD
929 .u = { \
930 .side_integer = { \
65b8734a
MD
931 .offset = _offset, \
932 .access_mode = _access_mode, \
33956c71
MD
933 .type = { \
934 .attr = _attr, \
935 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
936 .integer_size_bits = _integer_size_bits, \
937 .len_bits = _len_bits, \
938 .signedness = _signedness, \
939 .byte_order = _byte_order, \
940 }, \
941 .offset_bits = _offset_bits, \
942 }, \
87405d12 943 }, \
7a1cb105
MD
944 }, \
945 }, \
946 }
947
d41cb7ee
MD
948#define side_type_gather_unsigned_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
949 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_HOST, \
dd7947bf 950 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
d41cb7ee
MD
951#define side_type_gather_signed_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
952 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_HOST, \
dd7947bf 953 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
7a1cb105 954
d41cb7ee
MD
955#define side_type_gather_unsigned_integer_le(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
956 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_LE, \
dd7947bf 957 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
d41cb7ee
MD
958#define side_type_gather_signed_integer_le(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
959 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_LE, \
dd7947bf 960 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
905f68e3 961
d41cb7ee
MD
962#define side_type_gather_unsigned_integer_be(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
963 _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false, SIDE_TYPE_BYTE_ORDER_BE, \
dd7947bf 964 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
d41cb7ee
MD
965#define side_type_gather_signed_integer_be(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
966 _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_BE, \
dd7947bf 967 _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
905f68e3 968
d41cb7ee
MD
969#define side_field_gather_unsigned_integer(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
970 _side_field(_name, side_type_gather_unsigned_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
971#define side_field_gather_signed_integer(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
972 _side_field(_name, side_type_gather_signed_integer(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
7a1cb105 973
d41cb7ee
MD
974#define side_field_gather_unsigned_integer_le(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
975 _side_field(_name, side_type_gather_unsigned_integer_le(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
976#define side_field_gather_signed_integer_le(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
977 _side_field(_name, side_type_gather_signed_integer_le(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
905f68e3 978
d41cb7ee
MD
979#define side_field_gather_unsigned_integer_be(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
980 _side_field(_name, side_type_gather_unsigned_integer_be(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
981#define side_field_gather_signed_integer_be(_name, _integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, _attr) \
982 _side_field(_name, side_type_gather_signed_integer_be(_integer_offset, _integer_size_bits, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
905f68e3 983
d41cb7ee 984#define _side_type_gather_float(_byte_order, _offset, _float_size_bits, _access_mode, _attr) \
905f68e3 985 { \
d41cb7ee 986 .type = SIDE_TYPE_GATHER_FLOAT, \
905f68e3 987 .u = { \
d41cb7ee 988 .side_gather = { \
905f68e3
MD
989 .u = { \
990 .side_float = { \
65b8734a
MD
991 .offset = _offset, \
992 .access_mode = _access_mode, \
993 .type = { \
994 .attr = _attr, \
995 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
996 .float_size_bits = _float_size_bits, \
997 .byte_order = _byte_order, \
998 }, \
905f68e3
MD
999 }, \
1000 }, \
1001 }, \
1002 }, \
1003 }
1004
d41cb7ee
MD
1005#define side_type_gather_float(_offset, _float_size_bits, _access_mode, _attr) \
1006 _side_type_gather_float(SIDE_TYPE_FLOAT_WORD_ORDER_HOST, _offset, _float_size_bits, _access_mode, _attr)
1007#define side_type_gather_float_le(_offset, _float_size_bits, _access_mode, _attr) \
1008 _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_LE, _offset, _float_size_bits, _access_mode, _attr)
1009#define side_type_gather_float_be(_offset, _float_size_bits, _access_mode, _attr) \
1010 _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_BE, _offset, _float_size_bits, _access_mode, _attr)
1011
1012#define side_field_gather_float(_name, _offset, _float_size_bits, _access_mode, _attr) \
1013 _side_field(_name, side_type_gather_float(_offset, _float_size_bits, _access_mode, _attr))
1014#define side_field_gather_float_le(_name, _offset, _float_size_bits, _access_mode, _attr) \
1015 _side_field(_name, side_type_gather_float_le(_offset, _float_size_bits, _access_mode, _attr))
1016#define side_field_gather_float_be(_name, _offset, _float_size_bits, _access_mode, _attr) \
1017 _side_field(_name, side_type_gather_float_be(_offset, _float_size_bits, _access_mode, _attr))
1018
1019#define side_type_gather_struct(_struct_gather, _offset, _size, _access_mode) \
7a1cb105 1020 { \
d41cb7ee 1021 .type = SIDE_TYPE_GATHER_STRUCT, \
7a1cb105 1022 .u = { \
d41cb7ee 1023 .side_gather = { \
33956c71 1024 .u = { \
dd7947bf 1025 .side_struct = { \
65b8734a
MD
1026 .offset = _offset, \
1027 .access_mode = _access_mode, \
d41cb7ee 1028 .type = _struct_gather, \
dd7947bf
MD
1029 .size = _size, \
1030 }, \
33956c71
MD
1031 }, \
1032 }, \
7a1cb105
MD
1033 }, \
1034 }
d41cb7ee
MD
1035#define side_field_gather_struct(_name, _struct_gather, _offset, _size, _access_mode) \
1036 _side_field(_name, side_type_gather_struct(SIDE_PARAM(_struct_gather), _offset, _size, _access_mode))
7a1cb105 1037
d41cb7ee 1038#define side_type_gather_array(_elem_type_gather, _length, _offset, _access_mode, _attr) \
f611d0c3 1039 { \
d41cb7ee 1040 .type = SIDE_TYPE_GATHER_ARRAY, \
f611d0c3 1041 .u = { \
d41cb7ee 1042 .side_gather = { \
d9359cfa
MD
1043 .u = { \
1044 .side_array = { \
65b8734a
MD
1045 .offset = _offset, \
1046 .access_mode = _access_mode, \
1047 .type = { \
d41cb7ee 1048 .elem_type = _elem_type_gather, \
65b8734a
MD
1049 .attr = _attr, \
1050 .length = _length, \
1051 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1052 }, \
d9359cfa
MD
1053 }, \
1054 }, \
f611d0c3
MD
1055 }, \
1056 }, \
1057 }
d41cb7ee
MD
1058#define side_field_gather_array(_name, _elem_type, _length, _offset, _access_mode, _attr) \
1059 _side_field(_name, side_type_gather_array(SIDE_PARAM(_elem_type), _length, _offset, _access_mode, SIDE_PARAM(_attr)))
f611d0c3 1060
d41cb7ee 1061#define side_type_gather_vla(_elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
65b8734a 1062 { \
d41cb7ee 1063 .type = SIDE_TYPE_GATHER_VLA, \
65b8734a 1064 .u = { \
d41cb7ee 1065 .side_gather = { \
65b8734a
MD
1066 .u = { \
1067 .side_vla = { \
1068 .offset = _offset, \
1069 .access_mode = _access_mode, \
1070 .type = { \
d41cb7ee 1071 .elem_type = _elem_type_gather, \
65b8734a
MD
1072 .attr = _attr, \
1073 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1074 }, \
d41cb7ee 1075 .length_type = _length_type_gather, \
65b8734a
MD
1076 }, \
1077 }, \
1078 }, \
1079 }, \
1080 }
d41cb7ee
MD
1081#define side_field_gather_vla(_name, _elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1082 _side_field(_name, side_type_gather_vla(SIDE_PARAM(_elem_type_gather), _offset, _access_mode, SIDE_PARAM(_length_type_gather), SIDE_PARAM(_attr)))
65b8734a 1083
71002b5e 1084#define side_elem(...) \
66de373e 1085 SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
cdd6e858 1086
65b8734a
MD
1087#define side_length(...) \
1088 SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1089
f611d0c3
MD
1090#define side_field_list(...) \
1091 SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
1092
e24949fa
MD
1093/* Static field arguments */
1094
9b641221 1095#define side_arg_null(_val) { .type = SIDE_TYPE_NULL }
66de373e
MD
1096#define side_arg_bool(_val) { .type = SIDE_TYPE_BOOL, .u = { .side_static = { .bool_value = !!(_val) } } }
1097#define side_arg_byte(_val) { .type = SIDE_TYPE_BYTE, .u = { .side_static = { .byte_value = (_val) } } }
1098#define side_arg_string(_val) { .type = SIDE_TYPE_STRING, .u = { .side_static = { .string_value = (uintptr_t) (_val) } } }
1099
1100#define side_arg_u8(_val) { .type = SIDE_TYPE_U8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1101#define side_arg_u16(_val) { .type = SIDE_TYPE_U16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1102#define side_arg_u32(_val) { .type = SIDE_TYPE_U32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1103#define side_arg_u64(_val) { .type = SIDE_TYPE_U64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1104#define side_arg_s8(_val) { .type = SIDE_TYPE_S8, .u = { .side_static = { .integer_value = { .side_s8 = (_val) } } } }
1105#define side_arg_s16(_val) { .type = SIDE_TYPE_S16, .u = { .side_static = { .integer_value = { .side_s16 = (_val) } } } }
1106#define side_arg_s32(_val) { .type = SIDE_TYPE_S32, .u = { .side_static = { .integer_value = { .side_s32 = (_val) } } } }
1107#define side_arg_s64(_val) { .type = SIDE_TYPE_S64, .u = { .side_static = { .integer_value = { .side_s64 = (_val) } } } }
1108#define side_arg_pointer(_val) { .type = SIDE_TYPE_POINTER_HOST, .u = { .side_static = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } } }
1109#define side_arg_enum_bitmap8(_val) { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1110#define side_arg_enum_bitmap16(_val) { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1111#define side_arg_enum_bitmap32(_val) { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1112#define side_arg_enum_bitmap64(_val) { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1113#define side_arg_enum_bitmap_array(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1114#define side_arg_enum_bitmap_vla(_side_type) { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1115#define side_arg_float_binary16(_val) { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_static = { .float_value = { .side_float_binary16 = (_val) } } } }
1116#define side_arg_float_binary32(_val) { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_static = { .float_value = { .side_float_binary32 = (_val) } } } }
1117#define side_arg_float_binary64(_val) { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_static = { .float_value = { .side_float_binary64 = (_val) } } } }
1118#define side_arg_float_binary128(_val) { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_static = { .float_value = { .side_float_binary128 = (_val) } } } }
1119
1120#define side_arg_struct(_side_type) { .type = SIDE_TYPE_STRUCT, .u = { .side_static = { .side_struct = (_side_type) } } }
66de373e
MD
1121#define side_arg_array(_side_type) { .type = SIDE_TYPE_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1122#define side_arg_vla(_side_type) { .type = SIDE_TYPE_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1123#define side_arg_vla_visitor(_ctx) { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_static = { .side_vla_app_visitor_ctx = (_ctx) } } }
1124
1125#define side_arg_array_u8(_ptr) { .type = SIDE_TYPE_ARRAY_U8, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1126#define side_arg_array_u16(_ptr) { .type = SIDE_TYPE_ARRAY_U16, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1127#define side_arg_array_u32(_ptr) { .type = SIDE_TYPE_ARRAY_U32, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1128#define side_arg_array_u64(_ptr) { .type = SIDE_TYPE_ARRAY_U64, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1129#define side_arg_array_s8(_ptr) { .type = SIDE_TYPE_ARRAY_S8, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1130#define side_arg_array_s16(_ptr) { .type = SIDE_TYPE_ARRAY_S16, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1131#define side_arg_array_s32(_ptr) { .type = SIDE_TYPE_ARRAY_S32, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1132#define side_arg_array_s64(_ptr) { .type = SIDE_TYPE_ARRAY_S64, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1133#define side_arg_array_byte(_ptr) { .type = SIDE_TYPE_ARRAY_BYTE, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1134#define side_arg_array_pointer(_ptr) { .type = SIDE_TYPE_ARRAY_POINTER_HOST, .u = { .side_static = { .side_array_fixint = (_ptr) } } }
1135
1136#define side_arg_vla_u8(_ptr, _length) { .type = SIDE_TYPE_VLA_U8, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
1137#define side_arg_vla_u16(_ptr, _length) { .type = SIDE_TYPE_VLA_U16, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1138#define side_arg_vla_u32(_ptr, _length) { .type = SIDE_TYPE_VLA_U32, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1139#define side_arg_vla_u64(_ptr, _length) { .type = SIDE_TYPE_VLA_U64, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1140#define side_arg_vla_s8(_ptr, _length) { .type = SIDE_TYPE_VLA_S8, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1141#define side_arg_vla_s16(_ptr, _length) { .type = SIDE_TYPE_VLA_S16, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1142#define side_arg_vla_s32(_ptr, _length) { .type = SIDE_TYPE_VLA_S32, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1143#define side_arg_vla_s64(_ptr, _length) { .type = SIDE_TYPE_VLA_S64, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1144#define side_arg_vla_byte(_ptr, _length) { .type = SIDE_TYPE_VLA_BYTE, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
1145#define side_arg_vla_pointer(_ptr, _length) { .type = SIDE_TYPE_VLA_POINTER_HOST, .u = { .side_static = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } } }
ba845af5 1146
d41cb7ee 1147/* Gather field arguments */
d69918cc 1148#define side_arg_gather_byte(_ptr) { .type = SIDE_TYPE_GATHER_BYTE, .u = { .side_static = { .side_byte_gather_ptr = (_ptr) } } }
d41cb7ee
MD
1149#define side_arg_gather_unsigned_integer(_ptr) { .type = SIDE_TYPE_GATHER_UNSIGNED_INT, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1150#define side_arg_gather_signed_integer(_ptr) { .type = SIDE_TYPE_GATHER_SIGNED_INT, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1151#define side_arg_gather_float(_ptr) { .type = SIDE_TYPE_GATHER_FLOAT, .u = { .side_static = { .side_float_gather_ptr = (_ptr) } } }
1152#define side_arg_gather_struct(_ptr) { .type = SIDE_TYPE_GATHER_STRUCT, .u = { .side_static = { .side_struct_gather_ptr = (_ptr) } } }
1153#define side_arg_gather_array(_ptr) { .type = SIDE_TYPE_GATHER_ARRAY, .u = { .side_static = { .side_array_gather_ptr = (_ptr) } } }
1154#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) } } } }
d9359cfa 1155
e24949fa
MD
1156/* Dynamic field arguments */
1157
808bd9bf
MD
1158#define side_arg_dynamic_null(_attr) \
1159 { \
66de373e 1160 .type = SIDE_TYPE_DYNAMIC_NULL, \
8d20e708 1161 .u = { \
66de373e
MD
1162 .side_dynamic = { \
1163 .side_null = { \
1164 .attr = _attr, \
1165 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1166 }, \
8d20e708
MD
1167 }, \
1168 }, \
808bd9bf
MD
1169 }
1170
1171#define side_arg_dynamic_bool(_val, _attr) \
1172 { \
66de373e 1173 .type = SIDE_TYPE_DYNAMIC_BOOL, \
808bd9bf 1174 .u = { \
66de373e
MD
1175 .side_dynamic = { \
1176 .side_bool = { \
1177 .type = { \
1178 .attr = _attr, \
1179 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1180 }, \
1181 .value = !!(_val), \
8d20e708
MD
1182 }, \
1183 }, \
808bd9bf
MD
1184 }, \
1185 }
1186
8bdd5c12 1187#define side_arg_dynamic_byte(_val, _attr) \
808bd9bf 1188 { \
66de373e 1189 .type = SIDE_TYPE_DYNAMIC_BYTE, \
808bd9bf 1190 .u = { \
66de373e
MD
1191 .side_dynamic = { \
1192 .side_byte = { \
1193 .type = { \
1194 .attr = _attr, \
1195 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1196 }, \
1197 .value = (_val), \
8d20e708
MD
1198 }, \
1199 }, \
808bd9bf
MD
1200 }, \
1201 }
8bdd5c12 1202#define side_arg_dynamic_string(_val, _attr) \
808bd9bf 1203 { \
66de373e 1204 .type = SIDE_TYPE_DYNAMIC_STRING, \
808bd9bf 1205 .u = { \
66de373e
MD
1206 .side_dynamic = { \
1207 .side_string = { \
1208 .type = { \
1209 .attr = _attr, \
1210 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1211 }, \
1212 .value = (uintptr_t) (_val), \
8d20e708
MD
1213 }, \
1214 }, \
808bd9bf
MD
1215 }, \
1216 }
1217
d2be7696 1218#define _side_arg_dynamic_integer(_field, _val, _type, _signedness, _byte_order, _integer_size_bits, _len_bits, _attr) \
808bd9bf 1219 { \
66de373e 1220 .type = _type, \
808bd9bf 1221 .u = { \
66de373e
MD
1222 .side_dynamic = { \
1223 .side_integer = { \
1224 .type = { \
1225 .attr = _attr, \
1226 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1227 .integer_size_bits = _integer_size_bits, \
1228 .len_bits = _len_bits, \
1229 .signedness = _signedness, \
1230 .byte_order = _byte_order, \
1231 }, \
1232 .value = { \
1233 _field = (_val), \
1234 }, \
8d20e708
MD
1235 }, \
1236 }, \
808bd9bf
MD
1237 }, \
1238 }
d2be7696
MD
1239
1240#define side_arg_dynamic_u8(_val, _attr) \
66de373e 1241 _side_arg_dynamic_integer(.side_u8, _val, SIDE_TYPE_DYNAMIC_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
d2be7696 1242#define side_arg_dynamic_s8(_val, _attr) \
66de373e 1243 _side_arg_dynamic_integer(.side_s8, _val, SIDE_TYPE_DYNAMIC_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, 8, 8, SIDE_PARAM(_attr))
d2be7696
MD
1244
1245#define _side_arg_dynamic_u16(_val, _byte_order, _attr) \
66de373e 1246 _side_arg_dynamic_integer(.side_u16, _val, SIDE_TYPE_DYNAMIC_U16, false, _byte_order, 16, 16, SIDE_PARAM(_attr))
d2be7696 1247#define _side_arg_dynamic_u32(_val, _byte_order, _attr) \
66de373e 1248 _side_arg_dynamic_integer(.side_u32, _val, SIDE_TYPE_DYNAMIC_U32, false, _byte_order, 32, 32, SIDE_PARAM(_attr))
8bdd5c12 1249#define _side_arg_dynamic_u64(_val, _byte_order, _attr) \
66de373e 1250 _side_arg_dynamic_integer(.side_u64, _val, SIDE_TYPE_DYNAMIC_U64, false, _byte_order, 64, 64, SIDE_PARAM(_attr))
8bdd5c12
MD
1251
1252#define _side_arg_dynamic_s16(_val, _byte_order, _attr) \
66de373e 1253 _side_arg_dynamic_integer(.side_s16, _val, SIDE_TYPE_DYNAMIC_S16, true, _byte_order, 16, 16, SIDE_PARAM(_attr))
8bdd5c12 1254#define _side_arg_dynamic_s32(_val, _byte_order, _attr) \
66de373e 1255 _side_arg_dynamic_integer(.side_s32, _val, SIDE_TYPE_DYNAMIC_S32, true, _byte_order, 32, 32, SIDE_PARAM(_attr))
8bdd5c12 1256#define _side_arg_dynamic_s64(_val, _byte_order, _attr) \
66de373e 1257 _side_arg_dynamic_integer(.side_s64, _val, SIDE_TYPE_DYNAMIC_S64, true, _byte_order, 64, 64, SIDE_PARAM(_attr))
d2be7696 1258
f5e650d7 1259#define _side_arg_dynamic_pointer(_val, _byte_order, _attr) \
66de373e 1260 _side_arg_dynamic_integer(SIDE_PTR_HOST, (uintptr_t) (_val), SIDE_TYPE_DYNAMIC_POINTER_HOST, false, _byte_order, \
d2be7696
MD
1261 SIDE_BITS_PER_LONG, SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
1262
aac52685 1263#define _side_arg_dynamic_float(_field, _val, _type, _byte_order, _float_size_bits, _attr) \
fb25b355 1264 { \
66de373e 1265 .type = _type, \
fb25b355 1266 .u = { \
66de373e
MD
1267 .side_dynamic = { \
1268 .side_float = { \
1269 .type = { \
1270 .attr = _attr, \
1271 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
66de373e 1272 .float_size_bits = _float_size_bits, \
e65f9ce5 1273 .byte_order = _byte_order, \
66de373e
MD
1274 }, \
1275 .value = { \
1276 _field = (_val), \
1277 }, \
8d20e708
MD
1278 }, \
1279 }, \
fb25b355
MD
1280 }, \
1281 }
aac52685
MD
1282
1283#define _side_arg_dynamic_float_binary16(_val, _byte_order, _attr) \
66de373e 1284 _side_arg_dynamic_float(.side_float_binary16, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY16, _byte_order, 16, SIDE_PARAM(_attr))
aac52685 1285#define _side_arg_dynamic_float_binary32(_val, _byte_order, _attr) \
66de373e 1286 _side_arg_dynamic_float(.side_float_binary32, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY32, _byte_order, 32, SIDE_PARAM(_attr))
8bdd5c12 1287#define _side_arg_dynamic_float_binary64(_val, _byte_order, _attr) \
66de373e 1288 _side_arg_dynamic_float(.side_float_binary64, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY64, _byte_order, 64, SIDE_PARAM(_attr))
8bdd5c12 1289#define _side_arg_dynamic_float_binary128(_val, _byte_order, _attr) \
66de373e 1290 _side_arg_dynamic_float(.side_float_binary128, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY128, _byte_order, 128, SIDE_PARAM(_attr))
808bd9bf 1291
8bdd5c12
MD
1292/* Host endian */
1293#define side_arg_dynamic_u16(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1294#define side_arg_dynamic_u32(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1295#define side_arg_dynamic_u64(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1296#define side_arg_dynamic_s16(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1297#define side_arg_dynamic_s32(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1298#define side_arg_dynamic_s64(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
f5e650d7 1299#define side_arg_dynamic_pointer(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
8bdd5c12
MD
1300#define side_arg_dynamic_float_binary16(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1301#define side_arg_dynamic_float_binary32(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1302#define side_arg_dynamic_float_binary64(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1303#define side_arg_dynamic_float_binary128(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1304
1305/* Little endian */
1306#define side_arg_dynamic_u16_le(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1307#define side_arg_dynamic_u32_le(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1308#define side_arg_dynamic_u64_le(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1309#define side_arg_dynamic_s16_le(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1310#define side_arg_dynamic_s32_le(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1311#define side_arg_dynamic_s64_le(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
f5e650d7 1312#define side_arg_dynamic_pointer_le(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
8bdd5c12
MD
1313#define side_arg_dynamic_float_binary16_le(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1314#define side_arg_dynamic_float_binary32_le(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1315#define side_arg_dynamic_float_binary64_le(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1316#define side_arg_dynamic_float_binary128_le(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1317
1318/* Big endian */
1319#define side_arg_dynamic_u16_be(_val, _attr) _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1320#define side_arg_dynamic_u32_be(_val, _attr) _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1321#define side_arg_dynamic_u64_be(_val, _attr) _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1322#define side_arg_dynamic_s16_be(_val, _attr) _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1323#define side_arg_dynamic_s32_be(_val, _attr) _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1324#define side_arg_dynamic_s64_be(_val, _attr) _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
f5e650d7 1325#define side_arg_dynamic_pointer_be(_val, _attr) _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
8bdd5c12
MD
1326#define side_arg_dynamic_float_binary16_be(_val, _attr) _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1327#define side_arg_dynamic_float_binary32_be(_val, _attr) _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1328#define side_arg_dynamic_float_binary64_be(_val, _attr) _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1329#define side_arg_dynamic_float_binary128_be(_val, _attr) _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1330
8d20e708 1331#define side_arg_dynamic_vla(_vla) \
808bd9bf 1332 { \
66de373e 1333 .type = SIDE_TYPE_DYNAMIC_VLA, \
808bd9bf 1334 .u = { \
66de373e
MD
1335 .side_dynamic = { \
1336 .side_dynamic_vla = (_vla), \
1337 }, \
808bd9bf
MD
1338 }, \
1339 }
1340
1341#define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
bdc39c09 1342 { \
66de373e 1343 .type = SIDE_TYPE_DYNAMIC_VLA_VISITOR, \
bdc39c09 1344 .u = { \
66de373e
MD
1345 .side_dynamic = { \
1346 .side_dynamic_vla_visitor = { \
1347 .app_ctx = _ctx, \
1348 .visitor = _dynamic_vla_visitor, \
1349 .attr = _attr, \
1350 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1351 }, \
8ceca0cd 1352 }, \
bdc39c09
MD
1353 }, \
1354 }
1355
8d20e708 1356#define side_arg_dynamic_struct(_struct) \
808bd9bf 1357 { \
66de373e 1358 .type = SIDE_TYPE_DYNAMIC_STRUCT, \
808bd9bf 1359 .u = { \
66de373e
MD
1360 .side_dynamic = { \
1361 .side_dynamic_struct = (_struct), \
1362 }, \
808bd9bf
MD
1363 }, \
1364 }
1365
1366#define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
bdc39c09 1367 { \
66de373e 1368 .type = SIDE_TYPE_DYNAMIC_STRUCT_VISITOR, \
bdc39c09 1369 .u = { \
66de373e
MD
1370 .side_dynamic = { \
1371 .side_dynamic_struct_visitor = { \
1372 .app_ctx = _ctx, \
1373 .visitor = _dynamic_struct_visitor, \
1374 .attr = _attr, \
1375 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1376 }, \
8ceca0cd 1377 }, \
bdc39c09
MD
1378 }, \
1379 }
1380
8d20e708 1381#define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
66de373e
MD
1382 const struct side_arg _identifier##_vec[] = { _sav }; \
1383 const struct side_arg_dynamic_vla _identifier = { \
a2e2357e 1384 .sav = _identifier##_vec, \
8d20e708 1385 .attr = _attr, \
a2e2357e 1386 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
8d20e708 1387 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
a2e2357e
MD
1388 }
1389
8d20e708 1390#define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
0c7abe2b
MD
1391 const struct side_arg_dynamic_field _identifier##_fields[] = { _struct_fields }; \
1392 const struct side_arg_dynamic_struct _identifier = { \
465e5e7e 1393 .fields = _identifier##_fields, \
8d20e708 1394 .attr = _attr, \
465e5e7e 1395 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
8d20e708 1396 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
465e5e7e
MD
1397 }
1398
f611d0c3 1399#define side_arg_define_vec(_identifier, _sav) \
66de373e
MD
1400 const struct side_arg _identifier##_vec[] = { _sav }; \
1401 const struct side_arg_vec _identifier = { \
f611d0c3
MD
1402 .sav = _identifier##_vec, \
1403 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1404 }
a2e2357e 1405
465e5e7e
MD
1406#define side_arg_dynamic_field(_name, _elem) \
1407 { \
1408 .field_name = _name, \
1409 .elem = _elem, \
1410 }
1411
f611d0c3
MD
1412#define side_arg_list(...) __VA_ARGS__
1413
d4328528 1414#define side_define_enum(_identifier, _mappings, _attr) \
79f677ba
MD
1415 const struct side_enum_mappings _identifier = { \
1416 .mappings = _mappings, \
d4328528 1417 .attr = _attr, \
79f677ba 1418 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
d4328528 1419 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
79f677ba
MD
1420 }
1421
66cff328 1422#define side_enum_mapping_list(...) \
79f677ba
MD
1423 SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
1424
1425#define side_enum_mapping_range(_label, _begin, _end) \
1426 { \
1427 .range_begin = _begin, \
1428 .range_end = _end, \
1429 .label = _label, \
1430 }
1431
1432#define side_enum_mapping_value(_label, _value) \
1433 { \
1434 .range_begin = _value, \
1435 .range_end = _value, \
1436 .label = _label, \
1437 }
1438
d4328528 1439#define side_define_enum_bitmap(_identifier, _mappings, _attr) \
66cff328
MD
1440 const struct side_enum_bitmap_mappings _identifier = { \
1441 .mappings = _mappings, \
d4328528 1442 .attr = _attr, \
66cff328 1443 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
d4328528 1444 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
66cff328
MD
1445 }
1446
1447#define side_enum_bitmap_mapping_list(...) \
1448 SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
1449
1450#define side_enum_bitmap_mapping_range(_label, _begin, _end) \
1451 { \
1452 .range_begin = _begin, \
1453 .range_end = _end, \
1454 .label = _label, \
1455 }
1456
1457#define side_enum_bitmap_mapping_value(_label, _value) \
1458 { \
1459 .range_begin = _value, \
1460 .range_end = _value, \
1461 .label = _label, \
1462 }
1463
f85b7f8b
MD
1464#define side_event_cond(_identifier) \
1465 if (side_unlikely(__atomic_load_n(&side_event_enable__##_identifier, \
1466 __ATOMIC_RELAXED)))
e24949fa 1467
89747802 1468#define side_event_call(_identifier, _sav) \
e24949fa 1469 { \
66de373e 1470 const struct side_arg side_sav[] = { _sav }; \
9a6ca773 1471 const struct side_arg_vec side_arg_vec = { \
e24949fa
MD
1472 .sav = side_sav, \
1473 .len = SIDE_ARRAY_SIZE(side_sav), \
1474 }; \
9a6ca773 1475 side_call(&(_identifier), &side_arg_vec); \
e24949fa
MD
1476 }
1477
89747802
MD
1478#define side_event(_identifier, _sav) \
1479 side_event_cond(_identifier) \
1480 side_event_call(_identifier, SIDE_PARAM(_sav))
e24949fa 1481
89747802 1482#define side_event_call_variadic(_identifier, _sav, _var_fields, _attr) \
e24949fa 1483 { \
66de373e 1484 const struct side_arg side_sav[] = { _sav }; \
9a6ca773 1485 const struct side_arg_vec side_arg_vec = { \
e24949fa
MD
1486 .sav = side_sav, \
1487 .len = SIDE_ARRAY_SIZE(side_sav), \
1488 }; \
0c7abe2b
MD
1489 const struct side_arg_dynamic_field side_fields[] = { _var_fields }; \
1490 const struct side_arg_dynamic_struct var_struct = { \
e24949fa
MD
1491 .fields = side_fields, \
1492 .attr = _attr, \
1493 .len = SIDE_ARRAY_SIZE(side_fields), \
1494 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1495 }; \
9a6ca773 1496 side_call_variadic(&(_identifier), &side_arg_vec, &var_struct); \
e24949fa
MD
1497 }
1498
89747802
MD
1499#define side_event_variadic(_identifier, _sav, _var, _attr) \
1500 side_event_cond(_identifier) \
1501 side_event_call_variadic(_identifier, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
e24949fa 1502
89747802 1503#define _side_define_event(_linkage, _identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
83a72806 1504 _linkage uintptr_t side_event_enable__##_identifier __attribute__((section("side_event_enable"))); \
89747802
MD
1505 _linkage struct side_event_description __attribute__((section("side_event_description"))) \
1506 _identifier = { \
89747802 1507 .enabled = &(side_event_enable__##_identifier), \
f611d0c3
MD
1508 .provider_name = _provider, \
1509 .event_name = _event, \
1510 .fields = _fields, \
65010f43 1511 .attr = _attr, \
054b7b5c 1512 .callbacks = &side_empty_callback, \
352df610
MD
1513 .flags = (_flags), \
1514 .version = 0, \
1515 .loglevel = _loglevel, \
1516 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1517 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1518 .nr_callbacks = 0, \
b5b67ff2 1519 }; \
89747802
MD
1520 static const struct side_event_description *side_event_ptr__##_identifier \
1521 __attribute__((section("side_event_description_ptr"), used)) = &(_identifier);
1522
1523#define side_static_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1524 _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1525 SIDE_PARAM(_attr), 0)
1526
1527#define side_static_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1528 _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1529 SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1530
1531#define side_hidden_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
9a0c0952
MD
1532 _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, \
1533 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), 0)
89747802
MD
1534
1535#define side_hidden_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
9a0c0952
MD
1536 _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, \
1537 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
f611d0c3 1538
89747802 1539#define side_export_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
9a0c0952
MD
1540 _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, \
1541 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), 0)
8a25ce77 1542
89747802 1543#define side_export_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
9a0c0952
MD
1544 _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, \
1545 _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
8a25ce77 1546
f611d0c3 1547#define side_declare_event(_identifier) \
83a72806 1548 extern uintptr_t side_event_enable_##_identifier; \
89747802 1549 extern struct side_event_description _identifier
f611d0c3 1550
a3f36db7
MD
1551extern const struct side_callback side_empty_callback;
1552
6841ae81 1553void side_call(const struct side_event_description *desc,
9a6ca773 1554 const struct side_arg_vec *side_arg_vec);
6841ae81 1555void side_call_variadic(const struct side_event_description *desc,
9a6ca773 1556 const struct side_arg_vec *side_arg_vec,
0c7abe2b 1557 const struct side_arg_dynamic_struct *var_struct);
6841ae81 1558
8bd36d3b 1559typedef void (*side_tracer_callback_func)(const struct side_event_description *desc,
9a6ca773 1560 const struct side_arg_vec *side_arg_vec,
8bd36d3b
MD
1561 void *priv);
1562typedef void (*side_tracer_callback_variadic_func)(const struct side_event_description *desc,
9a6ca773 1563 const struct side_arg_vec *side_arg_vec,
0c7abe2b 1564 const struct side_arg_dynamic_struct *var_struct,
8bd36d3b
MD
1565 void *priv);
1566
1567int side_tracer_callback_register(struct side_event_description *desc,
1568 side_tracer_callback_func call,
1569 void *priv);
1570int side_tracer_callback_variadic_register(struct side_event_description *desc,
1571 side_tracer_callback_variadic_func call_variadic,
a3f36db7
MD
1572 void *priv);
1573int side_tracer_callback_unregister(struct side_event_description *desc,
8bd36d3b 1574 side_tracer_callback_func call,
a3f36db7
MD
1575 void *priv);
1576int side_tracer_callback_variadic_unregister(struct side_event_description *desc,
8bd36d3b 1577 side_tracer_callback_variadic_func call_variadic,
a3f36db7 1578 void *priv);
054b7b5c 1579
9a0c0952
MD
1580struct side_events_register_handle *side_events_register(struct side_event_description **events,
1581 uint32_t nr_events);
6e46f5e6
MD
1582void side_events_unregister(struct side_events_register_handle *handle);
1583
a13c9d2e
MD
1584enum side_tracer_notification {
1585 SIDE_TRACER_NOTIFICATION_INSERT_EVENTS,
1586 SIDE_TRACER_NOTIFICATION_REMOVE_EVENTS,
1587};
1588
1589/* Callback is invoked with side library internal lock held. */
1590struct side_tracer_handle *side_tracer_event_notification_register(
1591 void (*cb)(enum side_tracer_notification notif,
1592 struct side_event_description **events, uint32_t nr_events, void *priv),
1593 void *priv);
1594void side_tracer_event_notification_unregister(struct side_tracer_handle *handle);
1595
6e46f5e6
MD
1596void side_init(void);
1597void side_exit(void);
1598
314c22c3
MD
1599/*
1600 * These weak symbols, the constructor, and destructor take care of
1601 * registering only _one_ instance of the side instrumentation per
1602 * shared-ojbect (or for the whole main program).
1603 */
1604extern struct side_event_description * __start_side_event_description_ptr[]
1605 __attribute__((weak, visibility("hidden")));
1606extern struct side_event_description * __stop_side_event_description_ptr[]
1607 __attribute__((weak, visibility("hidden")));
1608int side_event_description_ptr_registered
1609 __attribute__((weak, visibility("hidden")));
1610struct side_events_register_handle *side_events_handle
1611 __attribute__((weak, visibility("hidden")));
1612
1613static void
1614side_event_description_ptr_init(void)
1615 __attribute__((no_instrument_function))
1616 __attribute__((constructor));
1617static void
1618side_event_description_ptr_init(void)
1619{
1620 if (side_event_description_ptr_registered++)
1621 return;
1622 side_events_handle = side_events_register(__start_side_event_description_ptr,
1623 __stop_side_event_description_ptr - __start_side_event_description_ptr);
1624}
1625
1626static void
1627side_event_description_ptr_exit(void)
1628 __attribute__((no_instrument_function))
1629 __attribute__((destructor));
1630static void
1631side_event_description_ptr_exit(void)
1632{
1633 if (--side_event_description_ptr_registered)
1634 return;
1635 side_events_unregister(side_events_handle);
1636 side_events_handle = NULL;
1637}
1638
f611d0c3 1639#endif /* _SIDE_TRACE_H */
This page took 0.187488 seconds and 4 git commands to generate.