include/lttng/ust-events.h

   1 #ifndef _LTTNG_UST_EVENTS_H
   2 #define _LTTNG_UST_EVENTS_H
   3
   4 /*
   5  * lttng/ust-events.h
   6  *
   7  * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * Holds LTTng per-session event registry.
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <urcu/list.h>
  31 #include <urcu/hlist.h>
  32 #include <stdint.h>
  33 #include <lttng/ust-config.h>
  34 #include <lttng/ust-abi.h>
  35 #include <lttng/ust-tracer.h>
  36 #include <lttng/ust-endian.h>
  37 #include <float.h>
  38 #include <errno.h>
  39 #include <urcu/ref.h>
  40 #include <pthread.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #define LTTNG_UST_UUID_LEN              16
  47
  48 /*
  49  * Tracepoint provider version. Compatibility based on the major number.
  50  * Older tracepoint providers can always register to newer lttng-ust
  51  * library, but the opposite is rejected: a newer tracepoint provider is
  52  * rejected by an older lttng-ust library.
  53  */
  54 #define LTTNG_UST_PROVIDER_MAJOR        1
  55 #define LTTNG_UST_PROVIDER_MINOR        0
  56
  57 struct lttng_channel;
  58 struct lttng_session;
  59 struct lttng_ust_lib_ring_buffer_ctx;
  60 struct lttng_ust_context_app;
  61 struct lttng_event_field;
  62
  63 /*
  64  * Data structures used by tracepoint event declarations, and by the
  65  * tracer. Those structures have padding for future extension.
  66  */
  67
  68 /*
  69  * LTTng client type enumeration. Used by the consumer to map the
  70  * callbacks from its own address space.
  71  */
  72 enum lttng_client_types {
  73         LTTNG_CLIENT_METADATA = 0,
  74         LTTNG_CLIENT_DISCARD = 1,
  75         LTTNG_CLIENT_OVERWRITE = 2,
  76         LTTNG_CLIENT_DISCARD_RT = 3,
  77         LTTNG_CLIENT_OVERWRITE_RT = 4,
  78         LTTNG_NR_CLIENT_TYPES,
  79 };
  80
  81 /* Type description */
  82
  83 /* Update the astract_types name table in lttng-types.c along with this enum */
  84 enum lttng_abstract_types {
  85         atype_integer,
  86         atype_enum,
  87         atype_array,
  88         atype_sequence,
  89         atype_string,
  90         atype_float,
  91         atype_dynamic,
  92         atype_struct,
  93         NR_ABSTRACT_TYPES,
  94 };
  95
  96 /* Update the string_encodings name table in lttng-types.c along with this enum */
  97 enum lttng_string_encodings {
  98         lttng_encode_none = 0,
  99         lttng_encode_UTF8 = 1,
 100         lttng_encode_ASCII = 2,
 101         NR_STRING_ENCODINGS,
 102 };
 103
 104 struct lttng_enum_value {
 105         unsigned long long value;
 106         unsigned int signedness:1;
 107 };
 108
 109 enum lttng_enum_entry_options {
 110         LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 111 };
 112
 113 #define LTTNG_UST_ENUM_ENTRY_PADDING    16
 114 struct lttng_enum_entry {
 115         struct lttng_enum_value start, end; /* start and end are inclusive */
 116         const char *string;
 117         union {
 118                 struct {
 119                         unsigned int options;
 120                 } LTTNG_PACKED extra;
 121                 char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
 122         } u;
 123 };
 124
 125 #define __type_integer(_type, _byte_order, _base, _encoding)    \
 126         {                                                       \
 127           .atype = atype_integer,                               \
 128           .u =                                                  \
 129                 {                                               \
 130                   .basic =                                      \
 131                         {                                       \
 132                           .integer =                            \
 133                                 {                               \
 134                                   .size = sizeof(_type) * CHAR_BIT,             \
 135                                   .alignment = lttng_alignof(_type) * CHAR_BIT, \
 136                                   .signedness = lttng_is_signed_type(_type),    \
 137                                   .reverse_byte_order = _byte_order != BYTE_ORDER, \
 138                                   .base = _base,                                \
 139                                   .encoding = lttng_encode_##_encoding,         \
 140                                 }                               \
 141                         }                                       \
 142                 },                                              \
 143         }                                                       \
 144
 145 #define LTTNG_UST_INTEGER_TYPE_PADDING  24
 146 struct lttng_integer_type {
 147         unsigned int size;              /* in bits */
 148         unsigned short alignment;       /* in bits */
 149         unsigned int signedness:1;
 150         unsigned int reverse_byte_order:1;
 151         unsigned int base;              /* 2, 8, 10, 16, for pretty print */
 152         enum lttng_string_encodings encoding;
 153         char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
 154 };
 155
 156 /*
 157  * Only float and double are supported. long double is not supported at
 158  * the moment.
 159  */
 160 #define _float_mant_dig(_type)                                          \
 161         (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG                  \
 162                 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG       \
 163                 : 0))
 164
 165 #define __type_float(_type)                                     \
 166         {                                                       \
 167           .atype = atype_float,                                 \
 168           .u =                                                  \
 169                 {                                               \
 170                   .basic =                                      \
 171                         {                                       \
 172                           ._float =                             \
 173                                 {                               \
 174                                   .exp_dig = sizeof(_type) * CHAR_BIT           \
 175                                                   - _float_mant_dig(_type),     \
 176                                   .mant_dig = _float_mant_dig(_type),           \
 177                                   .alignment = lttng_alignof(_type) * CHAR_BIT, \
 178                                   .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
 179                                 }                               \
 180                         }                                       \
 181                 },                                              \
 182         }                                                       \
 183
 184 #define LTTNG_UST_FLOAT_TYPE_PADDING    24
 185 struct lttng_float_type {
 186         unsigned int exp_dig;           /* exponent digits, in bits */
 187         unsigned int mant_dig;          /* mantissa digits, in bits */
 188         unsigned short alignment;       /* in bits */
 189         unsigned int reverse_byte_order:1;
 190         char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
 191 };
 192
 193 #define LTTNG_UST_BASIC_TYPE_PADDING    128
 194 union _lttng_basic_type {
 195         struct lttng_integer_type integer;
 196         struct {
 197                 const struct lttng_enum_desc *desc;     /* Enumeration mapping */
 198                 struct lttng_integer_type container_type;
 199         } enumeration;
 200         struct {
 201                 enum lttng_string_encodings encoding;
 202         } string;
 203         struct lttng_float_type _float;
 204         char padding[LTTNG_UST_BASIC_TYPE_PADDING];
 205 };
 206
 207 struct lttng_basic_type {
 208         enum lttng_abstract_types atype;
 209         union {
 210                 union _lttng_basic_type basic;
 211         } u;
 212 };
 213
 214 #define LTTNG_UST_TYPE_PADDING  128
 215 struct lttng_type {
 216         enum lttng_abstract_types atype;
 217         union {
 218                 union _lttng_basic_type basic;
 219                 struct {
 220                         struct lttng_basic_type elem_type;
 221                         unsigned int length;            /* num. elems. */
 222                 } array;
 223                 struct {
 224                         struct lttng_basic_type length_type;
 225                         struct lttng_basic_type elem_type;
 226                 } sequence;
 227                 struct {
 228                         uint32_t nr_fields;
 229                         struct lttng_event_field *fields;       /* Array of fields. */
 230                 } _struct;
 231                 char padding[LTTNG_UST_TYPE_PADDING];
 232         } u;
 233 };
 234
 235 #define LTTNG_UST_ENUM_TYPE_PADDING     24
 236 struct lttng_enum_desc {
 237         const char *name;
 238         const struct lttng_enum_entry *entries;
 239         unsigned int nr_entries;
 240         char padding[LTTNG_UST_ENUM_TYPE_PADDING];
 241 };
 242
 243 /*
 244  * Event field description
 245  *
 246  * IMPORTANT: this structure is part of the ABI between the probe and
 247  * UST. Fields need to be only added at the end, never reordered, never
 248  * removed.
 249  */
 250
 251 #define LTTNG_UST_EVENT_FIELD_PADDING   28
 252 struct lttng_event_field {
 253         const char *name;
 254         struct lttng_type type;
 255         unsigned int nowrite;   /* do not write into trace */
 256         char padding[LTTNG_UST_EVENT_FIELD_PADDING];
 257 };
 258
 259 enum lttng_ust_dynamic_type {
 260         LTTNG_UST_DYNAMIC_TYPE_NONE,
 261         LTTNG_UST_DYNAMIC_TYPE_S8,
 262         LTTNG_UST_DYNAMIC_TYPE_S16,
 263         LTTNG_UST_DYNAMIC_TYPE_S32,
 264         LTTNG_UST_DYNAMIC_TYPE_S64,
 265         LTTNG_UST_DYNAMIC_TYPE_U8,
 266         LTTNG_UST_DYNAMIC_TYPE_U16,
 267         LTTNG_UST_DYNAMIC_TYPE_U32,
 268         LTTNG_UST_DYNAMIC_TYPE_U64,
 269         LTTNG_UST_DYNAMIC_TYPE_FLOAT,
 270         LTTNG_UST_DYNAMIC_TYPE_DOUBLE,
 271         LTTNG_UST_DYNAMIC_TYPE_STRING,
 272         _NR_LTTNG_UST_DYNAMIC_TYPES,
 273 };
 274
 275 struct lttng_ctx_value {
 276         enum lttng_ust_dynamic_type sel;
 277         union {
 278                 int64_t s64;
 279                 const char *str;
 280                 double d;
 281         } u;
 282 };
 283
 284 struct lttng_perf_counter_field;
 285
 286 #define LTTNG_UST_CTX_FIELD_PADDING     40
 287 struct lttng_ctx_field {
 288         struct lttng_event_field event_field;
 289         size_t (*get_size)(struct lttng_ctx_field *field, size_t offset);
 290         void (*record)(struct lttng_ctx_field *field,
 291                        struct lttng_ust_lib_ring_buffer_ctx *ctx,
 292                        struct lttng_channel *chan);
 293         void (*get_value)(struct lttng_ctx_field *field,
 294                          struct lttng_ctx_value *value);
 295         union {
 296                 struct lttng_perf_counter_field *perf_counter;
 297                 char padding[LTTNG_UST_CTX_FIELD_PADDING];
 298         } u;
 299         void (*destroy)(struct lttng_ctx_field *field);
 300         char *field_name;       /* Has ownership, dynamically allocated. */
 301 };
 302
 303 #define LTTNG_UST_CTX_PADDING   20
 304 struct lttng_ctx {
 305         struct lttng_ctx_field *fields;
 306         unsigned int nr_fields;
 307         unsigned int allocated_fields;
 308         unsigned int largest_align;
 309         char padding[LTTNG_UST_CTX_PADDING];
 310 };
 311
 312 #define LTTNG_UST_EVENT_DESC_PADDING    40
 313 struct lttng_event_desc {
 314         const char *name;
 315         void (*probe_callback)(void);
 316         const struct lttng_event_ctx *ctx;      /* context */
 317         const struct lttng_event_field *fields; /* event payload */
 318         unsigned int nr_fields;
 319         const int **loglevel;
 320         const char *signature;  /* Argument types/names received */
 321         union {
 322                 struct {
 323                         const char **model_emf_uri;
 324                 } ext;
 325                 char padding[LTTNG_UST_EVENT_DESC_PADDING];
 326         } u;
 327 };
 328
 329 #define LTTNG_UST_PROBE_DESC_PADDING    12
 330 struct lttng_probe_desc {
 331         const char *provider;
 332         const struct lttng_event_desc **event_desc;
 333         unsigned int nr_events;
 334         struct cds_list_head head;              /* chain registered probes */
 335         struct cds_list_head lazy_init_head;
 336         int lazy;                               /* lazy registration */
 337         uint32_t major;
 338         uint32_t minor;
 339         char padding[LTTNG_UST_PROBE_DESC_PADDING];
 340 };
 341
 342 /* Data structures used by the tracer. */
 343
 344 enum lttng_enabler_type {
 345         LTTNG_ENABLER_STAR_GLOB,
 346         LTTNG_ENABLER_EVENT,
 347 };
 348
 349 /*
 350  * Enabler field, within whatever object is enabling an event. Target of
 351  * backward reference.
 352  */
 353 struct lttng_enabler {
 354         enum lttng_enabler_type type;
 355
 356         /* head list of struct lttng_ust_filter_bytecode_node */
 357         struct cds_list_head filter_bytecode_head;
 358         /* head list of struct lttng_ust_excluder_node */
 359         struct cds_list_head excluder_head;
 360         struct cds_list_head node;      /* per-session list of enablers */
 361
 362         struct lttng_ust_event event_param;
 363         struct lttng_channel *chan;
 364         struct lttng_ctx *ctx;
 365         unsigned int enabled:1;
 366 };
 367
 368 struct tp_list_entry {
 369         struct lttng_ust_tracepoint_iter tp;
 370         struct cds_list_head head;
 371 };
 372
 373 struct lttng_ust_tracepoint_list {
 374         struct tp_list_entry *iter;
 375         struct cds_list_head head;
 376 };
 377
 378 struct tp_field_list_entry {
 379         struct lttng_ust_field_iter field;
 380         struct cds_list_head head;
 381 };
 382
 383 struct lttng_ust_field_list {
 384         struct tp_field_list_entry *iter;
 385         struct cds_list_head head;
 386 };
 387
 388 struct ust_pending_probe;
 389 struct lttng_event;
 390
 391 struct lttng_ust_filter_bytecode_node {
 392         struct cds_list_head node;
 393         struct lttng_enabler *enabler;
 394         /*
 395          * struct lttng_ust_filter_bytecode has var. sized array, must
 396          * be last field.
 397          */
 398         struct lttng_ust_filter_bytecode bc;
 399 };
 400
 401 struct lttng_ust_excluder_node {
 402         struct cds_list_head node;
 403         struct lttng_enabler *enabler;
 404         /*
 405          * struct lttng_ust_event_exclusion had variable sized array,
 406          * must be last field.
 407          */
 408         struct lttng_ust_event_exclusion excluder;
 409 };
 410 /*
 411  * Filter return value masks.
 412  */
 413 enum lttng_filter_ret {
 414         LTTNG_FILTER_DISCARD = 0,
 415         LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
 416         /* Other bits are kept for future use. */
 417 };
 418
 419 struct lttng_bytecode_runtime {
 420         /* Associated bytecode */
 421         struct lttng_ust_filter_bytecode_node *bc;
 422         uint64_t (*filter)(void *filter_data, const char *filter_stack_data);
 423         int link_failed;
 424         struct cds_list_head node;      /* list of bytecode runtime in event */
 425         struct lttng_session *session;
 426 };
 427
 428 /*
 429  * Objects in a linked-list of enablers, owned by an event.
 430  */
 431 struct lttng_enabler_ref {
 432         struct cds_list_head node;              /* enabler ref list */
 433         struct lttng_enabler *ref;              /* backward ref */
 434 };
 435
 436 /*
 437  * lttng_event structure is referred to by the tracing fast path. It
 438  * must be kept small.
 439  *
 440  * IMPORTANT: this structure is part of the ABI between the probe and
 441  * UST. Fields need to be only added at the end, never reordered, never
 442  * removed.
 443  */
 444 struct lttng_event {
 445         /* LTTng-UST 2.0 starts here */
 446         unsigned int id;
 447         struct lttng_channel *chan;
 448         int enabled;
 449         const struct lttng_event_desc *desc;
 450         void *_deprecated1;
 451         struct lttng_ctx *ctx;
 452         enum lttng_ust_instrumentation instrumentation;
 453         struct cds_list_head node;              /* Event list in session */
 454         struct cds_list_head _deprecated2;
 455         void *_deprecated3;
 456         unsigned int _deprecated4:1;
 457
 458         /* LTTng-UST 2.1 starts here */
 459         /* list of struct lttng_bytecode_runtime, sorted by seqnum */
 460         struct cds_list_head bytecode_runtime_head;
 461         int has_enablers_without_bytecode;
 462         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 463         struct cds_list_head enablers_ref_head;
 464         struct cds_hlist_node hlist;    /* session ht of events */
 465         int registered;                 /* has reg'd tracepoint probe */
 466 };
 467
 468 struct lttng_enum {
 469         const struct lttng_enum_desc *desc;
 470         struct lttng_session *session;
 471         struct cds_list_head node;      /* Enum list in session */
 472         struct cds_hlist_node hlist;    /* Session ht of enums */
 473         uint64_t id;                    /* Enumeration ID in sessiond */
 474 };
 475
 476 struct channel;
 477 struct lttng_ust_shm_handle;
 478
 479 /*
 480  * IMPORTANT: this structure is part of the ABI between the probe and
 481  * UST. Fields need to be only added at the end, never reordered, never
 482  * removed.
 483  */
 484 struct lttng_channel_ops {
 485         struct lttng_channel *(*channel_create)(const char *name,
 486                         void *buf_addr,
 487                         size_t subbuf_size, size_t num_subbuf,
 488                         unsigned int switch_timer_interval,
 489                         unsigned int read_timer_interval,
 490                         unsigned char *uuid,
 491                         uint32_t chan_id,
 492                         const int *stream_fds, int nr_stream_fds);
 493         void (*channel_destroy)(struct lttng_channel *chan);
 494         union {
 495                 void *_deprecated1;
 496                 unsigned long has_strcpy:1;             /* ABI has strcpy */
 497         } u;
 498         void *_deprecated2;
 499         int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
 500                              uint32_t event_id);
 501         void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
 502         void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
 503                         const void *src, size_t len);
 504         /*
 505          * packet_avail_size returns the available size in the current
 506          * packet. Note that the size returned is only a hint, since it
 507          * may change due to concurrent writes.
 508          */
 509         size_t (*packet_avail_size)(struct channel *chan,
 510                                     struct lttng_ust_shm_handle *handle);
 511         //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
 512         //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 513         int (*is_finalized)(struct channel *chan);
 514         int (*is_disabled)(struct channel *chan);
 515         int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
 516         void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
 517                         const char *src, size_t len);
 518 };
 519
 520 /*
 521  * IMPORTANT: this structure is part of the ABI between the probe and
 522  * UST. Fields need to be only added at the end, never reordered, never
 523  * removed.
 524  */
 525 struct lttng_channel {
 526         /*
 527          * The pointers located in this private data are NOT safe to be
 528          * dereferenced by the consumer. The only operations the
 529          * consumer process is designed to be allowed to do is to read
 530          * and perform subbuffer flush.
 531          */
 532         struct channel *chan;           /* Channel buffers */
 533         int enabled;
 534         struct lttng_ctx *ctx;
 535         /* Event ID management */
 536         struct lttng_session *session;
 537         int objd;                       /* Object associated to channel */
 538         unsigned int _deprecated1;
 539         unsigned int _deprecated2;
 540         struct cds_list_head node;      /* Channel list in session */
 541         const struct lttng_channel_ops *ops;
 542         int header_type;                /* 0: unset, 1: compact, 2: large */
 543         struct lttng_ust_shm_handle *handle;    /* shared-memory handle */
 544         unsigned int _deprecated3:1;
 545
 546         /* Channel ID */
 547         unsigned int id;
 548         enum lttng_ust_chan_type type;
 549         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
 550         int tstate:1;                   /* Transient enable state */
 551 };
 552
 553 #define LTTNG_UST_STACK_CTX_PADDING     32
 554 struct lttng_stack_ctx {
 555         struct lttng_event *event;
 556         struct lttng_ctx *chan_ctx;     /* RCU dereferenced. */
 557         struct lttng_ctx *event_ctx;    /* RCU dereferenced. */
 558         char padding[LTTNG_UST_STACK_CTX_PADDING];
 559 };
 560
 561 #define LTTNG_UST_EVENT_HT_BITS         12
 562 #define LTTNG_UST_EVENT_HT_SIZE         (1U << LTTNG_UST_EVENT_HT_BITS)
 563
 564 struct lttng_ust_event_ht {
 565         struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
 566 };
 567
 568 #define LTTNG_UST_ENUM_HT_BITS          12
 569 #define LTTNG_UST_ENUM_HT_SIZE          (1U << LTTNG_UST_ENUM_HT_BITS)
 570
 571 struct lttng_ust_enum_ht {
 572         struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
 573 };
 574
 575 /*
 576  * IMPORTANT: this structure is part of the ABI between the probe and
 577  * UST. Fields need to be only added at the end, never reordered, never
 578  * removed.
 579  */
 580 struct lttng_session {
 581         int active;                             /* Is trace session active ? */
 582         int been_active;                        /* Been active ? */
 583         int objd;                               /* Object associated */
 584         void *_deprecated1;
 585         struct cds_list_head chan_head;         /* Channel list head */
 586         struct cds_list_head events_head;       /* list of events */
 587         struct cds_list_head _deprecated2;
 588         struct cds_list_head node;              /* Session list */
 589         int _deprecated3;
 590         unsigned int _deprecated4:1;
 591
 592         /* New UST 2.1 */
 593         /* List of enablers */
 594         struct cds_list_head enablers_head;
 595         struct lttng_ust_event_ht events_ht;    /* ht of events */
 596         void *owner;                            /* object owner */
 597         int tstate:1;                           /* Transient enable state */
 598
 599         /* New UST 2.4 */
 600         int statedump_pending:1;
 601
 602         /* New UST 2.8 */
 603         struct lttng_ust_enum_ht enums_ht;      /* ht of enumerations */
 604         struct cds_list_head enums_head;
 605         struct lttng_ctx *ctx;                  /* contexts for filters. */
 606 };
 607
 608 struct lttng_transport {
 609         char *name;
 610         struct cds_list_head node;
 611         struct lttng_channel_ops ops;
 612         const struct lttng_ust_lib_ring_buffer_config *client_config;
 613 };
 614
 615 struct lttng_session *lttng_session_create(void);
 616 int lttng_session_enable(struct lttng_session *session);
 617 int lttng_session_disable(struct lttng_session *session);
 618 int lttng_session_statedump(struct lttng_session *session);
 619 void lttng_session_destroy(struct lttng_session *session);
 620
 621 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 622                                        const char *transport_name,
 623                                        void *buf_addr,
 624                                        size_t subbuf_size, size_t num_subbuf,
 625                                        unsigned int switch_timer_interval,
 626                                        unsigned int read_timer_interval,
 627                                        int **shm_fd, int **wait_fd,
 628                                        uint64_t **memory_map_size,
 629                                        struct lttng_channel *chan_priv_init);
 630
 631 int lttng_channel_enable(struct lttng_channel *channel);
 632 int lttng_channel_disable(struct lttng_channel *channel);
 633
 634 struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type,
 635                 struct lttng_ust_event *event_param,
 636                 struct lttng_channel *chan);
 637 int lttng_enabler_enable(struct lttng_enabler *enabler);
 638 int lttng_enabler_disable(struct lttng_enabler *enabler);
 639 int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
 640                 struct lttng_ust_filter_bytecode_node *bytecode);
 641 int lttng_enabler_attach_context(struct lttng_enabler *enabler,
 642                 struct lttng_ust_context *ctx);
 643 int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler,
 644                 struct lttng_ust_excluder_node *excluder);
 645
 646 int lttng_attach_context(struct lttng_ust_context *context_param,
 647                 union ust_args *uargs,
 648                 struct lttng_ctx **ctx, struct lttng_session *session);
 649 int lttng_session_context_init(struct lttng_ctx **ctx);
 650
 651 void lttng_transport_register(struct lttng_transport *transport);
 652 void lttng_transport_unregister(struct lttng_transport *transport);
 653
 654 void synchronize_trace(void);
 655
 656 int lttng_probe_register(struct lttng_probe_desc *desc);
 657 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 658 int lttng_fix_pending_events(void);
 659 int lttng_probes_init(void);
 660 void lttng_probes_exit(void);
 661 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
 662 int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
 663 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
 664 void lttng_context_update(struct lttng_ctx *ctx);
 665 void lttng_remove_context_field(struct lttng_ctx **ctx_p,
 666                                 struct lttng_ctx_field *field);
 667 void lttng_destroy_context(struct lttng_ctx *ctx);
 668 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
 669 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
 670 int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
 671 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 672 int lttng_add_ip_to_ctx(struct lttng_ctx **ctx);
 673 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
 674 int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx);
 675 void lttng_context_vtid_reset(void);
 676 void lttng_context_vpid_reset(void);
 677
 678 #ifdef LTTNG_UST_HAVE_PERF_EVENT
 679 int lttng_add_perf_counter_to_ctx(uint32_t type,
 680                                   uint64_t config,
 681                                   const char *name,
 682                                   struct lttng_ctx **ctx);
 683 int lttng_perf_counter_init(void);
 684 void lttng_perf_counter_exit(void);
 685 #else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */
 686 static inline
 687 int lttng_add_perf_counter_to_ctx(uint32_t type,
 688                                   uint64_t config,
 689                                   const char *name,
 690                                   struct lttng_ctx **ctx)
 691 {
 692         return -ENOSYS;
 693 }
 694 static inline
 695 int lttng_perf_counter_init(void)
 696 {
 697         return 0;
 698 }
 699 static inline
 700 void lttng_perf_counter_exit(void)
 701 {
 702 }
 703 #endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */
 704
 705 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
 706 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
 707 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
 708
 709 struct lttng_transport *lttng_transport_find(const char *name);
 710
 711 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
 712 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
 713 struct lttng_ust_tracepoint_iter *
 714         lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
 715 int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
 716 void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 717 struct lttng_ust_field_iter *
 718         lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 719
 720 void lttng_filter_event_link_bytecode(struct lttng_event *event);
 721 void lttng_enabler_event_link_bytecode(struct lttng_event *event,
 722                 struct lttng_enabler *enabler);
 723 void lttng_free_event_filter_runtime(struct lttng_event *event);
 724 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
 725
 726 struct cds_list_head *lttng_get_probe_list_head(void);
 727 int lttng_session_active(void);
 728
 729 typedef int (*t_statedump_func_ptr)(struct lttng_session *session);
 730 void lttng_handle_pending_statedump(void *owner);
 731 struct cds_list_head *_lttng_get_sessions(void);
 732 struct lttng_enum *lttng_ust_enum_get(struct lttng_session *session,
 733                 const char *enum_name);
 734
 735 void lttng_ust_dl_update(void *ip);
 736 void lttng_ust_fixup_fd_tracker_tls(void);
 737
 738 /* For backward compatibility. Leave those exported symbols in place. */
 739 extern struct lttng_ctx *lttng_static_ctx;
 740 void lttng_context_init(void);
 741 void lttng_context_exit(void);
 742
 743 #ifdef __cplusplus
 744 }
 745 #endif
 746
 747 #endif /* _LTTNG_UST_EVENTS_H */