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