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