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