include/lttng/ust-abi.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  *
   6  * LTTng-UST ABI header
   7  */
   8
   9 #ifndef _LTTNG_UST_ABI_H
  10 #define _LTTNG_UST_ABI_H
  11
  12 #include <stdint.h>
  13 #include <lttng/ust-compiler.h>
  14
  15 #ifndef LTTNG_PACKED
  16 #error "LTTNG_PACKED should be defined"
  17 #endif
  18
  19 #ifndef __ust_stringify
  20 #define __ust_stringify1(x)     #x
  21 #define __ust_stringify(x)      __ust_stringify1(x)
  22 #endif /* __ust_stringify */
  23
  24 #define LTTNG_UST_SYM_NAME_LEN                  256
  25 #define LTTNG_UST_ABI_PROCNAME_LEN              16
  26
  27 /* UST comm magic number, used to validate protocol and endianness. */
  28 #define LTTNG_UST_COMM_MAGIC                    0xC57C57C5
  29
  30 /* Version for ABI between liblttng-ust, sessiond, consumerd */
  31 #define LTTNG_UST_ABI_MAJOR_VERSION                     9
  32 #define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE   8
  33 #define LTTNG_UST_ABI_MINOR_VERSION             0
  34
  35 enum lttng_ust_instrumentation {
  36         LTTNG_UST_TRACEPOINT            = 0,
  37         LTTNG_UST_PROBE                 = 1,
  38         LTTNG_UST_FUNCTION              = 2,
  39 };
  40
  41 enum lttng_ust_loglevel_type {
  42         LTTNG_UST_LOGLEVEL_ALL          = 0,
  43         LTTNG_UST_LOGLEVEL_RANGE        = 1,
  44         LTTNG_UST_LOGLEVEL_SINGLE       = 2,
  45 };
  46
  47 enum lttng_ust_output {
  48         LTTNG_UST_MMAP          = 0,
  49 };
  50
  51 enum lttng_ust_chan_type {
  52         LTTNG_UST_CHAN_PER_CPU = 0,
  53         LTTNG_UST_CHAN_METADATA = 1,
  54 };
  55
  56 struct lttng_ust_tracer_version {
  57         uint32_t major;
  58         uint32_t minor;
  59         uint32_t patchlevel;
  60 } LTTNG_PACKED;
  61
  62 #define LTTNG_UST_CHANNEL_PADDING       (LTTNG_UST_SYM_NAME_LEN + 32)
  63 /*
  64  * Given that the consumerd is limited to 64k file descriptors, we
  65  * cannot expect much more than 1MB channel structure size. This size is
  66  * depends on the number of streams within a channel, which depends on
  67  * the number of possible CPUs on the system.
  68  */
  69 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN  1048576U
  70 struct lttng_ust_channel {
  71         uint64_t len;
  72         enum lttng_ust_chan_type type;
  73         char padding[LTTNG_UST_CHANNEL_PADDING];
  74         char data[];    /* variable sized data */
  75 } LTTNG_PACKED;
  76
  77 #define LTTNG_UST_STREAM_PADDING1       (LTTNG_UST_SYM_NAME_LEN + 32)
  78 struct lttng_ust_stream {
  79         uint64_t len;           /* shm len */
  80         uint32_t stream_nr;     /* stream number */
  81         char padding[LTTNG_UST_STREAM_PADDING1];
  82         /*
  83          * shm_fd and wakeup_fd are send over unix socket as file
  84          * descriptors after this structure.
  85          */
  86 } LTTNG_PACKED;
  87
  88 #define LTTNG_UST_COUNTER_DIMENSION_MAX 8
  89
  90 enum lttng_ust_counter_arithmetic {
  91         LTTNG_UST_COUNTER_ARITHMETIC_MODULAR = 0,
  92         LTTNG_UST_COUNTER_ARITHMETIC_SATURATION = 1,
  93 };
  94
  95 enum lttng_ust_counter_bitness {
  96         LTTNG_UST_COUNTER_BITNESS_32 = 0,
  97         LTTNG_UST_COUNTER_BITNESS_64 = 1,
  98 };
  99
 100 struct lttng_ust_counter_dimension {
 101         uint64_t size;
 102         uint64_t underflow_index;
 103         uint64_t overflow_index;
 104         uint8_t has_underflow;
 105         uint8_t has_overflow;
 106 } LTTNG_PACKED;
 107
 108 #define LTTNG_UST_COUNTER_CONF_PADDING1 67
 109 struct lttng_ust_counter_conf {
 110         uint32_t arithmetic;    /* enum lttng_ust_counter_arithmetic */
 111         uint32_t bitness;       /* enum lttng_ust_counter_bitness */
 112         uint32_t number_dimensions;
 113         int64_t global_sum_step;
 114         struct lttng_ust_counter_dimension dimensions[LTTNG_UST_COUNTER_DIMENSION_MAX];
 115         uint8_t coalesce_hits;
 116         char padding[LTTNG_UST_COUNTER_CONF_PADDING1];
 117 } LTTNG_PACKED;
 118
 119 struct lttng_ust_counter_value {
 120         uint32_t number_dimensions;
 121         uint64_t dimension_indexes[LTTNG_UST_COUNTER_DIMENSION_MAX];
 122         int64_t value;
 123 } LTTNG_PACKED;
 124
 125 #define LTTNG_UST_EVENT_PADDING1        8
 126 #define LTTNG_UST_EVENT_PADDING2        (LTTNG_UST_SYM_NAME_LEN + 32)
 127 struct lttng_ust_event {
 128         enum lttng_ust_instrumentation instrumentation;
 129         char name[LTTNG_UST_SYM_NAME_LEN];      /* event name */
 130
 131         enum lttng_ust_loglevel_type loglevel_type;
 132         int loglevel;   /* value, -1: all */
 133         uint64_t token;                         /* User-provided token */
 134         char padding[LTTNG_UST_EVENT_PADDING1];
 135
 136         /* Per instrumentation type configuration */
 137         union {
 138                 char padding[LTTNG_UST_EVENT_PADDING2];
 139         } u;
 140 } LTTNG_PACKED;
 141
 142 #define LTTNG_UST_EVENT_NOTIFIER_PADDING        32
 143 struct lttng_ust_event_notifier {
 144         struct lttng_ust_event event;
 145         uint64_t error_counter_index;
 146         char padding[LTTNG_UST_EVENT_NOTIFIER_PADDING];
 147 } LTTNG_PACKED;
 148
 149 #define LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
 150 struct lttng_ust_event_notifier_notification {
 151         uint64_t token;
 152         uint16_t capture_buf_size;
 153         char padding[LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING];
 154 } LTTNG_PACKED;
 155
 156 #define LTTNG_UST_COUNTER_PADDING1      (LTTNG_UST_SYM_NAME_LEN + 32)
 157 #define LTTNG_UST_COUNTER_DATA_MAX_LEN  4096U
 158 struct lttng_ust_counter {
 159         uint64_t len;
 160         char padding[LTTNG_UST_COUNTER_PADDING1];
 161         char data[];    /* variable sized data */
 162 } LTTNG_PACKED;
 163
 164 #define LTTNG_UST_COUNTER_GLOBAL_PADDING1       (LTTNG_UST_SYM_NAME_LEN + 32)
 165 struct lttng_ust_counter_global {
 166         uint64_t len;           /* shm len */
 167         char padding[LTTNG_UST_COUNTER_GLOBAL_PADDING1];
 168 } LTTNG_PACKED;
 169
 170 #define LTTNG_UST_COUNTER_CPU_PADDING1  (LTTNG_UST_SYM_NAME_LEN + 32)
 171 struct lttng_ust_counter_cpu {
 172         uint64_t len;           /* shm len */
 173         uint32_t cpu_nr;
 174         char padding[LTTNG_UST_COUNTER_CPU_PADDING1];
 175 } LTTNG_PACKED;
 176
 177 enum lttng_ust_field_type {
 178         LTTNG_UST_FIELD_OTHER                   = 0,
 179         LTTNG_UST_FIELD_INTEGER                 = 1,
 180         LTTNG_UST_FIELD_ENUM                    = 2,
 181         LTTNG_UST_FIELD_FLOAT                   = 3,
 182         LTTNG_UST_FIELD_STRING                  = 4,
 183 };
 184
 185 #define LTTNG_UST_FIELD_ITER_PADDING    (LTTNG_UST_SYM_NAME_LEN + 28)
 186 struct lttng_ust_field_iter {
 187         char event_name[LTTNG_UST_SYM_NAME_LEN];
 188         char field_name[LTTNG_UST_SYM_NAME_LEN];
 189         enum lttng_ust_field_type type;
 190         int loglevel;                           /* event loglevel */
 191         int nowrite;
 192         char padding[LTTNG_UST_FIELD_ITER_PADDING];
 193 } LTTNG_PACKED;
 194
 195 enum lttng_ust_context_type {
 196         LTTNG_UST_CONTEXT_VTID                  = 0,
 197         LTTNG_UST_CONTEXT_VPID                  = 1,
 198         LTTNG_UST_CONTEXT_PTHREAD_ID            = 2,
 199         LTTNG_UST_CONTEXT_PROCNAME              = 3,
 200         LTTNG_UST_CONTEXT_IP                    = 4,
 201         LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER   = 5,
 202         LTTNG_UST_CONTEXT_CPU_ID                = 6,
 203         LTTNG_UST_CONTEXT_APP_CONTEXT           = 7,
 204         LTTNG_UST_CONTEXT_CGROUP_NS             = 8,
 205         LTTNG_UST_CONTEXT_IPC_NS                = 9,
 206         LTTNG_UST_CONTEXT_MNT_NS                = 10,
 207         LTTNG_UST_CONTEXT_NET_NS                = 11,
 208         LTTNG_UST_CONTEXT_PID_NS                = 12,
 209         LTTNG_UST_CONTEXT_USER_NS               = 13,
 210         LTTNG_UST_CONTEXT_UTS_NS                = 14,
 211         LTTNG_UST_CONTEXT_VUID                  = 15,
 212         LTTNG_UST_CONTEXT_VEUID                 = 16,
 213         LTTNG_UST_CONTEXT_VSUID                 = 17,
 214         LTTNG_UST_CONTEXT_VGID                  = 18,
 215         LTTNG_UST_CONTEXT_VEGID                 = 19,
 216         LTTNG_UST_CONTEXT_VSGID                 = 20,
 217         LTTNG_UST_CONTEXT_TIME_NS               = 21,
 218 };
 219
 220 struct lttng_ust_perf_counter_ctx {
 221         uint32_t type;
 222         uint64_t config;
 223         char name[LTTNG_UST_SYM_NAME_LEN];
 224 } LTTNG_PACKED;
 225
 226 #define LTTNG_UST_CONTEXT_PADDING1      16
 227 #define LTTNG_UST_CONTEXT_PADDING2      (LTTNG_UST_SYM_NAME_LEN + 32)
 228 struct lttng_ust_context {
 229         enum lttng_ust_context_type ctx;
 230         char padding[LTTNG_UST_CONTEXT_PADDING1];
 231
 232         union {
 233                 struct lttng_ust_perf_counter_ctx perf_counter;
 234                 struct {
 235                         /* Includes trailing '\0'. */
 236                         uint32_t provider_name_len;
 237                         uint32_t ctx_name_len;
 238                 } app_ctx;
 239                 char padding[LTTNG_UST_CONTEXT_PADDING2];
 240         } u;
 241 } LTTNG_PACKED;
 242
 243 /*
 244  * Tracer channel attributes.
 245  */
 246 #define LTTNG_UST_CHANNEL_ATTR_PADDING  (LTTNG_UST_SYM_NAME_LEN + 32)
 247 struct lttng_ust_channel_attr {
 248         uint64_t subbuf_size;                   /* bytes */
 249         uint64_t num_subbuf;                    /* power of 2 */
 250         int overwrite;                          /* 1: overwrite, 0: discard */
 251         unsigned int switch_timer_interval;     /* usec */
 252         unsigned int read_timer_interval;       /* usec */
 253         enum lttng_ust_output output;           /* splice, mmap */
 254         union {
 255                 struct {
 256                         int64_t blocking_timeout;       /* Blocking timeout (usec) */
 257                 } s;
 258                 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
 259         } u;
 260 } LTTNG_PACKED;
 261
 262 #define LTTNG_UST_TRACEPOINT_ITER_PADDING       16
 263 struct lttng_ust_tracepoint_iter {
 264         char name[LTTNG_UST_SYM_NAME_LEN];      /* provider:name */
 265         int loglevel;
 266         char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
 267 } LTTNG_PACKED;
 268
 269 enum lttng_ust_object_type {
 270         LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
 271         LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
 272         LTTNG_UST_OBJECT_TYPE_STREAM = 1,
 273         LTTNG_UST_OBJECT_TYPE_EVENT = 2,
 274         LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
 275         LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER_GROUP = 4,
 276         LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER = 5,
 277         LTTNG_UST_OBJECT_TYPE_COUNTER = 6,
 278         LTTNG_UST_OBJECT_TYPE_COUNTER_GLOBAL = 7,
 279         LTTNG_UST_OBJECT_TYPE_COUNTER_CPU = 8,
 280 };
 281
 282 #define LTTNG_UST_OBJECT_DATA_PADDING1  32
 283 #define LTTNG_UST_OBJECT_DATA_PADDING2  (LTTNG_UST_SYM_NAME_LEN + 32)
 284
 285 struct lttng_ust_object_data {
 286         enum lttng_ust_object_type type;
 287         int handle;
 288         uint64_t size;
 289         char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
 290         union {
 291                 struct {
 292                         void *data;
 293                         enum lttng_ust_chan_type type;
 294                         int wakeup_fd;
 295                 } channel;
 296                 struct {
 297                         int shm_fd;
 298                         int wakeup_fd;
 299                         uint32_t stream_nr;
 300                 } stream;
 301                 struct {
 302                         void *data;
 303                 } counter;
 304                 struct {
 305                         int shm_fd;
 306                 } counter_global;
 307                 struct {
 308                         int shm_fd;
 309                         uint32_t cpu_nr;
 310                 } counter_cpu;
 311                 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
 312         } u;
 313 } LTTNG_PACKED;
 314
 315 enum lttng_ust_calibrate_type {
 316         LTTNG_UST_CALIBRATE_TRACEPOINT,
 317 };
 318
 319 #define LTTNG_UST_CALIBRATE_PADDING1    16
 320 #define LTTNG_UST_CALIBRATE_PADDING2    (LTTNG_UST_SYM_NAME_LEN + 32)
 321 struct lttng_ust_calibrate {
 322         enum lttng_ust_calibrate_type type;     /* type (input) */
 323         char padding[LTTNG_UST_CALIBRATE_PADDING1];
 324
 325         union {
 326                 char padding[LTTNG_UST_CALIBRATE_PADDING2];
 327         } u;
 328 } LTTNG_PACKED;
 329
 330 #define FILTER_BYTECODE_MAX_LEN         65536
 331 #define LTTNG_UST_FILTER_PADDING        32
 332 struct lttng_ust_filter_bytecode {
 333         uint32_t len;
 334         uint32_t reloc_offset;
 335         uint64_t seqnum;
 336         char padding[LTTNG_UST_FILTER_PADDING];
 337         char data[0];
 338 } LTTNG_PACKED;
 339
 340 #define CAPTURE_BYTECODE_MAX_LEN        65536
 341 #define LTTNG_UST_CAPTURE_PADDING       32
 342 struct lttng_ust_capture_bytecode {
 343         uint32_t len;
 344         uint32_t reloc_offset;
 345         uint64_t seqnum;
 346         char padding[LTTNG_UST_CAPTURE_PADDING];
 347         char data[0];
 348 } LTTNG_PACKED;
 349
 350 #define LTTNG_UST_EXCLUSION_PADDING     32
 351 struct lttng_ust_event_exclusion {
 352         uint32_t count;
 353         char padding[LTTNG_UST_EXCLUSION_PADDING];
 354         char names[LTTNG_UST_SYM_NAME_LEN][0];
 355 } LTTNG_PACKED;
 356
 357 #define _UST_CMD(minor)                         (minor)
 358 #define _UST_CMDR(minor, type)                  (minor)
 359 #define _UST_CMDW(minor, type)                  (minor)
 360
 361 /* Handled by object descriptor */
 362 #define LTTNG_UST_RELEASE                       _UST_CMD(0x1)
 363
 364 /* Handled by object cmd */
 365
 366 /* LTTng-UST commands */
 367 #define LTTNG_UST_SESSION                       _UST_CMD(0x40)
 368 #define LTTNG_UST_TRACER_VERSION                \
 369         _UST_CMDR(0x41, struct lttng_ust_tracer_version)
 370 #define LTTNG_UST_TRACEPOINT_LIST               _UST_CMD(0x42)
 371 #define LTTNG_UST_WAIT_QUIESCENT                _UST_CMD(0x43)
 372 #define LTTNG_UST_REGISTER_DONE                 _UST_CMD(0x44)
 373 #define LTTNG_UST_TRACEPOINT_FIELD_LIST         _UST_CMD(0x45)
 374 #define LTTNG_UST_EVENT_NOTIFIER_GROUP_CREATE   _UST_CMD(0x46)
 375
 376 /* Session commands */
 377 #define LTTNG_UST_CHANNEL                       \
 378         _UST_CMDW(0x51, struct lttng_ust_channel)
 379 #define LTTNG_UST_SESSION_START                 _UST_CMD(0x52)
 380 #define LTTNG_UST_SESSION_STOP                  _UST_CMD(0x53)
 381 #define LTTNG_UST_SESSION_STATEDUMP             _UST_CMD(0x54)
 382
 383 /* Channel commands */
 384 #define LTTNG_UST_STREAM                        _UST_CMD(0x60)
 385 #define LTTNG_UST_EVENT                 \
 386         _UST_CMDW(0x61, struct lttng_ust_event)
 387
 388 /* Event and channel commands */
 389 #define LTTNG_UST_CONTEXT                       \
 390         _UST_CMDW(0x70, struct lttng_ust_context)
 391 #define LTTNG_UST_FLUSH_BUFFER                  \
 392         _UST_CMD(0x71)
 393
 394 /* Event, event notifier, channel and session commands */
 395 #define LTTNG_UST_ENABLE                        _UST_CMD(0x80)
 396 #define LTTNG_UST_DISABLE                       _UST_CMD(0x81)
 397
 398 /* Tracepoint list commands */
 399 #define LTTNG_UST_TRACEPOINT_LIST_GET           _UST_CMD(0x90)
 400 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET     _UST_CMD(0x91)
 401
 402 /* Event and event notifier commands */
 403 #define LTTNG_UST_FILTER                        _UST_CMD(0xA0)
 404 #define LTTNG_UST_EXCLUSION                     _UST_CMD(0xA1)
 405
 406 /* Event notifier group commands */
 407 #define LTTNG_UST_EVENT_NOTIFIER_CREATE         \
 408         _UST_CMDW(0xB0, struct lttng_ust_event_notifier)
 409
 410 /* Event notifier commands */
 411 #define LTTNG_UST_CAPTURE                       _UST_CMD(0xB6)
 412
 413 /* Session and event notifier group commands */
 414 #define LTTNG_UST_COUNTER                       \
 415         _UST_CMDW(0xC0, struct lttng_ust_counter)
 416
 417 /* Counter commands */
 418 #define LTTNG_UST_COUNTER_GLOBAL                \
 419         _UST_CMDW(0xD0, struct lttng_ust_counter_global)
 420 #define LTTNG_UST_COUNTER_CPU                   \
 421         _UST_CMDW(0xD1, struct lttng_ust_counter_cpu)
 422
 423 #define LTTNG_UST_ROOT_HANDLE   0
 424
 425 struct lttng_ust_obj;
 426
 427 union ust_args {
 428         struct {
 429                 void *chan_data;
 430                 int wakeup_fd;
 431         } channel;
 432         struct {
 433                 int shm_fd;
 434                 int wakeup_fd;
 435         } stream;
 436         struct {
 437                 struct lttng_ust_field_iter entry;
 438         } field_list;
 439         struct {
 440                 char *ctxname;
 441         } app_context;
 442         struct {
 443                 int event_notifier_notif_fd;
 444         } event_notifier_handle;
 445         struct {
 446                 void *counter_data;
 447         } counter;
 448         struct {
 449                 int shm_fd;
 450         } counter_shm;
 451 };
 452
 453 struct lttng_ust_objd_ops {
 454         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
 455                 union ust_args *args, void *owner);
 456         int (*release)(int objd);
 457 };
 458
 459 /* Create root handle. Always ID 0. */
 460 int lttng_abi_create_root_handle(void);
 461
 462 const struct lttng_ust_objd_ops *objd_ops(int id);
 463 int lttng_ust_objd_unref(int id, int is_owner);
 464
 465 void lttng_ust_abi_exit(void);
 466 void lttng_ust_events_exit(void);
 467 void lttng_ust_objd_table_owner_cleanup(void *owner);
 468
 469 #endif /* _LTTNG_UST_ABI_H */