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 enum lttng_enabler_format_type {
 331         LTTNG_ENABLER_FORMAT_STAR_GLOB,
 332         LTTNG_ENABLER_FORMAT_NAME,
 333 };
 334
 335 /*
 336  * Enabler field, within whatever object is enabling an event. Target of
 337  * backward reference.
 338  */
 339 struct lttng_enabler {
 340         enum lttng_event_type evtype;   /* First field. */
 341
 342         enum lttng_enabler_format_type format_type;
 343
 344         /* head list of struct lttng_ust_filter_bytecode_node */
 345         struct list_head filter_bytecode_head;
 346
 347         struct lttng_kernel_event event_param;
 348         unsigned int enabled:1;
 349 };
 350
 351 struct lttng_event_enabler {
 352         struct lttng_enabler base;
 353         struct list_head node;  /* per-session list of enablers */
 354         struct lttng_channel *chan;
 355         /*
 356          * Unused, but kept around to make it explicit that the tracer can do
 357          * it.
 358          */
 359         struct lttng_ctx *ctx;
 360 };
 361
 362 static inline
 363 struct lttng_enabler *lttng_event_enabler_as_enabler(
 364                 struct lttng_event_enabler *event_enabler)
 365 {
 366         return &event_enabler->base;
 367 }
 368
 369
 370 struct lttng_channel_ops {
 371         struct channel *(*channel_create)(const char *name,
 372                                 void *priv,
 373                                 void *buf_addr,
 374                                 size_t subbuf_size, size_t num_subbuf,
 375                                 unsigned int switch_timer_interval,
 376                                 unsigned int read_timer_interval);
 377         void (*channel_destroy)(struct channel *chan);
 378         struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
 379         int (*buffer_has_read_closed_stream)(struct channel *chan);
 380         void (*buffer_read_close)(struct lib_ring_buffer *buf);
 381         int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
 382                              uint32_t event_id);
 383         void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
 384         void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
 385                             size_t len);
 386         void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
 387                                       const void *src, size_t len);
 388         void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
 389                              int c, size_t len);
 390         void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
 391                              size_t len);
 392         void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
 393                                        const char __user *src, size_t len);
 394         /*
 395          * packet_avail_size returns the available size in the current
 396          * packet. Note that the size returned is only a hint, since it
 397          * may change due to concurrent writes.
 398          */
 399         size_t (*packet_avail_size)(struct channel *chan);
 400         wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
 401         wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 402         int (*is_finalized)(struct channel *chan);
 403         int (*is_disabled)(struct channel *chan);
 404         int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
 405                         struct lib_ring_buffer *bufb,
 406                         uint64_t *timestamp_begin);
 407         int (*timestamp_end) (const struct lib_ring_buffer_config *config,
 408                         struct lib_ring_buffer *bufb,
 409                         uint64_t *timestamp_end);
 410         int (*events_discarded) (const struct lib_ring_buffer_config *config,
 411                         struct lib_ring_buffer *bufb,
 412                         uint64_t *events_discarded);
 413         int (*content_size) (const struct lib_ring_buffer_config *config,
 414                         struct lib_ring_buffer *bufb,
 415                         uint64_t *content_size);
 416         int (*packet_size) (const struct lib_ring_buffer_config *config,
 417                         struct lib_ring_buffer *bufb,
 418                         uint64_t *packet_size);
 419         int (*stream_id) (const struct lib_ring_buffer_config *config,
 420                         struct lib_ring_buffer *bufb,
 421                         uint64_t *stream_id);
 422         int (*current_timestamp) (const struct lib_ring_buffer_config *config,
 423                         struct lib_ring_buffer *bufb,
 424                         uint64_t *ts);
 425         int (*sequence_number) (const struct lib_ring_buffer_config *config,
 426                         struct lib_ring_buffer *bufb,
 427                         uint64_t *seq);
 428         int (*instance_id) (const struct lib_ring_buffer_config *config,
 429                         struct lib_ring_buffer *bufb,
 430                         uint64_t *id);
 431 };
 432
 433 struct lttng_transport {
 434         char *name;
 435         struct module *owner;
 436         struct list_head node;
 437         struct lttng_channel_ops ops;
 438 };
 439
 440 struct lttng_syscall_filter;
 441
 442 #define LTTNG_EVENT_HT_BITS             12
 443 #define LTTNG_EVENT_HT_SIZE             (1U << LTTNG_EVENT_HT_BITS)
 444
 445 struct lttng_event_ht {
 446         struct hlist_head table[LTTNG_EVENT_HT_SIZE];
 447 };
 448
 449 struct lttng_channel {
 450         unsigned int id;
 451         struct channel *chan;           /* Channel buffers */
 452         int enabled;
 453         struct lttng_ctx *ctx;
 454         /* Event ID management */
 455         struct lttng_session *session;
 456         struct file *file;              /* File associated to channel */
 457         unsigned int free_event_id;     /* Next event ID to allocate */
 458         struct list_head list;          /* Channel list */
 459         struct lttng_channel_ops *ops;
 460         struct lttng_transport *transport;
 461         struct lttng_event **sc_table;  /* for syscall tracing */
 462         struct lttng_event **compat_sc_table;
 463         struct lttng_event **sc_exit_table;     /* for syscall exit tracing */
 464         struct lttng_event **compat_sc_exit_table;
 465         struct lttng_event *sc_unknown; /* for unknown syscalls */
 466         struct lttng_event *sc_compat_unknown;
 467         struct lttng_event *sc_exit_unknown;
 468         struct lttng_event *compat_sc_exit_unknown;
 469         struct lttng_syscall_filter *sc_filter;
 470         int header_type;                /* 0: unset, 1: compact, 2: large */
 471         enum channel_type channel_type;
 472         int syscall_all;
 473         unsigned int metadata_dumped:1,
 474                 sys_enter_registered:1,
 475                 sys_exit_registered:1,
 476                 tstate:1;               /* Transient enable state */
 477 };
 478
 479 struct lttng_metadata_stream {
 480         void *priv;                     /* Ring buffer private data */
 481         struct lttng_metadata_cache *metadata_cache;
 482         unsigned int metadata_in;       /* Bytes read from the cache */
 483         unsigned int metadata_out;      /* Bytes consumed from stream */
 484         int finalized;                  /* Has channel been finalized */
 485         wait_queue_head_t read_wait;    /* Reader buffer-level wait queue */
 486         struct list_head list;          /* Stream list */
 487         struct lttng_transport *transport;
 488         uint64_t version;               /* Current version of the metadata cache */
 489         bool coherent;                  /* Stream in a coherent state */
 490 };
 491
 492 #define LTTNG_DYNAMIC_LEN_STACK_SIZE    128
 493
 494 struct lttng_dynamic_len_stack {
 495         size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
 496         size_t offset;
 497 };
 498
 499 DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
 500
 501 /*
 502  * struct lttng_id_tracker declared in header due to deferencing of *v
 503  * in RCU_INITIALIZER(v).
 504  */
 505 #define LTTNG_ID_HASH_BITS      6
 506 #define LTTNG_ID_TABLE_SIZE     (1 << LTTNG_ID_HASH_BITS)
 507
 508 enum tracker_type {
 509         TRACKER_PID,
 510         TRACKER_VPID,
 511         TRACKER_UID,
 512         TRACKER_VUID,
 513         TRACKER_GID,
 514         TRACKER_VGID,
 515
 516         TRACKER_UNKNOWN,
 517 };
 518
 519 struct lttng_id_tracker_rcu {
 520         struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
 521 };
 522
 523 struct lttng_id_tracker {
 524         struct lttng_session *session;
 525         enum tracker_type tracker_type;
 526         struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
 527 };
 528
 529 struct lttng_id_hash_node {
 530         struct hlist_node hlist;
 531         int id;
 532 };
 533
 534 struct lttng_session {
 535         int active;                     /* Is trace session active ? */
 536         int been_active;                /* Has trace session been active ? */
 537         struct file *file;              /* File associated to session */
 538         struct list_head chan;          /* Channel list head */
 539         struct list_head events;        /* Event list head */
 540         struct list_head list;          /* Session list */
 541         unsigned int free_chan_id;      /* Next chan ID to allocate */
 542         uuid_le uuid;                   /* Trace session unique ID */
 543         struct lttng_metadata_cache *metadata_cache;
 544         struct lttng_id_tracker pid_tracker;
 545         struct lttng_id_tracker vpid_tracker;
 546         struct lttng_id_tracker uid_tracker;
 547         struct lttng_id_tracker vuid_tracker;
 548         struct lttng_id_tracker gid_tracker;
 549         struct lttng_id_tracker vgid_tracker;
 550         unsigned int metadata_dumped:1,
 551                 tstate:1;               /* Transient enable state */
 552         /* List of event enablers */
 553         struct list_head enablers_head;
 554         /* Hash table of events */
 555         struct lttng_event_ht events_ht;
 556         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 557         char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 558 };
 559
 560 struct lttng_metadata_cache {
 561         char *data;                     /* Metadata cache */
 562         unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
 563         unsigned int metadata_written;  /* Number of bytes written in metadata cache */
 564         atomic_t producing;             /* Metadata being produced (incomplete) */
 565         struct kref refcount;           /* Metadata cache usage */
 566         struct list_head metadata_stream;       /* Metadata stream list */
 567         uuid_le uuid;                   /* Trace session unique ID (copy) */
 568         struct mutex lock;              /* Produce/consume lock */
 569         uint64_t version;               /* Current version of the metadata */
 570 };
 571
 572 void lttng_lock_sessions(void);
 573 void lttng_unlock_sessions(void);
 574
 575 struct list_head *lttng_get_probe_list_head(void);
 576
 577 struct lttng_event_enabler *lttng_event_enabler_create(
 578                 enum lttng_enabler_format_type format_type,
 579                 struct lttng_kernel_event *event_param,
 580                 struct lttng_channel *chan);
 581
 582 int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler);
 583 int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
 584 int lttng_fix_pending_events(void);
 585 int lttng_session_active(void);
 586
 587 struct lttng_session *lttng_session_create(void);
 588 int lttng_session_enable(struct lttng_session *session);
 589 int lttng_session_disable(struct lttng_session *session);
 590 void lttng_session_destroy(struct lttng_session *session);
 591 int lttng_session_metadata_regenerate(struct lttng_session *session);
 592 int lttng_session_statedump(struct lttng_session *session);
 593 void metadata_cache_destroy(struct kref *kref);
 594
 595 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 596                                        const char *transport_name,
 597                                        void *buf_addr,
 598                                        size_t subbuf_size, size_t num_subbuf,
 599                                        unsigned int switch_timer_interval,
 600                                        unsigned int read_timer_interval,
 601                                        enum channel_type channel_type);
 602 struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
 603                                        int overwrite, void *buf_addr,
 604                                        size_t subbuf_size, size_t num_subbuf,
 605                                        unsigned int switch_timer_interval,
 606                                        unsigned int read_timer_interval);
 607
 608 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
 609 struct lttng_event *lttng_event_create(struct lttng_channel *chan,
 610                                 struct lttng_kernel_event *event_param,
 611                                 void *filter,
 612                                 const struct lttng_event_desc *event_desc,
 613                                 enum lttng_kernel_instrumentation itype);
 614 struct lttng_event *_lttng_event_create(struct lttng_channel *chan,
 615                                 struct lttng_kernel_event *event_param,
 616                                 void *filter,
 617                                 const struct lttng_event_desc *event_desc,
 618                                 enum lttng_kernel_instrumentation itype);
 619 struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
 620                 struct lttng_kernel_old_event *old_event_param,
 621                 void *filter,
 622                 const struct lttng_event_desc *internal_desc);
 623
 624 int lttng_channel_enable(struct lttng_channel *channel);
 625 int lttng_channel_disable(struct lttng_channel *channel);
 626 int lttng_event_enable(struct lttng_event *event);
 627 int lttng_event_disable(struct lttng_event *event);
 628
 629 void lttng_transport_register(struct lttng_transport *transport);
 630 void lttng_transport_unregister(struct lttng_transport *transport);
 631
 632 void synchronize_trace(void);
 633 int lttng_abi_init(void);
 634 int lttng_abi_compat_old_init(void);
 635 void lttng_abi_exit(void);
 636 void lttng_abi_compat_old_exit(void);
 637
 638 int lttng_probe_register(struct lttng_probe_desc *desc);
 639 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 640 const struct lttng_event_desc *lttng_event_desc_get(const char *name);
 641 void lttng_event_desc_put(const struct lttng_event_desc *desc);
 642 int lttng_probes_init(void);
 643 void lttng_probes_exit(void);
 644
 645 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
 646                 struct channel *chan, bool *coherent);
 647
 648 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
 649 int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
 650 void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
 651 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
 652 int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
 653 int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
 654
 655 int lttng_session_track_id(struct lttng_session *session,
 656                 enum tracker_type tracker_type, int id);
 657 int lttng_session_untrack_id(struct lttng_session *session,
 658                 enum tracker_type tracker_type, int id);
 659
 660 int lttng_session_list_tracker_ids(struct lttng_session *session,
 661                 enum tracker_type tracker_type);
 662
 663 void lttng_clock_ref(void);
 664 void lttng_clock_unref(void);
 665
 666 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
 667 int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
 668 int lttng_syscalls_unregister(struct lttng_channel *chan);
 669 int lttng_syscalls_destroy(struct lttng_channel *chan);
 670 int lttng_syscall_filter_enable(struct lttng_channel *chan,
 671                 struct lttng_event *event);
 672 int lttng_syscall_filter_disable(struct lttng_channel *chan,
 673                 struct lttng_event *event);
 674 long lttng_channel_syscall_mask(struct lttng_channel *channel,
 675                 struct lttng_kernel_syscall_mask __user *usyscall_mask);
 676 #else
 677 static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
 678 {
 679         return -ENOSYS;
 680 }
 681
 682 static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
 683 {
 684         return 0;
 685 }
 686
 687 static inline int lttng_syscalls_destroy(struct lttng_channel *chan)
 688 {
 689         return 0;
 690 }
 691
 692 static inline int lttng_syscall_filter_enable(struct lttng_channel *chan,
 693                 struct lttng_event *event);
 694 {
 695         return -ENOSYS;
 696 }
 697
 698 static inline int lttng_syscall_filter_disable(struct lttng_channel *chan,
 699                 struct lttng_event *event);
 700 {
 701         return -ENOSYS;
 702 }
 703
 704 static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
 705                 struct lttng_kernel_syscall_mask __user *usyscall_mask)
 706 {
 707         return -ENOSYS;
 708 }
 709 #endif
 710
 711 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
 712 int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler *event_enabler,
 713                 struct lttng_kernel_filter_bytecode __user *bytecode);
 714
 715 void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
 716                 struct lttng_ctx *ctx,
 717                 struct list_head *bytecode_runtime_head,
 718                 struct lttng_enabler *enabler);
 719
 720 int lttng_probes_init(void);
 721
 722 extern struct lttng_ctx *lttng_static_ctx;
 723
 724 int lttng_context_init(void);
 725 void lttng_context_exit(void);
 726 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
 727 ssize_t lttng_append_context_index(struct lttng_ctx **ctx_p);
 728 struct lttng_ctx_field *lttng_get_context_field_from_index(struct lttng_ctx *ctx,
 729                 size_t index);
 730 void lttng_context_update(struct lttng_ctx *ctx);
 731 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
 732 int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
 733 void lttng_remove_context_field(struct lttng_ctx **ctx,
 734                                 struct lttng_ctx_field *field);
 735 void lttng_remove_context_field_index(struct lttng_ctx **ctx_p, size_t index);
 736 void lttng_destroy_context(struct lttng_ctx *ctx);
 737 int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
 738 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
 739 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 740 int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
 741 int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
 742 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
 743 int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
 744 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
 745 int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
 746 int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
 747 int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
 748 int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx);
 749 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx);
 750 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
 751 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx);
 752 #else
 753 static inline
 754 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx)
 755 {
 756         return -ENOSYS;
 757 }
 758 #endif
 759 #ifdef CONFIG_PREEMPT_RT_FULL
 760 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx);
 761 #else
 762 static inline
 763 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx)
 764 {
 765         return -ENOSYS;
 766 }
 767 #endif
 768
 769 int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type);
 770
 771 #if defined(CONFIG_CGROUPS) && \
 772         ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
 773          LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
 774 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
 775 #else
 776 static inline
 777 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx)
 778 {
 779         return -ENOSYS;
 780 }
 781 #endif
 782
 783 #if defined(CONFIG_IPC_NS) && \
 784         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 785 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
 786 #else
 787 static inline
 788 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx)
 789 {
 790         return -ENOSYS;
 791 }
 792 #endif
 793
 794 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
 795         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 796 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
 797 #else
 798 static inline
 799 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx)
 800 {
 801         return -ENOSYS;
 802 }
 803 #endif
 804
 805 #if defined(CONFIG_NET_NS) && \
 806         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 807 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
 808 #else
 809 static inline
 810 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx)
 811 {
 812         return -ENOSYS;
 813 }
 814 #endif
 815
 816 #if defined(CONFIG_PID_NS) && \
 817         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 818 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
 819 #else
 820 static inline
 821 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx)
 822 {
 823         return -ENOSYS;
 824 }
 825 #endif
 826
 827 #if defined(CONFIG_USER_NS) && \
 828         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 829 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
 830 #else
 831 static inline
 832 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx)
 833 {
 834         return -ENOSYS;
 835 }
 836 #endif
 837
 838 #if defined(CONFIG_UTS_NS) && \
 839         (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
 840 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
 841 #else
 842 static inline
 843 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx)
 844 {
 845         return -ENOSYS;
 846 }
 847 #endif
 848
 849 #if defined(CONFIG_TIME_NS) && \
 850         (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
 851 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
 852 #else
 853 static inline
 854 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx)
 855 {
 856         return -ENOSYS;
 857 }
 858 #endif
 859
 860 int lttng_add_uid_to_ctx(struct lttng_ctx **ctx);
 861 int lttng_add_euid_to_ctx(struct lttng_ctx **ctx);
 862 int lttng_add_suid_to_ctx(struct lttng_ctx **ctx);
 863 int lttng_add_gid_to_ctx(struct lttng_ctx **ctx);
 864 int lttng_add_egid_to_ctx(struct lttng_ctx **ctx);
 865 int lttng_add_sgid_to_ctx(struct lttng_ctx **ctx);
 866 int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
 867 int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
 868 int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
 869 int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
 870 int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
 871 int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
 872
 873 #if defined(CONFIG_PERF_EVENTS)
 874 int lttng_add_perf_counter_to_ctx(uint32_t type,
 875                                   uint64_t config,
 876                                   const char *name,
 877                                   struct lttng_ctx **ctx);
 878 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
 879                 struct lttng_cpuhp_node *node);
 880 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
 881                 struct lttng_cpuhp_node *node);
 882 #else
 883 static inline
 884 int lttng_add_perf_counter_to_ctx(uint32_t type,
 885                                   uint64_t config,
 886                                   const char *name,
 887                                   struct lttng_ctx **ctx)
 888 {
 889         return -ENOSYS;
 890 }
 891 static inline
 892 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
 893                 struct lttng_cpuhp_node *node)
 894 {
 895         return 0;
 896 }
 897 static inline
 898 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
 899                 struct lttng_cpuhp_node *node)
 900 {
 901         return 0;
 902 }
 903 #endif
 904
 905 int lttng_logger_init(void);
 906 void lttng_logger_exit(void);
 907
 908 extern int lttng_statedump_start(struct lttng_session *session);
 909
 910 #ifdef CONFIG_KPROBES
 911 int lttng_kprobes_register(const char *name,
 912                 const char *symbol_name,
 913                 uint64_t offset,
 914                 uint64_t addr,
 915                 struct lttng_event *event);
 916 void lttng_kprobes_unregister(struct lttng_event *event);
 917 void lttng_kprobes_destroy_private(struct lttng_event *event);
 918 #else
 919 static inline
 920 int lttng_kprobes_register(const char *name,
 921                 const char *symbol_name,
 922                 uint64_t offset,
 923                 uint64_t addr,
 924                 struct lttng_event *event)
 925 {
 926         return -ENOSYS;
 927 }
 928
 929 static inline
 930 void lttng_kprobes_unregister(struct lttng_event *event)
 931 {
 932 }
 933
 934 static inline
 935 void lttng_kprobes_destroy_private(struct lttng_event *event)
 936 {
 937 }
 938 #endif
 939
 940 int lttng_event_add_callsite(struct lttng_event *event,
 941         struct lttng_kernel_event_callsite *callsite);
 942
 943 #ifdef CONFIG_UPROBES
 944 int lttng_uprobes_register(const char *name,
 945         int fd, struct lttng_event *event);
 946 int lttng_uprobes_add_callsite(struct lttng_event *event,
 947         struct lttng_kernel_event_callsite *callsite);
 948 void lttng_uprobes_unregister(struct lttng_event *event);
 949 void lttng_uprobes_destroy_private(struct lttng_event *event);
 950 #else
 951 static inline
 952 int lttng_uprobes_register(const char *name,
 953         int fd, struct lttng_event *event)
 954 {
 955         return -ENOSYS;
 956 }
 957
 958 static inline
 959 int lttng_uprobes_add_callsite(struct lttng_event *event,
 960         struct lttng_kernel_event_callsite *callsite)
 961 {
 962         return -ENOSYS;
 963 }
 964
 965 static inline
 966 void lttng_uprobes_unregister(struct lttng_event *event)
 967 {
 968 }
 969
 970 static inline
 971 void lttng_uprobes_destroy_private(struct lttng_event *event)
 972 {
 973 }
 974 #endif
 975
 976 #ifdef CONFIG_KRETPROBES
 977 int lttng_kretprobes_register(const char *name,
 978                 const char *symbol_name,
 979                 uint64_t offset,
 980                 uint64_t addr,
 981                 struct lttng_event *event_entry,
 982                 struct lttng_event *event_exit);
 983 void lttng_kretprobes_unregister(struct lttng_event *event);
 984 void lttng_kretprobes_destroy_private(struct lttng_event *event);
 985 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
 986         int enable);
 987 #else
 988 static inline
 989 int lttng_kretprobes_register(const char *name,
 990                 const char *symbol_name,
 991                 uint64_t offset,
 992                 uint64_t addr,
 993                 struct lttng_event *event_entry,
 994                 struct lttng_event *event_exit)
 995 {
 996         return -ENOSYS;
 997 }
 998
 999 static inline
1000 void lttng_kretprobes_unregister(struct lttng_event *event)
1001 {
1002 }
1003
1004 static inline
1005 void lttng_kretprobes_destroy_private(struct lttng_event *event)
1006 {
1007 }
1008
1009 static inline
1010 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1011         int enable)
1012 {
1013         return -ENOSYS;
1014 }
1015 #endif
1016
1017 int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
1018
1019 extern const struct file_operations lttng_tracepoint_list_fops;
1020 extern const struct file_operations lttng_syscall_list_fops;
1021
1022 #define TRACEPOINT_HAS_DATA_ARG
1023
1024 static inline bool lttng_is_bytewise_integer(const struct lttng_type *type)
1025 {
1026         if (type->atype != atype_integer)
1027                 return false;
1028         switch (type->u.integer.size) {
1029         case 8:         /* Fall-through. */
1030         case 16:        /* Fall-through. */
1031         case 32:        /* Fall-through. */
1032         case 64:
1033                 break;
1034         default:
1035                 return false;
1036         }
1037         return true;
1038 }
1039
1040 #endif /* _LTTNG_EVENTS_H */