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