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 <ust-helper.h>
  16 #include <lttng/ust-events.h>
  17
  18
  19 struct lttng_ust_abi_obj;
  20
  21 union lttng_ust_abi_args {
  22         struct {
  23                 void *chan_data;
  24                 int wakeup_fd;
  25         } channel;
  26         struct {
  27                 int shm_fd;
  28                 int wakeup_fd;
  29         } stream;
  30         struct {
  31                 struct lttng_ust_abi_field_iter entry;
  32         } field_list;
  33         struct {
  34                 char *ctxname;
  35         } app_context;
  36         struct {
  37                 int event_notifier_notif_fd;
  38         } event_notifier_handle;
  39         struct {
  40                 void *counter_data;
  41         } counter;
  42         struct {
  43                 int shm_fd;
  44         } counter_shm;
  45 };
  46
  47 struct lttng_ust_abi_objd_ops {
  48         long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
  49                 union lttng_ust_abi_args *args, void *owner);
  50         int (*release)(int objd);
  51 };
  52
  53 enum lttng_enabler_format_type {
  54         LTTNG_ENABLER_FORMAT_STAR_GLOB,
  55         LTTNG_ENABLER_FORMAT_EVENT,
  56 };
  57
  58 /*
  59  * Enabler field, within whatever object is enabling an event. Target of
  60  * backward reference.
  61  */
  62 struct lttng_enabler {
  63         enum lttng_enabler_format_type format_type;
  64
  65         /* head list of struct lttng_ust_filter_bytecode_node */
  66         struct cds_list_head filter_bytecode_head;
  67         /* head list of struct lttng_ust_excluder_node */
  68         struct cds_list_head excluder_head;
  69
  70         struct lttng_ust_abi_event event_param;
  71         unsigned int enabled:1;
  72 };
  73
  74 struct lttng_event_enabler {
  75         struct lttng_enabler base;
  76         struct cds_list_head node;      /* per-session list of enablers */
  77         struct lttng_channel *chan;
  78         /*
  79          * Unused, but kept around to make it explicit that the tracer can do
  80          * it.
  81          */
  82         struct lttng_ctx *ctx;
  83 };
  84
  85 struct lttng_event_notifier_enabler {
  86         struct lttng_enabler base;
  87         uint64_t error_counter_index;
  88         struct cds_list_head node;      /* per-app list of event_notifier enablers */
  89         struct cds_list_head capture_bytecode_head;
  90         struct lttng_event_notifier_group *group; /* weak ref */
  91         uint64_t user_token;            /* User-provided token */
  92         uint64_t num_captures;
  93 };
  94
  95 enum lttng_ust_bytecode_node_type {
  96         LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
  97         LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
  98 };
  99
 100 struct lttng_ust_bytecode_node {
 101         enum lttng_ust_bytecode_node_type type;
 102         struct cds_list_head node;
 103         struct lttng_enabler *enabler;
 104         struct  {
 105                 uint32_t len;
 106                 uint32_t reloc_offset;
 107                 uint64_t seqnum;
 108                 char data[];
 109         } bc;
 110 };
 111
 112 struct lttng_ust_excluder_node {
 113         struct cds_list_head node;
 114         struct lttng_enabler *enabler;
 115         /*
 116          * struct lttng_ust_event_exclusion had variable sized array,
 117          * must be last field.
 118          */
 119         struct lttng_ust_abi_event_exclusion excluder;
 120 };
 121
 122 /* Data structures used by the tracer. */
 123
 124 struct tp_list_entry {
 125         struct lttng_ust_abi_tracepoint_iter tp;
 126         struct cds_list_head head;
 127 };
 128
 129 struct lttng_ust_tracepoint_list {
 130         struct tp_list_entry *iter;
 131         struct cds_list_head head;
 132 };
 133
 134 struct tp_field_list_entry {
 135         struct lttng_ust_abi_field_iter field;
 136         struct cds_list_head head;
 137 };
 138
 139 struct lttng_ust_field_list {
 140         struct tp_field_list_entry *iter;
 141         struct cds_list_head head;
 142 };
 143
 144 /*
 145  * Objects in a linked-list of enablers, owned by an event or event_notifier.
 146  * This is used because an event (or a event_notifier) can be enabled by more
 147  * than one enabler and we want a quick way to iterate over all enablers of an
 148  * object.
 149  *
 150  * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
 151  * event with the name "my_app:abc".
 152  */
 153 struct lttng_enabler_ref {
 154         struct cds_list_head node;              /* enabler ref list */
 155         struct lttng_enabler *ref;              /* backward ref */
 156 };
 157
 158 #define LTTNG_COUNTER_DIMENSION_MAX     8
 159 struct lttng_counter_dimension {
 160         uint64_t size;
 161         uint64_t underflow_index;
 162         uint64_t overflow_index;
 163         uint8_t has_underflow;
 164         uint8_t has_overflow;
 165 };
 166
 167 struct lttng_counter_ops {
 168         struct lib_counter *(*counter_create)(size_t nr_dimensions,
 169                         const struct lttng_counter_dimension *dimensions,
 170                         int64_t global_sum_step,
 171                         int global_counter_fd,
 172                         int nr_counter_cpu_fds,
 173                         const int *counter_cpu_fds,
 174                         bool is_daemon);
 175         void (*counter_destroy)(struct lib_counter *counter);
 176         int (*counter_add)(struct lib_counter *counter,
 177                         const size_t *dimension_indexes, int64_t v);
 178         int (*counter_read)(struct lib_counter *counter,
 179                         const size_t *dimension_indexes, int cpu,
 180                         int64_t *value, bool *overflow, bool *underflow);
 181         int (*counter_aggregate)(struct lib_counter *counter,
 182                         const size_t *dimension_indexes, int64_t *value,
 183                         bool *overflow, bool *underflow);
 184         int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
 185 };
 186
 187 struct lttng_counter {
 188         int objd;
 189         struct lttng_event_notifier_group *event_notifier_group;    /* owner */
 190         struct lttng_counter_transport *transport;
 191         struct lib_counter *counter;
 192         struct lttng_counter_ops *ops;
 193 };
 194
 195 struct lttng_event_notifier_group {
 196         int objd;
 197         void *owner;
 198         int notification_fd;
 199         struct cds_list_head node;              /* Event notifier group handle list */
 200         struct cds_list_head enablers_head;
 201         struct cds_list_head event_notifiers_head;      /* list of event_notifiers */
 202         struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
 203         struct lttng_ctx *ctx;                  /* contexts for filters. */
 204
 205         struct lttng_counter *error_counter;
 206         size_t error_counter_len;
 207 };
 208
 209 struct lttng_transport {
 210         char *name;
 211         struct cds_list_head node;
 212         struct lttng_ust_channel_ops ops;
 213         const struct lttng_ust_lib_ring_buffer_config *client_config;
 214 };
 215
 216 struct lttng_counter_transport {
 217         char *name;
 218         struct cds_list_head node;
 219         struct lttng_counter_ops ops;
 220         const struct lib_counter_config *client_config;
 221 };
 222
 223 struct lttng_ust_event_common_private {
 224         struct lttng_ust_event_common *pub;     /* Public event interface */
 225
 226         const struct lttng_ust_event_desc *desc;
 227         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 228         struct cds_list_head enablers_ref_head;
 229         int registered;                 /* has reg'd tracepoint probe */
 230         uint64_t user_token;
 231 };
 232
 233 struct lttng_ust_event_recorder_private {
 234         struct lttng_ust_event_common_private parent;
 235
 236         struct lttng_ust_event_recorder *pub;   /* Public event interface */
 237         struct cds_list_head node;              /* Event recorder list */
 238         struct cds_hlist_node hlist;            /* Hash table of event recorders */
 239 };
 240
 241 struct lttng_ust_event_notifier_private {
 242         struct lttng_ust_event_common_private parent;
 243
 244         struct lttng_ust_event_notifier *pub;   /* Public event notifier interface */
 245         struct lttng_event_notifier_group *group; /* weak ref */
 246         size_t num_captures;                    /* Needed to allocate the msgpack array. */
 247         uint64_t error_counter_index;
 248         struct cds_list_head node;              /* Event notifier list */
 249         struct cds_hlist_node hlist;            /* Hash table of event notifiers */
 250 };
 251
 252 struct lttng_ust_bytecode_runtime_private {
 253         struct bytecode_runtime *pub;   /* Public bytecode runtime interface */
 254
 255         struct lttng_ust_bytecode_node *bc;
 256         int link_failed;
 257         /*
 258          * Pointer to a URCU-protected pointer owned by an `struct
 259          * lttng_session`or `struct lttng_event_notifier_group`.
 260          */
 261         struct lttng_ctx **pctx;
 262 };
 263
 264 struct lttng_ust_session_private {
 265         struct lttng_session *pub;              /* Public session interface */
 266
 267         int been_active;                        /* Been active ? */
 268         int objd;                               /* Object associated */
 269         struct cds_list_head chan_head;         /* Channel list head */
 270         struct cds_list_head events_head;       /* list of events */
 271         struct cds_list_head node;              /* Session list */
 272
 273         /* New UST 2.1 */
 274         /* List of enablers */
 275         struct cds_list_head enablers_head;
 276         struct lttng_ust_event_ht events_ht;    /* ht of events */
 277         void *owner;                            /* object owner */
 278         int tstate:1;                           /* Transient enable state */
 279
 280         /* New UST 2.4 */
 281         int statedump_pending:1;
 282
 283         /* New UST 2.8 */
 284         struct lttng_ust_enum_ht enums_ht;      /* ht of enumerations */
 285         struct cds_list_head enums_head;
 286         struct lttng_ctx *ctx;                  /* contexts for filters. */
 287 };
 288
 289 struct lttng_enum {
 290         const struct lttng_ust_enum_desc *desc;
 291         struct lttng_session *session;
 292         struct cds_list_head node;      /* Enum list in session */
 293         struct cds_hlist_node hlist;    /* Session ht of enums */
 294         uint64_t id;                    /* Enumeration ID in sessiond */
 295 };
 296
 297 static inline
 298 struct lttng_enabler *lttng_event_enabler_as_enabler(
 299                 struct lttng_event_enabler *event_enabler)
 300 {
 301         return &event_enabler->base;
 302 }
 303
 304 static inline
 305 struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
 306                 struct lttng_event_notifier_enabler *event_notifier_enabler)
 307 {
 308         return &event_notifier_enabler->base;
 309 }
 310
 311 /*
 312  * Allocate and initialize a `struct lttng_event_enabler` object.
 313  *
 314  * On success, returns a `struct lttng_event_enabler`,
 315  * On memory error, returns NULL.
 316  */
 317 LTTNG_HIDDEN
 318 struct lttng_event_enabler *lttng_event_enabler_create(
 319                 enum lttng_enabler_format_type format_type,
 320                 struct lttng_ust_abi_event *event_param,
 321                 struct lttng_channel *chan);
 322
 323 /*
 324  * Destroy a `struct lttng_event_enabler` object.
 325  */
 326 LTTNG_HIDDEN
 327 void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
 328
 329 /*
 330  * Enable a `struct lttng_event_enabler` object and all events related to this
 331  * enabler.
 332  */
 333 LTTNG_HIDDEN
 334 int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
 335
 336 /*
 337  * Disable a `struct lttng_event_enabler` object and all events related to this
 338  * enabler.
 339  */
 340 LTTNG_HIDDEN
 341 int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
 342
 343 /*
 344  * Attach filter bytecode program to `struct lttng_event_enabler` and all
 345  * events related to this enabler.
 346  */
 347 LTTNG_HIDDEN
 348 int lttng_event_enabler_attach_filter_bytecode(
 349                 struct lttng_event_enabler *enabler,
 350                 struct lttng_ust_bytecode_node **bytecode);
 351
 352 /*
 353  * Attach an application context to an event enabler.
 354  *
 355  * Not implemented.
 356  */
 357 LTTNG_HIDDEN
 358 int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
 359                 struct lttng_ust_abi_context *ctx);
 360
 361 /*
 362  * Attach exclusion list to `struct lttng_event_enabler` and all
 363  * events related to this enabler.
 364  */
 365 LTTNG_HIDDEN
 366 int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
 367                 struct lttng_ust_excluder_node **excluder);
 368
 369 /*
 370  * Synchronize bytecodes for the enabler and the instance (event or
 371  * event_notifier).
 372  *
 373  * This function goes over all bytecode programs of the enabler (event or
 374  * event_notifier enabler) to ensure each is linked to the provided instance.
 375  */
 376 LTTNG_HIDDEN
 377 void lttng_enabler_link_bytecode(const struct lttng_ust_event_desc *event_desc,
 378                 struct lttng_ctx **ctx,
 379                 struct cds_list_head *instance_bytecode_runtime_head,
 380                 struct cds_list_head *enabler_bytecode_runtime_head);
 381
 382 /*
 383  * Allocate and initialize a `struct lttng_event_notifier_group` object.
 384  *
 385  * On success, returns a `struct lttng_triggre_group`,
 386  * on memory error, returns NULL.
 387  */
 388 LTTNG_HIDDEN
 389 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
 390
 391 /*
 392  * Destroy a `struct lttng_event_notifier_group` object.
 393  */
 394 LTTNG_HIDDEN
 395 void lttng_event_notifier_group_destroy(
 396                 struct lttng_event_notifier_group *event_notifier_group);
 397
 398 /*
 399  * Allocate and initialize a `struct lttng_event_notifier_enabler` object.
 400  *
 401  * On success, returns a `struct lttng_event_notifier_enabler`,
 402  * On memory error, returns NULL.
 403  */
 404 LTTNG_HIDDEN
 405 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
 406                 struct lttng_event_notifier_group *event_notifier_group,
 407                 enum lttng_enabler_format_type format_type,
 408                 struct lttng_ust_abi_event_notifier *event_notifier_param);
 409
 410 /*
 411  * Destroy a `struct lttng_event_notifier_enabler` object.
 412  */
 413 LTTNG_HIDDEN
 414 void lttng_event_notifier_enabler_destroy(
 415                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 416
 417 /*
 418  * Enable a `struct lttng_event_notifier_enabler` object and all event
 419  * notifiers related to this enabler.
 420  */
 421 LTTNG_HIDDEN
 422 int lttng_event_notifier_enabler_enable(
 423                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 424
 425 /*
 426  * Disable a `struct lttng_event_notifier_enabler` object and all event
 427  * notifiers related to this enabler.
 428  */
 429 LTTNG_HIDDEN
 430 int lttng_event_notifier_enabler_disable(
 431                 struct lttng_event_notifier_enabler *event_notifier_enabler);
 432
 433 /*
 434  * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
 435  * all event notifiers related to this enabler.
 436  */
 437 LTTNG_HIDDEN
 438 int lttng_event_notifier_enabler_attach_filter_bytecode(
 439                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 440                 struct lttng_ust_bytecode_node **bytecode);
 441
 442 /*
 443  * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
 444  * all event_notifiers related to this enabler.
 445  */
 446 LTTNG_HIDDEN
 447 int lttng_event_notifier_enabler_attach_capture_bytecode(
 448                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 449                 struct lttng_ust_bytecode_node **bytecode);
 450
 451 /*
 452  * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
 453  * event notifiers related to this enabler.
 454  */
 455 LTTNG_HIDDEN
 456 int lttng_event_notifier_enabler_attach_exclusion(
 457                 struct lttng_event_notifier_enabler *event_notifier_enabler,
 458                 struct lttng_ust_excluder_node **excluder);
 459
 460 LTTNG_HIDDEN
 461 void lttng_free_event_filter_runtime(struct lttng_ust_event_common *event);
 462
 463 /*
 464  * Connect the probe on all enablers matching this event description.
 465  * Called on library load.
 466  */
 467 LTTNG_HIDDEN
 468 int lttng_fix_pending_event_notifiers(void);
 469
 470 LTTNG_HIDDEN
 471 struct lttng_counter *lttng_ust_counter_create(
 472                 const char *counter_transport_name,
 473                 size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
 474
 475 #ifdef HAVE_PERF_EVENT
 476
 477 LTTNG_HIDDEN
 478 int lttng_add_perf_counter_to_ctx(uint32_t type,
 479                                   uint64_t config,
 480                                   const char *name,
 481                                   struct lttng_ctx **ctx);
 482 LTTNG_HIDDEN
 483 int lttng_perf_counter_init(void);
 484 LTTNG_HIDDEN
 485 void lttng_perf_counter_exit(void);
 486
 487 #else /* #ifdef HAVE_PERF_EVENT */
 488
 489 static inline
 490 int lttng_add_perf_counter_to_ctx(uint32_t type,
 491                                   uint64_t config,
 492                                   const char *name,
 493                                   struct lttng_ctx **ctx)
 494 {
 495         return -ENOSYS;
 496 }
 497 static inline
 498 int lttng_perf_counter_init(void)
 499 {
 500         return 0;
 501 }
 502 static inline
 503 void lttng_perf_counter_exit(void)
 504 {
 505 }
 506 #endif /* #else #ifdef HAVE_PERF_EVENT */
 507
 508 LTTNG_HIDDEN
 509 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
 510 LTTNG_HIDDEN
 511 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
 512
 513 LTTNG_HIDDEN
 514 int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
 515 LTTNG_HIDDEN
 516 void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 517
 518 LTTNG_HIDDEN
 519 struct lttng_ust_abi_tracepoint_iter *
 520         lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
 521 LTTNG_HIDDEN
 522 struct lttng_ust_abi_field_iter *
 523         lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 524
 525 LTTNG_HIDDEN
 526 struct lttng_session *lttng_session_create(void);
 527 LTTNG_HIDDEN
 528 int lttng_session_enable(struct lttng_session *session);
 529 LTTNG_HIDDEN
 530 int lttng_session_disable(struct lttng_session *session);
 531 LTTNG_HIDDEN
 532 int lttng_session_statedump(struct lttng_session *session);
 533 LTTNG_HIDDEN
 534 void lttng_session_destroy(struct lttng_session *session);
 535
 536 LTTNG_HIDDEN
 537 struct cds_list_head *lttng_get_sessions(void);
 538
 539 LTTNG_HIDDEN
 540 void lttng_handle_pending_statedump(void *owner);
 541
 542 LTTNG_HIDDEN
 543 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 544                                        const char *transport_name,
 545                                        void *buf_addr,
 546                                        size_t subbuf_size, size_t num_subbuf,
 547                                        unsigned int switch_timer_interval,
 548                                        unsigned int read_timer_interval,
 549                                        int **shm_fd, int **wait_fd,
 550                                        uint64_t **memory_map_size,
 551                                        struct lttng_channel *chan_priv_init);
 552
 553 LTTNG_HIDDEN
 554 int lttng_channel_enable(struct lttng_channel *channel);
 555 LTTNG_HIDDEN
 556 int lttng_channel_disable(struct lttng_channel *channel);
 557
 558 LTTNG_HIDDEN
 559 void lttng_transport_register(struct lttng_transport *transport);
 560 LTTNG_HIDDEN
 561 void lttng_transport_unregister(struct lttng_transport *transport);
 562
 563 LTTNG_HIDDEN
 564 void lttng_probe_provider_unregister_events(struct lttng_ust_probe_desc *desc);
 565
 566 LTTNG_HIDDEN
 567 int lttng_fix_pending_events(void);
 568
 569 LTTNG_HIDDEN
 570 struct cds_list_head *lttng_get_probe_list_head(void);
 571
 572 LTTNG_HIDDEN
 573 struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
 574                 const struct lttng_ust_enum_desc *enum_desc);
 575
 576 LTTNG_HIDDEN
 577 int lttng_abi_create_root_handle(void);
 578
 579 LTTNG_HIDDEN
 580 const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id);
 581 LTTNG_HIDDEN
 582 int lttng_ust_abi_objd_unref(int id, int is_owner);
 583 LTTNG_HIDDEN
 584 void lttng_ust_abi_exit(void);
 585 LTTNG_HIDDEN
 586 void lttng_ust_abi_events_exit(void);
 587 LTTNG_HIDDEN
 588 void lttng_ust_abi_objd_table_owner_cleanup(void *owner);
 589
 590 #endif /* _LTTNG_UST_EVENTS_INTERNAL_H */