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