4 * Linux Trace Toolkit Control Library Header File
6 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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.
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
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
25 /* Error codes that can be returned by API calls */
26 #include <lttng/lttng-error.h>
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/session-descriptor.h>
39 #include <lttng/destruction-handle.h>
40 #include <lttng/action/action.h>
41 #include <lttng/action/notify.h>
42 #include <lttng/condition/condition.h>
43 #include <lttng/condition/buffer-usage.h>
44 #include <lttng/condition/session-consumed-size.h>
45 #include <lttng/condition/session-rotation.h>
46 #include <lttng/condition/evaluation.h>
47 #include <lttng/notification/channel.h>
48 #include <lttng/notification/notification.h>
49 #include <lttng/trigger/trigger.h>
50 #include <lttng/rotation.h>
56 enum lttng_calibrate_type
{
57 LTTNG_CALIBRATE_FUNCTION
= 0,
60 /* Machine interface output type */
61 enum lttng_mi_output_type
{
62 LTTNG_MI_XML
= 1 /* XML output */
65 #define LTTNG_CALIBRATE_PADDING1 16
66 struct lttng_calibrate
{
67 enum lttng_calibrate_type type
;
69 char padding
[LTTNG_CALIBRATE_PADDING1
];
73 * Check if a session daemon is alive.
75 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
78 extern int lttng_session_daemon_alive(void);
81 * Set the tracing group for the *current* flow of execution.
83 * On success, returns 0 else a negative LTTng error code.
85 extern int lttng_set_tracing_group(const char *name
);
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).
92 * NOTE that this is not recommended unless you absolutely know what you are
95 * Return 0 on success else a negative LTTng error code.
97 extern int lttng_register_consumer(struct lttng_handle
*handle
,
98 const char *socket_path
);
101 * Start tracing for *all* domain(s) in the session.
103 * Return 0 on success else a negative LTTng error code.
105 extern int lttng_start_tracing(const char *session_name
);
108 * Stop tracing for *all* domain(s) in the session.
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.
115 * The session_name can't be NULL.
117 * Return 0 on success else a negative LTTng error code.
119 extern int lttng_stop_tracing(const char *session_name
);
122 * Behave exactly like lttng_stop_tracing but does not wait for data
125 extern int lttng_stop_tracing_no_wait(const char *session_name
);
128 * Deprecated: As of LTTng 2.9, this function always returns
131 extern int lttng_calibrate(struct lttng_handle
*handle
,
132 struct lttng_calibrate
*calibrate
);
135 * Set URL for a consumer for a session and domain.
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.
140 * Default port are 5342 and 5343 respectively for control and data which uses
143 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
145 * Possible protocols are:
147 * Local filesystem full path.
150 * This will use the default network transport layer which is TCP for both
151 * control (PORT1) and data port (PORT2).
154 * TCP only streaming. For this one, both data and control URL must be given.
156 * Return 0 on success else a negative LTTng error code.
158 extern int lttng_set_consumer_url(struct lttng_handle
*handle
,
159 const char *control_url
, const char *data_url
);
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.
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().
171 extern int lttng_data_pending(const char *session_name
);
174 * Deprecated, replaced by lttng_regenerate_metadata.
177 extern int lttng_metadata_regenerate(const char *session_name
);
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.
185 extern int lttng_regenerate_metadata(const char *session_name
);
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
192 * Return 0 on success, a negative LTTng error code on error.
194 extern int lttng_regenerate_statedump(const char *session_name
);