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