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 /* Health component for the health check function. */
135 enum lttng_health_component
{
137 LTTNG_HEALTH_APP_MANAGE
,
138 LTTNG_HEALTH_APP_REG
,
140 LTTNG_HEALTH_CONSUMER
,
144 /* Destination type of lttng URI */
145 enum lttng_dst_type
{
151 /* Type of lttng URI where it is a final destination or a hop */
152 enum lttng_uri_type
{
153 LTTNG_URI_DST
, /* The URI is a final destination */
155 * Hop are not supported yet but planned for a future release.
161 /* Communication stream type of a lttng URI */
162 enum lttng_stream_type
{
163 LTTNG_STREAM_CONTROL
,
168 * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
171 enum lttng_proto_type
{
174 * UDP protocol is not supported for now.
181 * Structure representing an URI supported by lttng.
183 #define LTTNG_URI_PADDING1_LEN 16
184 #define LTTNG_URI_PADDING2_LEN LTTNG_SYMBOL_NAME_LEN + 32
186 enum lttng_dst_type dtype
;
187 enum lttng_uri_type utype
;
188 enum lttng_stream_type stype
;
189 enum lttng_proto_type proto
;
191 char padding
[LTTNG_URI_PADDING1_LEN
];
192 char subdir
[PATH_MAX
];
194 char ipv4
[INET_ADDRSTRLEN
];
195 char ipv6
[INET6_ADDRSTRLEN
];
197 char padding
[LTTNG_URI_PADDING2_LEN
];
202 * The structures should be initialized to zero before use.
204 #define LTTNG_DOMAIN_PADDING1 16
205 #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
206 struct lttng_domain
{
207 enum lttng_domain_type type
;
208 char padding
[LTTNG_DOMAIN_PADDING1
];
212 char exec_name
[NAME_MAX
];
213 char padding
[LTTNG_DOMAIN_PADDING2
];
218 * Perf counter attributes
220 * The structures should be initialized to zero before use.
222 #define LTTNG_PERF_EVENT_PADDING1 16
223 struct lttng_event_perf_counter_ctx
{
226 char name
[LTTNG_SYMBOL_NAME_LEN
];
228 char padding
[LTTNG_PERF_EVENT_PADDING1
];
232 * Event/channel context
234 * The structures should be initialized to zero before use.
236 #define LTTNG_EVENT_CONTEXT_PADDING1 16
237 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
238 struct lttng_event_context
{
239 enum lttng_event_context_type ctx
;
240 char padding
[LTTNG_EVENT_CONTEXT_PADDING1
];
243 struct lttng_event_perf_counter_ctx perf_counter
;
244 char padding
[LTTNG_EVENT_CONTEXT_PADDING2
];
251 * Either addr is used or symbol_name and offset.
253 * The structures should be initialized to zero before use.
255 #define LTTNG_EVENT_PROBE_PADDING1 16
256 struct lttng_event_probe_attr
{
260 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
262 char padding
[LTTNG_EVENT_PROBE_PADDING1
];
268 * The structures should be initialized to zero before use.
270 #define LTTNG_EVENT_FUNCTION_PADDING1 16
271 struct lttng_event_function_attr
{
272 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
274 char padding
[LTTNG_EVENT_FUNCTION_PADDING1
];
278 * Generic lttng event
280 * The structures should be initialized to zero before use.
282 #define LTTNG_EVENT_PADDING1 15
283 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
285 enum lttng_event_type type
;
286 char name
[LTTNG_SYMBOL_NAME_LEN
];
288 enum lttng_loglevel_type loglevel_type
;
291 int32_t enabled
; /* Does not apply: -1 */
293 unsigned char filter
; /* filter enabled ? */
295 char padding
[LTTNG_EVENT_PADDING1
];
297 /* Per event type configuration */
299 struct lttng_event_probe_attr probe
;
300 struct lttng_event_function_attr ftrace
;
302 char padding
[LTTNG_EVENT_PADDING2
];
306 enum lttng_event_field_type
{
307 LTTNG_EVENT_FIELD_OTHER
= 0,
308 LTTNG_EVENT_FIELD_INTEGER
= 1,
309 LTTNG_EVENT_FIELD_ENUM
= 2,
310 LTTNG_EVENT_FIELD_FLOAT
= 3,
311 LTTNG_EVENT_FIELD_STRING
= 4,
314 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
315 struct lttng_event_field
{
316 char field_name
[LTTNG_SYMBOL_NAME_LEN
];
317 enum lttng_event_field_type type
;
318 char padding
[LTTNG_EVENT_FIELD_PADDING
];
319 struct lttng_event event
;
323 * Tracer channel attributes. For both kernel and user-space.
325 * The structures should be initialized to zero before use.
327 #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
328 struct lttng_channel_attr
{
329 int overwrite
; /* 1: overwrite, 0: discard */
330 uint64_t subbuf_size
; /* bytes */
331 uint64_t num_subbuf
; /* power of 2 */
332 unsigned int switch_timer_interval
; /* usec */
333 unsigned int read_timer_interval
; /* usec */
334 enum lttng_event_output output
; /* splice, mmap */
336 char padding
[LTTNG_CHANNEL_ATTR_PADDING1
];
340 * Channel information structure. For both kernel and user-space.
342 * The structures should be initialized to zero before use.
344 #define LTTNG_CHANNEL_PADDING1 16
345 struct lttng_channel
{
346 char name
[LTTNG_SYMBOL_NAME_LEN
];
348 struct lttng_channel_attr attr
;
350 char padding
[LTTNG_CHANNEL_PADDING1
];
353 #define LTTNG_CALIBRATE_PADDING1 16
354 struct lttng_calibrate
{
355 enum lttng_calibrate_type type
;
357 char padding
[LTTNG_CALIBRATE_PADDING1
];
361 * Basic session information.
363 * This is an 'output data' meaning that it only comes *from* the session
364 * daemon *to* the lttng client. It's basically a 'human' representation of
365 * tracing entities (here a session).
367 * The structures should be initialized to zero before use.
369 #define LTTNG_SESSION_PADDING1 16
370 struct lttng_session
{
372 /* The path where traces are written */
374 uint32_t enabled
; /* enabled/started: 1, disabled/stopped: 0 */
376 char padding
[LTTNG_SESSION_PADDING1
];
380 * Handle used as a context for commands.
382 * The structures should be initialized to zero before use.
384 #define LTTNG_HANDLE_PADDING1 16
385 struct lttng_handle
{
386 char session_name
[NAME_MAX
];
387 struct lttng_domain domain
;
389 char padding
[LTTNG_HANDLE_PADDING1
];
393 * Public LTTng control API
395 * For functions having an lttng domain type as parameter, if a bad value is
396 * given, NO default is applied and an error is returned.
398 * On success, all functions of the API return 0 or the size of the allocated
401 * On error, a negative value is returned being a specific lttng-tools error
402 * code which can be humanly interpreted with lttng_strerror(err).
404 * Exceptions to this are noted below.
408 * Create a handle used as a context for every request made to the library.
410 * This handle contains the session name and lttng domain on which the command
412 * The returned pointer will be NULL in case of malloc() error.
414 extern struct lttng_handle
*lttng_create_handle(const char *session_name
,
415 struct lttng_domain
*domain
);
418 * Destroy a handle. This will simply free(3) the data pointer returned by
419 * lttng_create_handle(), rendering it unusable.
421 extern void lttng_destroy_handle(struct lttng_handle
*handle
);
424 * Create a tracing session using a name and a path where the trace will be
427 extern int lttng_create_session(const char *name
, const char *path
);
430 * Create a tracing sessioin using a name, URIs and a consumer enable flag.
431 * The control URI is mandatory for consumer local or network.
433 extern int lttng_create_session_uri(const char *name
,
434 struct lttng_uri
*ctrl_uri
, struct lttng_uri
*data_uri
,
435 unsigned int enable_consumer
);
438 * Destroy a tracing session.
440 * The session will not be usable anymore, tracing will be stopped for all
441 * registered traces, and the tracing buffers will be flushed.
443 extern int lttng_destroy_session(const char *name
);
446 * List all the tracing sessions.
448 * Return the size (number of entries) of the "lttng_session" array. Caller
451 extern int lttng_list_sessions(struct lttng_session
**sessions
);
454 * List the registered domain(s) of a session.
456 * Return the size (number of entries) of the "lttng_domain" array. Caller
459 extern int lttng_list_domains(const char *session_name
,
460 struct lttng_domain
**domains
);
463 * List the channel(s) of a session.
465 * Return the size (number of entries) of the "lttng_channel" array. Caller
468 extern int lttng_list_channels(struct lttng_handle
*handle
,
469 struct lttng_channel
**channels
);
472 * List the event(s) of a session channel.
474 * Return the size (number of entries) of the "lttng_event" array.
475 * Caller must free(3).
477 extern int lttng_list_events(struct lttng_handle
*handle
,
478 const char *channel_name
, struct lttng_event
**events
);
481 * List the available tracepoints of a specific lttng domain.
483 * Return the size (number of entries) of the "lttng_event" array.
484 * Caller must free(3).
486 extern int lttng_list_tracepoints(struct lttng_handle
*handle
,
487 struct lttng_event
**events
);
490 * List the available tracepoints fields of a specific lttng domain.
492 * Return the size (number of entries) of the "lttng_event_field" array.
493 * Caller must free(3).
495 extern int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
496 struct lttng_event_field
**fields
);
499 * Check if a session daemon is alive.
501 * Return 1 if alive or 0 if not. On error returns a negative value.
503 extern int lttng_session_daemon_alive(void);
506 * Set the tracing group for the *current* flow of execution.
508 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
510 extern int lttng_set_tracing_group(const char *name
);
513 * Return a human-readable error message for an lttng-tools error code.
515 * Parameter MUST be a negative value or else you'll get a generic message.
517 extern const char *lttng_strerror(int code
);
520 * This call registers an "outside consumer" for a session and an lttng domain.
521 * No consumer will be spawned and all fds/commands will go through the socket
522 * path given (socket_path).
524 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
525 * command socket. The error socket is not supported yet for roaming consumers.
527 extern int lttng_register_consumer(struct lttng_handle
*handle
,
528 const char *socket_path
);
531 * Start tracing for *all* registered traces (kernel and user-space).
533 extern int lttng_start_tracing(const char *session_name
);
536 * Stop tracing for *all* registered traces (kernel and user-space).
538 extern int lttng_stop_tracing(const char *session_name
);
541 * Add context to event(s) for a specific channel (or for all).
543 * If event_name is NULL, the context is applied to all events of the channel.
544 * If channel_name is NULL, a lookup of the event's channel is done.
545 * If both are NULL, the context is applied to all events of all channels.
547 extern int lttng_add_context(struct lttng_handle
*handle
,
548 struct lttng_event_context
*ctx
, const char *event_name
,
549 const char *channel_name
);
552 * Create or enable an event (or events) for a channel.
554 * If the event you are trying to enable does not exist, it will be created,
555 * else it is enabled.
556 * If event_name is NULL, all events are enabled.
557 * If channel_name is NULL, the default channel is used (channel0).
559 extern int lttng_enable_event(struct lttng_handle
*handle
,
560 struct lttng_event
*ev
, const char *channel_name
);
563 * Apply a filter expression to an event.
565 * If event_name is NULL, the filter is applied to all events of the channel.
566 * If channel_name is NULL, a lookup of the event's channel is done.
567 * If both are NULL, the filter is applied to all events of all channels.
569 extern int lttng_set_event_filter(struct lttng_handle
*handle
,
570 const char *event_name
,
571 const char *channel_name
,
572 const char *filter_expression
);
574 * Create or enable a channel.
575 * The channel name cannot be NULL.
577 extern int lttng_enable_channel(struct lttng_handle
*handle
,
578 struct lttng_channel
*chan
);
581 * Disable event(s) of a channel and domain.
583 * If event_name is NULL, all events are disabled.
584 * If channel_name is NULL, the default channel is used (channel0).
586 extern int lttng_disable_event(struct lttng_handle
*handle
,
587 const char *name
, const char *channel_name
);
592 * The channel name cannot be NULL.
594 extern int lttng_disable_channel(struct lttng_handle
*handle
,
598 * Calibrate LTTng overhead.
600 extern int lttng_calibrate(struct lttng_handle
*handle
,
601 struct lttng_calibrate
*calibrate
);
604 * Set the default channel attributes for a specific domain and an allocated
605 * lttng_channel_attr pointer.
607 * If either or both of the arguments are NULL, nothing happens.
609 extern void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
610 struct lttng_channel_attr
*attr
);
613 * Set URI for a consumer for a session and domain.
615 * For network streaming, both data and control stream type MUST be defined
616 * with a specific URIs. Default port are 5342 and 5343 respectively for
617 * control and data which uses the TCP protocol.
619 extern int lttng_set_consumer_uri(struct lttng_handle
*handle
,
620 struct lttng_uri
*uri
);
623 * Enable the consumer for a session and domain.
625 extern int lttng_enable_consumer(struct lttng_handle
*handle
);
628 * Disable consumer for a session and domain.
630 extern int lttng_disable_consumer(struct lttng_handle
*handle
);
633 * Check session daemon health for a specific component.
635 * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
636 * the control library was not able to connect to the session daemon health
639 * Any other positive value is an lttcomm error which can be translate with
642 extern int lttng_health_check(enum lttng_health_component c
);
644 #endif /* _LTTNG_H */