Commit | Line | Data |
---|---|---|
773168b7 MD |
1 | #ifndef _LTTNG_SESSIOND_COMM_H |
2 | #define _LTTNG_SESSIOND_COMM_H | |
3 | ||
6e3805e2 DG |
4 | /* |
5 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
6 | * Julien Desfossez <julien.desfossez@polymtl.ca> | |
773168b7 | 7 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
fac6795d DG |
8 | * |
9 | * This program is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU General Public License | |
82a3637f DG |
11 | * as published by the Free Software Foundation; only version 2 |
12 | * of the License. | |
fac6795d DG |
13 | * |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
fac6795d DG |
22 | */ |
23 | ||
773168b7 MD |
24 | /* |
25 | * This header is meant for liblttng and libust internal use ONLY. | |
26 | * These declarations should NOT be considered stable API. | |
27 | */ | |
fac6795d DG |
28 | |
29 | #include <limits.h> | |
f3ed775e | 30 | #include <lttng/lttng.h> |
5e16da05 | 31 | |
f4688807 | 32 | #define LTTNG_RUNDIR "/var/run/lttng" |
1526bda7 | 33 | |
fac6795d | 34 | /* Default unix socket path */ |
32258573 DG |
35 | #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond" |
36 | #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond" | |
37 | #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-lttng-sessiond" | |
38 | #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-lttng-sessiond" | |
fac6795d DG |
39 | |
40 | /* Queue size of listen(2) */ | |
f158a754 | 41 | #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64 |
fac6795d | 42 | |
3817e7df DG |
43 | /* |
44 | * Get the error code index from 0 since LTTCOMM_OK start at 1000 | |
fac6795d | 45 | */ |
686204ab | 46 | #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK) |
fac6795d | 47 | |
6abb15de | 48 | enum lttcomm_sessiond_command { |
0d0c377a | 49 | /* Tracer command */ |
b579acd9 | 50 | LTTNG_ADD_CONTEXT, |
f4688807 | 51 | LTTNG_CALIBRATE, |
0b97ec54 | 52 | LTTNG_DISABLE_CHANNEL, |
f5177a38 DG |
53 | LTTNG_DISABLE_EVENT, |
54 | LTTNG_DISABLE_ALL_EVENT, | |
0d0c377a DG |
55 | LTTNG_ENABLE_CHANNEL, |
56 | LTTNG_ENABLE_EVENT, | |
57 | LTTNG_ENABLE_ALL_EVENT, | |
58 | /* Session daemon command */ | |
fac6795d DG |
59 | LTTNG_CREATE_SESSION, |
60 | LTTNG_DESTROY_SESSION, | |
9f19cc17 DG |
61 | LTTNG_LIST_CHANNELS, |
62 | LTTNG_LIST_DOMAINS, | |
f3ed775e | 63 | LTTNG_LIST_EVENTS, |
9f19cc17 | 64 | LTTNG_LIST_SESSIONS, |
052da939 | 65 | LTTNG_LIST_TRACEPOINTS, |
d9800920 | 66 | LTTNG_REGISTER_CONSUMER, |
f3ed775e DG |
67 | LTTNG_START_TRACE, |
68 | LTTNG_STOP_TRACE, | |
fac6795d DG |
69 | }; |
70 | ||
71 | /* | |
72 | * lttcomm error code. | |
73 | */ | |
74 | enum lttcomm_return_code { | |
20fe2104 DG |
75 | LTTCOMM_OK = 1000, /* Ok */ |
76 | LTTCOMM_ERR, /* Unknown Error */ | |
77 | LTTCOMM_UND, /* Undefine command */ | |
7d29a247 DG |
78 | LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */ |
79 | LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */ | |
20fe2104 DG |
80 | LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */ |
81 | LTTCOMM_NO_SESSION, /* No session found */ | |
82 | LTTCOMM_CREATE_FAIL, /* Create trace fail */ | |
83 | LTTCOMM_SESSION_FAIL, /* Create session fail */ | |
84 | LTTCOMM_START_FAIL, /* Start tracing fail */ | |
85 | LTTCOMM_STOP_FAIL, /* Stop tracing fail */ | |
86 | LTTCOMM_LIST_FAIL, /* Listing apps fail */ | |
87 | LTTCOMM_NO_APPS, /* No traceable application */ | |
f3ed775e | 88 | LTTCOMM_SESS_NOT_FOUND, /* Session name not found */ |
20fe2104 DG |
89 | LTTCOMM_NO_TRACE, /* No trace exist */ |
90 | LTTCOMM_FATAL, /* Session daemon had a fatal error */ | |
91 | LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */ | |
92 | LTTCOMM_SELECT_SESS, /* Must select a session */ | |
93 | LTTCOMM_EXIST_SESS, /* Session name already exist */ | |
94 | LTTCOMM_NO_EVENT, /* No event found */ | |
d9800920 | 95 | LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */ |
2b0bf864 | 96 | LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */ |
20fe2104 | 97 | LTTCOMM_KERN_NA, /* Kernel tracer unavalable */ |
7d29a247 | 98 | LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */ |
20fe2104 DG |
99 | LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */ |
100 | LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */ | |
f3ed775e | 101 | LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */ |
26cc6b4e | 102 | LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */ |
d36b8583 | 103 | LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */ |
d65106b1 | 104 | LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */ |
f34daff7 DG |
105 | LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */ |
106 | LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */ | |
aaf26714 | 107 | LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */ |
8c0faa1d DG |
108 | LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */ |
109 | LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */ | |
110 | LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */ | |
111 | LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */ | |
112 | LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */ | |
84291629 DG |
113 | LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */ |
114 | LTTCOMM_KERN_NO_SESSION, /* No kernel session found */ | |
2ef84c95 | 115 | LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */ |
0177d773 | 116 | LTTCOMM_UST_SESS_FAIL, /* UST create session failed */ |
f6a9efaa | 117 | LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */ |
2bdd86d4 | 118 | LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */ |
2b0bf864 | 119 | LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */ |
2bdd86d4 MD |
120 | LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */ |
121 | LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */ | |
122 | LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */ | |
123 | LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */ | |
124 | LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */ | |
125 | LTTCOMM_UST_META_FAIL, /* UST open metadata failed */ | |
126 | LTTCOMM_UST_START_FAIL, /* UST start trace failed */ | |
127 | LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */ | |
7753dea8 MD |
128 | LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */ |
129 | LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */ | |
2bdd86d4 MD |
130 | LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */ |
131 | LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */ | |
132 | LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */ | |
133 | LTTCOMM_UST_NO_SESSION, /* No UST session found */ | |
134 | LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */ | |
3b25d04d | 135 | LTTCOMM_UST_EVENT_EXIST, /* UST event exist */ |
be4f0921 | 136 | LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */ |
2bdd86d4 | 137 | |
3bd1e081 MD |
138 | CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */ |
139 | CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */ | |
140 | CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */ | |
f2fc6720 | 141 | CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */ |
3bd1e081 MD |
142 | CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */ |
143 | CONSUMERD_POLL_NVAL, /* Poll on closed fd */ | |
144 | CONSUMERD_POLL_HUP, /* All fds have hungup */ | |
145 | CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */ | |
146 | CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */ | |
147 | CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */ | |
148 | CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */ | |
149 | CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */ | |
150 | CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */ | |
151 | CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */ | |
20fe2104 DG |
152 | /* MUST be last element */ |
153 | LTTCOMM_NR, /* Last element */ | |
fac6795d DG |
154 | }; |
155 | ||
156 | /* | |
9bda164d | 157 | * Data structure received from lttng client to session daemon. |
fac6795d DG |
158 | */ |
159 | struct lttcomm_session_msg { | |
773168b7 | 160 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
42abccdb | 161 | struct lttng_session session; |
9f19cc17 | 162 | struct lttng_domain domain; |
fac6795d DG |
163 | union { |
164 | struct { | |
f3ed775e DG |
165 | char channel_name[NAME_MAX]; |
166 | char name[NAME_MAX]; | |
167 | } disable; | |
168 | /* Event data */ | |
fac6795d | 169 | struct { |
f3ed775e DG |
170 | char channel_name[NAME_MAX]; |
171 | struct lttng_event event; | |
172 | } enable; | |
173 | /* Create channel */ | |
174 | struct { | |
175 | struct lttng_channel chan; | |
176 | } channel; | |
d65106b1 DG |
177 | /* Context */ |
178 | struct { | |
179 | char channel_name[NAME_MAX]; | |
180 | char event_name[NAME_MAX]; | |
7d29a247 | 181 | struct lttng_event_context ctx; |
d65106b1 | 182 | } context; |
d9800920 DG |
183 | /* Use by register_consumer */ |
184 | struct { | |
185 | char path[PATH_MAX]; | |
186 | } reg; | |
9f19cc17 DG |
187 | /* List */ |
188 | struct { | |
189 | char channel_name[NAME_MAX]; | |
190 | } list; | |
d0254c7c | 191 | struct lttng_calibrate calibrate; |
fac6795d DG |
192 | } u; |
193 | }; | |
194 | ||
195 | /* | |
5e16da05 | 196 | * Data structure for the response from sessiond to the lttng client. |
fac6795d | 197 | */ |
5461b305 | 198 | struct lttcomm_lttng_msg { |
773168b7 MD |
199 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
200 | uint32_t ret_code; /* enum lttcomm_return_code */ | |
201 | uint32_t pid; /* pid_t */ | |
202 | uint32_t data_size; | |
5461b305 DG |
203 | /* Contains: trace_name + data */ |
204 | char payload[]; | |
fac6795d DG |
205 | }; |
206 | ||
6e3805e2 | 207 | /* |
3bd1e081 MD |
208 | * lttcomm_consumer_msg is the message sent from sessiond to consumerd |
209 | * to either add a channel, add a stream, update a stream, or stop | |
210 | * operation. | |
6e3805e2 | 211 | */ |
3bd1e081 MD |
212 | struct lttcomm_consumer_msg { |
213 | uint32_t cmd_type; /* enum consumerd_command */ | |
214 | union { | |
215 | struct { | |
216 | int channel_key; | |
217 | uint64_t max_sb_size; /* the subbuffer size for this channel */ | |
218 | /* shm_fd and wait_fd are sent as ancillary data */ | |
219 | uint64_t mmap_len; | |
220 | } channel; | |
221 | struct { | |
222 | int channel_key; | |
223 | int stream_key; | |
224 | /* shm_fd and wait_fd are sent as ancillary data */ | |
225 | uint32_t state; /* enum lttcomm_consumer_fd_state */ | |
226 | enum lttng_event_output output; /* use splice or mmap to consume this fd */ | |
227 | uint64_t mmap_len; | |
228 | char path_name[PATH_MAX]; | |
229 | } stream; | |
230 | } u; | |
6e3805e2 DG |
231 | }; |
232 | ||
74d0b642 | 233 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 234 | |
9df8df5e | 235 | #include <lttng/ust-abi.h> |
6e3805e2 | 236 | |
3817e7df DG |
237 | /* |
238 | * Data structure for the commands sent from sessiond to UST. | |
239 | */ | |
240 | struct lttcomm_ust_msg { | |
3817e7df DG |
241 | uint32_t handle; |
242 | uint32_t cmd; | |
243 | union { | |
3817e7df | 244 | struct lttng_ust_channel channel; |
00a17c97 | 245 | struct lttng_ust_stream stream; |
3817e7df DG |
246 | struct lttng_ust_event event; |
247 | struct lttng_ust_context context; | |
00a17c97 | 248 | struct lttng_ust_tracer_version version; |
3817e7df DG |
249 | } u; |
250 | }; | |
251 | ||
252 | /* | |
253 | * Data structure for the response from UST to the session daemon. | |
254 | * cmd_type is sent back in the reply for validation. | |
255 | */ | |
256 | struct lttcomm_ust_reply { | |
257 | uint32_t handle; | |
258 | uint32_t cmd; | |
259 | uint32_t ret_code; /* enum lttcomm_return_code */ | |
260 | uint32_t ret_val; /* return value */ | |
261 | union { | |
2b0bf864 DG |
262 | struct { |
263 | uint64_t memory_map_size; | |
264 | } channel; | |
265 | struct { | |
266 | uint64_t memory_map_size; | |
267 | } stream; | |
00a17c97 | 268 | struct lttng_ust_tracer_version version; |
3817e7df DG |
269 | } u; |
270 | }; | |
271 | ||
74d0b642 | 272 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 273 | |
fac6795d DG |
274 | extern int lttcomm_create_unix_sock(const char *pathname); |
275 | extern int lttcomm_connect_unix_sock(const char *pathname); | |
276 | extern int lttcomm_accept_unix_sock(int sock); | |
277 | extern int lttcomm_listen_unix_sock(int sock); | |
87378cf5 | 278 | extern int lttcomm_close_unix_sock(int sock); |
3bd1e081 MD |
279 | |
280 | #define LTTCOMM_MAX_SEND_FDS 4 | |
281 | /* Send a message accompanied by fd(s) over a unix socket. */ | |
282 | extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd); | |
283 | /* Recv a message accompanied by fd(s) from a unix socket */ | |
284 | extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd); | |
285 | ||
fac6795d DG |
286 | extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len); |
287 | extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len); | |
288 | extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code); | |
289 | ||
773168b7 | 290 | #endif /* _LTTNG_SESSIOND_COMM_H */ |