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