include/side/trace.h

   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>
  13 #include <math.h>
  14 #include <side/macros.h>
  15 #include <side/endian.h>
  16
  17 /* SIDE stands for "Static Instrumentation Dynamically Enabled" */
  18
  19 //TODO: as those structures will be ABI, we need to either consider them
  20 //fixed forever, or think of a scheme that would allow their binary
  21 //representation to be extended if need be.
  22
  23 struct side_arg_vec;
  24 struct side_arg_vec_description;
  25 struct side_arg_dynamic_vec;
  26 struct side_arg_dynamic_vec_vla;
  27 struct side_type_description;
  28 struct side_event_field;
  29 struct side_event_field_sg;
  30 struct side_tracer_visitor_ctx;
  31 struct side_tracer_dynamic_struct_visitor_ctx;
  32 struct side_tracer_dynamic_vla_visitor_ctx;
  33 struct side_event_description;
  34 struct side_arg_dynamic_event_struct;
  35 struct side_events_register_handle;
  36
  37 enum side_type {
  38         /* Basic types */
  39         SIDE_TYPE_BOOL,
  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,
  48         SIDE_TYPE_BYTE,
  49         SIDE_TYPE_POINTER32,
  50         SIDE_TYPE_POINTER64,
  51         SIDE_TYPE_FLOAT_BINARY16,
  52         SIDE_TYPE_FLOAT_BINARY32,
  53         SIDE_TYPE_FLOAT_BINARY64,
  54         SIDE_TYPE_FLOAT_BINARY128,
  55         SIDE_TYPE_STRING,
  56
  57         /* Compound types */
  58         SIDE_TYPE_STRUCT,
  59         SIDE_TYPE_STRUCT_SG,
  60         SIDE_TYPE_ARRAY,
  61         SIDE_TYPE_VLA,
  62         SIDE_TYPE_VLA_VISITOR,
  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,
  72         SIDE_TYPE_ARRAY_BYTE,
  73         SIDE_TYPE_ARRAY_POINTER32,
  74         SIDE_TYPE_ARRAY_POINTER64,
  75
  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,
  84         SIDE_TYPE_VLA_BYTE,
  85         SIDE_TYPE_VLA_POINTER32,
  86         SIDE_TYPE_VLA_POINTER64,
  87
  88         /* Enumeration types */
  89         SIDE_TYPE_ENUM,
  90         SIDE_TYPE_ENUM_BITMAP,
  91
  92         /* Dynamic type */
  93         SIDE_TYPE_DYNAMIC,
  94 };
  95
  96 enum side_dynamic_type {
  97         /* Basic types */
  98         SIDE_DYNAMIC_TYPE_NULL,
  99         SIDE_DYNAMIC_TYPE_BOOL,
 100         SIDE_DYNAMIC_TYPE_U8,
 101         SIDE_DYNAMIC_TYPE_U16,
 102         SIDE_DYNAMIC_TYPE_U32,
 103         SIDE_DYNAMIC_TYPE_U64,
 104         SIDE_DYNAMIC_TYPE_S8,
 105         SIDE_DYNAMIC_TYPE_S16,
 106         SIDE_DYNAMIC_TYPE_S32,
 107         SIDE_DYNAMIC_TYPE_S64,
 108         SIDE_DYNAMIC_TYPE_BYTE,
 109         SIDE_DYNAMIC_TYPE_POINTER32,
 110         SIDE_DYNAMIC_TYPE_POINTER64,
 111         SIDE_DYNAMIC_TYPE_FLOAT_BINARY16,
 112         SIDE_DYNAMIC_TYPE_FLOAT_BINARY32,
 113         SIDE_DYNAMIC_TYPE_FLOAT_BINARY64,
 114         SIDE_DYNAMIC_TYPE_FLOAT_BINARY128,
 115         SIDE_DYNAMIC_TYPE_STRING,
 116
 117         /* Compound types */
 118         SIDE_DYNAMIC_TYPE_STRUCT,
 119         SIDE_DYNAMIC_TYPE_STRUCT_VISITOR,
 120         SIDE_DYNAMIC_TYPE_VLA,
 121         SIDE_DYNAMIC_TYPE_VLA_VISITOR,
 122 };
 123
 124 enum side_attr_type {
 125         SIDE_ATTR_TYPE_NULL,
 126         SIDE_ATTR_TYPE_BOOL,
 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,
 135         SIDE_ATTR_TYPE_POINTER32,
 136         SIDE_ATTR_TYPE_POINTER64,
 137         SIDE_ATTR_TYPE_FLOAT_BINARY16,
 138         SIDE_ATTR_TYPE_FLOAT_BINARY32,
 139         SIDE_ATTR_TYPE_FLOAT_BINARY64,
 140         SIDE_ATTR_TYPE_FLOAT_BINARY128,
 141         SIDE_ATTR_TYPE_STRING,
 142 };
 143
 144 enum side_type_sg {
 145         SIDE_TYPE_SG_UNSIGNED_INT,
 146         SIDE_TYPE_SG_SIGNED_INT,
 147 };
 148
 149 enum 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
 160 enum side_visitor_status {
 161         SIDE_VISITOR_STATUS_OK = 0,
 162         SIDE_VISITOR_STATUS_ERROR = -1,
 163 };
 164
 165 enum 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,
 171         SIDE_ERROR_EXITING = 5,
 172 };
 173
 174 enum 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
 191 typedef enum side_visitor_status (*side_visitor)(
 192                 const struct side_tracer_visitor_ctx *tracer_ctx,
 193                 void *app_ctx);
 194 typedef enum side_visitor_status (*side_dynamic_struct_visitor)(
 195                 const struct side_tracer_dynamic_struct_visitor_ctx *tracer_ctx,
 196                 void *app_ctx);
 197 typedef enum side_visitor_status (*side_dynamic_vla_visitor)(
 198                 const struct side_tracer_dynamic_vla_visitor_ctx *tracer_ctx,
 199                 void *app_ctx);
 200
 201 union 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
 212 union side_float_value {
 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
 225 };
 226
 227 struct side_attr_value {
 228         uint32_t type;  /* enum side_attr_type */
 229         union {
 230                 union side_integer_value integer_value;
 231                 union side_float_value float_value;
 232                 uint8_t side_bool;
 233                 uint64_t string;        /* const char * */
 234         } u;
 235 };
 236
 237 /* User attributes. */
 238 struct side_attr {
 239         const char *key;
 240         const struct side_attr_value value;
 241 };
 242
 243 struct side_enum_mapping {
 244         int64_t range_begin;
 245         int64_t range_end;
 246         const char *label;
 247 };
 248
 249 struct side_enum_mappings {
 250         const struct side_enum_mapping *mappings;
 251         const struct side_attr *attr;
 252         uint32_t nr_mappings;
 253         uint32_t nr_attr;
 254 };
 255
 256 struct side_enum_bitmap_mapping {
 257         uint64_t range_begin;
 258         uint64_t range_end;
 259         const char *label;
 260 };
 261
 262 struct side_enum_bitmap_mappings {
 263         const struct side_enum_bitmap_mapping *mappings;
 264         const struct side_attr *attr;
 265         uint32_t nr_mappings;
 266         uint32_t nr_attr;
 267 };
 268
 269 struct 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
 276 struct 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
 292 struct side_struct_field_sg {
 293         const char *field_name;
 294         struct side_type_sg_description side_type;
 295 };
 296
 297 /* Structure fields scatter-gather. */
 298 struct 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
 305 struct side_type_integer {
 306         const struct side_attr *attr;
 307         uint32_t nr_attr;
 308         uint16_t integer_size_bits;     /* bits */
 309         uint16_t len_bits;              /* bits */
 310         uint8_t signedness;             /* true/false */
 311         uint8_t byte_order;             /* enum side_type_byte_order */
 312 };
 313
 314 struct 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         uint16_t float_size_bits;       /* bits */
 319 };
 320
 321 struct side_type_description {
 322         uint32_t type;  /* enum side_type */
 323         union {
 324                 /* Basic types */
 325                 struct {
 326                         const struct side_attr *attr;
 327                         uint32_t nr_attr;
 328                         uint32_t byte_order;            /* enum side_type_byte_order */
 329                 } side_basic;
 330
 331                 struct side_type_integer side_integer;
 332                 struct side_type_float side_float;
 333
 334                 /* Compound types */
 335                 struct {
 336                         const struct side_type_description *elem_type;
 337                         const struct side_attr *attr;
 338                         uint32_t length;
 339                         uint32_t nr_attr;
 340                 } side_array;
 341                 struct {
 342                         const struct side_type_description *elem_type;
 343                         const struct side_attr *attr;
 344                         uint32_t nr_attr;
 345                 } side_vla;
 346                 struct {
 347                         const struct side_type_description *elem_type;
 348                         side_visitor visitor;
 349                         const struct side_attr *attr;
 350                         uint32_t nr_attr;
 351                 } side_vla_visitor;
 352                 const struct side_type_struct *side_struct;
 353                 const struct side_type_struct_sg *side_struct_sg;
 354
 355                 /* Enumeration types */
 356                 struct {
 357                         const struct side_enum_mappings *mappings;
 358                         const struct side_type_description *elem_type;
 359                 } side_enum;
 360                 struct {
 361                         const struct side_enum_bitmap_mappings *mappings;
 362                         const struct side_type_description *elem_type;
 363                 } side_enum_bitmap;
 364         } u;
 365 };
 366
 367 struct side_event_field {
 368         const char *field_name;
 369         struct side_type_description side_type;
 370 };
 371
 372 enum side_event_flags {
 373         SIDE_EVENT_FLAG_VARIADIC = (1 << 0),
 374 };
 375
 376 struct 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
 389 struct side_event_description {
 390         uintptr_t *enabled;
 391         const char *provider_name;
 392         const char *event_name;
 393         const struct side_event_field *fields;
 394         const struct side_attr *attr;
 395         const struct side_callback *callbacks;
 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;
 402 };
 403
 404 struct side_arg_dynamic_vec {
 405         uint32_t dynamic_type;  /* enum side_dynamic_type */
 406         union {
 407                 /* Basic types */
 408                 struct {
 409                         const struct side_attr *attr;
 410                         uint32_t nr_attr;
 411                         uint32_t byte_order;    /* enum side_type_byte_order */
 412                         union {
 413                                 union side_integer_value integer_value;
 414                                 union side_float_value float_value;
 415                                 uint8_t side_bool;
 416                                 uint8_t side_byte;
 417                                 uint64_t string;        /* const char * */
 418                         } u;
 419                 } side_basic;
 420
 421                 /* Compound types */
 422                 const struct side_arg_dynamic_event_struct *side_dynamic_struct;
 423                 struct {
 424                         void *app_ctx;
 425                         side_dynamic_struct_visitor visitor;
 426                         const struct side_attr *attr;
 427                         uint32_t nr_attr;
 428                 } side_dynamic_struct_visitor;
 429                 const struct side_arg_dynamic_vec_vla *side_dynamic_vla;
 430                 struct {
 431                         void *app_ctx;
 432                         side_dynamic_vla_visitor visitor;
 433                         const struct side_attr *attr;
 434                         uint32_t nr_attr;
 435                 } side_dynamic_vla_visitor;
 436         } u;
 437 };
 438
 439 struct 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
 446 struct side_arg_dynamic_event_field {
 447         const char *field_name;
 448         const struct side_arg_dynamic_vec elem;
 449 };
 450
 451 struct side_arg_dynamic_event_struct {
 452         const struct side_arg_dynamic_event_field *fields;
 453         const struct side_attr *attr;
 454         uint32_t len;
 455         uint32_t nr_attr;
 456 };
 457
 458 struct side_arg_vec {
 459         enum side_type type;
 460         union {
 461                 /* Integer types */
 462                 union side_integer_value integer_value;
 463
 464                 /* Basic types */
 465                 union side_float_value float_value;
 466                 uint8_t side_bool;
 467                 uint8_t side_byte;
 468                 uint64_t string;        /* const char * */
 469
 470                 /* Compound types */
 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;
 474                 void *side_vla_app_visitor_ctx;
 475                 void *side_array_fixint;
 476                 struct {
 477                         void *p;
 478                         uint32_t length;
 479                 } side_vla_fixint;
 480                 void *side_struct_sg_ptr;
 481
 482                 /* Dynamic type */
 483                 struct side_arg_dynamic_vec dynamic;
 484         } u;
 485 };
 486
 487 struct side_arg_vec_description {
 488         const struct side_arg_vec *sav;
 489         uint32_t len;
 490 };
 491
 492 /* The visitor pattern is a double-dispatch visitor. */
 493 struct side_tracer_visitor_ctx {
 494         enum side_visitor_status (*write_elem)(
 495                         const struct side_tracer_visitor_ctx *tracer_ctx,
 496                         const struct side_arg_vec *elem);
 497         void *priv;             /* Private tracer context. */
 498 };
 499
 500 struct side_tracer_dynamic_struct_visitor_ctx {
 501         enum side_visitor_status (*write_field)(
 502                         const struct side_tracer_dynamic_struct_visitor_ctx *tracer_ctx,
 503                         const struct side_arg_dynamic_event_field *dynamic_field);
 504         void *priv;             /* Private tracer context. */
 505 };
 506
 507 struct side_tracer_dynamic_vla_visitor_ctx {
 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);
 511         void *priv;             /* Private tracer context. */
 512 };
 513
 514 /* Event and type attributes */
 515
 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
 522 # define SIDE_PTR_HOST                  .side_u64
 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
 529 # define SIDE_PTR_HOST                  .side_u32
 530 #endif
 531
 532 #define side_attr(_key, _value) \
 533         { \
 534                 .key = _key, \
 535                 .value = SIDE_PARAM(_value), \
 536         }
 537
 538 #define side_attr_list(...) \
 539         SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
 540
 541 #define side_attr_null(_val)            { .type = SIDE_ATTR_TYPE_NULL }
 542 #define side_attr_bool(_val)            { .type = SIDE_ATTR_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
 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) } } }
 551 #define side_attr_pointer(_val)         { .type = SIDE_ATTR_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
 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) } } }
 556 #define side_attr_string(_val)          { .type = SIDE_ATTR_TYPE_STRING, .u = { .string = (uintptr_t) (_val) } }
 557
 558 /* Static field definition */
 559
 560 #define _side_type_basic(_type, _byte_order, _attr) \
 561         { \
 562                 .type = _type, \
 563                 .u = { \
 564                         .side_basic = { \
 565                                 .attr = _attr, \
 566                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 567                                 .byte_order = _byte_order, \
 568                         }, \
 569                 }, \
 570         }
 571
 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                                 .integer_size_bits = _integer_size_bits, \
 580                                 .len_bits = _len_bits, \
 581                                 .signedness = _signedness, \
 582                                 .byte_order = _byte_order, \
 583                         }, \
 584                 }, \
 585         }
 586
 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
 600 #define _side_field(_name, _type) \
 601         { \
 602                 .field_name = _name, \
 603                 .side_type = _type, \
 604         }
 605
 606 /* Host endian */
 607 #define side_type_bool(_attr)                           _side_type_basic(SIDE_TYPE_BOOL, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
 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))
 616 #define side_type_byte(_attr)                           _side_type_basic(SIDE_TYPE_BYTE, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
 617 #define side_type_pointer(_attr)                        _side_type_basic(SIDE_TYPE_POINTER_HOST, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
 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))
 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
 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)))
 634 #define side_field_byte(_name, _attr)                   _side_field(_name, side_type_byte(SIDE_PARAM(_attr)))
 635 #define side_field_pointer(_name, _attr)                _side_field(_name, side_type_pointer(SIDE_PARAM(_attr)))
 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)))
 642
 643 /* Little endian */
 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))
 650 #define side_type_pointer_le(_attr)                     _side_type_basic(SIDE_TYPE_POINTER_HOST, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
 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))
 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)))
 662 #define side_field_pointer_le(_name, _attr)             _side_field(_name, side_type_pointer_le(SIDE_PARAM(_attr)))
 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 */
 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))
 675 #define side_type_pointer_be(_attr)                     _side_type_basic(SIDE_TYPE_POINTER_HOST, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
 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))
 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)))
 687 #define side_field_pointer_be(_name, _attr)             _side_field(_name, side_type_pointer_be(SIDE_PARAM(_attr)))
 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
 693 #define side_type_enum(_mappings, _elem_type) \
 694         { \
 695                 .type = SIDE_TYPE_ENUM, \
 696                 .u = { \
 697                         .side_enum = { \
 698                                 .mappings = _mappings, \
 699                                 .elem_type = _elem_type, \
 700                         }, \
 701                 }, \
 702         }
 703 #define side_field_enum(_name, _mappings, _elem_type) \
 704         _side_field(_name, side_type_enum(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
 705
 706 #define side_type_enum_bitmap(_mappings, _elem_type) \
 707         { \
 708                 .type = SIDE_TYPE_ENUM_BITMAP, \
 709                 .u = { \
 710                         .side_enum_bitmap = { \
 711                                 .mappings = _mappings, \
 712                                 .elem_type = _elem_type, \
 713                         }, \
 714                 }, \
 715         }
 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)))
 718
 719 #define side_type_struct(_struct) \
 720         { \
 721                 .type = SIDE_TYPE_STRUCT, \
 722                 .u = { \
 723                         .side_struct = _struct, \
 724                 }, \
 725         }
 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)))
 743
 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
 805 #define side_type_array(_elem_type, _length, _attr) \
 806         { \
 807                 .type = SIDE_TYPE_ARRAY, \
 808                 .u = { \
 809                         .side_array = { \
 810                                 .elem_type = _elem_type, \
 811                                 .attr = _attr, \
 812                                 .length = _length, \
 813                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 814                         }, \
 815                 }, \
 816         }
 817 #define side_field_array(_name, _elem_type, _length, _attr) \
 818         _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
 819
 820 #define side_type_vla(_elem_type, _attr) \
 821         { \
 822                 .type = SIDE_TYPE_VLA, \
 823                 .u = { \
 824                         .side_vla = { \
 825                                 .elem_type = _elem_type, \
 826                                 .attr = _attr, \
 827                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 828                         }, \
 829                 }, \
 830         }
 831 #define side_field_vla(_name, _elem_type, _attr) \
 832         _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
 833
 834 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
 835         { \
 836                 .type = SIDE_TYPE_VLA_VISITOR, \
 837                 .u = { \
 838                         .side_vla_visitor = { \
 839                                 .elem_type = SIDE_PARAM(_elem_type), \
 840                                 .visitor = _visitor, \
 841                                 .attr = _attr, \
 842                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 843                         }, \
 844                 }, \
 845         }
 846 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
 847         _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
 848
 849 #define side_elem(...) \
 850         SIDE_COMPOUND_LITERAL(const struct side_type_description, __VA_ARGS__)
 851
 852 #define side_field_list(...) \
 853         SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
 854
 855 #define side_field_sg_list(...) \
 856         SIDE_COMPOUND_LITERAL(const struct side_struct_field_sg, __VA_ARGS__)
 857
 858 /* Static field arguments */
 859
 860 #define side_arg_bool(_val)             { .type = SIDE_TYPE_BOOL, .u = { .side_bool = !!(_val) } }
 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) } } }
 869 #define side_arg_byte(_val)             { .type = SIDE_TYPE_BYTE, .u = { .side_byte = (_val) } }
 870 #define side_arg_pointer(_val)          { .type = SIDE_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
 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) } } }
 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) } }
 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) } } }
 881
 882 #define side_arg_string(_val)           { .type = SIDE_TYPE_STRING, .u = { .string = (uintptr_t) (_val) } }
 883 #define side_arg_struct(_side_type)     { .type = SIDE_TYPE_STRUCT, .u = { .side_struct = (_side_type) } }
 884 #define side_arg_struct_sg(_ptr)        { .type = SIDE_TYPE_STRUCT_SG, .u = { .side_struct_sg_ptr = (_ptr) } }
 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) } }
 887 #define side_arg_vla_visitor(_ctx)      { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_vla_app_visitor_ctx = (_ctx) } }
 888
 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) } }
 897 #define side_arg_array_byte(_ptr)       { .type = SIDE_TYPE_ARRAY_BYTE, .u = { .side_array_fixint = (_ptr) } }
 898 #define side_arg_array_pointer(_ptr)    { .type = SIDE_TYPE_ARRAY_POINTER_HOST, .u = { .side_array_fixint = (_ptr) } }
 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) } } }
 908 #define side_arg_vla_byte(_ptr, _length) { .type = SIDE_TYPE_VLA_BYTE, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
 909 #define side_arg_vla_pointer(_ptr, _length) { .type = SIDE_TYPE_VLA_POINTER_HOST, .u = { .side_vla_fixint = { .p = (_ptr), .length = (_length) } } }
 910
 911 #define side_arg_dynamic(_dynamic_arg_type) \
 912         { \
 913                 .type = SIDE_TYPE_DYNAMIC, \
 914                 .u = { \
 915                         .dynamic = _dynamic_arg_type, \
 916                 }, \
 917         }
 918
 919 /* Dynamic field arguments */
 920
 921 #define side_arg_dynamic_null(_attr) \
 922         { \
 923                 .dynamic_type = SIDE_DYNAMIC_TYPE_NULL, \
 924                 .u = { \
 925                         .side_basic = { \
 926                                 .attr = _attr, \
 927                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 928                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 929                         }, \
 930                 }, \
 931         }
 932
 933 #define side_arg_dynamic_bool(_val, _attr) \
 934         { \
 935                 .dynamic_type = SIDE_DYNAMIC_TYPE_BOOL, \
 936                 .u = { \
 937                         .side_basic = { \
 938                                 .attr = _attr, \
 939                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 940                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 941                                 .u = { \
 942                                         .side_bool = !!(_val), \
 943                                 }, \
 944                         }, \
 945                 }, \
 946         }
 947
 948 #define side_arg_dynamic_u8(_val, _attr) \
 949         { \
 950                 .dynamic_type = SIDE_DYNAMIC_TYPE_U8, \
 951                 .u = { \
 952                         .side_basic = { \
 953                                 .attr = _attr, \
 954                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 955                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 956                                 .u = { \
 957                                         .integer_value.side_u8 = (_val), \
 958                                 }, \
 959                         }, \
 960                 }, \
 961         }
 962 #define side_arg_dynamic_s8(_val, _attr) \
 963         { \
 964                 .dynamic_type = SIDE_DYNAMIC_TYPE_S8, \
 965                 .u = { \
 966                         .side_basic = { \
 967                                 .attr = _attr, \
 968                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 969                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 970                                 .u = { \
 971                                         .integer_value.side_s8 = (_val), \
 972                                 }, \
 973                         }, \
 974                 }, \
 975         }
 976 #define side_arg_dynamic_byte(_val, _attr) \
 977         { \
 978                 .dynamic_type = SIDE_DYNAMIC_TYPE_BYTE, \
 979                 .u = { \
 980                         .side_basic = { \
 981                                 .attr = _attr, \
 982                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 983                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 984                                 .u = { \
 985                                         .side_byte = (_val), \
 986                                 }, \
 987                         }, \
 988                 }, \
 989         }
 990 #define side_arg_dynamic_string(_val, _attr) \
 991         { \
 992                 .dynamic_type = SIDE_DYNAMIC_TYPE_STRING, \
 993                 .u = { \
 994                         .side_basic = { \
 995                                 .attr = _attr, \
 996                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 997                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 998                                 .u = { \
 999                                         .string = (uintptr_t) (_val), \
1000                                 }, \
1001                         }, \
1002                 }, \
1003         }
1004
1005 #define _side_arg_dynamic_u16(_val, _byte_order, _attr) \
1006         { \
1007                 .dynamic_type = SIDE_DYNAMIC_TYPE_U16, \
1008                 .u = { \
1009                         .side_basic = { \
1010                                 .attr = _attr, \
1011                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1012                                 .byte_order = _byte_order, \
1013                                 .u = { \
1014                                         .integer_value.side_u16 = (_val), \
1015                                 }, \
1016                         }, \
1017                 }, \
1018         }
1019 #define _side_arg_dynamic_u32(_val, _byte_order, _attr) \
1020         { \
1021                 .dynamic_type = SIDE_DYNAMIC_TYPE_U32, \
1022                 .u = { \
1023                         .side_basic = { \
1024                                 .attr = _attr, \
1025                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1026                                 .byte_order = _byte_order, \
1027                                 .u = { \
1028                                         .integer_value.side_u32 = (_val), \
1029                                 }, \
1030                         }, \
1031                 }, \
1032         }
1033 #define _side_arg_dynamic_u64(_val, _byte_order, _attr) \
1034         { \
1035                 .dynamic_type = SIDE_DYNAMIC_TYPE_U64, \
1036                 .u = { \
1037                         .side_basic = { \
1038                                 .attr = _attr, \
1039                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1040                                 .byte_order = _byte_order, \
1041                                 .u = { \
1042                                         .integer_value.side_u64 = (_val), \
1043                                 }, \
1044                         }, \
1045                 }, \
1046         }
1047
1048 #define _side_arg_dynamic_s16(_val, _byte_order, _attr) \
1049         { \
1050                 .dynamic_type = SIDE_DYNAMIC_TYPE_S16, \
1051                 .u = { \
1052                         .side_basic = { \
1053                                 .attr = _attr, \
1054                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1055                                 .byte_order = _byte_order, \
1056                                 .u = { \
1057                                         .integer_value.side_s16 = (_val), \
1058                                 }, \
1059                         }, \
1060                 }, \
1061         }
1062 #define _side_arg_dynamic_s32(_val, _byte_order, _attr) \
1063         { \
1064                 .dynamic_type = SIDE_DYNAMIC_TYPE_S32, \
1065                 .u = { \
1066                         .side_basic = { \
1067                                 .attr = _attr, \
1068                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1069                                 .byte_order = _byte_order, \
1070                                 .u = { \
1071                                         .integer_value.side_s32 = (_val), \
1072                                 }, \
1073                         }, \
1074                 }, \
1075         }
1076 #define _side_arg_dynamic_s64(_val, _byte_order, _attr) \
1077         { \
1078                 .dynamic_type = SIDE_DYNAMIC_TYPE_S64, \
1079                 .u = { \
1080                         .side_basic = { \
1081                                 .attr = _attr, \
1082                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1083                                 .byte_order = _byte_order, \
1084                                 .u = { \
1085                                         .integer_value.side_s64 = (_val), \
1086                                 }, \
1087                         }, \
1088                 }, \
1089         }
1090 #define _side_arg_dynamic_pointer(_val, _byte_order, _attr) \
1091         { \
1092                 .dynamic_type = SIDE_DYNAMIC_TYPE_POINTER_HOST, \
1093                 .u = { \
1094                         .side_basic = { \
1095                                 .attr = _attr, \
1096                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1097                                 .byte_order = _byte_order, \
1098                                 .u = { \
1099                                         .integer_value = { \
1100                                                 SIDE_PTR_HOST = (uintptr_t) (_val), \
1101                                         }, \
1102                                 }, \
1103                         }, \
1104                 }, \
1105         }
1106 #define _side_arg_dynamic_float_binary16(_val, _byte_order, _attr) \
1107         { \
1108                 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY16, \
1109                 .u = { \
1110                         .side_basic = { \
1111                                 .attr = _attr, \
1112                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1113                                 .byte_order = _byte_order, \
1114                                 .u = { \
1115                                         .float_value.side_float_binary16 = (_val), \
1116                                 }, \
1117                         }, \
1118                 }, \
1119         }
1120 #define _side_arg_dynamic_float_binary32(_val, _byte_order, _attr) \
1121         { \
1122                 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY32, \
1123                 .u = { \
1124                         .side_basic = { \
1125                                 .attr = _attr, \
1126                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1127                                 .byte_order = _byte_order, \
1128                                 .u = { \
1129                                         .float_value.side_float_binary32 = (_val), \
1130                                 }, \
1131                         }, \
1132                 }, \
1133         }
1134 #define _side_arg_dynamic_float_binary64(_val, _byte_order, _attr) \
1135         { \
1136                 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY64, \
1137                 .u = { \
1138                         .side_basic = { \
1139                                 .attr = _attr, \
1140                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1141                                 .byte_order = _byte_order, \
1142                                 .u = { \
1143                                         .float_value.side_float_binary64 = (_val), \
1144                                 }, \
1145                         }, \
1146                 }, \
1147         }
1148 #define _side_arg_dynamic_float_binary128(_val, _byte_order, _attr) \
1149         { \
1150                 .dynamic_type = SIDE_DYNAMIC_TYPE_FLOAT_BINARY128, \
1151                 .u = { \
1152                         .side_basic = { \
1153                                 .attr = _attr, \
1154                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1155                                 .byte_order = _byte_order, \
1156                                 .u = { \
1157                                         .float_value.side_float_binary128 = (_val), \
1158                                 }, \
1159                         }, \
1160                 }, \
1161         }
1162
1163 /* Host endian */
1164 #define side_arg_dynamic_u16(_val, _attr)               _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1165 #define side_arg_dynamic_u32(_val, _attr)               _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1166 #define side_arg_dynamic_u64(_val, _attr)               _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1167 #define side_arg_dynamic_s16(_val, _attr)               _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1168 #define side_arg_dynamic_s32(_val, _attr)               _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1169 #define side_arg_dynamic_s64(_val, _attr)               _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1170 #define side_arg_dynamic_pointer(_val, _attr)           _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1171 #define side_arg_dynamic_float_binary16(_val, _attr)    _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1172 #define side_arg_dynamic_float_binary32(_val, _attr)    _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1173 #define side_arg_dynamic_float_binary64(_val, _attr)    _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1174 #define side_arg_dynamic_float_binary128(_val, _attr)   _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1175
1176 /* Little endian */
1177 #define side_arg_dynamic_u16_le(_val, _attr)                    _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1178 #define side_arg_dynamic_u32_le(_val, _attr)                    _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1179 #define side_arg_dynamic_u64_le(_val, _attr)                    _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1180 #define side_arg_dynamic_s16_le(_val, _attr)                    _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1181 #define side_arg_dynamic_s32_le(_val, _attr)                    _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1182 #define side_arg_dynamic_s64_le(_val, _attr)                    _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1183 #define side_arg_dynamic_pointer_le(_val, _attr)                _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1184 #define side_arg_dynamic_float_binary16_le(_val, _attr)         _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1185 #define side_arg_dynamic_float_binary32_le(_val, _attr)         _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1186 #define side_arg_dynamic_float_binary64_le(_val, _attr)         _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1187 #define side_arg_dynamic_float_binary128_le(_val, _attr)        _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1188
1189 /* Big endian */
1190 #define side_arg_dynamic_u16_be(_val, _attr)                    _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1191 #define side_arg_dynamic_u32_be(_val, _attr)                    _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1192 #define side_arg_dynamic_u64_be(_val, _attr)                    _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1193 #define side_arg_dynamic_s16_be(_val, _attr)                    _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1194 #define side_arg_dynamic_s32_be(_val, _attr)                    _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1195 #define side_arg_dynamic_s64_be(_val, _attr)                    _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1196 #define side_arg_dynamic_pointer_be(_val, _attr)                _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1197 #define side_arg_dynamic_float_binary16_be(_val, _attr)         _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1198 #define side_arg_dynamic_float_binary32_be(_val, _attr)         _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1199 #define side_arg_dynamic_float_binary64_be(_val, _attr)         _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1200 #define side_arg_dynamic_float_binary128_be(_val, _attr)        _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1201
1202 #define side_arg_dynamic_vla(_vla) \
1203         { \
1204                 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA, \
1205                 .u = { \
1206                         .side_dynamic_vla = (_vla), \
1207                 }, \
1208         }
1209
1210 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
1211         { \
1212                 .dynamic_type = SIDE_DYNAMIC_TYPE_VLA_VISITOR, \
1213                 .u = { \
1214                         .side_dynamic_vla_visitor = { \
1215                                 .app_ctx = _ctx, \
1216                                 .visitor = _dynamic_vla_visitor, \
1217                                 .attr = _attr, \
1218                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1219                         }, \
1220                 }, \
1221         }
1222
1223 #define side_arg_dynamic_struct(_struct) \
1224         { \
1225                 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT, \
1226                 .u = { \
1227                         .side_dynamic_struct = (_struct), \
1228                 }, \
1229         }
1230
1231 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
1232         { \
1233                 .dynamic_type = SIDE_DYNAMIC_TYPE_STRUCT_VISITOR, \
1234                 .u = { \
1235                         .side_dynamic_struct_visitor = { \
1236                                 .app_ctx = _ctx, \
1237                                 .visitor = _dynamic_struct_visitor, \
1238                                 .attr = _attr, \
1239                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1240                         }, \
1241                 }, \
1242         }
1243
1244 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
1245         const struct side_arg_dynamic_vec _identifier##_vec[] = { _sav }; \
1246         const struct side_arg_dynamic_vec_vla _identifier = { \
1247                 .sav = _identifier##_vec, \
1248                 .attr = _attr, \
1249                 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1250                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1251         }
1252
1253 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
1254         const struct side_arg_dynamic_event_field _identifier##_fields[] = { _struct_fields }; \
1255         const struct side_arg_dynamic_event_struct _identifier = { \
1256                 .fields = _identifier##_fields, \
1257                 .attr = _attr, \
1258                 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
1259                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1260         }
1261
1262 #define side_arg_define_vec(_identifier, _sav) \
1263         const struct side_arg_vec _identifier##_vec[] = { _sav }; \
1264         const struct side_arg_vec_description _identifier = { \
1265                 .sav = _identifier##_vec, \
1266                 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1267         }
1268
1269 #define side_arg_dynamic_field(_name, _elem) \
1270         { \
1271                 .field_name = _name, \
1272                 .elem = _elem, \
1273         }
1274
1275 #define side_arg_list(...)      __VA_ARGS__
1276
1277 #define side_define_enum(_identifier, _mappings, _attr) \
1278         const struct side_enum_mappings _identifier = { \
1279                 .mappings = _mappings, \
1280                 .attr = _attr, \
1281                 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1282                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1283         }
1284
1285 #define side_enum_mapping_list(...) \
1286         SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
1287
1288 #define side_enum_mapping_range(_label, _begin, _end) \
1289         { \
1290                 .range_begin = _begin, \
1291                 .range_end = _end, \
1292                 .label = _label, \
1293         }
1294
1295 #define side_enum_mapping_value(_label, _value) \
1296         { \
1297                 .range_begin = _value, \
1298                 .range_end = _value, \
1299                 .label = _label, \
1300         }
1301
1302 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
1303         const struct side_enum_bitmap_mappings _identifier = { \
1304                 .mappings = _mappings, \
1305                 .attr = _attr, \
1306                 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
1307                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1308         }
1309
1310 #define side_enum_bitmap_mapping_list(...) \
1311         SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
1312
1313 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
1314         { \
1315                 .range_begin = _begin, \
1316                 .range_end = _end, \
1317                 .label = _label, \
1318         }
1319
1320 #define side_enum_bitmap_mapping_value(_label, _value) \
1321         { \
1322                 .range_begin = _value, \
1323                 .range_end = _value, \
1324                 .label = _label, \
1325         }
1326
1327 #define side_event_cond(_identifier) \
1328         if (side_unlikely(__atomic_load_n(&side_event_enable__##_identifier, \
1329                                         __ATOMIC_RELAXED)))
1330
1331 #define side_event_call(_identifier, _sav) \
1332         { \
1333                 const struct side_arg_vec side_sav[] = { _sav }; \
1334                 const struct side_arg_vec_description sav_desc = { \
1335                         .sav = side_sav, \
1336                         .len = SIDE_ARRAY_SIZE(side_sav), \
1337                 }; \
1338                 side_call(&(_identifier), &sav_desc); \
1339         }
1340
1341 #define side_event(_identifier, _sav) \
1342         side_event_cond(_identifier) \
1343                 side_event_call(_identifier, SIDE_PARAM(_sav))
1344
1345 #define side_event_call_variadic(_identifier, _sav, _var_fields, _attr) \
1346         { \
1347                 const struct side_arg_vec side_sav[] = { _sav }; \
1348                 const struct side_arg_vec_description sav_desc = { \
1349                         .sav = side_sav, \
1350                         .len = SIDE_ARRAY_SIZE(side_sav), \
1351                 }; \
1352                 const struct side_arg_dynamic_event_field side_fields[] = { _var_fields }; \
1353                 const struct side_arg_dynamic_event_struct var_struct = { \
1354                         .fields = side_fields, \
1355                         .attr = _attr, \
1356                         .len = SIDE_ARRAY_SIZE(side_fields), \
1357                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1358                 }; \
1359                 side_call_variadic(&(_identifier), &sav_desc, &var_struct); \
1360         }
1361
1362 #define side_event_variadic(_identifier, _sav, _var, _attr) \
1363         side_event_cond(_identifier) \
1364                 side_event_call_variadic(_identifier, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1365
1366 #define _side_define_event(_linkage, _identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1367         _linkage uintptr_t side_event_enable__##_identifier __attribute__((section("side_event_enable"))); \
1368         _linkage struct side_event_description __attribute__((section("side_event_description"))) \
1369                         _identifier = { \
1370                 .enabled = &(side_event_enable__##_identifier), \
1371                 .provider_name = _provider, \
1372                 .event_name = _event, \
1373                 .fields = _fields, \
1374                 .attr = _attr, \
1375                 .callbacks = &side_empty_callback, \
1376                 .flags = (_flags), \
1377                 .version = 0, \
1378                 .loglevel = _loglevel, \
1379                 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1380                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1381                 .nr_callbacks = 0, \
1382         }; \
1383         static const struct side_event_description *side_event_ptr__##_identifier \
1384                 __attribute__((section("side_event_description_ptr"), used)) = &(_identifier);
1385
1386 #define side_static_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1387         _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1388                         SIDE_PARAM(_attr), 0)
1389
1390 #define side_static_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1391         _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1392                         SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1393
1394 #define side_hidden_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1395         _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1396                         SIDE_PARAM(_attr), 0)
1397
1398 #define side_hidden_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1399         _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1400                         SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1401
1402 #define side_export_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1403         _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1404                         SIDE_PARAM(_attr), 0)
1405
1406 #define side_export_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1407         _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1408                         SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1409
1410 #define side_declare_event(_identifier) \
1411         extern uintptr_t side_event_enable_##_identifier; \
1412         extern struct side_event_description _identifier
1413
1414 extern const struct side_callback side_empty_callback;
1415
1416 void side_call(const struct side_event_description *desc,
1417         const struct side_arg_vec_description *sav_desc);
1418 void side_call_variadic(const struct side_event_description *desc,
1419         const struct side_arg_vec_description *sav_desc,
1420         const struct side_arg_dynamic_event_struct *var_struct);
1421
1422 int side_tracer_callback_register(struct side_event_description *desc,
1423                 void (*call)(const struct side_event_description *desc,
1424                         const struct side_arg_vec_description *sav_desc,
1425                         void *priv),
1426                 void *priv);
1427 int side_tracer_callback_variadic_register(struct side_event_description *desc,
1428                 void (*call_variadic)(const struct side_event_description *desc,
1429                         const struct side_arg_vec_description *sav_desc,
1430                         const struct side_arg_dynamic_event_struct *var_struct,
1431                         void *priv),
1432                 void *priv);
1433 int side_tracer_callback_unregister(struct side_event_description *desc,
1434                 void (*call)(const struct side_event_description *desc,
1435                         const struct side_arg_vec_description *sav_desc,
1436                         void *priv),
1437                 void *priv);
1438 int side_tracer_callback_variadic_unregister(struct side_event_description *desc,
1439                 void (*call_variadic)(const struct side_event_description *desc,
1440                         const struct side_arg_vec_description *sav_desc,
1441                         const struct side_arg_dynamic_event_struct *var_struct,
1442                         void *priv),
1443                 void *priv);
1444
1445 struct side_events_register_handle *side_events_register(struct side_event_description **events, uint32_t nr_events);
1446 void side_events_unregister(struct side_events_register_handle *handle);
1447
1448 enum side_tracer_notification {
1449         SIDE_TRACER_NOTIFICATION_INSERT_EVENTS,
1450         SIDE_TRACER_NOTIFICATION_REMOVE_EVENTS,
1451 };
1452
1453 /* Callback is invoked with side library internal lock held. */
1454 struct side_tracer_handle *side_tracer_event_notification_register(
1455                 void (*cb)(enum side_tracer_notification notif,
1456                         struct side_event_description **events, uint32_t nr_events, void *priv),
1457                 void *priv);
1458 void side_tracer_event_notification_unregister(struct side_tracer_handle *handle);
1459
1460 void side_init(void);
1461 void side_exit(void);
1462
1463 /*
1464  * These weak symbols, the constructor, and destructor take care of
1465  * registering only _one_ instance of the side instrumentation per
1466  * shared-ojbect (or for the whole main program).
1467  */
1468 extern struct side_event_description * __start_side_event_description_ptr[]
1469         __attribute__((weak, visibility("hidden")));
1470 extern struct side_event_description * __stop_side_event_description_ptr[]
1471         __attribute__((weak, visibility("hidden")));
1472 int side_event_description_ptr_registered
1473         __attribute__((weak, visibility("hidden")));
1474 struct side_events_register_handle *side_events_handle
1475         __attribute__((weak, visibility("hidden")));
1476
1477 static void
1478 side_event_description_ptr_init(void)
1479         __attribute__((no_instrument_function))
1480         __attribute__((constructor));
1481 static void
1482 side_event_description_ptr_init(void)
1483 {
1484         if (side_event_description_ptr_registered++)
1485                 return;
1486         side_events_handle = side_events_register(__start_side_event_description_ptr,
1487                 __stop_side_event_description_ptr - __start_side_event_description_ptr);
1488 }
1489
1490 static void
1491 side_event_description_ptr_exit(void)
1492         __attribute__((no_instrument_function))
1493         __attribute__((destructor));
1494 static void
1495 side_event_description_ptr_exit(void)
1496 {
1497         if (--side_event_description_ptr_registered)
1498                 return;
1499         side_events_unregister(side_events_handle);
1500         side_events_handle = NULL;
1501 }
1502
1503 #endif /* _SIDE_TRACE_H */