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