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