lttng-events.h

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