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