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