SoW-2020-0002: Trace Hit Counters: trigger error reporting integration
[lttng-tools.git] / include / lttng / lttng.h
1 /*
2 * lttng.h
3 *
4 * Linux Trace Toolkit Control Library Header File
5 *
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
7 *
8 * SPDX-License-Identifier: LGPL-2.1-only
9 *
10 */
11
12 #ifndef LTTNG_H
13 #define LTTNG_H
14
15 /* Error codes that can be returned by API calls */
16 #include <lttng/lttng-error.h>
17
18 /* Include every LTTng ABI/API available. */
19 #include <lttng/action/action.h>
20 #include <lttng/action/group.h>
21 #include <lttng/action/notify.h>
22 #include <lttng/action/rotate-session.h>
23 #include <lttng/action/snapshot-session.h>
24 #include <lttng/action/start-session.h>
25 #include <lttng/action/stop-session.h>
26 #include <lttng/channel.h>
27 #include <lttng/clear-handle.h>
28 #include <lttng/clear.h>
29 #include <lttng/condition/buffer-usage.h>
30 #include <lttng/condition/condition.h>
31 #include <lttng/condition/evaluation.h>
32 #include <lttng/condition/event-rule.h>
33 #include <lttng/condition/session-consumed-size.h>
34 #include <lttng/condition/session-rotation.h>
35 #include <lttng/destruction-handle.h>
36 #include <lttng/domain.h>
37 #include <lttng/endpoint.h>
38 #include <lttng/event-rule/event-rule.h>
39 #include <lttng/event-rule/kprobe.h>
40 #include <lttng/event-rule/syscall.h>
41 #include <lttng/event-rule/tracepoint.h>
42 #include <lttng/event-rule/uprobe.h>
43 #include <lttng/event.h>
44 #include <lttng/event-expr.h>
45 #include <lttng/event-field-value.h>
46 #include <lttng/handle.h>
47 #include <lttng/health.h>
48 #include <lttng/load.h>
49 #include <lttng/location.h>
50 #include <lttng/notification/channel.h>
51 #include <lttng/notification/notification.h>
52 #include <lttng/rotation.h>
53 #include <lttng/save.h>
54 #include <lttng/session-descriptor.h>
55 #include <lttng/session.h>
56 #include <lttng/snapshot.h>
57 #include <lttng/tracker.h>
58 #include <lttng/trigger/trigger.h>
59 #include <lttng/userspace-probe.h>
60
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64
65 enum lttng_calibrate_type {
66 LTTNG_CALIBRATE_FUNCTION = 0,
67 };
68
69 /* Machine interface output type */
70 enum lttng_mi_output_type {
71 LTTNG_MI_XML = 1 /* XML output */
72 };
73
74 #define LTTNG_CALIBRATE_PADDING1 16
75 struct lttng_calibrate {
76 enum lttng_calibrate_type type;
77
78 char padding[LTTNG_CALIBRATE_PADDING1];
79 };
80
81 /*
82 * Check if a session daemon is alive.
83 *
84 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
85 * error code.
86 */
87 extern int lttng_session_daemon_alive(void);
88
89 /*
90 * Set the tracing group for the *current* flow of execution.
91 *
92 * On success, returns 0 else a negative LTTng error code.
93 */
94 extern int lttng_set_tracing_group(const char *name);
95
96 /*
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).
100 *
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.
105 */
106 extern int lttng_register_consumer(struct lttng_handle *handle,
107 const char *socket_path);
108
109 /*
110 * Start tracing for *all* domain(s) in the session.
111 *
112 * Return 0 on success else a negative LTTng error code.
113 */
114 extern int lttng_start_tracing(const char *session_name);
115
116 /*
117 * Stop tracing for *all* domain(s) in the session.
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
121 * the guarantee that the data is ready to be read and analyze. Use the
122 * _no_wait call below to avoid this behavior.
123 *
124 * The session_name can't be NULL.
125 *
126 * Return 0 on success else a negative LTTng error code.
127 */
128 extern int lttng_stop_tracing(const char *session_name);
129
130 /*
131 * Behave exactly like lttng_stop_tracing but does not wait for data
132 * availability.
133 */
134 extern int lttng_stop_tracing_no_wait(const char *session_name);
135
136 /*
137 * Deprecated: As of LTTng 2.9, this function always returns
138 * -LTTNG_ERR_UND.
139 */
140 extern int lttng_calibrate(struct lttng_handle *handle,
141 struct lttng_calibrate *calibrate);
142
143 /*
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.
148 *
149 * Default port are 5342 and 5343 respectively for control and data which uses
150 * the TCP protocol.
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.
166 */
167 extern int lttng_set_consumer_url(struct lttng_handle *handle,
168 const char *control_url, const char *data_url);
169
170 /*
171 * For a given session name, this call checks if the data is ready to be read
172 * or is still being extracted by the consumer(s) (pending) hence not ready to
173 * be used by any readers.
174 *
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().
179 */
180 extern int lttng_data_pending(const char *session_name);
181
182 /*
183 * Deprecated, replaced by lttng_regenerate_metadata.
184 */
185 LTTNG_DEPRECATED()
186 extern int lttng_metadata_regenerate(const char *session_name);
187
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 */
194 extern int lttng_regenerate_metadata(const char *session_name);
195
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 */
203 extern int lttng_regenerate_statedump(const char *session_name);
204
205 #ifdef __cplusplus
206 }
207 #endif
208
209 #endif /* LTTNG_H */
This page took 0.05001 seconds and 5 git commands to generate.