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>
38 struct lttng_endpoint
;
44 enum lttng_calibrate_type
{
45 LTTNG_CALIBRATE_FUNCTION
= 0,
48 /* Machine interface output type */
49 enum lttng_mi_output_type
{
50 LTTNG_MI_XML
= 1 /* XML output */
53 #define LTTNG_CALIBRATE_PADDING1 16
54 struct lttng_calibrate
{
55 enum lttng_calibrate_type type
;
57 char padding
[LTTNG_CALIBRATE_PADDING1
];
60 /* Default LTTng session daemon endpoint. */
61 extern struct lttng_endpoint
*session_daemon_endpoint
;
64 * Check if a session daemon is alive.
66 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
69 extern int lttng_session_daemon_alive(void);
72 * Set the tracing group for the *current* flow of execution.
74 * On success, returns 0 else a negative LTTng error code.
76 extern int lttng_set_tracing_group(const char *name
);
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).
83 * NOTE that this is not recommended unless you absolutely know what you are
86 * Return 0 on success else a negative LTTng error code.
88 extern int lttng_register_consumer(struct lttng_handle
*handle
,
89 const char *socket_path
);
92 * Start tracing for *all* domain(s) in the session.
94 * Return 0 on success else a negative LTTng error code.
96 extern int lttng_start_tracing(const char *session_name
);
99 * Stop tracing for *all* domain(s) in the session.
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.
106 * The session_name can't be NULL.
108 * Return 0 on success else a negative LTTng error code.
110 extern int lttng_stop_tracing(const char *session_name
);
113 * Behave exactly like lttng_stop_tracing but does not wait for data
116 extern int lttng_stop_tracing_no_wait(const char *session_name
);
119 * Deprecated: As of LTTng 2.9, this function always returns
122 extern int lttng_calibrate(struct lttng_handle
*handle
,
123 struct lttng_calibrate
*calibrate
);
126 * Set URL for a consumer for a session and domain.
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.
131 * Default port are 5342 and 5343 respectively for control and data which uses
134 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
136 * Possible protocols are:
138 * Local filesystem full path.
141 * This will use the default network transport layer which is TCP for both
142 * control (PORT1) and data port (PORT2).
145 * TCP only streaming. For this one, both data and control URL must be given.
147 * Return 0 on success else a negative LTTng error code.
149 extern int lttng_set_consumer_url(struct lttng_handle
*handle
,
150 const char *control_url
, const char *data_url
);
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.
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().
162 extern int lttng_data_pending(const char *session_name
);
165 * Deprecated, replaced by lttng_regenerate_metadata.
168 extern int lttng_metadata_regenerate(const char *session_name
);
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.
176 extern int lttng_regenerate_metadata(const char *session_name
);
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
183 * Return 0 on success, a negative LTTng error code on error.
185 extern int lttng_regenerate_statedump(const char *session_name
);