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