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