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