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