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