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