5669958682c9bab22925bef492f3f996e19dea96
[deliverable/lttng-tools.git] / include / lttng / lttng.h
1 /*
2 * lttng.h
3 *
4 * Linux Trace Toolkit Control Library Header File
5 *
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
7 *
8 * SPDX-License-Identifier: LGPL-2.1-only
9 *
10 */
11
12 #ifndef LTTNG_H
13 #define LTTNG_H
14
15 /* Error codes that can be returned by API calls */
16 #include <lttng/lttng-error.h>
17
18 /* Include every LTTng ABI/API available. */
19 #include <lttng/action/action.h>
20 #include <lttng/action/list.h>
21 #include <lttng/action/notify.h>
22 #include <lttng/action/path.h>
23 #include <lttng/action/rate-policy.h>
24 #include <lttng/action/rotate-session.h>
25 #include <lttng/action/snapshot-session.h>
26 #include <lttng/action/start-session.h>
27 #include <lttng/action/stop-session.h>
28 #include <lttng/channel.h>
29 #include <lttng/clear-handle.h>
30 #include <lttng/clear.h>
31 #include <lttng/condition/buffer-usage.h>
32 #include <lttng/condition/condition.h>
33 #include <lttng/condition/evaluation.h>
34 #include <lttng/condition/event-rule-matches.h>
35 #include <lttng/condition/session-consumed-size.h>
36 #include <lttng/condition/session-rotation.h>
37 #include <lttng/constant.h>
38 #include <lttng/destruction-handle.h>
39 #include <lttng/domain.h>
40 #include <lttng/endpoint.h>
41 #include <lttng/error-query.h>
42 #include <lttng/event-expr.h>
43 #include <lttng/event-field-value.h>
44 #include <lttng/event-rule/event-rule.h>
45 #include <lttng/event-rule/kernel-kprobe.h>
46 #include <lttng/event-rule/kernel-syscall.h>
47 #include <lttng/event-rule/tracepoint.h>
48 #include <lttng/event-rule/kernel-tracepoint.h>
49 #include <lttng/event-rule/kernel-uprobe.h>
50 #include <lttng/event.h>
51 #include <lttng/handle.h>
52 #include <lttng/health.h>
53 #include <lttng/kernel-probe.h>
54 #include <lttng/load.h>
55 #include <lttng/location.h>
56 #include <lttng/log-level-rule.h>
57 #include <lttng/lttng-error.h>
58 #include <lttng/notification/channel.h>
59 #include <lttng/notification/notification.h>
60 #include <lttng/rotation.h>
61 #include <lttng/save.h>
62 #include <lttng/session-descriptor.h>
63 #include <lttng/session.h>
64 #include <lttng/snapshot.h>
65 #include <lttng/tracker.h>
66 #include <lttng/trigger/trigger.h>
67 #include <lttng/userspace-probe.h>
68
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72
73 enum lttng_calibrate_type {
74 LTTNG_CALIBRATE_FUNCTION = 0,
75 };
76
77 /* Machine interface output type */
78 enum lttng_mi_output_type {
79 LTTNG_MI_XML = 1 /* XML output */
80 };
81
82 #define LTTNG_CALIBRATE_PADDING1 16
83 struct lttng_calibrate {
84 enum lttng_calibrate_type type;
85
86 char padding[LTTNG_CALIBRATE_PADDING1];
87 };
88
89 /*
90 * Check if a session daemon is alive.
91 *
92 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
93 * error code.
94 */
95 extern int lttng_session_daemon_alive(void);
96
97 /*
98 * Set the tracing group for the *current* flow of execution.
99 *
100 * On success, returns 0 else a negative LTTng error code.
101 */
102 extern int lttng_set_tracing_group(const char *name);
103
104 /*
105 * This call registers an "outside consumer" for a session and an lttng domain.
106 * No consumer will be spawned and all fds/commands will go through the socket
107 * path given (socket_path).
108 *
109 * NOTE that this is not recommended unless you absolutely know what you are
110 * doing.
111 *
112 * Return 0 on success else a negative LTTng error code.
113 */
114 extern int lttng_register_consumer(struct lttng_handle *handle,
115 const char *socket_path);
116
117 /*
118 * Start tracing for *all* domain(s) in the session.
119 *
120 * Return 0 on success else a negative LTTng error code.
121 */
122 extern int lttng_start_tracing(const char *session_name);
123
124 /*
125 * Stop tracing for *all* domain(s) in the session.
126 *
127 * This call will wait for data availability for each domain of the session so
128 * this can take an abritrary amount of time. However, when returning you have
129 * the guarantee that the data is ready to be read and analyze. Use the
130 * _no_wait call below to avoid this behavior.
131 *
132 * The session_name can't be NULL.
133 *
134 * Return 0 on success else a negative LTTng error code.
135 */
136 extern int lttng_stop_tracing(const char *session_name);
137
138 /*
139 * Behave exactly like lttng_stop_tracing but does not wait for data
140 * availability.
141 */
142 extern int lttng_stop_tracing_no_wait(const char *session_name);
143
144 /*
145 * Deprecated: As of LTTng 2.9, this function always returns
146 * -LTTNG_ERR_UND.
147 */
148 extern int lttng_calibrate(struct lttng_handle *handle,
149 struct lttng_calibrate *calibrate);
150
151 /*
152 * Set URL for a consumer for a session and domain.
153 *
154 * Both data and control URL must be defined. If both URLs are the same, only
155 * the control URL is used even for network streaming.
156 *
157 * Default port are 5342 and 5343 respectively for control and data which uses
158 * the TCP protocol.
159 *
160 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
161 *
162 * Possible protocols are:
163 * > file://...
164 * Local filesystem full path.
165 *
166 * > net[6]://...
167 * This will use the default network transport layer which is TCP for both
168 * control (PORT1) and data port (PORT2).
169 *
170 * > tcp[6]://...
171 * TCP only streaming. For this one, both data and control URL must be given.
172 *
173 * Return 0 on success else a negative LTTng error code.
174 */
175 extern int lttng_set_consumer_url(struct lttng_handle *handle,
176 const char *control_url, const char *data_url);
177
178 /*
179 * For a given session name, this call checks if the data is ready to be read
180 * or is still being extracted by the consumer(s) (pending) hence not ready to
181 * be used by any readers.
182 *
183 * Return 0 if there is _no_ data pending in the buffers thus having a
184 * guarantee that the data can be read safely. Else, return 1 if there is still
185 * traced data is pending. On error, a negative value is returned and readable
186 * by lttng_strerror().
187 */
188 extern int lttng_data_pending(const char *session_name);
189
190 /*
191 * Deprecated, replaced by lttng_regenerate_metadata.
192 */
193 LTTNG_DEPRECATED()
194 extern int lttng_metadata_regenerate(const char *session_name);
195
196 /*
197 * Trigger the regeneration of the metadata for a session.
198 * The new metadata overwrite the previous one locally or remotely (through
199 * the lttng-relayd). Only kernel, per-uid and non-live sessions are supported.
200 * Return 0 on success, a negative LTTng error code on error.
201 */
202 extern int lttng_regenerate_metadata(const char *session_name);
203
204 /*
205 * Trigger the regeneration of the statedump for a session. The new statedump
206 * information is appended to the currently active trace, the session needs to
207 * be active.
208 *
209 * Return 0 on success, a negative LTTng error code on error.
210 */
211 extern int lttng_regenerate_statedump(const char *session_name);
212
213 #ifdef __cplusplus
214 }
215 #endif
216
217 #endif /* LTTNG_H */
This page took 0.036194 seconds and 5 git commands to generate.