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