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