4 * Linux Trace Toolkit Control Library Header File
6 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
8 * This library is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License, version 2.1 only,
10 * as published by the Free Software Foundation.
12 * This library is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 * Necessary to include the fixed width type limits on glibc versions older
28 * than 2.18 when building with a C++ compiler.
30 #ifndef __STDC_LIMIT_MACROS
31 #define __STDC_LIMIT_MACROS
33 #undef __STDC_LIMIT_MACROS
34 #else /* #ifndef __STDC_LIMIT_MACROS */
36 #endif /* #else #ifndef __STDC_LIMIT_MACROS */
37 #include <sys/types.h>
39 /* Error codes that can be returned by API calls */
40 #include <lttng/lttng-error.h>
47 * Event symbol length. Copied from LTTng kernel ABI.
49 #define LTTNG_SYMBOL_NAME_LEN 256
52 * Every lttng_event_* structure both apply to kernel event and user-space
57 * Domain types: the different possible tracers.
59 enum lttng_domain_type
{
60 LTTNG_DOMAIN_KERNEL
= 1, /* Linux Kernel tracer. */
61 LTTNG_DOMAIN_UST
= 2, /* Global Userspace tracer. */
62 LTTNG_DOMAIN_JUL
= 3, /* Java Util Logging. */
66 * Instrumentation type of tracing event.
68 enum lttng_event_type
{
70 LTTNG_EVENT_TRACEPOINT
= 0,
71 LTTNG_EVENT_PROBE
= 1,
72 LTTNG_EVENT_FUNCTION
= 2,
73 LTTNG_EVENT_FUNCTION_ENTRY
= 3,
75 LTTNG_EVENT_SYSCALL
= 5,
79 * Loglevel information.
81 enum lttng_loglevel_type
{
82 LTTNG_EVENT_LOGLEVEL_ALL
= 0,
83 LTTNG_EVENT_LOGLEVEL_RANGE
= 1,
84 LTTNG_EVENT_LOGLEVEL_SINGLE
= 2,
88 * Available loglevels.
91 LTTNG_LOGLEVEL_EMERG
= 0,
92 LTTNG_LOGLEVEL_ALERT
= 1,
93 LTTNG_LOGLEVEL_CRIT
= 2,
94 LTTNG_LOGLEVEL_ERR
= 3,
95 LTTNG_LOGLEVEL_WARNING
= 4,
96 LTTNG_LOGLEVEL_NOTICE
= 5,
97 LTTNG_LOGLEVEL_INFO
= 6,
98 LTTNG_LOGLEVEL_DEBUG_SYSTEM
= 7,
99 LTTNG_LOGLEVEL_DEBUG_PROGRAM
= 8,
100 LTTNG_LOGLEVEL_DEBUG_PROCESS
= 9,
101 LTTNG_LOGLEVEL_DEBUG_MODULE
= 10,
102 LTTNG_LOGLEVEL_DEBUG_UNIT
= 11,
103 LTTNG_LOGLEVEL_DEBUG_FUNCTION
= 12,
104 LTTNG_LOGLEVEL_DEBUG_LINE
= 13,
105 LTTNG_LOGLEVEL_DEBUG
= 14,
109 * Available loglevels for the JUL domain. Those are an exact map from the
110 * class java.util.logging.Level.
112 enum lttng_loglevel_jul
{
113 LTTNG_LOGLEVEL_JUL_OFF
= INT32_MAX
,
114 LTTNG_LOGLEVEL_JUL_SEVERE
= 1000,
115 LTTNG_LOGLEVEL_JUL_WARNING
= 900,
116 LTTNG_LOGLEVEL_JUL_INFO
= 800,
117 LTTNG_LOGLEVEL_JUL_CONFIG
= 700,
118 LTTNG_LOGLEVEL_JUL_FINE
= 500,
119 LTTNG_LOGLEVEL_JUL_FINER
= 400,
120 LTTNG_LOGLEVEL_JUL_FINEST
= 300,
121 LTTNG_LOGLEVEL_JUL_ALL
= INT32_MIN
,
125 * LTTng consumer mode
127 enum lttng_event_output
{
128 LTTNG_EVENT_SPLICE
= 0,
129 LTTNG_EVENT_MMAP
= 1,
132 /* Event context possible type */
133 enum lttng_event_context_type
{
134 LTTNG_EVENT_CONTEXT_PID
= 0,
135 LTTNG_EVENT_CONTEXT_PERF_COUNTER
= 1, /* Backward compat. */
136 LTTNG_EVENT_CONTEXT_PROCNAME
= 2,
137 LTTNG_EVENT_CONTEXT_PRIO
= 3,
138 LTTNG_EVENT_CONTEXT_NICE
= 4,
139 LTTNG_EVENT_CONTEXT_VPID
= 5,
140 LTTNG_EVENT_CONTEXT_TID
= 6,
141 LTTNG_EVENT_CONTEXT_VTID
= 7,
142 LTTNG_EVENT_CONTEXT_PPID
= 8,
143 LTTNG_EVENT_CONTEXT_VPPID
= 9,
144 LTTNG_EVENT_CONTEXT_PTHREAD_ID
= 10,
145 LTTNG_EVENT_CONTEXT_HOSTNAME
= 11,
146 LTTNG_EVENT_CONTEXT_IP
= 12,
147 LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
= 13,
148 LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
= 14,
151 enum lttng_calibrate_type
{
152 LTTNG_CALIBRATE_FUNCTION
= 0,
155 /* Health component for the health check function. */
156 enum lttng_health_component
{
158 LTTNG_HEALTH_APP_MANAGE
,
159 LTTNG_HEALTH_APP_REG
,
161 LTTNG_HEALTH_CONSUMER
,
162 LTTNG_HEALTH_HT_CLEANUP
,
163 LTTNG_HEALTH_APP_MANAGE_NOTIFY
,
164 LTTNG_HEALTH_APP_REG_DISPATCH
,
168 /* Buffer type for a specific domain. */
169 enum lttng_buffer_type
{
170 LTTNG_BUFFER_PER_PID
, /* Only supported by UST being the default. */
171 LTTNG_BUFFER_PER_UID
, /* Only supported by UST. */
172 LTTNG_BUFFER_GLOBAL
, /* Only supported by the Kernel. */
176 * The structures should be initialized to zero before use.
178 #define LTTNG_DOMAIN_PADDING1 12
179 #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
180 struct lttng_domain
{
181 enum lttng_domain_type type
;
182 enum lttng_buffer_type buf_type
;
183 char padding
[LTTNG_DOMAIN_PADDING1
];
187 char exec_name
[NAME_MAX
];
188 char padding
[LTTNG_DOMAIN_PADDING2
];
193 * Perf counter attributes
195 * The structures should be initialized to zero before use.
197 #define LTTNG_PERF_EVENT_PADDING1 16
198 struct lttng_event_perf_counter_ctx
{
201 char name
[LTTNG_SYMBOL_NAME_LEN
];
203 char padding
[LTTNG_PERF_EVENT_PADDING1
];
207 * Event/channel context
209 * The structures should be initialized to zero before use.
211 #define LTTNG_EVENT_CONTEXT_PADDING1 16
212 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
213 struct lttng_event_context
{
214 enum lttng_event_context_type ctx
;
215 char padding
[LTTNG_EVENT_CONTEXT_PADDING1
];
218 struct lttng_event_perf_counter_ctx perf_counter
;
219 char padding
[LTTNG_EVENT_CONTEXT_PADDING2
];
226 * Either addr is used or symbol_name and offset.
228 * The structures should be initialized to zero before use.
230 #define LTTNG_EVENT_PROBE_PADDING1 16
231 struct lttng_event_probe_attr
{
235 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
237 char padding
[LTTNG_EVENT_PROBE_PADDING1
];
243 * The structures should be initialized to zero before use.
245 #define LTTNG_EVENT_FUNCTION_PADDING1 16
246 struct lttng_event_function_attr
{
247 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
249 char padding
[LTTNG_EVENT_FUNCTION_PADDING1
];
253 * Generic lttng event
255 * The structures should be initialized to zero before use.
257 #define LTTNG_EVENT_PADDING1 14
258 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
260 enum lttng_event_type type
;
261 char name
[LTTNG_SYMBOL_NAME_LEN
];
263 enum lttng_loglevel_type loglevel_type
;
266 int32_t enabled
; /* Does not apply: -1 */
268 unsigned char filter
; /* filter enabled ? */
269 unsigned char exclusion
; /* exclusions added ? */
271 char padding
[LTTNG_EVENT_PADDING1
];
273 /* Per event type configuration */
275 struct lttng_event_probe_attr probe
;
276 struct lttng_event_function_attr ftrace
;
278 char padding
[LTTNG_EVENT_PADDING2
];
282 enum lttng_event_field_type
{
283 LTTNG_EVENT_FIELD_OTHER
= 0,
284 LTTNG_EVENT_FIELD_INTEGER
= 1,
285 LTTNG_EVENT_FIELD_ENUM
= 2,
286 LTTNG_EVENT_FIELD_FLOAT
= 3,
287 LTTNG_EVENT_FIELD_STRING
= 4,
290 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
291 struct lttng_event_field
{
292 char field_name
[LTTNG_SYMBOL_NAME_LEN
];
293 enum lttng_event_field_type type
;
294 char padding
[LTTNG_EVENT_FIELD_PADDING
];
295 struct lttng_event event
;
300 * Tracer channel attributes. For both kernel and user-space.
302 * The structures should be initialized to zero before use.
304 #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 12
305 struct lttng_channel_attr
{
306 int overwrite
; /* 1: overwrite, 0: discard */
307 uint64_t subbuf_size
; /* bytes */
308 uint64_t num_subbuf
; /* power of 2 */
309 unsigned int switch_timer_interval
; /* usec */
310 unsigned int read_timer_interval
; /* usec */
311 enum lttng_event_output output
; /* splice, mmap */
312 /* LTTng 2.1 padding limit */
313 uint64_t tracefile_size
; /* bytes */
314 uint64_t tracefile_count
; /* number of tracefiles */
315 /* LTTng 2.3 padding limit */
316 unsigned int live_timer_interval
; /* usec */
318 char padding
[LTTNG_CHANNEL_ATTR_PADDING1
];
322 * Channel information structure. For both kernel and user-space.
324 * The structures should be initialized to zero before use.
326 #define LTTNG_CHANNEL_PADDING1 16
327 struct lttng_channel
{
328 char name
[LTTNG_SYMBOL_NAME_LEN
];
330 struct lttng_channel_attr attr
;
332 char padding
[LTTNG_CHANNEL_PADDING1
];
335 #define LTTNG_CALIBRATE_PADDING1 16
336 struct lttng_calibrate
{
337 enum lttng_calibrate_type type
;
339 char padding
[LTTNG_CALIBRATE_PADDING1
];
343 * Basic session information.
345 * This is an 'output data' meaning that it only comes *from* the session
346 * daemon *to* the lttng client. It's basically a 'human' representation of
347 * tracing entities (here a session).
349 * The structures should be initialized to zero before use.
351 #define LTTNG_SESSION_PADDING1 12
352 struct lttng_session
{
354 /* The path where traces are written */
356 uint32_t enabled
; /* enabled/started: 1, disabled/stopped: 0 */
357 uint32_t snapshot_mode
;
358 unsigned int live_timer_interval
; /* usec */
360 char padding
[LTTNG_SESSION_PADDING1
];
364 * Handle used as a context for commands.
366 * The structures should be initialized to zero before use.
368 #define LTTNG_HANDLE_PADDING1 16
369 struct lttng_handle
{
370 char session_name
[NAME_MAX
];
371 struct lttng_domain domain
;
373 char padding
[LTTNG_HANDLE_PADDING1
];
377 * Public LTTng control API
379 * For functions having an lttng domain type as parameter, if a bad value is
380 * given, NO default is applied and an error is returned.
382 * On success, all functions of the API return 0 or the size of the allocated
385 * On error, a negative value is returned being a specific lttng-tools error
386 * code which can be humanly interpreted with lttng_strerror(err).
388 * Exceptions to this are noted below.
392 * Create a handle used as a context for every request made to the library.
394 * This handle contains the session name and lttng domain on which the command
396 * The returned pointer will be NULL in case of malloc() error.
398 extern struct lttng_handle
*lttng_create_handle(const char *session_name
,
399 struct lttng_domain
*domain
);
404 * It free(3) the data pointer returned by lttng_create_handle(), rendering it
407 extern void lttng_destroy_handle(struct lttng_handle
*handle
);
410 * Create a tracing session using a name and an optional URL.
412 * If _url_ is NULL, no consumer is created for the session. The name can't be
415 extern int lttng_create_session(const char *name
, const char *url
);
418 * Create a tracing session that will exclusively be used for snapshot meaning
419 * the session will be in no output mode and every channel enabled for that
420 * session will be set in overwrite mode and in mmap output since splice is not
423 * If an url is given, it will be used to create a default snapshot output
424 * using it as a destination. If NULL, no output will be defined and an
425 * add-output call will be needed.
427 * Name can't be NULL.
429 extern int lttng_create_session_snapshot(const char *name
,
430 const char *snapshot_url
);
433 * Create a session exclusively used for live reading.
435 * In this mode, the switch-timer parameter is forced for each UST channel, a
436 * live-switch-timer is enabled for kernel channels, manually setting
437 * switch-timer is forbidden. Synchronization beacons are sent to the relayd,
438 * indexes are sent and metadata is checked for each packet.
440 * Returns LTTNG_OK on success or a negative error code.
442 extern int lttng_create_session_live(const char *name
, const char *url
,
443 unsigned int timer_interval
);
446 * Destroy a tracing session.
448 * The session will not be usable anymore, tracing will be stopped for all
449 * registered traces, and the tracing buffers will be flushed.
451 * The name can't be NULL here.
453 extern int lttng_destroy_session(const char *name
);
456 * List all the tracing sessions.
458 * Return the size (number of entries) of the "lttng_session" array. Caller
461 extern int lttng_list_sessions(struct lttng_session
**sessions
);
464 * List the registered domain(s) of a session.
466 * Return the size (number of entries) of the "lttng_domain" array. Caller
469 extern int lttng_list_domains(const char *session_name
,
470 struct lttng_domain
**domains
);
473 * List the channel(s) of a session.
475 * Return the size (number of entries) of the "lttng_channel" array. Caller
478 extern int lttng_list_channels(struct lttng_handle
*handle
,
479 struct lttng_channel
**channels
);
482 * List the event(s) of a session channel.
484 * Return the size (number of entries) of the "lttng_event" array.
485 * Caller must free(3).
487 extern int lttng_list_events(struct lttng_handle
*handle
,
488 const char *channel_name
, struct lttng_event
**events
);
491 * List the available tracepoints of a specific lttng domain.
493 * Return the size (number of entries) of the "lttng_event" array.
494 * Caller must free(3).
496 extern int lttng_list_tracepoints(struct lttng_handle
*handle
,
497 struct lttng_event
**events
);
500 * List the available tracepoints fields of a specific lttng domain.
502 * Return the size (number of entries) of the "lttng_event_field" array.
503 * Caller must free(3).
505 extern int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
506 struct lttng_event_field
**fields
);
509 * Check if a session daemon is alive.
511 * Return 1 if alive or 0 if not. On error returns a negative value.
513 extern int lttng_session_daemon_alive(void);
516 * Set the tracing group for the *current* flow of execution.
518 * On success, returns 0 else a negative value on error being a lttng error
519 * code found in lttng-error.h
521 extern int lttng_set_tracing_group(const char *name
);
524 * Return a human-readable error message for an lttng-tools error code.
526 * Parameter MUST be a negative value or else you'll get a generic message.
528 extern const char *lttng_strerror(int code
);
531 * This call registers an "outside consumer" for a session and an lttng domain.
532 * No consumer will be spawned and all fds/commands will go through the socket
533 * path given (socket_path).
535 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
536 * command socket. The error socket is not supported yet for roaming consumers.
538 extern int lttng_register_consumer(struct lttng_handle
*handle
,
539 const char *socket_path
);
542 * Start tracing for *all* registered traces (kernel and user-space).
544 extern int lttng_start_tracing(const char *session_name
);
547 * Stop tracing for *all* registered traces (kernel and user-space).
549 * This call will wait for data availability for each domain of the session so
550 * this can take an abritrary amount of time. However, when returning you have
551 * the guarantee that the data is ready to be read and analyse. Use the
552 * _no_wait call below to avoid this behavior.
554 * The session_name can't be NULL.
556 extern int lttng_stop_tracing(const char *session_name
);
559 * Behave exactly like lttng_stop_tracing but does not wait for data
562 extern int lttng_stop_tracing_no_wait(const char *session_name
);
565 * Add context to event(s) for a specific channel (or for all).
567 * If channel_name is NULL, a lookup of the event's channel is done. If both
568 * are NULL, the context is applied to all events of all channels.
570 * Note that whatever event_name value is, a context can not be added to an
571 * event, so we just ignore it for now.
573 extern int lttng_add_context(struct lttng_handle
*handle
,
574 struct lttng_event_context
*ctx
, const char *event_name
,
575 const char *channel_name
);
578 * Create or enable an event (or events) for a channel.
580 * If the event you are trying to enable does not exist, it will be created,
581 * else it is enabled.
582 * If channel_name is NULL, the default channel is used (channel0).
584 * The handle and ev params can not be NULL.
586 extern int lttng_enable_event(struct lttng_handle
*handle
,
587 struct lttng_event
*ev
, const char *channel_name
);
590 * Create or enable an event with a specific filter.
592 * If the event you are trying to enable does not exist, it will be created,
593 * else it is enabled.
594 * If ev is NULL, all events are enabled with that filter.
595 * If channel_name is NULL, the default channel is used (channel0) and created
597 * If filter_expression is NULL, an event without associated filter is
600 extern int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
601 struct lttng_event
*event
, const char *channel_name
,
602 const char *filter_expression
);
605 * Create or enable an event with a filter and/or exclusions.
607 * If the event you are trying to enable does not exist, it will be created,
608 * else it is enabled.
609 * If ev is NULL, all events are enabled with the filter and exclusion options.
610 * If channel_name is NULL, the default channel is used (channel0) and created
612 * If filter_expression is NULL, an event without associated filter is
614 * If exclusion count is zero, the event will be created without exclusions.
616 extern int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
617 struct lttng_event
*event
, const char *channel_name
,
618 const char *filter_expression
,
619 int exclusion_count
, char **exclusion_names
);
622 * Create or enable a channel.
624 * The chan and handle params can not be NULL.
626 extern int lttng_enable_channel(struct lttng_handle
*handle
,
627 struct lttng_channel
*chan
);
630 * Disable event(s) of a channel and domain.
632 * If name is NULL, all events are disabled.
633 * If channel_name is NULL, the default channel is used (channel0).
635 extern int lttng_disable_event(struct lttng_handle
*handle
,
636 const char *name
, const char *channel_name
);
642 extern int lttng_disable_channel(struct lttng_handle
*handle
,
646 * Calibrate LTTng overhead.
648 * The chan and handle params can not be NULL.
650 extern int lttng_calibrate(struct lttng_handle
*handle
,
651 struct lttng_calibrate
*calibrate
);
654 * Set the default channel attributes for a specific domain and an allocated
655 * lttng_channel_attr pointer.
657 * If one or both arguments are NULL, nothing happens.
659 extern void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
660 struct lttng_channel_attr
*attr
);
663 * Set URL for a consumer for a session and domain.
665 * Both data and control URL must be defined. If both URLs are the same, only
666 * the control URL is used even for network streaming.
668 * Default port are 5342 and 5343 respectively for control and data which uses
671 extern int lttng_set_consumer_url(struct lttng_handle
*handle
,
672 const char *control_url
, const char *data_url
);
675 * Enable the consumer for a session and domain.
677 extern LTTNG_DEPRECATED("This call is now obsolete.")
678 int lttng_enable_consumer(struct lttng_handle
*handle
);
681 * Disable consumer for a session and domain.
683 extern LTTNG_DEPRECATED("This call is now obsolete.")
684 int lttng_disable_consumer(struct lttng_handle
*handle
);
687 * Check session daemon health for a specific component.
689 * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
690 * the control library was not able to connect to the session daemon health
693 * Any other positive value is an lttcomm error which can be translate with
696 * Please see lttng-health-check(3) man page for more information.
698 extern LTTNG_DEPRECATED("This call is now obsolete.")
699 int lttng_health_check(enum lttng_health_component c
);
702 * For a given session name, this call checks if the data is ready to be read
703 * or is still being extracted by the consumer(s) (pending) hence not ready to
704 * be used by any readers.
706 * Return 0 if there is _no_ data pending in the buffers thus having a
707 * guarantee that the data can be read safely. Else, return 1 if there is still
708 * traced data is pending. On error, a negative value is returned and readable
709 * by lttng_strerror().
711 extern int lttng_data_pending(const char *session_name
);