Cleanup: remove duplicated code in snapshot record command
[lttng-tools.git] / include / lttng / lttng.h
CommitLineData
826d496d 1/*
b7384347
DG
2 * lttng.h
3 *
4 * Linux Trace Toolkit Control Library Header File
5 *
826d496d 6 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
fac6795d 7 *
1e46a50f 8 * This library is free software; you can redistribute it and/or modify it
d14d33bf
AM
9 * under the terms of the GNU Lesser General Public License, version 2.1 only,
10 * as published by the Free Software Foundation.
82a3637f 11 *
1e46a50f
TD
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.
82a3637f 16 *
1e46a50f
TD
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
fac6795d
DG
20 */
21
73db5be4
DG
22#ifndef LTTNG_H
23#define LTTNG_H
fac6795d 24
03b1319d
DG
25/* Error codes that can be returned by API calls */
26#include <lttng/lttng-error.h>
27
1239a312
DG
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>
a58c490f 37#include <lttng/endpoint.h>
b178f53e 38#include <lttng/session-descriptor.h>
a58c490f
JG
39#include <lttng/action/action.h>
40#include <lttng/action/notify.h>
41#include <lttng/condition/condition.h>
42#include <lttng/condition/buffer-usage.h>
e8360425 43#include <lttng/condition/session-consumed-size.h>
c19092cd 44#include <lttng/condition/session-rotation.h>
a58c490f
JG
45#include <lttng/condition/evaluation.h>
46#include <lttng/notification/channel.h>
47#include <lttng/notification/notification.h>
48#include <lttng/trigger/trigger.h>
259c2674 49#include <lttng/rotation.h>
1239a312 50
5168918c
DG
51#ifdef __cplusplus
52extern "C" {
53#endif
54
1239a312
DG
55enum lttng_calibrate_type {
56 LTTNG_CALIBRATE_FUNCTION = 0,
54c90d10 57};
f3ed775e 58
c7e35b03
JR
59/* Machine interface output type */
60enum lttng_mi_output_type {
61 LTTNG_MI_XML = 1 /* XML output */
62};
63
8d326ab9 64#define LTTNG_CALIBRATE_PADDING1 16
d0254c7c
MD
65struct lttng_calibrate {
66 enum lttng_calibrate_type type;
8d326ab9
DG
67
68 char padding[LTTNG_CALIBRATE_PADDING1];
54c90d10 69};
d0254c7c 70
7d29a247
DG
71/*
72 * Check if a session daemon is alive.
1e46a50f 73 *
06662f07
DG
74 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
75 * error code.
7d29a247 76 */
947308c4 77extern int lttng_session_daemon_alive(void);
f3ed775e 78
7d29a247 79/*
1e46a50f
TD
80 * Set the tracing group for the *current* flow of execution.
81 *
06662f07 82 * On success, returns 0 else a negative LTTng error code.
7d29a247 83 */
b7384347 84extern int lttng_set_tracing_group(const char *name);
f3ed775e 85
d9800920 86/*
1e46a50f
TD
87 * This call registers an "outside consumer" for a session and an lttng domain.
88 * No consumer will be spawned and all fds/commands will go through the socket
89 * path given (socket_path).
d9800920 90 *
06662f07
DG
91 * NOTE that this is not recommended unless you absolutely know what you are
92 * doing.
93 *
94 * Return 0 on success else a negative LTTng error code.
d9800920
DG
95 */
96extern int lttng_register_consumer(struct lttng_handle *handle,
97 const char *socket_path);
98
7d29a247 99/*
06662f07
DG
100 * Start tracing for *all* domain(s) in the session.
101 *
102 * Return 0 on success else a negative LTTng error code.
7d29a247 103 */
6a4f824d 104extern int lttng_start_tracing(const char *session_name);
f3ed775e 105
7d29a247 106/*
06662f07 107 * Stop tracing for *all* domain(s) in the session.
38ee087f
DG
108 *
109 * This call will wait for data availability for each domain of the session so
110 * this can take an abritrary amount of time. However, when returning you have
06662f07 111 * the guarantee that the data is ready to be read and analyze. Use the
38ee087f 112 * _no_wait call below to avoid this behavior.
41039c06
DG
113 *
114 * The session_name can't be NULL.
06662f07
DG
115 *
116 * Return 0 on success else a negative LTTng error code.
7d29a247 117 */
6a4f824d 118extern int lttng_stop_tracing(const char *session_name);
f3ed775e 119
38ee087f
DG
120/*
121 * Behave exactly like lttng_stop_tracing but does not wait for data
122 * availability.
123 */
124extern int lttng_stop_tracing_no_wait(const char *session_name);
125
d0254c7c 126/*
b812e5ca
PP
127 * Deprecated: As of LTTng 2.9, this function always returns
128 * -LTTNG_ERR_UND.
d0254c7c 129 */
cd80958d 130extern int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
131 struct lttng_calibrate *calibrate);
132
00e2e675 133/*
a4b92340
DG
134 * Set URL for a consumer for a session and domain.
135 *
136 * Both data and control URL must be defined. If both URLs are the same, only
137 * the control URL is used even for network streaming.
00e2e675 138 *
a4b92340
DG
139 * Default port are 5342 and 5343 respectively for control and data which uses
140 * the TCP protocol.
06662f07
DG
141 *
142 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
143 *
144 * Possible protocols are:
145 * > file://...
146 * Local filesystem full path.
147 *
148 * > net[6]://...
149 * This will use the default network transport layer which is TCP for both
150 * control (PORT1) and data port (PORT2).
151 *
152 * > tcp[6]://...
153 * TCP only streaming. For this one, both data and control URL must be given.
154 *
155 * Return 0 on success else a negative LTTng error code.
00e2e675 156 */
a4b92340
DG
157extern int lttng_set_consumer_url(struct lttng_handle *handle,
158 const char *control_url, const char *data_url);
00e2e675 159
806e2684
DG
160/*
161 * For a given session name, this call checks if the data is ready to be read
6d805429
DG
162 * or is still being extracted by the consumer(s) (pending) hence not ready to
163 * be used by any readers.
806e2684 164 *
6d805429
DG
165 * Return 0 if there is _no_ data pending in the buffers thus having a
166 * guarantee that the data can be read safely. Else, return 1 if there is still
167 * traced data is pending. On error, a negative value is returned and readable
168 * by lttng_strerror().
806e2684 169 */
6d805429 170extern int lttng_data_pending(const char *session_name);
806e2684 171
eded6438
JD
172/*
173 * Deprecated, replaced by lttng_regenerate_metadata.
174 */
175LTTNG_DEPRECATED()
176extern int lttng_metadata_regenerate(const char *session_name);
177
93ec662e
JD
178/*
179 * Trigger the regeneration of the metadata for a session.
180 * The new metadata overwrite the previous one locally or remotely (through
181 * the lttng-relayd). Only kernel, per-uid and non-live sessions are supported.
182 * Return 0 on success, a negative LTTng error code on error.
183 */
eded6438 184extern int lttng_regenerate_metadata(const char *session_name);
93ec662e 185
c2561365
JD
186/*
187 * Trigger the regeneration of the statedump for a session. The new statedump
188 * information is appended to the currently active trace, the session needs to
189 * be active.
190 *
191 * Return 0 on success, a negative LTTng error code on error.
192 */
193extern int lttng_regenerate_statedump(const char *session_name);
194
5168918c
DG
195#ifdef __cplusplus
196}
197#endif
198
73db5be4 199#endif /* LTTNG_H */
This page took 0.074487 seconds and 5 git commands to generate.