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 TD |
8 | * This library is free software; you can redistribute it and/or modify it |
9 | * under the terms of the GNU Lesser General Public License as published by the | |
10 | * Free Software Foundation; only version 2.1 of the License. | |
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> |
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 | */ |
0a31fd3c | 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, | |
69892bbb | 68 | LTTNG_EVENT_TRACEPOINT_LOGLEVEL = 6, |
1657e9bb DG |
69 | }; |
70 | ||
e6ddca71 DG |
71 | /* |
72 | * LTTng consumer mode | |
73 | */ | |
74 | enum lttng_event_output { | |
d78d6610 DG |
75 | LTTNG_EVENT_SPLICE = 0, |
76 | LTTNG_EVENT_MMAP = 1, | |
e6ddca71 DG |
77 | }; |
78 | ||
7d29a247 DG |
79 | /* Event context possible type */ |
80 | enum lttng_event_context_type { | |
d78d6610 DG |
81 | LTTNG_EVENT_CONTEXT_PID = 0, |
82 | LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, | |
9197c5c4 | 83 | LTTNG_EVENT_CONTEXT_PROCNAME = 2, |
d78d6610 DG |
84 | LTTNG_EVENT_CONTEXT_PRIO = 3, |
85 | LTTNG_EVENT_CONTEXT_NICE = 4, | |
86 | LTTNG_EVENT_CONTEXT_VPID = 5, | |
87 | LTTNG_EVENT_CONTEXT_TID = 6, | |
88 | LTTNG_EVENT_CONTEXT_VTID = 7, | |
89 | LTTNG_EVENT_CONTEXT_PPID = 8, | |
90 | LTTNG_EVENT_CONTEXT_VPPID = 9, | |
9197c5c4 | 91 | LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10, |
d65106b1 DG |
92 | }; |
93 | ||
d0254c7c | 94 | enum lttng_calibrate_type { |
d78d6610 | 95 | LTTNG_CALIBRATE_FUNCTION = 0, |
d0254c7c MD |
96 | }; |
97 | ||
9f19cc17 DG |
98 | struct lttng_domain { |
99 | enum lttng_domain_type type; | |
100 | union { | |
101 | pid_t pid; | |
102 | char exec_name[NAME_MAX]; | |
103 | } attr; | |
104 | }; | |
105 | ||
d65106b1 | 106 | /* Perf counter attributes */ |
7d29a247 | 107 | struct lttng_event_perf_counter_ctx { |
d65106b1 DG |
108 | uint32_t type; |
109 | uint64_t config; | |
110 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
111 | }; | |
112 | ||
113 | /* Event/Channel context */ | |
7d29a247 DG |
114 | struct lttng_event_context { |
115 | enum lttng_event_context_type ctx; | |
d65106b1 | 116 | union { |
7d29a247 | 117 | struct lttng_event_perf_counter_ctx perf_counter; |
d65106b1 DG |
118 | } u; |
119 | }; | |
120 | ||
b7384347 | 121 | /* |
7d29a247 DG |
122 | * Event probe. |
123 | * | |
124 | * Either addr is used or symbol_name and offset. | |
57167058 | 125 | */ |
7d29a247 | 126 | struct lttng_event_probe_attr { |
f3ed775e DG |
127 | uint64_t addr; |
128 | ||
129 | uint64_t offset; | |
130 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
57167058 DG |
131 | }; |
132 | ||
b7384347 | 133 | /* |
f3ed775e DG |
134 | * Function tracer |
135 | */ | |
136 | struct lttng_event_function_attr { | |
137 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
138 | }; | |
139 | ||
140 | /* | |
141 | * Generic lttng event | |
142 | */ | |
143 | struct lttng_event { | |
144 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
81afa345 | 145 | char loglevel[LTTNG_SYMBOL_NAME_LEN]; |
69892bbb DG |
146 | int64_t loglevel_value; |
147 | enum lttng_event_type type; | |
9f19cc17 | 148 | uint32_t enabled; |
b551a063 | 149 | pid_t pid; |
f3ed775e DG |
150 | /* Per event type configuration */ |
151 | union { | |
7d29a247 | 152 | struct lttng_event_probe_attr probe; |
f3ed775e DG |
153 | struct lttng_event_function_attr ftrace; |
154 | } attr; | |
155 | }; | |
156 | ||
e6ddca71 DG |
157 | /* |
158 | * Tracer channel attributes. For both kernel and user-space. | |
159 | */ | |
f3ed775e | 160 | struct lttng_channel_attr { |
8ce37aa5 DG |
161 | int overwrite; /* 1: overwrite, 0: discard */ |
162 | uint64_t subbuf_size; /* bytes */ | |
163 | uint64_t num_subbuf; /* power of 2 */ | |
164 | unsigned int switch_timer_interval; /* usec */ | |
165 | unsigned int read_timer_interval; /* usec */ | |
f05b5f07 | 166 | enum lttng_event_output output; /* splice, mmap */ |
f3ed775e DG |
167 | }; |
168 | ||
169 | /* | |
e6ddca71 | 170 | * Channel information structure. For both kernel and user-space. |
1657e9bb | 171 | */ |
e6ddca71 | 172 | struct lttng_channel { |
045e5491 | 173 | char name[LTTNG_SYMBOL_NAME_LEN]; |
9f19cc17 | 174 | uint32_t enabled; |
e6ddca71 | 175 | struct lttng_channel_attr attr; |
f3ed775e DG |
176 | }; |
177 | ||
d0254c7c MD |
178 | struct lttng_calibrate { |
179 | enum lttng_calibrate_type type; | |
180 | }; | |
181 | ||
e6ddca71 DG |
182 | /* |
183 | * Basic session information. | |
184 | * | |
185 | * This is an 'output data' meaning that it only comes *from* the session | |
186 | * daemon *to* the lttng client. It's basically a 'human' representation of | |
187 | * tracing entities (here a session). | |
188 | */ | |
189 | struct lttng_session { | |
f3ed775e | 190 | char name[NAME_MAX]; |
e6ddca71 DG |
191 | /* The path where traces are written */ |
192 | char path[PATH_MAX]; | |
464dd62d | 193 | uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ |
1657e9bb DG |
194 | }; |
195 | ||
cd80958d DG |
196 | /* |
197 | * Handle used as a context for commands. | |
198 | */ | |
199 | struct lttng_handle { | |
200 | char session_name[NAME_MAX]; | |
201 | struct lttng_domain domain; | |
202 | }; | |
203 | ||
7d29a247 DG |
204 | /* |
205 | * Public LTTng control API | |
206 | * | |
1e46a50f | 207 | * For functions having an lttng domain type as parameter, if a bad value is |
7d29a247 DG |
208 | * given, NO default is applied and an error is returned. |
209 | * | |
210 | * On success, all functions of the API return 0 or the size of the allocated | |
1e46a50f | 211 | * array (in bytes). |
7d29a247 DG |
212 | * |
213 | * On error, a negative value is returned being a specific lttng-tools error | |
9a745bc7 | 214 | * code which can be humanly interpreted with lttng_strerror(err). |
1e46a50f TD |
215 | * |
216 | * Exceptions to this are noted below. | |
7d29a247 DG |
217 | */ |
218 | ||
b7384347 | 219 | /* |
1e46a50f | 220 | * Create a handle used as a context for every request made to the library. |
cd80958d DG |
221 | * |
222 | * This handle contains the session name and lttng domain on which the command | |
1e46a50f TD |
223 | * will be executed. |
224 | * The returned pointer will be NULL in case of malloc() error. | |
cd80958d DG |
225 | */ |
226 | extern struct lttng_handle *lttng_create_handle(const char *session_name, | |
227 | struct lttng_domain *domain); | |
228 | ||
229 | /* | |
1e46a50f TD |
230 | * Destroy a handle. This will simply free(3) the data pointer returned by |
231 | * lttng_create_handle(), rendering it unusable. | |
b7384347 | 232 | */ |
cd80958d | 233 | extern void lttng_destroy_handle(struct lttng_handle *handle); |
7d29a247 DG |
234 | |
235 | /* | |
1e46a50f TD |
236 | * Create a tracing session using a name and a path where the trace will be |
237 | * written. | |
7d29a247 | 238 | */ |
38057ed1 | 239 | extern int lttng_create_session(const char *name, const char *path); |
f3ed775e | 240 | |
7d29a247 | 241 | /* |
1e46a50f | 242 | * Destroy a tracing session. |
7d29a247 | 243 | * |
1e46a50f TD |
244 | * The session will not be usable anymore, tracing will be stopped for all |
245 | * registered traces, and the tracing buffers will be flushed. | |
7d29a247 | 246 | */ |
843f5df9 | 247 | extern int lttng_destroy_session(const char *name); |
f3ed775e | 248 | |
e6ddca71 | 249 | /* |
1e46a50f | 250 | * List all the tracing sessions. |
7d29a247 | 251 | * |
1e46a50f TD |
252 | * Return the size (number of entries) of the "lttng_session" array. Caller |
253 | * must free(3). | |
e6ddca71 | 254 | */ |
ca95a216 | 255 | extern int lttng_list_sessions(struct lttng_session **sessions); |
f3ed775e | 256 | |
9f19cc17 | 257 | /* |
1e46a50f | 258 | * List the registered domain(s) of a session. |
9f19cc17 | 259 | * |
1e46a50f TD |
260 | * Return the size (number of entries) of the "lttng_domain" array. Caller |
261 | * must free(3). | |
9f19cc17 | 262 | */ |
330be774 | 263 | extern int lttng_list_domains(const char *session_name, |
9f19cc17 DG |
264 | struct lttng_domain **domains); |
265 | ||
266 | /* | |
1e46a50f | 267 | * List the channel(s) of a session. |
9f19cc17 | 268 | * |
1e46a50f TD |
269 | * Return the size (number of entries) of the "lttng_channel" array. Caller |
270 | * must free(3). | |
9f19cc17 | 271 | */ |
cd80958d DG |
272 | extern int lttng_list_channels(struct lttng_handle *handle, |
273 | struct lttng_channel **channels); | |
9f19cc17 DG |
274 | |
275 | /* | |
1e46a50f | 276 | * List the event(s) of a session channel. |
9f19cc17 | 277 | * |
1e46a50f TD |
278 | * Return the size (number of entries) of the "lttng_event" array. |
279 | * Caller must free(3). | |
9f19cc17 | 280 | */ |
cd80958d DG |
281 | extern int lttng_list_events(struct lttng_handle *handle, |
282 | const char *channel_name, struct lttng_event **events); | |
9f19cc17 DG |
283 | |
284 | /* | |
1e46a50f | 285 | * List the available tracepoints of a specific lttng domain. |
9f19cc17 | 286 | * |
1e46a50f TD |
287 | * Return the size (number of entries) of the "lttng_event" array. |
288 | * Caller must free(3). | |
9f19cc17 | 289 | */ |
cd80958d | 290 | extern int lttng_list_tracepoints(struct lttng_handle *handle, |
2a71efd5 | 291 | struct lttng_event **events); |
9f19cc17 | 292 | |
7d29a247 DG |
293 | /* |
294 | * Check if a session daemon is alive. | |
1e46a50f TD |
295 | * |
296 | * Return 1 if alive or 0 if not. On error returns a negative value. | |
7d29a247 | 297 | */ |
947308c4 | 298 | extern int lttng_session_daemon_alive(void); |
f3ed775e | 299 | |
7d29a247 | 300 | /* |
1e46a50f TD |
301 | * Set the tracing group for the *current* flow of execution. |
302 | * | |
303 | * On success, returns 0, on error, returns -1 (null name) or -ENOMEM. | |
7d29a247 | 304 | */ |
b7384347 | 305 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 306 | |
7d29a247 | 307 | /* |
1e46a50f | 308 | * Return a human-readable error message for an lttng-tools error code. |
7d29a247 DG |
309 | * |
310 | * Parameter MUST be a negative value or else you'll get a generic message. | |
311 | */ | |
9a745bc7 | 312 | extern const char *lttng_strerror(int code); |
b7384347 | 313 | |
d9800920 | 314 | /* |
1e46a50f TD |
315 | * This call registers an "outside consumer" for a session and an lttng domain. |
316 | * No consumer will be spawned and all fds/commands will go through the socket | |
317 | * path given (socket_path). | |
d9800920 | 318 | * |
3bd1e081 | 319 | * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the |
d9800920 DG |
320 | * command socket. The error socket is not supported yet for roaming consumers. |
321 | */ | |
322 | extern int lttng_register_consumer(struct lttng_handle *handle, | |
323 | const char *socket_path); | |
324 | ||
7d29a247 | 325 | /* |
1e46a50f | 326 | * Start tracing for *all* registered traces (kernel and user-space). |
7d29a247 | 327 | */ |
6a4f824d | 328 | extern int lttng_start_tracing(const char *session_name); |
f3ed775e | 329 | |
7d29a247 | 330 | /* |
1e46a50f | 331 | * Stop tracing for *all* registered traces (kernel and user-space). |
7d29a247 | 332 | */ |
6a4f824d | 333 | extern int lttng_stop_tracing(const char *session_name); |
f3ed775e | 334 | |
b7384347 | 335 | /* |
1e46a50f | 336 | * Add context to event(s) for a specific channel (or for all). |
7d29a247 | 337 | * |
1e46a50f | 338 | * If event_name is NULL, the context is applied to all events of the channel. |
7d29a247 | 339 | * If channel_name is NULL, a lookup of the event's channel is done. |
1e46a50f | 340 | * If both are NULL, the context is applied to all events of all channels. |
b7384347 | 341 | */ |
cd80958d | 342 | extern int lttng_add_context(struct lttng_handle *handle, |
38057ed1 DG |
343 | struct lttng_event_context *ctx, const char *event_name, |
344 | const char *channel_name); | |
f3ed775e | 345 | |
7d29a247 | 346 | /* |
1e46a50f | 347 | * Create or enable a kernel event (or events) for a channel. |
7d29a247 DG |
348 | * |
349 | * If the event you are trying to enable does not exist, it will be created, | |
350 | * else it is enabled. | |
1e46a50f | 351 | * If event_name is NULL, all events are enabled. |
7d29a247 DG |
352 | * If channel_name is NULL, the default channel is used (channel0). |
353 | */ | |
cd80958d DG |
354 | extern int lttng_enable_event(struct lttng_handle *handle, |
355 | struct lttng_event *ev, const char *channel_name); | |
f3ed775e | 356 | |
7d29a247 DG |
357 | /* |
358 | * Create or enable a kernel channel. | |
1e46a50f | 359 | * The channel name cannot be NULL. |
7d29a247 | 360 | */ |
cd80958d | 361 | extern int lttng_enable_channel(struct lttng_handle *handle, |
38057ed1 | 362 | struct lttng_channel *chan); |
f3ed775e | 363 | |
7d29a247 | 364 | /* |
1e46a50f | 365 | * Disable kernel event(s) of a channel and domain. |
7d29a247 | 366 | * |
1e46a50f | 367 | * If event_name is NULL, all events are disabled. |
7d29a247 DG |
368 | * If channel_name is NULL, the default channel is used (channel0). |
369 | */ | |
cd80958d DG |
370 | extern int lttng_disable_event(struct lttng_handle *handle, |
371 | const char *name, const char *channel_name); | |
fac6795d | 372 | |
1df4dedd | 373 | /* |
7d29a247 DG |
374 | * Disable kernel channel. |
375 | * | |
1e46a50f | 376 | * The channel name cannot be NULL. |
1df4dedd | 377 | */ |
cd80958d | 378 | extern int lttng_disable_channel(struct lttng_handle *handle, |
38057ed1 | 379 | const char *name); |
1df4dedd | 380 | |
d0254c7c MD |
381 | /* |
382 | * Calibrate LTTng overhead. | |
383 | */ | |
cd80958d | 384 | extern int lttng_calibrate(struct lttng_handle *handle, |
d0254c7c MD |
385 | struct lttng_calibrate *calibrate); |
386 | ||
5edd7e09 DG |
387 | /* |
388 | * Set the default channel attributes for a specific domain and an allocated | |
389 | * lttng_channel_attr pointer. | |
1e46a50f TD |
390 | * |
391 | * If either or both of the arguments are NULL, nothing happens. | |
5edd7e09 DG |
392 | */ |
393 | extern void lttng_channel_set_default_attr(struct lttng_domain *domain, | |
394 | struct lttng_channel_attr *attr); | |
395 | ||
b7384347 | 396 | #endif /* _LTTNG_H */ |