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