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