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