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