2 * Copyright (C) 2014 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
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.
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
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
26 #include <lttng/handle.h>
29 * Instrumentation type of tracing event.
31 enum lttng_event_type
{
33 LTTNG_EVENT_TRACEPOINT
= 0,
34 LTTNG_EVENT_PROBE
= 1,
35 LTTNG_EVENT_FUNCTION
= 2,
36 LTTNG_EVENT_FUNCTION_ENTRY
= 3,
38 LTTNG_EVENT_SYSCALL
= 5,
42 * Loglevel information.
44 enum lttng_loglevel_type
{
45 LTTNG_EVENT_LOGLEVEL_ALL
= 0,
46 LTTNG_EVENT_LOGLEVEL_RANGE
= 1,
47 LTTNG_EVENT_LOGLEVEL_SINGLE
= 2,
51 * Available loglevels.
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,
72 * Available loglevels for the JUL domain. Those are an exact map from the
73 * class java.util.logging.Level.
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
,
88 * Available loglevels for the LOG4j domain. Those are an exact map from the
89 * class org.apache.log4j.Level.
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
,
103 * Available loglevels for the Python domain. Those are an exact map from the
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,
116 * LTTng consumer mode
118 enum lttng_event_output
{
119 LTTNG_EVENT_SPLICE
= 0,
120 LTTNG_EVENT_MMAP
= 1,
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 LTTNG_EVENT_CONTEXT_CALLSTACK_KERNEL
= 20,
146 LTTNG_EVENT_CONTEXT_CALLSTACK_USER
= 21, /* Supported on x86_32 and x86_64 only. */
149 enum lttng_event_field_type
{
150 LTTNG_EVENT_FIELD_OTHER
= 0,
151 LTTNG_EVENT_FIELD_INTEGER
= 1,
152 LTTNG_EVENT_FIELD_ENUM
= 2,
153 LTTNG_EVENT_FIELD_FLOAT
= 3,
154 LTTNG_EVENT_FIELD_STRING
= 4,
157 enum lttng_event_flag
{
158 LTTNG_EVENT_FLAG_SYSCALL_32
= (1U << 0),
159 LTTNG_EVENT_FLAG_SYSCALL_64
= (1U << 1),
163 * Perf counter attributes
165 * The structures should be initialized to zero before use.
167 #define LTTNG_PERF_EVENT_PADDING1 16
168 struct lttng_event_perf_counter_ctx
{
171 char name
[LTTNG_SYMBOL_NAME_LEN
];
173 char padding
[LTTNG_PERF_EVENT_PADDING1
];
177 * Event/channel context
179 * The structures should be initialized to zero before use.
181 #define LTTNG_EVENT_CONTEXT_PADDING1 16
182 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
183 struct lttng_event_context
{
184 enum lttng_event_context_type ctx
;
185 char padding
[LTTNG_EVENT_CONTEXT_PADDING1
];
188 struct lttng_event_perf_counter_ctx perf_counter
;
193 char padding
[LTTNG_EVENT_CONTEXT_PADDING2
];
200 * Either addr is used or symbol_name and offset.
202 * The structures should be initialized to zero before use.
204 #define LTTNG_EVENT_PROBE_PADDING1 16
205 struct lttng_event_probe_attr
{
209 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
211 char padding
[LTTNG_EVENT_PROBE_PADDING1
];
217 * The structures should be initialized to zero before use.
219 #define LTTNG_EVENT_FUNCTION_PADDING1 16
220 struct lttng_event_function_attr
{
221 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
223 char padding
[LTTNG_EVENT_FUNCTION_PADDING1
];
227 * Generic lttng event
229 * The structures should be initialized to zero before use.
231 #define LTTNG_EVENT_PADDING1 12
232 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
235 enum lttng_event_type type
;
238 char name
[LTTNG_SYMBOL_NAME_LEN
];
241 enum lttng_loglevel_type loglevel_type
;
247 int32_t enabled
; /* Does not apply: -1 */
253 unsigned char filter
; /* filter enabled ? */
256 unsigned char exclusion
; /* exclusions added ? */
262 /* Event flag, from 2.6 and above. */
263 enum lttng_event_flag flags
;
275 /* Per event type configuration */
277 struct lttng_event_probe_attr probe
;
278 struct lttng_event_function_attr ftrace
;
280 char padding
[LTTNG_EVENT_PADDING2
];
284 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
285 struct lttng_event_field
{
286 char field_name
[LTTNG_SYMBOL_NAME_LEN
];
287 enum lttng_event_field_type type
;
288 char padding
[LTTNG_EVENT_FIELD_PADDING
];
289 struct lttng_event event
;
294 * List the event(s) of a session channel.
296 * Both handle and channel_name CAN NOT be NULL.
298 * Return the size (number of entries) of the "lttng_event" array. Caller must
299 * free events. On error a negative LTTng error code is returned.
301 extern int lttng_list_events(struct lttng_handle
*handle
,
302 const char *channel_name
, struct lttng_event
**events
);
305 * Get the filter expression of a specific LTTng event.
307 * If the call is successful, then the filter expression's address is put
308 * in *filter_expression. If the event has no filter expression,
309 * *filter_expression is set to NULL. The caller does NOT own
310 * *filter_expression.
312 * Returns 0 on success, or a negative LTTng error code on error.
314 extern int lttng_event_get_filter_expression(struct lttng_event
*event
,
315 const char **filter_string
);
318 * Get the number of exclusion names of a specific LTTng event.
320 * Returns the number of exclusion names on success, or a negative
321 * LTTng error code on error.
323 extern int lttng_event_get_exclusion_name_count(struct lttng_event
*event
);
326 * Get an LTTng event's exclusion name at a given index.
328 * If the call is successful, then the exclusion name string's address
329 * is put in *exclusion_name. The caller does NOT own *exclusion_name.
331 * Returns 0 on success, or a negative LTTng error code on error.
333 extern int lttng_event_get_exclusion_name(struct lttng_event
*event
,
334 size_t index
, const char **exclusion_name
);
337 * List the available tracepoints of a specific lttng domain.
339 * The handle CAN NOT be NULL.
341 * Return the size (number of entries) of the "lttng_event" array. Caller must
342 * free events. On error a negative LTTng error code is returned.
344 extern int lttng_list_tracepoints(struct lttng_handle
*handle
,
345 struct lttng_event
**events
);
348 * List the available tracepoints fields of a specific lttng domain.
350 * The handle CAN NOT be NULL.
352 * Return the size (number of entries) of the "lttng_event_field" array.
353 * Caller must free fields. On error a negative LTTng error code is
356 extern int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
357 struct lttng_event_field
**fields
);
360 * List the available kernel syscall.
362 * Return the size (number of entries) of the allocated "lttng_event" array.
363 * All events in will be of type syscall. Caller must free events. On error a
364 * negative LTTng error code is returned.
366 extern int lttng_list_syscalls(struct lttng_event
**events
);
369 * Add context to event(s) for a specific channel (or for all).
371 * If the channel_name is NULL and they are no channel for the domain, the
372 * default channel is created (channel0). The context is then added on ALL
373 * channels since no name was specified.
375 * The event_name is ignored since adding a context to an event is not possible
378 * Return 0 on success else a negative LTTng error code.
380 extern int lttng_add_context(struct lttng_handle
*handle
,
381 struct lttng_event_context
*ctx
, const char *event_name
,
382 const char *channel_name
);
385 * Create or enable an event (or events) for a channel.
387 * If the event you are trying to enable does not exist, it will be created,
388 * else it is enabled. If channel_name is NULL, the default channel is used
391 * The handle and ev params can not be NULL.
393 * Return 0 on success else a negative LTTng error code.
395 extern int lttng_enable_event(struct lttng_handle
*handle
,
396 struct lttng_event
*ev
, const char *channel_name
);
399 * Create or enable an event with a specific filter.
401 * If the event you are trying to enable does not exist, it will be created,
402 * else it is enabled.
403 * If ev is NULL, all events are enabled with that filter.
404 * If channel_name is NULL, the default channel is used (channel0) and created
406 * If filter_expression is NULL, an event without associated filter is
409 * Return 0 on success else a negative LTTng error code.
411 extern int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
412 struct lttng_event
*event
, const char *channel_name
,
413 const char *filter_expression
);
416 * Create or enable an event with a filter and/or exclusions.
418 * If the event you are trying to enable does not exist, it will be created,
419 * else it is enabled.
420 * If ev is NULL, all events are enabled with the filter and exclusion options.
421 * If channel_name is NULL, the default channel is used (channel0) and created
423 * If filter_expression is NULL, an event without associated filter is
425 * If exclusion count is zero, the event will be created without exclusions.
427 * Return 0 on success else a negative LTTng error code.
429 extern int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
430 struct lttng_event
*event
, const char *channel_name
,
431 const char *filter_expression
,
432 int exclusion_count
, char **exclusion_names
);
435 * Disable event(s) of a channel and domain.
437 * If name is NULL, all events are disabled.
438 * If channel_name is NULL, the default channel is used (channel0).
440 * Return 0 on success else a negative LTTng error code.
442 extern int lttng_disable_event(struct lttng_handle
*handle
,
443 const char *name
, const char *channel_name
);
446 * Disable event(s) of a channel and domain.
448 * Takes a struct lttng_event as parameter.
449 * If channel_name is NULL, the default channel is used (channel0).
451 * Currently, @filter_expression must be NULL. (disabling specific
452 * filter expressions not implemented)
453 * Currently, only LTTNG_EVENT_ALL and LTTNG_EVENT_SYSCALL event types
454 * are implemented for field @ev.
456 * Return 0 on success else a negative LTTng error code.
458 int lttng_disable_event_ext(struct lttng_handle
*handle
,
459 struct lttng_event
*ev
, const char *channel_name
,
460 const char *filter_expression
);
466 #endif /* LTTNG_EVENT_H */