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