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 | * |
82a3637f DG |
8 | * This library is free software; you can redistribute it and/or |
9 | * modify it under the terms of the GNU Lesser General Public | |
10 | * License as published by the Free Software Foundation; only | |
11 | * version 2.1 of the License. | |
12 | * | |
13 | * This library is distributed in the hope that it will be useful, | |
fac6795d | 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
82a3637f DG |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU Lesser General Public | |
19 | * License along with this library; if not, write to the Free Software | |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
fac6795d DG |
21 | */ |
22 | ||
b7384347 DG |
23 | #ifndef _LTTNG_H |
24 | #define _LTTNG_H | |
fac6795d | 25 | |
57167058 | 26 | #include <limits.h> |
1e307fab DG |
27 | #include <stdint.h> |
28 | #include <sys/types.h> | |
57167058 | 29 | |
b7384347 DG |
30 | /* Default unix group name for tracing. */ |
31 | #define LTTNG_DEFAULT_TRACING_GROUP "tracing" | |
fac6795d | 32 | |
b7384347 | 33 | /* Environment variable to set session daemon binary path. */ |
5b8719f5 DG |
34 | #define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH" |
35 | ||
58a97671 DG |
36 | /* Default trace output directory name */ |
37 | #define LTTNG_DEFAULT_TRACE_DIR_NAME "lttng-traces" | |
38 | ||
b7384347 | 39 | /* |
e6ddca71 | 40 | * Event symbol length. Copied from LTTng kernel ABI. |
1657e9bb | 41 | */ |
f3ed775e DG |
42 | #define LTTNG_SYMBOL_NAME_LEN 128 |
43 | ||
e6ddca71 DG |
44 | /* |
45 | * Every lttng_event_* structure both apply to kernel event and user-space | |
46 | * event. | |
e6ddca71 DG |
47 | */ |
48 | ||
7d29a247 DG |
49 | /* |
50 | * Domain type are the different possible tracers. | |
51 | */ | |
52 | enum lttng_domain_type { | |
0d0c377a DG |
53 | LTTNG_DOMAIN_KERNEL = 1, |
54 | LTTNG_DOMAIN_UST = 2, | |
55 | LTTNG_DOMAIN_UST_EXEC_NAME = 3, | |
56 | LTTNG_DOMAIN_UST_PID = 4, | |
57 | LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5, | |
7d29a247 DG |
58 | }; |
59 | ||
7d29a247 DG |
60 | /* |
61 | * Instrumentation type of tracing event. | |
62 | */ | |
f3ed775e | 63 | enum lttng_event_type { |
e6ddca71 | 64 | LTTNG_EVENT_TRACEPOINT, |
7d29a247 | 65 | LTTNG_EVENT_PROBE, |
f3ed775e | 66 | LTTNG_EVENT_FUNCTION, |
8f0d098b | 67 | LTTNG_EVENT_FUNCTION_ENTRY, |
0133c199 | 68 | LTTNG_EVENT_NOOP, |
a54bd42d | 69 | LTTNG_EVENT_SYSCALL, |
1657e9bb DG |
70 | }; |
71 | ||
e6ddca71 DG |
72 | /* |
73 | * LTTng consumer mode | |
74 | */ | |
75 | enum lttng_event_output { | |
7d29a247 DG |
76 | LTTNG_EVENT_SPLICE = 0, |
77 | LTTNG_EVENT_MMAP = 1, | |
e6ddca71 DG |
78 | }; |
79 | ||
7d29a247 DG |
80 | /* Event context possible type */ |
81 | enum lttng_event_context_type { | |
82 | LTTNG_EVENT_CONTEXT_PID = 0, | |
83 | LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, | |
84 | LTTNG_EVENT_CONTEXT_COMM = 2, | |
85 | LTTNG_EVENT_CONTEXT_PRIO = 3, | |
86 | LTTNG_EVENT_CONTEXT_NICE = 4, | |
87 | LTTNG_EVENT_CONTEXT_VPID = 5, | |
88 | LTTNG_EVENT_CONTEXT_TID = 6, | |
89 | LTTNG_EVENT_CONTEXT_VTID = 7, | |
90 | LTTNG_EVENT_CONTEXT_PPID = 8, | |
91 | LTTNG_EVENT_CONTEXT_VPPID = 9, | |
d65106b1 DG |
92 | }; |
93 | ||
d0254c7c MD |
94 | enum lttng_calibrate_type { |
95 | LTTNG_CALIBRATE_FUNCTION = 0, | |
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]; | |
145 | enum lttng_event_type type; | |
9f19cc17 | 146 | uint32_t enabled; |
f3ed775e DG |
147 | /* Per event type configuration */ |
148 | union { | |
7d29a247 | 149 | struct lttng_event_probe_attr probe; |
f3ed775e DG |
150 | struct lttng_event_function_attr ftrace; |
151 | } attr; | |
152 | }; | |
153 | ||
e6ddca71 DG |
154 | /* |
155 | * Tracer channel attributes. For both kernel and user-space. | |
156 | */ | |
f3ed775e | 157 | struct lttng_channel_attr { |
8ce37aa5 DG |
158 | int overwrite; /* 1: overwrite, 0: discard */ |
159 | uint64_t subbuf_size; /* bytes */ | |
160 | uint64_t num_subbuf; /* power of 2 */ | |
161 | unsigned int switch_timer_interval; /* usec */ | |
162 | unsigned int read_timer_interval; /* usec */ | |
f05b5f07 | 163 | enum lttng_event_output output; /* splice, mmap */ |
f3ed775e DG |
164 | }; |
165 | ||
166 | /* | |
e6ddca71 | 167 | * Channel information structure. For both kernel and user-space. |
1657e9bb | 168 | */ |
e6ddca71 | 169 | struct lttng_channel { |
1657e9bb | 170 | char name[NAME_MAX]; |
9f19cc17 | 171 | uint32_t enabled; |
e6ddca71 | 172 | struct lttng_channel_attr attr; |
f3ed775e DG |
173 | }; |
174 | ||
d0254c7c MD |
175 | struct lttng_calibrate { |
176 | enum lttng_calibrate_type type; | |
177 | }; | |
178 | ||
e6ddca71 DG |
179 | /* |
180 | * Basic session information. | |
181 | * | |
182 | * This is an 'output data' meaning that it only comes *from* the session | |
183 | * daemon *to* the lttng client. It's basically a 'human' representation of | |
184 | * tracing entities (here a session). | |
185 | */ | |
186 | struct lttng_session { | |
f3ed775e | 187 | char name[NAME_MAX]; |
e6ddca71 DG |
188 | /* The path where traces are written */ |
189 | char path[PATH_MAX]; | |
1657e9bb DG |
190 | }; |
191 | ||
cd80958d DG |
192 | /* |
193 | * Handle used as a context for commands. | |
194 | */ | |
195 | struct lttng_handle { | |
196 | char session_name[NAME_MAX]; | |
197 | struct lttng_domain domain; | |
198 | }; | |
199 | ||
7d29a247 DG |
200 | /* |
201 | * Public LTTng control API | |
202 | * | |
203 | * For functions having a lttng domain type as parameter, if a bad value is | |
204 | * given, NO default is applied and an error is returned. | |
205 | * | |
206 | * On success, all functions of the API return 0 or the size of the allocated | |
207 | * array. | |
208 | * | |
209 | * On error, a negative value is returned being a specific lttng-tools error | |
210 | * code which can be humanly interpreted with lttng_get_readable_code(err). | |
211 | */ | |
212 | ||
b7384347 | 213 | /* |
cd80958d DG |
214 | * Create an handle used as a context for every request made to the library. |
215 | * | |
216 | * This handle contains the session name and lttng domain on which the command | |
217 | * will be executed on. | |
218 | */ | |
219 | extern struct lttng_handle *lttng_create_handle(const char *session_name, | |
220 | struct lttng_domain *domain); | |
221 | ||
222 | /* | |
223 | * Destroy an handle. This will simply free(3) the data pointer returned by | |
224 | * lttng_create_handle() and rendering it unsuable. | |
b7384347 | 225 | */ |
cd80958d | 226 | extern void lttng_destroy_handle(struct lttng_handle *handle); |
7d29a247 DG |
227 | |
228 | /* | |
229 | * Create tracing session using a name and a path where trace will be written. | |
230 | */ | |
38057ed1 | 231 | extern int lttng_create_session(const char *name, const char *path); |
f3ed775e | 232 | |
7d29a247 DG |
233 | /* |
234 | * Destroy tracing session. | |
235 | * | |
236 | * The session will not be useable anymore, tracing will stopped for all | |
237 | * registered trace and tracing buffers will be flushed. | |
238 | */ | |
cd80958d | 239 | extern int lttng_destroy_session(struct lttng_handle *handle); |
f3ed775e | 240 | |
e6ddca71 | 241 | /* |
9f19cc17 | 242 | * List all tracing sessions. |
7d29a247 | 243 | * |
9f19cc17 | 244 | * Return the size of the "lttng_session" array. Caller must free(3). |
e6ddca71 | 245 | */ |
ca95a216 | 246 | extern int lttng_list_sessions(struct lttng_session **sessions); |
f3ed775e | 247 | |
9f19cc17 | 248 | /* |
2a71efd5 | 249 | * List registered domain(s) of a session. |
9f19cc17 DG |
250 | * |
251 | * Return the size of the "lttng_domain" array. Caller must free(3). | |
252 | */ | |
cd80958d | 253 | extern int lttng_list_domains(struct lttng_handle *handle, |
9f19cc17 DG |
254 | struct lttng_domain **domains); |
255 | ||
256 | /* | |
257 | * List channel(s) of a session. | |
258 | * | |
259 | * Return the size of the "lttng_channel" array. Caller must free(3). | |
260 | */ | |
cd80958d DG |
261 | extern int lttng_list_channels(struct lttng_handle *handle, |
262 | struct lttng_channel **channels); | |
9f19cc17 DG |
263 | |
264 | /* | |
265 | * List event(s) of a session channel. | |
266 | * | |
267 | * Return the size of the "lttng_event" array. Caller must free(3). | |
268 | */ | |
cd80958d DG |
269 | extern int lttng_list_events(struct lttng_handle *handle, |
270 | const char *channel_name, struct lttng_event **events); | |
9f19cc17 DG |
271 | |
272 | /* | |
cd80958d | 273 | * List available tracepoints of a specific lttng domain. |
9f19cc17 DG |
274 | * |
275 | * Return the size of the "lttng_event" array. Caller must free(3). | |
276 | */ | |
cd80958d | 277 | extern int lttng_list_tracepoints(struct lttng_handle *handle, |
2a71efd5 | 278 | struct lttng_event **events); |
9f19cc17 | 279 | |
7d29a247 DG |
280 | /* |
281 | * Check if a session daemon is alive. | |
282 | */ | |
947308c4 | 283 | extern int lttng_session_daemon_alive(void); |
f3ed775e | 284 | |
7d29a247 DG |
285 | /* |
286 | * Set tracing group for the *current* flow of execution. | |
287 | */ | |
b7384347 | 288 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 289 | |
7d29a247 DG |
290 | /* |
291 | * Return a human readable error message of a lttng-tools error code. | |
292 | * | |
293 | * Parameter MUST be a negative value or else you'll get a generic message. | |
294 | */ | |
b7384347 DG |
295 | extern const char *lttng_get_readable_code(int code); |
296 | ||
d9800920 DG |
297 | /* |
298 | * This call permits to register an "outside consumer" to a session and a lttng | |
299 | * domain. No consumer will be spawned and all fds/commands will go through the | |
300 | * socket path given (socket_path). | |
301 | * | |
6533b585 | 302 | * NOTE: At the moment, if you use the liblttngkconsumerd, you can only use the |
d9800920 DG |
303 | * command socket. The error socket is not supported yet for roaming consumers. |
304 | */ | |
305 | extern int lttng_register_consumer(struct lttng_handle *handle, | |
306 | const char *socket_path); | |
307 | ||
7d29a247 DG |
308 | /* |
309 | * Start tracing for *all* registered trace (kernel and user-space). | |
310 | */ | |
cd80958d | 311 | extern int lttng_start_tracing(struct lttng_handle *handle); |
f3ed775e | 312 | |
7d29a247 DG |
313 | /* |
314 | * Stop tracing for *all* registered trace (kernel and user-space). | |
315 | */ | |
cd80958d | 316 | extern int lttng_stop_tracing(struct lttng_handle *handle); |
f3ed775e | 317 | |
b7384347 | 318 | /* |
7d29a247 DG |
319 | * Add context to event for a specific channel. |
320 | * | |
321 | * If event_name is NULL, the context is applied to all event of the channel. | |
322 | * If channel_name is NULL, a lookup of the event's channel is done. | |
323 | * If both are NULL, the context is applied on all events of all channels. | |
b7384347 | 324 | */ |
cd80958d | 325 | extern int lttng_add_context(struct lttng_handle *handle, |
38057ed1 DG |
326 | struct lttng_event_context *ctx, const char *event_name, |
327 | const char *channel_name); | |
f3ed775e | 328 | |
7d29a247 DG |
329 | /* |
330 | * Create or enable a kernel event. | |
331 | * | |
332 | * If the event you are trying to enable does not exist, it will be created, | |
333 | * else it is enabled. | |
334 | * | |
335 | * If channel_name is NULL, the default channel is used (channel0). | |
336 | */ | |
cd80958d DG |
337 | extern int lttng_enable_event(struct lttng_handle *handle, |
338 | struct lttng_event *ev, const char *channel_name); | |
f3ed775e | 339 | |
7d29a247 DG |
340 | /* |
341 | * Create or enable a kernel channel. | |
342 | * | |
343 | * If name is NULL, the default channel is enabled (channel0). | |
344 | */ | |
cd80958d | 345 | extern int lttng_enable_channel(struct lttng_handle *handle, |
38057ed1 | 346 | struct lttng_channel *chan); |
f3ed775e | 347 | |
7d29a247 DG |
348 | /* |
349 | * Disable kernel event. | |
350 | * | |
351 | * If channel_name is NULL, the default channel is used (channel0). | |
352 | */ | |
cd80958d DG |
353 | extern int lttng_disable_event(struct lttng_handle *handle, |
354 | const char *name, const char *channel_name); | |
fac6795d | 355 | |
1df4dedd | 356 | /* |
7d29a247 DG |
357 | * Disable kernel channel. |
358 | * | |
359 | * If channel_name is NULL, the default channel is disabled (channel0). | |
1df4dedd | 360 | */ |
cd80958d | 361 | extern int lttng_disable_channel(struct lttng_handle *handle, |
38057ed1 | 362 | const char *name); |
1df4dedd | 363 | |
d0254c7c MD |
364 | /* |
365 | * Calibrate LTTng overhead. | |
366 | */ | |
cd80958d | 367 | extern int lttng_calibrate(struct lttng_handle *handle, |
d0254c7c MD |
368 | struct lttng_calibrate *calibrate); |
369 | ||
b7384347 | 370 | #endif /* _LTTNG_H */ |