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