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