Commit | Line | Data |
---|---|---|
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 | ||
73db5be4 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 | |
03b1319d DG |
29 | /* Error codes that can be returned by API calls */ |
30 | #include <lttng/lttng-error.h> | |
31 | ||
5168918c DG |
32 | #ifdef __cplusplus |
33 | extern "C" { | |
34 | #endif | |
35 | ||
b7384347 | 36 | /* |
e6ddca71 | 37 | * Event symbol length. Copied from LTTng kernel ABI. |
1657e9bb | 38 | */ |
8d326ab9 | 39 | #define LTTNG_SYMBOL_NAME_LEN 256 |
f3ed775e | 40 | |
e6ddca71 DG |
41 | /* |
42 | * Every lttng_event_* structure both apply to kernel event and user-space | |
43 | * event. | |
e6ddca71 DG |
44 | */ |
45 | ||
7d29a247 | 46 | /* |
1e46a50f | 47 | * Domain types: the different possible tracers. |
7d29a247 DG |
48 | */ |
49 | enum lttng_domain_type { | |
0d0c377a DG |
50 | LTTNG_DOMAIN_KERNEL = 1, |
51 | LTTNG_DOMAIN_UST = 2, | |
d78d6610 DG |
52 | |
53 | /* | |
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. | |
57 | * | |
0d0c377a DG |
58 | LTTNG_DOMAIN_UST_EXEC_NAME = 3, |
59 | LTTNG_DOMAIN_UST_PID = 4, | |
60 | LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5, | |
d78d6610 | 61 | */ |
7d29a247 DG |
62 | }; |
63 | ||
7d29a247 DG |
64 | /* |
65 | * Instrumentation type of tracing event. | |
66 | */ | |
f3ed775e | 67 | enum lttng_event_type { |
7a3d1328 MD |
68 | LTTNG_EVENT_ALL = -1, |
69 | LTTNG_EVENT_TRACEPOINT = 0, | |
70 | LTTNG_EVENT_PROBE = 1, | |
71 | LTTNG_EVENT_FUNCTION = 2, | |
72 | LTTNG_EVENT_FUNCTION_ENTRY = 3, | |
73 | LTTNG_EVENT_NOOP = 4, | |
74 | LTTNG_EVENT_SYSCALL = 5, | |
0cda4f28 MD |
75 | }; |
76 | ||
77 | /* | |
78 | * Loglevel information. | |
79 | */ | |
80 | enum lttng_loglevel_type { | |
8005f29a MD |
81 | LTTNG_EVENT_LOGLEVEL_ALL = 0, |
82 | LTTNG_EVENT_LOGLEVEL_RANGE = 1, | |
83 | LTTNG_EVENT_LOGLEVEL_SINGLE = 2, | |
1657e9bb DG |
84 | }; |
85 | ||
46839cc2 MD |
86 | /* |
87 | * Available loglevels. | |
88 | */ | |
89 | enum lttng_loglevel { | |
00e2e675 DG |
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, | |
46839cc2 MD |
105 | }; |
106 | ||
e6ddca71 DG |
107 | /* |
108 | * LTTng consumer mode | |
109 | */ | |
110 | enum lttng_event_output { | |
d78d6610 DG |
111 | LTTNG_EVENT_SPLICE = 0, |
112 | LTTNG_EVENT_MMAP = 1, | |
e6ddca71 DG |
113 | }; |
114 | ||
7d29a247 DG |
115 | /* Event context possible type */ |
116 | enum lttng_event_context_type { | |
d78d6610 DG |
117 | LTTNG_EVENT_CONTEXT_PID = 0, |
118 | LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, | |
9197c5c4 | 119 | LTTNG_EVENT_CONTEXT_PROCNAME = 2, |
d78d6610 DG |
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, | |
9197c5c4 | 127 | LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10, |
54773d68 | 128 | LTTNG_EVENT_CONTEXT_HOSTNAME = 11, |
d65106b1 DG |
129 | }; |
130 | ||
d0254c7c | 131 | enum lttng_calibrate_type { |
d78d6610 | 132 | LTTNG_CALIBRATE_FUNCTION = 0, |
d0254c7c MD |
133 | }; |
134 | ||
44a5e5eb DG |
135 | /* Health component for the health check function. */ |
136 | enum lttng_health_component { | |
137 | LTTNG_HEALTH_CMD, | |
139ac872 | 138 | LTTNG_HEALTH_APP_MANAGE, |
44a5e5eb DG |
139 | LTTNG_HEALTH_APP_REG, |
140 | LTTNG_HEALTH_KERNEL, | |
141 | LTTNG_HEALTH_CONSUMER, | |
0b2dc8df | 142 | LTTNG_HEALTH_HT_CLEANUP, |
380e8d6f | 143 | LTTNG_HEALTH_APP_MANAGE_NOTIFY, |
12e2b881 | 144 | LTTNG_HEALTH_APP_REG_DISPATCH, |
44a5e5eb DG |
145 | LTTNG_HEALTH_ALL, |
146 | }; | |
147 | ||
7972aab2 DG |
148 | /* Buffer type for a specific domain. */ |
149 | enum lttng_buffer_type { | |
150 | LTTNG_BUFFER_PER_PID, /* Only supported by UST being the default. */ | |
151 | LTTNG_BUFFER_PER_UID, /* Only supported by UST. */ | |
152 | LTTNG_BUFFER_GLOBAL, /* Only supported by the Kernel. */ | |
153 | }; | |
154 | ||
ece640c8 RB |
155 | /* |
156 | * The structures should be initialized to zero before use. | |
157 | */ | |
7972aab2 | 158 | #define LTTNG_DOMAIN_PADDING1 12 |
8d326ab9 | 159 | #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
9f19cc17 DG |
160 | struct lttng_domain { |
161 | enum lttng_domain_type type; | |
7972aab2 | 162 | enum lttng_buffer_type buf_type; |
8d326ab9 DG |
163 | char padding[LTTNG_DOMAIN_PADDING1]; |
164 | ||
9f19cc17 DG |
165 | union { |
166 | pid_t pid; | |
167 | char exec_name[NAME_MAX]; | |
8d326ab9 | 168 | char padding[LTTNG_DOMAIN_PADDING2]; |
9f19cc17 | 169 | } attr; |
54c90d10 | 170 | }; |
9f19cc17 | 171 | |
ece640c8 RB |
172 | /* |
173 | * Perf counter attributes | |
174 | * | |
175 | * The structures should be initialized to zero before use. | |
176 | */ | |
8d326ab9 | 177 | #define LTTNG_PERF_EVENT_PADDING1 16 |
7d29a247 | 178 | struct lttng_event_perf_counter_ctx { |
d65106b1 DG |
179 | uint32_t type; |
180 | uint64_t config; | |
181 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
182 | |
183 | char padding[LTTNG_PERF_EVENT_PADDING1]; | |
54c90d10 | 184 | }; |
d65106b1 | 185 | |
ece640c8 RB |
186 | /* |
187 | * Event/channel context | |
188 | * | |
189 | * The structures should be initialized to zero before use. | |
190 | */ | |
8d326ab9 DG |
191 | #define LTTNG_EVENT_CONTEXT_PADDING1 16 |
192 | #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 | |
7d29a247 DG |
193 | struct lttng_event_context { |
194 | enum lttng_event_context_type ctx; | |
8d326ab9 DG |
195 | char padding[LTTNG_EVENT_CONTEXT_PADDING1]; |
196 | ||
d65106b1 | 197 | union { |
7d29a247 | 198 | struct lttng_event_perf_counter_ctx perf_counter; |
8d326ab9 | 199 | char padding[LTTNG_EVENT_CONTEXT_PADDING2]; |
d65106b1 | 200 | } u; |
54c90d10 | 201 | }; |
d65106b1 | 202 | |
b7384347 | 203 | /* |
7d29a247 DG |
204 | * Event probe. |
205 | * | |
206 | * Either addr is used or symbol_name and offset. | |
ece640c8 RB |
207 | * |
208 | * The structures should be initialized to zero before use. | |
57167058 | 209 | */ |
8d326ab9 | 210 | #define LTTNG_EVENT_PROBE_PADDING1 16 |
7d29a247 | 211 | struct lttng_event_probe_attr { |
f3ed775e DG |
212 | uint64_t addr; |
213 | ||
214 | uint64_t offset; | |
215 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
216 | |
217 | char padding[LTTNG_EVENT_PROBE_PADDING1]; | |
54c90d10 | 218 | }; |
57167058 | 219 | |
b7384347 | 220 | /* |
f3ed775e | 221 | * Function tracer |
ece640c8 RB |
222 | * |
223 | * The structures should be initialized to zero before use. | |
f3ed775e | 224 | */ |
8d326ab9 | 225 | #define LTTNG_EVENT_FUNCTION_PADDING1 16 |
f3ed775e DG |
226 | struct lttng_event_function_attr { |
227 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
228 | |
229 | char padding[LTTNG_EVENT_FUNCTION_PADDING1]; | |
54c90d10 | 230 | }; |
f3ed775e DG |
231 | |
232 | /* | |
233 | * Generic lttng event | |
ece640c8 RB |
234 | * |
235 | * The structures should be initialized to zero before use. | |
f3ed775e | 236 | */ |
fceb65df | 237 | #define LTTNG_EVENT_PADDING1 15 |
8d326ab9 | 238 | #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
f3ed775e | 239 | struct lttng_event { |
0cda4f28 | 240 | enum lttng_event_type type; |
f3ed775e | 241 | char name[LTTNG_SYMBOL_NAME_LEN]; |
0cda4f28 MD |
242 | |
243 | enum lttng_loglevel_type loglevel_type; | |
8005f29a | 244 | int loglevel; |
0cda4f28 | 245 | |
35dc4d62 | 246 | int32_t enabled; /* Does not apply: -1 */ |
b551a063 | 247 | pid_t pid; |
fceb65df | 248 | unsigned char filter; /* filter enabled ? */ |
8d326ab9 DG |
249 | |
250 | char padding[LTTNG_EVENT_PADDING1]; | |
251 | ||
f3ed775e DG |
252 | /* Per event type configuration */ |
253 | union { | |
7d29a247 | 254 | struct lttng_event_probe_attr probe; |
f3ed775e | 255 | struct lttng_event_function_attr ftrace; |
8d326ab9 DG |
256 | |
257 | char padding[LTTNG_EVENT_PADDING2]; | |
f3ed775e | 258 | } attr; |
54c90d10 | 259 | }; |
f3ed775e | 260 | |
f37d259d MD |
261 | enum lttng_event_field_type { |
262 | LTTNG_EVENT_FIELD_OTHER = 0, | |
263 | LTTNG_EVENT_FIELD_INTEGER = 1, | |
264 | LTTNG_EVENT_FIELD_ENUM = 2, | |
265 | LTTNG_EVENT_FIELD_FLOAT = 3, | |
266 | LTTNG_EVENT_FIELD_STRING = 4, | |
267 | }; | |
268 | ||
269 | #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32 | |
270 | struct lttng_event_field { | |
271 | char field_name[LTTNG_SYMBOL_NAME_LEN]; | |
272 | enum lttng_event_field_type type; | |
273 | char padding[LTTNG_EVENT_FIELD_PADDING]; | |
274 | struct lttng_event event; | |
590b9e3c | 275 | int nowrite; |
54c90d10 | 276 | }; |
f37d259d | 277 | |
e6ddca71 DG |
278 | /* |
279 | * Tracer channel attributes. For both kernel and user-space. | |
ece640c8 RB |
280 | * |
281 | * The structures should be initialized to zero before use. | |
e6ddca71 | 282 | */ |
1624d5b7 | 283 | #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 16 |
f3ed775e | 284 | struct lttng_channel_attr { |
8ce37aa5 DG |
285 | int overwrite; /* 1: overwrite, 0: discard */ |
286 | uint64_t subbuf_size; /* bytes */ | |
287 | uint64_t num_subbuf; /* power of 2 */ | |
288 | unsigned int switch_timer_interval; /* usec */ | |
289 | unsigned int read_timer_interval; /* usec */ | |
f05b5f07 | 290 | enum lttng_event_output output; /* splice, mmap */ |
1624d5b7 JD |
291 | /* LTTng 2.1 padding limit */ |
292 | uint64_t tracefile_size; /* bytes */ | |
293 | uint64_t tracefile_count; /* number of tracefiles */ | |
8d326ab9 DG |
294 | |
295 | char padding[LTTNG_CHANNEL_ATTR_PADDING1]; | |
54c90d10 | 296 | }; |
f3ed775e DG |
297 | |
298 | /* | |
e6ddca71 | 299 | * Channel information structure. For both kernel and user-space. |
ece640c8 RB |
300 | * |
301 | * The structures should be initialized to zero before use. | |
1657e9bb | 302 | */ |
8d326ab9 | 303 | #define LTTNG_CHANNEL_PADDING1 16 |
e6ddca71 | 304 | struct lttng_channel { |
045e5491 | 305 | char name[LTTNG_SYMBOL_NAME_LEN]; |
9f19cc17 | 306 | uint32_t enabled; |
e6ddca71 | 307 | struct lttng_channel_attr attr; |
8d326ab9 DG |
308 | |
309 | char padding[LTTNG_CHANNEL_PADDING1]; | |
54c90d10 | 310 | }; |
f3ed775e | 311 | |
8d326ab9 | 312 | #define LTTNG_CALIBRATE_PADDING1 16 |
d0254c7c MD |
313 | struct lttng_calibrate { |
314 | enum lttng_calibrate_type type; | |
8d326ab9 DG |
315 | |
316 | char padding[LTTNG_CALIBRATE_PADDING1]; | |
54c90d10 | 317 | }; |
d0254c7c | 318 | |
e6ddca71 DG |
319 | /* |
320 | * Basic session information. | |
321 | * | |
322 | * This is an 'output data' meaning that it only comes *from* the session | |
323 | * daemon *to* the lttng client. It's basically a 'human' representation of | |
324 | * tracing entities (here a session). | |
ece640c8 RB |
325 | * |
326 | * The structures should be initialized to zero before use. | |
e6ddca71 | 327 | */ |
8d326ab9 | 328 | #define LTTNG_SESSION_PADDING1 16 |
e6ddca71 | 329 | struct lttng_session { |
f3ed775e | 330 | char name[NAME_MAX]; |
e6ddca71 DG |
331 | /* The path where traces are written */ |
332 | char path[PATH_MAX]; | |
464dd62d | 333 | uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ |
8d326ab9 DG |
334 | |
335 | char padding[LTTNG_SESSION_PADDING1]; | |
54c90d10 | 336 | }; |
1657e9bb | 337 | |
cd80958d DG |
338 | /* |
339 | * Handle used as a context for commands. | |
ece640c8 RB |
340 | * |
341 | * The structures should be initialized to zero before use. | |
cd80958d | 342 | */ |
8d326ab9 | 343 | #define LTTNG_HANDLE_PADDING1 16 |
cd80958d DG |
344 | struct lttng_handle { |
345 | char session_name[NAME_MAX]; | |
346 | struct lttng_domain domain; | |
8d326ab9 DG |
347 | |
348 | char padding[LTTNG_HANDLE_PADDING1]; | |
54c90d10 | 349 | }; |
cd80958d | 350 | |
7d29a247 DG |
351 | /* |
352 | * Public LTTng control API | |
353 | * | |
1e46a50f | 354 | * For functions having an lttng domain type as parameter, if a bad value is |
7d29a247 DG |
355 | * given, NO default is applied and an error is returned. |
356 | * | |
357 | * On success, all functions of the API return 0 or the size of the allocated | |
1e46a50f | 358 | * array (in bytes). |
7d29a247 DG |
359 | * |
360 | * On error, a negative value is returned being a specific lttng-tools error | |
9a745bc7 | 361 | * code which can be humanly interpreted with lttng_strerror(err). |
1e46a50f TD |
362 | * |
363 | * Exceptions to this are noted below. | |
7d29a247 DG |
364 | */ |
365 | ||
b7384347 | 366 | /* |
1e46a50f | 367 | * Create a handle used as a context for every request made to the library. |
cd80958d DG |
368 | * |
369 | * This handle contains the session name and lttng domain on which the command | |
1e46a50f TD |
370 | * will be executed. |
371 | * The returned pointer will be NULL in case of malloc() error. | |
cd80958d DG |
372 | */ |
373 | extern struct lttng_handle *lttng_create_handle(const char *session_name, | |
374 | struct lttng_domain *domain); | |
375 | ||
376 | /* | |
41039c06 DG |
377 | * Destroy an handle. |
378 | * | |
379 | * It free(3) the data pointer returned by lttng_create_handle(), rendering it | |
380 | * unusable. | |
b7384347 | 381 | */ |
cd80958d | 382 | extern void lttng_destroy_handle(struct lttng_handle *handle); |
7d29a247 DG |
383 | |
384 | /* | |
a4b92340 DG |
385 | * Create a tracing session using a name and an optional URL. |
386 | * | |
41039c06 DG |
387 | * If _url_ is NULL, no consumer is created for the session. The name can't be |
388 | * NULL here. | |
00e2e675 | 389 | */ |
a4b92340 | 390 | extern int lttng_create_session(const char *name, const char *url); |
00e2e675 | 391 | |
7d29a247 | 392 | /* |
1e46a50f | 393 | * Destroy a tracing session. |
7d29a247 | 394 | * |
1e46a50f TD |
395 | * The session will not be usable anymore, tracing will be stopped for all |
396 | * registered traces, and the tracing buffers will be flushed. | |
41039c06 DG |
397 | * |
398 | * The name can't be NULL here. | |
7d29a247 | 399 | */ |
843f5df9 | 400 | extern int lttng_destroy_session(const char *name); |
f3ed775e | 401 | |
e6ddca71 | 402 | /* |
1e46a50f | 403 | * List all the tracing sessions. |
7d29a247 | 404 | * |
1e46a50f TD |
405 | * Return the size (number of entries) of the "lttng_session" array. Caller |
406 | * must free(3). | |
e6ddca71 | 407 | */ |
ca95a216 | 408 | extern int lttng_list_sessions(struct lttng_session **sessions); |
f3ed775e | 409 | |
9f19cc17 | 410 | /* |
1e46a50f | 411 | * List the registered domain(s) of a session. |
9f19cc17 | 412 | * |
1e46a50f TD |
413 | * Return the size (number of entries) of the "lttng_domain" array. Caller |
414 | * must free(3). | |
9f19cc17 | 415 | */ |
330be774 | 416 | extern int lttng_list_domains(const char *session_name, |
9f19cc17 DG |
417 | struct lttng_domain **domains); |
418 | ||
419 | /* | |
1e46a50f | 420 | * List the channel(s) of a session. |
9f19cc17 | 421 | * |
1e46a50f TD |
422 | * Return the size (number of entries) of the "lttng_channel" array. Caller |
423 | * must free(3). | |
9f19cc17 | 424 | */ |
cd80958d DG |
425 | extern int lttng_list_channels(struct lttng_handle *handle, |
426 | struct lttng_channel **channels); | |
9f19cc17 DG |
427 | |
428 | /* | |
1e46a50f | 429 | * List the event(s) of a session channel. |
9f19cc17 | 430 | * |
1e46a50f TD |
431 | * Return the size (number of entries) of the "lttng_event" array. |
432 | * Caller must free(3). | |
9f19cc17 | 433 | */ |
cd80958d DG |
434 | extern int lttng_list_events(struct lttng_handle *handle, |
435 | const char *channel_name, struct lttng_event **events); | |
9f19cc17 DG |
436 | |
437 | /* | |
1e46a50f | 438 | * List the available tracepoints of a specific lttng domain. |
9f19cc17 | 439 | * |
1e46a50f TD |
440 | * Return the size (number of entries) of the "lttng_event" array. |
441 | * Caller must free(3). | |
9f19cc17 | 442 | */ |
cd80958d | 443 | extern int lttng_list_tracepoints(struct lttng_handle *handle, |
2a71efd5 | 444 | struct lttng_event **events); |
9f19cc17 | 445 | |
f37d259d MD |
446 | /* |
447 | * List the available tracepoints fields of a specific lttng domain. | |
448 | * | |
449 | * Return the size (number of entries) of the "lttng_event_field" array. | |
450 | * Caller must free(3). | |
451 | */ | |
452 | extern int lttng_list_tracepoint_fields(struct lttng_handle *handle, | |
453 | struct lttng_event_field **fields); | |
454 | ||
7d29a247 DG |
455 | /* |
456 | * Check if a session daemon is alive. | |
1e46a50f TD |
457 | * |
458 | * Return 1 if alive or 0 if not. On error returns a negative value. | |
7d29a247 | 459 | */ |
947308c4 | 460 | extern int lttng_session_daemon_alive(void); |
f3ed775e | 461 | |
7d29a247 | 462 | /* |
1e46a50f TD |
463 | * Set the tracing group for the *current* flow of execution. |
464 | * | |
41039c06 DG |
465 | * On success, returns 0 else a negative value on error being a lttng error |
466 | * code found in lttng-error.h | |
7d29a247 | 467 | */ |
b7384347 | 468 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 469 | |
7d29a247 | 470 | /* |
1e46a50f | 471 | * Return a human-readable error message for an lttng-tools error code. |
7d29a247 DG |
472 | * |
473 | * Parameter MUST be a negative value or else you'll get a generic message. | |
474 | */ | |
9a745bc7 | 475 | extern const char *lttng_strerror(int code); |
b7384347 | 476 | |
d9800920 | 477 | /* |
1e46a50f TD |
478 | * This call registers an "outside consumer" for a session and an lttng domain. |
479 | * No consumer will be spawned and all fds/commands will go through the socket | |
480 | * path given (socket_path). | |
d9800920 | 481 | * |
3bd1e081 | 482 | * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the |
d9800920 DG |
483 | * command socket. The error socket is not supported yet for roaming consumers. |
484 | */ | |
485 | extern int lttng_register_consumer(struct lttng_handle *handle, | |
486 | const char *socket_path); | |
487 | ||
7d29a247 | 488 | /* |
1e46a50f | 489 | * Start tracing for *all* registered traces (kernel and user-space). |
7d29a247 | 490 | */ |
6a4f824d | 491 | extern int lttng_start_tracing(const char *session_name); |
f3ed775e | 492 | |
7d29a247 | 493 | /* |
1e46a50f | 494 | * Stop tracing for *all* registered traces (kernel and user-space). |
38ee087f DG |
495 | * |
496 | * This call will wait for data availability for each domain of the session so | |
497 | * this can take an abritrary amount of time. However, when returning you have | |
498 | * the guarantee that the data is ready to be read and analyse. Use the | |
499 | * _no_wait call below to avoid this behavior. | |
41039c06 DG |
500 | * |
501 | * The session_name can't be NULL. | |
7d29a247 | 502 | */ |
6a4f824d | 503 | extern int lttng_stop_tracing(const char *session_name); |
f3ed775e | 504 | |
38ee087f DG |
505 | /* |
506 | * Behave exactly like lttng_stop_tracing but does not wait for data | |
507 | * availability. | |
508 | */ | |
509 | extern int lttng_stop_tracing_no_wait(const char *session_name); | |
510 | ||
b7384347 | 511 | /* |
1e46a50f | 512 | * Add context to event(s) for a specific channel (or for all). |
7d29a247 | 513 | * |
41039c06 DG |
514 | * If channel_name is NULL, a lookup of the event's channel is done. If both |
515 | * are NULL, the context is applied to all events of all channels. | |
516 | * | |
517 | * Note that whatever event_name value is, a context can not be added to an | |
518 | * event, so we just ignore it for now. | |
b7384347 | 519 | */ |
cd80958d | 520 | extern int lttng_add_context(struct lttng_handle *handle, |
38057ed1 DG |
521 | struct lttng_event_context *ctx, const char *event_name, |
522 | const char *channel_name); | |
f3ed775e | 523 | |
7d29a247 | 524 | /* |
c8f61fc6 | 525 | * Create or enable an event (or events) for a channel. |
7d29a247 DG |
526 | * |
527 | * If the event you are trying to enable does not exist, it will be created, | |
528 | * else it is enabled. | |
7d29a247 | 529 | * If channel_name is NULL, the default channel is used (channel0). |
41039c06 DG |
530 | * |
531 | * The handle and ev params can not be NULL. | |
7d29a247 | 532 | */ |
cd80958d DG |
533 | extern int lttng_enable_event(struct lttng_handle *handle, |
534 | struct lttng_event *ev, const char *channel_name); | |
f3ed775e | 535 | |
53a80697 | 536 | /* |
025faf73 | 537 | * Create or enable an event with a specific filter. |
53a80697 | 538 | * |
025faf73 DG |
539 | * If the event you are trying to enable does not exist, it will be created, |
540 | * else it is enabled. | |
41039c06 | 541 | * If ev is NULL, all events are enabled with that filter. |
025faf73 DG |
542 | * If channel_name is NULL, the default channel is used (channel0) and created |
543 | * if not found. | |
52df2401 MD |
544 | * If filter_expression is NULL, an event without associated filter is |
545 | * created. | |
53a80697 | 546 | */ |
025faf73 | 547 | extern int lttng_enable_event_with_filter(struct lttng_handle *handle, |
178191b3 | 548 | struct lttng_event *event, const char *channel_name, |
53a80697 | 549 | const char *filter_expression); |
178191b3 | 550 | |
7d29a247 | 551 | /* |
c8f61fc6 | 552 | * Create or enable a channel. |
41039c06 DG |
553 | * |
554 | * The chan and handle params can not be NULL. | |
7d29a247 | 555 | */ |
cd80958d | 556 | extern int lttng_enable_channel(struct lttng_handle *handle, |
38057ed1 | 557 | struct lttng_channel *chan); |
f3ed775e | 558 | |
7d29a247 | 559 | /* |
c8f61fc6 | 560 | * Disable event(s) of a channel and domain. |
7d29a247 | 561 | * |
41039c06 | 562 | * If name is NULL, all events are disabled. |
7d29a247 DG |
563 | * If channel_name is NULL, the default channel is used (channel0). |
564 | */ | |
cd80958d DG |
565 | extern int lttng_disable_event(struct lttng_handle *handle, |
566 | const char *name, const char *channel_name); | |
fac6795d | 567 | |
1df4dedd | 568 | /* |
c8f61fc6 | 569 | * Disable channel. |
7d29a247 | 570 | * |
1df4dedd | 571 | */ |
cd80958d | 572 | extern int lttng_disable_channel(struct lttng_handle *handle, |
38057ed1 | 573 | const char *name); |
1df4dedd | 574 | |
d0254c7c MD |
575 | /* |
576 | * Calibrate LTTng overhead. | |
41039c06 DG |
577 | * |
578 | * The chan and handle params can not be NULL. | |
d0254c7c | 579 | */ |
cd80958d | 580 | extern int lttng_calibrate(struct lttng_handle *handle, |
d0254c7c MD |
581 | struct lttng_calibrate *calibrate); |
582 | ||
5edd7e09 DG |
583 | /* |
584 | * Set the default channel attributes for a specific domain and an allocated | |
585 | * lttng_channel_attr pointer. | |
1e46a50f | 586 | * |
41039c06 | 587 | * If one or both arguments are NULL, nothing happens. |
5edd7e09 DG |
588 | */ |
589 | extern void lttng_channel_set_default_attr(struct lttng_domain *domain, | |
590 | struct lttng_channel_attr *attr); | |
591 | ||
00e2e675 | 592 | /* |
a4b92340 DG |
593 | * Set URL for a consumer for a session and domain. |
594 | * | |
595 | * Both data and control URL must be defined. If both URLs are the same, only | |
596 | * the control URL is used even for network streaming. | |
00e2e675 | 597 | * |
a4b92340 DG |
598 | * Default port are 5342 and 5343 respectively for control and data which uses |
599 | * the TCP protocol. | |
00e2e675 | 600 | */ |
a4b92340 DG |
601 | extern int lttng_set_consumer_url(struct lttng_handle *handle, |
602 | const char *control_url, const char *data_url); | |
00e2e675 DG |
603 | |
604 | /* | |
605 | * Enable the consumer for a session and domain. | |
606 | */ | |
9c6bda17 | 607 | extern LTTNG_DEPRECATED("This call is now obsolete.") |
785d2d0d | 608 | int lttng_enable_consumer(struct lttng_handle *handle); |
00e2e675 DG |
609 | |
610 | /* | |
611 | * Disable consumer for a session and domain. | |
612 | */ | |
9c6bda17 | 613 | extern LTTNG_DEPRECATED("This call is now obsolete.") |
785d2d0d | 614 | int lttng_disable_consumer(struct lttng_handle *handle); |
00e2e675 | 615 | |
44a5e5eb DG |
616 | /* |
617 | * Check session daemon health for a specific component. | |
618 | * | |
619 | * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that | |
620 | * the control library was not able to connect to the session daemon health | |
621 | * socket. | |
622 | * | |
623 | * Any other positive value is an lttcomm error which can be translate with | |
624 | * lttng_strerror(). | |
41039c06 DG |
625 | * |
626 | * Please see lttng-health-check(3) man page for more information. | |
44a5e5eb DG |
627 | */ |
628 | extern int lttng_health_check(enum lttng_health_component c); | |
629 | ||
806e2684 DG |
630 | /* |
631 | * For a given session name, this call checks if the data is ready to be read | |
6d805429 DG |
632 | * or is still being extracted by the consumer(s) (pending) hence not ready to |
633 | * be used by any readers. | |
806e2684 | 634 | * |
6d805429 DG |
635 | * Return 0 if there is _no_ data pending in the buffers thus having a |
636 | * guarantee that the data can be read safely. Else, return 1 if there is still | |
637 | * traced data is pending. On error, a negative value is returned and readable | |
638 | * by lttng_strerror(). | |
806e2684 | 639 | */ |
6d805429 | 640 | extern int lttng_data_pending(const char *session_name); |
806e2684 | 641 | |
5168918c DG |
642 | #ifdef __cplusplus |
643 | } | |
644 | #endif | |
645 | ||
73db5be4 | 646 | #endif /* LTTNG_H */ |