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 /*
  18  * SIDE stands for "Static Instrumentation Dynamically Enabled"
  19  *
  20  * This is an instrumentation API for Linux user-space, which exposes an
  21  * instrumentation type system and facilities allowing a kernel or
  22  * user-space tracer to consume user-space instrumentation.
  23  *
  24  * This instrumentation API exposes 3 type systems:
  25  *
  26  * * Stack-copy type system: This is the core type system which can
  27  *   represent all supported types and into which all other type systems
  28  *   can be nested. This type system requires that every type is
  29  *   statically or dynamically declared and then registered, thus giving
  30  *   tracers a complete description of the events and their associated
  31  *   fields before the associated instrumentation is invoked. The
  32  *   application needs to copy each argument (side_arg_...()) onto the
  33  *   stack when calling the instrumentation.
  34  *
  35  *   This is the most expressive of the 3 type systems, althrough not the
  36  *   fastest due to the extra copy of the arguments.
  37  *
  38  * * Data-gathering type system: This type system requires every type to
  39  *   be statically or dynamically declared and registered, but does not
  40  *   require the application to copy its arguments onto the stack.
  41  *   Instead, the type description contains all the required information
  42  *   to fetch the data from the application memory. The only argument
  43  *   required from the instrumentation is the base pointer from which
  44  *   the data should be fetched.
  45  *
  46  *   This type system can be used as an event field, or nested within
  47  *   the stack-copy type system. Nesting of gather-vla within
  48  *   gather-array and gather-vla types is not allowed.
  49  *
  50  *   This type system is has the least overhead of the 3 type systems.
  51  *
  52  * * Dynamic type system: This type system receives both type
  53  *   description and actual data onto the stack at runtime. It has more
  54  *   overhead that the 2 other type systems, but does not require a
  55  *   prior registration of event field description. This makes it useful
  56  *   for seldom used types which are not performance critical, but for
  57  *   which registering each individual events would needlessly grow the
  58  *   number of events to declare and register.
  59  *
  60  *   Another use-case for this type system is for use by dynamically
  61  *   typed language runtimes, where the field type is only known when
  62  *   the instrumentation is called.
  63  *
  64  *   Those dynamic types can be either used as arguments to a variadic
  65  *   field list, or as on-stack instrumentation argument for a static
  66  *   type SIDE_TYPE_DYNAMIC place holder in the stack-copy type system.
  67  */
  68
  69 //TODO: as those structures will be ABI, we need to either consider them
  70 //fixed forever, or think of a scheme that would allow their binary
  71 //representation to be extended if need be.
  72
  73 struct side_arg;
  74 struct side_arg_vec;
  75 struct side_arg_dynamic;
  76 struct side_arg_dynamic_field;
  77 struct side_arg_dynamic_vla;
  78 struct side_type;
  79 struct side_event_field;
  80 struct side_tracer_visitor_ctx;
  81 struct side_tracer_dynamic_struct_visitor_ctx;
  82 struct side_event_description;
  83 struct side_arg_dynamic_struct;
  84 struct side_events_register_handle;
  85
  86 enum side_type_label {
  87         /* Stack-copy basic types */
  88         SIDE_TYPE_NULL,
  89         SIDE_TYPE_BOOL,
  90         SIDE_TYPE_U8,
  91         SIDE_TYPE_U16,
  92         SIDE_TYPE_U32,
  93         SIDE_TYPE_U64,
  94         SIDE_TYPE_S8,
  95         SIDE_TYPE_S16,
  96         SIDE_TYPE_S32,
  97         SIDE_TYPE_S64,
  98         SIDE_TYPE_BYTE,
  99         SIDE_TYPE_POINTER32,
 100         SIDE_TYPE_POINTER64,
 101         SIDE_TYPE_FLOAT_BINARY16,
 102         SIDE_TYPE_FLOAT_BINARY32,
 103         SIDE_TYPE_FLOAT_BINARY64,
 104         SIDE_TYPE_FLOAT_BINARY128,
 105         SIDE_TYPE_STRING,
 106
 107         /* Stack-copy compound types */
 108         SIDE_TYPE_STRUCT,
 109         SIDE_TYPE_ARRAY,
 110         SIDE_TYPE_VLA,
 111         SIDE_TYPE_VLA_VISITOR,
 112
 113         /* Stack-copy enumeration types */
 114         SIDE_TYPE_ENUM,
 115         SIDE_TYPE_ENUM_BITMAP,
 116
 117         /* Stack-copy place holder for dynamic types */
 118         SIDE_TYPE_DYNAMIC,
 119
 120         /* Gather basic types */
 121         SIDE_TYPE_GATHER_BOOL,
 122         SIDE_TYPE_GATHER_UNSIGNED_INT,
 123         SIDE_TYPE_GATHER_SIGNED_INT,
 124         SIDE_TYPE_GATHER_BYTE,
 125         SIDE_TYPE_GATHER_FLOAT,
 126
 127         /* Gather compound types */
 128         SIDE_TYPE_GATHER_STRUCT,
 129         SIDE_TYPE_GATHER_ARRAY,
 130         SIDE_TYPE_GATHER_VLA,
 131
 132         /* Dynamic basic types */
 133         SIDE_TYPE_DYNAMIC_NULL,
 134         SIDE_TYPE_DYNAMIC_BOOL,
 135         SIDE_TYPE_DYNAMIC_U8,
 136         SIDE_TYPE_DYNAMIC_U16,
 137         SIDE_TYPE_DYNAMIC_U32,
 138         SIDE_TYPE_DYNAMIC_U64,
 139         SIDE_TYPE_DYNAMIC_S8,
 140         SIDE_TYPE_DYNAMIC_S16,
 141         SIDE_TYPE_DYNAMIC_S32,
 142         SIDE_TYPE_DYNAMIC_S64,
 143         SIDE_TYPE_DYNAMIC_BYTE,
 144         SIDE_TYPE_DYNAMIC_POINTER32,
 145         SIDE_TYPE_DYNAMIC_POINTER64,
 146         SIDE_TYPE_DYNAMIC_FLOAT_BINARY16,
 147         SIDE_TYPE_DYNAMIC_FLOAT_BINARY32,
 148         SIDE_TYPE_DYNAMIC_FLOAT_BINARY64,
 149         SIDE_TYPE_DYNAMIC_FLOAT_BINARY128,
 150         SIDE_TYPE_DYNAMIC_STRING,
 151
 152         /* Dynamic compound types */
 153         SIDE_TYPE_DYNAMIC_STRUCT,
 154         SIDE_TYPE_DYNAMIC_STRUCT_VISITOR,
 155         SIDE_TYPE_DYNAMIC_VLA,
 156         SIDE_TYPE_DYNAMIC_VLA_VISITOR,
 157 };
 158
 159 enum side_attr_type {
 160         SIDE_ATTR_TYPE_NULL,
 161         SIDE_ATTR_TYPE_BOOL,
 162         SIDE_ATTR_TYPE_U8,
 163         SIDE_ATTR_TYPE_U16,
 164         SIDE_ATTR_TYPE_U32,
 165         SIDE_ATTR_TYPE_U64,
 166         SIDE_ATTR_TYPE_S8,
 167         SIDE_ATTR_TYPE_S16,
 168         SIDE_ATTR_TYPE_S32,
 169         SIDE_ATTR_TYPE_S64,
 170         SIDE_ATTR_TYPE_POINTER32,
 171         SIDE_ATTR_TYPE_POINTER64,
 172         SIDE_ATTR_TYPE_FLOAT_BINARY16,
 173         SIDE_ATTR_TYPE_FLOAT_BINARY32,
 174         SIDE_ATTR_TYPE_FLOAT_BINARY64,
 175         SIDE_ATTR_TYPE_FLOAT_BINARY128,
 176         SIDE_ATTR_TYPE_STRING,
 177 };
 178
 179 enum side_loglevel {
 180         SIDE_LOGLEVEL_EMERG = 0,
 181         SIDE_LOGLEVEL_ALERT = 1,
 182         SIDE_LOGLEVEL_CRIT = 2,
 183         SIDE_LOGLEVEL_ERR = 3,
 184         SIDE_LOGLEVEL_WARNING = 4,
 185         SIDE_LOGLEVEL_NOTICE = 5,
 186         SIDE_LOGLEVEL_INFO = 6,
 187         SIDE_LOGLEVEL_DEBUG = 7,
 188 };
 189
 190 enum side_visitor_status {
 191         SIDE_VISITOR_STATUS_OK = 0,
 192         SIDE_VISITOR_STATUS_ERROR = -1,
 193 };
 194
 195 enum side_error {
 196         SIDE_ERROR_OK = 0,
 197         SIDE_ERROR_INVAL = 1,
 198         SIDE_ERROR_EXIST = 2,
 199         SIDE_ERROR_NOMEM = 3,
 200         SIDE_ERROR_NOENT = 4,
 201         SIDE_ERROR_EXITING = 5,
 202 };
 203
 204 enum side_type_label_byte_order {
 205         SIDE_TYPE_BYTE_ORDER_LE = 0,
 206         SIDE_TYPE_BYTE_ORDER_BE = 1,
 207 };
 208
 209 #if (SIDE_BYTE_ORDER == SIDE_LITTLE_ENDIAN)
 210 # define SIDE_TYPE_BYTE_ORDER_HOST              SIDE_TYPE_BYTE_ORDER_LE
 211 #else
 212 # define SIDE_TYPE_BYTE_ORDER_HOST              SIDE_TYPE_BYTE_ORDER_BE
 213 #endif
 214
 215 #if (SIDE_FLOAT_WORD_ORDER == SIDE_LITTLE_ENDIAN)
 216 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST        SIDE_TYPE_BYTE_ORDER_LE
 217 #else
 218 # define SIDE_TYPE_FLOAT_WORD_ORDER_HOST        SIDE_TYPE_BYTE_ORDER_BE
 219 #endif
 220
 221 enum side_type_gather_access_mode {
 222         SIDE_TYPE_GATHER_ACCESS_DIRECT,
 223         SIDE_TYPE_GATHER_ACCESS_POINTER,        /* Pointer dereference */
 224 };
 225
 226 typedef enum side_visitor_status (*side_visitor_func)(
 227                 const struct side_tracer_visitor_ctx *tracer_ctx,
 228                 void *app_ctx);
 229 typedef enum side_visitor_status (*side_dynamic_struct_visitor_func)(
 230                 const struct side_tracer_dynamic_struct_visitor_ctx *tracer_ctx,
 231                 void *app_ctx);
 232
 233 union side_integer_value {
 234         uint8_t side_u8;
 235         uint16_t side_u16;
 236         uint32_t side_u32;
 237         uint64_t side_u64;
 238         int8_t side_s8;
 239         int16_t side_s16;
 240         int32_t side_s32;
 241         int64_t side_s64;
 242 } SIDE_PACKED;
 243
 244 union side_bool_value {
 245         uint8_t side_bool8;
 246         uint16_t side_bool16;
 247         uint32_t side_bool32;
 248         uint64_t side_bool64;
 249 } SIDE_PACKED;
 250
 251 union side_float_value {
 252 #if __HAVE_FLOAT16
 253         _Float16 side_float_binary16;
 254 #endif
 255 #if __HAVE_FLOAT32
 256         _Float32 side_float_binary32;
 257 #endif
 258 #if __HAVE_FLOAT64
 259         _Float64 side_float_binary64;
 260 #endif
 261 #if __HAVE_FLOAT128
 262         _Float128 side_float_binary128;
 263 #endif
 264 } SIDE_PACKED;
 265
 266 struct side_attr_value {
 267         uint32_t type;  /* enum side_attr_type */
 268         union {
 269                 uint8_t bool_value;
 270                 uint64_t string_value;  /* const char * */
 271                 union side_integer_value integer_value;
 272                 union side_float_value float_value;
 273         } SIDE_PACKED u;
 274 };
 275
 276 /* User attributes. */
 277 struct side_attr {
 278         const char *key;
 279         const struct side_attr_value value;
 280 } SIDE_PACKED;
 281
 282 /* Type descriptions */
 283 struct side_type_null {
 284         const struct side_attr *attr;
 285         uint32_t nr_attr;
 286 } SIDE_PACKED;
 287
 288 struct side_type_bool {
 289         const struct side_attr *attr;
 290         uint32_t nr_attr;
 291         uint16_t bool_size;             /* bytes */
 292         uint16_t len_bits;              /* bits. 0 for (bool_size * CHAR_BITS) */
 293         uint8_t byte_order;             /* enum side_type_label_byte_order */
 294 } SIDE_PACKED;
 295
 296 struct side_type_byte {
 297         const struct side_attr *attr;
 298         uint32_t nr_attr;
 299 } SIDE_PACKED;
 300
 301 struct side_type_string {
 302         const struct side_attr *attr;
 303         uint32_t nr_attr;
 304 } SIDE_PACKED;
 305
 306 struct side_type_integer {
 307         const struct side_attr *attr;
 308         uint32_t nr_attr;
 309         uint16_t integer_size;          /* bytes */
 310         uint16_t len_bits;              /* bits. 0 for (integer_size * CHAR_BITS) */
 311         uint8_t signedness;             /* true/false */
 312         uint8_t byte_order;             /* enum side_type_label_byte_order */
 313 } SIDE_PACKED;
 314
 315 struct side_type_float {
 316         const struct side_attr *attr;
 317         uint32_t nr_attr;
 318         uint16_t float_size;            /* bytes */
 319         uint8_t byte_order;             /* enum side_type_label_byte_order */
 320 } SIDE_PACKED;
 321
 322 struct side_enum_mapping {
 323         int64_t range_begin;
 324         int64_t range_end;
 325         const char *label;
 326 } SIDE_PACKED;
 327
 328 struct side_enum_mappings {
 329         const struct side_enum_mapping *mappings;
 330         const struct side_attr *attr;
 331         uint32_t nr_mappings;
 332         uint32_t nr_attr;
 333 } SIDE_PACKED;
 334
 335 struct side_enum_bitmap_mapping {
 336         uint64_t range_begin;
 337         uint64_t range_end;
 338         const char *label;
 339 } SIDE_PACKED;
 340
 341 struct side_enum_bitmap_mappings {
 342         const struct side_enum_bitmap_mapping *mappings;
 343         const struct side_attr *attr;
 344         uint32_t nr_mappings;
 345         uint32_t nr_attr;
 346 } SIDE_PACKED;
 347
 348 struct side_type_struct {
 349         const struct side_event_field *fields;
 350         const struct side_attr *attr;
 351         uint32_t nr_fields;
 352         uint32_t nr_attr;
 353 } SIDE_PACKED;
 354
 355 struct side_type_array {
 356         const struct side_type *elem_type;
 357         const struct side_attr *attr;
 358         uint32_t length;
 359         uint32_t nr_attr;
 360 } SIDE_PACKED;
 361
 362 struct side_type_vla {
 363         const struct side_type *elem_type;
 364         const struct side_attr *attr;
 365         uint32_t nr_attr;
 366 } SIDE_PACKED;
 367
 368 struct side_type_vla_visitor {
 369         const struct side_type *elem_type;
 370         side_visitor_func visitor;
 371         const struct side_attr *attr;
 372         uint32_t nr_attr;
 373 } SIDE_PACKED;
 374
 375 struct side_type_enum {
 376         const struct side_enum_mappings *mappings;
 377         const struct side_type *elem_type;
 378 } SIDE_PACKED;
 379
 380 struct side_type_enum_bitmap {
 381         const struct side_enum_bitmap_mappings *mappings;
 382         const struct side_type *elem_type;
 383 } SIDE_PACKED;
 384
 385 struct side_type_gather_bool {
 386         uint64_t offset;        /* bytes */
 387         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 388         struct side_type_bool type;
 389         uint16_t offset_bits;   /* bits */
 390 } SIDE_PACKED;
 391
 392 struct side_type_gather_byte {
 393         uint64_t offset;        /* bytes */
 394         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 395         struct side_type_byte type;
 396 } SIDE_PACKED;
 397
 398 struct side_type_gather_integer {
 399         uint64_t offset;        /* bytes */
 400         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 401         struct side_type_integer type;
 402         uint16_t offset_bits;   /* bits */
 403 } SIDE_PACKED;
 404
 405 struct side_type_gather_float {
 406         uint64_t offset;        /* bytes */
 407         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 408         struct side_type_float type;
 409 } SIDE_PACKED;
 410
 411 struct side_type_gather_struct {
 412         uint64_t offset;        /* bytes */
 413         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 414         const struct side_type_struct *type;
 415         uint32_t size;          /* bytes */
 416 } SIDE_PACKED;
 417
 418 struct side_type_gather_array {
 419         uint64_t offset;        /* bytes */
 420         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 421         struct side_type_array type;
 422 } SIDE_PACKED;
 423
 424 struct side_type_gather_vla {
 425         const struct side_type *length_type;    /* side_length() */
 426
 427         uint64_t offset;        /* bytes */
 428         uint8_t access_mode;    /* enum side_type_gather_access_mode */
 429         struct side_type_vla type;
 430 } SIDE_PACKED;
 431
 432 struct side_type_gather {
 433         union {
 434                 struct side_type_gather_bool side_bool;
 435                 struct side_type_gather_byte side_byte;
 436                 struct side_type_gather_integer side_integer;
 437                 struct side_type_gather_float side_float;
 438                 struct side_type_gather_array side_array;
 439                 struct side_type_gather_vla side_vla;
 440                 struct side_type_gather_struct side_struct;
 441         } SIDE_PACKED u;
 442 } SIDE_PACKED;
 443
 444 struct side_type {
 445         uint32_t type;  /* enum side_type_label */
 446         union {
 447                 /* Stack-copy basic types */
 448                 struct side_type_null side_null;
 449                 struct side_type_bool side_bool;
 450                 struct side_type_byte side_byte;
 451                 struct side_type_string side_string;
 452                 struct side_type_integer side_integer;
 453                 struct side_type_float side_float;
 454
 455                 /* Stack-copy compound types */
 456                 struct side_type_array side_array;
 457                 struct side_type_vla side_vla;
 458                 struct side_type_vla_visitor side_vla_visitor;
 459                 const struct side_type_struct *side_struct;
 460
 461                 /* Stack-copy enumeration types */
 462                 struct side_type_enum side_enum;
 463                 struct side_type_enum_bitmap side_enum_bitmap;
 464
 465                 /* Gather types */
 466                 struct side_type_gather side_gather;
 467         } SIDE_PACKED u;
 468 } SIDE_PACKED;
 469
 470 struct side_event_field {
 471         const char *field_name;
 472         struct side_type side_type;
 473 } SIDE_PACKED;
 474
 475 enum side_event_flags {
 476         SIDE_EVENT_FLAG_VARIADIC = (1 << 0),
 477 };
 478
 479 struct side_callback {
 480         union {
 481                 void (*call)(const struct side_event_description *desc,
 482                         const struct side_arg_vec *side_arg_vec,
 483                         void *priv);
 484                 void (*call_variadic)(const struct side_event_description *desc,
 485                         const struct side_arg_vec *side_arg_vec,
 486                         const struct side_arg_dynamic_struct *var_struct,
 487                         void *priv);
 488         } SIDE_PACKED u;
 489         void *priv;
 490 } SIDE_PACKED;
 491
 492 struct side_arg_static {
 493         /* Stack-copy basic types */
 494         union side_bool_value bool_value;
 495         uint8_t byte_value;
 496         uint64_t string_value;  /* const char * */
 497         union side_integer_value integer_value;
 498         union side_float_value float_value;
 499
 500         /* Stack-copy compound types */
 501         const struct side_arg_vec *side_struct;
 502         const struct side_arg_vec *side_array;
 503         const struct side_arg_vec *side_vla;
 504         void *side_vla_app_visitor_ctx;
 505
 506         /* Gather basic types */
 507         void *side_bool_gather_ptr;
 508         void *side_byte_gather_ptr;
 509         void *side_integer_gather_ptr;
 510         void *side_float_gather_ptr;
 511
 512         /* Gather compound types */
 513         void *side_array_gather_ptr;
 514         void *side_struct_gather_ptr;
 515         struct {
 516                 void *ptr;
 517                 void *length_ptr;
 518         } SIDE_PACKED side_vla_gather;
 519 } SIDE_PACKED;
 520
 521 struct side_arg_dynamic_vla {
 522         const struct side_arg *sav;
 523         const struct side_attr *attr;
 524         uint32_t len;
 525         uint32_t nr_attr;
 526 } SIDE_PACKED;
 527
 528 struct side_arg_dynamic_struct {
 529         const struct side_arg_dynamic_field *fields;
 530         const struct side_attr *attr;
 531         uint32_t len;
 532         uint32_t nr_attr;
 533 } SIDE_PACKED;
 534
 535 struct side_dynamic_struct_visitor {
 536         void *app_ctx;
 537         side_dynamic_struct_visitor_func visitor;
 538         const struct side_attr *attr;
 539         uint32_t nr_attr;
 540 } SIDE_PACKED;
 541
 542 struct side_dynamic_vla_visitor {
 543         void *app_ctx;
 544         side_visitor_func visitor;
 545         const struct side_attr *attr;
 546         uint32_t nr_attr;
 547 } SIDE_PACKED;
 548
 549 struct side_arg_dynamic {
 550         /* Dynamic basic types */
 551         struct side_type_null side_null;
 552         struct {
 553                 struct side_type_bool type;
 554                 union side_bool_value value;
 555         } SIDE_PACKED side_bool;
 556         struct {
 557                 struct side_type_byte type;
 558                 uint8_t value;
 559         } SIDE_PACKED side_byte;
 560         struct {
 561                 struct side_type_string type;
 562                 uint64_t value; /* const char * */
 563         } SIDE_PACKED side_string;
 564         struct {
 565                 struct side_type_integer type;
 566                 union side_integer_value value;
 567         } SIDE_PACKED side_integer;
 568         struct {
 569                 struct side_type_float type;
 570                 union side_float_value value;
 571         } SIDE_PACKED side_float;
 572
 573         /* Dynamic compound types */
 574         const struct side_arg_dynamic_struct *side_dynamic_struct;
 575         const struct side_arg_dynamic_vla *side_dynamic_vla;
 576
 577         struct side_dynamic_struct_visitor side_dynamic_struct_visitor;
 578         struct side_dynamic_vla_visitor side_dynamic_vla_visitor;
 579 } SIDE_PACKED;
 580
 581 struct side_arg {
 582         enum side_type_label type;
 583         union {
 584                 struct side_arg_static side_static;
 585                 struct side_arg_dynamic side_dynamic;
 586         } SIDE_PACKED u;
 587 } SIDE_PACKED;
 588
 589 struct side_arg_vec {
 590         const struct side_arg *sav;
 591         uint32_t len;
 592 } SIDE_PACKED;
 593
 594 struct side_arg_dynamic_field {
 595         const char *field_name;
 596         const struct side_arg elem;
 597 } SIDE_PACKED;
 598
 599 /* The visitor pattern is a double-dispatch visitor. */
 600 struct side_tracer_visitor_ctx {
 601         enum side_visitor_status (*write_elem)(
 602                         const struct side_tracer_visitor_ctx *tracer_ctx,
 603                         const struct side_arg *elem);
 604         void *priv;             /* Private tracer context. */
 605 } SIDE_PACKED;
 606
 607 struct side_tracer_dynamic_struct_visitor_ctx {
 608         enum side_visitor_status (*write_field)(
 609                         const struct side_tracer_dynamic_struct_visitor_ctx *tracer_ctx,
 610                         const struct side_arg_dynamic_field *dynamic_field);
 611         void *priv;             /* Private tracer context. */
 612 } SIDE_PACKED;
 613
 614 struct side_event_description {
 615         uintptr_t *enabled;
 616         const char *provider_name;
 617         const char *event_name;
 618         const struct side_event_field *fields;
 619         const struct side_attr *attr;
 620         const struct side_callback *callbacks;
 621         uint64_t flags;
 622         uint32_t version;
 623         uint32_t loglevel;      /* enum side_loglevel */
 624         uint32_t nr_fields;
 625         uint32_t nr_attr;
 626         uint32_t nr_callbacks;
 627 } SIDE_PACKED;
 628
 629 /* Event and type attributes */
 630
 631 #if SIDE_BITS_PER_LONG == 64
 632 # define SIDE_TYPE_POINTER_HOST         SIDE_TYPE_POINTER64
 633 # define SIDE_TYPE_ARRAY_POINTER_HOST   SIDE_TYPE_ARRAY_POINTER64
 634 # define SIDE_TYPE_VLA_POINTER_HOST     SIDE_TYPE_VLA_POINTER64
 635 # define SIDE_TYPE_DYNAMIC_POINTER_HOST SIDE_TYPE_DYNAMIC_POINTER64
 636 # define SIDE_ATTR_TYPE_POINTER_HOST    SIDE_ATTR_TYPE_POINTER64
 637 # define SIDE_PTR_HOST                  .side_u64
 638 #else
 639 # define SIDE_TYPE_POINTER_HOST         SIDE_TYPE_POINTER32
 640 # define SIDE_TYPE_ARRAY_POINTER_HOST   SIDE_TYPE_ARRAY_POINTER32
 641 # define SIDE_TYPE_VLA_POINTER_HOST     SIDE_TYPE_VLA_POINTER32
 642 # define SIDE_TYPE_DYNAMIC_POINTER_HOST SIDE_TYPE_DYNAMIC_POINTER32
 643 # define SIDE_ATTR_TYPE_POINTER_HOST    SIDE_ATTR_TYPE_POINTER32
 644 # define SIDE_PTR_HOST                  .side_u32
 645 #endif
 646
 647 #define side_attr(_key, _value) \
 648         { \
 649                 .key = _key, \
 650                 .value = SIDE_PARAM(_value), \
 651         }
 652
 653 #define side_attr_list(...) \
 654         SIDE_COMPOUND_LITERAL(const struct side_attr, __VA_ARGS__)
 655
 656 #define side_attr_null(_val)            { .type = SIDE_ATTR_TYPE_NULL }
 657 #define side_attr_bool(_val)            { .type = SIDE_ATTR_TYPE_BOOL, .u = { .bool_value = !!(_val) } }
 658 #define side_attr_u8(_val)              { .type = SIDE_ATTR_TYPE_U8, .u = { .integer_value = { .side_u8 = (_val) } } }
 659 #define side_attr_u16(_val)             { .type = SIDE_ATTR_TYPE_U16, .u = { .integer_value = { .side_u16 = (_val) } } }
 660 #define side_attr_u32(_val)             { .type = SIDE_ATTR_TYPE_U32, .u = { .integer_value = { .side_u32 = (_val) } } }
 661 #define side_attr_u64(_val)             { .type = SIDE_ATTR_TYPE_U64, .u = { .integer_value = { .side_u64 = (_val) } } }
 662 #define side_attr_s8(_val)              { .type = SIDE_ATTR_TYPE_S8, .u = { .integer_value = { .side_s8 = (_val) } } }
 663 #define side_attr_s16(_val)             { .type = SIDE_ATTR_TYPE_S16, .u = { .integer_value = { .side_s16 = (_val) } } }
 664 #define side_attr_s32(_val)             { .type = SIDE_ATTR_TYPE_S32, .u = { .integer_value = { .side_s32 = (_val) } } }
 665 #define side_attr_s64(_val)             { .type = SIDE_ATTR_TYPE_S64, .u = { .integer_value = { .side_s64 = (_val) } } }
 666 #define side_attr_pointer(_val)         { .type = SIDE_ATTR_TYPE_POINTER_HOST, .u = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } }
 667 #define side_attr_float_binary16(_val)  { .type = SIDE_ATTR_TYPE_FLOAT_BINARY16, .u = { .float_value = { .side_float_binary16 = (_val) } } }
 668 #define side_attr_float_binary32(_val)  { .type = SIDE_ATTR_TYPE_FLOAT_BINARY32, .u = { .float_value = { .side_float_binary32 = (_val) } } }
 669 #define side_attr_float_binary64(_val)  { .type = SIDE_ATTR_TYPE_FLOAT_BINARY64, .u = { .float_value = { .side_float_binary64 = (_val) } } }
 670 #define side_attr_float_binary128(_val) { .type = SIDE_ATTR_TYPE_FLOAT_BINARY128, .u = { .float_value = { .side_float_binary128 = (_val) } } }
 671 #define side_attr_string(_val)          { .type = SIDE_ATTR_TYPE_STRING, .u = { .string_value = (uintptr_t) (_val) } }
 672
 673 /* Stack-copy enumeration type definitions */
 674
 675 #define side_define_enum(_identifier, _mappings, _attr) \
 676         const struct side_enum_mappings _identifier = { \
 677                 .mappings = _mappings, \
 678                 .attr = _attr, \
 679                 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
 680                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 681         }
 682
 683 #define side_enum_mapping_list(...) \
 684         SIDE_COMPOUND_LITERAL(const struct side_enum_mapping, __VA_ARGS__)
 685
 686 #define side_enum_mapping_range(_label, _begin, _end) \
 687         { \
 688                 .range_begin = _begin, \
 689                 .range_end = _end, \
 690                 .label = _label, \
 691         }
 692
 693 #define side_enum_mapping_value(_label, _value) \
 694         { \
 695                 .range_begin = _value, \
 696                 .range_end = _value, \
 697                 .label = _label, \
 698         }
 699
 700 #define side_define_enum_bitmap(_identifier, _mappings, _attr) \
 701         const struct side_enum_bitmap_mappings _identifier = { \
 702                 .mappings = _mappings, \
 703                 .attr = _attr, \
 704                 .nr_mappings = SIDE_ARRAY_SIZE(SIDE_PARAM(_mappings)), \
 705                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 706         }
 707
 708 #define side_enum_bitmap_mapping_list(...) \
 709         SIDE_COMPOUND_LITERAL(const struct side_enum_bitmap_mapping, __VA_ARGS__)
 710
 711 #define side_enum_bitmap_mapping_range(_label, _begin, _end) \
 712         { \
 713                 .range_begin = _begin, \
 714                 .range_end = _end, \
 715                 .label = _label, \
 716         }
 717
 718 #define side_enum_bitmap_mapping_value(_label, _value) \
 719         { \
 720                 .range_begin = _value, \
 721                 .range_end = _value, \
 722                 .label = _label, \
 723         }
 724
 725 /* Stack-copy field and type definitions */
 726
 727 #define side_type_null(_attr) \
 728         { \
 729                 .type = SIDE_TYPE_NULL, \
 730                 .u = { \
 731                         .side_null = { \
 732                                 .attr = _attr, \
 733                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 734                         }, \
 735                 }, \
 736         }
 737
 738 #define side_type_bool(_attr) \
 739         { \
 740                 .type = SIDE_TYPE_BOOL, \
 741                 .u = { \
 742                         .side_bool = { \
 743                                 .attr = _attr, \
 744                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 745                                 .bool_size = sizeof(uint8_t), \
 746                                 .len_bits = 0, \
 747                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
 748                         }, \
 749                 }, \
 750         }
 751
 752 #define side_type_byte(_attr) \
 753         { \
 754                 .type = SIDE_TYPE_BYTE, \
 755                 .u = { \
 756                         .side_byte = { \
 757                                 .attr = _attr, \
 758                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 759                         }, \
 760                 }, \
 761         }
 762
 763 #define side_type_string(_attr) \
 764         { \
 765                 .type = SIDE_TYPE_STRING, \
 766                 .u = { \
 767                         .side_string = { \
 768                                 .attr = _attr, \
 769                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 770                         }, \
 771                 }, \
 772         }
 773
 774 #define side_type_dynamic() \
 775         { \
 776                 .type = SIDE_TYPE_DYNAMIC, \
 777         }
 778
 779 #define _side_type_integer(_type, _signedness, _byte_order, _integer_size, _len_bits, _attr) \
 780         { \
 781                 .type = _type, \
 782                 .u = { \
 783                         .side_integer = { \
 784                                 .attr = _attr, \
 785                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 786                                 .integer_size = _integer_size, \
 787                                 .len_bits = _len_bits, \
 788                                 .signedness = _signedness, \
 789                                 .byte_order = _byte_order, \
 790                         }, \
 791                 }, \
 792         }
 793
 794 #define _side_type_float(_type, _byte_order, _float_size, _attr) \
 795         { \
 796                 .type = _type, \
 797                 .u = { \
 798                         .side_float = { \
 799                                 .attr = _attr, \
 800                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 801                                 .float_size = _float_size, \
 802                                 .byte_order = _byte_order, \
 803                         }, \
 804                 }, \
 805         }
 806
 807 #define _side_field(_name, _type) \
 808         { \
 809                 .field_name = _name, \
 810                 .side_type = _type, \
 811         }
 812
 813 /* Host endian */
 814 #define side_type_u8(_attr)                             _side_type_integer(SIDE_TYPE_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint8_t), 0, SIDE_PARAM(_attr))
 815 #define side_type_u16(_attr)                            _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
 816 #define side_type_u32(_attr)                            _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
 817 #define side_type_u64(_attr)                            _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
 818 #define side_type_s8(_attr)                             _side_type_integer(SIDE_TYPE_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int8_t), 0, SIDE_PARAM(_attr))
 819 #define side_type_s16(_attr)                            _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int16_t), 0, SIDE_PARAM(_attr))
 820 #define side_type_s32(_attr)                            _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int32_t), 0, SIDE_PARAM(_attr))
 821 #define side_type_s64(_attr)                            _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int64_t), 0, SIDE_PARAM(_attr))
 822 #define side_type_pointer(_attr)                        _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
 823 #define side_type_float_binary16(_attr)                 _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float16), SIDE_PARAM(_attr))
 824 #define side_type_float_binary32(_attr)                 _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float32), SIDE_PARAM(_attr))
 825 #define side_type_float_binary64(_attr)                 _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float64), SIDE_PARAM(_attr))
 826 #define side_type_float_binary128(_attr)                _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, sizeof(_Float128), SIDE_PARAM(_attr))
 827
 828 #define side_field_null(_name, _attr)                   _side_field(_name, side_type_null(SIDE_PARAM(_attr)))
 829 #define side_field_bool(_name, _attr)                   _side_field(_name, side_type_bool(SIDE_PARAM(_attr)))
 830 #define side_field_u8(_name, _attr)                     _side_field(_name, side_type_u8(SIDE_PARAM(_attr)))
 831 #define side_field_u16(_name, _attr)                    _side_field(_name, side_type_u16(SIDE_PARAM(_attr)))
 832 #define side_field_u32(_name, _attr)                    _side_field(_name, side_type_u32(SIDE_PARAM(_attr)))
 833 #define side_field_u64(_name, _attr)                    _side_field(_name, side_type_u64(SIDE_PARAM(_attr)))
 834 #define side_field_s8(_name, _attr)                     _side_field(_name, side_type_s8(SIDE_PARAM(_attr)))
 835 #define side_field_s16(_name, _attr)                    _side_field(_name, side_type_s16(SIDE_PARAM(_attr)))
 836 #define side_field_s32(_name, _attr)                    _side_field(_name, side_type_s32(SIDE_PARAM(_attr)))
 837 #define side_field_s64(_name, _attr)                    _side_field(_name, side_type_s64(SIDE_PARAM(_attr)))
 838 #define side_field_byte(_name, _attr)                   _side_field(_name, side_type_byte(SIDE_PARAM(_attr)))
 839 #define side_field_pointer(_name, _attr)                _side_field(_name, side_type_pointer(SIDE_PARAM(_attr)))
 840 #define side_field_float_binary16(_name, _attr)         _side_field(_name, side_type_float_binary16(SIDE_PARAM(_attr)))
 841 #define side_field_float_binary32(_name, _attr)         _side_field(_name, side_type_float_binary32(SIDE_PARAM(_attr)))
 842 #define side_field_float_binary64(_name, _attr)         _side_field(_name, side_type_float_binary64(SIDE_PARAM(_attr)))
 843 #define side_field_float_binary128(_name, _attr)        _side_field(_name, side_type_float_binary128(SIDE_PARAM(_attr)))
 844 #define side_field_string(_name, _attr)                 _side_field(_name, side_type_string(SIDE_PARAM(_attr)))
 845 #define side_field_dynamic(_name)                       _side_field(_name, side_type_dynamic())
 846
 847 /* Little endian */
 848 #define side_type_u16_le(_attr)                         _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
 849 #define side_type_u32_le(_attr)                         _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
 850 #define side_type_u64_le(_attr)                         _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
 851 #define side_type_s16_le(_attr)                         _side_type_integer(SIDE_TYPE_S16, true, SIDE_TYPE_BYTE_ORDER_LE, sizeof(int16_t), 0, SIDE_PARAM(_attr))
 852 #define side_type_s32_le(_attr)                         _side_type_integer(SIDE_TYPE_S32, true, SIDE_TYPE_BYTE_ORDER_LE, sizeof(int32_t), 0, SIDE_PARAM(_attr))
 853 #define side_type_s64_le(_attr)                         _side_type_integer(SIDE_TYPE_S64, true, SIDE_TYPE_BYTE_ORDER_LE, sizeof(int64_t), 0, SIDE_PARAM(_attr))
 854 #define side_type_pointer_le(_attr)                     _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_LE, sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
 855 #define side_type_float_binary16_le(_attr)              _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float16), SIDE_PARAM(_attr))
 856 #define side_type_float_binary32_le(_attr)              _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float32), SIDE_PARAM(_attr))
 857 #define side_type_float_binary64_le(_attr)              _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float64), SIDE_PARAM(_attr))
 858 #define side_type_float_binary128_le(_attr)             _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_LE, sizeof(_Float128), SIDE_PARAM(_attr))
 859
 860 #define side_field_u16_le(_name, _attr)                 _side_field(_name, side_type_u16_le(SIDE_PARAM(_attr)))
 861 #define side_field_u32_le(_name, _attr)                 _side_field(_name, side_type_u32_le(SIDE_PARAM(_attr)))
 862 #define side_field_u64_le(_name, _attr)                 _side_field(_name, side_type_u64_le(SIDE_PARAM(_attr)))
 863 #define side_field_s16_le(_name, _attr)                 _side_field(_name, side_type_s16_le(SIDE_PARAM(_attr)))
 864 #define side_field_s32_le(_name, _attr)                 _side_field(_name, side_type_s32_le(SIDE_PARAM(_attr)))
 865 #define side_field_s64_le(_name, _attr)                 _side_field(_name, side_type_s64_le(SIDE_PARAM(_attr)))
 866 #define side_field_pointer_le(_name, _attr)             _side_field(_name, side_type_pointer_le(SIDE_PARAM(_attr)))
 867 #define side_field_float_binary16_le(_name, _attr)      _side_field(_name, side_type_float_binary16_le(SIDE_PARAM(_attr)))
 868 #define side_field_float_binary32_le(_name, _attr)      _side_field(_name, side_type_float_binary32_le(SIDE_PARAM(_attr)))
 869 #define side_field_float_binary64_le(_name, _attr)      _side_field(_name, side_type_float_binary64_le(SIDE_PARAM(_attr)))
 870 #define side_field_float_binary128_le(_name, _attr)     _side_field(_name, side_type_float_binary128_le(SIDE_PARAM(_attr)))
 871
 872 /* Big endian */
 873 #define side_type_u16_be(_attr)                         _side_type_integer(SIDE_TYPE_U16, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
 874 #define side_type_u32_be(_attr)                         _side_type_integer(SIDE_TYPE_U32, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
 875 #define side_type_u64_be(_attr)                         _side_type_integer(SIDE_TYPE_U64, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
 876 #define side_type_s16_be(_attr)                         _side_type_integer(SIDE_TYPE_S16, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(int16_t), 0, SIDE_PARAM(_attr))
 877 #define side_type_s32_be(_attr)                         _side_type_integer(SIDE_TYPE_S32, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(int32_t), 0, SIDE_PARAM(_attr))
 878 #define side_type_s64_be(_attr)                         _side_type_integer(SIDE_TYPE_S64, false, SIDE_TYPE_BYTE_ORDER_BE, sizeof(int64_t), 0, SIDE_PARAM(_attr))
 879 #define side_type_pointer_be(_attr)                     _side_type_integer(SIDE_TYPE_POINTER_HOST, false, SIDE_TYPE_BYTE_ORDER_BE, SIDE_BITS_PER_LONG, \
 880                                                                         SIDE_BITS_PER_LONG, SIDE_PARAM(_attr))
 881 #define side_type_float_binary16_be(_attr)              _side_type_float(SIDE_TYPE_FLOAT_BINARY16, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float16), SIDE_PARAM(_attr))
 882 #define side_type_float_binary32_be(_attr)              _side_type_float(SIDE_TYPE_FLOAT_BINARY32, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float32), SIDE_PARAM(_attr))
 883 #define side_type_float_binary64_be(_attr)              _side_type_float(SIDE_TYPE_FLOAT_BINARY64, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float64), SIDE_PARAM(_attr))
 884 #define side_type_float_binary128_be(_attr)             _side_type_float(SIDE_TYPE_FLOAT_BINARY128, SIDE_TYPE_BYTE_ORDER_BE, sizeof(_Float128), SIDE_PARAM(_attr))
 885
 886 #define side_field_u16_be(_name, _attr)                 _side_field(_name, side_type_u16_be(SIDE_PARAM(_attr)))
 887 #define side_field_u32_be(_name, _attr)                 _side_field(_name, side_type_u32_be(SIDE_PARAM(_attr)))
 888 #define side_field_u64_be(_name, _attr)                 _side_field(_name, side_type_u64_be(SIDE_PARAM(_attr)))
 889 #define side_field_s16_be(_name, _attr)                 _side_field(_name, side_type_s16_be(SIDE_PARAM(_attr)))
 890 #define side_field_s32_be(_name, _attr)                 _side_field(_name, side_type_s32_be(SIDE_PARAM(_attr)))
 891 #define side_field_s64_be(_name, _attr)                 _side_field(_name, side_type_s64_be(SIDE_PARAM(_attr)))
 892 #define side_field_pointer_be(_name, _attr)             _side_field(_name, side_type_pointer_be(SIDE_PARAM(_attr)))
 893 #define side_field_float_binary16_be(_name, _attr)      _side_field(_name, side_type_float_binary16_be(SIDE_PARAM(_attr)))
 894 #define side_field_float_binary32_be(_name, _attr)      _side_field(_name, side_type_float_binary32_be(SIDE_PARAM(_attr)))
 895 #define side_field_float_binary64_be(_name, _attr)      _side_field(_name, side_type_float_binary64_be(SIDE_PARAM(_attr)))
 896 #define side_field_float_binary128_be(_name, _attr)     _side_field(_name, side_type_float_binary128_be(SIDE_PARAM(_attr)))
 897
 898 #define side_type_enum(_mappings, _elem_type) \
 899         { \
 900                 .type = SIDE_TYPE_ENUM, \
 901                 .u = { \
 902                         .side_enum = { \
 903                                 .mappings = _mappings, \
 904                                 .elem_type = _elem_type, \
 905                         }, \
 906                 }, \
 907         }
 908 #define side_field_enum(_name, _mappings, _elem_type) \
 909         _side_field(_name, side_type_enum(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
 910
 911 #define side_type_enum_bitmap(_mappings, _elem_type) \
 912         { \
 913                 .type = SIDE_TYPE_ENUM_BITMAP, \
 914                 .u = { \
 915                         .side_enum_bitmap = { \
 916                                 .mappings = _mappings, \
 917                                 .elem_type = _elem_type, \
 918                         }, \
 919                 }, \
 920         }
 921 #define side_field_enum_bitmap(_name, _mappings, _elem_type) \
 922         _side_field(_name, side_type_enum_bitmap(SIDE_PARAM(_mappings), SIDE_PARAM(_elem_type)))
 923
 924 #define side_type_struct(_struct) \
 925         { \
 926                 .type = SIDE_TYPE_STRUCT, \
 927                 .u = { \
 928                         .side_struct = _struct, \
 929                 }, \
 930         }
 931 #define side_field_struct(_name, _struct) \
 932         _side_field(_name, side_type_struct(SIDE_PARAM(_struct)))
 933
 934 #define _side_type_struct_define(_fields, _attr) \
 935         { \
 936                 .fields = _fields, \
 937                 .attr = _attr, \
 938                 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
 939                 .nr_attr  = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 940         }
 941
 942 #define side_define_struct(_identifier, _fields, _attr) \
 943         const struct side_type_struct _identifier = _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr))
 944
 945 #define side_struct_literal(_fields, _attr) \
 946         SIDE_COMPOUND_LITERAL(const struct side_type_struct, \
 947                 _side_type_struct_define(SIDE_PARAM(_fields), SIDE_PARAM(_attr)))
 948
 949 #define side_type_array(_elem_type, _length, _attr) \
 950         { \
 951                 .type = SIDE_TYPE_ARRAY, \
 952                 .u = { \
 953                         .side_array = { \
 954                                 .elem_type = _elem_type, \
 955                                 .attr = _attr, \
 956                                 .length = _length, \
 957                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 958                         }, \
 959                 }, \
 960         }
 961 #define side_field_array(_name, _elem_type, _length, _attr) \
 962         _side_field(_name, side_type_array(SIDE_PARAM(_elem_type), _length, SIDE_PARAM(_attr)))
 963
 964 #define side_type_vla(_elem_type, _attr) \
 965         { \
 966                 .type = SIDE_TYPE_VLA, \
 967                 .u = { \
 968                         .side_vla = { \
 969                                 .elem_type = _elem_type, \
 970                                 .attr = _attr, \
 971                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 972                         }, \
 973                 }, \
 974         }
 975 #define side_field_vla(_name, _elem_type, _attr) \
 976         _side_field(_name, side_type_vla(SIDE_PARAM(_elem_type), SIDE_PARAM(_attr)))
 977
 978 #define side_type_vla_visitor(_elem_type, _visitor, _attr) \
 979         { \
 980                 .type = SIDE_TYPE_VLA_VISITOR, \
 981                 .u = { \
 982                         .side_vla_visitor = { \
 983                                 .elem_type = SIDE_PARAM(_elem_type), \
 984                                 .visitor = _visitor, \
 985                                 .attr = _attr, \
 986                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
 987                         }, \
 988                 }, \
 989         }
 990 #define side_field_vla_visitor(_name, _elem_type, _visitor, _attr) \
 991         _side_field(_name, side_type_vla_visitor(SIDE_PARAM(_elem_type), _visitor, SIDE_PARAM(_attr)))
 992
 993 /* Gather field and type definitions */
 994
 995 #define side_type_gather_byte(_offset, _access_mode, _attr) \
 996         { \
 997                 .type = SIDE_TYPE_GATHER_BYTE, \
 998                 .u = { \
 999                         .side_gather = { \
1000                                 .u = { \
1001                                         .side_byte = { \
1002                                                 .offset = _offset, \
1003                                                 .access_mode = _access_mode, \
1004                                                 .type = { \
1005                                                         .attr = _attr, \
1006                                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1007                                                 }, \
1008                                         }, \
1009                                 }, \
1010                         }, \
1011                 }, \
1012         }
1013 #define side_field_gather_byte(_name, _offset, _access_mode, _attr) \
1014         _side_field(_name, side_type_gather_byte(_offset, _access_mode, SIDE_PARAM(_attr)))
1015
1016 #define _side_type_gather_bool(_byte_order, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1017         { \
1018                 .type = SIDE_TYPE_GATHER_BOOL, \
1019                 .u = { \
1020                         .side_gather = { \
1021                                 .u = { \
1022                                         .side_bool = { \
1023                                                 .offset = _offset, \
1024                                                 .access_mode = _access_mode, \
1025                                                 .type = { \
1026                                                         .attr = _attr, \
1027                                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1028                                                         .bool_size = _bool_size, \
1029                                                         .len_bits = _len_bits, \
1030                                                         .byte_order = _byte_order, \
1031                                                 }, \
1032                                                 .offset_bits = _offset_bits, \
1033                                         }, \
1034                                 }, \
1035                         }, \
1036                 }, \
1037         }
1038 #define side_type_gather_bool(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1039         _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_HOST, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1040 #define side_type_gather_bool_le(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1041         _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_LE, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1042 #define side_type_gather_bool_be(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1043         _side_type_gather_bool(SIDE_TYPE_BYTE_ORDER_BE, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr)
1044
1045 #define side_field_gather_bool(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1046         _side_field(_name, side_type_gather_bool(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1047 #define side_field_gather_bool_le(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1048         _side_field(_name, side_type_gather_bool_le(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1049 #define side_field_gather_bool_be(_name, _offset, _bool_size, _offset_bits, _len_bits, _access_mode, _attr) \
1050         _side_field(_name, side_type_gather_bool_be(_offset, _bool_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1051
1052 #define _side_type_gather_integer(_type, _signedness, _byte_order, _offset, \
1053                 _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1054         { \
1055                 .type = _type, \
1056                 .u = { \
1057                         .side_gather = { \
1058                                 .u = { \
1059                                         .side_integer = { \
1060                                                 .offset = _offset, \
1061                                                 .access_mode = _access_mode, \
1062                                                 .type = { \
1063                                                         .attr = _attr, \
1064                                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1065                                                         .integer_size = _integer_size, \
1066                                                         .len_bits = _len_bits, \
1067                                                         .signedness = _signedness, \
1068                                                         .byte_order = _byte_order, \
1069                                                 }, \
1070                                                 .offset_bits = _offset_bits, \
1071                                         }, \
1072                                 }, \
1073                         }, \
1074                 }, \
1075         }
1076
1077 #define side_type_gather_unsigned_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1078         _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false,  SIDE_TYPE_BYTE_ORDER_HOST, \
1079                         _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1080 #define side_type_gather_signed_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1081         _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_HOST, \
1082                         _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1083
1084 #define side_type_gather_unsigned_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1085         _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false,  SIDE_TYPE_BYTE_ORDER_LE, \
1086                         _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1087 #define side_type_gather_signed_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1088         _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_LE, \
1089                         _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1090
1091 #define side_type_gather_unsigned_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1092         _side_type_gather_integer(SIDE_TYPE_GATHER_UNSIGNED_INT, false,  SIDE_TYPE_BYTE_ORDER_BE, \
1093                         _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1094 #define side_type_gather_signed_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1095         _side_type_gather_integer(SIDE_TYPE_GATHER_SIGNED_INT, true, SIDE_TYPE_BYTE_ORDER_BE, \
1096                         _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr))
1097
1098 #define side_field_gather_unsigned_integer(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1099         _side_field(_name, side_type_gather_unsigned_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1100 #define side_field_gather_signed_integer(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1101         _side_field(_name, side_type_gather_signed_integer(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1102
1103 #define side_field_gather_unsigned_integer_le(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1104         _side_field(_name, side_type_gather_unsigned_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1105 #define side_field_gather_signed_integer_le(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1106         _side_field(_name, side_type_gather_signed_integer_le(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1107
1108 #define side_field_gather_unsigned_integer_be(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1109         _side_field(_name, side_type_gather_unsigned_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1110 #define side_field_gather_signed_integer_be(_name, _integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, _attr) \
1111         _side_field(_name, side_type_gather_signed_integer_be(_integer_offset, _integer_size, _offset_bits, _len_bits, _access_mode, SIDE_PARAM(_attr)))
1112
1113 #define _side_type_gather_float(_byte_order, _offset, _float_size, _access_mode, _attr) \
1114         { \
1115                 .type = SIDE_TYPE_GATHER_FLOAT, \
1116                 .u = { \
1117                         .side_gather = { \
1118                                 .u = { \
1119                                         .side_float = { \
1120                                                 .offset = _offset, \
1121                                                 .access_mode = _access_mode, \
1122                                                 .type = { \
1123                                                         .attr = _attr, \
1124                                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1125                                                         .float_size = _float_size, \
1126                                                         .byte_order = _byte_order, \
1127                                                 }, \
1128                                         }, \
1129                                 }, \
1130                         }, \
1131                 }, \
1132         }
1133
1134 #define side_type_gather_float(_offset, _float_size, _access_mode, _attr) \
1135         _side_type_gather_float(SIDE_TYPE_FLOAT_WORD_ORDER_HOST, _offset, _float_size, _access_mode, _attr)
1136 #define side_type_gather_float_le(_offset, _float_size, _access_mode, _attr) \
1137         _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_LE, _offset, _float_size, _access_mode, _attr)
1138 #define side_type_gather_float_be(_offset, _float_size, _access_mode, _attr) \
1139         _side_type_gather_float(SIDE_TYPE_BYTE_ORDER_BE, _offset, _float_size, _access_mode, _attr)
1140
1141 #define side_field_gather_float(_name, _offset, _float_size, _access_mode, _attr) \
1142         _side_field(_name, side_type_gather_float(_offset, _float_size, _access_mode, _attr))
1143 #define side_field_gather_float_le(_name, _offset, _float_size, _access_mode, _attr) \
1144         _side_field(_name, side_type_gather_float_le(_offset, _float_size, _access_mode, _attr))
1145 #define side_field_gather_float_be(_name, _offset, _float_size, _access_mode, _attr) \
1146         _side_field(_name, side_type_gather_float_be(_offset, _float_size, _access_mode, _attr))
1147
1148 #define side_type_gather_struct(_struct_gather, _offset, _size, _access_mode) \
1149         { \
1150                 .type = SIDE_TYPE_GATHER_STRUCT, \
1151                 .u = { \
1152                         .side_gather = { \
1153                                 .u = { \
1154                                         .side_struct = { \
1155                                                 .offset = _offset, \
1156                                                 .access_mode = _access_mode, \
1157                                                 .type = _struct_gather, \
1158                                                 .size = _size, \
1159                                         }, \
1160                                 }, \
1161                         }, \
1162                 }, \
1163         }
1164 #define side_field_gather_struct(_name, _struct_gather, _offset, _size, _access_mode) \
1165         _side_field(_name, side_type_gather_struct(SIDE_PARAM(_struct_gather), _offset, _size, _access_mode))
1166
1167 #define side_type_gather_array(_elem_type_gather, _length, _offset, _access_mode, _attr) \
1168         { \
1169                 .type = SIDE_TYPE_GATHER_ARRAY, \
1170                 .u = { \
1171                         .side_gather = { \
1172                                 .u = { \
1173                                         .side_array = { \
1174                                                 .offset = _offset, \
1175                                                 .access_mode = _access_mode, \
1176                                                 .type = { \
1177                                                         .elem_type = _elem_type_gather, \
1178                                                         .attr = _attr, \
1179                                                         .length = _length, \
1180                                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1181                                                 }, \
1182                                         }, \
1183                                 }, \
1184                         }, \
1185                 }, \
1186         }
1187 #define side_field_gather_array(_name, _elem_type, _length, _offset, _access_mode, _attr) \
1188         _side_field(_name, side_type_gather_array(SIDE_PARAM(_elem_type), _length, _offset, _access_mode, SIDE_PARAM(_attr)))
1189
1190 #define side_type_gather_vla(_elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1191         { \
1192                 .type = SIDE_TYPE_GATHER_VLA, \
1193                 .u = { \
1194                         .side_gather = { \
1195                                 .u = { \
1196                                         .side_vla = { \
1197                                                 .offset = _offset, \
1198                                                 .access_mode = _access_mode, \
1199                                                 .type = { \
1200                                                         .elem_type = _elem_type_gather, \
1201                                                         .attr = _attr, \
1202                                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1203                                                 }, \
1204                                                 .length_type = _length_type_gather, \
1205                                         }, \
1206                                 }, \
1207                         }, \
1208                 }, \
1209         }
1210 #define side_field_gather_vla(_name, _elem_type_gather, _offset, _access_mode, _length_type_gather, _attr) \
1211         _side_field(_name, side_type_gather_vla(SIDE_PARAM(_elem_type_gather), _offset, _access_mode, SIDE_PARAM(_length_type_gather), SIDE_PARAM(_attr)))
1212
1213 #define side_elem(...) \
1214         SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1215
1216 #define side_length(...) \
1217         SIDE_COMPOUND_LITERAL(const struct side_type, __VA_ARGS__)
1218
1219 #define side_field_list(...) \
1220         SIDE_COMPOUND_LITERAL(const struct side_event_field, __VA_ARGS__)
1221
1222 /* Stack-copy field arguments */
1223
1224 #define side_arg_null(_val)             { .type = SIDE_TYPE_NULL }
1225 #define side_arg_bool(_val)             { .type = SIDE_TYPE_BOOL, .u = { .side_static = { .bool_value.side_bool8 = !!(_val) } } }
1226 #define side_arg_byte(_val)             { .type = SIDE_TYPE_BYTE, .u = { .side_static = { .byte_value = (_val) } } }
1227 #define side_arg_string(_val)           { .type = SIDE_TYPE_STRING, .u = { .side_static = { .string_value = (uintptr_t) (_val) } } }
1228
1229 #define side_arg_u8(_val)               { .type = SIDE_TYPE_U8, .u = { .side_static = {  .integer_value = { .side_u8 = (_val) } } } }
1230 #define side_arg_u16(_val)              { .type = SIDE_TYPE_U16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1231 #define side_arg_u32(_val)              { .type = SIDE_TYPE_U32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1232 #define side_arg_u64(_val)              { .type = SIDE_TYPE_U64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1233 #define side_arg_s8(_val)               { .type = SIDE_TYPE_S8, .u = { .side_static = { .integer_value = { .side_s8 = (_val) } } } }
1234 #define side_arg_s16(_val)              { .type = SIDE_TYPE_S16, .u = { .side_static = { .integer_value = { .side_s16 = (_val) } } } }
1235 #define side_arg_s32(_val)              { .type = SIDE_TYPE_S32, .u = { .side_static = { .integer_value = { .side_s32 = (_val) } } } }
1236 #define side_arg_s64(_val)              { .type = SIDE_TYPE_S64, .u = { .side_static = { .integer_value = { .side_s64 = (_val) } } } }
1237 #define side_arg_pointer(_val)          { .type = SIDE_TYPE_POINTER_HOST, .u = { .side_static = { .integer_value = { SIDE_PTR_HOST = (uintptr_t) (_val) } } } }
1238 #define side_arg_enum_bitmap8(_val)     { .type = SIDE_TYPE_ENUM_BITMAP8, .u = { .side_static = { .integer_value = { .side_u8 = (_val) } } } }
1239 #define side_arg_enum_bitmap16(_val)    { .type = SIDE_TYPE_ENUM_BITMAP16, .u = { .side_static = { .integer_value = { .side_u16 = (_val) } } } }
1240 #define side_arg_enum_bitmap32(_val)    { .type = SIDE_TYPE_ENUM_BITMAP32, .u = { .side_static = { .integer_value = { .side_u32 = (_val) } } } }
1241 #define side_arg_enum_bitmap64(_val)    { .type = SIDE_TYPE_ENUM_BITMAP64, .u = { .side_static = { .integer_value = { .side_u64 = (_val) } } } }
1242 #define side_arg_enum_bitmap_array(_side_type)  { .type = SIDE_TYPE_ENUM_BITMAP_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1243 #define side_arg_enum_bitmap_vla(_side_type)    { .type = SIDE_TYPE_ENUM_BITMAP_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1244 #define side_arg_float_binary16(_val)   { .type = SIDE_TYPE_FLOAT_BINARY16, .u = { .side_static = { .float_value = { .side_float_binary16 = (_val) } } } }
1245 #define side_arg_float_binary32(_val)   { .type = SIDE_TYPE_FLOAT_BINARY32, .u = { .side_static = { .float_value = { .side_float_binary32 = (_val) } } } }
1246 #define side_arg_float_binary64(_val)   { .type = SIDE_TYPE_FLOAT_BINARY64, .u = { .side_static = { .float_value = { .side_float_binary64 = (_val) } } } }
1247 #define side_arg_float_binary128(_val)  { .type = SIDE_TYPE_FLOAT_BINARY128, .u = { .side_static = { .float_value = { .side_float_binary128 = (_val) } } } }
1248
1249 #define side_arg_struct(_side_type)     { .type = SIDE_TYPE_STRUCT, .u = { .side_static = { .side_struct = (_side_type) } } }
1250 #define side_arg_array(_side_type)      { .type = SIDE_TYPE_ARRAY, .u = { .side_static = { .side_array = (_side_type) } } }
1251 #define side_arg_vla(_side_type)        { .type = SIDE_TYPE_VLA, .u = { .side_static = { .side_vla = (_side_type) } } }
1252 #define side_arg_vla_visitor(_ctx)      { .type = SIDE_TYPE_VLA_VISITOR, .u = { .side_static = { .side_vla_app_visitor_ctx = (_ctx) } } }
1253
1254 /* Gather field arguments */
1255
1256 #define side_arg_gather_bool(_ptr)              { .type = SIDE_TYPE_GATHER_BOOL, .u = { .side_static = { .side_bool_gather_ptr = (_ptr) } } }
1257 #define side_arg_gather_byte(_ptr)              { .type = SIDE_TYPE_GATHER_BYTE, .u = { .side_static = { .side_byte_gather_ptr = (_ptr) } } }
1258 #define side_arg_gather_unsigned_integer(_ptr)  { .type = SIDE_TYPE_GATHER_UNSIGNED_INT, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1259 #define side_arg_gather_signed_integer(_ptr)    { .type = SIDE_TYPE_GATHER_SIGNED_INT, .u = { .side_static = { .side_integer_gather_ptr = (_ptr) } } }
1260 #define side_arg_gather_float(_ptr)             { .type = SIDE_TYPE_GATHER_FLOAT, .u = { .side_static = { .side_float_gather_ptr = (_ptr) } } }
1261 #define side_arg_gather_struct(_ptr)            { .type = SIDE_TYPE_GATHER_STRUCT, .u = { .side_static = { .side_struct_gather_ptr = (_ptr) } } }
1262 #define side_arg_gather_array(_ptr)             { .type = SIDE_TYPE_GATHER_ARRAY, .u = { .side_static = { .side_array_gather_ptr = (_ptr) } } }
1263 #define side_arg_gather_vla(_ptr, _length_ptr)  { .type = SIDE_TYPE_GATHER_VLA, .u = { .side_static = { .side_vla_gather = { .ptr = (_ptr), .length_ptr = (_length_ptr) } } } }
1264
1265 /* Dynamic field arguments */
1266
1267 #define side_arg_dynamic_null(_attr) \
1268         { \
1269                 .type = SIDE_TYPE_DYNAMIC_NULL, \
1270                 .u = { \
1271                         .side_dynamic = { \
1272                                 .side_null = { \
1273                                         .attr = _attr, \
1274                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1275                                 }, \
1276                         }, \
1277                 }, \
1278         }
1279
1280 #define side_arg_dynamic_bool(_val, _attr) \
1281         { \
1282                 .type = SIDE_TYPE_DYNAMIC_BOOL, \
1283                 .u = { \
1284                         .side_dynamic = { \
1285                                 .side_bool = { \
1286                                         .type = { \
1287                                                 .attr = _attr, \
1288                                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1289                                                 .bool_size = sizeof(uint8_t), \
1290                                                 .len_bits = 0, \
1291                                                 .byte_order = SIDE_TYPE_BYTE_ORDER_HOST, \
1292                                         }, \
1293                                         .value = { \
1294                                                 .side_bool8 = !!(_val), \
1295                                         }, \
1296                                 }, \
1297                         }, \
1298                 }, \
1299         }
1300
1301 #define side_arg_dynamic_byte(_val, _attr) \
1302         { \
1303                 .type = SIDE_TYPE_DYNAMIC_BYTE, \
1304                 .u = { \
1305                         .side_dynamic = { \
1306                                 .side_byte = { \
1307                                         .type = { \
1308                                                 .attr = _attr, \
1309                                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1310                                         }, \
1311                                         .value = (_val), \
1312                                 }, \
1313                         }, \
1314                 }, \
1315         }
1316 #define side_arg_dynamic_string(_val, _attr) \
1317         { \
1318                 .type = SIDE_TYPE_DYNAMIC_STRING, \
1319                 .u = { \
1320                         .side_dynamic = { \
1321                                 .side_string = { \
1322                                         .type = { \
1323                                                 .attr = _attr, \
1324                                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1325                                         }, \
1326                                         .value = (uintptr_t) (_val), \
1327                                 }, \
1328                         }, \
1329                 }, \
1330         }
1331
1332 #define _side_arg_dynamic_integer(_field, _val, _type, _signedness, _byte_order, _integer_size, _len_bits, _attr) \
1333         { \
1334                 .type = _type, \
1335                 .u = { \
1336                         .side_dynamic = { \
1337                                 .side_integer = { \
1338                                         .type = { \
1339                                                 .attr = _attr, \
1340                                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1341                                                 .integer_size = _integer_size, \
1342                                                 .len_bits = _len_bits, \
1343                                                 .signedness = _signedness, \
1344                                                 .byte_order = _byte_order, \
1345                                         }, \
1346                                         .value = { \
1347                                                 _field = (_val), \
1348                                         }, \
1349                                 }, \
1350                         }, \
1351                 }, \
1352         }
1353
1354 #define side_arg_dynamic_u8(_val, _attr) \
1355         _side_arg_dynamic_integer(.side_u8, _val, SIDE_TYPE_DYNAMIC_U8, false, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(uint8_t), 0, SIDE_PARAM(_attr))
1356 #define side_arg_dynamic_s8(_val, _attr) \
1357         _side_arg_dynamic_integer(.side_s8, _val, SIDE_TYPE_DYNAMIC_S8, true, SIDE_TYPE_BYTE_ORDER_HOST, sizeof(int8_t), 0, SIDE_PARAM(_attr))
1358
1359 #define _side_arg_dynamic_u16(_val, _byte_order, _attr) \
1360         _side_arg_dynamic_integer(.side_u16, _val, SIDE_TYPE_DYNAMIC_U16, false, _byte_order, sizeof(uint16_t), 0, SIDE_PARAM(_attr))
1361 #define _side_arg_dynamic_u32(_val, _byte_order, _attr) \
1362         _side_arg_dynamic_integer(.side_u32, _val, SIDE_TYPE_DYNAMIC_U32, false, _byte_order, sizeof(uint32_t), 0, SIDE_PARAM(_attr))
1363 #define _side_arg_dynamic_u64(_val, _byte_order, _attr) \
1364         _side_arg_dynamic_integer(.side_u64, _val, SIDE_TYPE_DYNAMIC_U64, false, _byte_order, sizeof(uint64_t), 0, SIDE_PARAM(_attr))
1365
1366 #define _side_arg_dynamic_s16(_val, _byte_order, _attr) \
1367         _side_arg_dynamic_integer(.side_s16, _val, SIDE_TYPE_DYNAMIC_S16, true, _byte_order, sizeof(int16_t), 0, SIDE_PARAM(_attr))
1368 #define _side_arg_dynamic_s32(_val, _byte_order, _attr) \
1369         _side_arg_dynamic_integer(.side_s32, _val, SIDE_TYPE_DYNAMIC_S32, true, _byte_order, sizeof(int32_t), 0, SIDE_PARAM(_attr))
1370 #define _side_arg_dynamic_s64(_val, _byte_order, _attr) \
1371         _side_arg_dynamic_integer(.side_s64, _val, SIDE_TYPE_DYNAMIC_S64, true, _byte_order, sizeof(int64_t), 0, SIDE_PARAM(_attr))
1372
1373 #define _side_arg_dynamic_pointer(_val, _byte_order, _attr) \
1374         _side_arg_dynamic_integer(SIDE_PTR_HOST, (uintptr_t) (_val), SIDE_TYPE_DYNAMIC_POINTER_HOST, false, _byte_order, \
1375                         sizeof(uintptr_t), 0, SIDE_PARAM(_attr))
1376
1377 #define _side_arg_dynamic_float(_field, _val, _type, _byte_order, _float_size, _attr) \
1378         { \
1379                 .type = _type, \
1380                 .u = { \
1381                         .side_dynamic = { \
1382                                 .side_float = { \
1383                                         .type = { \
1384                                                 .attr = _attr, \
1385                                                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1386                                                 .float_size = _float_size, \
1387                                                 .byte_order = _byte_order, \
1388                                         }, \
1389                                         .value = { \
1390                                                 _field = (_val), \
1391                                         }, \
1392                                 }, \
1393                         }, \
1394                 }, \
1395         }
1396
1397 #define _side_arg_dynamic_float_binary16(_val, _byte_order, _attr) \
1398         _side_arg_dynamic_float(.side_float_binary16, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY16, _byte_order, sizeof(_Float16), SIDE_PARAM(_attr))
1399 #define _side_arg_dynamic_float_binary32(_val, _byte_order, _attr) \
1400         _side_arg_dynamic_float(.side_float_binary32, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY32, _byte_order, sizeof(_Float32), SIDE_PARAM(_attr))
1401 #define _side_arg_dynamic_float_binary64(_val, _byte_order, _attr) \
1402         _side_arg_dynamic_float(.side_float_binary64, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY64, _byte_order, sizeof(_Float64), SIDE_PARAM(_attr))
1403 #define _side_arg_dynamic_float_binary128(_val, _byte_order, _attr) \
1404         _side_arg_dynamic_float(.side_float_binary128, _val, SIDE_TYPE_DYNAMIC_FLOAT_BINARY128, _byte_order, sizeof(_Float128), SIDE_PARAM(_attr))
1405
1406 /* Host endian */
1407 #define side_arg_dynamic_u16(_val, _attr)               _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1408 #define side_arg_dynamic_u32(_val, _attr)               _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1409 #define side_arg_dynamic_u64(_val, _attr)               _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1410 #define side_arg_dynamic_s16(_val, _attr)               _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1411 #define side_arg_dynamic_s32(_val, _attr)               _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1412 #define side_arg_dynamic_s64(_val, _attr)               _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1413 #define side_arg_dynamic_pointer(_val, _attr)           _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_HOST, SIDE_PARAM(_attr))
1414 #define side_arg_dynamic_float_binary16(_val, _attr)    _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1415 #define side_arg_dynamic_float_binary32(_val, _attr)    _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1416 #define side_arg_dynamic_float_binary64(_val, _attr)    _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1417 #define side_arg_dynamic_float_binary128(_val, _attr)   _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_FLOAT_WORD_ORDER_HOST, SIDE_PARAM(_attr))
1418
1419 /* Little endian */
1420 #define side_arg_dynamic_u16_le(_val, _attr)                    _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1421 #define side_arg_dynamic_u32_le(_val, _attr)                    _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1422 #define side_arg_dynamic_u64_le(_val, _attr)                    _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1423 #define side_arg_dynamic_s16_le(_val, _attr)                    _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1424 #define side_arg_dynamic_s32_le(_val, _attr)                    _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1425 #define side_arg_dynamic_s64_le(_val, _attr)                    _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1426 #define side_arg_dynamic_pointer_le(_val, _attr)                _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1427 #define side_arg_dynamic_float_binary16_le(_val, _attr)         _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1428 #define side_arg_dynamic_float_binary32_le(_val, _attr)         _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1429 #define side_arg_dynamic_float_binary64_le(_val, _attr)         _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1430 #define side_arg_dynamic_float_binary128_le(_val, _attr)        _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_LE, SIDE_PARAM(_attr))
1431
1432 /* Big endian */
1433 #define side_arg_dynamic_u16_be(_val, _attr)                    _side_arg_dynamic_u16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1434 #define side_arg_dynamic_u32_be(_val, _attr)                    _side_arg_dynamic_u32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1435 #define side_arg_dynamic_u64_be(_val, _attr)                    _side_arg_dynamic_u64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1436 #define side_arg_dynamic_s16_be(_val, _attr)                    _side_arg_dynamic_s16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1437 #define side_arg_dynamic_s32_be(_val, _attr)                    _side_arg_dynamic_s32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1438 #define side_arg_dynamic_s64_be(_val, _attr)                    _side_arg_dynamic_s64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1439 #define side_arg_dynamic_pointer_be(_val, _attr)                _side_arg_dynamic_pointer(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1440 #define side_arg_dynamic_float_binary16_be(_val, _attr)         _side_arg_dynamic_float_binary16(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1441 #define side_arg_dynamic_float_binary32_be(_val, _attr)         _side_arg_dynamic_float_binary32(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1442 #define side_arg_dynamic_float_binary64_be(_val, _attr)         _side_arg_dynamic_float_binary64(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1443 #define side_arg_dynamic_float_binary128_be(_val, _attr)        _side_arg_dynamic_float_binary128(_val, SIDE_TYPE_BYTE_ORDER_BE, SIDE_PARAM(_attr))
1444
1445 #define side_arg_dynamic_vla(_vla) \
1446         { \
1447                 .type = SIDE_TYPE_DYNAMIC_VLA, \
1448                 .u = { \
1449                         .side_dynamic = { \
1450                                 .side_dynamic_vla = (_vla), \
1451                         }, \
1452                 }, \
1453         }
1454
1455 #define side_arg_dynamic_vla_visitor(_dynamic_vla_visitor, _ctx, _attr) \
1456         { \
1457                 .type = SIDE_TYPE_DYNAMIC_VLA_VISITOR, \
1458                 .u = { \
1459                         .side_dynamic = { \
1460                                 .side_dynamic_vla_visitor = { \
1461                                         .app_ctx = _ctx, \
1462                                         .visitor = _dynamic_vla_visitor, \
1463                                         .attr = _attr, \
1464                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1465                                 }, \
1466                         }, \
1467                 }, \
1468         }
1469
1470 #define side_arg_dynamic_struct(_struct) \
1471         { \
1472                 .type = SIDE_TYPE_DYNAMIC_STRUCT, \
1473                 .u = { \
1474                         .side_dynamic = { \
1475                                 .side_dynamic_struct = (_struct), \
1476                         }, \
1477                 }, \
1478         }
1479
1480 #define side_arg_dynamic_struct_visitor(_dynamic_struct_visitor, _ctx, _attr) \
1481         { \
1482                 .type = SIDE_TYPE_DYNAMIC_STRUCT_VISITOR, \
1483                 .u = { \
1484                         .side_dynamic = { \
1485                                 .side_dynamic_struct_visitor = { \
1486                                         .app_ctx = _ctx, \
1487                                         .visitor = _dynamic_struct_visitor, \
1488                                         .attr = _attr, \
1489                                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1490                                 }, \
1491                         }, \
1492                 }, \
1493         }
1494
1495 #define side_arg_dynamic_define_vec(_identifier, _sav, _attr) \
1496         const struct side_arg _identifier##_vec[] = { _sav }; \
1497         const struct side_arg_dynamic_vla _identifier = { \
1498                 .sav = _identifier##_vec, \
1499                 .attr = _attr, \
1500                 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1501                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1502         }
1503
1504 #define side_arg_dynamic_define_struct(_identifier, _struct_fields, _attr) \
1505         const struct side_arg_dynamic_field _identifier##_fields[] = { _struct_fields }; \
1506         const struct side_arg_dynamic_struct _identifier = { \
1507                 .fields = _identifier##_fields, \
1508                 .attr = _attr, \
1509                 .len = SIDE_ARRAY_SIZE(_identifier##_fields), \
1510                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1511         }
1512
1513 #define side_arg_define_vec(_identifier, _sav) \
1514         const struct side_arg _identifier##_vec[] = { _sav }; \
1515         const struct side_arg_vec _identifier = { \
1516                 .sav = _identifier##_vec, \
1517                 .len = SIDE_ARRAY_SIZE(_identifier##_vec), \
1518         }
1519
1520 #define side_arg_dynamic_field(_name, _elem) \
1521         { \
1522                 .field_name = _name, \
1523                 .elem = _elem, \
1524         }
1525
1526 /*
1527  * Event instrumentation description registration, runtime enabled state
1528  * check, and instrumentation invocation.
1529  */
1530
1531 #define side_arg_list(...)      __VA_ARGS__
1532
1533 #define side_event_cond(_identifier) \
1534         if (side_unlikely(__atomic_load_n(&side_event_enable__##_identifier, \
1535                                         __ATOMIC_RELAXED)))
1536
1537 #define side_event_call(_identifier, _sav) \
1538         { \
1539                 const struct side_arg side_sav[] = { _sav }; \
1540                 const struct side_arg_vec side_arg_vec = { \
1541                         .sav = side_sav, \
1542                         .len = SIDE_ARRAY_SIZE(side_sav), \
1543                 }; \
1544                 side_call(&(_identifier), &side_arg_vec); \
1545         }
1546
1547 #define side_event(_identifier, _sav) \
1548         side_event_cond(_identifier) \
1549                 side_event_call(_identifier, SIDE_PARAM(_sav))
1550
1551 #define side_event_call_variadic(_identifier, _sav, _var_fields, _attr) \
1552         { \
1553                 const struct side_arg side_sav[] = { _sav }; \
1554                 const struct side_arg_vec side_arg_vec = { \
1555                         .sav = side_sav, \
1556                         .len = SIDE_ARRAY_SIZE(side_sav), \
1557                 }; \
1558                 const struct side_arg_dynamic_field side_fields[] = { _var_fields }; \
1559                 const struct side_arg_dynamic_struct var_struct = { \
1560                         .fields = side_fields, \
1561                         .attr = _attr, \
1562                         .len = SIDE_ARRAY_SIZE(side_fields), \
1563                         .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1564                 }; \
1565                 side_call_variadic(&(_identifier), &side_arg_vec, &var_struct); \
1566         }
1567
1568 #define side_event_variadic(_identifier, _sav, _var, _attr) \
1569         side_event_cond(_identifier) \
1570                 side_event_call_variadic(_identifier, SIDE_PARAM(_sav), SIDE_PARAM(_var), SIDE_PARAM(_attr))
1571
1572 #define _side_define_event(_linkage, _identifier, _provider, _event, _loglevel, _fields, _attr, _flags) \
1573         _linkage uintptr_t side_event_enable__##_identifier __attribute__((section("side_event_enable"))); \
1574         _linkage struct side_event_description __attribute__((section("side_event_description"))) \
1575                         _identifier = { \
1576                 .enabled = &(side_event_enable__##_identifier), \
1577                 .provider_name = _provider, \
1578                 .event_name = _event, \
1579                 .fields = _fields, \
1580                 .attr = _attr, \
1581                 .callbacks = &side_empty_callback, \
1582                 .flags = (_flags), \
1583                 .version = 0, \
1584                 .loglevel = _loglevel, \
1585                 .nr_fields = SIDE_ARRAY_SIZE(SIDE_PARAM(_fields)), \
1586                 .nr_attr = SIDE_ARRAY_SIZE(SIDE_PARAM(_attr)), \
1587                 .nr_callbacks = 0, \
1588         }; \
1589         static const struct side_event_description *side_event_ptr__##_identifier \
1590                 __attribute__((section("side_event_description_ptr"), used)) = &(_identifier);
1591
1592 #define side_static_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1593         _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1594                         SIDE_PARAM(_attr), 0)
1595
1596 #define side_static_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1597         _side_define_event(static, _identifier, _provider, _event, _loglevel, SIDE_PARAM(_fields), \
1598                         SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1599
1600 #define side_hidden_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1601         _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, \
1602                         _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), 0)
1603
1604 #define side_hidden_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1605         _side_define_event(__attribute__((visibility("hidden"))), _identifier, _provider, _event, \
1606                         _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1607
1608 #define side_export_event(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1609         _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, \
1610                         _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), 0)
1611
1612 #define side_export_event_variadic(_identifier, _provider, _event, _loglevel, _fields, _attr) \
1613         _side_define_event(__attribute__((visibility("default"))), _identifier, _provider, _event, \
1614                         _loglevel, SIDE_PARAM(_fields), SIDE_PARAM(_attr), SIDE_EVENT_FLAG_VARIADIC)
1615
1616 #define side_declare_event(_identifier) \
1617         extern uintptr_t side_event_enable_##_identifier; \
1618         extern struct side_event_description _identifier
1619
1620 extern const struct side_callback side_empty_callback;
1621
1622 void side_call(const struct side_event_description *desc,
1623         const struct side_arg_vec *side_arg_vec);
1624 void side_call_variadic(const struct side_event_description *desc,
1625         const struct side_arg_vec *side_arg_vec,
1626         const struct side_arg_dynamic_struct *var_struct);
1627
1628 struct side_events_register_handle *side_events_register(struct side_event_description **events,
1629                 uint32_t nr_events);
1630 void side_events_unregister(struct side_events_register_handle *handle);
1631
1632 /*
1633  * Userspace tracer registration API. This allows userspace tracers to
1634  * register event notification callbacks to be notified of the currently
1635  * registered instrumentation, and to register their callbacks to
1636  * specific events.
1637  */
1638 typedef void (*side_tracer_callback_func)(const struct side_event_description *desc,
1639                         const struct side_arg_vec *side_arg_vec,
1640                         void *priv);
1641 typedef void (*side_tracer_callback_variadic_func)(const struct side_event_description *desc,
1642                         const struct side_arg_vec *side_arg_vec,
1643                         const struct side_arg_dynamic_struct *var_struct,
1644                         void *priv);
1645
1646 int side_tracer_callback_register(struct side_event_description *desc,
1647                 side_tracer_callback_func call,
1648                 void *priv);
1649 int side_tracer_callback_variadic_register(struct side_event_description *desc,
1650                 side_tracer_callback_variadic_func call_variadic,
1651                 void *priv);
1652 int side_tracer_callback_unregister(struct side_event_description *desc,
1653                 side_tracer_callback_func call,
1654                 void *priv);
1655 int side_tracer_callback_variadic_unregister(struct side_event_description *desc,
1656                 side_tracer_callback_variadic_func call_variadic,
1657                 void *priv);
1658
1659 enum side_tracer_notification {
1660         SIDE_TRACER_NOTIFICATION_INSERT_EVENTS,
1661         SIDE_TRACER_NOTIFICATION_REMOVE_EVENTS,
1662 };
1663
1664 /* Callback is invoked with side library internal lock held. */
1665 struct side_tracer_handle *side_tracer_event_notification_register(
1666                 void (*cb)(enum side_tracer_notification notif,
1667                         struct side_event_description **events, uint32_t nr_events, void *priv),
1668                 void *priv);
1669 void side_tracer_event_notification_unregister(struct side_tracer_handle *handle);
1670
1671 /*
1672  * Explicit hooks to initialize/finalize the side instrumentation
1673  * library. Those are also library constructor/destructor.
1674  */
1675 void side_init(void);
1676 void side_exit(void);
1677
1678 /*
1679  * The following constructors/destructors perform automatic registration
1680  * of the declared side events. Those may have to be called explicitly
1681  * in a statically linked library.
1682  */
1683
1684 /*
1685  * These weak symbols, the constructor, and destructor take care of
1686  * registering only _one_ instance of the side instrumentation per
1687  * shared-ojbect (or for the whole main program).
1688  */
1689 extern struct side_event_description * __start_side_event_description_ptr[]
1690         __attribute__((weak, visibility("hidden")));
1691 extern struct side_event_description * __stop_side_event_description_ptr[]
1692         __attribute__((weak, visibility("hidden")));
1693 int side_event_description_ptr_registered
1694         __attribute__((weak, visibility("hidden")));
1695 struct side_events_register_handle *side_events_handle
1696         __attribute__((weak, visibility("hidden")));
1697
1698 static void
1699 side_event_description_ptr_init(void)
1700         __attribute__((no_instrument_function))
1701         __attribute__((constructor));
1702 static void
1703 side_event_description_ptr_init(void)
1704 {
1705         if (side_event_description_ptr_registered++)
1706                 return;
1707         side_events_handle = side_events_register(__start_side_event_description_ptr,
1708                 __stop_side_event_description_ptr - __start_side_event_description_ptr);
1709 }
1710
1711 static void
1712 side_event_description_ptr_exit(void)
1713         __attribute__((no_instrument_function))
1714         __attribute__((destructor));
1715 static void
1716 side_event_description_ptr_exit(void)
1717 {
1718         if (--side_event_description_ptr_registered)
1719                 return;
1720         side_events_unregister(side_events_handle);
1721         side_events_handle = NULL;
1722 }
1723
1724 #endif /* _SIDE_TRACE_H */