Commit | Line | Data |
---|---|---|
826d496d | 1 | /* |
b7384347 DG |
2 | * lttng.h |
3 | * | |
4 | * Linux Trace Toolkit Control Library Header File | |
5 | * | |
826d496d | 6 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> |
fac6795d | 7 | * |
1e46a50f | 8 | * This library is free software; you can redistribute it and/or modify it |
d14d33bf AM |
9 | * under the terms of the GNU Lesser General Public License, version 2.1 only, |
10 | * as published by the Free Software Foundation. | |
82a3637f | 11 | * |
1e46a50f TD |
12 | * This library is distributed in the hope that it will be useful, but WITHOUT |
13 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License | |
15 | * for more details. | |
82a3637f | 16 | * |
1e46a50f TD |
17 | * You should have received a copy of the GNU Lesser General Public License |
18 | * along with this library; if not, write to the Free Software Foundation, | |
19 | * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
fac6795d DG |
20 | */ |
21 | ||
73db5be4 DG |
22 | #ifndef LTTNG_H |
23 | #define LTTNG_H | |
fac6795d | 24 | |
03b1319d DG |
25 | /* Error codes that can be returned by API calls */ |
26 | #include <lttng/lttng-error.h> | |
27 | ||
1239a312 DG |
28 | /* Include every LTTng ABI/API available. */ |
29 | #include <lttng/channel.h> | |
30 | #include <lttng/domain.h> | |
31 | #include <lttng/event.h> | |
32 | #include <lttng/handle.h> | |
33 | #include <lttng/health.h> | |
34 | #include <lttng/save.h> | |
35 | #include <lttng/session.h> | |
36 | #include <lttng/snapshot.h> | |
37 | ||
5168918c DG |
38 | #ifdef __cplusplus |
39 | extern "C" { | |
40 | #endif | |
41 | ||
1239a312 DG |
42 | enum lttng_calibrate_type { |
43 | LTTNG_CALIBRATE_FUNCTION = 0, | |
54c90d10 | 44 | }; |
f3ed775e | 45 | |
8d326ab9 | 46 | #define LTTNG_CALIBRATE_PADDING1 16 |
d0254c7c MD |
47 | struct lttng_calibrate { |
48 | enum lttng_calibrate_type type; | |
8d326ab9 DG |
49 | |
50 | char padding[LTTNG_CALIBRATE_PADDING1]; | |
54c90d10 | 51 | }; |
d0254c7c | 52 | |
7d29a247 DG |
53 | /* |
54 | * Check if a session daemon is alive. | |
1e46a50f | 55 | * |
06662f07 DG |
56 | * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng |
57 | * error code. | |
7d29a247 | 58 | */ |
947308c4 | 59 | extern int lttng_session_daemon_alive(void); |
f3ed775e | 60 | |
7d29a247 | 61 | /* |
1e46a50f TD |
62 | * Set the tracing group for the *current* flow of execution. |
63 | * | |
06662f07 | 64 | * On success, returns 0 else a negative LTTng error code. |
7d29a247 | 65 | */ |
b7384347 | 66 | extern int lttng_set_tracing_group(const char *name); |
f3ed775e | 67 | |
d9800920 | 68 | /* |
1e46a50f TD |
69 | * This call registers an "outside consumer" for a session and an lttng domain. |
70 | * No consumer will be spawned and all fds/commands will go through the socket | |
71 | * path given (socket_path). | |
d9800920 | 72 | * |
06662f07 DG |
73 | * NOTE that this is not recommended unless you absolutely know what you are |
74 | * doing. | |
75 | * | |
76 | * Return 0 on success else a negative LTTng error code. | |
d9800920 DG |
77 | */ |
78 | extern int lttng_register_consumer(struct lttng_handle *handle, | |
79 | const char *socket_path); | |
80 | ||
7d29a247 | 81 | /* |
06662f07 DG |
82 | * Start tracing for *all* domain(s) in the session. |
83 | * | |
84 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 85 | */ |
6a4f824d | 86 | extern int lttng_start_tracing(const char *session_name); |
f3ed775e | 87 | |
7d29a247 | 88 | /* |
06662f07 | 89 | * Stop tracing for *all* domain(s) in the session. |
38ee087f DG |
90 | * |
91 | * This call will wait for data availability for each domain of the session so | |
92 | * this can take an abritrary amount of time. However, when returning you have | |
06662f07 | 93 | * the guarantee that the data is ready to be read and analyze. Use the |
38ee087f | 94 | * _no_wait call below to avoid this behavior. |
41039c06 DG |
95 | * |
96 | * The session_name can't be NULL. | |
06662f07 DG |
97 | * |
98 | * Return 0 on success else a negative LTTng error code. | |
7d29a247 | 99 | */ |
6a4f824d | 100 | extern int lttng_stop_tracing(const char *session_name); |
f3ed775e | 101 | |
38ee087f DG |
102 | /* |
103 | * Behave exactly like lttng_stop_tracing but does not wait for data | |
104 | * availability. | |
105 | */ | |
106 | extern int lttng_stop_tracing_no_wait(const char *session_name); | |
107 | ||
d0254c7c MD |
108 | /* |
109 | * Calibrate LTTng overhead. | |
41039c06 DG |
110 | * |
111 | * The chan and handle params can not be NULL. | |
06662f07 DG |
112 | * |
113 | * Return 0 on success else a negative LTTng error code. | |
d0254c7c | 114 | */ |
cd80958d | 115 | extern int lttng_calibrate(struct lttng_handle *handle, |
d0254c7c MD |
116 | struct lttng_calibrate *calibrate); |
117 | ||
00e2e675 | 118 | /* |
a4b92340 DG |
119 | * Set URL for a consumer for a session and domain. |
120 | * | |
121 | * Both data and control URL must be defined. If both URLs are the same, only | |
122 | * the control URL is used even for network streaming. | |
00e2e675 | 123 | * |
a4b92340 DG |
124 | * Default port are 5342 and 5343 respectively for control and data which uses |
125 | * the TCP protocol. | |
06662f07 DG |
126 | * |
127 | * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] | |
128 | * | |
129 | * Possible protocols are: | |
130 | * > file://... | |
131 | * Local filesystem full path. | |
132 | * | |
133 | * > net[6]://... | |
134 | * This will use the default network transport layer which is TCP for both | |
135 | * control (PORT1) and data port (PORT2). | |
136 | * | |
137 | * > tcp[6]://... | |
138 | * TCP only streaming. For this one, both data and control URL must be given. | |
139 | * | |
140 | * Return 0 on success else a negative LTTng error code. | |
00e2e675 | 141 | */ |
a4b92340 DG |
142 | extern int lttng_set_consumer_url(struct lttng_handle *handle, |
143 | const char *control_url, const char *data_url); | |
00e2e675 | 144 | |
806e2684 DG |
145 | /* |
146 | * For a given session name, this call checks if the data is ready to be read | |
6d805429 DG |
147 | * or is still being extracted by the consumer(s) (pending) hence not ready to |
148 | * be used by any readers. | |
806e2684 | 149 | * |
6d805429 DG |
150 | * Return 0 if there is _no_ data pending in the buffers thus having a |
151 | * guarantee that the data can be read safely. Else, return 1 if there is still | |
152 | * traced data is pending. On error, a negative value is returned and readable | |
153 | * by lttng_strerror(). | |
806e2684 | 154 | */ |
6d805429 | 155 | extern int lttng_data_pending(const char *session_name); |
806e2684 | 156 | |
5168918c DG |
157 | #ifdef __cplusplus |
158 | } | |
159 | #endif | |
160 | ||
73db5be4 | 161 | #endif /* LTTNG_H */ |