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