relayd: add testpoints
[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 {
b9dfb167
DG
50 LTTNG_DOMAIN_KERNEL = 1, /* Linux Kernel tracer. */
51 LTTNG_DOMAIN_UST = 2, /* Global Userspace tracer. */
52 LTTNG_DOMAIN_JUL = 3, /* Java Util Logging. */
7d29a247
DG
53};
54
7d29a247
DG
55/*
56 * Instrumentation type of tracing event.
57 */
f3ed775e 58enum lttng_event_type {
7a3d1328
MD
59 LTTNG_EVENT_ALL = -1,
60 LTTNG_EVENT_TRACEPOINT = 0,
61 LTTNG_EVENT_PROBE = 1,
62 LTTNG_EVENT_FUNCTION = 2,
63 LTTNG_EVENT_FUNCTION_ENTRY = 3,
64 LTTNG_EVENT_NOOP = 4,
65 LTTNG_EVENT_SYSCALL = 5,
0cda4f28
MD
66};
67
68/*
69 * Loglevel information.
70 */
71enum lttng_loglevel_type {
8005f29a
MD
72 LTTNG_EVENT_LOGLEVEL_ALL = 0,
73 LTTNG_EVENT_LOGLEVEL_RANGE = 1,
74 LTTNG_EVENT_LOGLEVEL_SINGLE = 2,
1657e9bb
DG
75};
76
46839cc2
MD
77/*
78 * Available loglevels.
79 */
80enum lttng_loglevel {
00e2e675
DG
81 LTTNG_LOGLEVEL_EMERG = 0,
82 LTTNG_LOGLEVEL_ALERT = 1,
83 LTTNG_LOGLEVEL_CRIT = 2,
84 LTTNG_LOGLEVEL_ERR = 3,
85 LTTNG_LOGLEVEL_WARNING = 4,
86 LTTNG_LOGLEVEL_NOTICE = 5,
87 LTTNG_LOGLEVEL_INFO = 6,
88 LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7,
89 LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8,
90 LTTNG_LOGLEVEL_DEBUG_PROCESS = 9,
91 LTTNG_LOGLEVEL_DEBUG_MODULE = 10,
92 LTTNG_LOGLEVEL_DEBUG_UNIT = 11,
93 LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12,
94 LTTNG_LOGLEVEL_DEBUG_LINE = 13,
95 LTTNG_LOGLEVEL_DEBUG = 14,
46839cc2
MD
96};
97
e6ddca71
DG
98/*
99 * LTTng consumer mode
100 */
101enum lttng_event_output {
d78d6610
DG
102 LTTNG_EVENT_SPLICE = 0,
103 LTTNG_EVENT_MMAP = 1,
e6ddca71
DG
104};
105
7d29a247
DG
106/* Event context possible type */
107enum lttng_event_context_type {
d78d6610
DG
108 LTTNG_EVENT_CONTEXT_PID = 0,
109 LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1,
9197c5c4 110 LTTNG_EVENT_CONTEXT_PROCNAME = 2,
d78d6610
DG
111 LTTNG_EVENT_CONTEXT_PRIO = 3,
112 LTTNG_EVENT_CONTEXT_NICE = 4,
113 LTTNG_EVENT_CONTEXT_VPID = 5,
114 LTTNG_EVENT_CONTEXT_TID = 6,
115 LTTNG_EVENT_CONTEXT_VTID = 7,
116 LTTNG_EVENT_CONTEXT_PPID = 8,
117 LTTNG_EVENT_CONTEXT_VPPID = 9,
9197c5c4 118 LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
54773d68 119 LTTNG_EVENT_CONTEXT_HOSTNAME = 11,
7c612c2e 120 LTTNG_EVENT_CONTEXT_IP = 12,
d65106b1
DG
121};
122
d0254c7c 123enum lttng_calibrate_type {
d78d6610 124 LTTNG_CALIBRATE_FUNCTION = 0,
d0254c7c
MD
125};
126
44a5e5eb
DG
127/* Health component for the health check function. */
128enum lttng_health_component {
129 LTTNG_HEALTH_CMD,
139ac872 130 LTTNG_HEALTH_APP_MANAGE,
44a5e5eb
DG
131 LTTNG_HEALTH_APP_REG,
132 LTTNG_HEALTH_KERNEL,
133 LTTNG_HEALTH_CONSUMER,
0b2dc8df 134 LTTNG_HEALTH_HT_CLEANUP,
380e8d6f 135 LTTNG_HEALTH_APP_MANAGE_NOTIFY,
12e2b881 136 LTTNG_HEALTH_APP_REG_DISPATCH,
44a5e5eb
DG
137 LTTNG_HEALTH_ALL,
138};
139
7972aab2
DG
140/* Buffer type for a specific domain. */
141enum lttng_buffer_type {
142 LTTNG_BUFFER_PER_PID, /* Only supported by UST being the default. */
143 LTTNG_BUFFER_PER_UID, /* Only supported by UST. */
144 LTTNG_BUFFER_GLOBAL, /* Only supported by the Kernel. */
145};
146
ece640c8
RB
147/*
148 * The structures should be initialized to zero before use.
149 */
7972aab2 150#define LTTNG_DOMAIN_PADDING1 12
8d326ab9 151#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
9f19cc17
DG
152struct lttng_domain {
153 enum lttng_domain_type type;
7972aab2 154 enum lttng_buffer_type buf_type;
8d326ab9
DG
155 char padding[LTTNG_DOMAIN_PADDING1];
156
9f19cc17
DG
157 union {
158 pid_t pid;
159 char exec_name[NAME_MAX];
8d326ab9 160 char padding[LTTNG_DOMAIN_PADDING2];
9f19cc17 161 } attr;
54c90d10 162};
9f19cc17 163
ece640c8
RB
164/*
165 * Perf counter attributes
166 *
167 * The structures should be initialized to zero before use.
168 */
8d326ab9 169#define LTTNG_PERF_EVENT_PADDING1 16
7d29a247 170struct lttng_event_perf_counter_ctx {
d65106b1
DG
171 uint32_t type;
172 uint64_t config;
173 char name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
174
175 char padding[LTTNG_PERF_EVENT_PADDING1];
54c90d10 176};
d65106b1 177
ece640c8
RB
178/*
179 * Event/channel context
180 *
181 * The structures should be initialized to zero before use.
182 */
8d326ab9
DG
183#define LTTNG_EVENT_CONTEXT_PADDING1 16
184#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
7d29a247
DG
185struct lttng_event_context {
186 enum lttng_event_context_type ctx;
8d326ab9
DG
187 char padding[LTTNG_EVENT_CONTEXT_PADDING1];
188
d65106b1 189 union {
7d29a247 190 struct lttng_event_perf_counter_ctx perf_counter;
8d326ab9 191 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
d65106b1 192 } u;
54c90d10 193};
d65106b1 194
b7384347 195/*
7d29a247
DG
196 * Event probe.
197 *
198 * Either addr is used or symbol_name and offset.
ece640c8
RB
199 *
200 * The structures should be initialized to zero before use.
57167058 201 */
8d326ab9 202#define LTTNG_EVENT_PROBE_PADDING1 16
7d29a247 203struct lttng_event_probe_attr {
f3ed775e
DG
204 uint64_t addr;
205
206 uint64_t offset;
207 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
208
209 char padding[LTTNG_EVENT_PROBE_PADDING1];
54c90d10 210};
57167058 211
b7384347 212/*
f3ed775e 213 * Function tracer
ece640c8
RB
214 *
215 * The structures should be initialized to zero before use.
f3ed775e 216 */
8d326ab9 217#define LTTNG_EVENT_FUNCTION_PADDING1 16
f3ed775e
DG
218struct lttng_event_function_attr {
219 char symbol_name[LTTNG_SYMBOL_NAME_LEN];
8d326ab9
DG
220
221 char padding[LTTNG_EVENT_FUNCTION_PADDING1];
54c90d10 222};
f3ed775e
DG
223
224/*
225 * Generic lttng event
ece640c8
RB
226 *
227 * The structures should be initialized to zero before use.
f3ed775e 228 */
4634f12e 229#define LTTNG_EVENT_PADDING1 14
8d326ab9 230#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
f3ed775e 231struct lttng_event {
0cda4f28 232 enum lttng_event_type type;
f3ed775e 233 char name[LTTNG_SYMBOL_NAME_LEN];
0cda4f28
MD
234
235 enum lttng_loglevel_type loglevel_type;
8005f29a 236 int loglevel;
0cda4f28 237
35dc4d62 238 int32_t enabled; /* Does not apply: -1 */
b551a063 239 pid_t pid;
fceb65df 240 unsigned char filter; /* filter enabled ? */
4634f12e 241 unsigned char exclusion; /* exclusions added ? */
8d326ab9
DG
242
243 char padding[LTTNG_EVENT_PADDING1];
244
f3ed775e
DG
245 /* Per event type configuration */
246 union {
7d29a247 247 struct lttng_event_probe_attr probe;
f3ed775e 248 struct lttng_event_function_attr ftrace;
8d326ab9
DG
249
250 char padding[LTTNG_EVENT_PADDING2];
f3ed775e 251 } attr;
54c90d10 252};
f3ed775e 253
f37d259d
MD
254enum lttng_event_field_type {
255 LTTNG_EVENT_FIELD_OTHER = 0,
256 LTTNG_EVENT_FIELD_INTEGER = 1,
257 LTTNG_EVENT_FIELD_ENUM = 2,
258 LTTNG_EVENT_FIELD_FLOAT = 3,
259 LTTNG_EVENT_FIELD_STRING = 4,
260};
261
262#define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
263struct lttng_event_field {
264 char field_name[LTTNG_SYMBOL_NAME_LEN];
265 enum lttng_event_field_type type;
266 char padding[LTTNG_EVENT_FIELD_PADDING];
267 struct lttng_event event;
590b9e3c 268 int nowrite;
54c90d10 269};
f37d259d 270
e6ddca71
DG
271/*
272 * Tracer channel attributes. For both kernel and user-space.
ece640c8
RB
273 *
274 * The structures should be initialized to zero before use.
e6ddca71 275 */
ecc48a90 276#define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 12
f3ed775e 277struct lttng_channel_attr {
8ce37aa5
DG
278 int overwrite; /* 1: overwrite, 0: discard */
279 uint64_t subbuf_size; /* bytes */
280 uint64_t num_subbuf; /* power of 2 */
281 unsigned int switch_timer_interval; /* usec */
282 unsigned int read_timer_interval; /* usec */
f05b5f07 283 enum lttng_event_output output; /* splice, mmap */
1624d5b7
JD
284 /* LTTng 2.1 padding limit */
285 uint64_t tracefile_size; /* bytes */
286 uint64_t tracefile_count; /* number of tracefiles */
ecc48a90
JD
287 /* LTTng 2.3 padding limit */
288 unsigned int live_timer_interval; /* usec */
8d326ab9
DG
289
290 char padding[LTTNG_CHANNEL_ATTR_PADDING1];
54c90d10 291};
f3ed775e
DG
292
293/*
e6ddca71 294 * Channel information structure. For both kernel and user-space.
ece640c8
RB
295 *
296 * The structures should be initialized to zero before use.
1657e9bb 297 */
8d326ab9 298#define LTTNG_CHANNEL_PADDING1 16
e6ddca71 299struct lttng_channel {
045e5491 300 char name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17 301 uint32_t enabled;
e6ddca71 302 struct lttng_channel_attr attr;
8d326ab9
DG
303
304 char padding[LTTNG_CHANNEL_PADDING1];
54c90d10 305};
f3ed775e 306
8d326ab9 307#define LTTNG_CALIBRATE_PADDING1 16
d0254c7c
MD
308struct lttng_calibrate {
309 enum lttng_calibrate_type type;
8d326ab9
DG
310
311 char padding[LTTNG_CALIBRATE_PADDING1];
54c90d10 312};
d0254c7c 313
e6ddca71
DG
314/*
315 * Basic session information.
316 *
317 * This is an 'output data' meaning that it only comes *from* the session
318 * daemon *to* the lttng client. It's basically a 'human' representation of
319 * tracing entities (here a session).
ece640c8
RB
320 *
321 * The structures should be initialized to zero before use.
e6ddca71 322 */
2cbf8fed 323#define LTTNG_SESSION_PADDING1 12
e6ddca71 324struct lttng_session {
f3ed775e 325 char name[NAME_MAX];
e6ddca71
DG
326 /* The path where traces are written */
327 char path[PATH_MAX];
464dd62d 328 uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
2cbf8fed 329 uint32_t snapshot_mode;
ecc48a90 330 unsigned int live_timer_interval; /* usec */
8d326ab9
DG
331
332 char padding[LTTNG_SESSION_PADDING1];
54c90d10 333};
1657e9bb 334
cd80958d
DG
335/*
336 * Handle used as a context for commands.
ece640c8
RB
337 *
338 * The structures should be initialized to zero before use.
cd80958d 339 */
8d326ab9 340#define LTTNG_HANDLE_PADDING1 16
cd80958d
DG
341struct lttng_handle {
342 char session_name[NAME_MAX];
343 struct lttng_domain domain;
8d326ab9
DG
344
345 char padding[LTTNG_HANDLE_PADDING1];
54c90d10 346};
cd80958d 347
7d29a247
DG
348/*
349 * Public LTTng control API
350 *
1e46a50f 351 * For functions having an lttng domain type as parameter, if a bad value is
7d29a247
DG
352 * given, NO default is applied and an error is returned.
353 *
354 * On success, all functions of the API return 0 or the size of the allocated
1e46a50f 355 * array (in bytes).
7d29a247
DG
356 *
357 * On error, a negative value is returned being a specific lttng-tools error
9a745bc7 358 * code which can be humanly interpreted with lttng_strerror(err).
1e46a50f
TD
359 *
360 * Exceptions to this are noted below.
7d29a247
DG
361 */
362
b7384347 363/*
1e46a50f 364 * Create a handle used as a context for every request made to the library.
cd80958d
DG
365 *
366 * This handle contains the session name and lttng domain on which the command
1e46a50f
TD
367 * will be executed.
368 * The returned pointer will be NULL in case of malloc() error.
cd80958d
DG
369 */
370extern struct lttng_handle *lttng_create_handle(const char *session_name,
371 struct lttng_domain *domain);
372
373/*
41039c06
DG
374 * Destroy an handle.
375 *
376 * It free(3) the data pointer returned by lttng_create_handle(), rendering it
377 * unusable.
b7384347 378 */
cd80958d 379extern void lttng_destroy_handle(struct lttng_handle *handle);
7d29a247
DG
380
381/*
a4b92340
DG
382 * Create a tracing session using a name and an optional URL.
383 *
41039c06
DG
384 * If _url_ is NULL, no consumer is created for the session. The name can't be
385 * NULL here.
00e2e675 386 */
a4b92340 387extern int lttng_create_session(const char *name, const char *url);
00e2e675 388
27babd3a
DG
389/*
390 * Create a tracing session that will exclusively be used for snapshot meaning
391 * the session will be in no output mode and every channel enabled for that
392 * session will be set in overwrite mode and in mmap output since splice is not
393 * supported.
394 *
395 * If an url is given, it will be used to create a default snapshot output
396 * using it as a destination. If NULL, no output will be defined and an
397 * add-output call will be needed.
398 *
399 * Name can't be NULL.
400 */
401extern int lttng_create_session_snapshot(const char *name,
402 const char *snapshot_url);
403
ecc48a90
JD
404/*
405 * Create a session exclusively used for live reading.
406 *
407 * In this mode, the switch-timer parameter is forced for each UST channel, a
408 * live-switch-timer is enabled for kernel channels, manually setting
409 * switch-timer is forbidden. Synchronization beacons are sent to the relayd,
410 * indexes are sent and metadata is checked for each packet.
411 *
412 * Returns LTTNG_OK on success or a negative error code.
413 */
414extern int lttng_create_session_live(const char *name, const char *url,
415 unsigned int timer_interval);
416
7d29a247 417/*
1e46a50f 418 * Destroy a tracing session.
7d29a247 419 *
1e46a50f
TD
420 * The session will not be usable anymore, tracing will be stopped for all
421 * registered traces, and the tracing buffers will be flushed.
41039c06
DG
422 *
423 * The name can't be NULL here.
7d29a247 424 */
843f5df9 425extern int lttng_destroy_session(const char *name);
f3ed775e 426
e6ddca71 427/*
1e46a50f 428 * List all the tracing sessions.
7d29a247 429 *
1e46a50f
TD
430 * Return the size (number of entries) of the "lttng_session" array. Caller
431 * must free(3).
e6ddca71 432 */
ca95a216 433extern int lttng_list_sessions(struct lttng_session **sessions);
f3ed775e 434
9f19cc17 435/*
1e46a50f 436 * List the registered domain(s) of a session.
9f19cc17 437 *
1e46a50f
TD
438 * Return the size (number of entries) of the "lttng_domain" array. Caller
439 * must free(3).
9f19cc17 440 */
330be774 441extern int lttng_list_domains(const char *session_name,
9f19cc17
DG
442 struct lttng_domain **domains);
443
444/*
1e46a50f 445 * List the channel(s) of a session.
9f19cc17 446 *
1e46a50f
TD
447 * Return the size (number of entries) of the "lttng_channel" array. Caller
448 * must free(3).
9f19cc17 449 */
cd80958d
DG
450extern int lttng_list_channels(struct lttng_handle *handle,
451 struct lttng_channel **channels);
9f19cc17
DG
452
453/*
1e46a50f 454 * List the event(s) of a session channel.
9f19cc17 455 *
1e46a50f
TD
456 * Return the size (number of entries) of the "lttng_event" array.
457 * Caller must free(3).
9f19cc17 458 */
cd80958d
DG
459extern int lttng_list_events(struct lttng_handle *handle,
460 const char *channel_name, struct lttng_event **events);
9f19cc17
DG
461
462/*
1e46a50f 463 * List the available tracepoints of a specific lttng domain.
9f19cc17 464 *
1e46a50f
TD
465 * Return the size (number of entries) of the "lttng_event" array.
466 * Caller must free(3).
9f19cc17 467 */
cd80958d 468extern int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 469 struct lttng_event **events);
9f19cc17 470
f37d259d
MD
471/*
472 * List the available tracepoints fields of a specific lttng domain.
473 *
474 * Return the size (number of entries) of the "lttng_event_field" array.
475 * Caller must free(3).
476 */
477extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
478 struct lttng_event_field **fields);
479
7d29a247
DG
480/*
481 * Check if a session daemon is alive.
1e46a50f
TD
482 *
483 * Return 1 if alive or 0 if not. On error returns a negative value.
7d29a247 484 */
947308c4 485extern int lttng_session_daemon_alive(void);
f3ed775e 486
7d29a247 487/*
1e46a50f
TD
488 * Set the tracing group for the *current* flow of execution.
489 *
41039c06
DG
490 * On success, returns 0 else a negative value on error being a lttng error
491 * code found in lttng-error.h
7d29a247 492 */
b7384347 493extern int lttng_set_tracing_group(const char *name);
f3ed775e 494
7d29a247 495/*
1e46a50f 496 * Return a human-readable error message for an lttng-tools error code.
7d29a247
DG
497 *
498 * Parameter MUST be a negative value or else you'll get a generic message.
499 */
9a745bc7 500extern const char *lttng_strerror(int code);
b7384347 501
d9800920 502/*
1e46a50f
TD
503 * This call registers an "outside consumer" for a session and an lttng domain.
504 * No consumer will be spawned and all fds/commands will go through the socket
505 * path given (socket_path).
d9800920 506 *
3bd1e081 507 * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the
d9800920
DG
508 * command socket. The error socket is not supported yet for roaming consumers.
509 */
510extern int lttng_register_consumer(struct lttng_handle *handle,
511 const char *socket_path);
512
7d29a247 513/*
1e46a50f 514 * Start tracing for *all* registered traces (kernel and user-space).
7d29a247 515 */
6a4f824d 516extern int lttng_start_tracing(const char *session_name);
f3ed775e 517
7d29a247 518/*
1e46a50f 519 * Stop tracing for *all* registered traces (kernel and user-space).
38ee087f
DG
520 *
521 * This call will wait for data availability for each domain of the session so
522 * this can take an abritrary amount of time. However, when returning you have
523 * the guarantee that the data is ready to be read and analyse. Use the
524 * _no_wait call below to avoid this behavior.
41039c06
DG
525 *
526 * The session_name can't be NULL.
7d29a247 527 */
6a4f824d 528extern int lttng_stop_tracing(const char *session_name);
f3ed775e 529
38ee087f
DG
530/*
531 * Behave exactly like lttng_stop_tracing but does not wait for data
532 * availability.
533 */
534extern int lttng_stop_tracing_no_wait(const char *session_name);
535
b7384347 536/*
1e46a50f 537 * Add context to event(s) for a specific channel (or for all).
7d29a247 538 *
41039c06
DG
539 * If channel_name is NULL, a lookup of the event's channel is done. If both
540 * are NULL, the context is applied to all events of all channels.
541 *
542 * Note that whatever event_name value is, a context can not be added to an
543 * event, so we just ignore it for now.
b7384347 544 */
cd80958d 545extern int lttng_add_context(struct lttng_handle *handle,
38057ed1
DG
546 struct lttng_event_context *ctx, const char *event_name,
547 const char *channel_name);
f3ed775e 548
7d29a247 549/*
c8f61fc6 550 * Create or enable an event (or events) for a channel.
7d29a247
DG
551 *
552 * If the event you are trying to enable does not exist, it will be created,
553 * else it is enabled.
7d29a247 554 * If channel_name is NULL, the default channel is used (channel0).
41039c06
DG
555 *
556 * The handle and ev params can not be NULL.
7d29a247 557 */
cd80958d
DG
558extern int lttng_enable_event(struct lttng_handle *handle,
559 struct lttng_event *ev, const char *channel_name);
f3ed775e 560
53a80697 561/*
025faf73 562 * Create or enable an event with a specific filter.
53a80697 563 *
025faf73
DG
564 * If the event you are trying to enable does not exist, it will be created,
565 * else it is enabled.
41039c06 566 * If ev is NULL, all events are enabled with that filter.
025faf73
DG
567 * If channel_name is NULL, the default channel is used (channel0) and created
568 * if not found.
52df2401
MD
569 * If filter_expression is NULL, an event without associated filter is
570 * created.
53a80697 571 */
025faf73 572extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
178191b3 573 struct lttng_event *event, const char *channel_name,
53a80697 574 const char *filter_expression);
178191b3 575
93deb080
JI
576/*
577 * Create or enable an event with a filter and/or exclusions.
578 *
579 * If the event you are trying to enable does not exist, it will be created,
580 * else it is enabled.
581 * If ev is NULL, all events are enabled with the filter and exclusion options.
582 * If channel_name is NULL, the default channel is used (channel0) and created
583 * if not found.
584 * If filter_expression is NULL, an event without associated filter is
585 * created.
586 * If exclusion count is zero, the event will be created without exclusions.
587 */
588extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
589 struct lttng_event *event, const char *channel_name,
590 const char *filter_expression,
591 int exclusion_count, char **exclusion_names);
592
7d29a247 593/*
c8f61fc6 594 * Create or enable a channel.
41039c06
DG
595 *
596 * The chan and handle params can not be NULL.
7d29a247 597 */
cd80958d 598extern int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 599 struct lttng_channel *chan);
f3ed775e 600
7d29a247 601/*
c8f61fc6 602 * Disable event(s) of a channel and domain.
7d29a247 603 *
41039c06 604 * If name is NULL, all events are disabled.
7d29a247
DG
605 * If channel_name is NULL, the default channel is used (channel0).
606 */
cd80958d
DG
607extern int lttng_disable_event(struct lttng_handle *handle,
608 const char *name, const char *channel_name);
fac6795d 609
1df4dedd 610/*
c8f61fc6 611 * Disable channel.
7d29a247 612 *
1df4dedd 613 */
cd80958d 614extern int lttng_disable_channel(struct lttng_handle *handle,
38057ed1 615 const char *name);
1df4dedd 616
d0254c7c
MD
617/*
618 * Calibrate LTTng overhead.
41039c06
DG
619 *
620 * The chan and handle params can not be NULL.
d0254c7c 621 */
cd80958d 622extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
623 struct lttng_calibrate *calibrate);
624
5edd7e09
DG
625/*
626 * Set the default channel attributes for a specific domain and an allocated
627 * lttng_channel_attr pointer.
1e46a50f 628 *
41039c06 629 * If one or both arguments are NULL, nothing happens.
5edd7e09
DG
630 */
631extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
632 struct lttng_channel_attr *attr);
633
00e2e675 634/*
a4b92340
DG
635 * Set URL for a consumer for a session and domain.
636 *
637 * Both data and control URL must be defined. If both URLs are the same, only
638 * the control URL is used even for network streaming.
00e2e675 639 *
a4b92340
DG
640 * Default port are 5342 and 5343 respectively for control and data which uses
641 * the TCP protocol.
00e2e675 642 */
a4b92340
DG
643extern int lttng_set_consumer_url(struct lttng_handle *handle,
644 const char *control_url, const char *data_url);
00e2e675
DG
645
646/*
647 * Enable the consumer for a session and domain.
648 */
9c6bda17 649extern LTTNG_DEPRECATED("This call is now obsolete.")
785d2d0d 650int lttng_enable_consumer(struct lttng_handle *handle);
00e2e675
DG
651
652/*
653 * Disable consumer for a session and domain.
654 */
9c6bda17 655extern LTTNG_DEPRECATED("This call is now obsolete.")
785d2d0d 656int lttng_disable_consumer(struct lttng_handle *handle);
00e2e675 657
44a5e5eb
DG
658/*
659 * Check session daemon health for a specific component.
660 *
661 * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
662 * the control library was not able to connect to the session daemon health
663 * socket.
664 *
665 * Any other positive value is an lttcomm error which can be translate with
666 * lttng_strerror().
41039c06
DG
667 *
668 * Please see lttng-health-check(3) man page for more information.
44a5e5eb 669 */
d74df422
MD
670extern LTTNG_DEPRECATED("This call is now obsolete.")
671int lttng_health_check(enum lttng_health_component c);
44a5e5eb 672
806e2684
DG
673/*
674 * For a given session name, this call checks if the data is ready to be read
6d805429
DG
675 * or is still being extracted by the consumer(s) (pending) hence not ready to
676 * be used by any readers.
806e2684 677 *
6d805429
DG
678 * Return 0 if there is _no_ data pending in the buffers thus having a
679 * guarantee that the data can be read safely. Else, return 1 if there is still
680 * traced data is pending. On error, a negative value is returned and readable
681 * by lttng_strerror().
806e2684 682 */
6d805429 683extern int lttng_data_pending(const char *session_name);
806e2684 684
5168918c
DG
685#ifdef __cplusplus
686}
687#endif
688
73db5be4 689#endif /* LTTNG_H */
This page took 0.109802 seconds and 4 git commands to generate.