| 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 "common/macros.h" |
| 19 | #include "common/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 | const 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 | const 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 | const 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 | unsigned int id; |
| 288 | }; |
| 289 | |
| 290 | struct lttng_ust_event_notifier_private { |
| 291 | struct lttng_ust_event_common_private parent; |
| 292 | |
| 293 | struct lttng_ust_event_notifier *pub; /* Public event notifier interface */ |
| 294 | struct lttng_event_notifier_group *group; /* weak ref */ |
| 295 | size_t num_captures; /* Needed to allocate the msgpack array. */ |
| 296 | uint64_t error_counter_index; |
| 297 | struct cds_list_head node; /* Event notifier list */ |
| 298 | struct cds_hlist_node hlist; /* Hash table of event notifiers */ |
| 299 | struct cds_list_head capture_bytecode_runtime_head; |
| 300 | }; |
| 301 | |
| 302 | struct lttng_ust_bytecode_runtime { |
| 303 | enum lttng_ust_bytecode_type type; |
| 304 | struct lttng_ust_bytecode_node *bc; |
| 305 | int link_failed; |
| 306 | int (*interpreter_func)(struct lttng_ust_bytecode_runtime *bytecode_runtime, |
| 307 | const char *interpreter_stack_data, |
| 308 | void *ctx); |
| 309 | struct cds_list_head node; /* list of bytecode runtime in event */ |
| 310 | /* |
| 311 | * Pointer to a URCU-protected pointer owned by an `struct |
| 312 | * lttng_session`or `struct lttng_event_notifier_group`. |
| 313 | */ |
| 314 | struct lttng_ust_ctx **pctx; |
| 315 | }; |
| 316 | |
| 317 | struct lttng_ust_session_private { |
| 318 | struct lttng_ust_session *pub; /* Public session interface */ |
| 319 | |
| 320 | int been_active; /* Been active ? */ |
| 321 | int objd; /* Object associated */ |
| 322 | struct cds_list_head chan_head; /* Channel list head */ |
| 323 | struct cds_list_head events_head; /* list of events */ |
| 324 | struct cds_list_head node; /* Session list */ |
| 325 | |
| 326 | /* List of enablers */ |
| 327 | struct cds_list_head enablers_head; |
| 328 | struct lttng_ust_event_ht events_ht; /* ht of events */ |
| 329 | void *owner; /* object owner */ |
| 330 | int tstate:1; /* Transient enable state */ |
| 331 | |
| 332 | int statedump_pending:1; |
| 333 | |
| 334 | struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */ |
| 335 | struct cds_list_head enums_head; |
| 336 | struct lttng_ust_ctx *ctx; /* contexts for filters. */ |
| 337 | |
| 338 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
| 339 | bool uuid_set; /* Is uuid set ? */ |
| 340 | }; |
| 341 | |
| 342 | struct lttng_enum { |
| 343 | const struct lttng_ust_enum_desc *desc; |
| 344 | struct lttng_ust_session *session; |
| 345 | struct cds_list_head node; /* Enum list in session */ |
| 346 | struct cds_hlist_node hlist; /* Session ht of enums */ |
| 347 | uint64_t id; /* Enumeration ID in sessiond */ |
| 348 | }; |
| 349 | |
| 350 | struct lttng_ust_shm_handle; |
| 351 | |
| 352 | struct lttng_ust_channel_buffer_ops_private { |
| 353 | struct lttng_ust_channel_buffer_ops *pub; /* Public channel buffer ops interface */ |
| 354 | |
| 355 | struct lttng_ust_channel_buffer *(*channel_create)(const char *name, |
| 356 | void *buf_addr, |
| 357 | size_t subbuf_size, size_t num_subbuf, |
| 358 | unsigned int switch_timer_interval, |
| 359 | unsigned int read_timer_interval, |
| 360 | unsigned char *uuid, |
| 361 | uint32_t chan_id, |
| 362 | const int *stream_fds, int nr_stream_fds, |
| 363 | int64_t blocking_timeout); |
| 364 | void (*channel_destroy)(struct lttng_ust_channel_buffer *chan); |
| 365 | /* |
| 366 | * packet_avail_size returns the available size in the current |
| 367 | * packet. Note that the size returned is only a hint, since it |
| 368 | * may change due to concurrent writes. |
| 369 | */ |
| 370 | size_t (*packet_avail_size)(struct lttng_ust_channel_buffer *chan); |
| 371 | int (*is_finalized)(struct lttng_ust_channel_buffer *chan); |
| 372 | int (*is_disabled)(struct lttng_ust_channel_buffer *chan); |
| 373 | int (*flush_buffer)(struct lttng_ust_channel_buffer *chan); |
| 374 | }; |
| 375 | |
| 376 | struct lttng_ust_channel_common_private { |
| 377 | struct lttng_ust_channel_common *pub; /* Public channel interface */ |
| 378 | |
| 379 | int objd; /* Object associated with channel. */ |
| 380 | int tstate:1; /* Transient enable state */ |
| 381 | }; |
| 382 | |
| 383 | struct lttng_ust_channel_buffer_private { |
| 384 | struct lttng_ust_channel_common_private parent; |
| 385 | |
| 386 | struct lttng_ust_channel_buffer *pub; /* Public channel buffer interface */ |
| 387 | struct cds_list_head node; /* Channel list in session */ |
| 388 | int header_type; /* 0: unset, 1: compact, 2: large */ |
| 389 | unsigned int id; /* Channel ID */ |
| 390 | enum lttng_ust_abi_chan_type type; |
| 391 | struct lttng_ust_ctx *ctx; |
| 392 | struct lttng_ust_lib_ring_buffer_channel *rb_chan; /* Ring buffer channel */ |
| 393 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
| 394 | }; |
| 395 | |
| 396 | /* |
| 397 | * IMPORTANT: this structure is part of the ABI between the consumer |
| 398 | * daemon and the UST library within traced applications. Changing it |
| 399 | * breaks the UST communication protocol. |
| 400 | * |
| 401 | * TODO: remove unused fields on next UST communication protocol |
| 402 | * breaking update. |
| 403 | */ |
| 404 | struct lttng_ust_abi_channel_config { |
| 405 | void *unused1; |
| 406 | int unused2; |
| 407 | void *unused3; |
| 408 | void *unused4; |
| 409 | int unused5; |
| 410 | struct cds_list_head unused6; |
| 411 | void *unused7; |
| 412 | int unused8; |
| 413 | void *unused9; |
| 414 | |
| 415 | /* Channel ID */ |
| 416 | unsigned int id; |
| 417 | enum lttng_ust_abi_chan_type unused10; |
| 418 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
| 419 | int unused11:1; |
| 420 | }; |
| 421 | |
| 422 | /* Global (filter), event and channel contexts. */ |
| 423 | struct lttng_ust_ctx { |
| 424 | struct lttng_ust_ctx_field *fields; |
| 425 | unsigned int nr_fields; |
| 426 | unsigned int allocated_fields; |
| 427 | unsigned int largest_align; |
| 428 | }; |
| 429 | |
| 430 | struct lttng_ust_registered_probe { |
| 431 | const struct lttng_ust_probe_desc *desc; |
| 432 | |
| 433 | struct cds_list_head head; /* chain registered probes */ |
| 434 | struct cds_list_head lazy_init_head; |
| 435 | int lazy; /* lazy registration */ |
| 436 | }; |
| 437 | |
| 438 | /* |
| 439 | * Context field |
| 440 | */ |
| 441 | |
| 442 | struct lttng_ust_ctx_field { |
| 443 | const struct lttng_ust_event_field *event_field; |
| 444 | size_t (*get_size)(void *priv, size_t offset); |
| 445 | void (*record)(void *priv, struct lttng_ust_lib_ring_buffer_ctx *ctx, |
| 446 | struct lttng_ust_channel_buffer *chan); |
| 447 | void (*get_value)(void *priv, struct lttng_ust_ctx_value *value); |
| 448 | void (*destroy)(void *priv); |
| 449 | void *priv; |
| 450 | }; |
| 451 | |
| 452 | static inline |
| 453 | const struct lttng_ust_type_integer *lttng_ust_get_type_integer(const struct lttng_ust_type_common *type) |
| 454 | { |
| 455 | if (type->type != lttng_ust_type_integer) |
| 456 | return NULL; |
| 457 | return caa_container_of(type, const struct lttng_ust_type_integer, parent); |
| 458 | } |
| 459 | |
| 460 | static inline |
| 461 | const struct lttng_ust_type_float *lttng_ust_get_type_float(const struct lttng_ust_type_common *type) |
| 462 | { |
| 463 | if (type->type != lttng_ust_type_float) |
| 464 | return NULL; |
| 465 | return caa_container_of(type, const struct lttng_ust_type_float, parent); |
| 466 | } |
| 467 | |
| 468 | static inline |
| 469 | const struct lttng_ust_type_string *lttng_ust_get_type_string(const struct lttng_ust_type_common *type) |
| 470 | { |
| 471 | if (type->type != lttng_ust_type_string) |
| 472 | return NULL; |
| 473 | return caa_container_of(type, const struct lttng_ust_type_string, parent); |
| 474 | } |
| 475 | |
| 476 | static inline |
| 477 | const struct lttng_ust_type_enum *lttng_ust_get_type_enum(const struct lttng_ust_type_common *type) |
| 478 | { |
| 479 | if (type->type != lttng_ust_type_enum) |
| 480 | return NULL; |
| 481 | return caa_container_of(type, const struct lttng_ust_type_enum, parent); |
| 482 | } |
| 483 | |
| 484 | static inline |
| 485 | const struct lttng_ust_type_array *lttng_ust_get_type_array(const struct lttng_ust_type_common *type) |
| 486 | { |
| 487 | if (type->type != lttng_ust_type_array) |
| 488 | return NULL; |
| 489 | return caa_container_of(type, const struct lttng_ust_type_array, parent); |
| 490 | } |
| 491 | |
| 492 | static inline |
| 493 | const struct lttng_ust_type_sequence *lttng_ust_get_type_sequence(const struct lttng_ust_type_common *type) |
| 494 | { |
| 495 | if (type->type != lttng_ust_type_sequence) |
| 496 | return NULL; |
| 497 | return caa_container_of(type, const struct lttng_ust_type_sequence, parent); |
| 498 | } |
| 499 | |
| 500 | static inline |
| 501 | const struct lttng_ust_type_struct *lttng_ust_get_type_struct(const struct lttng_ust_type_common *type) |
| 502 | { |
| 503 | if (type->type != lttng_ust_type_struct) |
| 504 | return NULL; |
| 505 | return caa_container_of(type, const struct lttng_ust_type_struct, parent); |
| 506 | } |
| 507 | |
| 508 | #define lttng_ust_static_type_integer(_size, _alignment, _signedness, _byte_order, _base) \ |
| 509 | ((const struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_type_integer, { \ |
| 510 | .parent = { \ |
| 511 | .type = lttng_ust_type_integer, \ |
| 512 | }, \ |
| 513 | .struct_size = sizeof(struct lttng_ust_type_integer), \ |
| 514 | .size = (_size), \ |
| 515 | .alignment = (_alignment), \ |
| 516 | .signedness = (_signedness), \ |
| 517 | .reverse_byte_order = (_byte_order) != BYTE_ORDER, \ |
| 518 | .base = (_base), \ |
| 519 | })) |
| 520 | |
| 521 | #define lttng_ust_static_type_array_text(_length) \ |
| 522 | ((const struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_type_array, { \ |
| 523 | .parent = { \ |
| 524 | .type = lttng_ust_type_array, \ |
| 525 | }, \ |
| 526 | .struct_size = sizeof(struct lttng_ust_type_array), \ |
| 527 | .length = (_length), \ |
| 528 | .alignment = 0, \ |
| 529 | .encoding = lttng_ust_string_encoding_UTF8, \ |
| 530 | .elem_type = lttng_ust_static_type_integer(sizeof(char) * CHAR_BIT, \ |
| 531 | lttng_ust_rb_alignof(char) * CHAR_BIT, lttng_ust_is_signed_type(char), \ |
| 532 | BYTE_ORDER, 10), \ |
| 533 | })) |
| 534 | |
| 535 | #define lttng_ust_static_event_field(_name, _type, _nowrite, _nofilter) \ |
| 536 | __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_event_field, { \ |
| 537 | .struct_size = sizeof(struct lttng_ust_event_field), \ |
| 538 | .name = (_name), \ |
| 539 | .type = (_type), \ |
| 540 | .nowrite = (_nowrite), \ |
| 541 | .nofilter = (_nofilter), \ |
| 542 | }) |
| 543 | |
| 544 | #define lttng_ust_static_ctx_field(_event_field, _get_size, _record, _get_value, _destroy, _priv) \ |
| 545 | __LTTNG_COMPOUND_LITERAL(const struct lttng_ust_ctx_field, { \ |
| 546 | .event_field = (_event_field), \ |
| 547 | .get_size = (_get_size), \ |
| 548 | .record = (_record), \ |
| 549 | .get_value = (_get_value), \ |
| 550 | .destroy = (_destroy), \ |
| 551 | .priv = (_priv), \ |
| 552 | }) |
| 553 | |
| 554 | static inline |
| 555 | struct lttng_enabler *lttng_event_enabler_as_enabler( |
| 556 | struct lttng_event_enabler *event_enabler) |
| 557 | { |
| 558 | return &event_enabler->base; |
| 559 | } |
| 560 | |
| 561 | static inline |
| 562 | struct lttng_enabler *lttng_event_notifier_enabler_as_enabler( |
| 563 | struct lttng_event_notifier_enabler *event_notifier_enabler) |
| 564 | { |
| 565 | return &event_notifier_enabler->base; |
| 566 | } |
| 567 | |
| 568 | /* |
| 569 | * Allocate and initialize a `struct lttng_event_enabler` object. |
| 570 | * |
| 571 | * On success, returns a `struct lttng_event_enabler`, |
| 572 | * On memory error, returns NULL. |
| 573 | */ |
| 574 | struct lttng_event_enabler *lttng_event_enabler_create( |
| 575 | enum lttng_enabler_format_type format_type, |
| 576 | struct lttng_ust_abi_event *event_param, |
| 577 | struct lttng_ust_channel_buffer *chan) |
| 578 | __attribute__((visibility("hidden"))); |
| 579 | |
| 580 | /* |
| 581 | * Destroy a `struct lttng_event_enabler` object. |
| 582 | */ |
| 583 | void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler) |
| 584 | __attribute__((visibility("hidden"))); |
| 585 | |
| 586 | /* |
| 587 | * Enable a `struct lttng_event_enabler` object and all events related to this |
| 588 | * enabler. |
| 589 | */ |
| 590 | int lttng_event_enabler_enable(struct lttng_event_enabler *enabler) |
| 591 | __attribute__((visibility("hidden"))); |
| 592 | |
| 593 | /* |
| 594 | * Disable a `struct lttng_event_enabler` object and all events related to this |
| 595 | * enabler. |
| 596 | */ |
| 597 | int lttng_event_enabler_disable(struct lttng_event_enabler *enabler) |
| 598 | __attribute__((visibility("hidden"))); |
| 599 | |
| 600 | /* |
| 601 | * Attach filter bytecode program to `struct lttng_event_enabler` and all |
| 602 | * events related to this enabler. |
| 603 | */ |
| 604 | int lttng_event_enabler_attach_filter_bytecode( |
| 605 | struct lttng_event_enabler *enabler, |
| 606 | struct lttng_ust_bytecode_node **bytecode) |
| 607 | __attribute__((visibility("hidden"))); |
| 608 | |
| 609 | /* |
| 610 | * Attach an application context to an event enabler. |
| 611 | * |
| 612 | * Not implemented. |
| 613 | */ |
| 614 | int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler, |
| 615 | struct lttng_ust_abi_context *ctx) |
| 616 | __attribute__((visibility("hidden"))); |
| 617 | |
| 618 | /* |
| 619 | * Attach exclusion list to `struct lttng_event_enabler` and all |
| 620 | * events related to this enabler. |
| 621 | */ |
| 622 | int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler, |
| 623 | struct lttng_ust_excluder_node **excluder) |
| 624 | __attribute__((visibility("hidden"))); |
| 625 | |
| 626 | /* |
| 627 | * Synchronize bytecodes for the enabler and the instance (event or |
| 628 | * event_notifier). |
| 629 | * |
| 630 | * This function goes over all bytecode programs of the enabler (event or |
| 631 | * event_notifier enabler) to ensure each is linked to the provided instance. |
| 632 | */ |
| 633 | void lttng_enabler_link_bytecode(const struct lttng_ust_event_desc *event_desc, |
| 634 | struct lttng_ust_ctx **ctx, |
| 635 | struct cds_list_head *instance_bytecode_runtime_head, |
| 636 | struct cds_list_head *enabler_bytecode_runtime_head) |
| 637 | __attribute__((visibility("hidden"))); |
| 638 | |
| 639 | /* |
| 640 | * Allocate and initialize a `struct lttng_event_notifier_group` object. |
| 641 | * |
| 642 | * On success, returns a `struct lttng_triggre_group`, |
| 643 | * on memory error, returns NULL. |
| 644 | */ |
| 645 | struct lttng_event_notifier_group *lttng_event_notifier_group_create(void) |
| 646 | __attribute__((visibility("hidden"))); |
| 647 | |
| 648 | /* |
| 649 | * Destroy a `struct lttng_event_notifier_group` object. |
| 650 | */ |
| 651 | void lttng_event_notifier_group_destroy( |
| 652 | struct lttng_event_notifier_group *event_notifier_group) |
| 653 | __attribute__((visibility("hidden"))); |
| 654 | |
| 655 | /* |
| 656 | * Allocate and initialize a `struct lttng_event_notifier_enabler` object. |
| 657 | * |
| 658 | * On success, returns a `struct lttng_event_notifier_enabler`, |
| 659 | * On memory error, returns NULL. |
| 660 | */ |
| 661 | struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create( |
| 662 | struct lttng_event_notifier_group *event_notifier_group, |
| 663 | enum lttng_enabler_format_type format_type, |
| 664 | struct lttng_ust_abi_event_notifier *event_notifier_param) |
| 665 | __attribute__((visibility("hidden"))); |
| 666 | |
| 667 | /* |
| 668 | * Destroy a `struct lttng_event_notifier_enabler` object. |
| 669 | */ |
| 670 | void lttng_event_notifier_enabler_destroy( |
| 671 | struct lttng_event_notifier_enabler *event_notifier_enabler) |
| 672 | __attribute__((visibility("hidden"))); |
| 673 | |
| 674 | /* |
| 675 | * Enable a `struct lttng_event_notifier_enabler` object and all event |
| 676 | * notifiers related to this enabler. |
| 677 | */ |
| 678 | int lttng_event_notifier_enabler_enable( |
| 679 | struct lttng_event_notifier_enabler *event_notifier_enabler) |
| 680 | __attribute__((visibility("hidden"))); |
| 681 | |
| 682 | /* |
| 683 | * Disable a `struct lttng_event_notifier_enabler` object and all event |
| 684 | * notifiers related to this enabler. |
| 685 | */ |
| 686 | int lttng_event_notifier_enabler_disable( |
| 687 | struct lttng_event_notifier_enabler *event_notifier_enabler) |
| 688 | __attribute__((visibility("hidden"))); |
| 689 | |
| 690 | /* |
| 691 | * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and |
| 692 | * all event notifiers related to this enabler. |
| 693 | */ |
| 694 | int lttng_event_notifier_enabler_attach_filter_bytecode( |
| 695 | struct lttng_event_notifier_enabler *event_notifier_enabler, |
| 696 | struct lttng_ust_bytecode_node **bytecode) |
| 697 | __attribute__((visibility("hidden"))); |
| 698 | |
| 699 | /* |
| 700 | * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and |
| 701 | * all event_notifiers related to this enabler. |
| 702 | */ |
| 703 | int lttng_event_notifier_enabler_attach_capture_bytecode( |
| 704 | struct lttng_event_notifier_enabler *event_notifier_enabler, |
| 705 | struct lttng_ust_bytecode_node **bytecode) |
| 706 | __attribute__((visibility("hidden"))); |
| 707 | |
| 708 | /* |
| 709 | * Attach exclusion list to `struct lttng_event_notifier_enabler` and all |
| 710 | * event notifiers related to this enabler. |
| 711 | */ |
| 712 | int lttng_event_notifier_enabler_attach_exclusion( |
| 713 | struct lttng_event_notifier_enabler *event_notifier_enabler, |
| 714 | struct lttng_ust_excluder_node **excluder) |
| 715 | __attribute__((visibility("hidden"))); |
| 716 | |
| 717 | void lttng_free_event_filter_runtime(struct lttng_ust_event_common *event) |
| 718 | __attribute__((visibility("hidden"))); |
| 719 | |
| 720 | /* |
| 721 | * Connect the probe on all enablers matching this event description. |
| 722 | * Called on library load. |
| 723 | */ |
| 724 | int lttng_fix_pending_event_notifiers(void) |
| 725 | __attribute__((visibility("hidden"))); |
| 726 | |
| 727 | struct lttng_counter *lttng_ust_counter_create( |
| 728 | const char *counter_transport_name, |
| 729 | size_t number_dimensions, const struct lttng_counter_dimension *dimensions) |
| 730 | __attribute__((visibility("hidden"))); |
| 731 | |
| 732 | #ifdef HAVE_LINUX_PERF_EVENT_H |
| 733 | |
| 734 | int lttng_add_perf_counter_to_ctx(uint32_t type, |
| 735 | uint64_t config, |
| 736 | const char *name, |
| 737 | struct lttng_ust_ctx **ctx) |
| 738 | __attribute__((visibility("hidden"))); |
| 739 | |
| 740 | int lttng_perf_counter_init(void) |
| 741 | __attribute__((visibility("hidden"))); |
| 742 | |
| 743 | void lttng_perf_counter_exit(void) |
| 744 | __attribute__((visibility("hidden"))); |
| 745 | |
| 746 | #else /* #ifdef HAVE_LINUX_PERF_EVENT_H */ |
| 747 | |
| 748 | static inline |
| 749 | int lttng_add_perf_counter_to_ctx(uint32_t type, |
| 750 | uint64_t config, |
| 751 | const char *name, |
| 752 | struct lttng_ust_ctx **ctx) |
| 753 | { |
| 754 | return -ENOSYS; |
| 755 | } |
| 756 | static inline |
| 757 | int lttng_perf_counter_init(void) |
| 758 | { |
| 759 | return 0; |
| 760 | } |
| 761 | static inline |
| 762 | void lttng_perf_counter_exit(void) |
| 763 | { |
| 764 | } |
| 765 | #endif /* #else #ifdef HAVE_LINUX_PERF_EVENT_H */ |
| 766 | |
| 767 | int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list) |
| 768 | __attribute__((visibility("hidden"))); |
| 769 | |
| 770 | void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list) |
| 771 | __attribute__((visibility("hidden"))); |
| 772 | |
| 773 | int lttng_probes_get_field_list(struct lttng_ust_field_list *list) |
| 774 | __attribute__((visibility("hidden"))); |
| 775 | |
| 776 | void lttng_probes_prune_field_list(struct lttng_ust_field_list *list) |
| 777 | __attribute__((visibility("hidden"))); |
| 778 | |
| 779 | struct lttng_ust_abi_tracepoint_iter * |
| 780 | lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list) |
| 781 | __attribute__((visibility("hidden"))); |
| 782 | |
| 783 | struct lttng_ust_abi_field_iter * |
| 784 | lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list) |
| 785 | __attribute__((visibility("hidden"))); |
| 786 | |
| 787 | struct lttng_ust_session *lttng_session_create(void) |
| 788 | __attribute__((visibility("hidden"))); |
| 789 | |
| 790 | int lttng_session_enable(struct lttng_ust_session *session) |
| 791 | __attribute__((visibility("hidden"))); |
| 792 | |
| 793 | int lttng_session_disable(struct lttng_ust_session *session) |
| 794 | __attribute__((visibility("hidden"))); |
| 795 | |
| 796 | int lttng_session_statedump(struct lttng_ust_session *session) |
| 797 | __attribute__((visibility("hidden"))); |
| 798 | |
| 799 | void lttng_session_destroy(struct lttng_ust_session *session) |
| 800 | __attribute__((visibility("hidden"))); |
| 801 | |
| 802 | /* |
| 803 | * Called with ust lock held. |
| 804 | */ |
| 805 | int lttng_session_active(void) |
| 806 | __attribute__((visibility("hidden"))); |
| 807 | |
| 808 | struct cds_list_head *lttng_get_sessions(void) |
| 809 | __attribute__((visibility("hidden"))); |
| 810 | |
| 811 | void lttng_handle_pending_statedump(void *owner) |
| 812 | __attribute__((visibility("hidden"))); |
| 813 | |
| 814 | int lttng_channel_enable(struct lttng_ust_channel_common *lttng_channel) |
| 815 | __attribute__((visibility("hidden"))); |
| 816 | |
| 817 | int lttng_channel_disable(struct lttng_ust_channel_common *lttng_channel) |
| 818 | __attribute__((visibility("hidden"))); |
| 819 | |
| 820 | void lttng_transport_register(struct lttng_transport *transport) |
| 821 | __attribute__((visibility("hidden"))); |
| 822 | |
| 823 | void lttng_transport_unregister(struct lttng_transport *transport) |
| 824 | __attribute__((visibility("hidden"))); |
| 825 | |
| 826 | /* This is ABI between liblttng-ust and liblttng-ust-ctl */ |
| 827 | struct lttng_transport *lttng_ust_transport_find(const char *name); |
| 828 | |
| 829 | /* This is ABI between liblttng-ust and liblttng-ust-dl */ |
| 830 | void lttng_ust_dl_update(void *ip); |
| 831 | |
| 832 | void lttng_probe_provider_unregister_events(const struct lttng_ust_probe_desc *desc) |
| 833 | __attribute__((visibility("hidden"))); |
| 834 | |
| 835 | int lttng_fix_pending_events(void) |
| 836 | __attribute__((visibility("hidden"))); |
| 837 | |
| 838 | struct cds_list_head *lttng_get_probe_list_head(void) |
| 839 | __attribute__((visibility("hidden"))); |
| 840 | |
| 841 | struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_ust_session *session, |
| 842 | const struct lttng_ust_enum_desc *enum_desc) |
| 843 | __attribute__((visibility("hidden"))); |
| 844 | |
| 845 | int lttng_abi_create_root_handle(void) |
| 846 | __attribute__((visibility("hidden"))); |
| 847 | |
| 848 | const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id) |
| 849 | __attribute__((visibility("hidden"))); |
| 850 | |
| 851 | int lttng_ust_abi_objd_unref(int id, int is_owner) |
| 852 | __attribute__((visibility("hidden"))); |
| 853 | |
| 854 | void lttng_ust_abi_exit(void) |
| 855 | __attribute__((visibility("hidden"))); |
| 856 | |
| 857 | void lttng_ust_abi_events_exit(void) |
| 858 | __attribute__((visibility("hidden"))); |
| 859 | |
| 860 | void lttng_ust_abi_objd_table_owner_cleanup(void *owner) |
| 861 | __attribute__((visibility("hidden"))); |
| 862 | |
| 863 | struct lttng_ust_channel_buffer *lttng_ust_alloc_channel_buffer(void) |
| 864 | __attribute__((visibility("hidden"))); |
| 865 | |
| 866 | void lttng_ust_free_channel_common(struct lttng_ust_channel_common *chan) |
| 867 | __attribute__((visibility("hidden"))); |
| 868 | |
| 869 | int lttng_ust_interpret_event_filter(struct lttng_ust_event_common *event, |
| 870 | const char *interpreter_stack_data, |
| 871 | void *filter_ctx) |
| 872 | __attribute__((visibility("hidden"))); |
| 873 | |
| 874 | int lttng_ust_session_uuid_validate(struct lttng_ust_session *session, |
| 875 | unsigned char *uuid) |
| 876 | __attribute__((visibility("hidden"))); |
| 877 | |
| 878 | bool lttng_ust_validate_event_name(const struct lttng_ust_event_desc *desc) |
| 879 | __attribute__((visibility("hidden"))); |
| 880 | |
| 881 | void lttng_ust_format_event_name(const struct lttng_ust_event_desc *desc, |
| 882 | char *name) |
| 883 | __attribute__((visibility("hidden"))); |
| 884 | |
| 885 | int lttng_ust_add_app_context_to_ctx_rcu(const char *name, struct lttng_ust_ctx **ctx) |
| 886 | __attribute__((visibility("hidden"))); |
| 887 | |
| 888 | int lttng_ust_context_set_provider_rcu(struct lttng_ust_ctx **_ctx, |
| 889 | const char *name, |
| 890 | size_t (*get_size)(void *priv, size_t offset), |
| 891 | void (*record)(void *priv, struct lttng_ust_lib_ring_buffer_ctx *ctx, |
| 892 | struct lttng_ust_channel_buffer *chan), |
| 893 | void (*get_value)(void *priv, struct lttng_ust_ctx_value *value), |
| 894 | void *priv) |
| 895 | __attribute__((visibility("hidden"))); |
| 896 | |
| 897 | void lttng_ust_context_set_session_provider(const char *name, |
| 898 | size_t (*get_size)(void *priv, size_t offset), |
| 899 | void (*record)(void *priv, struct lttng_ust_lib_ring_buffer_ctx *ctx, |
| 900 | struct lttng_ust_channel_buffer *chan), |
| 901 | void (*get_value)(void *priv, struct lttng_ust_ctx_value *value), |
| 902 | void *priv) |
| 903 | __attribute__((visibility("hidden"))); |
| 904 | |
| 905 | #endif /* _LTTNG_UST_EVENTS_INTERNAL_H */ |