include/lttng/events.h

   1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
   2  *
   3  * lttng/events.h
   4  *
   5  * Holds LTTng per-session event registry.
   6  *
   7  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  */
   9
  10 #ifndef _LTTNG_EVENTS_H
  11 #define _LTTNG_EVENTS_H
  12
  13 #include <linux/irq_work.h>
  14 #include <linux/version.h>
  15 #include <linux/list.h>
  16 #include <linux/kprobes.h>
  17 #include <linux/kref.h>
  18 #include <linux/uuid.h>
  19 #include <wrapper/uprobes.h>
  20 #include <lttng/cpuhotplug.h>
  21 #include <lttng/tracer.h>
  22 #include <lttng/abi.h>
  23 #include <lttng/abi-old.h>
  24 #include <lttng/endian.h>
  25
  26 #define lttng_is_signed_type(type)      (((type)(-1)) < 0)
  27
  28 struct lttng_channel;
  29 struct lttng_session;
  30 struct lttng_metadata_cache;
  31 struct lib_ring_buffer_ctx;
  32 struct perf_event;
  33 struct perf_event_attr;
  34 struct lib_ring_buffer_config;
  35
  36 /* Type description */
  37
  38 enum abstract_types {
  39         atype_integer,
  40         atype_string,
  41         atype_enum_nestable,
  42         atype_array_nestable,
  43         atype_sequence_nestable,
  44         atype_struct_nestable,
  45         atype_variant_nestable,
  46         NR_ABSTRACT_TYPES,
  47 };
  48
  49 enum lttng_string_encodings {
  50         lttng_encode_none = 0,
  51         lttng_encode_UTF8 = 1,
  52         lttng_encode_ASCII = 2,
  53         NR_STRING_ENCODINGS,
  54 };
  55
  56 enum channel_type {
  57         PER_CPU_CHANNEL,
  58         METADATA_CHANNEL,
  59 };
  60
  61 struct lttng_enum_value {
  62         unsigned long long value;
  63         unsigned int signedness:1;
  64 };
  65
  66 struct lttng_enum_entry {
  67         struct lttng_enum_value start, end;     /* start and end are inclusive */
  68         const char *string;
  69         struct {
  70                 unsigned int is_auto:1;
  71         } options;
  72 };
  73
  74 #define __type_integer(_type, _size, _alignment, _signedness,   \
  75                 _byte_order, _base, _encoding)  \
  76         {                                                       \
  77             .atype = atype_integer,                             \
  78             .u.integer =                                        \
  79                 {                                               \
  80                   .size = (_size) ? : sizeof(_type) * CHAR_BIT, \
  81                   .alignment = (_alignment) ? : lttng_alignof(_type) * CHAR_BIT, \
  82                   .signedness = (_signedness) >= 0 ? (_signedness) : lttng_is_signed_type(_type), \
  83                   .reverse_byte_order = _byte_order != __BYTE_ORDER, \
  84                   .base = _base,                                \
  85                   .encoding = lttng_encode_##_encoding,         \
  86                 },                                              \
  87         }                                                       \
  88
  89 struct lttng_integer_type {
  90         unsigned int size;              /* in bits */
  91         unsigned short alignment;       /* in bits */
  92         unsigned int signedness:1,
  93                 reverse_byte_order:1;
  94         unsigned int base;              /* 2, 8, 10, 16, for pretty print */
  95         enum lttng_string_encodings encoding;
  96 };
  97
  98 struct lttng_type {
  99         enum abstract_types atype;
 100         union {
 101                 struct lttng_integer_type integer;
 102                 struct {
 103                         enum lttng_string_encodings encoding;
 104                 } string;
 105                 struct {
 106                         const struct lttng_enum_desc *desc;     /* Enumeration mapping */
 107                         const struct lttng_type *container_type;
 108                 } enum_nestable;
 109                 struct {
 110                         const struct lttng_type *elem_type;
 111                         unsigned int length;                    /* Num. elems. */
 112                         unsigned int alignment;
 113                 } array_nestable;
 114                 struct {
 115                         const char *length_name;                /* Length field name. */
 116                         const struct lttng_type *elem_type;
 117                         unsigned int alignment;                 /* Alignment before elements. */
 118                 } sequence_nestable;
 119                 struct {
 120                         unsigned int nr_fields;
 121                         const struct lttng_event_field *fields; /* Array of fields. */
 122                         unsigned int alignment;
 123                 } struct_nestable;
 124                 struct {
 125                         const char *tag_name;
 126                         const struct lttng_event_field *choices; /* Array of fields. */
 127                         unsigned int nr_choices;
 128                         unsigned int alignment;
 129                 } variant_nestable;
 130         } u;
 131 };
 132
 133 struct lttng_enum_desc {
 134         const char *name;
 135         const struct lttng_enum_entry *entries;
 136         unsigned int nr_entries;
 137 };
 138
 139 /* Event field description */
 140
 141 struct lttng_event_field {
 142         const char *name;
 143         struct lttng_type type;
 144         unsigned int nowrite:1,         /* do not write into trace */
 145                         user:1,         /* fetch from user-space */
 146                         nofilter:1;     /* do not consider for filter */
 147 };
 148
 149 union lttng_ctx_value {
 150         int64_t s64;
 151         const char *str;
 152         double d;
 153 };
 154
 155 /*
 156  * We need to keep this perf counter field separately from struct
 157  * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
 158  */
 159 struct lttng_perf_counter_field {
 160 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
 161         struct lttng_cpuhp_node cpuhp_prepare;
 162         struct lttng_cpuhp_node cpuhp_online;
 163 #else
 164         struct notifier_block nb;
 165         int hp_enable;
 166 #endif
 167         struct perf_event_attr *attr;
 168         struct perf_event **e;  /* per-cpu array */
 169 };
 170
 171 struct lttng_probe_ctx {
 172         struct lttng_event *event;
 173         struct lttng_event_notifier *event_notifier; // Not sure if we will ever need it.
 174         uint8_t interruptible;
 175 };
 176
 177 struct lttng_ctx_field {
 178         struct lttng_event_field event_field;
 179         size_t (*get_size)(size_t offset);
 180         size_t (*get_size_arg)(size_t offset, struct lttng_ctx_field *field,
 181                                struct lib_ring_buffer_ctx *ctx,
 182                                struct lttng_channel *chan);
 183         void (*record)(struct lttng_ctx_field *field,
 184                        struct lib_ring_buffer_ctx *ctx,
 185                        struct lttng_channel *chan);
 186         void (*get_value)(struct lttng_ctx_field *field,
 187                          struct lttng_probe_ctx *lttng_probe_ctx,
 188                          union lttng_ctx_value *value);
 189         union {
 190                 struct lttng_perf_counter_field *perf_counter;
 191         } u;
 192         void (*destroy)(struct lttng_ctx_field *field);
 193         /*
 194          * Private data to keep state between get_size and record.
 195          * User must perform its own synchronization to protect against
 196          * concurrent and reentrant contexts.
 197          */
 198         void *priv;
 199 };
 200
 201 struct lttng_ctx {
 202         struct lttng_ctx_field *fields;
 203         unsigned int nr_fields;
 204         unsigned int allocated_fields;
 205         size_t largest_align;   /* in bytes */
 206 };
 207
 208 struct lttng_event_desc {
 209         const char *name;               /* lttng-modules name */
 210         const char *kname;              /* Linux kernel name (tracepoints) */
 211         void *probe_callback;
 212         const struct lttng_event_ctx *ctx;      /* context */
 213         const struct lttng_event_field *fields; /* event payload */
 214         unsigned int nr_fields;
 215         struct module *owner;
 216         void *event_notifier_callback;
 217 };
 218
 219 struct lttng_probe_desc {
 220         const char *provider;
 221         const struct lttng_event_desc **event_desc;
 222         unsigned int nr_events;
 223         struct list_head head;                  /* chain registered probes */
 224         struct list_head lazy_init_head;
 225         int lazy;                               /* lazy registration */
 226 };
 227
 228 struct lttng_krp;                               /* Kretprobe handling */
 229
 230 enum lttng_event_type {
 231         LTTNG_TYPE_EVENT = 0,
 232         LTTNG_TYPE_ENABLER = 1,
 233 };
 234
 235 struct lttng_filter_bytecode_node {
 236         struct list_head node;
 237         struct lttng_enabler *enabler;
 238         /*
 239          * struct lttng_kernel_filter_bytecode has var. sized array, must be
 240          * last field.
 241          */
 242         struct lttng_kernel_filter_bytecode bc;
 243 };
 244
 245 /*
 246  * Filter return value masks.
 247  */
 248 enum lttng_filter_ret {
 249         LTTNG_FILTER_DISCARD = 0,
 250         LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
 251         /* Other bits are kept for future use. */
 252 };
 253
 254 struct lttng_bytecode_runtime {
 255         /* Associated bytecode */
 256         struct lttng_filter_bytecode_node *bc;
 257         uint64_t (*filter)(void *filter_data, struct lttng_probe_ctx *lttng_probe_ctx,
 258                         const char *filter_stack_data);
 259         int link_failed;
 260         struct list_head node;  /* list of bytecode runtime in event */
 261         struct lttng_ctx *ctx;
 262 };
 263
 264 /*
 265  * Objects in a linked-list of enablers, owned by an event.
 266  */
 267 struct lttng_enabler_ref {
 268         struct list_head node;                  /* enabler ref list */
 269         struct lttng_enabler *ref;              /* backward ref */
 270 };
 271
 272 struct lttng_uprobe_handler {
 273         struct lttng_event *event;
 274         loff_t offset;
 275         struct uprobe_consumer up_consumer;
 276         struct list_head node;
 277 };
 278
 279 struct lttng_kprobe {
 280         struct kprobe kp;
 281         char *symbol_name;
 282 };
 283
 284 enum lttng_syscall_entryexit {
 285         LTTNG_SYSCALL_ENTRY,
 286         LTTNG_SYSCALL_EXIT,
 287 };
 288
 289 enum lttng_syscall_abi {
 290         LTTNG_SYSCALL_ABI_NATIVE,
 291         LTTNG_SYSCALL_ABI_COMPAT,
 292 };
 293
 294 /*
 295  * lttng_event structure is referred to by the tracing fast path. It must be
 296  * kept small.
 297  */
 298 struct lttng_event {
 299         enum lttng_event_type evtype;   /* First field. */
 300         unsigned int id;
 301         struct lttng_channel *chan;
 302         int enabled;
 303         const struct lttng_event_desc *desc;
 304         void *filter;
 305         struct lttng_ctx *ctx;
 306         enum lttng_kernel_instrumentation instrumentation;
 307         union {
 308                 struct lttng_kprobe kprobe;
 309                 struct {
 310                         struct lttng_krp *lttng_krp;
 311                         char *symbol_name;
 312                 } kretprobe;
 313                 struct {
 314                         struct inode *inode;
 315                         struct list_head head;
 316                 } uprobe;
 317                 struct {
 318                         char *syscall_name;
 319                         enum lttng_syscall_entryexit entryexit;
 320                         enum lttng_syscall_abi abi;
 321                 } syscall;
 322         } u;
 323         struct list_head list;          /* Event list in session */
 324         unsigned int metadata_dumped:1;
 325
 326         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 327         struct list_head enablers_ref_head;
 328         struct hlist_node hlist;        /* session ht of events */
 329         int registered;                 /* has reg'd tracepoint probe */
 330         /* list of struct lttng_bytecode_runtime, sorted by seqnum */
 331         struct list_head bytecode_runtime_head;
 332         int has_enablers_without_bytecode;
 333 };
 334
 335 // FIXME: Really similar to lttng_event above. Could those be merged ?
 336 struct lttng_event_notifier {
 337         enum lttng_event_type evtype;   /* First field. */
 338         uint64_t user_token;
 339         int enabled;
 340         int registered;                 /* has reg'd tracepoint probe */
 341         const struct lttng_event_desc *desc;
 342         void *filter;
 343         struct list_head list;          /* event_notifier list in event_notifier group */
 344
 345         enum lttng_kernel_instrumentation instrumentation;
 346         union {
 347         } u;
 348
 349         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 350         struct list_head enablers_ref_head;
 351         struct hlist_node hlist;        /* session ht of event_notifiers */
 352         /* list of struct lttng_bytecode_runtime, sorted by seqnum */
 353         struct list_head bytecode_runtime_head;
 354         int has_enablers_without_bytecode;
 355
 356         void (*send_notification)(struct lttng_event_notifier *event_notifier);
 357         struct lttng_event_notifier_group *group; /* Weak ref */
 358 };
 359
 360 enum lttng_enabler_format_type {
 361         LTTNG_ENABLER_FORMAT_STAR_GLOB,
 362         LTTNG_ENABLER_FORMAT_NAME,
 363 };
 364
 365 /*
 366  * Enabler field, within whatever object is enabling an event. Target of
 367  * backward reference.
 368  */
 369 struct lttng_enabler {
 370         enum lttng_event_type evtype;   /* First field. */
 371
 372         enum lttng_enabler_format_type format_type;
 373
 374         /* head list of struct lttng_ust_filter_bytecode_node */
 375         struct list_head filter_bytecode_head;
 376
 377         struct lttng_kernel_event event_param;
 378         unsigned int enabled:1;
 379
 380         uint64_t user_token;            /* User-provided token. */
 381 };
 382
 383 struct lttng_event_enabler {
 384         struct lttng_enabler base;
 385         struct list_head node;  /* per-session list of enablers */
 386         struct lttng_channel *chan;
 387         /*
 388          * Unused, but kept around to make it explicit that the tracer can do
 389          * it.
 390          */
 391         struct lttng_ctx *ctx;
 392 };
 393
 394 struct lttng_event_notifier_enabler {
 395         struct lttng_enabler base;
 396         struct list_head node;  /* List of event_notifier enablers */
 397         struct lttng_event_notifier_group *group;
 398 };
 399
 400 static inline
 401 struct lttng_enabler *lttng_event_enabler_as_enabler(
 402                 struct lttng_event_enabler *event_enabler)
 403 {
 404         return &event_enabler->base;
 405 }
 406
 407 static inline
 408 struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
 409                 struct lttng_event_notifier_enabler *event_notifier_enabler)
 410 {
 411         return &event_notifier_enabler->base;
 412 }
 413
 414 struct lttng_channel_ops {
 415         struct channel *(*channel_create)(const char *name,
 416                                 void *priv,
 417                                 void *buf_addr,
 418                                 size_t subbuf_size, size_t num_subbuf,
 419                                 unsigned int switch_timer_interval,
 420                                 unsigned int read_timer_interval);
 421         void (*channel_destroy)(struct channel *chan);
 422         struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
 423         int (*buffer_has_read_closed_stream)(struct channel *chan);
 424         void (*buffer_read_close)(struct lib_ring_buffer *buf);
 425         int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
 426                              uint32_t event_id);
 427         void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
 428         void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
 429                             size_t len);
 430         void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
 431                                       const void *src, size_t len);
 432         void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
 433                              int c, size_t len);
 434         void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
 435                              size_t len);
 436         void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
 437                                        const char __user *src, size_t len);
 438         /*
 439          * packet_avail_size returns the available size in the current
 440          * packet. Note that the size returned is only a hint, since it
 441          * may change due to concurrent writes.
 442          */
 443         size_t (*packet_avail_size)(struct channel *chan);
 444         wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
 445         wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 446         int (*is_finalized)(struct channel *chan);
 447         int (*is_disabled)(struct channel *chan);
 448         int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
 449                         struct lib_ring_buffer *bufb,
 450                         uint64_t *timestamp_begin);
 451         int (*timestamp_end) (const struct lib_ring_buffer_config *config,
 452                         struct lib_ring_buffer *bufb,
 453                         uint64_t *timestamp_end);
 454         int (*events_discarded) (const struct lib_ring_buffer_config *config,
 455                         struct lib_ring_buffer *bufb,
 456                         uint64_t *events_discarded);
 457         int (*content_size) (const struct lib_ring_buffer_config *config,
 458                         struct lib_ring_buffer *bufb,
 459                         uint64_t *content_size);
 460         int (*packet_size) (const struct lib_ring_buffer_config *config,
 461                         struct lib_ring_buffer *bufb,
 462                         uint64_t *packet_size);
 463         int (*stream_id) (const struct lib_ring_buffer_config *config,
 464                         struct lib_ring_buffer *bufb,
 465                         uint64_t *stream_id);
 466         int (*current_timestamp) (const struct lib_ring_buffer_config *config,
 467                         struct lib_ring_buffer *bufb,
 468                         uint64_t *ts);
 469         int (*sequence_number) (const struct lib_ring_buffer_config *config,
 470                         struct lib_ring_buffer *bufb,
 471                         uint64_t *seq);
 472         int (*instance_id) (const struct lib_ring_buffer_config *config,
 473                         struct lib_ring_buffer *bufb,
 474                         uint64_t *id);
 475 };
 476
 477 struct lttng_transport {
 478         char *name;
 479         struct module *owner;
 480         struct list_head node;
 481         struct lttng_channel_ops ops;
 482 };
 483
 484 struct lttng_syscall_filter;
 485
 486 #define LTTNG_EVENT_HT_BITS             12
 487 #define LTTNG_EVENT_HT_SIZE             (1U << LTTNG_EVENT_HT_BITS)
 488
 489 struct lttng_event_ht {
 490         struct hlist_head table[LTTNG_EVENT_HT_SIZE];
 491 };
 492
 493 #define LTTNG_EVENT_NOTIFIER_HT_BITS            12
 494 #define LTTNG_EVENT_NOTIFIER_HT_SIZE            (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
 495
 496 struct lttng_event_notifier_ht {
 497         struct hlist_head table[LTTNG_EVENT_NOTIFIER_HT_SIZE];
 498 };
 499
 500 struct lttng_channel {
 501         unsigned int id;
 502         struct channel *chan;           /* Channel buffers */
 503         int enabled;
 504         struct lttng_ctx *ctx;
 505         /* Event ID management */
 506         struct lttng_session *session;
 507         struct file *file;              /* File associated to channel */
 508         unsigned int free_event_id;     /* Next event ID to allocate */
 509         struct list_head list;          /* Channel list */
 510         struct lttng_channel_ops *ops;
 511         struct lttng_transport *transport;
 512         struct lttng_event **sc_table;  /* for syscall tracing */
 513         struct lttng_event **compat_sc_table;
 514         struct lttng_event **sc_exit_table;     /* for syscall exit tracing */
 515         struct lttng_event **compat_sc_exit_table;
 516         struct lttng_event *sc_unknown; /* for unknown syscalls */
 517         struct lttng_event *sc_compat_unknown;
 518         struct lttng_event *sc_exit_unknown;
 519         struct lttng_event *compat_sc_exit_unknown;
 520         struct lttng_syscall_filter *sc_filter;
 521         int header_type;                /* 0: unset, 1: compact, 2: large */
 522         enum channel_type channel_type;
 523         int syscall_all;
 524         unsigned int metadata_dumped:1,
 525                 sys_enter_registered:1,
 526                 sys_exit_registered:1,
 527                 tstate:1;               /* Transient enable state */
 528 };
 529
 530 struct lttng_metadata_stream {
 531         void *priv;                     /* Ring buffer private data */
 532         struct lttng_metadata_cache *metadata_cache;
 533         unsigned int metadata_in;       /* Bytes read from the cache */
 534         unsigned int metadata_out;      /* Bytes consumed from stream */
 535         int finalized;                  /* Has channel been finalized */
 536         wait_queue_head_t read_wait;    /* Reader buffer-level wait queue */
 537         struct list_head list;          /* Stream list */
 538         struct lttng_transport *transport;
 539         uint64_t version;               /* Current version of the metadata cache */
 540         bool coherent;                  /* Stream in a coherent state */
 541 };
 542
 543 #define LTTNG_DYNAMIC_LEN_STACK_SIZE    128
 544
 545 struct lttng_dynamic_len_stack {
 546         size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
 547         size_t offset;
 548 };
 549
 550 DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
 551
 552 /*
 553  * struct lttng_id_tracker declared in header due to deferencing of *v
 554  * in RCU_INITIALIZER(v).
 555  */
 556 #define LTTNG_ID_HASH_BITS      6
 557 #define LTTNG_ID_TABLE_SIZE     (1 << LTTNG_ID_HASH_BITS)
 558
 559 enum tracker_type {
 560         TRACKER_PID,
 561         TRACKER_VPID,
 562         TRACKER_UID,
 563         TRACKER_VUID,
 564         TRACKER_GID,
 565         TRACKER_VGID,
 566
 567         TRACKER_UNKNOWN,
 568 };
 569
 570 struct lttng_id_tracker_rcu {
 571         struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
 572 };
 573
 574 struct lttng_id_tracker {
 575         struct lttng_session *session;
 576         enum tracker_type tracker_type;
 577         struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
 578 };
 579
 580 struct lttng_id_hash_node {
 581         struct hlist_node hlist;
 582         int id;
 583 };
 584
 585 struct lttng_session {
 586         int active;                     /* Is trace session active ? */
 587         int been_active;                /* Has trace session been active ? */
 588         struct file *file;              /* File associated to session */
 589         struct list_head chan;          /* Channel list head */
 590         struct list_head events;        /* Event list head */
 591         struct list_head list;          /* Session list */
 592         unsigned int free_chan_id;      /* Next chan ID to allocate */
 593         uuid_le uuid;                   /* Trace session unique ID */
 594         struct lttng_metadata_cache *metadata_cache;
 595         struct lttng_id_tracker pid_tracker;
 596         struct lttng_id_tracker vpid_tracker;
 597         struct lttng_id_tracker uid_tracker;
 598         struct lttng_id_tracker vuid_tracker;
 599         struct lttng_id_tracker gid_tracker;
 600         struct lttng_id_tracker vgid_tracker;
 601         unsigned int metadata_dumped:1,
 602                 tstate:1;               /* Transient enable state */
 603         /* List of event enablers */
 604         struct list_head enablers_head;
 605         /* Hash table of events */
 606         struct lttng_event_ht events_ht;
 607         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 608         char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 609 };
 610
 611 struct lttng_event_notifier_group {
 612         struct file *file;              /* File associated to event notifier group */
 613         struct file *notif_file;        /* File used to expose notifications to userspace. */
 614         struct list_head node;          /* event notifier group list */
 615         struct list_head enablers_head; /* List of enablers */
 616         struct list_head event_notifiers_head; /* List of event notifier */
 617         struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
 618         struct lttng_ctx *ctx;          /* Contexts for filters. */
 619         struct lttng_channel_ops *ops;
 620         struct lttng_transport *transport;
 621         struct channel *chan;           /* Ring buffer channel for event notifier group. */
 622         struct lib_ring_buffer *buf;    /* Ring buffer for event notifier group. */
 623         wait_queue_head_t read_wait;
 624         struct irq_work wakeup_pending; /* Pending wakeup irq work. */
 625 };
 626
 627 struct lttng_metadata_cache {
 628         char *data;                     /* Metadata cache */
 629         unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
 630         unsigned int metadata_written;  /* Number of bytes written in metadata cache */
 631         atomic_t producing;             /* Metadata being produced (incomplete) */
 632         struct kref refcount;           /* Metadata cache usage */
 633         struct list_head metadata_stream;       /* Metadata stream list */
 634         uuid_le uuid;                   /* Trace session unique ID (copy) */
 635         struct mutex lock;              /* Produce/consume lock */
 636         uint64_t version;               /* Current version of the metadata */
 637 };
 638
 639 void lttng_lock_sessions(void);
 640 void lttng_unlock_sessions(void);
 641
 642 struct list_head *lttng_get_probe_list_head(void);
 643
 644 struct lttng_event_enabler *lttng_event_enabler_create(
 645                 enum lttng_enabler_format_type format_type,
 646                 struct lttng_kernel_event *event_param,
 647                 struct lttng_channel *chan);
 648
 649 int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler);
 650 int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
 651 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
 652                 struct lttng_event_notifier_group *event_notifier_group,
 653                 enum lttng_enabler_format_type format_type,
 654                 struct lttng_kernel_event_notifier *event_notifier_param);
 655
 656 int lttng_event_notifier_enabler_enable(
 657                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 658 int lttng_event_notifier_enabler_disable(
 659                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 660 int lttng_fix_pending_events(void);
 661 int lttng_fix_pending_event_notifiers(void);
 662 int lttng_session_active(void);
 663 bool lttng_event_notifier_active(void);
 664
 665 struct lttng_session *lttng_session_create(void);
 666 int lttng_session_enable(struct lttng_session *session);
 667 int lttng_session_disable(struct lttng_session *session);
 668 void lttng_session_destroy(struct lttng_session *session);
 669 int lttng_session_metadata_regenerate(struct lttng_session *session);
 670 int lttng_session_statedump(struct lttng_session *session);
 671 void metadata_cache_destroy(struct kref *kref);
 672
 673 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
 674 void lttng_event_notifier_group_destroy(
 675                 struct lttng_event_notifier_group *event_notifier_group);
 676
 677 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 678                                        const char *transport_name,
 679                                        void *buf_addr,
 680                                        size_t subbuf_size, size_t num_subbuf,
 681                                        unsigned int switch_timer_interval,
 682                                        unsigned int read_timer_interval,
 683                                        enum channel_type channel_type);
 684 struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
 685                                        int overwrite, void *buf_addr,
 686                                        size_t subbuf_size, size_t num_subbuf,
 687                                        unsigned int switch_timer_interval,
 688                                        unsigned int read_timer_interval);
 689
 690 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
 691 struct lttng_event *lttng_event_create(struct lttng_channel *chan,
 692                                 struct lttng_kernel_event *event_param,
 693                                 void *filter,
 694                                 const struct lttng_event_desc *event_desc,
 695                                 enum lttng_kernel_instrumentation itype);
 696 struct lttng_event *_lttng_event_create(struct lttng_channel *chan,
 697                                 struct lttng_kernel_event *event_param,
 698                                 void *filter,
 699                                 const struct lttng_event_desc *event_desc,
 700                                 enum lttng_kernel_instrumentation itype);
 701 struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
 702                 struct lttng_kernel_old_event *old_event_param,
 703                 void *filter,
 704                 const struct lttng_event_desc *internal_desc);
 705
 706 struct lttng_event_notifier *lttng_event_notifier_create(
 707                                 const struct lttng_event_desc *event_notifier_desc,
 708                                 uint64_t id,
 709                                 struct lttng_event_notifier_group *event_notifier_group,
 710                                 struct lttng_kernel_event_notifier *event_notifier_param,
 711                                 void *filter,
 712                                 enum lttng_kernel_instrumentation itype);
 713 struct lttng_event_notifier *_lttng_event_notifier_create(
 714                                 const struct lttng_event_desc *event_notifier_desc,
 715                                 uint64_t id,
 716                                 struct lttng_event_notifier_group *event_notifier_group,
 717                                 struct lttng_kernel_event_notifier *event_notifier_param,
 718                                 void *filter,
 719                                 enum lttng_kernel_instrumentation itype);
 720
 721 int lttng_channel_enable(struct lttng_channel *channel);
 722 int lttng_channel_disable(struct lttng_channel *channel);
 723 int lttng_event_enable(struct lttng_event *event);
 724 int lttng_event_disable(struct lttng_event *event);
 725
 726 void lttng_transport_register(struct lttng_transport *transport);
 727 void lttng_transport_unregister(struct lttng_transport *transport);
 728
 729 void synchronize_trace(void);
 730 int lttng_abi_init(void);
 731 int lttng_abi_compat_old_init(void);
 732 void lttng_abi_exit(void);
 733 void lttng_abi_compat_old_exit(void);
 734
 735 int lttng_probe_register(struct lttng_probe_desc *desc);
 736 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 737 const struct lttng_event_desc *lttng_event_desc_get(const char *name);
 738 void lttng_event_desc_put(const struct lttng_event_desc *desc);
 739 int lttng_probes_init(void);
 740 void lttng_probes_exit(void);
 741
 742 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
 743                 struct channel *chan, bool *coherent);
 744
 745 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
 746 int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
 747 void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
 748 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
 749 int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
 750 int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
 751
 752 int lttng_session_track_id(struct lttng_session *session,
 753                 enum tracker_type tracker_type, int id);
 754 int lttng_session_untrack_id(struct lttng_session *session,
 755                 enum tracker_type tracker_type, int id);
 756
 757 int lttng_session_list_tracker_ids(struct lttng_session *session,
 758                 enum tracker_type tracker_type);
 759
 760 void lttng_clock_ref(void);
 761 void lttng_clock_unref(void);
 762
 763 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
 764 int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
 765 int lttng_syscalls_unregister(struct lttng_channel *chan);
 766 int lttng_syscalls_destroy(struct lttng_channel *chan);
 767 int lttng_syscall_filter_enable(struct lttng_channel *chan,
 768                 struct lttng_event *event);
 769 int lttng_syscall_filter_disable(struct lttng_channel *chan,
 770                 struct lttng_event *event);
 771 long lttng_channel_syscall_mask(struct lttng_channel *channel,
 772                 struct lttng_kernel_syscall_mask __user *usyscall_mask);
 773 #else
 774 static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
 775 {
 776         return -ENOSYS;
 777 }
 778
 779 static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
 780 {
 781         return 0;
 782 }
 783
 784 static inline int lttng_syscalls_destroy(struct lttng_channel *chan)
 785 {
 786         return 0;
 787 }
 788
 789 static inline int lttng_syscall_filter_enable(struct lttng_channel *chan,
 790                 struct lttng_event *event);
 791 {
 792         return -ENOSYS;
 793 }
 794
 795 static inline int lttng_syscall_filter_disable(struct lttng_channel *chan,
 796                 struct lttng_event *event);
 797 {
 798         return -ENOSYS;
 799 }
 800
 801 static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
 802                 struct lttng_kernel_syscall_mask __user *usyscall_mask)
 803 {
 804         return -ENOSYS;
 805 }
 806
 807 #endif
 808
 809 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
 810 int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler *event_enabler,
 811                 struct lttng_kernel_filter_bytecode __user *bytecode);
 812 int lttng_event_notifier_enabler_attach_bytecode(
 813                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 814                 struct lttng_kernel_filter_bytecode __user *bytecode);
 815
 816 void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
 817                 struct lttng_ctx *ctx,
 818                 struct list_head *bytecode_runtime_head,
 819                 struct lttng_enabler *enabler);
 820
 821 int lttng_probes_init(void);
 822
 823 extern struct lttng_ctx *lttng_static_ctx;
 824
 825 int lttng_context_init(void);
 826 void lttng_context_exit(void);
 827 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
 828 ssize_t lttng_append_context_index(struct lttng_ctx **ctx_p);
 829 struct lttng_ctx_field *lttng_get_context_field_from_index(struct lttng_ctx *ctx,
 830                 size_t index);
 831 void lttng_context_update(struct lttng_ctx *ctx);
 832 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
 833 int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
 834 void lttng_remove_context_field(struct lttng_ctx **ctx,
 835                                 struct lttng_ctx_field *field);
 836 void lttng_remove_context_field_index(struct lttng_ctx **ctx_p, size_t index);
 837 void lttng_destroy_context(struct lttng_ctx *ctx);
 838 int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
 839 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
 840 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 841 int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
 842 int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
 843 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
 844 int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
 845 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
 846 int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
 847 int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
 848 int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
 849 int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx);
 850 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx);
 851 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
 852 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx);
 853 #else
 854 static inline
 855 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx)
 856 {
 857         return -ENOSYS;
 858 }
 859 #endif
 860 #ifdef CONFIG_PREEMPT_RT_FULL
 861 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx);
 862 #else
 863 static inline
 864 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx)
 865 {
 866         return -ENOSYS;
 867 }
 868 #endif
 869
 870 int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type);
 871
 872 #if defined(CONFIG_CGROUPS) && \
 873         ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
 874          LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
 875 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
 876 #else
 877 static inline
 878 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx)
 879 {
 880         return -ENOSYS;
 881 }
 882 #endif
 883
 884 #if defined(CONFIG_IPC_NS) && \
 885         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 886 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
 887 #else
 888 static inline
 889 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx)
 890 {
 891         return -ENOSYS;
 892 }
 893 #endif
 894
 895 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
 896         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 897 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
 898 #else
 899 static inline
 900 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx)
 901 {
 902         return -ENOSYS;
 903 }
 904 #endif
 905
 906 #if defined(CONFIG_NET_NS) && \
 907         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 908 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
 909 #else
 910 static inline
 911 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx)
 912 {
 913         return -ENOSYS;
 914 }
 915 #endif
 916
 917 #if defined(CONFIG_PID_NS) && \
 918         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 919 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
 920 #else
 921 static inline
 922 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx)
 923 {
 924         return -ENOSYS;
 925 }
 926 #endif
 927
 928 #if defined(CONFIG_USER_NS) && \
 929         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 930 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
 931 #else
 932 static inline
 933 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx)
 934 {
 935         return -ENOSYS;
 936 }
 937 #endif
 938
 939 #if defined(CONFIG_UTS_NS) && \
 940         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 941 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
 942 #else
 943 static inline
 944 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx)
 945 {
 946         return -ENOSYS;
 947 }
 948 #endif
 949
 950 #if defined(CONFIG_TIME_NS) && \
 951         (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
 952 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
 953 #else
 954 static inline
 955 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx)
 956 {
 957         return -ENOSYS;
 958 }
 959 #endif
 960
 961 int lttng_add_uid_to_ctx(struct lttng_ctx **ctx);
 962 int lttng_add_euid_to_ctx(struct lttng_ctx **ctx);
 963 int lttng_add_suid_to_ctx(struct lttng_ctx **ctx);
 964 int lttng_add_gid_to_ctx(struct lttng_ctx **ctx);
 965 int lttng_add_egid_to_ctx(struct lttng_ctx **ctx);
 966 int lttng_add_sgid_to_ctx(struct lttng_ctx **ctx);
 967 int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
 968 int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
 969 int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
 970 int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
 971 int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
 972 int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
 973
 974 #if defined(CONFIG_PERF_EVENTS)
 975 int lttng_add_perf_counter_to_ctx(uint32_t type,
 976                                   uint64_t config,
 977                                   const char *name,
 978                                   struct lttng_ctx **ctx);
 979 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
 980                 struct lttng_cpuhp_node *node);
 981 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
 982                 struct lttng_cpuhp_node *node);
 983 #else
 984 static inline
 985 int lttng_add_perf_counter_to_ctx(uint32_t type,
 986                                   uint64_t config,
 987                                   const char *name,
 988                                   struct lttng_ctx **ctx)
 989 {
 990         return -ENOSYS;
 991 }
 992 static inline
 993 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
 994                 struct lttng_cpuhp_node *node)
 995 {
 996         return 0;
 997 }
 998 static inline
 999 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
