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