Fix: API: missing end brace for C++ linkage specification.
[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 *
ab5be9fa 6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
fac6795d 7 *
ab5be9fa 8 * SPDX-License-Identifier: LGPL-2.1-only
82a3637f 9 *
fac6795d
DG
10 */
11
73db5be4
DG
12#ifndef LTTNG_H
13#define LTTNG_H
fac6795d 14
03b1319d
DG
15/* Error codes that can be returned by API calls */
16#include <lttng/lttng-error.h>
17
1239a312
DG
18/* Include every LTTng ABI/API available. */
19#include <lttng/channel.h>
20#include <lttng/domain.h>
21#include <lttng/event.h>
22#include <lttng/handle.h>
23#include <lttng/health.h>
24#include <lttng/save.h>
25#include <lttng/session.h>
26#include <lttng/snapshot.h>
a58c490f 27#include <lttng/endpoint.h>
b178f53e 28#include <lttng/session-descriptor.h>
bbbfd849 29#include <lttng/destruction-handle.h>
a58c490f
JG
30#include <lttng/action/action.h>
31#include <lttng/action/notify.h>
32#include <lttng/condition/condition.h>
33#include <lttng/condition/buffer-usage.h>
e8360425 34#include <lttng/condition/session-consumed-size.h>
c19092cd 35#include <lttng/condition/session-rotation.h>
a58c490f
JG
36#include <lttng/condition/evaluation.h>
37#include <lttng/notification/channel.h>
38#include <lttng/notification/notification.h>
39#include <lttng/trigger/trigger.h>
259c2674 40#include <lttng/rotation.h>
2d97a006 41#include <lttng/tracker.h>
1239a312 42
5168918c
DG
43#ifdef __cplusplus
44extern "C" {
45#endif
46
1239a312
DG
47enum lttng_calibrate_type {
48 LTTNG_CALIBRATE_FUNCTION = 0,
54c90d10 49};
f3ed775e 50
c7e35b03
JR
51/* Machine interface output type */
52enum lttng_mi_output_type {
53 LTTNG_MI_XML = 1 /* XML output */
54};
55
8d326ab9 56#define LTTNG_CALIBRATE_PADDING1 16
d0254c7c
MD
57struct lttng_calibrate {
58 enum lttng_calibrate_type type;
8d326ab9
DG
59
60 char padding[LTTNG_CALIBRATE_PADDING1];
54c90d10 61};
d0254c7c 62
7d29a247
DG
63/*
64 * Check if a session daemon is alive.
1e46a50f 65 *
06662f07
DG
66 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
67 * error code.
7d29a247 68 */
947308c4 69extern int lttng_session_daemon_alive(void);
f3ed775e 70
7d29a247 71/*
1e46a50f
TD
72 * Set the tracing group for the *current* flow of execution.
73 *
06662f07 74 * On success, returns 0 else a negative LTTng error code.
7d29a247 75 */
b7384347 76extern int lttng_set_tracing_group(const char *name);
f3ed775e 77
d9800920 78/*
1e46a50f
TD
79 * This call registers an "outside consumer" for a session and an lttng domain.
80 * No consumer will be spawned and all fds/commands will go through the socket
81 * path given (socket_path).
d9800920 82 *
06662f07
DG
83 * NOTE that this is not recommended unless you absolutely know what you are
84 * doing.
85 *
86 * Return 0 on success else a negative LTTng error code.
d9800920
DG
87 */
88extern int lttng_register_consumer(struct lttng_handle *handle,
89 const char *socket_path);
90
7d29a247 91/*
06662f07
DG
92 * Start tracing for *all* domain(s) in the session.
93 *
94 * Return 0 on success else a negative LTTng error code.
7d29a247 95 */
6a4f824d 96extern int lttng_start_tracing(const char *session_name);
f3ed775e 97
7d29a247 98/*
06662f07 99 * Stop tracing for *all* domain(s) in the session.
38ee087f
DG
100 *
101 * This call will wait for data availability for each domain of the session so
102 * this can take an abritrary amount of time. However, when returning you have
06662f07 103 * the guarantee that the data is ready to be read and analyze. Use the
38ee087f 104 * _no_wait call below to avoid this behavior.
41039c06
DG
105 *
106 * The session_name can't be NULL.
06662f07
DG
107 *
108 * Return 0 on success else a negative LTTng error code.
7d29a247 109 */
6a4f824d 110extern int lttng_stop_tracing(const char *session_name);
f3ed775e 111
38ee087f
DG
112/*
113 * Behave exactly like lttng_stop_tracing but does not wait for data
114 * availability.
115 */
116extern int lttng_stop_tracing_no_wait(const char *session_name);
117
d0254c7c 118/*
b812e5ca
PP
119 * Deprecated: As of LTTng 2.9, this function always returns
120 * -LTTNG_ERR_UND.
d0254c7c 121 */
cd80958d 122extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
123 struct lttng_calibrate *calibrate);
124
00e2e675 125/*
a4b92340
DG
126 * Set URL for a consumer for a session and domain.
127 *
128 * Both data and control URL must be defined. If both URLs are the same, only
129 * the control URL is used even for network streaming.
00e2e675 130 *
a4b92340
DG
131 * Default port are 5342 and 5343 respectively for control and data which uses
132 * the TCP protocol.
06662f07
DG
133 *
134 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
135 *
136 * Possible protocols are:
137 * > file://...
138 * Local filesystem full path.
139 *
140 * > net[6]://...
141 * This will use the default network transport layer which is TCP for both
142 * control (PORT1) and data port (PORT2).
143 *
144 * > tcp[6]://...
145 * TCP only streaming. For this one, both data and control URL must be given.
146 *
147 * Return 0 on success else a negative LTTng error code.
00e2e675 148 */
a4b92340
DG
149extern int lttng_set_consumer_url(struct lttng_handle *handle,
150 const char *control_url, const char *data_url);
00e2e675 151
806e2684
DG
152/*
153 * For a given session name, this call checks if the data is ready to be read
6d805429
DG
154 * or is still being extracted by the consumer(s) (pending) hence not ready to
155 * be used by any readers.
806e2684 156 *
6d805429
DG
157 * Return 0 if there is _no_ data pending in the buffers thus having a
158 * guarantee that the data can be read safely. Else, return 1 if there is still
159 * traced data is pending. On error, a negative value is returned and readable
160 * by lttng_strerror().
806e2684 161 */
6d805429 162extern int lttng_data_pending(const char *session_name);
806e2684 163
eded6438
JD
164/*
165 * Deprecated, replaced by lttng_regenerate_metadata.
166 */
167LTTNG_DEPRECATED()
168extern int lttng_metadata_regenerate(const char *session_name);
169
93ec662e
JD
170/*
171 * Trigger the regeneration of the metadata for a session.
172 * The new metadata overwrite the previous one locally or remotely (through
173 * the lttng-relayd). Only kernel, per-uid and non-live sessions are supported.
174 * Return 0 on success, a negative LTTng error code on error.
175 */
eded6438 176extern int lttng_regenerate_metadata(const char *session_name);
93ec662e 177
c2561365
JD
178/*
179 * Trigger the regeneration of the statedump for a session. The new statedump
180 * information is appended to the currently active trace, the session needs to
181 * be active.
182 *
183 * Return 0 on success, a negative LTTng error code on error.
184 */
185extern int lttng_regenerate_statedump(const char *session_name);
186
5168918c
DG
187#ifdef __cplusplus
188}
189#endif
190
73db5be4 191#endif /* LTTNG_H */
This page took 0.09408 seconds and 4 git commands to generate.