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