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