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