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 16
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 */
284 char padding
[LTTNG_EVENT_PADDING1
];
286 /* Per event type configuration */
288 struct lttng_event_probe_attr probe
;
289 struct lttng_event_function_attr ftrace
;
291 char padding
[LTTNG_EVENT_PADDING2
];
295 enum lttng_event_field_type
{
296 LTTNG_EVENT_FIELD_OTHER
= 0,
297 LTTNG_EVENT_FIELD_INTEGER
= 1,
298 LTTNG_EVENT_FIELD_ENUM
= 2,
299 LTTNG_EVENT_FIELD_FLOAT
= 3,
300 LTTNG_EVENT_FIELD_STRING
= 4,
303 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
304 struct lttng_event_field
{
305 char field_name
[LTTNG_SYMBOL_NAME_LEN
];
306 enum lttng_event_field_type type
;
307 char padding
[LTTNG_EVENT_FIELD_PADDING
];
308 struct lttng_event event
;
312 * Tracer channel attributes. For both kernel and user-space.
314 * The structures should be initialized to zero before use.
316 #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
317 struct lttng_channel_attr
{
318 int overwrite
; /* 1: overwrite, 0: discard */
319 uint64_t subbuf_size
; /* bytes */
320 uint64_t num_subbuf
; /* power of 2 */
321 unsigned int switch_timer_interval
; /* usec */
322 unsigned int read_timer_interval
; /* usec */
323 enum lttng_event_output output
; /* splice, mmap */
325 char padding
[LTTNG_CHANNEL_ATTR_PADDING1
];
329 * Channel information structure. For both kernel and user-space.
331 * The structures should be initialized to zero before use.
333 #define LTTNG_CHANNEL_PADDING1 16
334 struct lttng_channel
{
335 char name
[LTTNG_SYMBOL_NAME_LEN
];
337 struct lttng_channel_attr attr
;
339 char padding
[LTTNG_CHANNEL_PADDING1
];
342 #define LTTNG_CALIBRATE_PADDING1 16
343 struct lttng_calibrate
{
344 enum lttng_calibrate_type type
;
346 char padding
[LTTNG_CALIBRATE_PADDING1
];
350 * Basic session information.
352 * This is an 'output data' meaning that it only comes *from* the session
353 * daemon *to* the lttng client. It's basically a 'human' representation of
354 * tracing entities (here a session).
356 * The structures should be initialized to zero before use.
358 #define LTTNG_SESSION_PADDING1 16
359 struct lttng_session
{
361 /* The path where traces are written */
363 uint32_t enabled
; /* enabled/started: 1, disabled/stopped: 0 */
365 char padding
[LTTNG_SESSION_PADDING1
];
369 * Handle used as a context for commands.
371 * The structures should be initialized to zero before use.
373 #define LTTNG_HANDLE_PADDING1 16
374 struct lttng_handle
{
375 char session_name
[NAME_MAX
];
376 struct lttng_domain domain
;
378 char padding
[LTTNG_HANDLE_PADDING1
];
382 * Public LTTng control API
384 * For functions having an lttng domain type as parameter, if a bad value is
385 * given, NO default is applied and an error is returned.
387 * On success, all functions of the API return 0 or the size of the allocated
390 * On error, a negative value is returned being a specific lttng-tools error
391 * code which can be humanly interpreted with lttng_strerror(err).
393 * Exceptions to this are noted below.
397 * Create a handle used as a context for every request made to the library.
399 * This handle contains the session name and lttng domain on which the command
401 * The returned pointer will be NULL in case of malloc() error.
403 extern struct lttng_handle
*lttng_create_handle(const char *session_name
,
404 struct lttng_domain
*domain
);
407 * Destroy a handle. This will simply free(3) the data pointer returned by
408 * lttng_create_handle(), rendering it unusable.
410 extern void lttng_destroy_handle(struct lttng_handle
*handle
);
413 * Create a tracing session using a name and a path where the trace will be
416 extern int lttng_create_session(const char *name
, const char *path
);
419 * Create a tracing sessioin using a name, URIs and a consumer enable flag.
420 * The control URI is mandatory for consumer local or network.
422 extern int lttng_create_session_uri(const char *name
,
423 struct lttng_uri
*ctrl_uri
, struct lttng_uri
*data_uri
,
424 unsigned int enable_consumer
);
427 * Destroy a tracing session.
429 * The session will not be usable anymore, tracing will be stopped for all
430 * registered traces, and the tracing buffers will be flushed.
432 extern int lttng_destroy_session(const char *name
);
435 * List all the tracing sessions.
437 * Return the size (number of entries) of the "lttng_session" array. Caller
440 extern int lttng_list_sessions(struct lttng_session
**sessions
);
443 * List the registered domain(s) of a session.
445 * Return the size (number of entries) of the "lttng_domain" array. Caller
448 extern int lttng_list_domains(const char *session_name
,
449 struct lttng_domain
**domains
);
452 * List the channel(s) of a session.
454 * Return the size (number of entries) of the "lttng_channel" array. Caller
457 extern int lttng_list_channels(struct lttng_handle
*handle
,
458 struct lttng_channel
**channels
);
461 * List the event(s) of a session channel.
463 * Return the size (number of entries) of the "lttng_event" array.
464 * Caller must free(3).
466 extern int lttng_list_events(struct lttng_handle
*handle
,
467 const char *channel_name
, struct lttng_event
**events
);
470 * List the available tracepoints of a specific lttng domain.
472 * Return the size (number of entries) of the "lttng_event" array.
473 * Caller must free(3).
475 extern int lttng_list_tracepoints(struct lttng_handle
*handle
,
476 struct lttng_event
**events
);
479 * List the available tracepoints fields of a specific lttng domain.
481 * Return the size (number of entries) of the "lttng_event_field" array.
482 * Caller must free(3).
484 extern int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
485 struct lttng_event_field
**fields
);
488 * Check if a session daemon is alive.
490 * Return 1 if alive or 0 if not. On error returns a negative value.
492 extern int lttng_session_daemon_alive(void);
495 * Set the tracing group for the *current* flow of execution.
497 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
499 extern int lttng_set_tracing_group(const char *name
);
502 * Return a human-readable error message for an lttng-tools error code.
504 * Parameter MUST be a negative value or else you'll get a generic message.
506 extern const char *lttng_strerror(int code
);
509 * This call registers an "outside consumer" for a session and an lttng domain.
510 * No consumer will be spawned and all fds/commands will go through the socket
511 * path given (socket_path).
513 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
514 * command socket. The error socket is not supported yet for roaming consumers.
516 extern int lttng_register_consumer(struct lttng_handle
*handle
,
517 const char *socket_path
);
520 * Start tracing for *all* registered traces (kernel and user-space).
522 extern int lttng_start_tracing(const char *session_name
);
525 * Stop tracing for *all* registered traces (kernel and user-space).
527 extern int lttng_stop_tracing(const char *session_name
);
530 * Add context to event(s) for a specific channel (or for all).
532 * If event_name is NULL, the context is applied to all events of the channel.
533 * If channel_name is NULL, a lookup of the event's channel is done.
534 * If both are NULL, the context is applied to all events of all channels.
536 extern int lttng_add_context(struct lttng_handle
*handle
,
537 struct lttng_event_context
*ctx
, const char *event_name
,
538 const char *channel_name
);
541 * Create or enable an event (or events) for a channel.
543 * If the event you are trying to enable does not exist, it will be created,
544 * else it is enabled.
545 * If event_name is NULL, all events are enabled.
546 * If channel_name is NULL, the default channel is used (channel0).
548 extern int lttng_enable_event(struct lttng_handle
*handle
,
549 struct lttng_event
*ev
, const char *channel_name
);
552 * Create or enable a channel.
553 * The channel name cannot be NULL.
555 extern int lttng_enable_channel(struct lttng_handle
*handle
,
556 struct lttng_channel
*chan
);
559 * Disable event(s) of a channel and domain.
561 * If event_name is NULL, all events are disabled.
562 * If channel_name is NULL, the default channel is used (channel0).
564 extern int lttng_disable_event(struct lttng_handle
*handle
,
565 const char *name
, const char *channel_name
);
570 * The channel name cannot be NULL.
572 extern int lttng_disable_channel(struct lttng_handle
*handle
,
576 * Calibrate LTTng overhead.
578 extern int lttng_calibrate(struct lttng_handle
*handle
,
579 struct lttng_calibrate
*calibrate
);
582 * Set the default channel attributes for a specific domain and an allocated
583 * lttng_channel_attr pointer.
585 * If either or both of the arguments are NULL, nothing happens.
587 extern void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
588 struct lttng_channel_attr
*attr
);
591 * Set URI for a consumer for a session and domain.
593 * For network streaming, both data and control stream type MUST be defined
594 * with a specific URIs. Default port are 5342 and 5343 respectively for
595 * control and data which uses the TCP protocol.
597 extern int lttng_set_consumer_uri(struct lttng_handle
*handle
,
598 struct lttng_uri
*uri
);
601 * Enable the consumer for a session and domain.
603 extern int lttng_enable_consumer(struct lttng_handle
*handle
);
606 * Disable consumer for a session and domain.
608 extern int lttng_disable_consumer(struct lttng_handle
*handle
);
610 #endif /* _LTTNG_H */