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>
42 enum lttng_calibrate_type
{
43 LTTNG_CALIBRATE_FUNCTION
= 0,
46 /* Machine interface output type */
47 enum lttng_mi_output_type
{
48 LTTNG_MI_XML
= 1 /* XML output */
51 #define LTTNG_CALIBRATE_PADDING1 16
52 struct lttng_calibrate
{
53 enum lttng_calibrate_type type
;
55 char padding
[LTTNG_CALIBRATE_PADDING1
];
59 * Check if a session daemon is alive.
61 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
64 extern int lttng_session_daemon_alive(void);
67 * Set the tracing group for the *current* flow of execution.
69 * On success, returns 0 else a negative LTTng error code.
71 extern int lttng_set_tracing_group(const char *name
);
74 * This call registers an "outside consumer" for a session and an lttng domain.
75 * No consumer will be spawned and all fds/commands will go through the socket
76 * path given (socket_path).
78 * NOTE that this is not recommended unless you absolutely know what you are
81 * Return 0 on success else a negative LTTng error code.
83 extern int lttng_register_consumer(struct lttng_handle
*handle
,
84 const char *socket_path
);
87 * Start tracing for *all* domain(s) in the session.
89 * Return 0 on success else a negative LTTng error code.
91 extern int lttng_start_tracing(const char *session_name
);
94 * Stop tracing for *all* domain(s) in the session.
96 * This call will wait for data availability for each domain of the session so
97 * this can take an abritrary amount of time. However, when returning you have
98 * the guarantee that the data is ready to be read and analyze. Use the
99 * _no_wait call below to avoid this behavior.
101 * The session_name can't be NULL.
103 * Return 0 on success else a negative LTTng error code.
105 extern int lttng_stop_tracing(const char *session_name
);
108 * Behave exactly like lttng_stop_tracing but does not wait for data
111 extern int lttng_stop_tracing_no_wait(const char *session_name
);
114 * Calibrate LTTng overhead.
116 * The chan and handle params can not be NULL.
118 * Return 0 on success else a negative LTTng error code.
120 extern int lttng_calibrate(struct lttng_handle
*handle
,
121 struct lttng_calibrate
*calibrate
);
124 * Set URL for a consumer for a session and domain.
126 * Both data and control URL must be defined. If both URLs are the same, only
127 * the control URL is used even for network streaming.
129 * Default port are 5342 and 5343 respectively for control and data which uses
132 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
134 * Possible protocols are:
136 * Local filesystem full path.
139 * This will use the default network transport layer which is TCP for both
140 * control (PORT1) and data port (PORT2).
143 * TCP only streaming. For this one, both data and control URL must be given.
145 * Return 0 on success else a negative LTTng error code.
147 extern int lttng_set_consumer_url(struct lttng_handle
*handle
,
148 const char *control_url
, const char *data_url
);
151 * For a given session name, this call checks if the data is ready to be read
152 * or is still being extracted by the consumer(s) (pending) hence not ready to
153 * be used by any readers.
155 * Return 0 if there is _no_ data pending in the buffers thus having a
156 * guarantee that the data can be read safely. Else, return 1 if there is still
157 * traced data is pending. On error, a negative value is returned and readable
158 * by lttng_strerror().
160 extern int lttng_data_pending(const char *session_name
);
163 * Deprecated, replaced by lttng_regenerate_metadata.
166 extern int lttng_metadata_regenerate(const char *session_name
);
169 * Trigger the regeneration of the metadata for a session.
170 * The new metadata overwrite the previous one locally or remotely (through
171 * the lttng-relayd). Only kernel, per-uid and non-live sessions are supported.
172 * Return 0 on success, a negative LTTng error code on error.
174 extern int lttng_regenerate_metadata(const char *session_name
);
177 * Trigger the regeneration of the statedump for a session. The new statedump
178 * information is appended to the currently active trace, the session needs to
181 * Return 0 on success, a negative LTTng error code on error.
183 extern int lttng_regenerate_statedump(const char *session_name
);