Update lttng-ust-abi.h for event field listing
[lttng-tools.git] / include / lttng / lttng.h
CommitLineData
826d496d 1/*
b7384347
DG
2 * lttng.h
3 *
4 * Linux Trace Toolkit Control Library Header File
5 *
826d496d 6 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
fac6795d 7 *
1e46a50f 8 * This library is free software; you can redistribute it and/or modify it
d14d33bf
AM
9 * under the terms of the GNU Lesser General Public License, version 2.1 only,
10 * as published by the Free Software Foundation.
82a3637f 11 *
1e46a50f
TD
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
15 * for more details.
82a3637f 16 *
1e46a50f
TD
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
fac6795d
DG
20 */
21
b7384347
DG
22#ifndef _LTTNG_H
23#define _LTTNG_H
fac6795d 24
57167058 25#include <limits.h>
1e307fab
DG
26#include <stdint.h>
27#include <sys/types.h>
57167058 28
b7384347 29/*
e6ddca71 30 * Event symbol length. Copied from LTTng kernel ABI.
1657e9bb 31 */
8d326ab9 32#define LTTNG_SYMBOL_NAME_LEN 256
f3ed775e 33
e6ddca71
DG
34/*
35 * Every lttng_event_* structure both apply to kernel event and user-space
36 * event.
e6ddca71
DG
37 */
38
7d29a247 39/*
1e46a50f 40 * Domain types: the different possible tracers.
7d29a247
DG
41 */
42enum lttng_domain_type {
0d0c377a
DG
43 LTTNG_DOMAIN_KERNEL = 1,
44 LTTNG_DOMAIN_UST = 2,
d78d6610
DG
45
46 /*
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.
50 *
0d0c377a
DG
51 LTTNG_DOMAIN_UST_EXEC_NAME = 3,
52 LTTNG_DOMAIN_UST_PID = 4,
53 LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5,
d78d6610 54 */
7d29a247
DG
55};
56
7d29a247
DG
57/*
58 * Instrumentation type of tracing event.
59 */
f3ed775e 60enum lttng_event_type {
7a3d1328
MD
61 LTTNG_EVENT_ALL = -1,
62 LTTNG_EVENT_TRACEPOINT = 0,
63 LTTNG_EVENT_PROBE = 1,
64 LTTNG_EVENT_FUNCTION = 2,
65 LTTNG_EVENT_FUNCTION_ENTRY = 3,
66 LTTNG_EVENT_NOOP = 4,
67 LTTNG_EVENT_SYSCALL = 5,
0cda4f28
MD
68};
69
70/*
71 * Loglevel information.
72 */
73enum lttng_loglevel_type {
8005f29a
MD
74 LTTNG_EVENT_LOGLEVEL_ALL = 0,
75 LTTNG_EVENT_LOGLEVEL_RANGE = 1,
76 LTTNG_EVENT_LOGLEVEL_SINGLE = 2,
1657e9bb
DG
77};
78
46839cc2
MD
79/*
80 * Available loglevels.
81 */
82enum lttng_loglevel {
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,
98};
99
e6ddca71
DG
100/*
101 * LTTng consumer mode
102 */
103enum lttng_event_output {
d78d6610
DG
104 LTTNG_EVENT_SPLICE = 0,
105 LTTNG_EVENT_MMAP = 1,
e6ddca71
DG
106};
107
7d29a247
DG
108/* Event context possible type */
109enum lttng_event_context_type {
d78d6610
DG
110 LTTNG_EVENT_CONTEXT_PID = 0,
111 LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1,
9197c5c4 112 LTTNG_EVENT_CONTEXT_PROCNAME = 2,
d78d6610
DG
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,
9197c5c4 120 LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
d65106b1
DG
121};
122
d0254c7c 123enum lttng_calibrate_type {
d78d6610 124 LTTNG_CALIBRATE_FUNCTION = 0,
d0254c7c
MD
125};
126
ece640c8
RB
127/*
128 * The structures should be initialized to zero before use.
129 */
8d326ab9
DG
130#define LTTNG_DOMAIN_PADDING1 16
131#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
9f19cc17
DG
132struct lttng_domain {
133 enum lttng_domain_type type;
8d326ab9
DG
134 char padding[LTTNG_DOMAIN_PADDING1];
135
9f19cc17
DG
136 union {
137 pid_t pid;
138 char exec_name[NAME_MAX];
8d326ab9 139 char padding[LTTNG_DOMAIN_PADDING2];
9f19cc17
DG
140 } attr;
141};
142
ece640c8
RB
143/*
144 * Perf counter attributes
145 *
146 * The structures should be initialized to zero before use.
147 */
8d326ab9 148#define LTTNG_PERF_EVENT_PADDING1 16
7d29a247 149struct lttng_event_perf_counter_ctx {
d65106b1
DG
150 uint32_t type;
151 uint64_t config;
152 char name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
153
154 char padding[LTTNG_PERF_EVENT_PADDING1];
d65106b1
DG
155};
156
ece640c8
RB
157/*
158 * Event/channel context
159 *
160 * The structures should be initialized to zero before use.
161 */
8d326ab9
DG
162#define LTTNG_EVENT_CONTEXT_PADDING1 16
163#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
7d29a247
DG
164struct lttng_event_context {
165 enum lttng_event_context_type ctx;
8d326ab9
DG
166 char padding[LTTNG_EVENT_CONTEXT_PADDING1];
167
d65106b1 168 union {
7d29a247 169 struct lttng_event_perf_counter_ctx perf_counter;
8d326ab9 170 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
d65106b1
DG
171 } u;
172};
173
b7384347 174/*
7d29a247
DG
175 * Event probe.
176 *
177 * Either addr is used or symbol_name and offset.
ece640c8
RB
178 *
179 * The structures should be initialized to zero before use.
57167058 180 */
8d326ab9 181#define LTTNG_EVENT_PROBE_PADDING1 16
7d29a247 182struct lttng_event_probe_attr {
f3ed775e
DG
183 uint64_t addr;
184
185 uint64_t offset;
186 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
187
188 char padding[LTTNG_EVENT_PROBE_PADDING1];
57167058
DG
189};
190
b7384347 191/*
f3ed775e 192 * Function tracer
ece640c8
RB
193 *
194 * The structures should be initialized to zero before use.
f3ed775e 195 */
8d326ab9 196#define LTTNG_EVENT_FUNCTION_PADDING1 16
f3ed775e
DG
197struct lttng_event_function_attr {
198 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
199
200 char padding[LTTNG_EVENT_FUNCTION_PADDING1];
f3ed775e
DG
201};
202
203/*
204 * Generic lttng event
ece640c8
RB
205 *
206 * The structures should be initialized to zero before use.
f3ed775e 207 */
8d326ab9
DG
208#define LTTNG_EVENT_PADDING1 16
209#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 210struct lttng_event {
0cda4f28 211 enum lttng_event_type type;
f3ed775e 212 char name[LTTNG_SYMBOL_NAME_LEN];
0cda4f28
MD
213
214 enum lttng_loglevel_type loglevel_type;
8005f29a 215 int loglevel;
0cda4f28 216
9f19cc17 217 uint32_t enabled;
b551a063 218 pid_t pid;
8d326ab9
DG
219
220 char padding[LTTNG_EVENT_PADDING1];
221
f3ed775e
DG
222 /* Per event type configuration */
223 union {
7d29a247 224 struct lttng_event_probe_attr probe;
f3ed775e 225 struct lttng_event_function_attr ftrace;
8d326ab9
DG
226
227 char padding[LTTNG_EVENT_PADDING2];
f3ed775e
DG
228 } attr;
229};
230
e6ddca71
DG
231/*
232 * Tracer channel attributes. For both kernel and user-space.
ece640c8
RB
233 *
234 * The structures should be initialized to zero before use.
e6ddca71 235 */
8d326ab9 236#define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 237struct lttng_channel_attr {
8ce37aa5
DG
238 int overwrite; /* 1: overwrite, 0: discard */
239 uint64_t subbuf_size; /* bytes */
240 uint64_t num_subbuf; /* power of 2 */
241 unsigned int switch_timer_interval; /* usec */
242 unsigned int read_timer_interval; /* usec */
f05b5f07 243 enum lttng_event_output output; /* splice, mmap */
8d326ab9
DG
244
245 char padding[LTTNG_CHANNEL_ATTR_PADDING1];
f3ed775e
DG
246};
247
248/*
e6ddca71 249 * Channel information structure. For both kernel and user-space.
ece640c8
RB
250 *
251 * The structures should be initialized to zero before use.
1657e9bb 252 */
8d326ab9 253#define LTTNG_CHANNEL_PADDING1 16
e6ddca71 254struct lttng_channel {
045e5491 255 char name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 256 uint32_t enabled;
e6ddca71 257 struct lttng_channel_attr attr;
8d326ab9
DG
258
259 char padding[LTTNG_CHANNEL_PADDING1];
f3ed775e
DG
260};
261
8d326ab9 262#define LTTNG_CALIBRATE_PADDING1 16
d0254c7c
MD
263struct lttng_calibrate {
264 enum lttng_calibrate_type type;
8d326ab9
DG
265
266 char padding[LTTNG_CALIBRATE_PADDING1];
d0254c7c
MD
267};
268
e6ddca71
DG
269/*
270 * Basic session information.
271 *
272 * This is an 'output data' meaning that it only comes *from* the session
273 * daemon *to* the lttng client. It's basically a 'human' representation of
274 * tracing entities (here a session).
ece640c8
RB
275 *
276 * The structures should be initialized to zero before use.
e6ddca71 277 */
8d326ab9 278#define LTTNG_SESSION_PADDING1 16
e6ddca71 279struct lttng_session {
f3ed775e 280 char name[NAME_MAX];
e6ddca71
DG
281 /* The path where traces are written */
282 char path[PATH_MAX];
464dd62d 283 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
8d326ab9
DG
284
285 char padding[LTTNG_SESSION_PADDING1];
1657e9bb
DG
286};
287
cd80958d
DG
288/*
289 * Handle used as a context for commands.
ece640c8
RB
290 *
291 * The structures should be initialized to zero before use.
cd80958d 292 */
8d326ab9 293#define LTTNG_HANDLE_PADDING1 16
cd80958d
DG
294struct lttng_handle {
295 char session_name[NAME_MAX];
296 struct lttng_domain domain;
8d326ab9
DG
297
298 char padding[LTTNG_HANDLE_PADDING1];
cd80958d
DG
299};
300
7d29a247
DG
301/*
302 * Public LTTng control API
303 *
1e46a50f 304 * For functions having an lttng domain type as parameter, if a bad value is
7d29a247
DG
305 * given, NO default is applied and an error is returned.
306 *
307 * On success, all functions of the API return 0 or the size of the allocated
1e46a50f 308 * array (in bytes).
7d29a247
DG
309 *
310 * On error, a negative value is returned being a specific lttng-tools error
9a745bc7 311 * code which can be humanly interpreted with lttng_strerror(err).
1e46a50f
TD
312 *
313 * Exceptions to this are noted below.
7d29a247
DG
314 */
315
b7384347 316/*
1e46a50f 317 * Create a handle used as a context for every request made to the library.
cd80958d
DG
318 *
319 * This handle contains the session name and lttng domain on which the command
1e46a50f
TD
320 * will be executed.
321 * The returned pointer will be NULL in case of malloc() error.
cd80958d
DG
322 */
323extern struct lttng_handle *lttng_create_handle(const char *session_name,
324 struct lttng_domain *domain);
325
326/*
1e46a50f
TD
327 * Destroy a handle. This will simply free(3) the data pointer returned by
328 * lttng_create_handle(), rendering it unusable.
b7384347 329 */
cd80958d 330extern void lttng_destroy_handle(struct lttng_handle *handle);
7d29a247
DG
331
332/*
1e46a50f
TD
333 * Create a tracing session using a name and a path where the trace will be
334 * written.
7d29a247 335 */
38057ed1 336extern int lttng_create_session(const char *name, const char *path);
f3ed775e 337
7d29a247 338/*
1e46a50f 339 * Destroy a tracing session.
7d29a247 340 *
1e46a50f
TD
341 * The session will not be usable anymore, tracing will be stopped for all
342 * registered traces, and the tracing buffers will be flushed.
7d29a247 343 */
843f5df9 344extern int lttng_destroy_session(const char *name);
f3ed775e 345
e6ddca71 346/*
1e46a50f 347 * List all the tracing sessions.
7d29a247 348 *
1e46a50f
TD
349 * Return the size (number of entries) of the "lttng_session" array. Caller
350 * must free(3).
e6ddca71 351 */
ca95a216 352extern int lttng_list_sessions(struct lttng_session **sessions);
f3ed775e 353
9f19cc17 354/*
1e46a50f 355 * List the registered domain(s) of a session.
9f19cc17 356 *
1e46a50f
TD
357 * Return the size (number of entries) of the "lttng_domain" array. Caller
358 * must free(3).
9f19cc17 359 */
330be774 360extern int lttng_list_domains(const char *session_name,
9f19cc17
DG
361 struct lttng_domain **domains);
362
363/*
1e46a50f 364 * List the channel(s) of a session.
9f19cc17 365 *
1e46a50f
TD
366 * Return the size (number of entries) of the "lttng_channel" array. Caller
367 * must free(3).
9f19cc17 368 */
cd80958d
DG
369extern int lttng_list_channels(struct lttng_handle *handle,
370 struct lttng_channel **channels);
9f19cc17
DG
371
372/*
1e46a50f 373 * List the event(s) of a session channel.
9f19cc17 374 *
1e46a50f
TD
375 * Return the size (number of entries) of the "lttng_event" array.
376 * Caller must free(3).
9f19cc17 377 */
cd80958d
DG
378extern int lttng_list_events(struct lttng_handle *handle,
379 const char *channel_name, struct lttng_event **events);
9f19cc17
DG
380
381/*
1e46a50f 382 * List the available tracepoints of a specific lttng domain.
9f19cc17 383 *
1e46a50f
TD
384 * Return the size (number of entries) of the "lttng_event" array.
385 * Caller must free(3).
9f19cc17 386 */
cd80958d 387extern int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 388 struct lttng_event **events);
9f19cc17 389
7d29a247
DG
390/*
391 * Check if a session daemon is alive.
1e46a50f
TD
392 *
393 * Return 1 if alive or 0 if not. On error returns a negative value.
7d29a247 394 */
947308c4 395extern int lttng_session_daemon_alive(void);
f3ed775e 396
7d29a247 397/*
1e46a50f
TD
398 * Set the tracing group for the *current* flow of execution.
399 *
400 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
7d29a247 401 */
b7384347 402extern int lttng_set_tracing_group(const char *name);
f3ed775e 403
7d29a247 404/*
1e46a50f 405 * Return a human-readable error message for an lttng-tools error code.
7d29a247
DG
406 *
407 * Parameter MUST be a negative value or else you'll get a generic message.
408 */
9a745bc7 409extern const char *lttng_strerror(int code);
b7384347 410
d9800920 411/*
1e46a50f
TD
412 * This call registers an "outside consumer" for a session and an lttng domain.
413 * No consumer will be spawned and all fds/commands will go through the socket
414 * path given (socket_path).
d9800920 415 *
3bd1e081 416 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
d9800920
DG
417 * command socket. The error socket is not supported yet for roaming consumers.
418 */
419extern int lttng_register_consumer(struct lttng_handle *handle,
420 const char *socket_path);
421
7d29a247 422/*
1e46a50f 423 * Start tracing for *all* registered traces (kernel and user-space).
7d29a247 424 */
6a4f824d 425extern int lttng_start_tracing(const char *session_name);
f3ed775e 426
7d29a247 427/*
1e46a50f 428 * Stop tracing for *all* registered traces (kernel and user-space).
7d29a247 429 */
6a4f824d 430extern int lttng_stop_tracing(const char *session_name);
f3ed775e 431
b7384347 432/*
1e46a50f 433 * Add context to event(s) for a specific channel (or for all).
7d29a247 434 *
1e46a50f 435 * If event_name is NULL, the context is applied to all events of the channel.
7d29a247 436 * If channel_name is NULL, a lookup of the event's channel is done.
1e46a50f 437 * If both are NULL, the context is applied to all events of all channels.
b7384347 438 */
cd80958d 439extern int lttng_add_context(struct lttng_handle *handle,
38057ed1
DG
440 struct lttng_event_context *ctx, const char *event_name,
441 const char *channel_name);
f3ed775e 442
7d29a247 443/*
c8f61fc6 444 * Create or enable an event (or events) for a channel.
7d29a247
DG
445 *
446 * If the event you are trying to enable does not exist, it will be created,
447 * else it is enabled.
1e46a50f 448 * If event_name is NULL, all events are enabled.
7d29a247
DG
449 * If channel_name is NULL, the default channel is used (channel0).
450 */
cd80958d
DG
451extern int lttng_enable_event(struct lttng_handle *handle,
452 struct lttng_event *ev, const char *channel_name);
f3ed775e 453
7d29a247 454/*
c8f61fc6 455 * Create or enable a channel.
1e46a50f 456 * The channel name cannot be NULL.
7d29a247 457 */
cd80958d 458extern int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 459 struct lttng_channel *chan);
f3ed775e 460
7d29a247 461/*
c8f61fc6 462 * Disable event(s) of a channel and domain.
7d29a247 463 *
1e46a50f 464 * If event_name is NULL, all events are disabled.
7d29a247
DG
465 * If channel_name is NULL, the default channel is used (channel0).
466 */
cd80958d
DG
467extern int lttng_disable_event(struct lttng_handle *handle,
468 const char *name, const char *channel_name);
fac6795d 469
1df4dedd 470/*
c8f61fc6 471 * Disable channel.
7d29a247 472 *
1e46a50f 473 * The channel name cannot be NULL.
1df4dedd 474 */
cd80958d 475extern int lttng_disable_channel(struct lttng_handle *handle,
38057ed1 476 const char *name);
1df4dedd 477
d0254c7c
MD
478/*
479 * Calibrate LTTng overhead.
480 */
cd80958d 481extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
482 struct lttng_calibrate *calibrate);
483
5edd7e09
DG
484/*
485 * Set the default channel attributes for a specific domain and an allocated
486 * lttng_channel_attr pointer.
1e46a50f
TD
487 *
488 * If either or both of the arguments are NULL, nothing happens.
5edd7e09
DG
489 */
490extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
491 struct lttng_channel_attr *attr);
492
b7384347 493#endif /* _LTTNG_H */
This page took 0.127316 seconds and 4 git commands to generate.