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-abi.h>
  34 #include <lttng/ust-tracer.h>
  35 #include <lttng/ust-endian.h>
  36 #include <float.h>
  37
  38 #define LTTNG_UST_UUID_LEN              16
  39
  40 struct lttng_channel;
  41 struct lttng_session;
  42 struct lttng_ust_lib_ring_buffer_ctx;
  43
  44 /*
  45  * Data structures used by tracepoint event declarations, and by the
  46  * tracer. Those structures have padding for future extension.
  47  */
  48
  49 /*
  50  * LTTng client type enumeration. Used by the consumer to map the
  51  * callbacks from its own address space.
  52  */
  53 enum lttng_client_types {
  54         LTTNG_CLIENT_METADATA = 0,
  55         LTTNG_CLIENT_DISCARD = 1,
  56         LTTNG_CLIENT_OVERWRITE = 2,
  57         LTTNG_NR_CLIENT_TYPES,
  58 };
  59
  60 /* Type description */
  61
  62 /* Update the astract_types name table in lttng-types.c along with this enum */
  63 enum lttng_abstract_types {
  64         atype_integer,
  65         atype_enum,
  66         atype_array,
  67         atype_sequence,
  68         atype_string,
  69         atype_float,
  70         NR_ABSTRACT_TYPES,
  71 };
  72
  73 /* Update the string_encodings name table in lttng-types.c along with this enum */
  74 enum lttng_string_encodings {
  75         lttng_encode_none = 0,
  76         lttng_encode_UTF8 = 1,
  77         lttng_encode_ASCII = 2,
  78         NR_STRING_ENCODINGS,
  79 };
  80
  81 #define LTTNG_UST_ENUM_ENTRY_PADDING    16
  82 struct lttng_enum_entry {
  83         unsigned long long start, end;  /* start and end are inclusive */
  84         const char *string;
  85         char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
  86 };
  87
  88 #define __type_integer(_type, _byte_order, _base, _encoding)    \
  89         {                                                       \
  90             .atype = atype_integer,                             \
  91             .u.basic.integer =                                  \
  92                 {                                               \
  93                   .size = sizeof(_type) * CHAR_BIT,             \
  94                   .alignment = lttng_alignof(_type) * CHAR_BIT, \
  95                   .signedness = lttng_is_signed_type(_type),    \
  96                   .reverse_byte_order = _byte_order != BYTE_ORDER,      \
  97                   .base = _base,                                \
  98                   .encoding = lttng_encode_##_encoding,         \
  99                 },                                              \
 100         }                                                       \
 101
 102 #define LTTNG_UST_INTEGER_TYPE_PADDING  24
 103 struct lttng_integer_type {
 104         unsigned int size;              /* in bits */
 105         unsigned short alignment;       /* in bits */
 106         unsigned int signedness:1;
 107         unsigned int reverse_byte_order:1;
 108         unsigned int base;              /* 2, 8, 10, 16, for pretty print */
 109         enum lttng_string_encodings encoding;
 110         char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
 111 };
 112
 113 /*
 114  * Only float and double are supported. long double is not supported at
 115  * the moment.
 116  */
 117 #define _float_mant_dig(_type)                                          \
 118         (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG                  \
 119                 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG       \
 120                 : 0))
 121
 122 #define __type_float(_type)                                     \
 123         {                                                       \
 124             .atype = atype_float,                               \
 125             .u.basic._float =                                   \
 126                 {                                               \
 127                   .exp_dig = sizeof(_type) * CHAR_BIT           \
 128                                 - _float_mant_dig(_type),       \
 129                   .mant_dig = _float_mant_dig(_type),           \
 130                   .alignment = lttng_alignof(_type) * CHAR_BIT, \
 131                   .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
 132                 },                                              \
 133         }                                                       \
 134
 135 #define LTTNG_UST_FLOAT_TYPE_PADDING    24
 136 struct lttng_float_type {
 137         unsigned int exp_dig;           /* exponent digits, in bits */
 138         unsigned int mant_dig;          /* mantissa digits, in bits */
 139         unsigned short alignment;       /* in bits */
 140         unsigned int reverse_byte_order:1;
 141         char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
 142 };
 143
 144 #define LTTNG_UST_BASIC_TYPE_PADDING    128
 145 union _lttng_basic_type {
 146         struct lttng_integer_type integer;
 147         struct {
 148                 const char *name;
 149         } enumeration;
 150         struct {
 151                 enum lttng_string_encodings encoding;
 152         } string;
 153         struct lttng_float_type _float;
 154         char padding[LTTNG_UST_BASIC_TYPE_PADDING];
 155 };
 156
 157 struct lttng_basic_type {
 158         enum lttng_abstract_types atype;
 159         union {
 160                 union _lttng_basic_type basic;
 161         } u;
 162 };
 163
 164 #define LTTNG_UST_TYPE_PADDING  128
 165 struct lttng_type {
 166         enum lttng_abstract_types atype;
 167         union {
 168                 union _lttng_basic_type basic;
 169                 struct {
 170                         struct lttng_basic_type elem_type;
 171                         unsigned int length;            /* num. elems. */
 172                 } array;
 173                 struct {
 174                         struct lttng_basic_type length_type;
 175                         struct lttng_basic_type elem_type;
 176                 } sequence;
 177                 char padding[LTTNG_UST_TYPE_PADDING];
 178         } u;
 179 };
 180
 181 #define LTTNG_UST_ENUM_TYPE_PADDING     24
 182 struct lttng_enum {
 183         const char *name;
 184         struct lttng_type container_type;
 185         const struct lttng_enum_entry *entries;
 186         unsigned int len;
 187         char padding[LTTNG_UST_ENUM_TYPE_PADDING];
 188 };
 189
 190 /*
 191  * Event field description
 192  *
 193  * IMPORTANT: this structure is part of the ABI between the probe and
 194  * UST. Fields need to be only added at the end, never reordered, never
 195  * removed.
 196  */
 197
 198 #define LTTNG_UST_EVENT_FIELD_PADDING   28
 199 struct lttng_event_field {
 200         const char *name;
 201         struct lttng_type type;
 202         unsigned int nowrite;   /* do not write into trace */
 203         char padding[LTTNG_UST_EVENT_FIELD_PADDING];
 204 };
 205
 206 #define LTTNG_UST_CTX_FIELD_PADDING     40
 207 struct lttng_ctx_field {
 208         struct lttng_event_field event_field;
 209         size_t (*get_size)(size_t offset);
 210         void (*record)(struct lttng_ctx_field *field,
 211                        struct lttng_ust_lib_ring_buffer_ctx *ctx,
 212                        struct lttng_channel *chan);
 213         union {
 214                 char padding[LTTNG_UST_CTX_FIELD_PADDING];
 215         } u;
 216         void (*destroy)(struct lttng_ctx_field *field);
 217 };
 218
 219 #define LTTNG_UST_CTX_PADDING   24
 220 struct lttng_ctx {
 221         struct lttng_ctx_field *fields;
 222         unsigned int nr_fields;
 223         unsigned int allocated_fields;
 224         char padding[LTTNG_UST_CTX_PADDING];
 225 };
 226
 227 #define LTTNG_UST_EVENT_DESC_PADDING    40
 228 struct lttng_event_desc {
 229         const char *name;
 230         void (*probe_callback)(void);
 231         const struct lttng_event_ctx *ctx;      /* context */
 232         const struct lttng_event_field *fields; /* event payload */
 233         unsigned int nr_fields;
 234         const int **loglevel;
 235         const char *signature;  /* Argument types/names received */
 236         union {
 237                 struct {
 238                         const char **model_emf_uri;
 239                 } ext;
 240                 char padding[LTTNG_UST_EVENT_DESC_PADDING];
 241         } u;
 242 };
 243
 244 #define LTTNG_UST_PROBE_DESC_PADDING    40
 245 struct lttng_probe_desc {
 246         const char *provider;
 247         const struct lttng_event_desc **event_desc;
 248         unsigned int nr_events;
 249         struct cds_list_head head;              /* chain registered probes */
 250         char padding[LTTNG_UST_PROBE_DESC_PADDING];
 251 };
 252
 253 /* Data structures used by the tracer. */
 254
 255 enum lttng_enabler_type {
 256         LTTNG_ENABLER_WILDCARD,
 257         LTTNG_ENABLER_EVENT,
 258 };
 259
 260 /*
 261  * Enabler field, within whatever object is enabling an event. Target of
 262  * backward reference.
 263  */
 264 struct lttng_enabler {
 265         enum lttng_enabler_type type;
 266
 267         /* head list of struct lttng_ust_filter_bytecode_node */
 268         struct cds_list_head filter_bytecode_head;
 269         struct cds_list_head node;      /* per-session list of enablers */
 270
 271         struct lttng_ust_event event_param;
 272         struct lttng_channel *chan;
 273         struct lttng_ctx *ctx;
 274         unsigned int enabled:1;
 275 };
 276
 277 struct tp_list_entry {
 278         struct lttng_ust_tracepoint_iter tp;
 279         struct cds_list_head head;
 280 };
 281
 282 struct lttng_ust_tracepoint_list {
 283         struct tp_list_entry *iter;
 284         struct cds_list_head head;
 285 };
 286
 287 struct tp_field_list_entry {
 288         struct lttng_ust_field_iter field;
 289         struct cds_list_head head;
 290 };
 291
 292 struct lttng_ust_field_list {
 293         struct tp_field_list_entry *iter;
 294         struct cds_list_head head;
 295 };
 296
 297 struct ust_pending_probe;
 298 struct lttng_event;
 299
 300 struct lttng_ust_filter_bytecode_node {
 301         struct cds_list_head node;
 302         struct lttng_enabler *enabler;
 303         /*
 304          * struct lttng_ust_filter_bytecode has var. sized array, must
 305          * be last field.
 306          */
 307         struct lttng_ust_filter_bytecode bc;
 308 };
 309
 310 /*
 311  * Filter return value masks.
 312  */
 313 enum lttng_filter_ret {
 314         LTTNG_FILTER_DISCARD = 0,
 315         LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
 316         /* Other bits are kept for future use. */
 317 };
 318
 319 struct lttng_bytecode_runtime {
 320         /* Associated bytecode */
 321         struct lttng_ust_filter_bytecode_node *bc;
 322         uint64_t (*filter)(void *filter_data, const char *filter_stack_data);
 323         int link_failed;
 324         struct cds_list_head node;      /* list of bytecode runtime in event */
 325 };
 326
 327 /*
 328  * Objects in a linked-list of enablers, owned by an event.
 329  */
 330 struct lttng_enabler_ref {
 331         struct cds_list_head node;              /* enabler ref list */
 332         struct lttng_enabler *ref;              /* backward ref */
 333 };
 334
 335 /*
 336  * lttng_event structure is referred to by the tracing fast path. It
 337  * must be kept small.
 338  *
 339  * IMPORTANT: this structure is part of the ABI between the probe and
 340  * UST. Fields need to be only added at the end, never reordered, never
 341  * removed.
 342  */
 343 struct lttng_event {
 344         /* LTTng-UST 2.0 starts here */
 345         unsigned int id;
 346         struct lttng_channel *chan;
 347         int enabled;
 348         const struct lttng_event_desc *desc;
 349         void *_deprecated1;
 350         struct lttng_ctx *ctx;
 351         enum lttng_ust_instrumentation instrumentation;
 352         union {
 353         } u;
 354         struct cds_list_head node;              /* Event list in session */
 355         struct cds_list_head _deprecated2;
 356         void *_deprecated3;
 357         unsigned int metadata_dumped:1;
 358
 359         /* LTTng-UST 2.1 starts here */
 360         /* list of struct lttng_bytecode_runtime, sorted by seqnum */
 361         struct cds_list_head bytecode_runtime_head;
 362         int has_enablers_without_bytecode;
 363         /* Backward references: list of lttng_enabler_ref (ref to enablers) */
 364         struct cds_list_head enablers_ref_head;
 365         struct cds_hlist_node hlist;    /* session ht of events */
 366 };
 367
 368 struct channel;
 369 struct lttng_ust_shm_handle;
 370
 371 /*
 372  * IMPORTANT: this structure is part of the ABI between the probe and
 373  * UST. Fields need to be only added at the end, never reordered, never
 374  * removed.
 375  */
 376 struct lttng_channel_ops {
 377         struct lttng_channel *(*channel_create)(const char *name,
 378                         void *buf_addr,
 379                         size_t subbuf_size, size_t num_subbuf,
 380                         unsigned int switch_timer_interval,
 381                         unsigned int read_timer_interval,
 382                         unsigned char *uuid);
 383         void (*channel_destroy)(struct lttng_channel *chan);
 384         int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
 385                              uint32_t event_id);
 386         void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
 387         void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
 388                         const void *src, size_t len);
 389         /*
 390          * packet_avail_size returns the available size in the current
 391          * packet. Note that the size returned is only a hint, since it
 392          * may change due to concurrent writes.
 393          */
 394         size_t (*packet_avail_size)(struct channel *chan,
 395                                     struct lttng_ust_shm_handle *handle);
 396         //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
 397         //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 398         int (*is_finalized)(struct channel *chan);
 399         int (*is_disabled)(struct channel *chan);
 400         int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
 401 };
 402
 403 /*
 404  * IMPORTANT: this structure is part of the ABI between the probe and
 405  * UST. Fields need to be only added at the end, never reordered, never
 406  * removed.
 407  */
 408 struct lttng_channel {
 409         /*
 410          * The pointers located in this private data are NOT safe to be
 411          * dereferenced by the consumer. The only operations the
 412          * consumer process is designed to be allowed to do is to read
 413          * and perform subbuffer flush.
 414          */
 415         struct channel *chan;           /* Channel buffers */
 416         int enabled;
 417         struct lttng_ctx *ctx;
 418         /* Event ID management */
 419         struct lttng_session *session;
 420         int objd;                       /* Object associated to channel */
 421         unsigned int free_event_id;     /* Next event ID to allocate */
 422         unsigned int used_event_id;     /* Max allocated event IDs */
 423         struct cds_list_head node;      /* Channel list in session */
 424         const struct lttng_channel_ops *ops;
 425         int header_type;                /* 0: unset, 1: compact, 2: large */
 426         struct lttng_ust_shm_handle *handle;    /* shared-memory handle */
 427         unsigned int metadata_dumped:1;
 428
 429         /* Channel ID */
 430         unsigned int id;
 431         enum lttng_ust_chan_type type;
 432         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
 433 };
 434
 435 #define LTTNG_UST_EVENT_HT_BITS         12
 436 #define LTTNG_UST_EVENT_HT_SIZE         (1U << LTTNG_UST_EVENT_HT_BITS)
 437
 438 struct lttng_ust_event_ht {
 439         struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
 440 };
 441
 442 /*
 443  * IMPORTANT: this structure is part of the ABI between the probe and
 444  * UST. Fields need to be only added at the end, never reordered, never
 445  * removed.
 446  */
 447 struct lttng_session {
 448         int active;                             /* Is trace session active ? */
 449         int been_active;                        /* Been active ? */
 450         int objd;                               /* Object associated */
 451         struct lttng_channel *metadata;         /* Metadata channel */
 452         struct cds_list_head chan_head;         /* Channel list head */
 453         struct cds_list_head events_head;       /* list of events */
 454         struct cds_list_head _deprecated1;
 455         struct cds_list_head node;              /* Session list */
 456         unsigned int free_chan_id;              /* Next chan ID to allocate */
 457         unsigned int metadata_dumped:1;
 458
 459         /* New UST 2.1 */
 460         /* List of enablers */
 461         struct cds_list_head enablers_head;
 462         struct lttng_ust_event_ht events_ht;    /* ht of events */
 463 };
 464
 465 struct lttng_transport {
 466         char *name;
 467         struct cds_list_head node;
 468         struct lttng_channel_ops ops;
 469         const struct lttng_ust_lib_ring_buffer_config *client_config;
 470 };
 471
 472 struct lttng_session *lttng_session_create(void);
 473 int lttng_session_enable(struct lttng_session *session);
 474 int lttng_session_disable(struct lttng_session *session);
 475 void lttng_session_destroy(struct lttng_session *session);
 476
 477 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 478                                        const char *transport_name,
 479                                        void *buf_addr,
 480                                        size_t subbuf_size, size_t num_subbuf,
 481                                        unsigned int switch_timer_interval,
 482                                        unsigned int read_timer_interval,
 483                                        int **shm_fd, int **wait_fd,
 484                                        uint64_t **memory_map_size,
 485                                        struct lttng_channel *chan_priv_init);
 486
 487 int lttng_channel_enable(struct lttng_channel *channel);
 488 int lttng_channel_disable(struct lttng_channel *channel);
 489
 490 struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type,
 491                 struct lttng_ust_event *event_param,
 492                 struct lttng_channel *chan);
 493 int lttng_enabler_enable(struct lttng_enabler *enabler);
 494 int lttng_enabler_disable(struct lttng_enabler *enabler);
 495 int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
 496                 struct lttng_ust_filter_bytecode_node *bytecode);
 497 int lttng_enabler_attach_context(struct lttng_enabler *enabler,
 498                 struct lttng_ust_context *ctx);
 499
 500 int lttng_attach_context(struct lttng_ust_context *context_param,
 501                 struct lttng_ctx **ctx, struct lttng_session *session);
 502
 503 void lttng_transport_register(struct lttng_transport *transport);
 504 void lttng_transport_unregister(struct lttng_transport *transport);
 505
 506 void synchronize_trace(void);
 507
 508 int lttng_probe_register(struct lttng_probe_desc *desc);
 509 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 510 int lttng_fix_pending_event_desc(const struct lttng_event_desc *desc);
 511 int lttng_probes_init(void);
 512 void lttng_probes_exit(void);
 513 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
 514 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
 515 void lttng_remove_context_field(struct lttng_ctx **ctx_p,
 516                                 struct lttng_ctx_field *field);
 517 void lttng_destroy_context(struct lttng_ctx *ctx);
 518 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
 519 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
 520 int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
 521 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 522 void lttng_context_vtid_reset(void);
 523 void lttng_context_vpid_reset(void);
 524
 525 extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
 526 extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
 527 extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
 528
 529 struct lttng_transport *lttng_transport_find(const char *name);
 530
 531 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
 532 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
 533 struct lttng_ust_tracepoint_iter *
 534         lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
 535 int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
 536 void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 537 struct lttng_ust_field_iter *
 538         lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 539
 540 void lttng_filter_event_link_bytecode(struct lttng_event *event);
 541 void lttng_enabler_event_link_bytecode(struct lttng_event *event,
 542                 struct lttng_enabler *enabler);
 543 void lttng_free_event_filter_runtime(struct lttng_event *event);
 544 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
 545
 546 struct cds_list_head *lttng_get_probe_list_head(void);
 547
 548 #endif /* _LTTNG_UST_EVENTS_H */