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