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