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