| 1 | /* |
| 2 | * Copyright (C) 2014 - David Goulet <dgoulet@efficios.com> |
| 3 | * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 4 | * |
| 5 | * This library is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU Lesser General Public License, version 2.1 only, |
| 7 | * as published by the Free Software Foundation. |
| 8 | * |
| 9 | * This library is distributed in the hope that it will be useful, but WITHOUT |
| 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License |
| 12 | * for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU Lesser General Public License |
| 15 | * along with this library; if not, write to the Free Software Foundation, |
| 16 | * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 17 | */ |
| 18 | |
| 19 | #ifndef LTTNG_EVENT_H |
| 20 | #define LTTNG_EVENT_H |
| 21 | |
| 22 | #ifdef __cplusplus |
| 23 | extern "C" { |
| 24 | #endif |
| 25 | |
| 26 | #include <lttng/handle.h> |
| 27 | |
| 28 | /* |
| 29 | * Instrumentation type of tracing event. |
| 30 | */ |
| 31 | enum lttng_event_type { |
| 32 | LTTNG_EVENT_ALL = -1, |
| 33 | LTTNG_EVENT_TRACEPOINT = 0, |
| 34 | LTTNG_EVENT_PROBE = 1, |
| 35 | LTTNG_EVENT_FUNCTION = 2, |
| 36 | LTTNG_EVENT_FUNCTION_ENTRY = 3, |
| 37 | LTTNG_EVENT_NOOP = 4, |
| 38 | LTTNG_EVENT_SYSCALL = 5, |
| 39 | }; |
| 40 | |
| 41 | /* |
| 42 | * Loglevel information. |
| 43 | */ |
| 44 | enum lttng_loglevel_type { |
| 45 | LTTNG_EVENT_LOGLEVEL_ALL = 0, |
| 46 | LTTNG_EVENT_LOGLEVEL_RANGE = 1, |
| 47 | LTTNG_EVENT_LOGLEVEL_SINGLE = 2, |
| 48 | }; |
| 49 | |
| 50 | /* |
| 51 | * Available loglevels. |
| 52 | */ |
| 53 | enum lttng_loglevel { |
| 54 | LTTNG_LOGLEVEL_EMERG = 0, |
| 55 | LTTNG_LOGLEVEL_ALERT = 1, |
| 56 | LTTNG_LOGLEVEL_CRIT = 2, |
| 57 | LTTNG_LOGLEVEL_ERR = 3, |
| 58 | LTTNG_LOGLEVEL_WARNING = 4, |
| 59 | LTTNG_LOGLEVEL_NOTICE = 5, |
| 60 | LTTNG_LOGLEVEL_INFO = 6, |
| 61 | LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7, |
| 62 | LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8, |
| 63 | LTTNG_LOGLEVEL_DEBUG_PROCESS = 9, |
| 64 | LTTNG_LOGLEVEL_DEBUG_MODULE = 10, |
| 65 | LTTNG_LOGLEVEL_DEBUG_UNIT = 11, |
| 66 | LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12, |
| 67 | LTTNG_LOGLEVEL_DEBUG_LINE = 13, |
| 68 | LTTNG_LOGLEVEL_DEBUG = 14, |
| 69 | }; |
| 70 | |
| 71 | /* |
| 72 | * Available loglevels for the JUL domain. Those are an exact map from the |
| 73 | * class java.util.logging.Level. |
| 74 | */ |
| 75 | enum lttng_loglevel_jul { |
| 76 | LTTNG_LOGLEVEL_JUL_OFF = INT32_MAX, |
| 77 | LTTNG_LOGLEVEL_JUL_SEVERE = 1000, |
| 78 | LTTNG_LOGLEVEL_JUL_WARNING = 900, |
| 79 | LTTNG_LOGLEVEL_JUL_INFO = 800, |
| 80 | LTTNG_LOGLEVEL_JUL_CONFIG = 700, |
| 81 | LTTNG_LOGLEVEL_JUL_FINE = 500, |
| 82 | LTTNG_LOGLEVEL_JUL_FINER = 400, |
| 83 | LTTNG_LOGLEVEL_JUL_FINEST = 300, |
| 84 | LTTNG_LOGLEVEL_JUL_ALL = INT32_MIN, |
| 85 | }; |
| 86 | |
| 87 | /* |
| 88 | * Available loglevels for the LOG4j domain. Those are an exact map from the |
| 89 | * class org.apache.log4j.Level. |
| 90 | */ |
| 91 | enum lttng_loglevel_log4j { |
| 92 | LTTNG_LOGLEVEL_LOG4J_OFF = INT32_MAX, |
| 93 | LTTNG_LOGLEVEL_LOG4J_FATAL = 50000, |
| 94 | LTTNG_LOGLEVEL_LOG4J_ERROR = 40000, |
| 95 | LTTNG_LOGLEVEL_LOG4J_WARN = 30000, |
| 96 | LTTNG_LOGLEVEL_LOG4J_INFO = 20000, |
| 97 | LTTNG_LOGLEVEL_LOG4J_DEBUG = 10000, |
| 98 | LTTNG_LOGLEVEL_LOG4J_TRACE = 5000, |
| 99 | LTTNG_LOGLEVEL_LOG4J_ALL = INT32_MIN, |
| 100 | }; |
| 101 | |
| 102 | /* |
| 103 | * Available loglevels for the Python domain. Those are an exact map from the |
| 104 | * Level class. |
| 105 | */ |
| 106 | enum lttng_loglevel_python { |
| 107 | LTTNG_LOGLEVEL_PYTHON_CRITICAL = 50, |
| 108 | LTTNG_LOGLEVEL_PYTHON_ERROR = 40, |
| 109 | LTTNG_LOGLEVEL_PYTHON_WARNING = 30, |
| 110 | LTTNG_LOGLEVEL_PYTHON_INFO = 20, |
| 111 | LTTNG_LOGLEVEL_PYTHON_DEBUG = 10, |
| 112 | LTTNG_LOGLEVEL_PYTHON_NOTSET = 0, |
| 113 | }; |
| 114 | |
| 115 | /* |
| 116 | * LTTng consumer mode |
| 117 | */ |
| 118 | enum lttng_event_output { |
| 119 | LTTNG_EVENT_SPLICE = 0, |
| 120 | LTTNG_EVENT_MMAP = 1, |
| 121 | }; |
| 122 | |
| 123 | /* Event context possible type */ |
| 124 | enum lttng_event_context_type { |
| 125 | LTTNG_EVENT_CONTEXT_PID = 0, |
| 126 | LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, /* Backward compat. */ |
| 127 | LTTNG_EVENT_CONTEXT_PROCNAME = 2, |
| 128 | LTTNG_EVENT_CONTEXT_PRIO = 3, |
| 129 | LTTNG_EVENT_CONTEXT_NICE = 4, |
| 130 | LTTNG_EVENT_CONTEXT_VPID = 5, |
| 131 | LTTNG_EVENT_CONTEXT_TID = 6, |
| 132 | LTTNG_EVENT_CONTEXT_VTID = 7, |
| 133 | LTTNG_EVENT_CONTEXT_PPID = 8, |
| 134 | LTTNG_EVENT_CONTEXT_VPPID = 9, |
| 135 | LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10, |
| 136 | LTTNG_EVENT_CONTEXT_HOSTNAME = 11, |
| 137 | LTTNG_EVENT_CONTEXT_IP = 12, |
| 138 | LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER = 13, |
| 139 | LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14, |
| 140 | LTTNG_EVENT_CONTEXT_APP_CONTEXT = 15, |
| 141 | LTTNG_EVENT_CONTEXT_INTERRUPTIBLE = 16, |
| 142 | LTTNG_EVENT_CONTEXT_PREEMPTIBLE = 17, |
| 143 | LTTNG_EVENT_CONTEXT_NEED_RESCHEDULE = 18, |
| 144 | LTTNG_EVENT_CONTEXT_MIGRATABLE = 19, |
| 145 | }; |
| 146 | |
| 147 | enum lttng_event_field_type { |
| 148 | LTTNG_EVENT_FIELD_OTHER = 0, |
| 149 | LTTNG_EVENT_FIELD_INTEGER = 1, |
| 150 | LTTNG_EVENT_FIELD_ENUM = 2, |
| 151 | LTTNG_EVENT_FIELD_FLOAT = 3, |
| 152 | LTTNG_EVENT_FIELD_STRING = 4, |
| 153 | }; |
| 154 | |
| 155 | enum lttng_event_flag { |
| 156 | LTTNG_EVENT_FLAG_SYSCALL_32 = (1U << 0), |
| 157 | LTTNG_EVENT_FLAG_SYSCALL_64 = (1U << 1), |
| 158 | }; |
| 159 | |
| 160 | /* |
| 161 | * Perf counter attributes |
| 162 | * |
| 163 | * The structures should be initialized to zero before use. |
| 164 | */ |
| 165 | #define LTTNG_PERF_EVENT_PADDING1 16 |
| 166 | struct lttng_event_perf_counter_ctx { |
| 167 | uint32_t type; |
| 168 | uint64_t config; |
| 169 | char name[LTTNG_SYMBOL_NAME_LEN]; |
| 170 | |
| 171 | char padding[LTTNG_PERF_EVENT_PADDING1]; |
| 172 | }; |
| 173 | |
| 174 | /* |
| 175 | * Event/channel context |
| 176 | * |
| 177 | * The structures should be initialized to zero before use. |
| 178 | */ |
| 179 | #define LTTNG_EVENT_CONTEXT_PADDING1 16 |
| 180 | #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
| 181 | struct lttng_event_context { |
| 182 | enum lttng_event_context_type ctx; |
| 183 | char padding[LTTNG_EVENT_CONTEXT_PADDING1]; |
| 184 | |
| 185 | union { |
| 186 | struct lttng_event_perf_counter_ctx perf_counter; |
| 187 | struct { |
| 188 | char *provider_name; |
| 189 | char *ctx_name; |
| 190 | } app_ctx; |
| 191 | char padding[LTTNG_EVENT_CONTEXT_PADDING2]; |
| 192 | } u; |
| 193 | }; |
| 194 | |
| 195 | /* |
| 196 | * Event probe. |
| 197 | * |
| 198 | * Either addr is used or symbol_name and offset. |
| 199 | * |
| 200 | * The structures should be initialized to zero before use. |
| 201 | */ |
| 202 | #define LTTNG_EVENT_PROBE_PADDING1 16 |
| 203 | struct lttng_event_probe_attr { |
| 204 | uint64_t addr; |
| 205 | |
| 206 | uint64_t offset; |
| 207 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; |
| 208 | |
| 209 | char padding[LTTNG_EVENT_PROBE_PADDING1]; |
| 210 | }; |
| 211 | |
| 212 | /* |
| 213 | * Function tracer |
| 214 | * |
| 215 | * The structures should be initialized to zero before use. |
| 216 | */ |
| 217 | #define LTTNG_EVENT_FUNCTION_PADDING1 16 |
| 218 | struct lttng_event_function_attr { |
| 219 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; |
| 220 | |
| 221 | char padding[LTTNG_EVENT_FUNCTION_PADDING1]; |
| 222 | }; |
| 223 | |
| 224 | /* |
| 225 | * Generic lttng event |
| 226 | * |
| 227 | * The structures should be initialized to zero before use. |
| 228 | */ |
| 229 | #define LTTNG_EVENT_PADDING1 12 |
| 230 | #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
| 231 | struct lttng_event { |
| 232 | /* Offset 0 */ |
| 233 | enum lttng_event_type type; |
| 234 | |
| 235 | /* Offset 4 */ |
| 236 | char name[LTTNG_SYMBOL_NAME_LEN]; |
| 237 | |
| 238 | /* Offset 260 */ |
| 239 | enum lttng_loglevel_type loglevel_type; |
| 240 | |
| 241 | /* Offset 264 */ |
| 242 | int loglevel; |
| 243 | |
| 244 | /* Offset 268 */ |
| 245 | int32_t enabled; /* Does not apply: -1 */ |
| 246 | |
| 247 | /* Offset 272 */ |
| 248 | pid_t pid; |
| 249 | |
| 250 | /* Offset 276 */ |
| 251 | unsigned char filter; /* filter enabled ? */ |
| 252 | |
| 253 | /* Offset 277 */ |
| 254 | unsigned char exclusion; /* exclusions added ? */ |
| 255 | |
| 256 | /* Offset 278 */ |
| 257 | char padding2[2]; |
| 258 | |
| 259 | /* Offset 280 */ |
| 260 | /* Event flag, from 2.6 and above. */ |
| 261 | enum lttng_event_flag flags; |
| 262 | |
| 263 | /* Offset 284 */ |
| 264 | char padding[4]; |
| 265 | |
| 266 | /* Offset 288 */ |
| 267 | union { |
| 268 | uint64_t padding; |
| 269 | void *ptr; |
| 270 | } extended; |
| 271 | |
| 272 | /* Offset 296 */ |
| 273 | /* Per event type configuration */ |
| 274 | union { |
| 275 | struct lttng_event_probe_attr probe; |
| 276 | struct lttng_event_function_attr ftrace; |
| 277 | |
| 278 | char padding[LTTNG_EVENT_PADDING2]; |
| 279 | } attr; |
| 280 | }; |
| 281 | |
| 282 | #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32 |
| 283 | struct lttng_event_field { |
| 284 | char field_name[LTTNG_SYMBOL_NAME_LEN]; |
| 285 | enum lttng_event_field_type type; |
| 286 | char padding[LTTNG_EVENT_FIELD_PADDING]; |
| 287 | struct lttng_event event; |
| 288 | int nowrite; |
| 289 | }; |
| 290 | |
| 291 | /* |
| 292 | * List the event(s) of a session channel. |
| 293 | * |
| 294 | * Both handle and channel_name CAN NOT be NULL. |
| 295 | * |
| 296 | * Return the size (number of entries) of the "lttng_event" array. Caller must |
| 297 | * free events. On error a negative LTTng error code is returned. |
| 298 | */ |
| 299 | extern int lttng_list_events(struct lttng_handle *handle, |
| 300 | const char *channel_name, struct lttng_event **events); |
| 301 | |
| 302 | /* |
| 303 | * Get the filter expression of a specific LTTng event. |
| 304 | * |
| 305 | * If the call is successful, then the filter expression's address is put |
| 306 | * in *filter_expression. If the event has no filter expression, |
| 307 | * *filter_expression is set to NULL. The caller does NOT own |
| 308 | * *filter_expression. |
| 309 | * |
| 310 | * Returns 0 on success, or a negative LTTng error code on error. |
| 311 | */ |
| 312 | extern int lttng_event_get_filter_expression(struct lttng_event *event, |
| 313 | const char **filter_string); |
| 314 | |
| 315 | /* |
| 316 | * Get the number of exclusion names of a specific LTTng event. |
| 317 | * |
| 318 | * Returns the number of exclusion names on success, or a negative |
| 319 | * LTTng error code on error. |
| 320 | */ |
| 321 | extern int lttng_event_get_exclusion_name_count(struct lttng_event *event); |
| 322 | |
| 323 | /* |
| 324 | * Get an LTTng event's exclusion name at a given index. |
| 325 | * |
| 326 | * If the call is successful, then the exclusion name string's address |
| 327 | * is put in *exclusion_name. The caller does NOT own *exclusion_name. |
| 328 | * |
| 329 | * Returns 0 on success, or a negative LTTng error code on error. |
| 330 | */ |
| 331 | extern int lttng_event_get_exclusion_name(struct lttng_event *event, |
| 332 | size_t index, const char **exclusion_name); |
| 333 | |
| 334 | /* |
| 335 | * List the available tracepoints of a specific lttng domain. |
| 336 | * |
| 337 | * The handle CAN NOT be NULL. |
| 338 | * |
| 339 | * Return the size (number of entries) of the "lttng_event" array. Caller must |
| 340 | * free events. On error a negative LTTng error code is returned. |
| 341 | */ |
| 342 | extern int lttng_list_tracepoints(struct lttng_handle *handle, |
| 343 | struct lttng_event **events); |
| 344 | |
| 345 | /* |
| 346 | * List the available tracepoints fields of a specific lttng domain. |
| 347 | * |
| 348 | * The handle CAN NOT be NULL. |
| 349 | * |
| 350 | * Return the size (number of entries) of the "lttng_event_field" array. |
| 351 | * Caller must free fields. On error a negative LTTng error code is |
| 352 | * returned. |
| 353 | */ |
| 354 | extern int lttng_list_tracepoint_fields(struct lttng_handle *handle, |
| 355 | struct lttng_event_field **fields); |
| 356 | |
| 357 | /* |
| 358 | * List the available kernel syscall. |
| 359 | * |
| 360 | * Return the size (number of entries) of the allocated "lttng_event" array. |
| 361 | * All events in will be of type syscall. Caller must free events. On error a |
| 362 | * negative LTTng error code is returned. |
| 363 | */ |
| 364 | extern int lttng_list_syscalls(struct lttng_event **events); |
| 365 | |
| 366 | /* |
| 367 | * Add context to event(s) for a specific channel (or for all). |
| 368 | * |
| 369 | * If the channel_name is NULL and they are no channel for the domain, the |
| 370 | * default channel is created (channel0). The context is then added on ALL |
| 371 | * channels since no name was specified. |
| 372 | * |
| 373 | * The event_name is ignored since adding a context to an event is not possible |
| 374 | * for now. |
| 375 | * |
| 376 | * Return 0 on success else a negative LTTng error code. |
| 377 | */ |
| 378 | extern int lttng_add_context(struct lttng_handle *handle, |
| 379 | struct lttng_event_context *ctx, const char *event_name, |
| 380 | const char *channel_name); |
| 381 | |
| 382 | /* |
| 383 | * Create or enable an event (or events) for a channel. |
| 384 | * |
| 385 | * If the event you are trying to enable does not exist, it will be created, |
| 386 | * else it is enabled. If channel_name is NULL, the default channel is used |
| 387 | * (channel0). |
| 388 | * |
| 389 | * The handle and ev params can not be NULL. |
| 390 | * |
| 391 | * Return 0 on success else a negative LTTng error code. |
| 392 | */ |
| 393 | extern int lttng_enable_event(struct lttng_handle *handle, |
| 394 | struct lttng_event *ev, const char *channel_name); |
| 395 | |
| 396 | /* |
| 397 | * Create or enable an event with a specific filter. |
| 398 | * |
| 399 | * If the event you are trying to enable does not exist, it will be created, |
| 400 | * else it is enabled. |
| 401 | * If ev is NULL, all events are enabled with that filter. |
| 402 | * If channel_name is NULL, the default channel is used (channel0) and created |
| 403 | * if not found. |
| 404 | * If filter_expression is NULL, an event without associated filter is |
| 405 | * created. |
| 406 | * |
| 407 | * Return 0 on success else a negative LTTng error code. |
| 408 | */ |
| 409 | extern int lttng_enable_event_with_filter(struct lttng_handle *handle, |
| 410 | struct lttng_event *event, const char *channel_name, |
| 411 | const char *filter_expression); |
| 412 | |
| 413 | /* |
| 414 | * Create or enable an event with a filter and/or exclusions. |
| 415 | * |
| 416 | * If the event you are trying to enable does not exist, it will be created, |
| 417 | * else it is enabled. |
| 418 | * If ev is NULL, all events are enabled with the filter and exclusion options. |
| 419 | * If channel_name is NULL, the default channel is used (channel0) and created |
| 420 | * if not found. |
| 421 | * If filter_expression is NULL, an event without associated filter is |
| 422 | * created. |
| 423 | * If exclusion count is zero, the event will be created without exclusions. |
| 424 | * |
| 425 | * Return 0 on success else a negative LTTng error code. |
| 426 | */ |
| 427 | extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle, |
| 428 | struct lttng_event *event, const char *channel_name, |
| 429 | const char *filter_expression, |
| 430 | int exclusion_count, char **exclusion_names); |
| 431 | |
| 432 | /* |
| 433 | * Disable event(s) of a channel and domain. |
| 434 | * |
| 435 | * If name is NULL, all events are disabled. |
| 436 | * If channel_name is NULL, the default channel is used (channel0). |
| 437 | * |
| 438 | * Return 0 on success else a negative LTTng error code. |
| 439 | */ |
| 440 | extern int lttng_disable_event(struct lttng_handle *handle, |
| 441 | const char *name, const char *channel_name); |
| 442 | |
| 443 | /* |
| 444 | * Disable event(s) of a channel and domain. |
| 445 | * |
| 446 | * Takes a struct lttng_event as parameter. |
| 447 | * If channel_name is NULL, the default channel is used (channel0). |
| 448 | * |
| 449 | * Currently, @filter_expression must be NULL. (disabling specific |
| 450 | * filter expressions not implemented) |
| 451 | * Currently, only LTTNG_EVENT_ALL and LTTNG_EVENT_SYSCALL event types |
| 452 | * are implemented for field @ev. |
| 453 | * |
| 454 | * Return 0 on success else a negative LTTng error code. |
| 455 | */ |
| 456 | int lttng_disable_event_ext(struct lttng_handle *handle, |
| 457 | struct lttng_event *ev, const char *channel_name, |
| 458 | const char *filter_expression); |
| 459 | |
| 460 | #ifdef __cplusplus |
| 461 | } |
| 462 | #endif |
| 463 | |
| 464 | #endif /* LTTNG_EVENT_H */ |