4 * Linux Trace Toolkit Control Library Header File
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
8 * SPDX-License-Identifier: LGPL-2.1-only
15 /* Error codes that can be returned by API calls */
16 #include <lttng/lttng-error.h>
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/rate-policy.h>
23 #include <lttng/action/rotate-session.h>
24 #include <lttng/action/snapshot-session.h>
25 #include <lttng/action/start-session.h>
26 #include <lttng/action/stop-session.h>
27 #include <lttng/channel.h>
28 #include <lttng/clear-handle.h>
29 #include <lttng/clear.h>
30 #include <lttng/condition/buffer-usage.h>
31 #include <lttng/condition/condition.h>
32 #include <lttng/condition/evaluation.h>
33 #include <lttng/condition/on-event.h>
34 #include <lttng/condition/session-consumed-size.h>
35 #include <lttng/condition/session-rotation.h>
36 #include <lttng/constant.h>
37 #include <lttng/destruction-handle.h>
38 #include <lttng/domain.h>
39 #include <lttng/endpoint.h>
40 #include <lttng/event-expr.h>
41 #include <lttng/event-field-value.h>
42 #include <lttng/event-rule/event-rule.h>
43 #include <lttng/event-rule/kernel-probe.h>
44 #include <lttng/event-rule/syscall.h>
45 #include <lttng/event-rule/tracepoint.h>
46 #include <lttng/event-rule/userspace-probe.h>
47 #include <lttng/event.h>
48 #include <lttng/handle.h>
49 #include <lttng/health.h>
50 #include <lttng/kernel-probe.h>
51 #include <lttng/load.h>
52 #include <lttng/location.h>
53 #include <lttng/log-level-rule.h>
54 #include <lttng/lttng-error.h>
55 #include <lttng/notification/channel.h>
56 #include <lttng/notification/notification.h>
57 #include <lttng/rotation.h>
58 #include <lttng/save.h>
59 #include <lttng/session-descriptor.h>
60 #include <lttng/session.h>
61 #include <lttng/snapshot.h>
62 #include <lttng/tracker.h>
63 #include <lttng/trigger/trigger.h>
64 #include <lttng/userspace-probe.h>
70 enum lttng_calibrate_type
{
71 LTTNG_CALIBRATE_FUNCTION
= 0,
74 /* Machine interface output type */
75 enum lttng_mi_output_type
{
76 LTTNG_MI_XML
= 1 /* XML output */
79 #define LTTNG_CALIBRATE_PADDING1 16
80 struct lttng_calibrate
{
81 enum lttng_calibrate_type type
;
83 char padding
[LTTNG_CALIBRATE_PADDING1
];
87 * Check if a session daemon is alive.
89 * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
92 extern int lttng_session_daemon_alive(void);
95 * Set the tracing group for the *current* flow of execution.
97 * On success, returns 0 else a negative LTTng error code.
99 extern int lttng_set_tracing_group(const char *name
);
102 * This call registers an "outside consumer" for a session and an lttng domain.
103 * No consumer will be spawned and all fds/commands will go through the socket
104 * path given (socket_path).
106 * NOTE that this is not recommended unless you absolutely know what you are
109 * Return 0 on success else a negative LTTng error code.
111 extern int lttng_register_consumer(struct lttng_handle
*handle
,
112 const char *socket_path
);
115 * Start tracing for *all* domain(s) in the session.
117 * Return 0 on success else a negative LTTng error code.
119 extern int lttng_start_tracing(const char *session_name
);
122 * Stop tracing for *all* domain(s) in the session.
124 * This call will wait for data availability for each domain of the session so
125 * this can take an abritrary amount of time. However, when returning you have
126 * the guarantee that the data is ready to be read and analyze. Use the
127 * _no_wait call below to avoid this behavior.
129 * The session_name can't be NULL.
131 * Return 0 on success else a negative LTTng error code.
133 extern int lttng_stop_tracing(const char *session_name
);
136 * Behave exactly like lttng_stop_tracing but does not wait for data
139 extern int lttng_stop_tracing_no_wait(const char *session_name
);
142 * Deprecated: As of LTTng 2.9, this function always returns
145 extern int lttng_calibrate(struct lttng_handle
*handle
,
146 struct lttng_calibrate
*calibrate
);
149 * Set URL for a consumer for a session and domain.
151 * Both data and control URL must be defined. If both URLs are the same, only
152 * the control URL is used even for network streaming.
154 * Default port are 5342 and 5343 respectively for control and data which uses
157 * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
159 * Possible protocols are:
161 * Local filesystem full path.
164 * This will use the default network transport layer which is TCP for both
165 * control (PORT1) and data port (PORT2).
168 * TCP only streaming. For this one, both data and control URL must be given.
170 * Return 0 on success else a negative LTTng error code.
172 extern int lttng_set_consumer_url(struct lttng_handle
*handle
,
173 const char *control_url
, const char *data_url
);
176 * For a given session name, this call checks if the data is ready to be read
177 * or is still being extracted by the consumer(s) (pending) hence not ready to
178 * be used by any readers.
180 * Return 0 if there is _no_ data pending in the buffers thus having a
181 * guarantee that the data can be read safely. Else, return 1 if there is still
182 * traced data is pending. On error, a negative value is returned and readable
183 * by lttng_strerror().
185 extern int lttng_data_pending(const char *session_name
);
188 * Deprecated, replaced by lttng_regenerate_metadata.
191 extern int lttng_metadata_regenerate(const char *session_name
);
194 * Trigger the regeneration of the metadata for a session.
195 * The new metadata overwrite the previous one locally or remotely (through
196 * the lttng-relayd). Only kernel, per-uid and non-live sessions are supported.
197 * Return 0 on success, a negative LTTng error code on error.
199 extern int lttng_regenerate_metadata(const char *session_name
);
202 * Trigger the regeneration of the statedump for a session. The new statedump
203 * information is appended to the currently active trace, the session needs to
206 * Return 0 on success, a negative LTTng error code on error.
208 extern int lttng_regenerate_statedump(const char *session_name
);