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