liblttng-ust/ust-events-internal.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
   5  */
   6
   7 #ifndef _LTTNG_UST_EVENTS_INTERNAL_H
   8 #define _LTTNG_UST_EVENTS_INTERNAL_H
   9
  10 #include <stdint.h>
  11
  12 #include <urcu/list.h>
  13 #include <urcu/hlist.h>
  14
  15 #include <lttng/ust-events.h>
  16
  17 #include <ust-helper.h>
  18 #include "ust-context-provider.h"
  19
  20 struct lttng_ust_abi_obj;
  21 struct lttng_event_notifier_group;
  22
  23 union lttng_ust_abi_args {
  24         struct {
  25                 void *chan_data;
  26                 int wakeup_fd;
  27         } channel;
  28         struct {
  29                 int shm_fd;
  30                 int wakeup_fd;
  31         } stream;
  32         struct {
  33                 struct lttng_ust_abi_field_iter entry;
  34         } field_list;
  35         struct {
  36                 char *ctxname;
  37         } app_context;
  38         struct {
  39                 int event_notifier_notif_fd;
  40         } event_notifier_handle;
  41         struct {
  42                 void *counter_data;
  43         } counter;
  44         struct {
  45                 int shm_fd;
  46         } counter_shm;
  47 };
  48
  49 struct lttng_ust_abi_objd_ops {
  50         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
  51                 union lttng_ust_abi_args *args, void *owner);
  52         int (*release)(int objd);
  53 };
  54
  55 enum lttng_enabler_format_type {
  56         LTTNG_ENABLER_FORMAT_STAR_GLOB,
  57         LTTNG_ENABLER_FORMAT_EVENT,
  58 };
  59
  60 /*
  61  * Enabler field, within whatever object is enabling an event. Target of
  62  * backward reference.
  63  */
  64 struct lttng_enabler {
  65         enum lttng_enabler_format_type format_type;
  66
  67         /* head list of struct lttng_ust_filter_bytecode_node */
  68         struct cds_list_head filter_bytecode_head;
  69         /* head list of struct lttng_ust_excluder_node */
  70         struct cds_list_head excluder_head;
  71
  72         struct lttng_ust_abi_event event_param;
  73         unsigned int enabled:1;
  74 };
  75
  76 struct lttng_event_enabler {
  77         struct lttng_enabler base;
  78         struct cds_list_head node;      /* per-session list of enablers */
  79         struct lttng_ust_channel_buffer *chan;
  80         /*
  81          * Unused, but kept around to make it explicit that the tracer can do
  82          * it.
  83          */
  84         struct lttng_ust_ctx *ctx;
  85 };
  86
  87 struct lttng_event_notifier_enabler {
  88         struct lttng_enabler base;
  89         uint64_t error_counter_index;
  90         struct cds_list_head node;      /* per-app list of event_notifier enablers */
  91         struct cds_list_head capture_bytecode_head;
  92         struct lttng_event_notifier_group *group; /* weak ref */
  93         uint64_t user_token;            /* User-provided token */
  94         uint64_t num_captures;
  95 };
  96
  97 enum lttng_ust_bytecode_type {
  98         LTTNG_UST_BYTECODE_TYPE_FILTER,
  99         LTTNG_UST_BYTECODE_TYPE_CAPTURE,
 100 };
 101
 102 struct lttng_ust_bytecode_node {
 103         enum lttng_ust_bytecode_type type;
 104         struct cds_list_head node;
 105         struct lttng_enabler *enabler;
 106         struct  {
 107                 uint32_t len;
 108                 uint32_t reloc_offset;
 109                 uint64_t seqnum;
 110                 char data[];
 111         } bc;
 112 };
 113
 114 /*
 115  * Bytecode interpreter return value.
 116  */
 117 enum lttng_ust_bytecode_interpreter_ret {
 118         LTTNG_UST_BYTECODE_INTERPRETER_ERROR = -1,
 119         LTTNG_UST_BYTECODE_INTERPRETER_OK = 0,
 120 };
 121
 122 struct lttng_interpreter_output;
 123 struct lttng_ust_bytecode_runtime_private;
 124
 125 enum lttng_ust_bytecode_filter_result {
 126         LTTNG_UST_BYTECODE_FILTER_ACCEPT = 0,
 127         LTTNG_UST_BYTECODE_FILTER_REJECT = 1,
 128 };
 129
 130 struct lttng_ust_bytecode_filter_ctx {
 131         enum lttng_ust_bytecode_filter_result result;
 132 };
 133
 134 struct lttng_ust_excluder_node {
 135         struct cds_list_head node;
 136         struct lttng_enabler *enabler;
 137         /*
 138          * struct lttng_ust_event_exclusion had variable sized array,
 139          * must be last field.
 140          */
 141         struct lttng_ust_abi_event_exclusion excluder;
 142 };
 143
 144 /* Data structures used by the tracer. */
 145
 146 struct tp_list_entry {
 147         struct lttng_ust_abi_tracepoint_iter tp;
 148         struct cds_list_head head;
 149 };
 150
 151 struct lttng_ust_tracepoint_list {
 152         struct tp_list_entry *iter;
 153         struct cds_list_head head;
 154 };
 155
 156 struct tp_field_list_entry {
 157         struct lttng_ust_abi_field_iter field;
 158         struct cds_list_head head;
 159 };
 160
 161 struct lttng_ust_field_list {
 162         struct tp_field_list_entry *iter;
 163         struct cds_list_head head;
 164 };
 165
 166 /*
 167  * Objects in a linked-list of enablers, owned by an event or event_notifier.
 168  * This is used because an event (or a event_notifier) can be enabled by more
 169  * than one enabler and we want a quick way to iterate over all enablers of an
 170  * object.
 171  *
 172  * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
 173  * event with the name "my_app:abc".
 174  */
 175 struct lttng_enabler_ref {
 176         struct cds_list_head node;              /* enabler ref list */
 177         struct lttng_enabler *ref;              /* backward ref */
 178 };
 179
 180 #define LTTNG_COUNTER_DIMENSION_MAX     8
 181 struct lttng_counter_dimension {
 182         uint64_t size;
 183         uint64_t underflow_index;
 184         uint64_t overflow_index;
 185         uint8_t has_underflow;
 186         uint8_t has_overflow;
 187 };
 188
 189 struct lttng_counter_ops {
 190         struct lib_counter *(*counter_create)(size_t nr_dimensions,
 191                         const struct lttng_counter_dimension *dimensions,
 192                         int64_t global_sum_step,
 193                         int global_counter_fd,
 194                         int nr_counter_cpu_fds,
 195                         const int *counter_cpu_fds,
 196                         bool is_daemon);
 197         void (*counter_destroy)(struct lib_counter *counter);
 198         int (*counter_add)(struct lib_counter *counter,
 199                         const size_t *dimension_indexes, int64_t v);
 200         int (*counter_read)(struct lib_counter *counter,
 201                         const size_t *dimension_indexes, int cpu,
 202                         int64_t *value, bool *overflow, bool *underflow);
 203         int (*counter_aggregate)(struct lib_counter *counter,
 204                         const size_t *dimension_indexes, int64_t *value,
 205                         bool *overflow, bool *underflow);
 206         int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
 207 };
 208
 209 struct lttng_counter {
 210         int objd;
 211         struct lttng_event_notifier_group *event_notifier_group;    /* owner */
 212         struct lttng_counter_transport *transport;
 213         struct lib_counter *counter;
 214         struct lttng_counter_ops *ops;
 215 };
 216
 217 #define LTTNG_UST_EVENT_HT_BITS         12
 218 #define LTTNG_UST_EVENT_HT_SIZE         (1U << LTTNG_UST_EVENT_HT_BITS)
 219
 220 struct lttng_ust_event_ht {
 221         struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
 222 };
 223
 224 #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS                12
 225 #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE                (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
 226 struct lttng_ust_event_notifier_ht {
 227         struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE];
 228 };
 229
 230 #define LTTNG_UST_ENUM_HT_BITS          12
 231 #define LTTNG_UST_ENUM_HT_SIZE          (1U << LTTNG_UST_ENUM_HT_BITS)
 232
 233 struct lttng_ust_enum_ht {
 234         struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
 235 };
 236
 237 struct lttng_event_notifier_group {
 238         int objd;
 239         void *owner;
 240         int notification_fd;
 241         struct cds_list_head node;              /* Event notifier group handle list */
 242         struct cds_list_head enablers_head;
 243         struct cds_list_head event_notifiers_head; /* list of event_notifiers */
 244         struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
 245         struct lttng_ust_ctx *ctx;              /* contexts for filters. */
 246
 247         struct lttng_counter *error_counter;
 248         size_t error_counter_len;
 249 };
 250
 251 struct lttng_transport {
 252         char *name;
 253         struct cds_list_head node;
 254         struct lttng_ust_channel_ops ops;
 255         const struct lttng_ust_lib_ring_buffer_config *client_config;
 256 };
 257
 258 struct lttng_counter_transport {
 259         char *name;
 260         struct cds_list_head node;
 261         struct lttng_counter_ops ops;
 262         const struct lib_counter_config *client_config;
 263 };
 264
 265 struct lttng_ust_event_common_private {
 266         struct lttng_ust_event_common *pub;     /* Public event interface */
 267
 268         struct lttng_ust_event_desc *desc;
 269         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 270         struct cds_list_head enablers_ref_head;
 271         int registered;                         /* has reg'd tracepoint probe */
 272         uint64_t user_token;
 273
 274         int has_enablers_without_filter_bytecode;
 275         /* list of struct lttng_ust_bytecode_runtime, sorted by seqnum */
 276         struct cds_list_head filter_bytecode_runtime_head;
 277 };
 278
 279 struct lttng_ust_event_recorder_private {
 280         struct lttng_ust_event_common_private parent;
 281
 282         struct lttng_ust_event_recorder *pub;   /* Public event interface */
 283         struct cds_list_head node;              /* Event recorder list */
 284         struct cds_hlist_node hlist;            /* Hash table of event recorders */
 285         struct lttng_ust_ctx *ctx;
 286 };
 287
 288 struct lttng_ust_event_notifier_private {
 289         struct lttng_ust_event_common_private parent;
 290
 291         struct lttng_ust_event_notifier *pub;   /* Public event notifier interface */
 292         struct lttng_event_notifier_group *group; /* weak ref */
 293         size_t num_captures;                    /* Needed to allocate the msgpack array. */
 294         uint64_t error_counter_index;
 295         struct cds_list_head node;              /* Event notifier list */
 296         struct cds_hlist_node hlist;            /* Hash table of event notifiers */
 297         struct cds_list_head capture_bytecode_runtime_head;
 298 };
 299
 300 struct lttng_ust_bytecode_runtime {
 301         enum lttng_ust_bytecode_type type;
 302         struct lttng_ust_bytecode_node *bc;
 303         int link_failed;
 304         int (*interpreter_func)(struct lttng_ust_bytecode_runtime *bytecode_runtime,
 305                         const char *interpreter_stack_data,
 306                         void *ctx);
 307         struct cds_list_head node;              /* list of bytecode runtime in event */
 308         /*
 309          * Pointer to a URCU-protected pointer owned by an `struct
 310          * lttng_session`or `struct lttng_event_notifier_group`.
 311          */
 312         struct lttng_ust_ctx **pctx;
 313 };
 314
 315 struct lttng_ust_session_private {
 316         struct lttng_ust_session *pub;          /* Public session interface */
 317
 318         int been_active;                        /* Been active ? */
 319         int objd;                               /* Object associated */
 320         struct cds_list_head chan_head;         /* Channel list head */
 321         struct cds_list_head events_head;       /* list of events */
 322         struct cds_list_head node;              /* Session list */
 323
 324         /* List of enablers */
 325         struct cds_list_head enablers_head;
 326         struct lttng_ust_event_ht events_ht;    /* ht of events */
 327         void *owner;                            /* object owner */
 328         int tstate:1;                           /* Transient enable state */
 329
 330         int statedump_pending:1;
 331
 332         struct lttng_ust_enum_ht enums_ht;      /* ht of enumerations */
 333         struct cds_list_head enums_head;
 334         struct lttng_ust_ctx *ctx;              /* contexts for filters. */
 335 };
 336
 337 struct lttng_enum {
 338         struct lttng_ust_enum_desc *desc;
 339         struct lttng_ust_session *session;
 340         struct cds_list_head node;              /* Enum list in session */
 341         struct cds_hlist_node hlist;            /* Session ht of enums */
 342         uint64_t id;                            /* Enumeration ID in sessiond */
 343 };
 344
 345 struct lttng_ust_shm_handle;
 346
 347 struct lttng_ust_channel_ops_private {
 348         struct lttng_ust_channel_ops *pub;      /* Public channels ops interface */
 349
 350         struct lttng_ust_channel_buffer *(*channel_create)(const char *name,
 351                         void *buf_addr,
 352                         size_t subbuf_size, size_t num_subbuf,
 353                         unsigned int switch_timer_interval,
 354                         unsigned int read_timer_interval,
 355                         unsigned char *uuid,
 356                         uint32_t chan_id,
 357                         const int *stream_fds, int nr_stream_fds,
 358                         int64_t blocking_timeout);
 359         void (*channel_destroy)(struct lttng_ust_channel_buffer *chan);
 360         /*
 361          * packet_avail_size returns the available size in the current
 362          * packet. Note that the size returned is only a hint, since it
 363          * may change due to concurrent writes.
 364          */
 365         size_t (*packet_avail_size)(struct lttng_ust_lib_ring_buffer_channel *chan,
 366                                     struct lttng_ust_shm_handle *handle);
 367         int (*is_finalized)(struct lttng_ust_lib_ring_buffer_channel *chan);
 368         int (*is_disabled)(struct lttng_ust_lib_ring_buffer_channel *chan);
 369         int (*flush_buffer)(struct lttng_ust_lib_ring_buffer_channel *chan,
 370                             struct lttng_ust_shm_handle *handle);
 371 };
 372
 373 struct lttng_ust_channel_common_private {
 374         struct lttng_ust_channel_common *pub;   /* Public channel interface */
 375
 376         int objd;                               /* Object associated with channel. */
 377         int tstate:1;                           /* Transient enable state */
 378 };
 379
 380 struct lttng_ust_channel_buffer_private {
 381         struct lttng_ust_channel_common_private parent;
 382
 383         struct lttng_ust_channel_buffer *pub;   /* Public channel buffer interface */
 384         struct cds_list_head node;              /* Channel list in session */
 385         int header_type;                        /* 0: unset, 1: compact, 2: large */
 386         unsigned int id;                        /* Channel ID */
 387         enum lttng_ust_abi_chan_type type;
 388         struct lttng_ust_ctx *ctx;
 389         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
 390 };
 391
 392 /*
 393  * IMPORTANT: this structure is part of the ABI between the consumer
 394  * daemon and the UST library within traced applications. Changing it
 395  * breaks the UST communication protocol.
 396  *
 397  * TODO: remove unused fields on next UST communication protocol
 398  * breaking update.
 399  */
 400 struct lttng_ust_abi_channel_config {
 401         void *unused1;
 402         int unused2;
 403         void *unused3;
 404         void *unused4;
 405         int unused5;
 406         struct cds_list_head unused6;
 407         void *unused7;
 408         int unused8;
 409         void *unused9;
 410
 411         /* Channel ID */
 412         unsigned int id;
 413         enum lttng_ust_abi_chan_type unused10;
 414         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
 415         int unused11:1;
 416 };
 417
 418 static inline
 419 struct lttng_ust_type_integer *lttng_ust_get_type_integer(struct lttng_ust_type_common *type)
 420 {
 421         if (type->type != lttng_ust_type_integer)
 422                 return NULL;
 423         return caa_container_of(type, struct lttng_ust_type_integer, parent);
 424 }
 425
 426 static inline
 427 struct lttng_ust_type_float *lttng_ust_get_type_float(struct lttng_ust_type_common *type)
 428 {
 429         if (type->type != lttng_ust_type_float)
 430                 return NULL;
 431         return caa_container_of(type, struct lttng_ust_type_float, parent);
 432 }
 433
 434 static inline
 435 struct lttng_ust_type_string *lttng_ust_get_type_string(struct lttng_ust_type_common *type)
 436 {
 437         if (type->type != lttng_ust_type_string)
 438                 return NULL;
 439         return caa_container_of(type, struct lttng_ust_type_string, parent);
 440 }
 441
 442 static inline
 443 struct lttng_ust_type_enum *lttng_ust_get_type_enum(struct lttng_ust_type_common *type)
 444 {
 445         if (type->type != lttng_ust_type_enum)
 446                 return NULL;
 447         return caa_container_of(type, struct lttng_ust_type_enum, parent);
 448 }
 449
 450 static inline
 451 struct lttng_ust_type_array *lttng_ust_get_type_array(struct lttng_ust_type_common *type)
 452 {
 453         if (type->type != lttng_ust_type_array)
 454                 return NULL;
 455         return caa_container_of(type, struct lttng_ust_type_array, parent);
 456 }
 457
 458 static inline
 459 struct lttng_ust_type_sequence *lttng_ust_get_type_sequence(struct lttng_ust_type_common *type)
 460 {
 461         if (type->type != lttng_ust_type_sequence)
 462                 return NULL;
 463         return caa_container_of(type, struct lttng_ust_type_sequence, parent);
 464 }
 465
 466 static inline
 467 struct lttng_ust_type_struct *lttng_ust_get_type_struct(struct lttng_ust_type_common *type)
 468 {
 469         if (type->type != lttng_ust_type_struct)
 470                 return NULL;
 471         return caa_container_of(type, struct lttng_ust_type_struct, parent);
 472 }
 473
 474 /* Create dynamically allocated types. */
 475 static inline
 476 struct lttng_ust_type_common *lttng_ust_create_type_integer(unsigned int size,
 477                 unsigned short alignment, bool signedness, unsigned int byte_order,
 478                 unsigned int base)
 479 {
 480         struct lttng_ust_type_integer *integer_type;
 481
 482         integer_type = zmalloc(sizeof(struct lttng_ust_type_integer));
 483         if (!integer_type)
 484                 return NULL;
 485         integer_type->parent.type = lttng_ust_type_integer;
 486         integer_type->struct_size = sizeof(struct lttng_ust_type_integer);
 487         integer_type->size = size;
 488         integer_type->alignment = alignment;
 489         integer_type->signedness = signedness;
 490         integer_type->reverse_byte_order = byte_order != BYTE_ORDER;
 491         integer_type->base = base;
 492         return (struct lttng_ust_type_common *) integer_type;
 493 }
 494
 495 static inline
 496 struct lttng_ust_type_common *lttng_ust_create_type_array_text(unsigned int length)
 497 {
 498         struct lttng_ust_type_array *array_type;
 499
 500         array_type = zmalloc(sizeof(struct lttng_ust_type_array));
 501         if (!array_type)
 502                 return NULL;
 503         array_type->parent.type = lttng_ust_type_array;
 504         array_type->struct_size = sizeof(struct lttng_ust_type_array);
 505         array_type->length = length;
 506         array_type->alignment = 0;
 507         array_type->encoding = lttng_ust_string_encoding_UTF8;
 508         array_type->elem_type = lttng_ust_create_type_integer(sizeof(char) * CHAR_BIT,
 509                         lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char),
 510                         BYTE_ORDER, 10);
 511         if (!array_type->elem_type)
 512                 goto error_elem;
 513         return (struct lttng_ust_type_common *) array_type;
 514
 515 error_elem:
 516         free(array_type);
 517         return NULL;
 518 }
 519
 520 /*
 521  * Destroy dynamically allocated types, including nested types.
 522  * For enumerations, it does not free the enumeration mapping description.
 523  */
 524 static inline
 525 void lttng_ust_destroy_type(struct lttng_ust_type_common *type)
 526 {
 527         if (!type)
 528                 return;
 529
 530         switch (type->type) {
 531         case lttng_ust_type_integer:
 532         case lttng_ust_type_string:
 533         case lttng_ust_type_float:
 534         case lttng_ust_type_dynamic:
 535                 free(type);
 536                 break;
 537         case lttng_ust_type_enum:
 538         {
 539                 struct lttng_ust_type_enum *enum_type = (struct lttng_ust_type_enum *) type;
 540
 541                 lttng_ust_destroy_type(enum_type->container_type);
 542                 free(enum_type);
 543                 break;
 544         }
 545         case lttng_ust_type_array:
 546         {
 547                 struct lttng_ust_type_array *array_type = (struct lttng_ust_type_array *) type;
 548
 549                 lttng_ust_destroy_type(array_type->elem_type);
 550                 free(array_type);
 551                 break;
 552         }
 553         case lttng_ust_type_sequence:
 554         {
 555                 struct lttng_ust_type_sequence *sequence_type = (struct lttng_ust_type_sequence *) type;
 556
 557                 lttng_ust_destroy_type(sequence_type->elem_type);
 558                 free(sequence_type);
 559                 break;
 560         }
 561         case lttng_ust_type_struct:
 562         {
 563                 struct lttng_ust_type_struct *struct_type = (struct lttng_ust_type_struct *) type;
 564                 unsigned int i;
 565
 566                 for (i = 0; i < struct_type->nr_fields; i++)
 567                         lttng_ust_destroy_type(struct_type->fields[i]->type);
 568                 free(struct_type);
 569                 break;
 570         }
 571         default:
 572                 abort();
 573         }
 574 }
 575
 576 static inline
 577 struct lttng_enabler *lttng_event_enabler_as_enabler(
 578                 struct lttng_event_enabler *event_enabler)
 579 {
 580         return &event_enabler->base;
 581 }
 582
 583 static inline
 584 struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
 585                 struct lttng_event_notifier_enabler *event_notifier_enabler)
 586 {
 587         return &event_notifier_enabler->base;
 588 }
 589
 590 /*
 591  * Allocate and initialize a `struct lttng_event_enabler` object.
 592  *
 593  * On success, returns a `struct lttng_event_enabler`,
 594  * On memory error, returns NULL.
 595  */
 596 __attribute__((visibility("hidden")))
 597 struct lttng_event_enabler *lttng_event_enabler_create(
 598                 enum lttng_enabler_format_type format_type,
 599                 struct lttng_ust_abi_event *event_param,
 600                 struct lttng_ust_channel_buffer *chan);
 601
 602 /*
 603  * Destroy a `struct lttng_event_enabler` object.
 604  */
 605 __attribute__((visibility("hidden")))
 606 void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
 607
 608 /*
 609  * Enable a `struct lttng_event_enabler` object and all events related to this
 610  * enabler.
 611  */
 612 __attribute__((visibility("hidden")))
 613 int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
 614
 615 /*
 616  * Disable a `struct lttng_event_enabler` object and all events related to this
 617  * enabler.
 618  */
 619 __attribute__((visibility("hidden")))
 620 int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
 621
 622 /*
 623  * Attach filter bytecode program to `struct lttng_event_enabler` and all
 624  * events related to this enabler.
 625  */
 626 __attribute__((visibility("hidden")))
 627 int lttng_event_enabler_attach_filter_bytecode(
 628                 struct lttng_event_enabler *enabler,
 629                 struct lttng_ust_bytecode_node **bytecode);
 630
 631 /*
 632  * Attach an application context to an event enabler.
 633  *
 634  * Not implemented.
 635  */
 636 __attribute__((visibility("hidden")))
 637 int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
 638                 struct lttng_ust_abi_context *ctx);
 639
 640 /*
 641  * Attach exclusion list to `struct lttng_event_enabler` and all
 642  * events related to this enabler.
 643  */
 644 __attribute__((visibility("hidden")))
 645 int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
 646                 struct lttng_ust_excluder_node **excluder);
 647
 648 /*
 649  * Synchronize bytecodes for the enabler and the instance (event or
 650  * event_notifier).
 651  *
 652  * This function goes over all bytecode programs of the enabler (event or
 653  * event_notifier enabler) to ensure each is linked to the provided instance.
 654  */
 655 __attribute__((visibility("hidden")))
 656 void lttng_enabler_link_bytecode(struct lttng_ust_event_desc *event_desc,
 657                 struct lttng_ust_ctx **ctx,
 658                 struct cds_list_head *instance_bytecode_runtime_head,
 659                 struct cds_list_head *enabler_bytecode_runtime_head);
 660
 661 /*
 662  * Allocate and initialize a `struct lttng_event_notifier_group` object.
 663  *
 664  * On success, returns a `struct lttng_triggre_group`,
 665  * on memory error, returns NULL.
 666  */
 667 __attribute__((visibility("hidden")))
 668 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
 669
 670 /*
 671  * Destroy a `struct lttng_event_notifier_group` object.
 672  */
 673 __attribute__((visibility("hidden")))
 674 void lttng_event_notifier_group_destroy(
 675                 struct lttng_event_notifier_group *event_notifier_group);
 676
 677 /*
 678  * Allocate and initialize a `struct lttng_event_notifier_enabler` object.
 679  *
 680  * On success, returns a `struct lttng_event_notifier_enabler`,
 681  * On memory error, returns NULL.
 682  */
 683 __attribute__((visibility("hidden")))
 684 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
 685                 struct lttng_event_notifier_group *event_notifier_group,
 686                 enum lttng_enabler_format_type format_type,
 687                 struct lttng_ust_abi_event_notifier *event_notifier_param);
 688
 689 /*
 690  * Destroy a `struct lttng_event_notifier_enabler` object.
 691  */
 692 __attribute__((visibility("hidden")))
 693 void lttng_event_notifier_enabler_destroy(
 694                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 695
 696 /*
 697  * Enable a `struct lttng_event_notifier_enabler` object and all event
 698  * notifiers related to this enabler.
 699  */
 700 __attribute__((visibility("hidden")))
 701 int lttng_event_notifier_enabler_enable(
 702                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 703
 704 /*
 705  * Disable a `struct lttng_event_notifier_enabler` object and all event
 706  * notifiers related to this enabler.
 707  */
 708 __attribute__((visibility("hidden")))
 709 int lttng_event_notifier_enabler_disable(
 710                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 711
 712 /*
 713  * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
 714  * all event notifiers related to this enabler.
 715  */
 716 __attribute__((visibility("hidden")))
 717 int lttng_event_notifier_enabler_attach_filter_bytecode(
 718                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 719                 struct lttng_ust_bytecode_node **bytecode);
 720
 721 /*
 722  * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
 723  * all event_notifiers related to this enabler.
 724  */
 725 __attribute__((visibility("hidden")))
 726 int lttng_event_notifier_enabler_attach_capture_bytecode(
 727                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 728                 struct lttng_ust_bytecode_node **bytecode);
 729
 730 /*
 731  * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
 732  * event notifiers related to this enabler.
 733  */
 734 __attribute__((visibility("hidden")))
 735 int lttng_event_notifier_enabler_attach_exclusion(
 736                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 737                 struct lttng_ust_excluder_node **excluder);
 738
 739 __attribute__((visibility("hidden")))
 740 void lttng_free_event_filter_runtime(struct lttng_ust_event_common *event);
 741
 742 /*
 743  * Connect the probe on all enablers matching this event description.
 744  * Called on library load.
 745  */
 746 __attribute__((visibility("hidden")))
 747 int lttng_fix_pending_event_notifiers(void);
 748
 749 __attribute__((visibility("hidden")))
 750 struct lttng_counter *lttng_ust_counter_create(
 751                 const char *counter_transport_name,
 752                 size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
 753
 754 #ifdef HAVE_PERF_EVENT
 755
 756 __attribute__((visibility("hidden")))
 757 int lttng_add_perf_counter_to_ctx(uint32_t type,
 758                                   uint64_t config,
 759                                   const char *name,
 760                                   struct lttng_ust_ctx **ctx);
 761
 762 __attribute__((visibility("hidden")))
 763 int lttng_perf_counter_init(void);
 764
 765 __attribute__((visibility("hidden")))
 766 void lttng_perf_counter_exit(void);
 767
 768 #else /* #ifdef HAVE_PERF_EVENT */
 769
 770 static inline
 771 int lttng_add_perf_counter_to_ctx(uint32_t type,
 772                                   uint64_t config,
 773                                   const char *name,
 774                                   struct lttng_ust_ctx **ctx)
 775 {
 776         return -ENOSYS;
 777 }
 778 static inline
 779 int lttng_perf_counter_init(void)
 780 {
 781         return 0;
 782 }
 783 static inline
 784 void lttng_perf_counter_exit(void)
 785 {
 786 }
 787 #endif /* #else #ifdef HAVE_PERF_EVENT */
 788
 789 __attribute__((visibility("hidden")))
 790 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
 791
 792 __attribute__((visibility("hidden")))
 793 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
 794
 795 __attribute__((visibility("hidden")))
 796 int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
 797
 798 __attribute__((visibility("hidden")))
 799 void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 800
 801 __attribute__((visibility("hidden")))
 802 struct lttng_ust_abi_tracepoint_iter *
 803         lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
 804
 805 __attribute__((visibility("hidden")))
 806 struct lttng_ust_abi_field_iter *
 807         lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 808
 809 __attribute__((visibility("hidden")))
 810 struct lttng_ust_session *lttng_session_create(void);
 811
 812 __attribute__((visibility("hidden")))
 813 int lttng_session_enable(struct lttng_ust_session *session);
 814
 815 __attribute__((visibility("hidden")))
 816 int lttng_session_disable(struct lttng_ust_session *session);
 817
 818 __attribute__((visibility("hidden")))
 819 int lttng_session_statedump(struct lttng_ust_session *session);
 820
 821 __attribute__((visibility("hidden")))
 822 void lttng_session_destroy(struct lttng_ust_session *session);
 823
 824 /*
 825  * Called with ust lock held.
 826  */
 827 __attribute__((visibility("hidden")))
 828 int lttng_session_active(void);
 829
 830 __attribute__((visibility("hidden")))
 831 struct cds_list_head *lttng_get_sessions(void);
 832
 833 __attribute__((visibility("hidden")))
 834 void lttng_handle_pending_statedump(void *owner);
 835
 836 __attribute__((visibility("hidden")))
 837 int lttng_channel_enable(struct lttng_ust_channel_common *lttng_channel);
 838
 839 __attribute__((visibility("hidden")))
 840 int lttng_channel_disable(struct lttng_ust_channel_common *lttng_channel);
 841
 842 __attribute__((visibility("hidden")))
 843 void lttng_transport_register(struct lttng_transport *transport);
 844
 845 __attribute__((visibility("hidden")))
 846 void lttng_transport_unregister(struct lttng_transport *transport);
 847
 848 /* This is ABI between liblttng-ust and liblttng-ust-ctl */
 849 struct lttng_transport *lttng_ust_transport_find(const char *name);
 850
 851 /* This is ABI between liblttng-ust and liblttng-ust-dl */
 852 void lttng_ust_dl_update(void *ip);
 853
 854 __attribute__((visibility("hidden")))
 855 void lttng_probe_provider_unregister_events(struct lttng_ust_probe_desc *desc);
 856
 857 __attribute__((visibility("hidden")))
 858 int lttng_fix_pending_events(void);
 859
 860 __attribute__((visibility("hidden")))
 861 struct cds_list_head *lttng_get_probe_list_head(void);
 862
 863 __attribute__((visibility("hidden")))
 864 struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_ust_session *session,
 865                 struct lttng_ust_enum_desc *enum_desc);
 866
 867 __attribute__((visibility("hidden")))
 868 int lttng_abi_create_root_handle(void);
 869
 870 __attribute__((visibility("hidden")))
 871 const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id);
 872
 873 __attribute__((visibility("hidden")))
 874 int lttng_ust_abi_objd_unref(int id, int is_owner);
 875
 876 __attribute__((visibility("hidden")))
 877 void lttng_ust_abi_exit(void);
 878
 879 __attribute__((visibility("hidden")))
 880 void lttng_ust_abi_events_exit(void);
 881
 882 __attribute__((visibility("hidden")))
 883 void lttng_ust_abi_objd_table_owner_cleanup(void *owner);
 884
 885 __attribute__((visibility("hidden")))
 886 struct lttng_ust_channel_buffer *lttng_ust_alloc_channel_buffer(void);
 887
 888 __attribute__((visibility("hidden")))
 889 void lttng_ust_free_channel_common(struct lttng_ust_channel_common *chan);
 890
 891 __attribute__((visibility("hidden")))
 892 int lttng_ust_interpret_event_filter(struct lttng_ust_event_common *event,
 893                 const char *interpreter_stack_data,
 894                 void *filter_ctx);
 895
 896 #endif /* _LTTNG_UST_EVENTS_INTERNAL_H */