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