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