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 #include <sys/types.h>
30 * Event symbol length. Copied from LTTng kernel ABI.
32 #define LTTNG_SYMBOL_NAME_LEN 256
35 * Every lttng_event_* structure both apply to kernel event and user-space
40 * Domain types: the different possible tracers.
42 enum lttng_domain_type
{
43 LTTNG_DOMAIN_KERNEL
= 1,
47 * For now, the domains below are not implemented. However, we keep them
48 * here in order to retain their enum values for future development. Note
49 * that it is on the roadmap to implement them.
51 LTTNG_DOMAIN_UST_EXEC_NAME = 3,
52 LTTNG_DOMAIN_UST_PID = 4,
53 LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5,
58 * Instrumentation type of tracing event.
60 enum lttng_event_type
{
62 LTTNG_EVENT_TRACEPOINT
= 0,
63 LTTNG_EVENT_PROBE
= 1,
64 LTTNG_EVENT_FUNCTION
= 2,
65 LTTNG_EVENT_FUNCTION_ENTRY
= 3,
67 LTTNG_EVENT_SYSCALL
= 5,
71 * Loglevel information.
73 enum lttng_loglevel_type
{
74 LTTNG_EVENT_LOGLEVEL_ALL
= 0,
75 LTTNG_EVENT_LOGLEVEL_RANGE
= 1,
76 LTTNG_EVENT_LOGLEVEL_SINGLE
= 2,
80 * Available loglevels.
83 LTTNG_LOGLEVEL_EMERG
= 0,
84 LTTNG_LOGLEVEL_ALERT
= 1,
85 LTTNG_LOGLEVEL_CRIT
= 2,
86 LTTNG_LOGLEVEL_ERR
= 3,
87 LTTNG_LOGLEVEL_WARNING
= 4,
88 LTTNG_LOGLEVEL_NOTICE
= 5,
89 LTTNG_LOGLEVEL_INFO
= 6,
90 LTTNG_LOGLEVEL_DEBUG_SYSTEM
= 7,
91 LTTNG_LOGLEVEL_DEBUG_PROGRAM
= 8,
92 LTTNG_LOGLEVEL_DEBUG_PROCESS
= 9,
93 LTTNG_LOGLEVEL_DEBUG_MODULE
= 10,
94 LTTNG_LOGLEVEL_DEBUG_UNIT
= 11,
95 LTTNG_LOGLEVEL_DEBUG_FUNCTION
= 12,
96 LTTNG_LOGLEVEL_DEBUG_LINE
= 13,
97 LTTNG_LOGLEVEL_DEBUG
= 14,
101 * LTTng consumer mode
103 enum lttng_event_output
{
104 LTTNG_EVENT_SPLICE
= 0,
105 LTTNG_EVENT_MMAP
= 1,
108 /* Event context possible type */
109 enum lttng_event_context_type
{
110 LTTNG_EVENT_CONTEXT_PID
= 0,
111 LTTNG_EVENT_CONTEXT_PERF_COUNTER
= 1,
112 LTTNG_EVENT_CONTEXT_PROCNAME
= 2,
113 LTTNG_EVENT_CONTEXT_PRIO
= 3,
114 LTTNG_EVENT_CONTEXT_NICE
= 4,
115 LTTNG_EVENT_CONTEXT_VPID
= 5,
116 LTTNG_EVENT_CONTEXT_TID
= 6,
117 LTTNG_EVENT_CONTEXT_VTID
= 7,
118 LTTNG_EVENT_CONTEXT_PPID
= 8,
119 LTTNG_EVENT_CONTEXT_VPPID
= 9,
120 LTTNG_EVENT_CONTEXT_PTHREAD_ID
= 10,
123 enum lttng_calibrate_type
{
124 LTTNG_CALIBRATE_FUNCTION
= 0,
127 /* Health component for the health check function. */
128 enum lttng_health_component
{
130 LTTNG_HEALTH_APP_MANAGE
,
131 LTTNG_HEALTH_APP_REG
,
133 LTTNG_HEALTH_CONSUMER
,
138 * The structures should be initialized to zero before use.
140 #define LTTNG_DOMAIN_PADDING1 16
141 #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
142 struct lttng_domain
{
143 enum lttng_domain_type type
;
144 char padding
[LTTNG_DOMAIN_PADDING1
];
148 char exec_name
[NAME_MAX
];
149 char padding
[LTTNG_DOMAIN_PADDING2
];
154 * Perf counter attributes
156 * The structures should be initialized to zero before use.
158 #define LTTNG_PERF_EVENT_PADDING1 16
159 struct lttng_event_perf_counter_ctx
{
162 char name
[LTTNG_SYMBOL_NAME_LEN
];
164 char padding
[LTTNG_PERF_EVENT_PADDING1
];
168 * Event/channel context
170 * The structures should be initialized to zero before use.
172 #define LTTNG_EVENT_CONTEXT_PADDING1 16
173 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
174 struct lttng_event_context
{
175 enum lttng_event_context_type ctx
;
176 char padding
[LTTNG_EVENT_CONTEXT_PADDING1
];
179 struct lttng_event_perf_counter_ctx perf_counter
;
180 char padding
[LTTNG_EVENT_CONTEXT_PADDING2
];
187 * Either addr is used or symbol_name and offset.
189 * The structures should be initialized to zero before use.
191 #define LTTNG_EVENT_PROBE_PADDING1 16
192 struct lttng_event_probe_attr
{
196 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
198 char padding
[LTTNG_EVENT_PROBE_PADDING1
];
204 * The structures should be initialized to zero before use.
206 #define LTTNG_EVENT_FUNCTION_PADDING1 16
207 struct lttng_event_function_attr
{
208 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
210 char padding
[LTTNG_EVENT_FUNCTION_PADDING1
];
214 * Generic lttng event
216 * The structures should be initialized to zero before use.
218 #define LTTNG_EVENT_PADDING1 15
219 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
221 enum lttng_event_type type
;
222 char name
[LTTNG_SYMBOL_NAME_LEN
];
224 enum lttng_loglevel_type loglevel_type
;
227 int32_t enabled
; /* Does not apply: -1 */
229 unsigned char filter
; /* filter enabled ? */
231 char padding
[LTTNG_EVENT_PADDING1
];
233 /* Per event type configuration */
235 struct lttng_event_probe_attr probe
;
236 struct lttng_event_function_attr ftrace
;
238 char padding
[LTTNG_EVENT_PADDING2
];
242 enum lttng_event_field_type
{
243 LTTNG_EVENT_FIELD_OTHER
= 0,
244 LTTNG_EVENT_FIELD_INTEGER
= 1,
245 LTTNG_EVENT_FIELD_ENUM
= 2,
246 LTTNG_EVENT_FIELD_FLOAT
= 3,
247 LTTNG_EVENT_FIELD_STRING
= 4,
250 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
251 struct lttng_event_field
{
252 char field_name
[LTTNG_SYMBOL_NAME_LEN
];
253 enum lttng_event_field_type type
;
254 char padding
[LTTNG_EVENT_FIELD_PADDING
];
255 struct lttng_event event
;
259 * Tracer channel attributes. For both kernel and user-space.
261 * The structures should be initialized to zero before use.
263 #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
264 struct lttng_channel_attr
{
265 int overwrite
; /* 1: overwrite, 0: discard */
266 uint64_t subbuf_size
; /* bytes */
267 uint64_t num_subbuf
; /* power of 2 */
268 unsigned int switch_timer_interval
; /* usec */
269 unsigned int read_timer_interval
; /* usec */
270 enum lttng_event_output output
; /* splice, mmap */
272 char padding
[LTTNG_CHANNEL_ATTR_PADDING1
];
276 * Channel information structure. For both kernel and user-space.
278 * The structures should be initialized to zero before use.
280 #define LTTNG_CHANNEL_PADDING1 16
281 struct lttng_channel
{
282 char name
[LTTNG_SYMBOL_NAME_LEN
];
284 struct lttng_channel_attr attr
;
286 char padding
[LTTNG_CHANNEL_PADDING1
];
289 #define LTTNG_CALIBRATE_PADDING1 16
290 struct lttng_calibrate
{
291 enum lttng_calibrate_type type
;
293 char padding
[LTTNG_CALIBRATE_PADDING1
];
297 * Basic session information.
299 * This is an 'output data' meaning that it only comes *from* the session
300 * daemon *to* the lttng client. It's basically a 'human' representation of
301 * tracing entities (here a session).
303 * The structures should be initialized to zero before use.
305 #define LTTNG_SESSION_PADDING1 16
306 struct lttng_session
{
308 /* The path where traces are written */
310 uint32_t enabled
; /* enabled/started: 1, disabled/stopped: 0 */
312 char padding
[LTTNG_SESSION_PADDING1
];
316 * Handle used as a context for commands.
318 * The structures should be initialized to zero before use.
320 #define LTTNG_HANDLE_PADDING1 16
321 struct lttng_handle
{
322 char session_name
[NAME_MAX
];
323 struct lttng_domain domain
;
325 char padding
[LTTNG_HANDLE_PADDING1
];
329 * Public LTTng control API
331 * For functions having an lttng domain type as parameter, if a bad value is
332 * given, NO default is applied and an error is returned.
334 * On success, all functions of the API return 0 or the size of the allocated
337 * On error, a negative value is returned being a specific lttng-tools error
338 * code which can be humanly interpreted with lttng_strerror(err).
340 * Exceptions to this are noted below.
344 * Create a handle used as a context for every request made to the library.
346 * This handle contains the session name and lttng domain on which the command
348 * The returned pointer will be NULL in case of malloc() error.
350 extern struct lttng_handle
*lttng_create_handle(const char *session_name
,
351 struct lttng_domain
*domain
);
354 * Destroy a handle. This will simply free(3) the data pointer returned by
355 * lttng_create_handle(), rendering it unusable.
357 extern void lttng_destroy_handle(struct lttng_handle
*handle
);
360 * Create a tracing session using a name and an optional URL.
362 * If _url_ is NULL, no consumer is created for the session.
364 extern int lttng_create_session(const char *name
, const char *url
);
367 * Destroy a tracing session.
369 * The session will not be usable anymore, tracing will be stopped for all
370 * registered traces, and the tracing buffers will be flushed.
372 extern int lttng_destroy_session(const char *name
);
375 * List all the tracing sessions.
377 * Return the size (number of entries) of the "lttng_session" array. Caller
380 extern int lttng_list_sessions(struct lttng_session
**sessions
);
383 * List the registered domain(s) of a session.
385 * Return the size (number of entries) of the "lttng_domain" array. Caller
388 extern int lttng_list_domains(const char *session_name
,
389 struct lttng_domain
**domains
);
392 * List the channel(s) of a session.
394 * Return the size (number of entries) of the "lttng_channel" array. Caller
397 extern int lttng_list_channels(struct lttng_handle
*handle
,
398 struct lttng_channel
**channels
);
401 * List the event(s) of a session channel.
403 * Return the size (number of entries) of the "lttng_event" array.
404 * Caller must free(3).
406 extern int lttng_list_events(struct lttng_handle
*handle
,
407 const char *channel_name
, struct lttng_event
**events
);
410 * List the available tracepoints of a specific lttng domain.
412 * Return the size (number of entries) of the "lttng_event" array.
413 * Caller must free(3).
415 extern int lttng_list_tracepoints(struct lttng_handle
*handle
,
416 struct lttng_event
**events
);
419 * List the available tracepoints fields of a specific lttng domain.
421 * Return the size (number of entries) of the "lttng_event_field" array.
422 * Caller must free(3).
424 extern int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
425 struct lttng_event_field
**fields
);
428 * Check if a session daemon is alive.
430 * Return 1 if alive or 0 if not. On error returns a negative value.
432 extern int lttng_session_daemon_alive(void);
435 * Set the tracing group for the *current* flow of execution.
437 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
439 extern int lttng_set_tracing_group(const char *name
);
442 * Return a human-readable error message for an lttng-tools error code.
444 * Parameter MUST be a negative value or else you'll get a generic message.
446 extern const char *lttng_strerror(int code
);
449 * This call registers an "outside consumer" for a session and an lttng domain.
450 * No consumer will be spawned and all fds/commands will go through the socket
451 * path given (socket_path).
453 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
454 * command socket. The error socket is not supported yet for roaming consumers.
456 extern int lttng_register_consumer(struct lttng_handle
*handle
,
457 const char *socket_path
);
460 * Start tracing for *all* registered traces (kernel and user-space).
462 extern int lttng_start_tracing(const char *session_name
);
465 * Stop tracing for *all* registered traces (kernel and user-space).
467 extern int lttng_stop_tracing(const char *session_name
);
470 * Add context to event(s) for a specific channel (or for all).
472 * If event_name is NULL, the context is applied to all events of the channel.
473 * If channel_name is NULL, a lookup of the event's channel is done.
474 * If both are NULL, the context is applied to all events of all channels.
476 extern int lttng_add_context(struct lttng_handle
*handle
,
477 struct lttng_event_context
*ctx
, const char *event_name
,
478 const char *channel_name
);
481 * Create or enable an event (or events) for a channel.
483 * If the event you are trying to enable does not exist, it will be created,
484 * else it is enabled.
485 * If event_name is NULL, all events are enabled.
486 * If channel_name is NULL, the default channel is used (channel0).
488 extern int lttng_enable_event(struct lttng_handle
*handle
,
489 struct lttng_event
*ev
, const char *channel_name
);
492 * Apply a filter expression to an event.
494 * If event_name is NULL, the filter is applied to all events of the channel.
495 * If channel_name is NULL, a lookup of the event's channel is done.
496 * If both are NULL, the filter is applied to all events of all channels.
498 extern int lttng_set_event_filter(struct lttng_handle
*handle
,
499 const char *event_name
,
500 const char *channel_name
,
501 const char *filter_expression
);
503 * Create or enable a channel.
504 * The channel name cannot be NULL.
506 extern int lttng_enable_channel(struct lttng_handle
*handle
,
507 struct lttng_channel
*chan
);
510 * Disable event(s) of a channel and domain.
512 * If event_name is NULL, all events are disabled.
513 * If channel_name is NULL, the default channel is used (channel0).
515 extern int lttng_disable_event(struct lttng_handle
*handle
,
516 const char *name
, const char *channel_name
);
521 * The channel name cannot be NULL.
523 extern int lttng_disable_channel(struct lttng_handle
*handle
,
527 * Calibrate LTTng overhead.
529 extern int lttng_calibrate(struct lttng_handle
*handle
,
530 struct lttng_calibrate
*calibrate
);
533 * Set the default channel attributes for a specific domain and an allocated
534 * lttng_channel_attr pointer.
536 * If either or both of the arguments are NULL, nothing happens.
538 extern void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
539 struct lttng_channel_attr
*attr
);
542 * Set URL for a consumer for a session and domain.
544 * Both data and control URL must be defined. If both URLs are the same, only
545 * the control URL is used even for network streaming.
547 * Default port are 5342 and 5343 respectively for control and data which uses
550 extern int lttng_set_consumer_url(struct lttng_handle
*handle
,
551 const char *control_url
, const char *data_url
);
554 * Enable the consumer for a session and domain.
556 extern int lttng_enable_consumer(struct lttng_handle
*handle
);
559 * Disable consumer for a session and domain.
561 extern int lttng_disable_consumer(struct lttng_handle
*handle
);
564 * Check session daemon health for a specific component.
566 * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
567 * the control library was not able to connect to the session daemon health
570 * Any other positive value is an lttcomm error which can be translate with
573 extern int lttng_health_check(enum lttng_health_component c
);
575 #endif /* _LTTNG_H */