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