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 <lttng/kernel-version.h>
  14 #include <linux/list.h>
  15 #include <linux/kprobes.h>
  16 #include <linux/kref.h>
  17 #include <linux/uuid.h>
  18 #include <linux/irq_work.h>
  19 #include <wrapper/uprobes.h>
  20 #include <lttng/cpuhotplug.h>
  21 #include <lttng/tracer.h>
  22 #include <lttng/abi.h>
  23 #include <lttng/abi-old.h>
  24 #include <lttng/endian.h>
  25
  26 #define lttng_is_signed_type(type)      (((type)(-1)) < 0)
  27
  28 struct lttng_channel;
  29 struct lttng_session;
  30 struct lttng_metadata_cache;
  31 struct lib_ring_buffer_ctx;
  32 struct perf_event;
  33 struct perf_event_attr;
  34 struct lib_ring_buffer_config;
  35
  36 /* Type description */
  37
  38 enum abstract_types {
  39         atype_integer,
  40         atype_string,
  41         atype_enum_nestable,
  42         atype_array_nestable,
  43         atype_sequence_nestable,
  44         atype_struct_nestable,
  45         atype_variant_nestable,
  46         NR_ABSTRACT_TYPES,
  47 };
  48
  49 enum lttng_string_encodings {
  50         lttng_encode_none = 0,
  51         lttng_encode_UTF8 = 1,
  52         lttng_encode_ASCII = 2,
  53         NR_STRING_ENCODINGS,
  54 };
  55
  56 enum channel_type {
  57         PER_CPU_CHANNEL,
  58         METADATA_CHANNEL,
  59 };
  60
  61 struct lttng_enum_value {
  62         unsigned long long value;
  63         unsigned int signedness:1;
  64 };
  65
  66 struct lttng_enum_entry {
  67         struct lttng_enum_value start, end;     /* start and end are inclusive */
  68         const char *string;
  69         struct {
  70                 unsigned int is_auto:1;
  71         } options;
  72 };
  73
  74 #define __type_integer(_type, _size, _alignment, _signedness,   \
  75                 _byte_order, _base, _encoding)  \
  76         {                                                       \
  77             .atype = atype_integer,                             \
  78             .u.integer =                                        \
  79                 {                                               \
  80                   .size = (_size) ? : sizeof(_type) * CHAR_BIT, \
  81                   .alignment = (_alignment) ? : lttng_alignof(_type) * CHAR_BIT, \
  82                   .signedness = (_signedness) >= 0 ? (_signedness) : lttng_is_signed_type(_type), \
  83                   .reverse_byte_order = _byte_order != __BYTE_ORDER, \
  84                   .base = _base,                                \
  85                   .encoding = lttng_encode_##_encoding,         \
  86                 },                                              \
  87         }                                                       \
  88
  89 struct lttng_integer_type {
  90         unsigned int size;              /* in bits */
  91         unsigned short alignment;       /* in bits */
  92         unsigned int signedness:1,
  93                 reverse_byte_order:1;
  94         unsigned int base;              /* 2, 8, 10, 16, for pretty print */
  95         enum lttng_string_encodings encoding;
  96 };
  97
  98 struct lttng_type {
  99         enum abstract_types atype;
 100         union {
 101                 struct lttng_integer_type integer;
 102                 struct {
 103                         enum lttng_string_encodings encoding;
 104                 } string;
 105                 struct {
 106                         const struct lttng_enum_desc *desc;     /* Enumeration mapping */
 107                         const struct lttng_type *container_type;
 108                 } enum_nestable;
 109                 struct {
 110                         const struct lttng_type *elem_type;
 111                         unsigned int length;                    /* Num. elems. */
 112                         unsigned int alignment;
 113                 } array_nestable;
 114                 struct {
 115                         const char *length_name;                /* Length field name. */
 116                         const struct lttng_type *elem_type;
 117                         unsigned int alignment;                 /* Alignment before elements. */
 118                 } sequence_nestable;
 119                 struct {
 120                         unsigned int nr_fields;
 121                         const struct lttng_event_field *fields; /* Array of fields. */
 122                         unsigned int alignment;
 123                 } struct_nestable;
 124                 struct {
 125                         const char *tag_name;
 126                         const struct lttng_event_field *choices; /* Array of fields. */
 127                         unsigned int nr_choices;
 128                         unsigned int alignment;
 129                 } variant_nestable;
 130         } u;
 131 };
 132
 133 struct lttng_enum_desc {
 134         const char *name;
 135         const struct lttng_enum_entry *entries;
 136         unsigned int nr_entries;
 137 };
 138
 139 /* Event field description */
 140
 141 struct lttng_event_field {
 142         const char *name;
 143         struct lttng_type type;
 144         unsigned int nowrite:1,         /* do not write into trace */
 145                         user:1,         /* fetch from user-space */
 146                         nofilter:1;     /* do not consider for filter */
 147 };
 148
 149 union lttng_ctx_value {
 150         int64_t s64;
 151         const char *str;
 152         double d;
 153 };
 154
 155 /*
 156  * We need to keep this perf counter field separately from struct
 157  * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
 158  */
 159 struct lttng_perf_counter_field {
 160 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
 161         struct lttng_cpuhp_node cpuhp_prepare;
 162         struct lttng_cpuhp_node cpuhp_online;
 163 #else
 164         struct notifier_block nb;
 165         int hp_enable;
 166 #endif
 167         struct perf_event_attr *attr;
 168         struct perf_event **e;  /* per-cpu array */
 169 };
 170
 171 struct lttng_probe_ctx {
 172         struct lttng_event *event;
 173         struct lttng_event_notifier *event_notifier; // Not sure if we will ever need it.
 174         uint8_t interruptible;
 175 };
 176
 177 struct lttng_ctx_field {
 178         struct lttng_event_field event_field;
 179         size_t (*get_size)(size_t offset);
 180         size_t (*get_size_arg)(size_t offset, struct lttng_ctx_field *field,
 181                                struct lib_ring_buffer_ctx *ctx,
 182                                struct lttng_channel *chan);
 183         void (*record)(struct lttng_ctx_field *field,
 184                        struct lib_ring_buffer_ctx *ctx,
 185                        struct lttng_channel *chan);
 186         void (*get_value)(struct lttng_ctx_field *field,
 187                          struct lttng_probe_ctx *lttng_probe_ctx,
 188                          union lttng_ctx_value *value);
 189         union {
 190                 struct lttng_perf_counter_field *perf_counter;
 191         } u;
 192         void (*destroy)(struct lttng_ctx_field *field);
 193         /*
 194          * Private data to keep state between get_size and record.
 195          * User must perform its own synchronization to protect against
 196          * concurrent and reentrant contexts.
 197          */
 198         void *priv;
 199 };
 200
 201 struct lttng_ctx {
 202         struct lttng_ctx_field *fields;
 203         unsigned int nr_fields;
 204         unsigned int allocated_fields;
 205         size_t largest_align;   /* in bytes */
 206 };
 207
 208 struct lttng_event_desc {
 209         const char *name;               /* lttng-modules name */
 210         const char *kname;              /* Linux kernel name (tracepoints) */
 211         void *probe_callback;           /* store-event and count-event probe */
 212         const struct lttng_event_ctx *ctx;      /* context */
 213         const struct lttng_event_field *fields; /* event payload */
 214         unsigned int nr_fields;
 215         struct module *owner;
 216         void *event_notifier_callback;
 217 };
 218
 219 struct lttng_probe_desc {
 220         const char *provider;
 221         const struct lttng_event_desc **event_desc;
 222         unsigned int nr_events;
 223         struct list_head head;                  /* chain registered probes */
 224         struct list_head lazy_init_head;
 225         int lazy;                               /* lazy registration */
 226 };
 227
 228 struct lttng_krp;                               /* Kretprobe handling */
 229
 230 enum lttng_event_type {
 231         LTTNG_TYPE_EVENT = 0,
 232         LTTNG_TYPE_ENABLER = 1,
 233 };
 234
 235 enum lttng_bytecode_node_type {
 236         LTTNG_BYTECODE_NODE_TYPE_FILTER,
 237         LTTNG_BYTECODE_NODE_TYPE_CAPTURE,
 238 };
 239
 240 struct lttng_bytecode_node {
 241         enum lttng_bytecode_node_type type;
 242         struct list_head node;
 243         struct lttng_enabler *enabler;
 244         struct {
 245                 uint32_t len;
 246                 uint32_t reloc_offset;
 247                 uint64_t seqnum;
 248                 char data[];
 249         } bc;
 250 };
 251
 252 /*
 253  * Bytecode interpreter return value masks.
 254  */
 255 enum lttng_bytecode_interpreter_ret {
 256         LTTNG_INTERPRETER_DISCARD = 0,
 257         LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0),
 258         /* Other bits are kept for future use. */
 259 };
 260
 261 struct lttng_interpreter_output;
 262
 263 struct lttng_bytecode_runtime {
 264         /* Associated bytecode */
 265         struct lttng_bytecode_node *bc;
 266         union {
 267                 uint64_t (*filter)(void *filter_data,
 268                                 struct lttng_probe_ctx *lttng_probe_ctx,
 269                                 const char *filter_stack_data);
 270                 uint64_t (*capture)(void *filter_data,
 271                                 struct lttng_probe_ctx *lttng_probe_ctx,
 272                                 const char *capture_stack_data,
 273                                 struct lttng_interpreter_output *output);
 274         } interpreter_funcs;
 275         int link_failed;
 276         struct list_head node;  /* list of bytecode runtime in event */
 277         struct lttng_ctx *ctx;
 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         union {
 290                 struct lttng_event *event;
 291                 struct lttng_event_notifier *event_notifier;
 292         } u;
 293         loff_t offset;
 294         struct uprobe_consumer up_consumer;
 295         struct list_head node;
 296 };
 297
 298 struct lttng_kprobe {
 299         struct kprobe kp;
 300         char *symbol_name;
 301         uint64_t user_token;
 302 };
 303
 304 struct lttng_uprobe {
 305         struct inode *inode;
 306         struct list_head head;
 307         uint64_t user_token;
 308 };
 309
 310 enum lttng_syscall_entryexit {
 311         LTTNG_SYSCALL_ENTRY,
 312         LTTNG_SYSCALL_EXIT,
 313 };
 314
 315 enum lttng_syscall_abi {
 316         LTTNG_SYSCALL_ABI_NATIVE,
 317         LTTNG_SYSCALL_ABI_COMPAT,
 318 };
 319
 320 struct lttng_syscall {
 321         struct list_head node;                  /* chain registered syscall trigger */
 322         unsigned int syscall_id;
 323         bool is_compat;
 324 };
 325
 326 enum lttng_key_token_type {
 327         LTTNG_KEY_TOKEN_STRING = 0,
 328         LTTNG_KEY_TOKEN_EVENT_NAME = 1,
 329 };
 330
 331 #define LTTNG_KEY_TOKEN_STRING_LEN_MAX LTTNG_KERNEL_KEY_TOKEN_STRING_LEN_MAX
 332 struct lttng_key_token {
 333         enum lttng_key_token_type type;
 334         union {
 335                 char string[LTTNG_KEY_TOKEN_STRING_LEN_MAX];
 336         } arg;
 337 };
 338
 339 #define LTTNG_NR_KEY_TOKEN LTTNG_KERNEL_NR_KEY_TOKEN
 340 struct lttng_counter_key_dimension {
 341         size_t nr_key_tokens;
 342         struct lttng_key_token key_tokens[LTTNG_KERNEL_NR_KEY_TOKEN];
 343 };
 344
 345 #define LTTNG_COUNTER_DIMENSION_MAX LTTNG_KERNEL_COUNTER_DIMENSION_MAX
 346 struct lttng_counter_key {
 347         size_t nr_dimensions;
 348         struct lttng_counter_key_dimension key_dimensions[LTTNG_COUNTER_DIMENSION_MAX];
 349 };
 350
 351 #define LTTNG_KEY_TOKEN_STRING_LEN_MAX LTTNG_KERNEL_KEY_TOKEN_STRING_LEN_MAX
 352
 353 /*
 354  * lttng_event structure is referred to by the tracing fast path. It must be
 355  * kept small.
 356  */
 357 struct lttng_event {
 358         enum lttng_event_type evtype;   /* First field. */
 359         struct lttng_event_container *container;
 360         size_t id;
 361         int enabled;
 362         const struct lttng_event_desc *desc;
 363         void *filter;
 364         struct lttng_ctx *ctx;
 365         enum lttng_kernel_instrumentation instrumentation;
 366         union {
 367                 struct lttng_kprobe kprobe;
 368                 struct {
 369                         struct lttng_krp *lttng_krp;
 370                         char *symbol_name;
 371                         uint64_t user_token;
 372                 } kretprobe;
 373                 struct lttng_uprobe uprobe;
 374                 struct {
 375                         enum lttng_syscall_entryexit entryexit;
 376                         enum lttng_syscall_abi abi;
 377                         struct hlist_node node;                 /* chain registered syscall event */
 378                 } syscall;
 379         } u;
 380         struct list_head list;          /* Event list in session */
 381         unsigned int metadata_dumped:1;
 382
 383         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 384         struct list_head enablers_ref_head;
 385         struct hlist_node name_hlist;   /* session ht of events, per event name */
 386         struct hlist_node key_hlist;    /* session ht of events, per key */
 387         int registered;                 /* has reg'd tracepoint probe */
 388         /* list of struct lttng_bytecode_runtime, sorted by seqnum */
 389         struct list_head filter_bytecode_runtime_head;
 390         int has_enablers_without_bytecode;
 391
 392         /* List node of actions to perform (for syscall events). */
 393         struct hlist_node action_list;
 394
 395         char key[LTTNG_KEY_TOKEN_STRING_LEN_MAX];
 396
 397         /*
 398          * For non-coalesce-hit event containers, each event is
 399          * associated with a single event enabler user_token.
 400          */
 401         uint64_t user_token;
 402 };
 403
 404 struct lttng_kernel_notifier_ctx {
 405         int eval_capture;
 406 };
 407
 408 // FIXME: Really similar to lttng_event above. Could those be merged ?
 409 struct lttng_event_notifier {
 410         enum lttng_event_type evtype;   /* First field. */
 411         uint64_t user_token;
 412         uint64_t error_counter_index;
 413         int enabled;
 414         int registered;                 /* has reg'd tracepoint probe */
 415         const struct lttng_event_desc *desc;
 416         void *filter;
 417         struct list_head list;          /* event_notifier list in event_notifier group */
 418
 419         enum lttng_kernel_instrumentation instrumentation;
 420         union {
 421                 struct lttng_kprobe kprobe;
 422                 struct lttng_uprobe uprobe;
 423                 struct {
 424                         enum lttng_syscall_entryexit entryexit;
 425                         enum lttng_syscall_abi abi;
 426                         struct hlist_node node;                 /* chain registered syscall event_notifier */
 427                         unsigned int syscall_id;
 428                 } syscall;
 429
 430         } u;
 431
 432         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 433         struct list_head enablers_ref_head;
 434         struct hlist_node hlist;        /* session ht of event_notifiers */
 435         /* list of struct lttng_bytecode_runtime, sorted by seqnum */
 436         struct list_head filter_bytecode_runtime_head;
 437         size_t num_captures;
 438         struct list_head capture_bytecode_runtime_head;
 439         int has_enablers_without_bytecode;
 440         int eval_capture;               /* Should evaluate capture */
 441
 442         void (*send_notification)(struct lttng_event_notifier *event_notifier,
 443                         struct lttng_probe_ctx *lttng_probe_ctx,
 444                         const char *interpreter_stack_data,
 445                         struct lttng_kernel_notifier_ctx *notif_ctx);
 446         struct lttng_event_notifier_group *group; /* Weak ref */
 447 };
 448
 449 enum lttng_enabler_format_type {
 450         LTTNG_ENABLER_FORMAT_STAR_GLOB,
 451         LTTNG_ENABLER_FORMAT_NAME,
 452 };
 453
 454 /*
 455  * Enabler field, within whatever object is enabling an event. Target of
 456  * backward reference.
 457  */
 458 struct lttng_enabler {
 459         enum lttng_event_type evtype;   /* First field. */
 460
 461         enum lttng_enabler_format_type format_type;
 462
 463         /* head list of struct lttng_bytecode_node */
 464         struct list_head filter_bytecode_head;
 465
 466         struct lttng_kernel_event event_param;
 467         unsigned int enabled:1;
 468
 469         uint64_t user_token;            /* User-provided token. */
 470 };
 471
 472 struct lttng_event_enabler {
 473         struct lttng_enabler base;
 474         struct list_head node;  /* per-session list of enablers */
 475         struct lttng_event_container *container;
 476         struct lttng_counter_key key;
 477         /*
 478          * Unused, but kept around to make it explicit that the tracer can do
 479          * it.
 480          */
 481         struct lttng_ctx *ctx;
 482 };
 483
 484 struct lttng_event_notifier_enabler {
 485         struct lttng_enabler base;
 486         uint64_t error_counter_index;
 487         struct list_head node;  /* List of event_notifier enablers */
 488         struct lttng_event_notifier_group *group;
 489
 490         /* head list of struct lttng_bytecode_node */
 491         struct list_head capture_bytecode_head;
 492         uint64_t num_captures;
 493 };
 494
 495
 496 static inline
 497 struct lttng_enabler *lttng_event_enabler_as_enabler(
 498                 struct lttng_event_enabler *event_enabler)
 499 {
 500         return &event_enabler->base;
 501 }
 502
 503 static inline
 504 struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
 505                 struct lttng_event_notifier_enabler *event_notifier_enabler)
 506 {
 507         return &event_notifier_enabler->base;
 508 }
 509
 510 struct lttng_channel_ops {
 511         struct channel *(*channel_create)(const char *name,
 512                                 void *priv,
 513                                 void *buf_addr,
 514                                 size_t subbuf_size, size_t num_subbuf,
 515                                 unsigned int switch_timer_interval,
 516                                 unsigned int read_timer_interval);
 517         void (*channel_destroy)(struct channel *chan);
 518         struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
 519         int (*buffer_has_read_closed_stream)(struct channel *chan);
 520         void (*buffer_read_close)(struct lib_ring_buffer *buf);
 521         int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
 522                              uint32_t event_id);
 523         void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
 524         void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
 525                             size_t len);
 526         void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
 527                                       const void *src, size_t len);
 528         void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
 529                              int c, size_t len);
 530         void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
 531                              size_t len);
 532         void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
 533                                        const char __user *src, size_t len);
 534         /*
 535          * packet_avail_size returns the available size in the current
 536          * packet. Note that the size returned is only a hint, since it
 537          * may change due to concurrent writes.
 538          */
 539         size_t (*packet_avail_size)(struct channel *chan);
 540         wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
 541         wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 542         int (*is_finalized)(struct channel *chan);
 543         int (*is_disabled)(struct channel *chan);
 544         int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
 545                         struct lib_ring_buffer *bufb,
 546                         uint64_t *timestamp_begin);
 547         int (*timestamp_end) (const struct lib_ring_buffer_config *config,
 548                         struct lib_ring_buffer *bufb,
 549                         uint64_t *timestamp_end);
 550         int (*events_discarded) (const struct lib_ring_buffer_config *config,
 551                         struct lib_ring_buffer *bufb,
 552                         uint64_t *events_discarded);
 553         int (*content_size) (const struct lib_ring_buffer_config *config,
 554                         struct lib_ring_buffer *bufb,
 555                         uint64_t *content_size);
 556         int (*packet_size) (const struct lib_ring_buffer_config *config,
 557                         struct lib_ring_buffer *bufb,
 558                         uint64_t *packet_size);
 559         int (*stream_id) (const struct lib_ring_buffer_config *config,
 560                         struct lib_ring_buffer *bufb,
 561                         uint64_t *stream_id);
 562         int (*current_timestamp) (const struct lib_ring_buffer_config *config,
 563                         struct lib_ring_buffer *bufb,
 564                         uint64_t *ts);
 565         int (*sequence_number) (const struct lib_ring_buffer_config *config,
 566                         struct lib_ring_buffer *bufb,
 567                         uint64_t *seq);
 568         int (*instance_id) (const struct lib_ring_buffer_config *config,
 569                         struct lib_ring_buffer *bufb,
 570                         uint64_t *id);
 571 };
 572
 573 struct lttng_counter_ops {
 574         struct lib_counter *(*counter_create)(size_t nr_dimensions,
 575                         const size_t *max_nr_elem,      /* for each dimension */
 576                         int64_t global_sum_step);
 577         void (*counter_destroy)(struct lib_counter *counter);
 578         int (*counter_add)(struct lib_counter *counter, const size_t *dimension_indexes,
 579                         int64_t v);
 580         /*
 581          * counter_read reads a specific cpu's counter if @cpu >= 0, or
 582          * the global aggregation counter if @cpu == -1.
 583          */
 584         int (*counter_read)(struct lib_counter *counter, const size_t *dimension_indexes, int cpu,
 585                          int64_t *value, bool *overflow, bool *underflow);
 586         /*
 587          * counter_aggregate returns the total sum of all per-cpu counters and
 588          * the global aggregation counter.
 589          */
 590         int (*counter_aggregate)(struct lib_counter *counter, const size_t *dimension_indexes,
 591                         int64_t *value, bool *overflow, bool *underflow);
 592         int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
 593 };
 594
 595 struct lttng_transport {
 596         char *name;
 597         struct module *owner;
 598         struct list_head node;
 599         struct lttng_channel_ops ops;
 600 };
 601
 602 struct lttng_counter_transport {
 603         char *name;
 604         struct module *owner;
 605         struct list_head node;
 606         struct lttng_counter_ops ops;
 607 };
 608
 609 struct lttng_syscall_filter;
 610
 611 #define LTTNG_EVENT_HT_BITS             12
 612 #define LTTNG_EVENT_HT_SIZE             (1U << LTTNG_EVENT_HT_BITS)
 613
 614 struct lttng_event_ht {
 615         struct hlist_head table[LTTNG_EVENT_HT_SIZE];
 616 };
 617
 618 #define LTTNG_EVENT_NOTIFIER_HT_BITS            12
 619 #define LTTNG_EVENT_NOTIFIER_HT_SIZE            (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
 620
 621 struct lttng_event_notifier_ht {
 622         struct hlist_head table[LTTNG_EVENT_NOTIFIER_HT_SIZE];
 623 };
 624
 625 enum lttng_event_container_type {
 626         LTTNG_EVENT_CONTAINER_CHANNEL,
 627         LTTNG_EVENT_CONTAINER_COUNTER,
 628 };
 629
 630 /*
 631  * An event can be contained within either a channel or a counter.
 632  */
 633 struct lttng_event_container {
 634         enum lttng_event_container_type type;
 635
 636         struct file *file;                      /* File associated to event container */
 637         struct lttng_session *session;          /* Session containing the container */
 638         int enabled;
 639         struct hlist_head *sc_table;            /* for syscall tracing */
 640         struct hlist_head *compat_sc_table;
 641         struct hlist_head *sc_exit_table;       /* for syscall exit tracing */
 642         struct hlist_head *compat_sc_exit_table;
 643
 644         /*
 645          * Combining all unknown syscall events works as long as they
 646          * are only matched by "all" syscalls enablers, but will require
 647          * a design change when we allow matching by syscall number, for
 648          * instance by allocating sc_tables accomodating NR_syscalls
 649          * entries.
 650          */
 651         struct hlist_head sc_unknown;           /* for unknown syscalls */
 652         struct hlist_head sc_compat_unknown;
 653         struct hlist_head sc_exit_unknown;
 654         struct hlist_head compat_sc_exit_unknown;
 655
 656         struct lttng_syscall_filter *sc_filter;
 657         int syscall_all_entry;
 658         int syscall_all_exit;
 659         unsigned int sys_enter_registered:1,
 660                 sys_exit_registered:1,
 661                 tstate:1;                       /* Transient enable state */
 662         bool coalesce_hits;
 663 };
 664
 665 struct lttng_channel {
 666         unsigned int id;
 667         struct channel *chan;           /* Channel buffers */
 668         struct lttng_ctx *ctx;
 669         /* Event ID management */
 670         unsigned int free_event_id;     /* Next event ID to allocate */
 671         struct list_head list;          /* Channel list */
 672         struct lttng_channel_ops *ops;
 673         struct lttng_transport *transport;
 674         int header_type;                /* 0: unset, 1: compact, 2: large */
 675         enum channel_type channel_type;
 676         unsigned int metadata_dumped:1;
 677
 678         struct lttng_event_container parent;
 679 };
 680
 681 struct lttng_metadata_stream {
 682         void *priv;                     /* Ring buffer private data */
 683         struct lttng_metadata_cache *metadata_cache;
 684         unsigned int metadata_in;       /* Bytes read from the cache */
 685         unsigned int metadata_out;      /* Bytes consumed from stream */
 686         int finalized;                  /* Has channel been finalized */
 687         wait_queue_head_t read_wait;    /* Reader buffer-level wait queue */
 688         struct list_head list;          /* Stream list */
 689         struct lttng_transport *transport;
 690         uint64_t version;               /* Current version of the metadata cache */
 691         bool coherent;                  /* Stream in a coherent state */
 692 };
 693
 694 #define LTTNG_DYNAMIC_LEN_STACK_SIZE    128
 695
 696 struct lttng_dynamic_len_stack {
 697         size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
 698         size_t offset;
 699 };
 700
 701 DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
 702
 703 /*
 704  * struct lttng_id_tracker declared in header due to deferencing of *v
 705  * in RCU_INITIALIZER(v).
 706  */
 707 #define LTTNG_ID_HASH_BITS      6
 708 #define LTTNG_ID_TABLE_SIZE     (1 << LTTNG_ID_HASH_BITS)
 709
 710 enum tracker_type {
 711         TRACKER_PID,
 712         TRACKER_VPID,
 713         TRACKER_UID,
 714         TRACKER_VUID,
 715         TRACKER_GID,
 716         TRACKER_VGID,
 717
 718         TRACKER_UNKNOWN,
 719 };
 720
 721 struct lttng_id_tracker_rcu {
 722         struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
 723 };
 724
 725 struct lttng_id_tracker {
 726         struct lttng_session *session;
 727         enum tracker_type tracker_type;
 728         struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
 729 };
 730
 731 struct lttng_id_hash_node {
 732         struct hlist_node hlist;
 733         int id;
 734 };
 735
 736 struct lttng_session {
 737         int active;                     /* Is trace session active ? */
 738         int been_active;                /* Has trace session been active ? */
 739         struct file *file;              /* File associated to session */
 740         struct list_head chan;          /* Channel list head */
 741         struct list_head events;        /* Event list head */
 742         struct list_head counters;      /* Counters list head */
 743         struct list_head list;          /* Session list */
 744         unsigned int free_chan_id;      /* Next chan ID to allocate */
 745         uuid_le uuid;                   /* Trace session unique ID */
 746         struct lttng_metadata_cache *metadata_cache;
 747         struct lttng_id_tracker pid_tracker;
 748         struct lttng_id_tracker vpid_tracker;
 749         struct lttng_id_tracker uid_tracker;
 750         struct lttng_id_tracker vuid_tracker;
 751         struct lttng_id_tracker gid_tracker;
 752         struct lttng_id_tracker vgid_tracker;
 753         unsigned int metadata_dumped:1,
 754                 tstate:1;               /* Transient enable state */
 755         /* List of event enablers */
 756         struct list_head enablers_head;
 757         /* Hash table of events indexed by event name */
 758         struct lttng_event_ht events_name_ht;
 759         /* Hash table of events indexed by key  */
 760         struct lttng_event_ht events_key_ht;
 761         char name[LTTNG_KERNEL_SESSION_NAME_LEN];
 762         char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 763 };
 764
 765 struct lttng_counter_map_descriptor {
 766         uint64_t user_token;
 767         size_t array_index;
 768         char key[LTTNG_KERNEL_COUNTER_KEY_LEN];
 769 };
 770
 771 struct lttng_counter_map {
 772         struct lttng_counter_map_descriptor *descriptors;
 773         size_t nr_descriptors;
 774         size_t alloc_len;
 775         struct mutex lock;              /* counter map lock */
 776 };
 777
 778 struct lttng_counter {
 779         struct file *owner;
 780         struct lttng_counter_transport *transport;
 781         struct lib_counter *counter;
 782         struct lttng_counter_ops *ops;
 783         struct list_head node;          /* Counter list (in session) */
 784
 785         size_t free_index;              /* Next index to allocate */
 786         struct lttng_counter_map map;
 787
 788         struct lttng_event_container parent;
 789 };
 790
 791 struct lttng_event_notifier_group {
 792         struct file *file;              /* File associated to event notifier group */
 793         struct file *notif_file;        /* File used to expose notifications to userspace. */
 794         struct list_head node;          /* event notifier group list */
 795         struct list_head enablers_head; /* List of enablers */
 796         struct list_head event_notifiers_head; /* List of event notifier */
 797         struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
 798         struct lttng_ctx *ctx;          /* Contexts for filters. */
 799         struct lttng_channel_ops *ops;
 800         struct lttng_transport *transport;
 801         struct channel *chan;           /* Ring buffer channel for event notifier group. */
 802         struct lib_ring_buffer *buf;    /* Ring buffer for event notifier group. */
 803         wait_queue_head_t read_wait;
 804         struct irq_work wakeup_pending; /* Pending wakeup irq work. */
 805         struct lttng_event_notifier *sc_unknown;        /* for unknown syscalls */
 806         struct lttng_event_notifier *sc_compat_unknown;
 807
 808         struct lttng_syscall_filter *sc_filter;
 809
 810         struct hlist_head *event_notifier_syscall_dispatch;
 811         struct hlist_head *event_notifier_compat_syscall_dispatch;
 812         struct hlist_head *event_notifier_exit_syscall_dispatch;
 813         struct hlist_head *event_notifier_exit_compat_syscall_dispatch;
 814
 815         struct hlist_head event_notifier_unknown_syscall_dispatch;
 816         struct hlist_head event_notifier_compat_unknown_syscall_dispatch;
 817         struct hlist_head event_notifier_exit_unknown_syscall_dispatch;
 818         struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch;
 819
 820         int syscall_all_entry;
 821         int syscall_all_exit;
 822
 823         unsigned int sys_enter_registered:1, sys_exit_registered:1;
 824
 825         struct lttng_counter *error_counter;
 826         size_t error_counter_len;
 827 };
 828
 829 struct lttng_metadata_cache {
 830         char *data;                     /* Metadata cache */
 831         unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
 832         unsigned int metadata_written;  /* Number of bytes written in metadata cache */
 833         atomic_t producing;             /* Metadata being produced (incomplete) */
 834         struct kref refcount;           /* Metadata cache usage */
 835         struct list_head metadata_stream;       /* Metadata stream list */
 836         uuid_le uuid;                   /* Trace session unique ID (copy) */
 837         struct mutex lock;              /* Produce/consume lock */
 838         uint64_t version;               /* Current version of the metadata */
 839 };
 840
 841 static inline
 842 struct lttng_event_container *lttng_channel_get_event_container(struct lttng_channel *channel)
 843 {
 844         return &channel->parent;
 845 }
 846
 847 static inline
 848 struct lttng_event_container *lttng_counter_get_event_container(struct lttng_counter *counter)
 849 {
 850         return &counter->parent;
 851 }
 852
 853 static inline
 854 struct lttng_channel *lttng_event_container_get_channel(struct lttng_event_container *container)
 855 {
 856         if (container->type != LTTNG_EVENT_CONTAINER_CHANNEL)
 857                 return NULL;
 858         return container_of(container, struct lttng_channel, parent);
 859 }
 860
 861 static inline
 862 struct lttng_counter *lttng_event_container_get_counter(struct lttng_event_container *container)
 863 {
 864         if (container->type != LTTNG_EVENT_CONTAINER_COUNTER)
 865                 return NULL;
 866         return container_of(container, struct lttng_counter, parent);
 867 }
 868
 869 void lttng_lock_sessions(void);
 870 void lttng_unlock_sessions(void);
 871
 872 struct list_head *lttng_get_probe_list_head(void);
 873
 874 struct lttng_event_enabler *lttng_event_enabler_create(
 875                 enum lttng_enabler_format_type format_type,
 876                 struct lttng_kernel_event *event_param,
 877                 const struct lttng_counter_key *key,
 878                 struct lttng_event_container *container);
 879
 880 int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler);
 881 int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
 882 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
 883                 struct lttng_event_notifier_group *event_notifier_group,
 884                 enum lttng_enabler_format_type format_type,
 885                 struct lttng_kernel_event_notifier *event_notifier_param);
 886
 887 int lttng_event_notifier_enabler_enable(
 888                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 889 int lttng_event_notifier_enabler_disable(
 890                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 891 int lttng_fix_pending_events(void);
 892 int lttng_fix_pending_event_notifiers(void);
 893 int lttng_session_active(void);
 894 bool lttng_event_notifier_active(void);
 895
 896 struct lttng_session *lttng_session_create(void);
 897 int lttng_session_enable(struct lttng_session *session);
 898 int lttng_session_disable(struct lttng_session *session);
 899 void lttng_session_destroy(struct lttng_session *session);
 900 int lttng_session_metadata_regenerate(struct lttng_session *session);
 901 int lttng_session_statedump(struct lttng_session *session);
 902 void metadata_cache_destroy(struct kref *kref);
 903
 904 int lttng_kernel_counter_read(struct lttng_counter *counter,
 905                 const size_t *dimension_indexes, int32_t cpu,
 906                 int64_t *val, bool *overflow, bool *underflow);
 907 int lttng_kernel_counter_aggregate(struct lttng_counter *counter,
 908                 const size_t *dimension_indexes, int64_t *val,
 909                 bool *overflow, bool *underflow);
 910 int lttng_kernel_counter_clear(struct lttng_counter *counter,
 911                 const size_t *dimension_indexes);
 912
 913
 914 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
 915 int lttng_event_notifier_group_create_error_counter(
 916                 struct file *event_notifier_group_file,
 917                 const struct lttng_kernel_counter_conf *error_counter_conf);
 918
 919 void lttng_event_notifier_group_destroy(
 920                 struct lttng_event_notifier_group *event_notifier_group);
 921 int lttng_event_notifier_group_set_error_counter(
 922                 struct lttng_event_notifier_group *event_notifier_group,
 923                 const char *counter_transport_name,
 924                 size_t counter_len);
 925
 926 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 927                                        const char *transport_name,
 928                                        void *buf_addr,
 929                                        size_t subbuf_size, size_t num_subbuf,
 930                                        unsigned int switch_timer_interval,
 931                                        unsigned int read_timer_interval,
 932                                        enum channel_type channel_type);
 933
 934 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
 935 struct lttng_event *lttng_event_create(struct lttng_event_container *container,
 936                                 struct lttng_kernel_event *event_param,
 937                                 const struct lttng_counter_key *key,
 938                                 void *filter,
 939                                 const struct lttng_event_desc *event_desc,
 940                                 enum lttng_kernel_instrumentation itype,
 941                                 uint64_t user_token);
 942 struct lttng_event *_lttng_event_create(struct lttng_event_container *container,
 943                                 struct lttng_kernel_event *event_param,
 944                                 const struct lttng_counter_key *key,
 945                                 void *filter,
 946                                 const struct lttng_event_desc *event_desc,
 947                                 enum lttng_kernel_instrumentation itype,
 948                                 uint64_t user_token);
 949 struct lttng_counter *lttng_session_create_counter(
 950         struct lttng_session *session,
 951         const char *counter_transport_name,
 952         size_t number_dimensions, const size_t *dimensions_sizes,
 953         bool coalesce_hits);
 954
 955 struct lttng_event_notifier *lttng_event_notifier_create(
 956                                 const struct lttng_event_desc *event_notifier_desc,
 957                                 uint64_t id,
 958                                 uint64_t error_counter_idx,
 959                                 struct lttng_event_notifier_group *event_notifier_group,
 960                                 struct lttng_kernel_event_notifier *event_notifier_param,
 961                                 void *filter,
 962                                 enum lttng_kernel_instrumentation itype);
 963 struct lttng_event_notifier *_lttng_event_notifier_create(
 964                                 const struct lttng_event_desc *event_notifier_desc,
 965                                 uint64_t id,
 966                                 uint64_t error_counter_idx,
 967                                 struct lttng_event_notifier_group *event_notifier_group,
 968                                 struct lttng_kernel_event_notifier *event_notifier_param,
 969                                 void *filter,
 970                                 enum lttng_kernel_instrumentation itype);
 971
 972 int lttng_event_container_enable(struct lttng_event_container *container);
 973 int lttng_event_container_disable(struct lttng_event_container *container);
 974 int lttng_event_enable(struct lttng_event *event);
 975 int lttng_event_disable(struct lttng_event *event);
 976
 977 int lttng_event_notifier_enable(struct lttng_event_notifier *event_notifier);
 978 int lttng_event_notifier_disable(struct lttng_event_notifier *event_notifier);
 979
 980 void lttng_transport_register(struct lttng_transport *transport);
 981 void lttng_transport_unregister(struct lttng_transport *transport);
 982
 983 void lttng_counter_transport_register(struct lttng_counter_transport *transport);
 984 void lttng_counter_transport_unregister(struct lttng_counter_transport *transport);
 985
 986 void synchronize_trace(void);
 987 int lttng_abi_init(void);
 988 int lttng_abi_compat_old_init(void);
 989 void lttng_abi_exit(void);
 990 void lttng_abi_compat_old_exit(void);
 991
 992 int lttng_probe_register(struct lttng_probe_desc *desc);
 993 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 994 const struct lttng_event_desc *lttng_event_desc_get(const char *name);
 995 void lttng_event_desc_put(const struct lttng_event_desc *desc);
 996 int lttng_probes_init(void);
 997 void lttng_probes_exit(void);
 998
 999 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
1000                 struct channel *chan, bool *coherent);
1001
1002 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
1003 int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
1004 void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
1005 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
1006 int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
1007 int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
1008
1009 int lttng_session_track_id(struct lttng_session *session,
1010                 enum tracker_type tracker_type, int id);
1011 int lttng_session_untrack_id(struct lttng_session *session,
1012                 enum tracker_type tracker_type, int id);
1013
1014 int lttng_session_list_tracker_ids(struct lttng_session *session,
1015                 enum tracker_type tracker_type);
1016
1017 void lttng_clock_ref(void);
1018 void lttng_clock_unref(void);
1019
1020 int lttng_desc_match_enabler(const struct lttng_event_desc *desc,
1021                 struct lttng_enabler *enabler);
1022
1023 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
1024 int lttng_syscalls_register_event(struct lttng_event_enabler *event_enabler, void *filter);
1025 int lttng_syscalls_unregister_event_container(struct lttng_event_container *event_container);
1026 int lttng_syscalls_destroy_event_container(struct lttng_event_container *container);
1027 int lttng_syscall_filter_enable_event(struct lttng_event_container *container,
1028                 struct lttng_event *event);
1029 int lttng_syscall_filter_disable_event(struct lttng_event_container *container,
1030                 struct lttng_event *event);
1031 long lttng_event_container_syscall_mask(struct lttng_event_container *container,
1032                 struct lttng_kernel_syscall_mask __user *usyscall_mask);
1033
1034 int lttng_syscalls_register_event_notifier(
1035                 struct lttng_event_notifier_enabler *event_notifier_enabler,
1036                 void *filter);
1037 int lttng_syscals_create_matching_event_notifiers(
1038                 struct lttng_event_notifier_enabler *event_notifier_enabler, void *filter);
1039 int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group *group);
1040 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier *event_notifier);
1041 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier *event_notifier);
1042 #else
1043 static inline int lttng_syscalls_register_event(
1044                 struct lttng_event_enabler *event_enabler, void *filter)
1045 {
1046         return -ENOSYS;
1047 }
1048
1049 static inline int lttng_syscalls_unregister_event_container(struct lttng_event_container *event_container)
1050 {
1051         return 0;
1052 }
1053
1054 static inline int lttng_syscalls_destroy_event_container(struct lttng_event_container *event_container)
1055 {
1056         return 0;
1057 }
1058
1059 static inline int lttng_syscall_filter_enable_event(struct lttng_event_container *event_container,
1060                 struct lttng_event *event);
1061 {
1062         return -ENOSYS;
1063 }
1064
1065 static inline int lttng_syscall_filter_disable_event(struct lttng_event_container *event_container,
1066                 struct lttng_event *event);
1067 {
1068         return -ENOSYS;
1069 }
1070
1071 static inline long lttng_channel_syscall_mask(struct lttng_event_container *event_container,
1072                 struct lttng_kernel_syscall_mask __user *usyscall_mask)
1073 {
1074         return -ENOSYS;
1075 }
1076
1077 static inline int lttng_syscalls_register_event_notifier(
1078                 struct lttng_event_notifier_group *group, void *filter)
1079 {
1080         return -ENOSYS;
1081 }
1082
1083 static inline int lttng_syscalls_unregister_event_notifier_group(
1084                 struct lttng_event_notifier_group *group)
1085 {
1086         return 0;
1087 }
1088
1089 static inline int lttng_syscall_filter_enable_event_notifier(
1090                 struct lttng_event_notifier_group *group,
1091                 const char *name)
1092 {
1093         return -ENOSYS;
1094 }
1095
1096 static inline int lttng_syscall_filter_disable_event_notifier(
1097                 struct lttng_event_notifier_group *group,
1098                 const char *name)
1099 {
1100         return -ENOSYS;
1101 }
1102
1103 #endif
1104
1105 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler *event_enabler,
1106                 struct lttng_kernel_filter_bytecode __user *bytecode);
1107 int lttng_event_notifier_enabler_attach_filter_bytecode(
1108                 struct lttng_event_notifier_enabler *event_notifier_enabler,
1109                 struct lttng_kernel_filter_bytecode __user *bytecode);
1110 int lttng_event_notifier_enabler_attach_capture_bytecode(
1111                 struct lttng_event_notifier_enabler *event_notifier_enabler,
1112                 struct lttng_kernel_capture_bytecode __user *bytecode);
1113
1114 void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
1115                 struct lttng_ctx *ctx,
1116                 struct list_head *instance_bytecode_runtime_head,
1117                 struct list_head *enabler_bytecode_runtime_head);
1118 void lttng_free_event_filter_runtime(struct lttng_event *event);
1119 void lttng_free_event_notifier_filter_runtime(struct lttng_event_notifier *event_notifier);
1120
1121 int lttng_probes_init(void);
1122
1123 extern struct lttng_ctx *lttng_static_ctx;
1124
1125 int lttng_context_init(void);
1126 void lttng_context_exit(void);
1127 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
1128 ssize_t lttng_append_context_index(struct lttng_ctx **ctx_p);
1129 struct lttng_ctx_field *lttng_get_context_field_from_index(struct lttng_ctx *ctx,
1130                 size_t index);
1131 void lttng_context_update(struct lttng_ctx *ctx);
1132 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
1133 int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
1134 void lttng_remove_context_field(struct lttng_ctx **ctx,
1135                                 struct lttng_ctx_field *field);
1136 void lttng_remove_context_field_index(struct lttng_ctx **ctx_p, size_t index);
1137 void lttng_destroy_context(struct lttng_ctx *ctx);
1138 int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
1139 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
1140 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
1141 int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
1142 int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
1143 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
1144 int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
1145 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
1146 int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
1147 int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
1148 int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
1149 int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx);
1150 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx);
1151 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
1152 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx);
1153 #else
1154 static inline
1155 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx)
1156 {
1157         return -ENOSYS;
1158 }
1159 #endif
1160 #ifdef CONFIG_PREEMPT_RT_FULL
1161 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx);
1162 #else
1163 static inline
1164 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx)
1165 {
1166         return -ENOSYS;
1167 }
1168 #endif
1169
1170 int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type);
1171
1172 #if defined(CONFIG_CGROUPS) && \
1173         ((LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,6,0)) || \
1174          LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
1175 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
1176 #else
1177 static inline
1178 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx)
1179 {
1180         return -ENOSYS;
1181 }
1182 #endif
1183
1184 #if defined(CONFIG_IPC_NS) && \
1185         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1186 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
1187 #else
1188 static inline
1189 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx)
1190 {
1191         return -ENOSYS;
1192 }
1193 #endif
1194
1195 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
1196         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1197 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
1198 #else
1199 static inline
1200 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx)
1201 {
1202         return -ENOSYS;
1203 }
1204 #endif
1205
1206 #if defined(CONFIG_NET_NS) && \
1207         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1208 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
1209 #else
1210 static inline
1211 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx)
1212 {
1213         return -ENOSYS;
1214 }
1215 #endif
1216
1217 #if defined(CONFIG_PID_NS) && \
1218         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1219 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
1220 #else
1221 static inline
1222 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx)
1223 {
1224         return -ENOSYS;
1225 }
1226 #endif
1227
1228 #if defined(CONFIG_USER_NS) && \
1229         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1230 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
1231 #else
1232 static inline
1233 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx)
1234 {
1235         return -ENOSYS;
1236 }
1237 #endif
1238
1239 #if defined(CONFIG_UTS_NS) && \
1240         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1241 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
1242 #else
1243 static inline
1244 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx)
1245 {
1246         return -ENOSYS;
1247 }
1248 #endif
1249
1250 #if defined(CONFIG_TIME_NS) && \
1251         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,6,0))
1252 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
1253 #else
1254 static inline
1255 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx)
1256 {
1257         return -ENOSYS;
1258 }
1259 #endif
1260
1261 int lttng_add_uid_to_ctx(struct lttng_ctx **ctx);
1262 int lttng_add_euid_to_ctx(struct lttng_ctx **ctx);
1263 int lttng_add_suid_to_ctx(struct lttng_ctx **ctx);
1264 int lttng_add_gid_to_ctx(struct lttng_ctx **ctx);
1265 int lttng_add_egid_to_ctx(struct lttng_ctx **ctx);
1266 int lttng_add_sgid_to_ctx(struct lttng_ctx **ctx);
1267 int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
1268 int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
1269 int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
1270 int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
1271 int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
1272 int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
1273
1274 #if defined(CONFIG_PERF_EVENTS)
1275 int lttng_add_perf_counter_to_ctx(uint32_t type,
1276                                   uint64_t config,
1277                                   const char *name,
1278                                   struct lttng_ctx **ctx);
1279 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
1280                 struct lttng_cpuhp_node *node);
1281 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
1282                 struct lttng_cpuhp_node *node);
1283 #else
1284 static inline
1285 int lttng_add_perf_counter_to_ctx(uint32_t type,
1286                                   uint64_t config,
1287                                   const char *name,
1288                                   struct lttng_ctx **ctx)
1289 {
1290         return -ENOSYS;
1291 }
1292 static inline
1293 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
1294                 struct lttng_cpuhp_node *node)
1295 {
1296         return 0;
1297 }
1298 static inline
1299 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
1300                 struct lttng_cpuhp_node *node)
1301 {
1302         return 0;
1303 }
1304 #endif
1305
1306 int lttng_logger_init(void);
1307 void lttng_logger_exit(void);
1308
1309 extern int lttng_statedump_start(struct lttng_session *session);
1310
1311 #ifdef CONFIG_KPROBES
1312 int lttng_kprobes_register_event(const char *name,
1313                 const char *symbol_name,
1314                 uint64_t offset,
1315                 uint64_t addr,
1316                 struct lttng_event *event);
1317 void lttng_kprobes_unregister_event(struct lttng_event *event);
1318 void lttng_kprobes_destroy_event_private(struct lttng_event *event);
1319 int lttng_kprobes_register_event_notifier(const char *symbol_name,
1320                 uint64_t offset,
1321                 uint64_t addr,
1322                 struct lttng_event_notifier *event_notifier);
1323 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier);
1324 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier);
1325 #else
1326 static inline
1327 int lttng_kprobes_register_event(const char *name,
1328                 const char *symbol_name,
1329                 uint64_t offset,
1330                 uint64_t addr,
1331                 struct lttng_event *event)
1332 {
1333         return -ENOSYS;
1334 }
1335
1336 static inline
1337 void lttng_kprobes_unregister_event(struct lttng_event *event)
1338 {
1339 }
1340
1341 static inline
1342 void lttng_kprobes_destroy_event_private(struct lttng_event *event)
1343 {
1344 }
1345
1346 static inline
1347 int lttng_kprobes_register_event_notifier(const char *symbol_name,
1348                 uint64_t offset,
1349                 uint64_t addr,
1350                 struct lttng_event_notifier *event_notifier)
1351 {
1352         return -ENOSYS;
1353 }
1354
1355 static inline
1356 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier)
1357 {
1358 }
1359
1360 static inline
1361 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier)
1362 {
1363 }
1364 #endif
1365
1366 int lttng_event_add_callsite(struct lttng_event *event,
1367         struct lttng_kernel_event_callsite *callsite);
1368
1369 int lttng_event_notifier_add_callsite(struct lttng_event_notifier *event_notifier,
1370         struct lttng_kernel_event_callsite *callsite);
1371
1372 #ifdef CONFIG_UPROBES
1373 int lttng_uprobes_register_event(const char *name,
1374         int fd, struct lttng_event *event);
1375 int lttng_uprobes_event_add_callsite(struct lttng_event *event,
1376         struct lttng_kernel_event_callsite *callsite);
1377 void lttng_uprobes_unregister_event(struct lttng_event *event);
1378 void lttng_uprobes_destroy_event_private(struct lttng_event *event);
1379 int lttng_uprobes_register_event_notifier(const char *name,
1380         int fd, struct lttng_event_notifier *event_notifier);
1381 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier *event_notifier,
1382         struct lttng_kernel_event_callsite *callsite);
1383 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier);
1384 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier);
1385 #else
1386 static inline
1387 int lttng_uprobes_register_event(const char *name,
1388         int fd, struct lttng_event *event)
1389 {
1390         return -ENOSYS;
1391 }
1392
1393 static inline
1394 int lttng_uprobes_event_add_callsite(struct lttng_event *event,
1395         struct lttng_kernel_event_callsite *callsite)
1396 {
1397         return -ENOSYS;
1398 }
1399
1400 static inline
1401 void lttng_uprobes_unregister_event(struct lttng_event *event)
1402 {
1403 }
1404
1405 static inline
1406 void lttng_uprobes_destroy_event_private(struct lttng_event *event)
1407 {
1408 }
1409
1410 static inline
1411 int lttng_uprobes_register_event_notifier(const char *name,
1412         int fd, struct lttng_event_notifier *event_notifier)
1413 {
1414         return -ENOSYS;
1415 }
1416
1417 static inline
1418 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier *event_notifier,
1419         struct lttng_kernel_event_callsite *callsite)
1420 {
1421         return -ENOSYS;
1422 }
1423
1424 static inline
1425 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier)
1426 {
1427 }
1428
1429 static inline
1430 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier)
1431 {
1432 }
1433 #endif
1434
1435 #ifdef CONFIG_KRETPROBES
1436 int lttng_kretprobes_register(const char *name,
1437                 const char *symbol_name,
1438                 uint64_t offset,
1439                 uint64_t addr,
1440                 struct lttng_event *event_entry,
1441                 struct lttng_event *event_exit);
1442 void lttng_kretprobes_unregister(struct lttng_event *event);
1443 void lttng_kretprobes_destroy_private(struct lttng_event *event);
1444 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1445         int enable);
1446 #else
1447 static inline
1448 int lttng_kretprobes_register(const char *name,
1449                 const char *symbol_name,
1450                 uint64_t offset,
1451                 uint64_t addr,
1452                 struct lttng_event *event_entry,
1453                 struct lttng_event *event_exit)
1454 {
1455         return -ENOSYS;
1456 }
1457
1458 static inline
1459 void lttng_kretprobes_unregister(struct lttng_event *event)
1460 {
1461 }
1462
1463 static inline
1464 void lttng_kretprobes_destroy_private(struct lttng_event *event)
1465 {
1466 }
1467
1468 static inline
1469 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1470         int enable)
1471 {
1472         return -ENOSYS;
1473 }
1474 #endif
1475
1476 int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
1477
1478 extern const struct file_operations lttng_tracepoint_list_fops;
1479 extern const struct file_operations lttng_syscall_list_fops;
1480
1481 #define TRACEPOINT_HAS_DATA_ARG
1482
1483 static inline bool lttng_is_bytewise_integer(const struct lttng_type *type)
1484 {
1485         if (type->atype != atype_integer)
1486                 return false;
1487         switch (type->u.integer.size) {
1488         case 8:         /* Fall-through. */
1489         case 16:        /* Fall-through. */
1490         case 32:        /* Fall-through. */
1491         case 64:
1492                 break;
1493         default:
1494                 return false;
1495         }
1496         return true;
1497 }
1498
1499 #endif /* _LTTNG_EVENTS_H */