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 | ||
b7384347 DG |
22 | #ifndef _LTTNG_H |
23 | #define _LTTNG_H | |
fac6795d | 24 | |
57167058 | 25 | #include <limits.h> |
3a5713da | 26 | #include <netinet/in.h> |
1e307fab DG |
27 | #include <stdint.h> |
28 | #include <sys/types.h> | |
57167058 | 29 | |
b7384347 | 30 | /* |
e6ddca71 | 31 | * Event symbol length. Copied from LTTng kernel ABI. |
1657e9bb | 32 | */ |
8d326ab9 | 33 | #define LTTNG_SYMBOL_NAME_LEN 256 |
f3ed775e | 34 | |
3a5713da DG |
35 | /* |
36 | * Maximum length of a domain name. This is the limit for the total length of a | |
37 | * domain name specified by the RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) | |
38 | */ | |
39 | #define LTTNG_MAX_DNNAME 255 | |
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, |
d65106b1 DG |
128 | }; |
129 | ||
d0254c7c | 130 | enum lttng_calibrate_type { |
d78d6610 | 131 | LTTNG_CALIBRATE_FUNCTION = 0, |
d0254c7c MD |
132 | }; |
133 | ||
3a5713da DG |
134 | /* Destination type of lttng URI */ |
135 | enum lttng_dst_type { | |
00e2e675 DG |
136 | LTTNG_DST_IPV4 = 1, |
137 | LTTNG_DST_IPV6 = 2, | |
138 | LTTNG_DST_PATH = 3, | |
3a5713da DG |
139 | }; |
140 | ||
141 | /* Type of lttng URI where it is a final destination or a hop */ | |
142 | enum lttng_uri_type { | |
143 | LTTNG_URI_DST, /* The URI is a final destination */ | |
144 | /* | |
145 | * Hop are not supported yet but planned for a future release. | |
146 | * | |
147 | LTTNG_URI_HOP, | |
148 | */ | |
149 | }; | |
150 | ||
151 | /* Communication stream type of a lttng URI */ | |
152 | enum lttng_stream_type { | |
153 | LTTNG_STREAM_CONTROL, | |
154 | LTTNG_STREAM_DATA, | |
155 | }; | |
156 | ||
157 | /* | |
158 | * Protocol type of a lttng URI. The value 0 indicate that the proto_type field | |
159 | * should be ignored. | |
160 | */ | |
161 | enum lttng_proto_type { | |
162 | LTTNG_TCP = 1, | |
163 | /* | |
164 | * UDP protocol is not supported for now. | |
165 | * | |
166 | LTTNG_UDP = 2, | |
167 | */ | |
168 | }; | |
169 | ||
170 | /* | |
171 | * Structure representing an URI supported by lttng. | |
172 | */ | |
173 | #define LTTNG_URI_PADDING1_LEN 16 | |
174 | #define LTTNG_URI_PADDING2_LEN LTTNG_SYMBOL_NAME_LEN + 32 | |
175 | struct lttng_uri { | |
176 | enum lttng_dst_type dtype; | |
177 | enum lttng_uri_type utype; | |
178 | enum lttng_stream_type stype; | |
179 | enum lttng_proto_type proto; | |
180 | in_port_t port; | |
181 | char padding[LTTNG_URI_PADDING1_LEN]; | |
00e2e675 | 182 | char subdir[PATH_MAX]; |
3a5713da DG |
183 | union { |
184 | char ipv4[INET_ADDRSTRLEN]; | |
185 | char ipv6[INET6_ADDRSTRLEN]; | |
186 | char path[PATH_MAX]; | |
187 | char padding[LTTNG_URI_PADDING2_LEN]; | |
188 | } dst; | |
189 | }; | |
190 | ||
ece640c8 RB |
191 | /* |
192 | * The structures should be initialized to zero before use. | |
193 | */ | |
8d326ab9 DG |
194 | #define LTTNG_DOMAIN_PADDING1 16 |
195 | #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 | |
9f19cc17 DG |
196 | struct lttng_domain { |
197 | enum lttng_domain_type type; | |
8d326ab9 DG |
198 | char padding[LTTNG_DOMAIN_PADDING1]; |
199 | ||
9f19cc17 DG |
200 | union { |
201 | pid_t pid; | |
202 | char exec_name[NAME_MAX]; | |
8d326ab9 | 203 | char padding[LTTNG_DOMAIN_PADDING2]; |
9f19cc17 DG |
204 | } attr; |
205 | }; | |
206 | ||
ece640c8 RB |
207 | /* |
208 | * Perf counter attributes | |
209 | * | |
210 | * The structures should be initialized to zero before use. | |
211 | */ | |
8d326ab9 | 212 | #define LTTNG_PERF_EVENT_PADDING1 16 |
7d29a247 | 213 | struct lttng_event_perf_counter_ctx { |
d65106b1 DG |
214 | uint32_t type; |
215 | uint64_t config; | |
216 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
217 | |
218 | char padding[LTTNG_PERF_EVENT_PADDING1]; | |
d65106b1 DG |
219 | }; |
220 | ||
ece640c8 RB |
221 | /* |
222 | * Event/channel context | |
223 | * | |
224 | * The structures should be initialized to zero before use. | |
225 | */ | |
8d326ab9 DG |
226 | #define LTTNG_EVENT_CONTEXT_PADDING1 16 |
227 | #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 | |
7d29a247 DG |
228 | struct lttng_event_context { |
229 | enum lttng_event_context_type ctx; | |
8d326ab9 DG |
230 | char padding[LTTNG_EVENT_CONTEXT_PADDING1]; |
231 | ||
d65106b1 | 232 | union { |
7d29a247 | 233 | struct lttng_event_perf_counter_ctx perf_counter; |
8d326ab9 | 234 | char padding[LTTNG_EVENT_CONTEXT_PADDING2]; |
d65106b1 DG |
235 | } u; |
236 | }; | |
237 | ||
b7384347 | 238 | /* |
7d29a247 DG |
239 | * Event probe. |
240 | * | |
241 | * Either addr is used or symbol_name and offset. | |
ece640c8 RB |
242 | * |
243 | * The structures should be initialized to zero before use. | |
57167058 | 244 | */ |
8d326ab9 | 245 | #define LTTNG_EVENT_PROBE_PADDING1 16 |
7d29a247 | 246 | struct lttng_event_probe_attr { |
f3ed775e DG |
247 | uint64_t addr; |
248 | ||
249 | uint64_t offset; | |
250 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
251 | |
252 | char padding[LTTNG_EVENT_PROBE_PADDING1]; | |
57167058 DG |
253 | }; |
254 | ||
b7384347 | 255 | /* |
f3ed775e | 256 | * Function tracer |
ece640c8 RB |
257 | * |
258 | * The structures should be initialized to zero before use. | |
f3ed775e | 259 | */ |
8d326ab9 | 260 | #define LTTNG_EVENT_FUNCTION_PADDING1 16 |
f3ed775e DG |
261 | struct lttng_event_function_attr { |
262 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
8d326ab9 DG |
263 | |
264 | char padding[LTTNG_EVENT_FUNCTION_PADDING1]; | |
f3ed775e DG |
265 | }; |
266 | ||
267 | /* | |
268 | * Generic lttng event | |
ece640c8 RB |
269 | * |
270 | * The structures should be initialized to zero before use. | |
f3ed775e | 271 | */ |
fceb65df | 272 | #define LTTNG_EVENT_PADDING1 15 |
8d326ab9 | 273 | #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 |
f3ed775e | 274 | struct lttng_event { |
0cda4f28 | 275 | enum lttng_event_type type; |
f3ed775e | 276 | char name[LTTNG_SYMBOL_NAME_LEN]; |
0cda4f28 MD |
277 | |
278 | enum lttng_loglevel_type loglevel_type; | |
8005f29a | 279 | int loglevel; |
0cda4f28 | 280 | |
35dc4d62 | 281 | int32_t enabled; /* Does not apply: -1 */ |
b551a063 | 282 | pid_t pid; |
fceb65df | 283 | unsigned char filter; /* filter enabled ? */ |
8d326ab9 DG |
284 | |
285 | char padding[LTTNG_EVENT_PADDING1]; | |
286 | ||
f3ed775e DG |
287 | /* Per event type configuration */ |
288 | union { | |
7d29a247 | 289 | struct lttng_event_probe_attr probe; |
f3ed775e | 290 | struct lttng_event_function_attr ftrace; |
8d326ab9 DG |
291 | |
292 | char padding[LTTNG_EVENT_PADDING2]; | |
f3ed775e DG |
293 | } attr; |
294 | }; | |
295 | ||
f37d259d MD |
296 | enum lttng_event_field_type { |
297 | LTTNG_EVENT_FIELD_OTHER = 0, | |
298 | LTTNG_EVENT_FIELD_INTEGER = 1, | |
299 | LTTNG_EVENT_FIELD_ENUM = 2, | |
300 | LTTNG_EVENT_FIELD_FLOAT = 3, | |
301 | LTTNG_EVENT_FIELD_STRING = 4, | |
302 | }; | |
303 | ||
304 | #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32 | |
305 | struct lttng_event_field { | |
306 | char field_name[LTTNG_SYMBOL_NAME_LEN]; | |
307 | enum lttng_event_field_type type; | |
308 | char padding[LTTNG_EVENT_FIELD_PADDING]; | |
309 | struct lttng_event event; | |
310 | }; | |
311 | ||
e6ddca71 DG |
312 | /* |
313 | * Tracer channel attributes. For both kernel and user-space. | |
ece640c8 RB |
314 | * |
315 | * The structures should be initialized to zero before use. | |
e6ddca71 | 316 | */ |
8d326ab9 | 317 | #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32 |
f3ed775e | 318 | struct lttng_channel_attr { |
8ce37aa5 DG |
319 | int overwrite; /* 1: overwrite, 0: discard */ |
320 | uint64_t subbuf_size; /* bytes */ | |
321 | uint64_t num_subbuf; /* power of 2 */ | |
322 | unsigned int switch_timer_interval; /* usec */ | |
323 | unsigned int read_timer_interval; /* usec */ | |
f05b5f07 | 324 | enum lttng_event_output output; /* splice, mmap */ |
8d326ab9 DG |
325 | |
326 | char padding[LTTNG_CHANNEL_ATTR_PADDING1]; | |
f3ed775e DG |
327 | }; |
328 | ||
329 | /* | |
e6ddca71 | 330 | * Channel information structure. For both kernel and user-space. |
ece640c8 RB |
331 | * |
332 | * The structures should be initialized to zero before use. | |
1657e9bb | 333 | */ |
8d326ab9 | 334 | #define LTTNG_CHANNEL_PADDING1 16 |
e6ddca71 | 335 | struct lttng_channel { |
045e5491 | 336 | char name[LTTNG_SYMBOL_NAME_LEN]; |
9f19cc17 | 337 | uint32_t enabled; |
e6ddca71 | 338 | struct lttng_channel_attr attr; |
8d326ab9 DG |
339 | |
340 | char padding[LTTNG_CHANNEL_PADDING1]; | |
f3ed775e DG |
341 | }; |
342 | ||
8d326ab9 | 343 | #define LTTNG_CALIBRATE_PADDING1 16 |
d0254c7c MD |
344 | struct lttng_calibrate { |
345 | enum lttng_calibrate_type type; | |
8d326ab9 DG |
346 | |
347 | char padding[LTTNG_CALIBRATE_PADDING1]; | |
d0254c7c MD |
348 | }; |
349 | ||
e6ddca71 DG |
350 | /* |
351 | * Basic session information. | |
352 | * | |
353 | * This is an 'output data' meaning that it only comes *from* the session | |
354 | * daemon *to* the lttng client. It's basically a 'human' representation of | |
355 | * tracing entities (here a session). | |
ece640c8 RB |
356 | * |
357 | * The structures should be initialized to zero before use. | |
e6ddca71 | 358 | */ |
8d326ab9 | 359 | #define LTTNG_SESSION_PADDING1 16 |
e6ddca71 | 360 | struct lttng_session { |
f3ed775e | 361 | char name[NAME_MAX]; |
e6ddca71 DG |
362 | /* The path where traces are written */ |
363 | char path[PATH_MAX]; | |
464dd62d | 364 | uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ |
8d326ab9 DG |
365 | |
366 | char padding[LTTNG_SESSION_PADDING1]; | |
1657e9bb DG |
367 | }; |
368 | ||
cd80958d DG |
369 | /* |
370 | * Handle used as a context for commands. | |
ece640c8 RB |
371 | * |
372 | * The structures should be initialized to zero before use. | |
cd80958d | 373 | */ |
8d326ab9 | 374 | #define LTTNG_HANDLE_PADDING1 16 |
cd80958d DG |
375 | struct lttng_handle { |
376 | char session_name[NAME_MAX]; | |
377 | struct lttng_domain domain; | |
8d326ab9 DG |
378 | |
379 | char padding[LTTNG_HANDLE_PADDING1]; | |
cd80958d DG |
380 | }; |
381 | ||
7d29a247 DG |
382 | /* |
383 | * Public LTTng control API | |
384 | * | |
1e46a50f | 385 | * For functions having an lttng domain type as parameter, if a bad value is |
7d29a247 DG |
386 | * given, NO default is applied and an error is returned. |
387 | * | |
388 | * On success, all functions of the API return 0 or the size of the allocated | |
1e46a50f | 389 | * array (in bytes). |
7d29a247 DG |
390 | * |
391 | * On error, a negative value is returned being a specific lttng-tools error | |
9a745bc7 | 392 | * code which can be humanly interpreted with lttng_strerror(err). |
1e46a50f TD |
393 | * |
394 | * Exceptions to this are noted below. | |
7d29a247 DG |
395 | */ |
396 | ||
b7384347 | 397 | /* |
1e46a50f | 398 | * Create a handle used as a context for every request made to the library. |
cd80958d DG |
399 | * |
400 | * This handle contains the session name and lttng domain on which the command | |
1e46a50f TD |
401 | * will be executed. |
402 | * The returned pointer will be NULL in case of malloc() error. | |
cd80958d DG |
403 | */ |
404 | extern struct lttng_handle *lttng_create_handle(const char *session_name, | |
405 | struct lttng_domain *domain); | |
406 | ||
407 | /* | |
1e46a50f TD |
408 | * Destroy a handle. This will simply free(3) the data pointer returned by |
409 | * lttng_create_handle(), rendering it unusable. | |
b7384347 | 410 | */ |
cd80958d | 411 | extern void lttng_destroy_handle(struct lttng_handle *handle); |
7d29a247 DG |
412 | |
413 | /* | |
1e46a50f TD |
414 | * Create a tracing session using a name and a path where the trace will be |
415 | * written. | |
7d29a247 | 416 | */ |
38057ed1 | 417 | extern int lttng_create_session(const char *name, const char *path); |
f3ed775e | 418 | |
00e2e675 DG |
419 | /* |
420 | * Create a tracing sessioin using a name, URIs and a consumer enable flag. | |
421 | * The control URI is mandatory for consumer local or network. | |
422 | */ | |
423 | extern int lttng_create_session_uri(const char *name, | |
424 | struct lttng_uri *ctrl_uri, struct lttng_uri *data_uri, | |
425 | unsigned int enable_consumer); | |
426 | ||
7d29a247 | 427 | /* |
1e46a50f | 428 | * Destroy a tracing session. |
7d29a247 | 429 | * |
1e46a50f TD |
430 | * The session will not be usable anymore, tracing will be stopped for all |
431 | * registered traces, and the tracing buffers will be flushed. | |
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 | * | |
498 | * On success, returns 0, on error, returns -1 (null name) or -ENOMEM. | |
7d29a247 | 499 | */ |
b7384347 | 500 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 501 | |
7d29a247 | 502 | /* |
1e46a50f | 503 | * Return a human-readable error message for an lttng-tools error code. |
7d29a247 DG |
504 | * |
505 | * Parameter MUST be a negative value or else you'll get a generic message. | |
506 | */ | |
9a745bc7 | 507 | extern const char *lttng_strerror(int code); |
b7384347 | 508 | |
d9800920 | 509 | /* |
1e46a50f TD |
510 | * This call registers an "outside consumer" for a session and an lttng domain. |
511 | * No consumer will be spawned and all fds/commands will go through the socket | |
512 | * path given (socket_path). | |
d9800920 | 513 | * |
3bd1e081 | 514 | * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the |
d9800920 DG |
515 | * command socket. The error socket is not supported yet for roaming consumers. |
516 | */ | |
517 | extern int lttng_register_consumer(struct lttng_handle *handle, | |
518 | const char *socket_path); | |
519 | ||
7d29a247 | 520 | /* |
1e46a50f | 521 | * Start tracing for *all* registered traces (kernel and user-space). |
7d29a247 | 522 | */ |
6a4f824d | 523 | extern int lttng_start_tracing(const char *session_name); |
f3ed775e | 524 | |
7d29a247 | 525 | /* |
1e46a50f | 526 | * Stop tracing for *all* registered traces (kernel and user-space). |
7d29a247 | 527 | */ |
6a4f824d | 528 | extern int lttng_stop_tracing(const char *session_name); |
f3ed775e | 529 | |
b7384347 | 530 | /* |
1e46a50f | 531 | * Add context to event(s) for a specific channel (or for all). |
7d29a247 | 532 | * |
1e46a50f | 533 | * If event_name is NULL, the context is applied to all events of the channel. |
7d29a247 | 534 | * If channel_name is NULL, a lookup of the event's channel is done. |
1e46a50f | 535 | * If both are NULL, the context is applied to all events of all channels. |
b7384347 | 536 | */ |
cd80958d | 537 | extern int lttng_add_context(struct lttng_handle *handle, |
38057ed1 DG |
538 | struct lttng_event_context *ctx, const char *event_name, |
539 | const char *channel_name); | |
f3ed775e | 540 | |
7d29a247 | 541 | /* |
c8f61fc6 | 542 | * Create or enable an event (or events) for a channel. |
7d29a247 DG |
543 | * |
544 | * If the event you are trying to enable does not exist, it will be created, | |
545 | * else it is enabled. | |
1e46a50f | 546 | * If event_name is NULL, all events are enabled. |
7d29a247 DG |
547 | * If channel_name is NULL, the default channel is used (channel0). |
548 | */ | |
cd80958d DG |
549 | extern int lttng_enable_event(struct lttng_handle *handle, |
550 | struct lttng_event *ev, const char *channel_name); | |
f3ed775e | 551 | |
53a80697 MD |
552 | /* |
553 | * Apply a filter expression to an event. | |
554 | * | |
555 | * If event_name is NULL, the filter is applied to all events of the channel. | |
556 | * If channel_name is NULL, a lookup of the event's channel is done. | |
557 | * If both are NULL, the filter is applied to all events of all channels. | |
558 | */ | |
559 | extern int lttng_set_event_filter(struct lttng_handle *handle, | |
560 | const char *event_name, | |
561 | const char *channel_name, | |
562 | const char *filter_expression); | |
7d29a247 | 563 | /* |
c8f61fc6 | 564 | * Create or enable a channel. |
1e46a50f | 565 | * The channel name cannot be NULL. |
7d29a247 | 566 | */ |
cd80958d | 567 | extern int lttng_enable_channel(struct lttng_handle *handle, |
38057ed1 | 568 | struct lttng_channel *chan); |
f3ed775e | 569 | |
7d29a247 | 570 | /* |
c8f61fc6 | 571 | * Disable event(s) of a channel and domain. |
7d29a247 | 572 | * |
1e46a50f | 573 | * If event_name is NULL, all events are disabled. |
7d29a247 DG |
574 | * If channel_name is NULL, the default channel is used (channel0). |
575 | */ | |
cd80958d DG |
576 | extern int lttng_disable_event(struct lttng_handle *handle, |
577 | const char *name, const char *channel_name); | |
fac6795d | 578 | |
1df4dedd | 579 | /* |
c8f61fc6 | 580 | * Disable channel. |
7d29a247 | 581 | * |
1e46a50f | 582 | * The channel name cannot be NULL. |
1df4dedd | 583 | */ |
cd80958d | 584 | extern int lttng_disable_channel(struct lttng_handle *handle, |
38057ed1 | 585 | const char *name); |
1df4dedd | 586 | |
d0254c7c MD |
587 | /* |
588 | * Calibrate LTTng overhead. | |
589 | */ | |
cd80958d | 590 | extern int lttng_calibrate(struct lttng_handle *handle, |
d0254c7c MD |
591 | struct lttng_calibrate *calibrate); |
592 | ||
5edd7e09 DG |
593 | /* |
594 | * Set the default channel attributes for a specific domain and an allocated | |
595 | * lttng_channel_attr pointer. | |
1e46a50f TD |
596 | * |
597 | * If either or both of the arguments are NULL, nothing happens. | |
5edd7e09 DG |
598 | */ |
599 | extern void lttng_channel_set_default_attr(struct lttng_domain *domain, | |
600 | struct lttng_channel_attr *attr); | |
601 | ||
00e2e675 DG |
602 | /* |
603 | * Set URI for a consumer for a session and domain. | |
604 | * | |
605 | * For network streaming, both data and control stream type MUST be defined | |
606 | * with a specific URIs. Default port are 5342 and 5343 respectively for | |
607 | * control and data which uses the TCP protocol. | |
608 | */ | |
609 | extern int lttng_set_consumer_uri(struct lttng_handle *handle, | |
610 | struct lttng_uri *uri); | |
611 | ||
612 | /* | |
613 | * Enable the consumer for a session and domain. | |
614 | */ | |
615 | extern int lttng_enable_consumer(struct lttng_handle *handle); | |
616 | ||
617 | /* | |
618 | * Disable consumer for a session and domain. | |
619 | */ | |
620 | extern int lttng_disable_consumer(struct lttng_handle *handle); | |
621 | ||
b7384347 | 622 | #endif /* _LTTNG_H */ |