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