1000                 struct lttng_cpuhp_node *node)
1001 {
1002         return 0;
1003 }
1004 #endif
1005
1006 int lttng_logger_init(void);
1007 void lttng_logger_exit(void);
1008
1009 extern int lttng_statedump_start(struct lttng_session *session);
1010
1011 #ifdef CONFIG_KPROBES
1012 int lttng_kprobes_register_event(const char *name,
1013                 const char *symbol_name,
1014                 uint64_t offset,
1015                 uint64_t addr,
1016                 struct lttng_event *event);
1017 void lttng_kprobes_unregister_event(struct lttng_event *event);
1018 void lttng_kprobes_destroy_event_private(struct lttng_event *event);
1019 #else
1020 static inline
1021 int lttng_kprobes_register_event(const char *name,
1022                 const char *symbol_name,
1023                 uint64_t offset,
1024                 uint64_t addr,
1025                 struct lttng_event *event)
1026 {
1027         return -ENOSYS;
1028 }
1029
1030 static inline
1031 void lttng_kprobes_unregister_event(struct lttng_event *event)
1032 {
1033 }
1034
1035 static inline
1036 void lttng_kprobes_destroy_event_private(struct lttng_event *event)
1037 {
1038 }
1039
1040 static inline
1041 void lttng_kprobes_destroy_private(struct lttng_event *event)
1042 {
1043 }
1044 #endif
1045
1046 int lttng_event_add_callsite(struct lttng_event *event,
1047         struct lttng_kernel_event_callsite *callsite);
1048
1049 #ifdef CONFIG_UPROBES
1050 int lttng_uprobes_register(const char *name,
1051         int fd, struct lttng_event *event);
1052 int lttng_uprobes_add_callsite(struct lttng_event *event,
1053         struct lttng_kernel_event_callsite *callsite);
1054 void lttng_uprobes_unregister(struct lttng_event *event);
1055 void lttng_uprobes_destroy_private(struct lttng_event *event);
1056 #else
1057 static inline
1058 int lttng_uprobes_register(const char *name,
1059         int fd, struct lttng_event *event)
1060 {
1061         return -ENOSYS;
1062 }
1063
1064 static inline
1065 int lttng_uprobes_add_callsite(struct lttng_event *event,
1066         struct lttng_kernel_event_callsite *callsite)
1067 {
1068         return -ENOSYS;
1069 }
1070
1071 static inline
1072 void lttng_uprobes_unregister(struct lttng_event *event)
1073 {
1074 }
1075
1076 static inline
1077 void lttng_uprobes_destroy_private(struct lttng_event *event)
1078 {
1079 }
1080 #endif
1081
1082 #ifdef CONFIG_KRETPROBES
1083 int lttng_kretprobes_register(const char *name,
1084                 const char *symbol_name,
1085                 uint64_t offset,
1086                 uint64_t addr,
1087                 struct lttng_event *event_entry,
1088                 struct lttng_event *event_exit);
1089 void lttng_kretprobes_unregister(struct lttng_event *event);
1090 void lttng_kretprobes_destroy_private(struct lttng_event *event);
1091 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1092         int enable);
1093 #else
1094 static inline
1095 int lttng_kretprobes_register(const char *name,
1096                 const char *symbol_name,
1097                 uint64_t offset,
1098                 uint64_t addr,
1099                 struct lttng_event *event_entry,
1100                 struct lttng_event *event_exit)
1101 {
1102         return -ENOSYS;
1103 }
1104
1105 static inline
1106 void lttng_kretprobes_unregister(struct lttng_event *event)
1107 {
1108 }
1109
1110 static inline
1111 void lttng_kretprobes_destroy_private(struct lttng_event *event)
1112 {
1113 }
1114
1115 static inline
1116 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1117         int enable)
1118 {
1119         return -ENOSYS;
1120 }
1121 #endif
1122
1123 int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
1124
1125 extern const struct file_operations lttng_tracepoint_list_fops;
1126 extern const struct file_operations lttng_syscall_list_fops;
1127
1128 #define TRACEPOINT_HAS_DATA_ARG
1129
1130 static inline bool lttng_is_bytewise_integer(const struct lttng_type *type)
1131 {
1132         if (type->atype != atype_integer)
1133                 return false;
1134         switch (type->u.integer.size) {
1135         case 8:         /* Fall-through. */
1136         case 16:        /* Fall-through. */
1137         case 32:        /* Fall-through. */
1138         case 64:
1139                 break;
1140         default:
1141                 return false;
1142         }
1143         return true;
1144 }
1145
1146 #endif /* _LTTNG_EVENTS_H */