Initial import of the new binary lttng-relayd
[lttng-tools.git] / include / lttng / lttng.h
1 /*
2 * lttng.h
3 *
4 * Linux Trace Toolkit Control Library Header File
5 *
6 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
7 *
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, version 2.1 only,
10 * as published by the Free Software Foundation.
11 *
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.
16 *
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
20 */
21
22 #ifndef _LTTNG_H
23 #define _LTTNG_H
24
25 #include <limits.h>
26 #include <netinet/in.h>
27 #include <stdint.h>
28 #include <sys/types.h>
29
30 /*
31 * Event symbol length. Copied from LTTng kernel ABI.
32 */
33 #define LTTNG_SYMBOL_NAME_LEN 256
34
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
41 /*
42 * Every lttng_event_* structure both apply to kernel event and user-space
43 * event.
44 */
45
46 /*
47 * Domain types: the different possible tracers.
48 */
49 enum lttng_domain_type {
50 LTTNG_DOMAIN_KERNEL = 1,
51 LTTNG_DOMAIN_UST = 2,
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 *
58 LTTNG_DOMAIN_UST_EXEC_NAME = 3,
59 LTTNG_DOMAIN_UST_PID = 4,
60 LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5,
61 */
62 };
63
64 /*
65 * Instrumentation type of tracing event.
66 */
67 enum lttng_event_type {
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,
75 };
76
77 /*
78 * Loglevel information.
79 */
80 enum lttng_loglevel_type {
81 LTTNG_EVENT_LOGLEVEL_ALL = 0,
82 LTTNG_EVENT_LOGLEVEL_RANGE = 1,
83 LTTNG_EVENT_LOGLEVEL_SINGLE = 2,
84 };
85
86 /*
87 * Available loglevels.
88 */
89 enum lttng_loglevel {
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,
105 };
106
107 /*
108 * LTTng consumer mode
109 */
110 enum lttng_event_output {
111 LTTNG_EVENT_SPLICE = 0,
112 LTTNG_EVENT_MMAP = 1,
113 };
114
115 /* Event context possible type */
116 enum lttng_event_context_type {
117 LTTNG_EVENT_CONTEXT_PID = 0,
118 LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1,
119 LTTNG_EVENT_CONTEXT_PROCNAME = 2,
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,
127 LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
128 };
129
130 enum lttng_calibrate_type {
131 LTTNG_CALIBRATE_FUNCTION = 0,
132 };
133
134 /* Destination type of lttng URI */
135 enum lttng_dst_type {
136 LTTNG_DST_IPV4, /* IPv4 protocol */
137 LTTNG_DST_IPV6, /* IPv6 protocol */
138 LTTNG_DST_PATH, /* Local file system */
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];
182 union {
183 char ipv4[INET_ADDRSTRLEN];
184 char ipv6[INET6_ADDRSTRLEN];
185 char path[PATH_MAX];
186 char padding[LTTNG_URI_PADDING2_LEN];
187 } dst;
188 };
189
190 /*
191 * The structures should be initialized to zero before use.
192 */
193 #define LTTNG_DOMAIN_PADDING1 16
194 #define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
195 struct lttng_domain {
196 enum lttng_domain_type type;
197 char padding[LTTNG_DOMAIN_PADDING1];
198
199 union {
200 pid_t pid;
201 char exec_name[NAME_MAX];
202 char padding[LTTNG_DOMAIN_PADDING2];
203 } attr;
204 };
205
206 /*
207 * Perf counter attributes
208 *
209 * The structures should be initialized to zero before use.
210 */
211 #define LTTNG_PERF_EVENT_PADDING1 16
212 struct lttng_event_perf_counter_ctx {
213 uint32_t type;
214 uint64_t config;
215 char name[LTTNG_SYMBOL_NAME_LEN];
216
217 char padding[LTTNG_PERF_EVENT_PADDING1];
218 };
219
220 /*
221 * Event/channel context
222 *
223 * The structures should be initialized to zero before use.
224 */
225 #define LTTNG_EVENT_CONTEXT_PADDING1 16
226 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
227 struct lttng_event_context {
228 enum lttng_event_context_type ctx;
229 char padding[LTTNG_EVENT_CONTEXT_PADDING1];
230
231 union {
232 struct lttng_event_perf_counter_ctx perf_counter;
233 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
234 } u;
235 };
236
237 /*
238 * Event probe.
239 *
240 * Either addr is used or symbol_name and offset.
241 *
242 * The structures should be initialized to zero before use.
243 */
244 #define LTTNG_EVENT_PROBE_PADDING1 16
245 struct lttng_event_probe_attr {
246 uint64_t addr;
247
248 uint64_t offset;
249 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
250
251 char padding[LTTNG_EVENT_PROBE_PADDING1];
252 };
253
254 /*
255 * Function tracer
256 *
257 * The structures should be initialized to zero before use.
258 */
259 #define LTTNG_EVENT_FUNCTION_PADDING1 16
260 struct lttng_event_function_attr {
261 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
262
263 char padding[LTTNG_EVENT_FUNCTION_PADDING1];
264 };
265
266 /*
267 * Generic lttng event
268 *
269 * The structures should be initialized to zero before use.
270 */
271 #define LTTNG_EVENT_PADDING1 16
272 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
273 struct lttng_event {
274 enum lttng_event_type type;
275 char name[LTTNG_SYMBOL_NAME_LEN];
276
277 enum lttng_loglevel_type loglevel_type;
278 int loglevel;
279
280 int32_t enabled; /* Does not apply: -1 */
281 pid_t pid;
282
283 char padding[LTTNG_EVENT_PADDING1];
284
285 /* Per event type configuration */
286 union {
287 struct lttng_event_probe_attr probe;
288 struct lttng_event_function_attr ftrace;
289
290 char padding[LTTNG_EVENT_PADDING2];
291 } attr;
292 };
293
294 enum lttng_event_field_type {
295 LTTNG_EVENT_FIELD_OTHER = 0,
296 LTTNG_EVENT_FIELD_INTEGER = 1,
297 LTTNG_EVENT_FIELD_ENUM = 2,
298 LTTNG_EVENT_FIELD_FLOAT = 3,
299 LTTNG_EVENT_FIELD_STRING = 4,
300 };
301
302 #define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
303 struct lttng_event_field {
304 char field_name[LTTNG_SYMBOL_NAME_LEN];
305 enum lttng_event_field_type type;
306 char padding[LTTNG_EVENT_FIELD_PADDING];
307 struct lttng_event event;
308 };
309
310 /*
311 * Tracer channel attributes. For both kernel and user-space.
312 *
313 * The structures should be initialized to zero before use.
314 */
315 #define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
316 struct lttng_channel_attr {
317 int overwrite; /* 1: overwrite, 0: discard */
318 uint64_t subbuf_size; /* bytes */
319 uint64_t num_subbuf; /* power of 2 */
320 unsigned int switch_timer_interval; /* usec */
321 unsigned int read_timer_interval; /* usec */
322 enum lttng_event_output output; /* splice, mmap */
323
324 char padding[LTTNG_CHANNEL_ATTR_PADDING1];
325 };
326
327 /*
328 * Channel information structure. For both kernel and user-space.
329 *
330 * The structures should be initialized to zero before use.
331 */
332 #define LTTNG_CHANNEL_PADDING1 16
333 struct lttng_channel {
334 char name[LTTNG_SYMBOL_NAME_LEN];
335 uint32_t enabled;
336 struct lttng_channel_attr attr;
337
338 char padding[LTTNG_CHANNEL_PADDING1];
339 };
340
341 #define LTTNG_CALIBRATE_PADDING1 16
342 struct lttng_calibrate {
343 enum lttng_calibrate_type type;
344
345 char padding[LTTNG_CALIBRATE_PADDING1];
346 };
347
348 /*
349 * Basic session information.
350 *
351 * This is an 'output data' meaning that it only comes *from* the session
352 * daemon *to* the lttng client. It's basically a 'human' representation of
353 * tracing entities (here a session).
354 *
355 * The structures should be initialized to zero before use.
356 */
357 #define LTTNG_SESSION_PADDING1 16
358 struct lttng_session {
359 char name[NAME_MAX];
360 /* The path where traces are written */
361 char path[PATH_MAX];
362 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
363
364 char padding[LTTNG_SESSION_PADDING1];
365 };
366
367 /*
368 * Handle used as a context for commands.
369 *
370 * The structures should be initialized to zero before use.
371 */
372 #define LTTNG_HANDLE_PADDING1 16
373 struct lttng_handle {
374 char session_name[NAME_MAX];
375 struct lttng_domain domain;
376
377 char padding[LTTNG_HANDLE_PADDING1];
378 };
379
380 /*
381 * Public LTTng control API
382 *
383 * For functions having an lttng domain type as parameter, if a bad value is
384 * given, NO default is applied and an error is returned.
385 *
386 * On success, all functions of the API return 0 or the size of the allocated
387 * array (in bytes).
388 *
389 * On error, a negative value is returned being a specific lttng-tools error
390 * code which can be humanly interpreted with lttng_strerror(err).
391 *
392 * Exceptions to this are noted below.
393 */
394
395 /*
396 * Create a handle used as a context for every request made to the library.
397 *
398 * This handle contains the session name and lttng domain on which the command
399 * will be executed.
400 * The returned pointer will be NULL in case of malloc() error.
401 */
402 extern struct lttng_handle *lttng_create_handle(const char *session_name,
403 struct lttng_domain *domain);
404
405 /*
406 * Destroy a handle. This will simply free(3) the data pointer returned by
407 * lttng_create_handle(), rendering it unusable.
408 */
409 extern void lttng_destroy_handle(struct lttng_handle *handle);
410
411 /*
412 * Create a tracing session using a name and a path where the trace will be
413 * written.
414 */
415 extern int lttng_create_session(const char *name, const char *path);
416
417 /*
418 * Destroy a tracing session.
419 *
420 * The session will not be usable anymore, tracing will be stopped for all
421 * registered traces, and the tracing buffers will be flushed.
422 */
423 extern int lttng_destroy_session(const char *name);
424
425 /*
426 * List all the tracing sessions.
427 *
428 * Return the size (number of entries) of the "lttng_session" array. Caller
429 * must free(3).
430 */
431 extern int lttng_list_sessions(struct lttng_session **sessions);
432
433 /*
434 * List the registered domain(s) of a session.
435 *
436 * Return the size (number of entries) of the "lttng_domain" array. Caller
437 * must free(3).
438 */
439 extern int lttng_list_domains(const char *session_name,
440 struct lttng_domain **domains);
441
442 /*
443 * List the channel(s) of a session.
444 *
445 * Return the size (number of entries) of the "lttng_channel" array. Caller
446 * must free(3).
447 */
448 extern int lttng_list_channels(struct lttng_handle *handle,
449 struct lttng_channel **channels);
450
451 /*
452 * List the event(s) of a session channel.
453 *
454 * Return the size (number of entries) of the "lttng_event" array.
455 * Caller must free(3).
456 */
457 extern int lttng_list_events(struct lttng_handle *handle,
458 const char *channel_name, struct lttng_event **events);
459
460 /*
461 * List the available tracepoints of a specific lttng domain.
462 *
463 * Return the size (number of entries) of the "lttng_event" array.
464 * Caller must free(3).
465 */
466 extern int lttng_list_tracepoints(struct lttng_handle *handle,
467 struct lttng_event **events);
468
469 /*
470 * List the available tracepoints fields of a specific lttng domain.
471 *
472 * Return the size (number of entries) of the "lttng_event_field" array.
473 * Caller must free(3).
474 */
475 extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
476 struct lttng_event_field **fields);
477
478 /*
479 * Check if a session daemon is alive.
480 *
481 * Return 1 if alive or 0 if not. On error returns a negative value.
482 */
483 extern int lttng_session_daemon_alive(void);
484
485 /*
486 * Set the tracing group for the *current* flow of execution.
487 *
488 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
489 */
490 extern int lttng_set_tracing_group(const char *name);
491
492 /*
493 * Return a human-readable error message for an lttng-tools error code.
494 *
495 * Parameter MUST be a negative value or else you'll get a generic message.
496 */
497 extern const char *lttng_strerror(int code);
498
499 /*
500 * This call registers an "outside consumer" for a session and an lttng domain.
501 * No consumer will be spawned and all fds/commands will go through the socket
502 * path given (socket_path).
503 *
504 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
505 * command socket. The error socket is not supported yet for roaming consumers.
506 */
507 extern int lttng_register_consumer(struct lttng_handle *handle,
508 const char *socket_path);
509
510 /*
511 * Start tracing for *all* registered traces (kernel and user-space).
512 */
513 extern int lttng_start_tracing(const char *session_name);
514
515 /*
516 * Stop tracing for *all* registered traces (kernel and user-space).
517 */
518 extern int lttng_stop_tracing(const char *session_name);
519
520 /*
521 * Add context to event(s) for a specific channel (or for all).
522 *
523 * If event_name is NULL, the context is applied to all events of the channel.
524 * If channel_name is NULL, a lookup of the event's channel is done.
525 * If both are NULL, the context is applied to all events of all channels.
526 */
527 extern int lttng_add_context(struct lttng_handle *handle,
528 struct lttng_event_context *ctx, const char *event_name,
529 const char *channel_name);
530
531 /*
532 * Create or enable an event (or events) for a channel.
533 *
534 * If the event you are trying to enable does not exist, it will be created,
535 * else it is enabled.
536 * If event_name is NULL, all events are enabled.
537 * If channel_name is NULL, the default channel is used (channel0).
538 */
539 extern int lttng_enable_event(struct lttng_handle *handle,
540 struct lttng_event *ev, const char *channel_name);
541
542 /*
543 * Create or enable a channel.
544 * The channel name cannot be NULL.
545 */
546 extern int lttng_enable_channel(struct lttng_handle *handle,
547 struct lttng_channel *chan);
548
549 /*
550 * Disable event(s) of a channel and domain.
551 *
552 * If event_name is NULL, all events are disabled.
553 * If channel_name is NULL, the default channel is used (channel0).
554 */
555 extern int lttng_disable_event(struct lttng_handle *handle,
556 const char *name, const char *channel_name);
557
558 /*
559 * Disable channel.
560 *
561 * The channel name cannot be NULL.
562 */
563 extern int lttng_disable_channel(struct lttng_handle *handle,
564 const char *name);
565
566 /*
567 * Calibrate LTTng overhead.
568 */
569 extern int lttng_calibrate(struct lttng_handle *handle,
570 struct lttng_calibrate *calibrate);
571
572 /*
573 * Set the default channel attributes for a specific domain and an allocated
574 * lttng_channel_attr pointer.
575 *
576 * If either or both of the arguments are NULL, nothing happens.
577 */
578 extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
579 struct lttng_channel_attr *attr);
580
581 #endif /* _LTTNG_H */
This page took 0.040525 seconds and 5 git commands to generate.