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