Add CMD_WARNING error code
[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 *
82a3637f
DG
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; only
11 * version 2.1 of the License.
12 *
13 * This library is distributed in the hope that it will be useful,
fac6795d 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
82a3637f
DG
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
fac6795d
DG
21 */
22
b7384347
DG
23#ifndef _LTTNG_H
24#define _LTTNG_H
fac6795d 25
57167058 26#include <limits.h>
1e307fab
DG
27#include <stdint.h>
28#include <sys/types.h>
57167058 29
b7384347 30/*
e6ddca71 31 * Event symbol length. Copied from LTTng kernel ABI.
1657e9bb 32 */
0a31fd3c 33#define LTTNG_SYMBOL_NAME_LEN 256
f3ed775e 34
e6ddca71
DG
35/*
36 * Every lttng_event_* structure both apply to kernel event and user-space
37 * event.
e6ddca71
DG
38 */
39
7d29a247
DG
40/*
41 * Domain type are the different possible tracers.
42 */
43enum lttng_domain_type {
0d0c377a
DG
44 LTTNG_DOMAIN_KERNEL = 1,
45 LTTNG_DOMAIN_UST = 2,
d78d6610
DG
46
47 /*
48 * For now, the domains below are not implemented. However, we keep them
49 * here in order to retain their enum values for future development. Note
50 * that it is on the roadmap to implement them.
51 *
0d0c377a
DG
52 LTTNG_DOMAIN_UST_EXEC_NAME = 3,
53 LTTNG_DOMAIN_UST_PID = 4,
54 LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5,
d78d6610 55 */
7d29a247
DG
56};
57
7d29a247
DG
58/*
59 * Instrumentation type of tracing event.
60 */
f3ed775e 61enum lttng_event_type {
7a3d1328
MD
62 LTTNG_EVENT_ALL = -1,
63 LTTNG_EVENT_TRACEPOINT = 0,
64 LTTNG_EVENT_PROBE = 1,
65 LTTNG_EVENT_FUNCTION = 2,
66 LTTNG_EVENT_FUNCTION_ENTRY = 3,
67 LTTNG_EVENT_NOOP = 4,
68 LTTNG_EVENT_SYSCALL = 5,
81afa345 69 LTTNG_EVENT_TRACEPOINT_LOGLEVEL = 6,
1657e9bb
DG
70};
71
e6ddca71
DG
72/*
73 * LTTng consumer mode
74 */
75enum lttng_event_output {
d78d6610
DG
76 LTTNG_EVENT_SPLICE = 0,
77 LTTNG_EVENT_MMAP = 1,
e6ddca71
DG
78};
79
7d29a247
DG
80/* Event context possible type */
81enum lttng_event_context_type {
d78d6610
DG
82 LTTNG_EVENT_CONTEXT_PID = 0,
83 LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1,
84 LTTNG_EVENT_CONTEXT_COMM = 2,
85 LTTNG_EVENT_CONTEXT_PRIO = 3,
86 LTTNG_EVENT_CONTEXT_NICE = 4,
87 LTTNG_EVENT_CONTEXT_VPID = 5,
88 LTTNG_EVENT_CONTEXT_TID = 6,
89 LTTNG_EVENT_CONTEXT_VTID = 7,
90 LTTNG_EVENT_CONTEXT_PPID = 8,
91 LTTNG_EVENT_CONTEXT_VPPID = 9,
d65106b1
DG
92};
93
d0254c7c 94enum lttng_calibrate_type {
d78d6610 95 LTTNG_CALIBRATE_FUNCTION = 0,
d0254c7c
MD
96};
97
9f19cc17
DG
98struct lttng_domain {
99 enum lttng_domain_type type;
100 union {
101 pid_t pid;
102 char exec_name[NAME_MAX];
103 } attr;
104};
105
d65106b1 106/* Perf counter attributes */
7d29a247 107struct lttng_event_perf_counter_ctx {
d65106b1
DG
108 uint32_t type;
109 uint64_t config;
110 char name[LTTNG_SYMBOL_NAME_LEN];
111};
112
113/* Event/Channel context */
7d29a247
DG
114struct lttng_event_context {
115 enum lttng_event_context_type ctx;
d65106b1 116 union {
7d29a247 117 struct lttng_event_perf_counter_ctx perf_counter;
d65106b1
DG
118 } u;
119};
120
b7384347 121/*
7d29a247
DG
122 * Event probe.
123 *
124 * Either addr is used or symbol_name and offset.
57167058 125 */
7d29a247 126struct lttng_event_probe_attr {
f3ed775e
DG
127 uint64_t addr;
128
129 uint64_t offset;
130 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
57167058
DG
131};
132
b7384347 133/*
f3ed775e
DG
134 * Function tracer
135 */
136struct lttng_event_function_attr {
137 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
138};
139
140/*
141 * Generic lttng event
142 */
143struct lttng_event {
144 char name[LTTNG_SYMBOL_NAME_LEN];
81afa345 145 char loglevel[LTTNG_SYMBOL_NAME_LEN];
e4baff1e 146 int64_t loglevel_value;
f3ed775e 147 enum lttng_event_type type;
9f19cc17 148 uint32_t enabled;
b551a063 149 pid_t pid;
f3ed775e
DG
150 /* Per event type configuration */
151 union {
7d29a247 152 struct lttng_event_probe_attr probe;
f3ed775e
DG
153 struct lttng_event_function_attr ftrace;
154 } attr;
155};
156
e6ddca71
DG
157/*
158 * Tracer channel attributes. For both kernel and user-space.
159 */
f3ed775e 160struct lttng_channel_attr {
8ce37aa5
DG
161 int overwrite; /* 1: overwrite, 0: discard */
162 uint64_t subbuf_size; /* bytes */
163 uint64_t num_subbuf; /* power of 2 */
164 unsigned int switch_timer_interval; /* usec */
165 unsigned int read_timer_interval; /* usec */
f05b5f07 166 enum lttng_event_output output; /* splice, mmap */
f3ed775e
DG
167};
168
169/*
e6ddca71 170 * Channel information structure. For both kernel and user-space.
1657e9bb 171 */
e6ddca71 172struct lttng_channel {
045e5491 173 char name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 174 uint32_t enabled;
e6ddca71 175 struct lttng_channel_attr attr;
f3ed775e
DG
176};
177
d0254c7c
MD
178struct lttng_calibrate {
179 enum lttng_calibrate_type type;
180};
181
e6ddca71
DG
182/*
183 * Basic session information.
184 *
185 * This is an 'output data' meaning that it only comes *from* the session
186 * daemon *to* the lttng client. It's basically a 'human' representation of
187 * tracing entities (here a session).
188 */
189struct lttng_session {
f3ed775e 190 char name[NAME_MAX];
e6ddca71
DG
191 /* The path where traces are written */
192 char path[PATH_MAX];
464dd62d 193 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
1657e9bb
DG
194};
195
cd80958d
DG
196/*
197 * Handle used as a context for commands.
198 */
199struct lttng_handle {
200 char session_name[NAME_MAX];
201 struct lttng_domain domain;
202};
203
7d29a247
DG
204/*
205 * Public LTTng control API
206 *
207 * For functions having a lttng domain type as parameter, if a bad value is
208 * given, NO default is applied and an error is returned.
209 *
210 * On success, all functions of the API return 0 or the size of the allocated
211 * array.
212 *
213 * On error, a negative value is returned being a specific lttng-tools error
9a745bc7 214 * code which can be humanly interpreted with lttng_strerror(err).
7d29a247
DG
215 */
216
b7384347 217/*
cd80958d
DG
218 * Create an handle used as a context for every request made to the library.
219 *
220 * This handle contains the session name and lttng domain on which the command
221 * will be executed on.
222 */
223extern struct lttng_handle *lttng_create_handle(const char *session_name,
224 struct lttng_domain *domain);
225
226/*
227 * Destroy an handle. This will simply free(3) the data pointer returned by
228 * lttng_create_handle() and rendering it unsuable.
b7384347 229 */
cd80958d 230extern void lttng_destroy_handle(struct lttng_handle *handle);
7d29a247
DG
231
232/*
233 * Create tracing session using a name and a path where trace will be written.
234 */
38057ed1 235extern int lttng_create_session(const char *name, const char *path);
f3ed775e 236
7d29a247
DG
237/*
238 * Destroy tracing session.
239 *
240 * The session will not be useable anymore, tracing will stopped for all
241 * registered trace and tracing buffers will be flushed.
242 */
843f5df9 243extern int lttng_destroy_session(const char *name);
f3ed775e 244
e6ddca71 245/*
9f19cc17 246 * List all tracing sessions.
7d29a247 247 *
9f19cc17 248 * Return the size of the "lttng_session" array. Caller must free(3).
e6ddca71 249 */
ca95a216 250extern int lttng_list_sessions(struct lttng_session **sessions);
f3ed775e 251
9f19cc17 252/*
2a71efd5 253 * List registered domain(s) of a session.
9f19cc17
DG
254 *
255 * Return the size of the "lttng_domain" array. Caller must free(3).
256 */
330be774 257extern int lttng_list_domains(const char *session_name,
9f19cc17
DG
258 struct lttng_domain **domains);
259
260/*
261 * List channel(s) of a session.
262 *
263 * Return the size of the "lttng_channel" array. Caller must free(3).
264 */
cd80958d
DG
265extern int lttng_list_channels(struct lttng_handle *handle,
266 struct lttng_channel **channels);
9f19cc17
DG
267
268/*
269 * List event(s) of a session channel.
270 *
271 * Return the size of the "lttng_event" array. Caller must free(3).
272 */
cd80958d
DG
273extern int lttng_list_events(struct lttng_handle *handle,
274 const char *channel_name, struct lttng_event **events);
9f19cc17
DG
275
276/*
cd80958d 277 * List available tracepoints of a specific lttng domain.
9f19cc17
DG
278 *
279 * Return the size of the "lttng_event" array. Caller must free(3).
280 */
cd80958d 281extern int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 282 struct lttng_event **events);
9f19cc17 283
7d29a247
DG
284/*
285 * Check if a session daemon is alive.
286 */
947308c4 287extern int lttng_session_daemon_alive(void);
f3ed775e 288
7d29a247
DG
289/*
290 * Set tracing group for the *current* flow of execution.
291 */
b7384347 292extern int lttng_set_tracing_group(const char *name);
f3ed775e 293
7d29a247
DG
294/*
295 * Return a human readable error message of a lttng-tools error code.
296 *
297 * Parameter MUST be a negative value or else you'll get a generic message.
298 */
9a745bc7 299extern const char *lttng_strerror(int code);
b7384347 300
d9800920
DG
301/*
302 * This call permits to register an "outside consumer" to a session and a lttng
303 * domain. No consumer will be spawned and all fds/commands will go through the
304 * socket path given (socket_path).
305 *
3bd1e081 306 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
d9800920
DG
307 * command socket. The error socket is not supported yet for roaming consumers.
308 */
309extern int lttng_register_consumer(struct lttng_handle *handle,
310 const char *socket_path);
311
7d29a247
DG
312/*
313 * Start tracing for *all* registered trace (kernel and user-space).
314 */
6a4f824d 315extern int lttng_start_tracing(const char *session_name);
f3ed775e 316
7d29a247
DG
317/*
318 * Stop tracing for *all* registered trace (kernel and user-space).
319 */
6a4f824d 320extern int lttng_stop_tracing(const char *session_name);
f3ed775e 321
b7384347 322/*
7d29a247
DG
323 * Add context to event for a specific channel.
324 *
325 * If event_name is NULL, the context is applied to all event of the channel.
326 * If channel_name is NULL, a lookup of the event's channel is done.
327 * If both are NULL, the context is applied on all events of all channels.
b7384347 328 */
cd80958d 329extern int lttng_add_context(struct lttng_handle *handle,
38057ed1
DG
330 struct lttng_event_context *ctx, const char *event_name,
331 const char *channel_name);
f3ed775e 332
7d29a247
DG
333/*
334 * Create or enable a kernel event.
335 *
336 * If the event you are trying to enable does not exist, it will be created,
337 * else it is enabled.
338 *
339 * If channel_name is NULL, the default channel is used (channel0).
340 */
cd80958d
DG
341extern int lttng_enable_event(struct lttng_handle *handle,
342 struct lttng_event *ev, const char *channel_name);
f3ed775e 343
7d29a247
DG
344/*
345 * Create or enable a kernel channel.
346 *
347 * If name is NULL, the default channel is enabled (channel0).
348 */
cd80958d 349extern int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 350 struct lttng_channel *chan);
f3ed775e 351
7d29a247
DG
352/*
353 * Disable kernel event.
354 *
355 * If channel_name is NULL, the default channel is used (channel0).
356 */
cd80958d
DG
357extern int lttng_disable_event(struct lttng_handle *handle,
358 const char *name, const char *channel_name);
fac6795d 359
1df4dedd 360/*
7d29a247
DG
361 * Disable kernel channel.
362 *
363 * If channel_name is NULL, the default channel is disabled (channel0).
1df4dedd 364 */
cd80958d 365extern int lttng_disable_channel(struct lttng_handle *handle,
38057ed1 366 const char *name);
1df4dedd 367
d0254c7c
MD
368/*
369 * Calibrate LTTng overhead.
370 */
cd80958d 371extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
372 struct lttng_calibrate *calibrate);
373
5edd7e09
DG
374/*
375 * Set the default channel attributes for a specific domain and an allocated
376 * lttng_channel_attr pointer.
377 */
378extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
379 struct lttng_channel_attr *attr);
380
b7384347 381#endif /* _LTTNG_H */
This page took 0.067419 seconds and 4 git commands to generate.