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> |
a625e7d7 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> |
a625e7d7 | 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 { | |
b9dfb167 DG |
60 | LTTNG_DOMAIN_KERNEL = 1, /* Linux Kernel tracer. */ |
61 | LTTNG_DOMAIN_UST = 2, /* Global Userspace tracer. */ | |
62 | LTTNG_DOMAIN_JUL = 3, /* Java Util Logging. */ | |
7d29a247 DG |
63 | }; |
64 | ||
7d29a247 DG |
65 | /* |
66 | * Instrumentation type of tracing event. | |
67 | */ | |
f3ed775e | 68 | enum lttng_event_type { |
7a3d1328 MD |
69 | LTTNG_EVENT_ALL = -1, |
70 | LTTNG_EVENT_TRACEPOINT = 0, | |
71 | LTTNG_EVENT_PROBE = 1, | |
72 | LTTNG_EVENT_FUNCTION = 2, | |
73 | LTTNG_EVENT_FUNCTION_ENTRY = 3, | |
74 | LTTNG_EVENT_NOOP = 4, | |
75 | LTTNG_EVENT_SYSCALL = 5, | |
0cda4f28 MD |
76 | }; |
77 | ||
78 | /* | |
79 | * Loglevel information. | |
80 | */ | |
81 | enum lttng_loglevel_type { | |
8005f29a MD |
82 | LTTNG_EVENT_LOGLEVEL_ALL = 0, |
83 | LTTNG_EVENT_LOGLEVEL_RANGE = 1, | |
84 | LTTNG_EVENT_LOGLEVEL_SINGLE = 2, | |
1657e9bb DG |
85 | }; |
86 | ||
46839cc2 MD |
87 | /* |
88 | * Available loglevels. | |
89 | */ | |
90 | enum lttng_loglevel { | |
00e2e675 DG |
91 | LTTNG_LOGLEVEL_EMERG = 0, |
92 | LTTNG_LOGLEVEL_ALERT = 1, | |
93 | LTTNG_LOGLEVEL_CRIT = 2, | |
94 | LTTNG_LOGLEVEL_ERR = 3, | |
95 | LTTNG_LOGLEVEL_WARNING = 4, | |
96 | LTTNG_LOGLEVEL_NOTICE = 5, | |
97 | LTTNG_LOGLEVEL_INFO = 6, | |
98 | LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7, | |
99 | LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8, | |
100 | LTTNG_LOGLEVEL_DEBUG_PROCESS = 9, | |
101 | LTTNG_LOGLEVEL_DEBUG_MODULE = 10, | |
102 | LTTNG_LOGLEVEL_DEBUG_UNIT = 11, | |
103 | LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12, | |
104 | LTTNG_LOGLEVEL_DEBUG_LINE = 13, | |
105 | LTTNG_LOGLEVEL_DEBUG = 14, | |
46839cc2 MD |
106 | }; |
107 | ||
e3a639d0 DG |
108 | /* |
109 | * Available loglevels for the JUL domain. Those are an exact map from the | |
110 | * class java.util.logging.Level. | |
111 | */ | |
112 | enum lttng_loglevel_jul { | |
113 | LTTNG_LOGLEVEL_JUL_OFF = INT32_MAX, | |
114 | LTTNG_LOGLEVEL_JUL_SEVERE = 1000, | |
115 | LTTNG_LOGLEVEL_JUL_WARNING = 900, | |
116 | LTTNG_LOGLEVEL_JUL_INFO = 800, | |
117 | LTTNG_LOGLEVEL_JUL_CONFIG = 700, | |
118 | LTTNG_LOGLEVEL_JUL_FINE = 500, | |
119 | LTTNG_LOGLEVEL_JUL_FINER = 400, | |
120 | LTTNG_LOGLEVEL_JUL_FINEST = 300, | |
121 | LTTNG_LOGLEVEL_JUL_ALL = INT32_MIN, | |
122 | }; | |
123 | ||
e6ddca71 DG |
124 | /* |
125 | * LTTng consumer mode | |
126 | */ | |
127 | enum lttng_event_output { | |
d78d6610 DG |
128 | LTTNG_EVENT_SPLICE = 0, |
129 | LTTNG_EVENT_MMAP = 1, | |
e6ddca71 DG |
130 | }; |
131 | ||
7d29a247 DG |
132 | /* Event context possible type */ |
133 | enum lttng_event_context_type { | |
d78d6610 DG |
134 | LTTNG_EVENT_CONTEXT_PID = 0, |
135 | LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, | |
9197c5c4 | 136 | LTTNG_EVENT_CONTEXT_PROCNAME = 2, |
d78d6610 DG |
137 | LTTNG_EVENT_CONTEXT_PRIO = 3, |
138 | LTTNG_EVENT_CONTEXT_NICE = 4, | |
139 | LTTNG_EVENT_CONTEXT_VPID = 5, | |
140 | LTTNG_EVENT_CONTEXT_TID = 6, | |
141 | LTTNG_EVENT_CONTEXT_VTID = 7, | |
142 | LTTNG_EVENT_CONTEXT_PPID = 8, | |
143 | LTTNG_EVENT_CONTEXT_VPPID = 9, | |
9197c5c4 | 144 | LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10, |
54773d68 | 145 | LTTNG_EVENT_CONTEXT_HOSTNAME = 11, |
7c612c2e | 146 | LTTNG_EVENT_CONTEXT_IP = 12, |
d65106b1 DG |
147 | }; |
148 | ||
d0254c7c | 149 | enum lttng_calibrate_type { |
d78d6610 | 150 | LTTNG_CALIBRATE_FUNCTION = 0, |
d0254c7c MD |
151 | }; |
152 | ||
44a5e5eb DG |
153 | /* Health component for the health check function. */ |
154 | enum lttng_health_component { | |
155 | LTTNG_HEALTH_CMD, | |
139ac872 | 156 | LTTNG_HEALTH_APP_MANAGE, |
44a5e5eb DG |
157 | LTTNG_HEALTH_APP_REG, |
158 | LTTNG_HEALTH_KERNEL, | |
159 | LTTNG_HEALTH_CONSUMER, | |
0b2dc8df | 160 | LTTNG_HEALTH_HT_CLEANUP, |
380e8d6f | 161 | LTTNG_HEALTH_APP_MANAGE_NOTIFY, |
12e2b881 | 162 | LTTNG_HEALTH_APP_REG_DISPATCH, |
44a5e5eb DG |
163 | LTTNG_HEALTH_ALL, |
164 | }; | |
165 | ||
7972aab2 DG |
166 | /* Buffer type for a specific domain. */ |
167 | enum lttng_buffer_type { | |
168 | LTTNG_BUFFER_PER_PID, /* Only supported by UST being the default. */ | |
169 | LTTNG_BUFFER_PER_UID, /* Only supported by UST. */ | |
170 | LTTNG_BUFFER_GLOBAL, /* Only supported by the Kernel. */ | |
171 | }; | |
172 | ||
ece640c8 RB |
173 | /* |
174 | * The structures should be initialized to zero before use. | |
175 | */ | |
7972aab2 | 176 | #define LTTNG_DOMAIN_PADDING1 12 |
8d326ab9 | 177 | #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
9f19cc17 DG |
178 | struct lttng_domain { |
179 | enum lttng_domain_type type; | |
7972aab2 | 180 | enum lttng_buffer_type buf_type; |
8d326ab9 DG |
181 | char padding[LTTNG_DOMAIN_PADDING1]; |
182 | ||
9f19cc17 DG |
183 | union { |
184 | pid_t pid; | |
185 | char exec_name[NAME_MAX]; | |
8d326ab9 | 186 | char padding[LTTNG_DOMAIN_PADDING2]; |
9f19cc17 | 187 | } attr; |
54c90d10 | 188 | }; |
9f19cc17 | 189 | |
ece640c8 RB |
190 | /* |
191 | * Perf counter attributes | |
192 | * | |
193 | * The structures should be initialized to zero before use. | |
194 | */ | |
8d326ab9 | 195 | #define LTTNG_PERF_EVENT_PADDING1 16 |
7d29a247 | 196 | struct lttng_event_perf_counter_ctx { |
d65106b1 DG |
197 | uint32_t type; |
198 | uint64_t config; | |
199 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
200 | |
201 | char padding[LTTNG_PERF_EVENT_PADDING1]; | |
54c90d10 | 202 | }; |
d65106b1 | 203 | |
ece640c8 RB |
204 | /* |
205 | * Event/channel context | |
206 | * | |
207 | * The structures should be initialized to zero before use. | |
208 | */ | |
8d326ab9 DG |
209 | #define LTTNG_EVENT_CONTEXT_PADDING1 16 |
210 | #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 | |
7d29a247 DG |
211 | struct lttng_event_context { |
212 | enum lttng_event_context_type ctx; | |
8d326ab9 DG |
213 | char padding[LTTNG_EVENT_CONTEXT_PADDING1]; |
214 | ||
d65106b1 | 215 | union { |
7d29a247 | 216 | struct lttng_event_perf_counter_ctx perf_counter; |
8d326ab9 | 217 | char padding[LTTNG_EVENT_CONTEXT_PADDING2]; |
d65106b1 | 218 | } u; |
54c90d10 | 219 | }; |
d65106b1 | 220 | |
b7384347 | 221 | /* |
7d29a247 DG |
222 | * Event probe. |
223 | * | |
224 | * Either addr is used or symbol_name and offset. | |
ece640c8 RB |
225 | * |
226 | * The structures should be initialized to zero before use. | |
57167058 | 227 | */ |
8d326ab9 | 228 | #define LTTNG_EVENT_PROBE_PADDING1 16 |
7d29a247 | 229 | struct lttng_event_probe_attr { |
f3ed775e DG |
230 | uint64_t addr; |
231 | ||
232 | uint64_t offset; | |
233 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
234 | |
235 | char padding[LTTNG_EVENT_PROBE_PADDING1]; | |
54c90d10 | 236 | }; |
57167058 | 237 | |
b7384347 | 238 | /* |
f3ed775e | 239 | * Function tracer |
ece640c8 RB |
240 | * |
241 | * The structures should be initialized to zero before use. | |
f3ed775e | 242 | */ |
8d326ab9 | 243 | #define LTTNG_EVENT_FUNCTION_PADDING1 16 |
f3ed775e DG |
244 | struct lttng_event_function_attr { |
245 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
246 | |
247 | char padding[LTTNG_EVENT_FUNCTION_PADDING1]; | |
54c90d10 | 248 | }; |
f3ed775e DG |
249 | |
250 | /* | |
251 | * Generic lttng event | |
ece640c8 RB |
252 | * |
253 | * The structures should be initialized to zero before use. | |
f3ed775e | 254 | */ |
4634f12e | 255 | #define LTTNG_EVENT_PADDING1 14 |
8d326ab9 | 256 | #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
f3ed775e | 257 | struct lttng_event { |
0cda4f28 | 258 | enum lttng_event_type type; |
f3ed775e | 259 | char name[LTTNG_SYMBOL_NAME_LEN]; |
0cda4f28 MD |
260 | |
261 | enum lttng_loglevel_type loglevel_type; | |
8005f29a | 262 | int loglevel; |
0cda4f28 | 263 | |
35dc4d62 | 264 | int32_t enabled; /* Does not apply: -1 */ |
b551a063 | 265 | pid_t pid; |
fceb65df | 266 | unsigned char filter; /* filter enabled ? */ |
4634f12e | 267 | unsigned char exclusion; /* exclusions added ? */ |
8d326ab9 DG |
268 | |
269 | char padding[LTTNG_EVENT_PADDING1]; | |
270 | ||
f3ed775e DG |
271 | /* Per event type configuration */ |
272 | union { | |
7d29a247 | 273 | struct lttng_event_probe_attr probe; |
f3ed775e | 274 | struct lttng_event_function_attr ftrace; |
8d326ab9 DG |
275 | |
276 | char padding[LTTNG_EVENT_PADDING2]; | |
f3ed775e | 277 | } attr; |
54c90d10 | 278 | }; |
f3ed775e | 279 | |
f37d259d MD |
280 | enum lttng_event_field_type { |
281 | LTTNG_EVENT_FIELD_OTHER = 0, | |
282 | LTTNG_EVENT_FIELD_INTEGER = 1, | |
283 | LTTNG_EVENT_FIELD_ENUM = 2, | |
284 | LTTNG_EVENT_FIELD_FLOAT = 3, | |
285 | LTTNG_EVENT_FIELD_STRING = 4, | |
286 | }; | |
287 | ||
288 | #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32 | |
289 | struct lttng_event_field { | |
290 | char field_name[LTTNG_SYMBOL_NAME_LEN]; | |
291 | enum lttng_event_field_type type; | |
292 | char padding[LTTNG_EVENT_FIELD_PADDING]; | |
293 | struct lttng_event event; | |
590b9e3c | 294 | int nowrite; |
54c90d10 | 295 | }; |
f37d259d | 296 | |
e6ddca71 DG |
297 | /* |
298 | * Tracer channel attributes. For both kernel and user-space. | |
ece640c8 RB |
299 | * |
300 | * The structures should be initialized to zero before use. | |
e6ddca71 | 301 | */ |
ecc48a90 | 302 | #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 12 |
f3ed775e | 303 | struct lttng_channel_attr { |
8ce37aa5 DG |
304 | int overwrite; /* 1: overwrite, 0: discard */ |
305 | uint64_t subbuf_size; /* bytes */ | |
306 | uint64_t num_subbuf; /* power of 2 */ | |
307 | unsigned int switch_timer_interval; /* usec */ | |
308 | unsigned int read_timer_interval; /* usec */ | |
f05b5f07 | 309 | enum lttng_event_output output; /* splice, mmap */ |
1624d5b7 JD |
310 | /* LTTng 2.1 padding limit */ |
311 | uint64_t tracefile_size; /* bytes */ | |
312 | uint64_t tracefile_count; /* number of tracefiles */ | |
ecc48a90 JD |
313 | /* LTTng 2.3 padding limit */ |
314 | unsigned int live_timer_interval; /* usec */ | |
8d326ab9 DG |
315 | |
316 | char padding[LTTNG_CHANNEL_ATTR_PADDING1]; | |
54c90d10 | 317 | }; |
f3ed775e DG |
318 | |
319 | /* | |
e6ddca71 | 320 | * Channel information structure. For both kernel and user-space. |
ece640c8 RB |
321 | * |
322 | * The structures should be initialized to zero before use. | |
1657e9bb | 323 | */ |
8d326ab9 | 324 | #define LTTNG_CHANNEL_PADDING1 16 |
e6ddca71 | 325 | struct lttng_channel { |
045e5491 | 326 | char name[LTTNG_SYMBOL_NAME_LEN]; |
9f19cc17 | 327 | uint32_t enabled; |
e6ddca71 | 328 | struct lttng_channel_attr attr; |
8d326ab9 DG |
329 | |
330 | char padding[LTTNG_CHANNEL_PADDING1]; | |
54c90d10 | 331 | }; |
f3ed775e | 332 | |
8d326ab9 | 333 | #define LTTNG_CALIBRATE_PADDING1 16 |
d0254c7c MD |
334 | struct lttng_calibrate { |
335 | enum lttng_calibrate_type type; | |
8d326ab9 DG |
336 | |
337 | char padding[LTTNG_CALIBRATE_PADDING1]; | |
54c90d10 | 338 | }; |
d0254c7c | 339 | |
e6ddca71 DG |
340 | /* |
341 | * Basic session information. | |
342 | * | |
343 | * This is an 'output data' meaning that it only comes *from* the session | |
344 | * daemon *to* the lttng client. It's basically a 'human' representation of | |
345 | * tracing entities (here a session). | |
ece640c8 RB |
346 | * |
347 | * The structures should be initialized to zero before use. | |
e6ddca71 | 348 | */ |
2cbf8fed | 349 | #define LTTNG_SESSION_PADDING1 12 |
e6ddca71 | 350 | struct lttng_session { |
f3ed775e | 351 | char name[NAME_MAX]; |
e6ddca71 DG |
352 | /* The path where traces are written */ |
353 | char path[PATH_MAX]; | |
464dd62d | 354 | uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ |
2cbf8fed | 355 | uint32_t snapshot_mode; |
ecc48a90 | 356 | unsigned int live_timer_interval; /* usec */ |
8d326ab9 DG |
357 | |
358 | char padding[LTTNG_SESSION_PADDING1]; | |
54c90d10 | 359 | }; |
1657e9bb | 360 | |
cd80958d DG |
361 | /* |
362 | * Handle used as a context for commands. | |
ece640c8 RB |
363 | * |
364 | * The structures should be initialized to zero before use. | |
cd80958d | 365 | */ |
8d326ab9 | 366 | #define LTTNG_HANDLE_PADDING1 16 |
cd80958d DG |
367 | struct lttng_handle { |
368 | char session_name[NAME_MAX]; | |
369 | struct lttng_domain domain; | |
8d326ab9 DG |
370 | |
371 | char padding[LTTNG_HANDLE_PADDING1]; | |
54c90d10 | 372 | }; |
cd80958d | 373 | |
7d29a247 DG |
374 | /* |
375 | * Public LTTng control API | |
cd80958d | 376 | */ |
7d29a247 DG |
377 | |
378 | /* | |
a4b92340 DG |
379 | * Create a tracing session using a name and an optional URL. |
380 | * | |
41039c06 DG |
381 | * If _url_ is NULL, no consumer is created for the session. The name can't be |
382 | * NULL here. | |
7389132f DG |
383 | * |
384 | * Return 0 on success else a negative LTTng error code. | |
00e2e675 | 385 | */ |
a4b92340 | 386 | extern int lttng_create_session(const char *name, const char *url); |
00e2e675 | 387 | |
27babd3a DG |
388 | /* |
389 | * Create a tracing session that will exclusively be used for snapshot meaning | |
390 | * the session will be in no output mode and every channel enabled for that | |
391 | * session will be set in overwrite mode and in mmap output since splice is not | |
392 | * supported. | |
393 | * | |
7389132f DG |
394 | * Name can't be NULL. If an url is given, it will be used to create a default |
395 | * snapshot output using it as a destination. If NULL, no output will be | |
396 | * defined and an add-output call will be needed. | |
27babd3a | 397 | * |
7389132f | 398 | * Return 0 on success else a negative LTTng error code. |
27babd3a DG |
399 | */ |
400 | extern int lttng_create_session_snapshot(const char *name, | |
401 | const char *snapshot_url); | |
402 | ||
ecc48a90 JD |
403 | /* |
404 | * Create a session exclusively used for live reading. | |
405 | * | |
406 | * In this mode, the switch-timer parameter is forced for each UST channel, a | |
407 | * live-switch-timer is enabled for kernel channels, manually setting | |
408 | * switch-timer is forbidden. Synchronization beacons are sent to the relayd, | |
409 | * indexes are sent and metadata is checked for each packet. | |
410 | * | |
7389132f DG |
411 | * Name can't be NULL. If no URL is given, the default is to send the data to |
412 | * net://127.0.0.1. The timer_interval is in usec and by default set to 1000000 | |
413 | * (1 second). | |
414 | * | |
415 | * Return 0 on success else a negative LTTng error code. | |
ecc48a90 JD |
416 | */ |
417 | extern int lttng_create_session_live(const char *name, const char *url, | |
418 | unsigned int timer_interval); | |
419 | ||
7389132f DG |
420 | /* |
421 | * Create an handle used as a context for every request made to the library. | |
422 | * | |
423 | * This handle contains the session name and domain on which the command will | |
424 | * be executed. A domain is basically a tracer like the kernel or user space. | |
425 | * | |
426 | * Return an newly allocated handle that should be freed using | |
427 | * lttng_destroy_handle. On error, NULL is returned. | |
428 | */ | |
429 | extern struct lttng_handle *lttng_create_handle(const char *session_name, | |
430 | struct lttng_domain *domain); | |
431 | ||
432 | /* | |
433 | * Destroy an handle that has been previously created with lttng_create_handle. | |
434 | * | |
435 | * It free the given pointer making it unusable. | |
436 | */ | |
437 | extern void lttng_destroy_handle(struct lttng_handle *handle); | |
438 | ||
7d29a247 | 439 | /* |
1e46a50f | 440 | * Destroy a tracing session. |
7d29a247 | 441 | * |
7389132f DG |
442 | * The session will not be usable, tracing will be stopped thus buffers will be |
443 | * flushed. | |
41039c06 DG |
444 | * |
445 | * The name can't be NULL here. | |
7389132f DG |
446 | * |
447 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 448 | */ |
843f5df9 | 449 | extern int lttng_destroy_session(const char *name); |
f3ed775e | 450 | |
e6ddca71 | 451 | /* |
1e46a50f | 452 | * List all the tracing sessions. |
7d29a247 | 453 | * |
1e46a50f | 454 | * Return the size (number of entries) of the "lttng_session" array. Caller |
7389132f | 455 | * must free sessions. On error, a negative LTTng error code is returned. |
e6ddca71 | 456 | */ |
ca95a216 | 457 | extern int lttng_list_sessions(struct lttng_session **sessions); |
f3ed775e | 458 | |
9f19cc17 | 459 | /* |
1e46a50f | 460 | * List the registered domain(s) of a session. |
9f19cc17 | 461 | * |
7389132f DG |
462 | * Session name CAN NOT be NULL. |
463 | * | |
1e46a50f | 464 | * Return the size (number of entries) of the "lttng_domain" array. Caller |
7389132f | 465 | * must free domains. On error, a negative LTTng error code is returned. |
9f19cc17 | 466 | */ |
330be774 | 467 | extern int lttng_list_domains(const char *session_name, |
9f19cc17 DG |
468 | struct lttng_domain **domains); |
469 | ||
470 | /* | |
1e46a50f | 471 | * List the channel(s) of a session. |
9f19cc17 | 472 | * |
7389132f DG |
473 | * The handle CAN NOT be NULL. |
474 | * | |
1e46a50f | 475 | * Return the size (number of entries) of the "lttng_channel" array. Caller |
7389132f | 476 | * must free channels. On error, a negative LTTng error code is returned. |
9f19cc17 | 477 | */ |
cd80958d DG |
478 | extern int lttng_list_channels(struct lttng_handle *handle, |
479 | struct lttng_channel **channels); | |
9f19cc17 DG |
480 | |
481 | /* | |
1e46a50f | 482 | * List the event(s) of a session channel. |
9f19cc17 | 483 | * |
7389132f DG |
484 | * Both handle and channel_name CAN NOT be NULL. |
485 | * | |
486 | * Return the size (number of entries) of the "lttng_event" array. Caller must | |
487 | * free events. On error a negative LTTng error code is returned. | |
9f19cc17 | 488 | */ |
cd80958d DG |
489 | extern int lttng_list_events(struct lttng_handle *handle, |
490 | const char *channel_name, struct lttng_event **events); | |
9f19cc17 DG |
491 | |
492 | /* | |
1e46a50f | 493 | * List the available tracepoints of a specific lttng domain. |
9f19cc17 | 494 | * |
7389132f DG |
495 | * The handle CAN NOT be NULL. |
496 | * | |
497 | * Return the size (number of entries) of the "lttng_event" array. Caller must | |
498 | * free events. On error a negative LTTng error code is returned. | |
9f19cc17 | 499 | */ |
cd80958d | 500 | extern int lttng_list_tracepoints(struct lttng_handle *handle, |
2a71efd5 | 501 | struct lttng_event **events); |
9f19cc17 | 502 | |
f37d259d MD |
503 | /* |
504 | * List the available tracepoints fields of a specific lttng domain. | |
505 | * | |
7389132f DG |
506 | * The handle CAN NOT be NULL. |
507 | * | |
f37d259d | 508 | * Return the size (number of entries) of the "lttng_event_field" array. |
7389132f DG |
509 | * Caller must free fields. On error a negative LTTng error code is |
510 | * returned. | |
f37d259d MD |
511 | */ |
512 | extern int lttng_list_tracepoint_fields(struct lttng_handle *handle, | |
513 | struct lttng_event_field **fields); | |
514 | ||
7d29a247 DG |
515 | /* |
516 | * Check if a session daemon is alive. | |
1e46a50f | 517 | * |
7389132f DG |
518 | * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng |
519 | * error code. | |
7d29a247 | 520 | */ |
947308c4 | 521 | extern int lttng_session_daemon_alive(void); |
f3ed775e | 522 | |
7d29a247 | 523 | /* |
1e46a50f TD |
524 | * Set the tracing group for the *current* flow of execution. |
525 | * | |
7389132f | 526 | * On success, returns 0 else a negative LTTng error code. |
7d29a247 | 527 | */ |
b7384347 | 528 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 529 | |
7d29a247 | 530 | /* |
7389132f | 531 | * Return a human-readable error message for a LTTng error code. |
7d29a247 DG |
532 | * |
533 | * Parameter MUST be a negative value or else you'll get a generic message. | |
534 | */ | |
9a745bc7 | 535 | extern const char *lttng_strerror(int code); |
b7384347 | 536 | |
d9800920 | 537 | /* |
1e46a50f TD |
538 | * This call registers an "outside consumer" for a session and an lttng domain. |
539 | * No consumer will be spawned and all fds/commands will go through the socket | |
540 | * path given (socket_path). | |
d9800920 | 541 | * |
7389132f DG |
542 | * NOTE that this is not recommended unless you absolutely know what you are |
543 | * doing. | |
544 | * | |
545 | * Return 0 on success else a negative LTTng error code. | |
d9800920 DG |
546 | */ |
547 | extern int lttng_register_consumer(struct lttng_handle *handle, | |
548 | const char *socket_path); | |
549 | ||
7d29a247 | 550 | /* |
7389132f DG |
551 | * Start tracing for *all* domain(s) in the session. |
552 | * | |
553 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 554 | */ |
6a4f824d | 555 | extern int lttng_start_tracing(const char *session_name); |
f3ed775e | 556 | |
7d29a247 | 557 | /* |
7389132f | 558 | * Stop tracing for *all* domain(s) in the session. |
38ee087f DG |
559 | * |
560 | * This call will wait for data availability for each domain of the session so | |
561 | * this can take an abritrary amount of time. However, when returning you have | |
7389132f | 562 | * the guarantee that the data is ready to be read and analyze. Use the |
38ee087f | 563 | * _no_wait call below to avoid this behavior. |
41039c06 DG |
564 | * |
565 | * The session_name can't be NULL. | |
7389132f DG |
566 | * |
567 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 568 | */ |
6a4f824d | 569 | extern int lttng_stop_tracing(const char *session_name); |
f3ed775e | 570 | |
38ee087f DG |
571 | /* |
572 | * Behave exactly like lttng_stop_tracing but does not wait for data | |
573 | * availability. | |
574 | */ | |
575 | extern int lttng_stop_tracing_no_wait(const char *session_name); | |
576 | ||
b7384347 | 577 | /* |
1e46a50f | 578 | * Add context to event(s) for a specific channel (or for all). |
7d29a247 | 579 | * |
7389132f DG |
580 | * If the channel_name is NULL and they are no channel for the domain, the |
581 | * default channel is created (channel0). The context is then added on ALL | |
582 | * channels since no name was specified. | |
583 | * | |
584 | * The event_name is ignored since adding a context to an event is not possible | |
585 | * for now. | |
41039c06 | 586 | * |
7389132f | 587 | * Return 0 on success else a negative LTTng error code. |
b7384347 | 588 | */ |
cd80958d | 589 | extern int lttng_add_context(struct lttng_handle *handle, |
38057ed1 DG |
590 | struct lttng_event_context *ctx, const char *event_name, |
591 | const char *channel_name); | |
f3ed775e | 592 | |
7d29a247 | 593 | /* |
c8f61fc6 | 594 | * Create or enable an event (or events) for a channel. |
7d29a247 DG |
595 | * |
596 | * If the event you are trying to enable does not exist, it will be created, | |
7389132f DG |
597 | * else it is enabled. If channel_name is NULL, the default channel is used |
598 | * (channel0). | |
41039c06 DG |
599 | * |
600 | * The handle and ev params can not be NULL. | |
7389132f DG |
601 | * |
602 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 603 | */ |
cd80958d DG |
604 | extern int lttng_enable_event(struct lttng_handle *handle, |
605 | struct lttng_event *ev, const char *channel_name); | |
f3ed775e | 606 | |
53a80697 | 607 | /* |
025faf73 | 608 | * Create or enable an event with a specific filter. |
53a80697 | 609 | * |
025faf73 DG |
610 | * If the event you are trying to enable does not exist, it will be created, |
611 | * else it is enabled. | |
41039c06 | 612 | * If ev is NULL, all events are enabled with that filter. |
025faf73 DG |
613 | * If channel_name is NULL, the default channel is used (channel0) and created |
614 | * if not found. | |
52df2401 MD |
615 | * If filter_expression is NULL, an event without associated filter is |
616 | * created. | |
7389132f DG |
617 | * |
618 | * Return 0 on success else a negative LTTng error code. | |
53a80697 | 619 | */ |
025faf73 | 620 | extern int lttng_enable_event_with_filter(struct lttng_handle *handle, |
178191b3 | 621 | struct lttng_event *event, const char *channel_name, |
53a80697 | 622 | const char *filter_expression); |
178191b3 | 623 | |
93deb080 JI |
624 | /* |
625 | * Create or enable an event with a filter and/or exclusions. | |
626 | * | |
627 | * If the event you are trying to enable does not exist, it will be created, | |
628 | * else it is enabled. | |
629 | * If ev is NULL, all events are enabled with the filter and exclusion options. | |
630 | * If channel_name is NULL, the default channel is used (channel0) and created | |
631 | * if not found. | |
632 | * If filter_expression is NULL, an event without associated filter is | |
633 | * created. | |
634 | * If exclusion count is zero, the event will be created without exclusions. | |
7389132f DG |
635 | * |
636 | * Return 0 on success else a negative LTTng error code. | |
93deb080 JI |
637 | */ |
638 | extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle, | |
639 | struct lttng_event *event, const char *channel_name, | |
640 | const char *filter_expression, | |
641 | int exclusion_count, char **exclusion_names); | |
642 | ||
7d29a247 | 643 | /* |
c8f61fc6 | 644 | * Create or enable a channel. |
41039c06 DG |
645 | * |
646 | * The chan and handle params can not be NULL. | |
7389132f DG |
647 | * |
648 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 649 | */ |
cd80958d | 650 | extern int lttng_enable_channel(struct lttng_handle *handle, |
38057ed1 | 651 | struct lttng_channel *chan); |
f3ed775e | 652 | |
7d29a247 | 653 | /* |
c8f61fc6 | 654 | * Disable event(s) of a channel and domain. |
7d29a247 | 655 | * |
41039c06 | 656 | * If name is NULL, all events are disabled. |
7d29a247 | 657 | * If channel_name is NULL, the default channel is used (channel0). |
7389132f DG |
658 | * |
659 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 660 | */ |
cd80958d DG |
661 | extern int lttng_disable_event(struct lttng_handle *handle, |
662 | const char *name, const char *channel_name); | |
fac6795d | 663 | |
1df4dedd | 664 | /* |
c8f61fc6 | 665 | * Disable channel. |
7d29a247 | 666 | * |
7389132f DG |
667 | * Name and handle CAN NOT be NULL. |
668 | * | |
669 | * Return 0 on success else a negative LTTng error code. | |
1df4dedd | 670 | */ |
cd80958d | 671 | extern int lttng_disable_channel(struct lttng_handle *handle, |
38057ed1 | 672 | const char *name); |
1df4dedd | 673 | |
d0254c7c MD |
674 | /* |
675 | * Calibrate LTTng overhead. | |
41039c06 DG |
676 | * |
677 | * The chan and handle params can not be NULL. | |
7389132f DG |
678 | * |
679 | * Return 0 on success else a negative LTTng error code. | |
d0254c7c | 680 | */ |
cd80958d | 681 | extern int lttng_calibrate(struct lttng_handle *handle, |
d0254c7c MD |
682 | struct lttng_calibrate *calibrate); |
683 | ||
5edd7e09 DG |
684 | /* |
685 | * Set the default channel attributes for a specific domain and an allocated | |
686 | * lttng_channel_attr pointer. | |
1e46a50f | 687 | * |
41039c06 | 688 | * If one or both arguments are NULL, nothing happens. |
5edd7e09 DG |
689 | */ |
690 | extern void lttng_channel_set_default_attr(struct lttng_domain *domain, | |
691 | struct lttng_channel_attr *attr); | |
692 | ||
00e2e675 | 693 | /* |
a4b92340 DG |
694 | * Set URL for a consumer for a session and domain. |
695 | * | |
696 | * Both data and control URL must be defined. If both URLs are the same, only | |
697 | * the control URL is used even for network streaming. | |
00e2e675 | 698 | * |
a4b92340 DG |
699 | * Default port are 5342 and 5343 respectively for control and data which uses |
700 | * the TCP protocol. | |
7389132f DG |
701 | * |
702 | * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] | |
703 | * | |
704 | * Possible protocols are: | |
705 | * > file://... | |
706 | * Local filesystem full path. | |
707 | * | |
708 | * > net[6]://... | |
709 | * This will use the default network transport layer which is TCP for both | |
710 | * control (PORT1) and data port (PORT2). | |
711 | * | |
712 | * > tcp[6]://... | |
713 | * TCP only streaming. For this one, both data and control URL must be given. | |
714 | * | |
715 | * Return 0 on success else a negative LTTng error code. | |
00e2e675 | 716 | */ |
a4b92340 DG |
717 | extern int lttng_set_consumer_url(struct lttng_handle *handle, |
718 | const char *control_url, const char *data_url); | |
00e2e675 DG |
719 | |
720 | /* | |
721 | * Enable the consumer for a session and domain. | |
722 | */ | |
9c6bda17 | 723 | extern LTTNG_DEPRECATED("This call is now obsolete.") |
785d2d0d | 724 | int lttng_enable_consumer(struct lttng_handle *handle); |
00e2e675 DG |
725 | |
726 | /* | |
727 | * Disable consumer for a session and domain. | |
728 | */ | |
9c6bda17 | 729 | extern LTTNG_DEPRECATED("This call is now obsolete.") |
785d2d0d | 730 | int lttng_disable_consumer(struct lttng_handle *handle); |
00e2e675 | 731 | |
44a5e5eb DG |
732 | /* |
733 | * Check session daemon health for a specific component. | |
734 | * | |
735 | * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that | |
736 | * the control library was not able to connect to the session daemon health | |
737 | * socket. | |
738 | * | |
739 | * Any other positive value is an lttcomm error which can be translate with | |
740 | * lttng_strerror(). | |
41039c06 DG |
741 | * |
742 | * Please see lttng-health-check(3) man page for more information. | |
44a5e5eb | 743 | */ |
d74df422 MD |
744 | extern LTTNG_DEPRECATED("This call is now obsolete.") |
745 | int lttng_health_check(enum lttng_health_component c); | |
44a5e5eb | 746 | |
806e2684 DG |
747 | /* |
748 | * For a given session name, this call checks if the data is ready to be read | |
6d805429 DG |
749 | * or is still being extracted by the consumer(s) (pending) hence not ready to |
750 | * be used by any readers. | |
806e2684 | 751 | * |
6d805429 DG |
752 | * Return 0 if there is _no_ data pending in the buffers thus having a |
753 | * guarantee that the data can be read safely. Else, return 1 if there is still | |
754 | * traced data is pending. On error, a negative value is returned and readable | |
755 | * by lttng_strerror(). | |
806e2684 | 756 | */ |
6d805429 | 757 | extern int lttng_data_pending(const char *session_name); |
806e2684 | 758 | |
5168918c DG |
759 | #ifdef __cplusplus |
760 | } | |
761 | #endif | |
762 | ||
73db5be4 | 763 | #endif /* LTTNG_H */ |