Move ust channel registry inside session registry
[lttng-tools.git] / include / lttng / lttng.h
CommitLineData
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
73db5be4
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
03b1319d
DG
29/* Error codes that can be returned by API calls */
30#include <lttng/lttng-error.h>
31
5168918c
DG
32#ifdef __cplusplus
33extern "C" {
34#endif
35
b7384347 36/*
e6ddca71 37 * Event symbol length. Copied from LTTng kernel ABI.
1657e9bb 38 */
8d326ab9 39#define LTTNG_SYMBOL_NAME_LEN 256
f3ed775e 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 */
49enum 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 67enum 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 */
80enum 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 */
89enum 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 */
110enum 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 */
116enum 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,
54773d68 128 LTTNG_EVENT_CONTEXT_HOSTNAME = 11,
d65106b1
DG
129};
130
d0254c7c 131enum lttng_calibrate_type {
d78d6610 132 LTTNG_CALIBRATE_FUNCTION = 0,
d0254c7c
MD
133};
134
44a5e5eb
DG
135/* Health component for the health check function. */
136enum lttng_health_component {
137 LTTNG_HEALTH_CMD,
139ac872 138 LTTNG_HEALTH_APP_MANAGE,
44a5e5eb
DG
139 LTTNG_HEALTH_APP_REG,
140 LTTNG_HEALTH_KERNEL,
141 LTTNG_HEALTH_CONSUMER,
142 LTTNG_HEALTH_ALL,
143};
144
ece640c8
RB
145/*
146 * The structures should be initialized to zero before use.
147 */
8d326ab9
DG
148#define LTTNG_DOMAIN_PADDING1 16
149#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
9f19cc17
DG
150struct lttng_domain {
151 enum lttng_domain_type type;
8d326ab9
DG
152 char padding[LTTNG_DOMAIN_PADDING1];
153
9f19cc17
DG
154 union {
155 pid_t pid;
156 char exec_name[NAME_MAX];
8d326ab9 157 char padding[LTTNG_DOMAIN_PADDING2];
9f19cc17 158 } attr;
54c90d10 159};
9f19cc17 160
ece640c8
RB
161/*
162 * Perf counter attributes
163 *
164 * The structures should be initialized to zero before use.
165 */
8d326ab9 166#define LTTNG_PERF_EVENT_PADDING1 16
7d29a247 167struct lttng_event_perf_counter_ctx {
d65106b1
DG
168 uint32_t type;
169 uint64_t config;
170 char name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
171
172 char padding[LTTNG_PERF_EVENT_PADDING1];
54c90d10 173};
d65106b1 174
ece640c8
RB
175/*
176 * Event/channel context
177 *
178 * The structures should be initialized to zero before use.
179 */
8d326ab9
DG
180#define LTTNG_EVENT_CONTEXT_PADDING1 16
181#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
7d29a247
DG
182struct lttng_event_context {
183 enum lttng_event_context_type ctx;
8d326ab9
DG
184 char padding[LTTNG_EVENT_CONTEXT_PADDING1];
185
d65106b1 186 union {
7d29a247 187 struct lttng_event_perf_counter_ctx perf_counter;
8d326ab9 188 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
d65106b1 189 } u;
54c90d10 190};
d65106b1 191
b7384347 192/*
7d29a247
DG
193 * Event probe.
194 *
195 * Either addr is used or symbol_name and offset.
ece640c8
RB
196 *
197 * The structures should be initialized to zero before use.
57167058 198 */
8d326ab9 199#define LTTNG_EVENT_PROBE_PADDING1 16
7d29a247 200struct lttng_event_probe_attr {
f3ed775e
DG
201 uint64_t addr;
202
203 uint64_t offset;
204 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
205
206 char padding[LTTNG_EVENT_PROBE_PADDING1];
54c90d10 207};
57167058 208
b7384347 209/*
f3ed775e 210 * Function tracer
ece640c8
RB
211 *
212 * The structures should be initialized to zero before use.
f3ed775e 213 */
8d326ab9 214#define LTTNG_EVENT_FUNCTION_PADDING1 16
f3ed775e
DG
215struct lttng_event_function_attr {
216 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
217
218 char padding[LTTNG_EVENT_FUNCTION_PADDING1];
54c90d10 219};
f3ed775e
DG
220
221/*
222 * Generic lttng event
ece640c8
RB
223 *
224 * The structures should be initialized to zero before use.
f3ed775e 225 */
fceb65df 226#define LTTNG_EVENT_PADDING1 15
8d326ab9 227#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 228struct lttng_event {
0cda4f28 229 enum lttng_event_type type;
f3ed775e 230 char name[LTTNG_SYMBOL_NAME_LEN];
0cda4f28
MD
231
232 enum lttng_loglevel_type loglevel_type;
8005f29a 233 int loglevel;
0cda4f28 234
35dc4d62 235 int32_t enabled; /* Does not apply: -1 */
b551a063 236 pid_t pid;
fceb65df 237 unsigned char filter; /* filter enabled ? */
8d326ab9
DG
238
239 char padding[LTTNG_EVENT_PADDING1];
240
f3ed775e
DG
241 /* Per event type configuration */
242 union {
7d29a247 243 struct lttng_event_probe_attr probe;
f3ed775e 244 struct lttng_event_function_attr ftrace;
8d326ab9
DG
245
246 char padding[LTTNG_EVENT_PADDING2];
f3ed775e 247 } attr;
54c90d10 248};
f3ed775e 249
f37d259d
MD
250enum lttng_event_field_type {
251 LTTNG_EVENT_FIELD_OTHER = 0,
252 LTTNG_EVENT_FIELD_INTEGER = 1,
253 LTTNG_EVENT_FIELD_ENUM = 2,
254 LTTNG_EVENT_FIELD_FLOAT = 3,
255 LTTNG_EVENT_FIELD_STRING = 4,
256};
257
258#define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
259struct lttng_event_field {
260 char field_name[LTTNG_SYMBOL_NAME_LEN];
261 enum lttng_event_field_type type;
262 char padding[LTTNG_EVENT_FIELD_PADDING];
263 struct lttng_event event;
590b9e3c 264 int nowrite;
54c90d10 265};
f37d259d 266
e6ddca71
DG
267/*
268 * Tracer channel attributes. For both kernel and user-space.
ece640c8
RB
269 *
270 * The structures should be initialized to zero before use.
e6ddca71 271 */
8d326ab9 272#define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 273struct lttng_channel_attr {
8ce37aa5
DG
274 int overwrite; /* 1: overwrite, 0: discard */
275 uint64_t subbuf_size; /* bytes */
276 uint64_t num_subbuf; /* power of 2 */
277 unsigned int switch_timer_interval; /* usec */
278 unsigned int read_timer_interval; /* usec */
f05b5f07 279 enum lttng_event_output output; /* splice, mmap */
8d326ab9
DG
280
281 char padding[LTTNG_CHANNEL_ATTR_PADDING1];
54c90d10 282};
f3ed775e
DG
283
284/*
e6ddca71 285 * Channel information structure. For both kernel and user-space.
ece640c8
RB
286 *
287 * The structures should be initialized to zero before use.
1657e9bb 288 */
8d326ab9 289#define LTTNG_CHANNEL_PADDING1 16
e6ddca71 290struct lttng_channel {
045e5491 291 char name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 292 uint32_t enabled;
e6ddca71 293 struct lttng_channel_attr attr;
8d326ab9
DG
294
295 char padding[LTTNG_CHANNEL_PADDING1];
54c90d10 296};
f3ed775e 297
8d326ab9 298#define LTTNG_CALIBRATE_PADDING1 16
d0254c7c
MD
299struct lttng_calibrate {
300 enum lttng_calibrate_type type;
8d326ab9
DG
301
302 char padding[LTTNG_CALIBRATE_PADDING1];
54c90d10 303};
d0254c7c 304
e6ddca71
DG
305/*
306 * Basic session information.
307 *
308 * This is an 'output data' meaning that it only comes *from* the session
309 * daemon *to* the lttng client. It's basically a 'human' representation of
310 * tracing entities (here a session).
ece640c8
RB
311 *
312 * The structures should be initialized to zero before use.
e6ddca71 313 */
8d326ab9 314#define LTTNG_SESSION_PADDING1 16
e6ddca71 315struct lttng_session {
f3ed775e 316 char name[NAME_MAX];
e6ddca71
DG
317 /* The path where traces are written */
318 char path[PATH_MAX];
464dd62d 319 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
8d326ab9
DG
320
321 char padding[LTTNG_SESSION_PADDING1];
54c90d10 322};
1657e9bb 323
cd80958d
DG
324/*
325 * Handle used as a context for commands.
ece640c8
RB
326 *
327 * The structures should be initialized to zero before use.
cd80958d 328 */
8d326ab9 329#define LTTNG_HANDLE_PADDING1 16
cd80958d
DG
330struct lttng_handle {
331 char session_name[NAME_MAX];
332 struct lttng_domain domain;
8d326ab9
DG
333
334 char padding[LTTNG_HANDLE_PADDING1];
54c90d10 335};
cd80958d 336
7d29a247
DG
337/*
338 * Public LTTng control API
339 *
1e46a50f 340 * For functions having an lttng domain type as parameter, if a bad value is
7d29a247
DG
341 * given, NO default is applied and an error is returned.
342 *
343 * On success, all functions of the API return 0 or the size of the allocated
1e46a50f 344 * array (in bytes).
7d29a247
DG
345 *
346 * On error, a negative value is returned being a specific lttng-tools error
9a745bc7 347 * code which can be humanly interpreted with lttng_strerror(err).
1e46a50f
TD
348 *
349 * Exceptions to this are noted below.
7d29a247
DG
350 */
351
b7384347 352/*
1e46a50f 353 * Create a handle used as a context for every request made to the library.
cd80958d
DG
354 *
355 * This handle contains the session name and lttng domain on which the command
1e46a50f
TD
356 * will be executed.
357 * The returned pointer will be NULL in case of malloc() error.
cd80958d
DG
358 */
359extern struct lttng_handle *lttng_create_handle(const char *session_name,
360 struct lttng_domain *domain);
361
362/*
41039c06
DG
363 * Destroy an handle.
364 *
365 * It free(3) the data pointer returned by lttng_create_handle(), rendering it
366 * unusable.
b7384347 367 */
cd80958d 368extern void lttng_destroy_handle(struct lttng_handle *handle);
7d29a247
DG
369
370/*
a4b92340
DG
371 * Create a tracing session using a name and an optional URL.
372 *
41039c06
DG
373 * If _url_ is NULL, no consumer is created for the session. The name can't be
374 * NULL here.
00e2e675 375 */
a4b92340 376extern int lttng_create_session(const char *name, const char *url);
00e2e675 377
7d29a247 378/*
1e46a50f 379 * Destroy a tracing session.
7d29a247 380 *
1e46a50f
TD
381 * The session will not be usable anymore, tracing will be stopped for all
382 * registered traces, and the tracing buffers will be flushed.
41039c06
DG
383 *
384 * The name can't be NULL here.
7d29a247 385 */
843f5df9 386extern int lttng_destroy_session(const char *name);
f3ed775e 387
e6ddca71 388/*
1e46a50f 389 * List all the tracing sessions.
7d29a247 390 *
1e46a50f
TD
391 * Return the size (number of entries) of the "lttng_session" array. Caller
392 * must free(3).
e6ddca71 393 */
ca95a216 394extern int lttng_list_sessions(struct lttng_session **sessions);
f3ed775e 395
9f19cc17 396/*
1e46a50f 397 * List the registered domain(s) of a session.
9f19cc17 398 *
1e46a50f
TD
399 * Return the size (number of entries) of the "lttng_domain" array. Caller
400 * must free(3).
9f19cc17 401 */
330be774 402extern int lttng_list_domains(const char *session_name,
9f19cc17
DG
403 struct lttng_domain **domains);
404
405/*
1e46a50f 406 * List the channel(s) of a session.
9f19cc17 407 *
1e46a50f
TD
408 * Return the size (number of entries) of the "lttng_channel" array. Caller
409 * must free(3).
9f19cc17 410 */
cd80958d
DG
411extern int lttng_list_channels(struct lttng_handle *handle,
412 struct lttng_channel **channels);
9f19cc17
DG
413
414/*
1e46a50f 415 * List the event(s) of a session channel.
9f19cc17 416 *
1e46a50f
TD
417 * Return the size (number of entries) of the "lttng_event" array.
418 * Caller must free(3).
9f19cc17 419 */
cd80958d
DG
420extern int lttng_list_events(struct lttng_handle *handle,
421 const char *channel_name, struct lttng_event **events);
9f19cc17
DG
422
423/*
1e46a50f 424 * List the available tracepoints of a specific lttng domain.
9f19cc17 425 *
1e46a50f
TD
426 * Return the size (number of entries) of the "lttng_event" array.
427 * Caller must free(3).
9f19cc17 428 */
cd80958d 429extern int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 430 struct lttng_event **events);
9f19cc17 431
f37d259d
MD
432/*
433 * List the available tracepoints fields of a specific lttng domain.
434 *
435 * Return the size (number of entries) of the "lttng_event_field" array.
436 * Caller must free(3).
437 */
438extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
439 struct lttng_event_field **fields);
440
7d29a247
DG
441/*
442 * Check if a session daemon is alive.
1e46a50f
TD
443 *
444 * Return 1 if alive or 0 if not. On error returns a negative value.
7d29a247 445 */
947308c4 446extern int lttng_session_daemon_alive(void);
f3ed775e 447
7d29a247 448/*
1e46a50f
TD
449 * Set the tracing group for the *current* flow of execution.
450 *
41039c06
DG
451 * On success, returns 0 else a negative value on error being a lttng error
452 * code found in lttng-error.h
7d29a247 453 */
b7384347 454extern int lttng_set_tracing_group(const char *name);
f3ed775e 455
7d29a247 456/*
1e46a50f 457 * Return a human-readable error message for an lttng-tools error code.
7d29a247
DG
458 *
459 * Parameter MUST be a negative value or else you'll get a generic message.
460 */
9a745bc7 461extern const char *lttng_strerror(int code);
b7384347 462
d9800920 463/*
1e46a50f
TD
464 * This call registers an "outside consumer" for a session and an lttng domain.
465 * No consumer will be spawned and all fds/commands will go through the socket
466 * path given (socket_path).
d9800920 467 *
3bd1e081 468 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
d9800920
DG
469 * command socket. The error socket is not supported yet for roaming consumers.
470 */
471extern int lttng_register_consumer(struct lttng_handle *handle,
472 const char *socket_path);
473
7d29a247 474/*
1e46a50f 475 * Start tracing for *all* registered traces (kernel and user-space).
7d29a247 476 */
6a4f824d 477extern int lttng_start_tracing(const char *session_name);
f3ed775e 478
7d29a247 479/*
1e46a50f 480 * Stop tracing for *all* registered traces (kernel and user-space).
38ee087f
DG
481 *
482 * This call will wait for data availability for each domain of the session so
483 * this can take an abritrary amount of time. However, when returning you have
484 * the guarantee that the data is ready to be read and analyse. Use the
485 * _no_wait call below to avoid this behavior.
41039c06
DG
486 *
487 * The session_name can't be NULL.
7d29a247 488 */
6a4f824d 489extern int lttng_stop_tracing(const char *session_name);
f3ed775e 490
38ee087f
DG
491/*
492 * Behave exactly like lttng_stop_tracing but does not wait for data
493 * availability.
494 */
495extern int lttng_stop_tracing_no_wait(const char *session_name);
496
b7384347 497/*
1e46a50f 498 * Add context to event(s) for a specific channel (or for all).
7d29a247 499 *
41039c06
DG
500 * If channel_name is NULL, a lookup of the event's channel is done. If both
501 * are NULL, the context is applied to all events of all channels.
502 *
503 * Note that whatever event_name value is, a context can not be added to an
504 * event, so we just ignore it for now.
b7384347 505 */
cd80958d 506extern int lttng_add_context(struct lttng_handle *handle,
38057ed1
DG
507 struct lttng_event_context *ctx, const char *event_name,
508 const char *channel_name);
f3ed775e 509
7d29a247 510/*
c8f61fc6 511 * Create or enable an event (or events) for a channel.
7d29a247
DG
512 *
513 * If the event you are trying to enable does not exist, it will be created,
514 * else it is enabled.
7d29a247 515 * If channel_name is NULL, the default channel is used (channel0).
41039c06
DG
516 *
517 * The handle and ev params can not be NULL.
7d29a247 518 */
cd80958d
DG
519extern int lttng_enable_event(struct lttng_handle *handle,
520 struct lttng_event *ev, const char *channel_name);
f3ed775e 521
53a80697 522/*
025faf73 523 * Create or enable an event with a specific filter.
53a80697 524 *
025faf73
DG
525 * If the event you are trying to enable does not exist, it will be created,
526 * else it is enabled.
41039c06 527 * If ev is NULL, all events are enabled with that filter.
025faf73
DG
528 * If channel_name is NULL, the default channel is used (channel0) and created
529 * if not found.
52df2401
MD
530 * If filter_expression is NULL, an event without associated filter is
531 * created.
53a80697 532 */
025faf73 533extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
178191b3 534 struct lttng_event *event, const char *channel_name,
53a80697 535 const char *filter_expression);
178191b3 536
7d29a247 537/*
c8f61fc6 538 * Create or enable a channel.
41039c06
DG
539 *
540 * The chan and handle params can not be NULL.
7d29a247 541 */
cd80958d 542extern int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 543 struct lttng_channel *chan);
f3ed775e 544
7d29a247 545/*
c8f61fc6 546 * Disable event(s) of a channel and domain.
7d29a247 547 *
41039c06 548 * If name is NULL, all events are disabled.
7d29a247
DG
549 * If channel_name is NULL, the default channel is used (channel0).
550 */
cd80958d
DG
551extern int lttng_disable_event(struct lttng_handle *handle,
552 const char *name, const char *channel_name);
fac6795d 553
1df4dedd 554/*
c8f61fc6 555 * Disable channel.
7d29a247 556 *
1df4dedd 557 */
cd80958d 558extern int lttng_disable_channel(struct lttng_handle *handle,
38057ed1 559 const char *name);
1df4dedd 560
d0254c7c
MD
561/*
562 * Calibrate LTTng overhead.
41039c06
DG
563 *
564 * The chan and handle params can not be NULL.
d0254c7c 565 */
cd80958d 566extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
567 struct lttng_calibrate *calibrate);
568
5edd7e09
DG
569/*
570 * Set the default channel attributes for a specific domain and an allocated
571 * lttng_channel_attr pointer.
1e46a50f 572 *
41039c06 573 * If one or both arguments are NULL, nothing happens.
5edd7e09
DG
574 */
575extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
576 struct lttng_channel_attr *attr);
577
00e2e675 578/*
a4b92340
DG
579 * Set URL for a consumer for a session and domain.
580 *
581 * Both data and control URL must be defined. If both URLs are the same, only
582 * the control URL is used even for network streaming.
00e2e675 583 *
a4b92340
DG
584 * Default port are 5342 and 5343 respectively for control and data which uses
585 * the TCP protocol.
00e2e675 586 */
a4b92340
DG
587extern int lttng_set_consumer_url(struct lttng_handle *handle,
588 const char *control_url, const char *data_url);
00e2e675
DG
589
590/*
591 * Enable the consumer for a session and domain.
592 */
785d2d0d
DG
593extern LTTNG_DEPRECATED("This call is now obselete.")
594int lttng_enable_consumer(struct lttng_handle *handle);
00e2e675
DG
595
596/*
597 * Disable consumer for a session and domain.
598 */
785d2d0d
DG
599extern LTTNG_DEPRECATED("This call is now obselete.")
600int lttng_disable_consumer(struct lttng_handle *handle);
00e2e675 601
44a5e5eb
DG
602/*
603 * Check session daemon health for a specific component.
604 *
605 * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
606 * the control library was not able to connect to the session daemon health
607 * socket.
608 *
609 * Any other positive value is an lttcomm error which can be translate with
610 * lttng_strerror().
41039c06
DG
611 *
612 * Please see lttng-health-check(3) man page for more information.
44a5e5eb
DG
613 */
614extern int lttng_health_check(enum lttng_health_component c);
615
806e2684
DG
616/*
617 * For a given session name, this call checks if the data is ready to be read
6d805429
DG
618 * or is still being extracted by the consumer(s) (pending) hence not ready to
619 * be used by any readers.
806e2684 620 *
6d805429
DG
621 * Return 0 if there is _no_ data pending in the buffers thus having a
622 * guarantee that the data can be read safely. Else, return 1 if there is still
623 * traced data is pending. On error, a negative value is returned and readable
624 * by lttng_strerror().
806e2684 625 */
6d805429 626extern int lttng_data_pending(const char *session_name);
806e2684 627
5168918c
DG
628#ifdef __cplusplus
629}
630#endif
631
73db5be4 632#endif /* LTTNG_H */
This page took 0.101424 seconds and 4 git commands to generate.