Fix memory leak in lttng cli
[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 */
0a31fd3c 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 {
74 LTTNG_EVENT_LOGLEVEL = 0,
75 LTTNG_EVENT_LOGLEVEL_ONLY = 1,
1657e9bb
DG
76};
77
e6ddca71
DG
78/*
79 * LTTng consumer mode
80 */
81enum lttng_event_output {
d78d6610
DG
82 LTTNG_EVENT_SPLICE = 0,
83 LTTNG_EVENT_MMAP = 1,
e6ddca71
DG
84};
85
7d29a247
DG
86/* Event context possible type */
87enum lttng_event_context_type {
d78d6610
DG
88 LTTNG_EVENT_CONTEXT_PID = 0,
89 LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1,
9197c5c4 90 LTTNG_EVENT_CONTEXT_PROCNAME = 2,
d78d6610
DG
91 LTTNG_EVENT_CONTEXT_PRIO = 3,
92 LTTNG_EVENT_CONTEXT_NICE = 4,
93 LTTNG_EVENT_CONTEXT_VPID = 5,
94 LTTNG_EVENT_CONTEXT_TID = 6,
95 LTTNG_EVENT_CONTEXT_VTID = 7,
96 LTTNG_EVENT_CONTEXT_PPID = 8,
97 LTTNG_EVENT_CONTEXT_VPPID = 9,
9197c5c4 98 LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
d65106b1
DG
99};
100
d0254c7c 101enum lttng_calibrate_type {
d78d6610 102 LTTNG_CALIBRATE_FUNCTION = 0,
d0254c7c
MD
103};
104
9f19cc17
DG
105struct lttng_domain {
106 enum lttng_domain_type type;
107 union {
108 pid_t pid;
109 char exec_name[NAME_MAX];
110 } attr;
111};
112
d65106b1 113/* Perf counter attributes */
7d29a247 114struct lttng_event_perf_counter_ctx {
d65106b1
DG
115 uint32_t type;
116 uint64_t config;
117 char name[LTTNG_SYMBOL_NAME_LEN];
118};
119
120/* Event/Channel context */
7d29a247
DG
121struct lttng_event_context {
122 enum lttng_event_context_type ctx;
d65106b1 123 union {
7d29a247 124 struct lttng_event_perf_counter_ctx perf_counter;
d65106b1
DG
125 } u;
126};
127
b7384347 128/*
7d29a247
DG
129 * Event probe.
130 *
131 * Either addr is used or symbol_name and offset.
57167058 132 */
7d29a247 133struct lttng_event_probe_attr {
f3ed775e
DG
134 uint64_t addr;
135
136 uint64_t offset;
137 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
57167058
DG
138};
139
b7384347 140/*
f3ed775e
DG
141 * Function tracer
142 */
143struct lttng_event_function_attr {
144 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
145};
146
147/*
148 * Generic lttng event
149 */
150struct lttng_event {
0cda4f28 151 enum lttng_event_type type;
f3ed775e 152 char name[LTTNG_SYMBOL_NAME_LEN];
0cda4f28
MD
153
154 enum lttng_loglevel_type loglevel_type;
ed7f4083 155 char loglevel[LTTNG_SYMBOL_NAME_LEN]; /* '\0' for all loglevels */
0cda4f28 156
ed7f4083 157 int64_t loglevel_value; /* for printing */
9f19cc17 158 uint32_t enabled;
b551a063 159 pid_t pid;
f3ed775e
DG
160 /* Per event type configuration */
161 union {
7d29a247 162 struct lttng_event_probe_attr probe;
f3ed775e
DG
163 struct lttng_event_function_attr ftrace;
164 } attr;
165};
166
e6ddca71
DG
167/*
168 * Tracer channel attributes. For both kernel and user-space.
169 */
f3ed775e 170struct lttng_channel_attr {
8ce37aa5
DG
171 int overwrite; /* 1: overwrite, 0: discard */
172 uint64_t subbuf_size; /* bytes */
173 uint64_t num_subbuf; /* power of 2 */
174 unsigned int switch_timer_interval; /* usec */
175 unsigned int read_timer_interval; /* usec */
f05b5f07 176 enum lttng_event_output output; /* splice, mmap */
f3ed775e
DG
177};
178
179/*
e6ddca71 180 * Channel information structure. For both kernel and user-space.
1657e9bb 181 */
e6ddca71 182struct lttng_channel {
045e5491 183 char name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 184 uint32_t enabled;
e6ddca71 185 struct lttng_channel_attr attr;
f3ed775e
DG
186};
187
d0254c7c
MD
188struct lttng_calibrate {
189 enum lttng_calibrate_type type;
190};
191
e6ddca71
DG
192/*
193 * Basic session information.
194 *
195 * This is an 'output data' meaning that it only comes *from* the session
196 * daemon *to* the lttng client. It's basically a 'human' representation of
197 * tracing entities (here a session).
198 */
199struct lttng_session {
f3ed775e 200 char name[NAME_MAX];
e6ddca71
DG
201 /* The path where traces are written */
202 char path[PATH_MAX];
464dd62d 203 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
1657e9bb
DG
204};
205
cd80958d
DG
206/*
207 * Handle used as a context for commands.
208 */
209struct lttng_handle {
210 char session_name[NAME_MAX];
211 struct lttng_domain domain;
212};
213
7d29a247
DG
214/*
215 * Public LTTng control API
216 *
1e46a50f 217 * For functions having an lttng domain type as parameter, if a bad value is
7d29a247
DG
218 * given, NO default is applied and an error is returned.
219 *
220 * On success, all functions of the API return 0 or the size of the allocated
1e46a50f 221 * array (in bytes).
7d29a247
DG
222 *
223 * On error, a negative value is returned being a specific lttng-tools error
9a745bc7 224 * code which can be humanly interpreted with lttng_strerror(err).
1e46a50f
TD
225 *
226 * Exceptions to this are noted below.
7d29a247
DG
227 */
228
b7384347 229/*
1e46a50f 230 * Create a handle used as a context for every request made to the library.
cd80958d
DG
231 *
232 * This handle contains the session name and lttng domain on which the command
1e46a50f
TD
233 * will be executed.
234 * The returned pointer will be NULL in case of malloc() error.
cd80958d
DG
235 */
236extern struct lttng_handle *lttng_create_handle(const char *session_name,
237 struct lttng_domain *domain);
238
239/*
1e46a50f
TD
240 * Destroy a handle. This will simply free(3) the data pointer returned by
241 * lttng_create_handle(), rendering it unusable.
b7384347 242 */
cd80958d 243extern void lttng_destroy_handle(struct lttng_handle *handle);
7d29a247
DG
244
245/*
1e46a50f
TD
246 * Create a tracing session using a name and a path where the trace will be
247 * written.
7d29a247 248 */
38057ed1 249extern int lttng_create_session(const char *name, const char *path);
f3ed775e 250
7d29a247 251/*
1e46a50f 252 * Destroy a tracing session.
7d29a247 253 *
1e46a50f
TD
254 * The session will not be usable anymore, tracing will be stopped for all
255 * registered traces, and the tracing buffers will be flushed.
7d29a247 256 */
843f5df9 257extern int lttng_destroy_session(const char *name);
f3ed775e 258
e6ddca71 259/*
1e46a50f 260 * List all the tracing sessions.
7d29a247 261 *
1e46a50f
TD
262 * Return the size (number of entries) of the "lttng_session" array. Caller
263 * must free(3).
e6ddca71 264 */
ca95a216 265extern int lttng_list_sessions(struct lttng_session **sessions);
f3ed775e 266
9f19cc17 267/*
1e46a50f 268 * List the registered domain(s) of a session.
9f19cc17 269 *
1e46a50f
TD
270 * Return the size (number of entries) of the "lttng_domain" array. Caller
271 * must free(3).
9f19cc17 272 */
330be774 273extern int lttng_list_domains(const char *session_name,
9f19cc17
DG
274 struct lttng_domain **domains);
275
276/*
1e46a50f 277 * List the channel(s) of a session.
9f19cc17 278 *
1e46a50f
TD
279 * Return the size (number of entries) of the "lttng_channel" array. Caller
280 * must free(3).
9f19cc17 281 */
cd80958d
DG
282extern int lttng_list_channels(struct lttng_handle *handle,
283 struct lttng_channel **channels);
9f19cc17
DG
284
285/*
1e46a50f 286 * List the event(s) of a session channel.
9f19cc17 287 *
1e46a50f
TD
288 * Return the size (number of entries) of the "lttng_event" array.
289 * Caller must free(3).
9f19cc17 290 */
cd80958d
DG
291extern int lttng_list_events(struct lttng_handle *handle,
292 const char *channel_name, struct lttng_event **events);
9f19cc17
DG
293
294/*
1e46a50f 295 * List the available tracepoints of a specific lttng domain.
9f19cc17 296 *
1e46a50f
TD
297 * Return the size (number of entries) of the "lttng_event" array.
298 * Caller must free(3).
9f19cc17 299 */
cd80958d 300extern int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 301 struct lttng_event **events);
9f19cc17 302
7d29a247
DG
303/*
304 * Check if a session daemon is alive.
1e46a50f
TD
305 *
306 * Return 1 if alive or 0 if not. On error returns a negative value.
7d29a247 307 */
947308c4 308extern int lttng_session_daemon_alive(void);
f3ed775e 309
7d29a247 310/*
1e46a50f
TD
311 * Set the tracing group for the *current* flow of execution.
312 *
313 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
7d29a247 314 */
b7384347 315extern int lttng_set_tracing_group(const char *name);
f3ed775e 316
7d29a247 317/*
1e46a50f 318 * Return a human-readable error message for an lttng-tools error code.
7d29a247
DG
319 *
320 * Parameter MUST be a negative value or else you'll get a generic message.
321 */
9a745bc7 322extern const char *lttng_strerror(int code);
b7384347 323
d9800920 324/*
1e46a50f
TD
325 * This call registers an "outside consumer" for a session and an lttng domain.
326 * No consumer will be spawned and all fds/commands will go through the socket
327 * path given (socket_path).
d9800920 328 *
3bd1e081 329 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
d9800920
DG
330 * command socket. The error socket is not supported yet for roaming consumers.
331 */
332extern int lttng_register_consumer(struct lttng_handle *handle,
333 const char *socket_path);
334
7d29a247 335/*
1e46a50f 336 * Start tracing for *all* registered traces (kernel and user-space).
7d29a247 337 */
6a4f824d 338extern int lttng_start_tracing(const char *session_name);
f3ed775e 339
7d29a247 340/*
1e46a50f 341 * Stop tracing for *all* registered traces (kernel and user-space).
7d29a247 342 */
6a4f824d 343extern int lttng_stop_tracing(const char *session_name);
f3ed775e 344
b7384347 345/*
1e46a50f 346 * Add context to event(s) for a specific channel (or for all).
7d29a247 347 *
1e46a50f 348 * If event_name is NULL, the context is applied to all events of the channel.
7d29a247 349 * If channel_name is NULL, a lookup of the event's channel is done.
1e46a50f 350 * If both are NULL, the context is applied to all events of all channels.
b7384347 351 */
cd80958d 352extern int lttng_add_context(struct lttng_handle *handle,
38057ed1
DG
353 struct lttng_event_context *ctx, const char *event_name,
354 const char *channel_name);
f3ed775e 355
7d29a247 356/*
1e46a50f 357 * Create or enable a kernel event (or events) for a channel.
7d29a247
DG
358 *
359 * If the event you are trying to enable does not exist, it will be created,
360 * else it is enabled.
1e46a50f 361 * If event_name is NULL, all events are enabled.
7d29a247
DG
362 * If channel_name is NULL, the default channel is used (channel0).
363 */
cd80958d
DG
364extern int lttng_enable_event(struct lttng_handle *handle,
365 struct lttng_event *ev, const char *channel_name);
f3ed775e 366
7d29a247
DG
367/*
368 * Create or enable a kernel channel.
1e46a50f 369 * The channel name cannot be NULL.
7d29a247 370 */
cd80958d 371extern int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 372 struct lttng_channel *chan);
f3ed775e 373
7d29a247 374/*
1e46a50f 375 * Disable kernel event(s) of a channel and domain.
7d29a247 376 *
1e46a50f 377 * If event_name is NULL, all events are disabled.
7d29a247
DG
378 * If channel_name is NULL, the default channel is used (channel0).
379 */
cd80958d
DG
380extern int lttng_disable_event(struct lttng_handle *handle,
381 const char *name, const char *channel_name);
fac6795d 382
1df4dedd 383/*
7d29a247
DG
384 * Disable kernel channel.
385 *
1e46a50f 386 * The channel name cannot be NULL.
1df4dedd 387 */
cd80958d 388extern int lttng_disable_channel(struct lttng_handle *handle,
38057ed1 389 const char *name);
1df4dedd 390
d0254c7c
MD
391/*
392 * Calibrate LTTng overhead.
393 */
cd80958d 394extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
395 struct lttng_calibrate *calibrate);
396
5edd7e09
DG
397/*
398 * Set the default channel attributes for a specific domain and an allocated
399 * lttng_channel_attr pointer.
1e46a50f
TD
400 *
401 * If either or both of the arguments are NULL, nothing happens.
5edd7e09
DG
402 */
403extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
404 struct lttng_channel_attr *attr);
405
b7384347 406#endif /* _LTTNG_H */
This page took 0.071473 seconds and 4 git commands to generate.