lttng-events.h

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