Fix: lttng UST and kernel consumer: fix ret vs errno mixup
[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
TD
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 as published by the
10 * Free Software Foundation; only version 2.1 of the License.
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
8d326ab9
DG
127#define LTTNG_DOMAIN_PADDING1 16
128#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
9f19cc17
DG
129struct lttng_domain {
130 enum lttng_domain_type type;
8d326ab9
DG
131 char padding[LTTNG_DOMAIN_PADDING1];
132
9f19cc17
DG
133 union {
134 pid_t pid;
135 char exec_name[NAME_MAX];
8d326ab9 136 char padding[LTTNG_DOMAIN_PADDING2];
9f19cc17
DG
137 } attr;
138};
139
d65106b1 140/* Perf counter attributes */
8d326ab9 141#define LTTNG_PERF_EVENT_PADDING1 16
7d29a247 142struct lttng_event_perf_counter_ctx {
d65106b1
DG
143 uint32_t type;
144 uint64_t config;
145 char name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
146
147 char padding[LTTNG_PERF_EVENT_PADDING1];
d65106b1
DG
148};
149
150/* Event/Channel context */
8d326ab9
DG
151#define LTTNG_EVENT_CONTEXT_PADDING1 16
152#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
7d29a247
DG
153struct lttng_event_context {
154 enum lttng_event_context_type ctx;
8d326ab9
DG
155 char padding[LTTNG_EVENT_CONTEXT_PADDING1];
156
d65106b1 157 union {
7d29a247 158 struct lttng_event_perf_counter_ctx perf_counter;
8d326ab9 159 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
d65106b1
DG
160 } u;
161};
162
b7384347 163/*
7d29a247
DG
164 * Event probe.
165 *
166 * Either addr is used or symbol_name and offset.
57167058 167 */
8d326ab9 168#define LTTNG_EVENT_PROBE_PADDING1 16
7d29a247 169struct lttng_event_probe_attr {
f3ed775e
DG
170 uint64_t addr;
171
172 uint64_t offset;
173 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
174
175 char padding[LTTNG_EVENT_PROBE_PADDING1];
57167058
DG
176};
177
b7384347 178/*
f3ed775e
DG
179 * Function tracer
180 */
8d326ab9 181#define LTTNG_EVENT_FUNCTION_PADDING1 16
f3ed775e
DG
182struct lttng_event_function_attr {
183 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
184
185 char padding[LTTNG_EVENT_FUNCTION_PADDING1];
f3ed775e
DG
186};
187
188/*
189 * Generic lttng event
190 */
8d326ab9
DG
191#define LTTNG_EVENT_PADDING1 16
192#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 193struct lttng_event {
0cda4f28 194 enum lttng_event_type type;
f3ed775e 195 char name[LTTNG_SYMBOL_NAME_LEN];
0cda4f28
MD
196
197 enum lttng_loglevel_type loglevel_type;
8005f29a 198 int loglevel;
0cda4f28 199
9f19cc17 200 uint32_t enabled;
b551a063 201 pid_t pid;
8d326ab9
DG
202
203 char padding[LTTNG_EVENT_PADDING1];
204
f3ed775e
DG
205 /* Per event type configuration */
206 union {
7d29a247 207 struct lttng_event_probe_attr probe;
f3ed775e 208 struct lttng_event_function_attr ftrace;
8d326ab9
DG
209
210 char padding[LTTNG_EVENT_PADDING2];
f3ed775e
DG
211 } attr;
212};
213
e6ddca71
DG
214/*
215 * Tracer channel attributes. For both kernel and user-space.
216 */
8d326ab9 217#define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 218struct lttng_channel_attr {
8ce37aa5
DG
219 int overwrite; /* 1: overwrite, 0: discard */
220 uint64_t subbuf_size; /* bytes */
221 uint64_t num_subbuf; /* power of 2 */
222 unsigned int switch_timer_interval; /* usec */
223 unsigned int read_timer_interval; /* usec */
f05b5f07 224 enum lttng_event_output output; /* splice, mmap */
8d326ab9
DG
225
226 char padding[LTTNG_CHANNEL_ATTR_PADDING1];
f3ed775e
DG
227};
228
229/*
e6ddca71 230 * Channel information structure. For both kernel and user-space.
1657e9bb 231 */
8d326ab9 232#define LTTNG_CHANNEL_PADDING1 16
e6ddca71 233struct lttng_channel {
045e5491 234 char name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 235 uint32_t enabled;
e6ddca71 236 struct lttng_channel_attr attr;
8d326ab9
DG
237
238 char padding[LTTNG_CHANNEL_PADDING1];
f3ed775e
DG
239};
240
8d326ab9 241#define LTTNG_CALIBRATE_PADDING1 16
d0254c7c
MD
242struct lttng_calibrate {
243 enum lttng_calibrate_type type;
8d326ab9
DG
244
245 char padding[LTTNG_CALIBRATE_PADDING1];
d0254c7c
MD
246};
247
e6ddca71
DG
248/*
249 * Basic session information.
250 *
251 * This is an 'output data' meaning that it only comes *from* the session
252 * daemon *to* the lttng client. It's basically a 'human' representation of
253 * tracing entities (here a session).
254 */
8d326ab9 255#define LTTNG_SESSION_PADDING1 16
e6ddca71 256struct lttng_session {
f3ed775e 257 char name[NAME_MAX];
e6ddca71
DG
258 /* The path where traces are written */
259 char path[PATH_MAX];
464dd62d 260 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
8d326ab9
DG
261
262 char padding[LTTNG_SESSION_PADDING1];
1657e9bb
DG
263};
264
cd80958d
DG
265/*
266 * Handle used as a context for commands.
267 */
8d326ab9 268#define LTTNG_HANDLE_PADDING1 16
cd80958d
DG
269struct lttng_handle {
270 char session_name[NAME_MAX];
271 struct lttng_domain domain;
8d326ab9
DG
272
273 char padding[LTTNG_HANDLE_PADDING1];
cd80958d
DG
274};
275
7d29a247
DG
276/*
277 * Public LTTng control API
278 *
1e46a50f 279 * For functions having an lttng domain type as parameter, if a bad value is
7d29a247
DG
280 * given, NO default is applied and an error is returned.
281 *
282 * On success, all functions of the API return 0 or the size of the allocated
1e46a50f 283 * array (in bytes).
7d29a247
DG
284 *
285 * On error, a negative value is returned being a specific lttng-tools error
9a745bc7 286 * code which can be humanly interpreted with lttng_strerror(err).
1e46a50f
TD
287 *
288 * Exceptions to this are noted below.
7d29a247
DG
289 */
290
b7384347 291/*
1e46a50f 292 * Create a handle used as a context for every request made to the library.
cd80958d
DG
293 *
294 * This handle contains the session name and lttng domain on which the command
1e46a50f
TD
295 * will be executed.
296 * The returned pointer will be NULL in case of malloc() error.
cd80958d
DG
297 */
298extern struct lttng_handle *lttng_create_handle(const char *session_name,
299 struct lttng_domain *domain);
300
301/*
1e46a50f
TD
302 * Destroy a handle. This will simply free(3) the data pointer returned by
303 * lttng_create_handle(), rendering it unusable.
b7384347 304 */
cd80958d 305extern void lttng_destroy_handle(struct lttng_handle *handle);
7d29a247
DG
306
307/*
1e46a50f
TD
308 * Create a tracing session using a name and a path where the trace will be
309 * written.
7d29a247 310 */
38057ed1 311extern int lttng_create_session(const char *name, const char *path);
f3ed775e 312
7d29a247 313/*
1e46a50f 314 * Destroy a tracing session.
7d29a247 315 *
1e46a50f
TD
316 * The session will not be usable anymore, tracing will be stopped for all
317 * registered traces, and the tracing buffers will be flushed.
7d29a247 318 */
843f5df9 319extern int lttng_destroy_session(const char *name);
f3ed775e 320
e6ddca71 321/*
1e46a50f 322 * List all the tracing sessions.
7d29a247 323 *
1e46a50f
TD
324 * Return the size (number of entries) of the "lttng_session" array. Caller
325 * must free(3).
e6ddca71 326 */
ca95a216 327extern int lttng_list_sessions(struct lttng_session **sessions);
f3ed775e 328
9f19cc17 329/*
1e46a50f 330 * List the registered domain(s) of a session.
9f19cc17 331 *
1e46a50f
TD
332 * Return the size (number of entries) of the "lttng_domain" array. Caller
333 * must free(3).
9f19cc17 334 */
330be774 335extern int lttng_list_domains(const char *session_name,
9f19cc17
DG
336 struct lttng_domain **domains);
337
338/*
1e46a50f 339 * List the channel(s) of a session.
9f19cc17 340 *
1e46a50f
TD
341 * Return the size (number of entries) of the "lttng_channel" array. Caller
342 * must free(3).
9f19cc17 343 */
cd80958d
DG
344extern int lttng_list_channels(struct lttng_handle *handle,
345 struct lttng_channel **channels);
9f19cc17
DG
346
347/*
1e46a50f 348 * List the event(s) of a session channel.
9f19cc17 349 *
1e46a50f
TD
350 * Return the size (number of entries) of the "lttng_event" array.
351 * Caller must free(3).
9f19cc17 352 */
cd80958d
DG
353extern int lttng_list_events(struct lttng_handle *handle,
354 const char *channel_name, struct lttng_event **events);
9f19cc17
DG
355
356/*
1e46a50f 357 * List the available tracepoints of a specific lttng domain.
9f19cc17 358 *
1e46a50f
TD
359 * Return the size (number of entries) of the "lttng_event" array.
360 * Caller must free(3).
9f19cc17 361 */
cd80958d 362extern int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 363 struct lttng_event **events);
9f19cc17 364
7d29a247
DG
365/*
366 * Check if a session daemon is alive.
1e46a50f
TD
367 *
368 * Return 1 if alive or 0 if not. On error returns a negative value.
7d29a247 369 */
947308c4 370extern int lttng_session_daemon_alive(void);
f3ed775e 371
7d29a247 372/*
1e46a50f
TD
373 * Set the tracing group for the *current* flow of execution.
374 *
375 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
7d29a247 376 */
b7384347 377extern int lttng_set_tracing_group(const char *name);
f3ed775e 378
7d29a247 379/*
1e46a50f 380 * Return a human-readable error message for an lttng-tools error code.
7d29a247
DG
381 *
382 * Parameter MUST be a negative value or else you'll get a generic message.
383 */
9a745bc7 384extern const char *lttng_strerror(int code);
b7384347 385
d9800920 386/*
1e46a50f
TD
387 * This call registers an "outside consumer" for a session and an lttng domain.
388 * No consumer will be spawned and all fds/commands will go through the socket
389 * path given (socket_path).
d9800920 390 *
3bd1e081 391 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
d9800920
DG
392 * command socket. The error socket is not supported yet for roaming consumers.
393 */
394extern int lttng_register_consumer(struct lttng_handle *handle,
395 const char *socket_path);
396
7d29a247 397/*
1e46a50f 398 * Start tracing for *all* registered traces (kernel and user-space).
7d29a247 399 */
6a4f824d 400extern int lttng_start_tracing(const char *session_name);
f3ed775e 401
7d29a247 402/*
1e46a50f 403 * Stop tracing for *all* registered traces (kernel and user-space).
7d29a247 404 */
6a4f824d 405extern int lttng_stop_tracing(const char *session_name);
f3ed775e 406
b7384347 407/*
1e46a50f 408 * Add context to event(s) for a specific channel (or for all).
7d29a247 409 *
1e46a50f 410 * If event_name is NULL, the context is applied to all events of the channel.
7d29a247 411 * If channel_name is NULL, a lookup of the event's channel is done.
1e46a50f 412 * If both are NULL, the context is applied to all events of all channels.
b7384347 413 */
cd80958d 414extern int lttng_add_context(struct lttng_handle *handle,
38057ed1
DG
415 struct lttng_event_context *ctx, const char *event_name,
416 const char *channel_name);
f3ed775e 417
7d29a247 418/*
1e46a50f 419 * Create or enable a kernel event (or events) for a channel.
7d29a247
DG
420 *
421 * If the event you are trying to enable does not exist, it will be created,
422 * else it is enabled.
1e46a50f 423 * If event_name is NULL, all events are enabled.
7d29a247
DG
424 * If channel_name is NULL, the default channel is used (channel0).
425 */
cd80958d
DG
426extern int lttng_enable_event(struct lttng_handle *handle,
427 struct lttng_event *ev, const char *channel_name);
f3ed775e 428
7d29a247
DG
429/*
430 * Create or enable a kernel channel.
1e46a50f 431 * The channel name cannot be NULL.
7d29a247 432 */
cd80958d 433extern int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 434 struct lttng_channel *chan);
f3ed775e 435
7d29a247 436/*
1e46a50f 437 * Disable kernel event(s) of a channel and domain.
7d29a247 438 *
1e46a50f 439 * If event_name is NULL, all events are disabled.
7d29a247
DG
440 * If channel_name is NULL, the default channel is used (channel0).
441 */
cd80958d
DG
442extern int lttng_disable_event(struct lttng_handle *handle,
443 const char *name, const char *channel_name);
fac6795d 444
1df4dedd 445/*
7d29a247
DG
446 * Disable kernel channel.
447 *
1e46a50f 448 * The channel name cannot be NULL.
1df4dedd 449 */
cd80958d 450extern int lttng_disable_channel(struct lttng_handle *handle,
38057ed1 451 const char *name);
1df4dedd 452
d0254c7c
MD
453/*
454 * Calibrate LTTng overhead.
455 */
cd80958d 456extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
457 struct lttng_calibrate *calibrate);
458
5edd7e09
DG
459/*
460 * Set the default channel attributes for a specific domain and an allocated
461 * lttng_channel_attr pointer.
1e46a50f
TD
462 *
463 * If either or both of the arguments are NULL, nothing happens.
5edd7e09
DG
464 */
465extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
466 struct lttng_channel_attr *attr);
467
b7384347 468#endif /* _LTTNG_H */
This page took 0.079221 seconds and 4 git commands to generate.