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