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
26 #include <netinet/in.h>
28 #include <sys/types.h>
31 * Event symbol length. Copied from LTTng kernel ABI.
33 #define LTTNG_SYMBOL_NAME_LEN 256
36 * Maximum length of a domain name. This is the limit for the total length of a
37 * domain name specified by the RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt)
39 #define LTTNG_MAX_DNNAME 255
42 * Every lttng_event_* structure both apply to kernel event and user-space
47 * Domain types: the different possible tracers.
49 enum lttng_domain_type
{
50 LTTNG_DOMAIN_KERNEL
= 1,
54 * For now, the domains below are not implemented. However, we keep them
55 * here in order to retain their enum values for future development. Note
56 * that it is on the roadmap to implement them.
58 LTTNG_DOMAIN_UST_EXEC_NAME = 3,
59 LTTNG_DOMAIN_UST_PID = 4,
60 LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5,
65 * Instrumentation type of tracing event.
67 enum lttng_event_type
{
69 LTTNG_EVENT_TRACEPOINT
= 0,
70 LTTNG_EVENT_PROBE
= 1,
71 LTTNG_EVENT_FUNCTION
= 2,
72 LTTNG_EVENT_FUNCTION_ENTRY
= 3,
74 LTTNG_EVENT_SYSCALL
= 5,
78 * Loglevel information.
80 enum lttng_loglevel_type
{
81 LTTNG_EVENT_LOGLEVEL_ALL
= 0,
82 LTTNG_EVENT_LOGLEVEL_RANGE
= 1,
83 LTTNG_EVENT_LOGLEVEL_SINGLE
= 2,
87 * Available loglevels.
90 LTTNG_LOGLEVEL_EMERG
= 0,
91 LTTNG_LOGLEVEL_ALERT
= 1,
92 LTTNG_LOGLEVEL_CRIT
= 2,
93 LTTNG_LOGLEVEL_ERR
= 3,
94 LTTNG_LOGLEVEL_WARNING
= 4,
95 LTTNG_LOGLEVEL_NOTICE
= 5,
96 LTTNG_LOGLEVEL_INFO
= 6,
97 LTTNG_LOGLEVEL_DEBUG_SYSTEM
= 7,
98 LTTNG_LOGLEVEL_DEBUG_PROGRAM
= 8,
99 LTTNG_LOGLEVEL_DEBUG_PROCESS
= 9,
100 LTTNG_LOGLEVEL_DEBUG_MODULE
= 10,
101 LTTNG_LOGLEVEL_DEBUG_UNIT
= 11,
102 LTTNG_LOGLEVEL_DEBUG_FUNCTION
= 12,
103 LTTNG_LOGLEVEL_DEBUG_LINE
= 13,
104 LTTNG_LOGLEVEL_DEBUG
= 14,
108 * LTTng consumer mode
110 enum lttng_event_output
{
111 LTTNG_EVENT_SPLICE
= 0,
112 LTTNG_EVENT_MMAP
= 1,
115 /* Event context possible type */
116 enum lttng_event_context_type
{
117 LTTNG_EVENT_CONTEXT_PID
= 0,
118 LTTNG_EVENT_CONTEXT_PERF_COUNTER
= 1,
119 LTTNG_EVENT_CONTEXT_PROCNAME
= 2,
120 LTTNG_EVENT_CONTEXT_PRIO
= 3,
121 LTTNG_EVENT_CONTEXT_NICE
= 4,
122 LTTNG_EVENT_CONTEXT_VPID
= 5,
123 LTTNG_EVENT_CONTEXT_TID
= 6,
124 LTTNG_EVENT_CONTEXT_VTID
= 7,
125 LTTNG_EVENT_CONTEXT_PPID
= 8,
126 LTTNG_EVENT_CONTEXT_VPPID
= 9,
127 LTTNG_EVENT_CONTEXT_PTHREAD_ID
= 10,
130 enum lttng_calibrate_type
{
131 LTTNG_CALIBRATE_FUNCTION
= 0,
134 /* Destination type of lttng URI */
135 enum lttng_dst_type
{
141 /* Type of lttng URI where it is a final destination or a hop */
142 enum lttng_uri_type
{
143 LTTNG_URI_DST
, /* The URI is a final destination */
145 * Hop are not supported yet but planned for a future release.
151 /* Communication stream type of a lttng URI */
152 enum lttng_stream_type
{
153 LTTNG_STREAM_CONTROL
,
158 * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
161 enum lttng_proto_type
{
164 * UDP protocol is not supported for now.
171 * Structure representing an URI supported by lttng.
173 #define LTTNG_URI_PADDING1_LEN 16
174 #define LTTNG_URI_PADDING2_LEN LTTNG_SYMBOL_NAME_LEN + 32
176 enum lttng_dst_type dtype
;
177 enum lttng_uri_type utype
;
178 enum lttng_stream_type stype
;
179 enum lttng_proto_type proto
;
181 char padding
[LTTNG_URI_PADDING1_LEN
];
182 char subdir
[PATH_MAX
];
184 char ipv4
[INET_ADDRSTRLEN
];
185 char ipv6
[INET6_ADDRSTRLEN
];
187 char padding
[LTTNG_URI_PADDING2_LEN
];
192 * The structures should be initialized to zero before use.
194 #define LTTNG_DOMAIN_PADDING1 16
195 #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
196 struct lttng_domain
{
197 enum lttng_domain_type type
;
198 char padding
[LTTNG_DOMAIN_PADDING1
];
202 char exec_name
[NAME_MAX
];
203 char padding
[LTTNG_DOMAIN_PADDING2
];
208 * Perf counter attributes
210 * The structures should be initialized to zero before use.
212 #define LTTNG_PERF_EVENT_PADDING1 16
213 struct lttng_event_perf_counter_ctx
{
216 char name
[LTTNG_SYMBOL_NAME_LEN
];
218 char padding
[LTTNG_PERF_EVENT_PADDING1
];
222 * Event/channel context
224 * The structures should be initialized to zero before use.
226 #define LTTNG_EVENT_CONTEXT_PADDING1 16
227 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
228 struct lttng_event_context
{
229 enum lttng_event_context_type ctx
;
230 char padding
[LTTNG_EVENT_CONTEXT_PADDING1
];
233 struct lttng_event_perf_counter_ctx perf_counter
;
234 char padding
[LTTNG_EVENT_CONTEXT_PADDING2
];
241 * Either addr is used or symbol_name and offset.
243 * The structures should be initialized to zero before use.
245 #define LTTNG_EVENT_PROBE_PADDING1 16
246 struct lttng_event_probe_attr
{
250 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
252 char padding
[LTTNG_EVENT_PROBE_PADDING1
];
258 * The structures should be initialized to zero before use.
260 #define LTTNG_EVENT_FUNCTION_PADDING1 16
261 struct lttng_event_function_attr
{
262 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
264 char padding
[LTTNG_EVENT_FUNCTION_PADDING1
];
268 * Generic lttng event
270 * The structures should be initialized to zero before use.
272 #define LTTNG_EVENT_PADDING1 15
273 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
275 enum lttng_event_type type
;
276 char name
[LTTNG_SYMBOL_NAME_LEN
];
278 enum lttng_loglevel_type loglevel_type
;
281 int32_t enabled
; /* Does not apply: -1 */
283 unsigned char filter
; /* filter enabled ? */
285 char padding
[LTTNG_EVENT_PADDING1
];
287 /* Per event type configuration */
289 struct lttng_event_probe_attr probe
;
290 struct lttng_event_function_attr ftrace
;
292 char padding
[LTTNG_EVENT_PADDING2
];
296 enum lttng_event_field_type
{
297 LTTNG_EVENT_FIELD_OTHER
= 0,
298 LTTNG_EVENT_FIELD_INTEGER
= 1,
299 LTTNG_EVENT_FIELD_ENUM
= 2,
300 LTTNG_EVENT_FIELD_FLOAT
= 3,
301 LTTNG_EVENT_FIELD_STRING
= 4,
304 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
305 struct lttng_event_field
{
306 char field_name
[LTTNG_SYMBOL_NAME_LEN
];
307 enum lttng_event_field_type type
;
308 char padding
[LTTNG_EVENT_FIELD_PADDING
];
309 struct lttng_event event
;
313 * Tracer channel attributes. For both kernel and user-space.
315 * The structures should be initialized to zero before use.
317 #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
318 struct lttng_channel_attr
{
319 int overwrite
; /* 1: overwrite, 0: discard */
320 uint64_t subbuf_size
; /* bytes */
321 uint64_t num_subbuf
; /* power of 2 */
322 unsigned int switch_timer_interval
; /* usec */
323 unsigned int read_timer_interval
; /* usec */
324 enum lttng_event_output output
; /* splice, mmap */
326 char padding
[LTTNG_CHANNEL_ATTR_PADDING1
];
330 * Channel information structure. For both kernel and user-space.
332 * The structures should be initialized to zero before use.
334 #define LTTNG_CHANNEL_PADDING1 16
335 struct lttng_channel
{
336 char name
[LTTNG_SYMBOL_NAME_LEN
];
338 struct lttng_channel_attr attr
;
340 char padding
[LTTNG_CHANNEL_PADDING1
];
343 #define LTTNG_CALIBRATE_PADDING1 16
344 struct lttng_calibrate
{
345 enum lttng_calibrate_type type
;
347 char padding
[LTTNG_CALIBRATE_PADDING1
];
351 * Basic session information.
353 * This is an 'output data' meaning that it only comes *from* the session
354 * daemon *to* the lttng client. It's basically a 'human' representation of
355 * tracing entities (here a session).
357 * The structures should be initialized to zero before use.
359 #define LTTNG_SESSION_PADDING1 16
360 struct lttng_session
{
362 /* The path where traces are written */
364 uint32_t enabled
; /* enabled/started: 1, disabled/stopped: 0 */
366 char padding
[LTTNG_SESSION_PADDING1
];
370 * Handle used as a context for commands.
372 * The structures should be initialized to zero before use.
374 #define LTTNG_HANDLE_PADDING1 16
375 struct lttng_handle
{
376 char session_name
[NAME_MAX
];
377 struct lttng_domain domain
;
379 char padding
[LTTNG_HANDLE_PADDING1
];
383 * Public LTTng control API
385 * For functions having an lttng domain type as parameter, if a bad value is
386 * given, NO default is applied and an error is returned.
388 * On success, all functions of the API return 0 or the size of the allocated
391 * On error, a negative value is returned being a specific lttng-tools error
392 * code which can be humanly interpreted with lttng_strerror(err).
394 * Exceptions to this are noted below.
398 * Create a handle used as a context for every request made to the library.
400 * This handle contains the session name and lttng domain on which the command
402 * The returned pointer will be NULL in case of malloc() error.
404 extern struct lttng_handle
*lttng_create_handle(const char *session_name
,
405 struct lttng_domain
*domain
);
408 * Destroy a handle. This will simply free(3) the data pointer returned by
409 * lttng_create_handle(), rendering it unusable.
411 extern void lttng_destroy_handle(struct lttng_handle
*handle
);
414 * Create a tracing session using a name and a path where the trace will be
417 extern int lttng_create_session(const char *name
, const char *path
);
420 * Create a tracing sessioin using a name, URIs and a consumer enable flag.
421 * The control URI is mandatory for consumer local or network.
423 extern int lttng_create_session_uri(const char *name
,
424 struct lttng_uri
*ctrl_uri
, struct lttng_uri
*data_uri
,
425 unsigned int enable_consumer
);
428 * Destroy a tracing session.
430 * The session will not be usable anymore, tracing will be stopped for all
431 * registered traces, and the tracing buffers will be flushed.
433 extern int lttng_destroy_session(const char *name
);
436 * List all the tracing sessions.
438 * Return the size (number of entries) of the "lttng_session" array. Caller
441 extern int lttng_list_sessions(struct lttng_session
**sessions
);
444 * List the registered domain(s) of a session.
446 * Return the size (number of entries) of the "lttng_domain" array. Caller
449 extern int lttng_list_domains(const char *session_name
,
450 struct lttng_domain
**domains
);
453 * List the channel(s) of a session.
455 * Return the size (number of entries) of the "lttng_channel" array. Caller
458 extern int lttng_list_channels(struct lttng_handle
*handle
,
459 struct lttng_channel
**channels
);
462 * List the event(s) of a session channel.
464 * Return the size (number of entries) of the "lttng_event" array.
465 * Caller must free(3).
467 extern int lttng_list_events(struct lttng_handle
*handle
,
468 const char *channel_name
, struct lttng_event
**events
);
471 * List the available tracepoints of a specific lttng domain.
473 * Return the size (number of entries) of the "lttng_event" array.
474 * Caller must free(3).
476 extern int lttng_list_tracepoints(struct lttng_handle
*handle
,
477 struct lttng_event
**events
);
480 * List the available tracepoints fields of a specific lttng domain.
482 * Return the size (number of entries) of the "lttng_event_field" array.
483 * Caller must free(3).
485 extern int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
486 struct lttng_event_field
**fields
);
489 * Check if a session daemon is alive.
491 * Return 1 if alive or 0 if not. On error returns a negative value.
493 extern int lttng_session_daemon_alive(void);
496 * Set the tracing group for the *current* flow of execution.
498 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
500 extern int lttng_set_tracing_group(const char *name
);
503 * Return a human-readable error message for an lttng-tools error code.
505 * Parameter MUST be a negative value or else you'll get a generic message.
507 extern const char *lttng_strerror(int code
);
510 * This call registers an "outside consumer" for a session and an lttng domain.
511 * No consumer will be spawned and all fds/commands will go through the socket
512 * path given (socket_path).
514 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
515 * command socket. The error socket is not supported yet for roaming consumers.
517 extern int lttng_register_consumer(struct lttng_handle
*handle
,
518 const char *socket_path
);
521 * Start tracing for *all* registered traces (kernel and user-space).
523 extern int lttng_start_tracing(const char *session_name
);
526 * Stop tracing for *all* registered traces (kernel and user-space).
528 extern int lttng_stop_tracing(const char *session_name
);
531 * Add context to event(s) for a specific channel (or for all).
533 * If event_name is NULL, the context is applied to all events of the channel.
534 * If channel_name is NULL, a lookup of the event's channel is done.
535 * If both are NULL, the context is applied to all events of all channels.
537 extern int lttng_add_context(struct lttng_handle
*handle
,
538 struct lttng_event_context
*ctx
, const char *event_name
,
539 const char *channel_name
);
542 * Create or enable an event (or events) for a channel.
544 * If the event you are trying to enable does not exist, it will be created,
545 * else it is enabled.
546 * If event_name is NULL, all events are enabled.
547 * If channel_name is NULL, the default channel is used (channel0).
549 extern int lttng_enable_event(struct lttng_handle
*handle
,
550 struct lttng_event
*ev
, const char *channel_name
);
553 * Apply a filter expression to an event.
555 * If event_name is NULL, the filter is applied to all events of the channel.
556 * If channel_name is NULL, a lookup of the event's channel is done.
557 * If both are NULL, the filter is applied to all events of all channels.
559 extern int lttng_set_event_filter(struct lttng_handle
*handle
,
560 const char *event_name
,
561 const char *channel_name
,
562 const char *filter_expression
);
564 * Create or enable a channel.
565 * The channel name cannot be NULL.
567 extern int lttng_enable_channel(struct lttng_handle
*handle
,
568 struct lttng_channel
*chan
);
571 * Disable event(s) of a channel and domain.
573 * If event_name is NULL, all events are disabled.
574 * If channel_name is NULL, the default channel is used (channel0).
576 extern int lttng_disable_event(struct lttng_handle
*handle
,
577 const char *name
, const char *channel_name
);
582 * The channel name cannot be NULL.
584 extern int lttng_disable_channel(struct lttng_handle
*handle
,
588 * Calibrate LTTng overhead.
590 extern int lttng_calibrate(struct lttng_handle
*handle
,
591 struct lttng_calibrate
*calibrate
);
594 * Set the default channel attributes for a specific domain and an allocated
595 * lttng_channel_attr pointer.
597 * If either or both of the arguments are NULL, nothing happens.
599 extern void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
600 struct lttng_channel_attr
*attr
);
603 * Set URI for a consumer for a session and domain.
605 * For network streaming, both data and control stream type MUST be defined
606 * with a specific URIs. Default port are 5342 and 5343 respectively for
607 * control and data which uses the TCP protocol.
609 extern int lttng_set_consumer_uri(struct lttng_handle
*handle
,
610 struct lttng_uri
*uri
);
613 * Enable the consumer for a session and domain.
615 extern int lttng_enable_consumer(struct lttng_handle
*handle
);
618 * Disable consumer for a session and domain.
620 extern int lttng_disable_consumer(struct lttng_handle
*handle
);
622 #endif /* _LTTNG_H */