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 | |
f3ed775e | 26 | #include <asm/types.h> |
7d29a247 | 27 | #include <sys/types.h> |
f3ed775e | 28 | #include <stdint.h> |
57167058 DG |
29 | #include <limits.h> |
30 | ||
b7384347 DG |
31 | /* Default unix group name for tracing. */ |
32 | #define LTTNG_DEFAULT_TRACING_GROUP "tracing" | |
fac6795d | 33 | |
b7384347 | 34 | /* Environment variable to set session daemon binary path. */ |
5b8719f5 DG |
35 | #define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH" |
36 | ||
58a97671 DG |
37 | /* Default trace output directory name */ |
38 | #define LTTNG_DEFAULT_TRACE_DIR_NAME "lttng-traces" | |
39 | ||
b7384347 | 40 | /* |
e6ddca71 | 41 | * Event symbol length. Copied from LTTng kernel ABI. |
1657e9bb | 42 | */ |
f3ed775e DG |
43 | #define LTTNG_SYMBOL_NAME_LEN 128 |
44 | ||
e6ddca71 DG |
45 | /* |
46 | * Every lttng_event_* structure both apply to kernel event and user-space | |
47 | * event. | |
e6ddca71 DG |
48 | */ |
49 | ||
7d29a247 DG |
50 | /* |
51 | * Domain type are the different possible tracers. | |
52 | */ | |
53 | enum lttng_domain_type { | |
0d0c377a DG |
54 | LTTNG_DOMAIN_KERNEL = 1, |
55 | LTTNG_DOMAIN_UST = 2, | |
56 | LTTNG_DOMAIN_UST_EXEC_NAME = 3, | |
57 | LTTNG_DOMAIN_UST_PID = 4, | |
58 | LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5, | |
7d29a247 DG |
59 | }; |
60 | ||
7d29a247 DG |
61 | /* |
62 | * Instrumentation type of tracing event. | |
63 | */ | |
f3ed775e | 64 | enum lttng_event_type { |
e6ddca71 | 65 | LTTNG_EVENT_TRACEPOINT, |
7d29a247 | 66 | LTTNG_EVENT_PROBE, |
f3ed775e | 67 | LTTNG_EVENT_FUNCTION, |
8f0d098b | 68 | LTTNG_EVENT_FUNCTION_ENTRY, |
1657e9bb DG |
69 | }; |
70 | ||
e6ddca71 DG |
71 | /* |
72 | * LTTng consumer mode | |
73 | */ | |
74 | enum lttng_event_output { | |
7d29a247 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 { | |
81 | LTTNG_EVENT_CONTEXT_PID = 0, | |
82 | LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, | |
83 | LTTNG_EVENT_CONTEXT_COMM = 2, | |
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, | |
d65106b1 DG |
91 | }; |
92 | ||
d0254c7c MD |
93 | enum lttng_calibrate_type { |
94 | LTTNG_CALIBRATE_FUNCTION = 0, | |
95 | }; | |
96 | ||
9f19cc17 DG |
97 | struct lttng_domain { |
98 | enum lttng_domain_type type; | |
99 | union { | |
100 | pid_t pid; | |
101 | char exec_name[NAME_MAX]; | |
102 | } attr; | |
103 | }; | |
104 | ||
d65106b1 | 105 | /* Perf counter attributes */ |
7d29a247 | 106 | struct lttng_event_perf_counter_ctx { |
d65106b1 DG |
107 | uint32_t type; |
108 | uint64_t config; | |
109 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
110 | }; | |
111 | ||
112 | /* Event/Channel context */ | |
7d29a247 DG |
113 | struct lttng_event_context { |
114 | enum lttng_event_context_type ctx; | |
d65106b1 | 115 | union { |
7d29a247 | 116 | struct lttng_event_perf_counter_ctx perf_counter; |
d65106b1 DG |
117 | } u; |
118 | }; | |
119 | ||
b7384347 | 120 | /* |
7d29a247 DG |
121 | * Event probe. |
122 | * | |
123 | * Either addr is used or symbol_name and offset. | |
57167058 | 124 | */ |
7d29a247 | 125 | struct lttng_event_probe_attr { |
f3ed775e DG |
126 | uint64_t addr; |
127 | ||
128 | uint64_t offset; | |
129 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
57167058 DG |
130 | }; |
131 | ||
b7384347 | 132 | /* |
f3ed775e DG |
133 | * Function tracer |
134 | */ | |
135 | struct lttng_event_function_attr { | |
136 | char symbol_name[LTTNG_SYMBOL_NAME_LEN]; | |
137 | }; | |
138 | ||
139 | /* | |
140 | * Generic lttng event | |
141 | */ | |
142 | struct lttng_event { | |
143 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
144 | enum lttng_event_type type; | |
9f19cc17 | 145 | uint32_t enabled; |
f3ed775e DG |
146 | /* Per event type configuration */ |
147 | union { | |
7d29a247 | 148 | struct lttng_event_probe_attr probe; |
f3ed775e DG |
149 | struct lttng_event_function_attr ftrace; |
150 | } attr; | |
151 | }; | |
152 | ||
e6ddca71 DG |
153 | /* |
154 | * Tracer channel attributes. For both kernel and user-space. | |
155 | */ | |
f3ed775e | 156 | struct lttng_channel_attr { |
8ce37aa5 DG |
157 | int overwrite; /* 1: overwrite, 0: discard */ |
158 | uint64_t subbuf_size; /* bytes */ | |
159 | uint64_t num_subbuf; /* power of 2 */ | |
160 | unsigned int switch_timer_interval; /* usec */ | |
161 | unsigned int read_timer_interval; /* usec */ | |
f05b5f07 | 162 | enum lttng_event_output output; /* splice, mmap */ |
f3ed775e DG |
163 | }; |
164 | ||
165 | /* | |
e6ddca71 | 166 | * Channel information structure. For both kernel and user-space. |
1657e9bb | 167 | */ |
e6ddca71 | 168 | struct lttng_channel { |
1657e9bb | 169 | char name[NAME_MAX]; |
9f19cc17 | 170 | uint32_t enabled; |
e6ddca71 | 171 | struct lttng_channel_attr attr; |
f3ed775e DG |
172 | }; |
173 | ||
d0254c7c MD |
174 | struct lttng_calibrate { |
175 | enum lttng_calibrate_type type; | |
176 | }; | |
177 | ||
e6ddca71 DG |
178 | /* |
179 | * Basic session information. | |
180 | * | |
181 | * This is an 'output data' meaning that it only comes *from* the session | |
182 | * daemon *to* the lttng client. It's basically a 'human' representation of | |
183 | * tracing entities (here a session). | |
184 | */ | |
185 | struct lttng_session { | |
f3ed775e | 186 | char name[NAME_MAX]; |
e6ddca71 DG |
187 | /* The path where traces are written */ |
188 | char path[PATH_MAX]; | |
1657e9bb DG |
189 | }; |
190 | ||
7d29a247 DG |
191 | /* |
192 | * Public LTTng control API | |
193 | * | |
194 | * For functions having a lttng domain type as parameter, if a bad value is | |
195 | * given, NO default is applied and an error is returned. | |
196 | * | |
197 | * On success, all functions of the API return 0 or the size of the allocated | |
198 | * array. | |
199 | * | |
200 | * On error, a negative value is returned being a specific lttng-tools error | |
201 | * code which can be humanly interpreted with lttng_get_readable_code(err). | |
202 | */ | |
203 | ||
b7384347 DG |
204 | /* |
205 | * Session daemon control | |
206 | */ | |
7d29a247 DG |
207 | |
208 | /* | |
209 | * Create tracing session using a name and a path where trace will be written. | |
210 | */ | |
38057ed1 | 211 | extern int lttng_create_session(const char *name, const char *path); |
f3ed775e | 212 | |
7d29a247 DG |
213 | /* |
214 | * Destroy tracing session. | |
215 | * | |
216 | * The session will not be useable anymore, tracing will stopped for all | |
217 | * registered trace and tracing buffers will be flushed. | |
218 | */ | |
38057ed1 | 219 | extern int lttng_destroy_session(const char *name); |
f3ed775e | 220 | |
e6ddca71 | 221 | /* |
9f19cc17 | 222 | * List all tracing sessions. |
7d29a247 | 223 | * |
9f19cc17 | 224 | * Return the size of the "lttng_session" array. Caller must free(3). |
e6ddca71 | 225 | */ |
ca95a216 | 226 | extern int lttng_list_sessions(struct lttng_session **sessions); |
f3ed775e | 227 | |
9f19cc17 | 228 | /* |
2a71efd5 | 229 | * List registered domain(s) of a session. |
9f19cc17 DG |
230 | * |
231 | * Return the size of the "lttng_domain" array. Caller must free(3). | |
232 | */ | |
233 | extern int lttng_list_domains(const char *session_name, | |
234 | struct lttng_domain **domains); | |
235 | ||
236 | /* | |
237 | * List channel(s) of a session. | |
238 | * | |
239 | * Return the size of the "lttng_channel" array. Caller must free(3). | |
240 | */ | |
241 | extern int lttng_list_channels(struct lttng_domain *domain, | |
242 | const char *session_name, struct lttng_channel **channels); | |
243 | ||
244 | /* | |
245 | * List event(s) of a session channel. | |
246 | * | |
247 | * Return the size of the "lttng_event" array. Caller must free(3). | |
248 | */ | |
249 | extern int lttng_list_events(struct lttng_domain *domain, | |
250 | const char *session_name, const char *channel_name, | |
251 | struct lttng_event **events); | |
252 | ||
253 | /* | |
2a71efd5 | 254 | * List available tracepoints of domain. |
9f19cc17 DG |
255 | * |
256 | * Return the size of the "lttng_event" array. Caller must free(3). | |
257 | */ | |
2a71efd5 DG |
258 | extern int lttng_list_tracepoints(struct lttng_domain *domain, |
259 | struct lttng_event **events); | |
9f19cc17 | 260 | |
7d29a247 DG |
261 | /* |
262 | * Check if a session daemon is alive. | |
263 | */ | |
947308c4 | 264 | extern int lttng_session_daemon_alive(void); |
f3ed775e | 265 | |
7d29a247 DG |
266 | /* |
267 | * Set tracing group for the *current* flow of execution. | |
268 | */ | |
b7384347 | 269 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 270 | |
7d29a247 DG |
271 | /* |
272 | * Set the session name of the *current* flow of execution. | |
273 | * | |
274 | * This is a VERY important things to do before doing any tracing actions. If | |
275 | * it's not done, you'll get an error saying that the session is not found. | |
276 | * It avoids the use of a session name on every API call. | |
277 | */ | |
38057ed1 | 278 | extern void lttng_set_session_name(const char *name); |
f3ed775e | 279 | |
7d29a247 DG |
280 | /* |
281 | * Return a human readable error message of a lttng-tools error code. | |
282 | * | |
283 | * Parameter MUST be a negative value or else you'll get a generic message. | |
284 | */ | |
b7384347 DG |
285 | extern const char *lttng_get_readable_code(int code); |
286 | ||
7d29a247 DG |
287 | /* |
288 | * Start tracing for *all* registered trace (kernel and user-space). | |
289 | */ | |
38057ed1 | 290 | extern int lttng_start_tracing(const char *session_name); |
f3ed775e | 291 | |
7d29a247 DG |
292 | /* |
293 | * Stop tracing for *all* registered trace (kernel and user-space). | |
294 | */ | |
38057ed1 | 295 | extern int lttng_stop_tracing(const char *session_name); |
f3ed775e | 296 | |
b7384347 | 297 | /* |
7d29a247 DG |
298 | * Add context to event for a specific channel. |
299 | * | |
300 | * If event_name is NULL, the context is applied to all event of the channel. | |
301 | * If channel_name is NULL, a lookup of the event's channel is done. | |
302 | * If both are NULL, the context is applied on all events of all channels. | |
b7384347 | 303 | */ |
f3ed775e | 304 | |
7d29a247 | 305 | extern int lttng_add_context(struct lttng_domain *domain, |
38057ed1 DG |
306 | struct lttng_event_context *ctx, const char *event_name, |
307 | const char *channel_name); | |
f3ed775e | 308 | |
7d29a247 DG |
309 | /* |
310 | * Create or enable a kernel event. | |
311 | * | |
312 | * If the event you are trying to enable does not exist, it will be created, | |
313 | * else it is enabled. | |
314 | * | |
315 | * If channel_name is NULL, the default channel is used (channel0). | |
316 | */ | |
317 | extern int lttng_enable_event(struct lttng_domain *domain, struct lttng_event *ev, | |
38057ed1 | 318 | const char *channel_name); |
f3ed775e | 319 | |
7d29a247 DG |
320 | /* |
321 | * Create or enable a kernel channel. | |
322 | * | |
323 | * If name is NULL, the default channel is enabled (channel0). | |
324 | */ | |
38057ed1 DG |
325 | extern int lttng_enable_channel(struct lttng_domain *domain, |
326 | struct lttng_channel *chan); | |
f3ed775e | 327 | |
7d29a247 DG |
328 | /* |
329 | * Disable kernel event. | |
330 | * | |
331 | * If channel_name is NULL, the default channel is used (channel0). | |
332 | */ | |
38057ed1 DG |
333 | extern int lttng_disable_event(struct lttng_domain *domain, const char *name, |
334 | const char *channel_name); | |
fac6795d | 335 | |
1df4dedd | 336 | /* |
7d29a247 DG |
337 | * Disable kernel channel. |
338 | * | |
339 | * If channel_name is NULL, the default channel is disabled (channel0). | |
1df4dedd | 340 | */ |
38057ed1 DG |
341 | extern int lttng_disable_channel(struct lttng_domain *domain, |
342 | const char *name); | |
1df4dedd | 343 | |
d0254c7c MD |
344 | /* |
345 | * Calibrate LTTng overhead. | |
346 | */ | |
347 | extern int lttng_calibrate(struct lttng_domain *domain, | |
348 | struct lttng_calibrate *calibrate); | |
349 | ||
b7384347 | 350 | #endif /* _LTTNG_H */ |