Commit | Line | Data |
---|---|---|
826d496d | 1 | /* |
917216f6 DG |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> |
3 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
fac6795d | 4 | * |
d14d33bf AM |
5 | * This program is free software; you can redistribute it and/or modify |
6 | * it under the terms of the GNU General Public License, version 2 only, | |
7 | * as published by the Free Software Foundation. | |
fac6795d | 8 | * |
917216f6 DG |
9 | * This program is distributed in the hope that it will be useful, but WITHOUT |
10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
12 | * more details. | |
fac6795d | 13 | * |
d14d33bf AM |
14 | * You should have received a copy of the GNU General Public License along |
15 | * with this program; if not, write to the Free Software Foundation, Inc., | |
16 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
fac6795d DG |
17 | */ |
18 | ||
19 | #define _GNU_SOURCE | |
1e307fab | 20 | #include <assert.h> |
fac6795d DG |
21 | #include <limits.h> |
22 | #include <stdio.h> | |
23 | #include <stdlib.h> | |
24 | #include <string.h> | |
fac6795d DG |
25 | #include <sys/stat.h> |
26 | #include <sys/types.h> | |
fac6795d | 27 | #include <unistd.h> |
3bd1e081 | 28 | #include <errno.h> |
fac6795d | 29 | |
990570ed | 30 | #include <common/defaults.h> |
4c462e79 | 31 | #include <common/error.h> |
990570ed | 32 | |
10a8a223 | 33 | #include "sessiond-comm.h" |
fac6795d DG |
34 | |
35 | /* | |
36 | * Human readable error message. | |
37 | */ | |
38 | static const char *lttcomm_readable_code[] = { | |
39 | [ LTTCOMM_ERR_INDEX(LTTCOMM_OK) ] = "Success", | |
40 | [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR) ] = "Unknown error", | |
41 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UND) ] = "Undefined command", | |
7d29a247 DG |
42 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NOT_IMPLEMENTED) ] = "Not implemented", |
43 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UNKNOWN_DOMAIN) ] = "Unknown tracing domain", | |
fac6795d DG |
44 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION) ] = "No session found", |
45 | [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL) ] = "Unable to list traceable apps", | |
e065084a | 46 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS) ] = "No traceable apps found", |
f3ed775e | 47 | [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND) ] = "Session name not found", |
ce3d728c | 48 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE) ] = "No trace found", |
ca95a216 | 49 | [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL) ] = "Fatal error of the session daemon", |
ae856491 | 50 | [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_DIR_FAIL) ] = "Create directory failed", |
379473d2 | 51 | [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL) ] = "Start trace failed", |
520ff687 | 52 | [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL) ] = "Stop trace failed", |
379473d2 DG |
53 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE) ] = "App is not traceable", |
54 | [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS) ] = "A session MUST be selected", | |
27673bb6 | 55 | [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS) ] = "Session name already exist", |
d9800920 | 56 | [ LTTCOMM_ERR_INDEX(LTTCOMM_CONNECT_FAIL) ] = "Unable to connect to Unix socket", |
2b0bf864 | 57 | [ LTTCOMM_ERR_INDEX(LTTCOMM_APP_NOT_FOUND) ] = "Application not found", |
8e0af1b4 | 58 | [ LTTCOMM_ERR_INDEX(LTTCOMM_EPERM) ] = "Permission denied", |
20fe2104 | 59 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA) ] = "Kernel tracer not available", |
394016d1 | 60 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_VERSION) ] = "Kernel tracer version is not compatible", |
7d29a247 | 61 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST) ] = "Kernel event already exists", |
20fe2104 | 62 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL) ] = "Kernel create session failed", |
42224349 | 63 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_EXIST) ] = "Kernel channel already exists", |
20fe2104 | 64 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL) ] = "Kernel create channel failed", |
f3ed775e | 65 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND) ] = "Kernel channel not found", |
26cc6b4e | 66 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL) ] = "Disable kernel channel failed", |
d36b8583 | 67 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL) ] = "Enable kernel channel failed", |
d65106b1 | 68 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL) ] = "Add kernel context failed", |
f34daff7 DG |
69 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL) ] = "Enable kernel event failed", |
70 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL) ] = "Disable kernel event failed", | |
aaf26714 | 71 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL) ] = "Opening metadata failed", |
8c0faa1d DG |
72 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL) ] = "Starting kernel trace failed", |
73 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL) ] = "Stoping kernel trace failed", | |
74 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed", | |
75 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL) ] = "Kernel create stream failed", | |
76 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL) ] = "Kernel trace directory creation failed", | |
77 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST) ] = "Kernel trace directory already exist", | |
84291629 | 78 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION) ] = "No kernel session found", |
2ef84c95 | 79 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL) ] = "Listing kernel events failed", |
4466912f | 80 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CALIBRATE_FAIL) ] = "UST calibration failed", |
e0c7ec2b | 81 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_VERSION) ] = "UST tracer version is not compatible", |
0177d773 | 82 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_SESS_FAIL) ] = "UST create session failed", |
2b0bf864 | 83 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_FAIL) ] = "UST create channel failed", |
f6a9efaa | 84 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_EXIST) ] = "UST channel already exist", |
2bdd86d4 MD |
85 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_NOT_FOUND) ] = "UST channel not found", |
86 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_DISABLE_FAIL) ] = "Disable UST channel failed", | |
87 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_ENABLE_FAIL) ] = "Enable UST channel failed", | |
88 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_FAIL) ] = "Add UST context failed", | |
89 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_ENABLE_FAIL) ] = "Enable UST event failed", | |
90 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DISABLE_FAIL) ] = "Disable UST event failed", | |
91 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_META_FAIL) ] = "Opening metadata failed", | |
92 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_START_FAIL) ] = "Starting UST trace failed", | |
93 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STOP_FAIL) ] = "Stoping UST trace failed", | |
7753dea8 MD |
94 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER64_FAIL) ] = "64-bit UST consumer start failed", |
95 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER32_FAIL) ] = "32-bit UST consumer start failed", | |
2bdd86d4 MD |
96 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STREAM_FAIL) ] = "UST create stream failed", |
97 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_FAIL) ] = "UST trace directory creation failed", | |
98 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_EXIST) ] = "UST trace directory already exist", | |
99 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_NO_SESSION) ] = "No UST session found", | |
100 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_LIST_FAIL) ] = "Listing UST events failed", | |
3b25d04d | 101 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_EXIST) ] = "UST event already exist", |
be4f0921 | 102 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_NOT_FOUND)] = "UST event not found", |
ae357384 | 103 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_EXIST)] = "UST context already exist", |
ae856491 | 104 | [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_INVAL)] = "UST invalid context", |
30905cf4 | 105 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NEED_ROOT_SESSIOND) ] = "Tracing the kernel requires a root lttng-sessiond daemon and \"tracing\" group user membership", |
80e327fa DG |
106 | [ LTTCOMM_ERR_INDEX(LTTCOMM_TRACE_ALREADY_STARTED) ] = "Tracing already started", |
107 | [ LTTCOMM_ERR_INDEX(LTTCOMM_TRACE_ALREADY_STOPPED) ] = "Tracing already stopped", | |
15d5a1ad | 108 | [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_ENOSYS) ] = "Kernel event type not supported", |
80e327fa | 109 | |
3bd1e081 MD |
110 | [ LTTCOMM_ERR_INDEX(CONSUMERD_COMMAND_SOCK_READY) ] = "consumerd command socket ready", |
111 | [ LTTCOMM_ERR_INDEX(CONSUMERD_SUCCESS_RECV_FD) ] = "consumerd success on receiving fds", | |
112 | [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_FD) ] = "consumerd error on receiving fds", | |
f2fc6720 | 113 | [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_CMD) ] = "consumerd error on receiving command", |
3bd1e081 MD |
114 | [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_ERROR) ] = "consumerd error in polling thread", |
115 | [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_NVAL) ] = "consumerd polling on closed fd", | |
116 | [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_HUP) ] = "consumerd all fd hung up", | |
117 | [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_SUCCESS) ] = "consumerd exiting normally", | |
118 | [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_FAILURE) ] = "consumerd exiting on error", | |
119 | [ LTTCOMM_ERR_INDEX(CONSUMERD_OUTFD_ERROR) ] = "consumerd error opening the tracefile", | |
120 | [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EBADF) ] = "consumerd splice EBADF", | |
121 | [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EINVAL) ] = "consumerd splice EINVAL", | |
122 | [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ENOMEM) ] = "consumerd splice ENOMEM", | |
123 | [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ESPIPE) ] = "consumerd splice ESPIPE", | |
d65106b1 | 124 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "Event not found", |
b024d072 | 125 | [ LTTCOMM_ERR_INDEX(LTTCOMM_INVALID) ] = "Invalid parameter", |
f22d70f0 DG |
126 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_USTCONSUMERD) ] = "No UST consumer detected", |
127 | [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_KERNCONSUMERD) ] = "No kernel consumer detected", | |
c0657016 | 128 | [ LTTCOMM_ERR_INDEX(LTTCOMM_EVENT_EXIST_LOGLEVEL) ] = "Event already enabled with different loglevel", |
fac6795d DG |
129 | }; |
130 | ||
131 | /* | |
917216f6 DG |
132 | * Return ptr to string representing a human readable error code from the |
133 | * lttcomm_return_code enum. | |
fac6795d | 134 | * |
917216f6 | 135 | * These code MUST be negative in other to treat that as an error value. |
fac6795d DG |
136 | */ |
137 | const char *lttcomm_get_readable_code(enum lttcomm_return_code code) | |
138 | { | |
139 | int tmp_code = -code; | |
140 | ||
141 | if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) { | |
142 | return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)]; | |
143 | } | |
144 | ||
145 | return "Unknown error code"; | |
146 | } | |
147 | ||
148 | /* | |
917216f6 | 149 | * Connect to unix socket using the path name. |
fac6795d DG |
150 | */ |
151 | int lttcomm_connect_unix_sock(const char *pathname) | |
152 | { | |
686204ab | 153 | struct sockaddr_un sun; |
4c462e79 | 154 | int fd, ret, closeret; |
fac6795d | 155 | |
686204ab | 156 | fd = socket(PF_UNIX, SOCK_STREAM, 0); |
fac6795d | 157 | if (fd < 0) { |
4c462e79 | 158 | PERROR("socket"); |
a8afeb4a | 159 | ret = fd; |
fac6795d DG |
160 | goto error; |
161 | } | |
162 | ||
686204ab MD |
163 | memset(&sun, 0, sizeof(sun)); |
164 | sun.sun_family = AF_UNIX; | |
165 | strncpy(sun.sun_path, pathname, sizeof(sun.sun_path)); | |
99497cd0 | 166 | sun.sun_path[sizeof(sun.sun_path) - 1] = '\0'; |
fac6795d | 167 | |
686204ab MD |
168 | ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun)); |
169 | if (ret < 0) { | |
a8afeb4a | 170 | /* |
917216f6 DG |
171 | * Don't print message on connect error, because connect is used in |
172 | * normal execution to detect if sessiond is alive. | |
a8afeb4a MD |
173 | */ |
174 | goto error_connect; | |
686204ab | 175 | } |
fac6795d | 176 | |
686204ab | 177 | return fd; |
fac6795d | 178 | |
a8afeb4a | 179 | error_connect: |
4c462e79 MD |
180 | closeret = close(fd); |
181 | if (closeret) { | |
182 | PERROR("close"); | |
183 | } | |
fac6795d | 184 | error: |
a8afeb4a | 185 | return ret; |
fac6795d DG |
186 | } |
187 | ||
188 | /* | |
917216f6 DG |
189 | * Do an accept(2) on the sock and return the new file descriptor. The socket |
190 | * MUST be bind(2) before. | |
fac6795d DG |
191 | */ |
192 | int lttcomm_accept_unix_sock(int sock) | |
193 | { | |
194 | int new_fd; | |
195 | struct sockaddr_un sun; | |
196 | socklen_t len = 0; | |
197 | ||
198 | /* Blocking call */ | |
199 | new_fd = accept(sock, (struct sockaddr *) &sun, &len); | |
200 | if (new_fd < 0) { | |
4c462e79 | 201 | PERROR("accept"); |
fac6795d DG |
202 | } |
203 | ||
204 | return new_fd; | |
fac6795d DG |
205 | } |
206 | ||
207 | /* | |
917216f6 DG |
208 | * Creates a AF_UNIX local socket using pathname bind the socket upon creation |
209 | * and return the fd. | |
fac6795d DG |
210 | */ |
211 | int lttcomm_create_unix_sock(const char *pathname) | |
212 | { | |
213 | struct sockaddr_un sun; | |
214 | int fd; | |
215 | int ret = -1; | |
216 | ||
217 | /* Create server socket */ | |
218 | if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) { | |
4c462e79 | 219 | PERROR("socket"); |
fac6795d DG |
220 | goto error; |
221 | } | |
222 | ||
223 | memset(&sun, 0, sizeof(sun)); | |
224 | sun.sun_family = AF_UNIX; | |
99497cd0 MD |
225 | strncpy(sun.sun_path, pathname, sizeof(sun.sun_path)); |
226 | sun.sun_path[sizeof(sun.sun_path) - 1] = '\0'; | |
fac6795d | 227 | |
7d8234d9 MD |
228 | /* Unlink the old file if present */ |
229 | (void) unlink(pathname); | |
fac6795d DG |
230 | ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun)); |
231 | if (ret < 0) { | |
4c462e79 | 232 | PERROR("bind"); |
fac6795d DG |
233 | goto error; |
234 | } | |
235 | ||
236 | return fd; | |
237 | ||
238 | error: | |
239 | return ret; | |
240 | } | |
241 | ||
242 | /* | |
f158a754 | 243 | * Make the socket listen using LTTNG_SESSIOND_COMM_MAX_LISTEN. |
fac6795d DG |
244 | */ |
245 | int lttcomm_listen_unix_sock(int sock) | |
246 | { | |
247 | int ret; | |
248 | ||
f158a754 | 249 | ret = listen(sock, LTTNG_SESSIOND_COMM_MAX_LISTEN); |
fac6795d | 250 | if (ret < 0) { |
4c462e79 | 251 | PERROR("listen"); |
fac6795d DG |
252 | } |
253 | ||
254 | return ret; | |
255 | } | |
256 | ||
257 | /* | |
917216f6 DG |
258 | * Receive data of size len in put that data into the buf param. Using recvmsg |
259 | * API. | |
fac6795d | 260 | * |
917216f6 | 261 | * Return the size of received data. |
fac6795d DG |
262 | */ |
263 | ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len) | |
264 | { | |
156ea65a | 265 | struct msghdr msg; |
fac6795d DG |
266 | struct iovec iov[1]; |
267 | ssize_t ret = -1; | |
268 | ||
156ea65a MD |
269 | memset(&msg, 0, sizeof(msg)); |
270 | ||
fac6795d DG |
271 | iov[0].iov_base = buf; |
272 | iov[0].iov_len = len; | |
273 | msg.msg_iov = iov; | |
274 | msg.msg_iovlen = 1; | |
275 | ||
91fe73e2 MD |
276 | do { |
277 | ret = recvmsg(sock, &msg, MSG_WAITALL); | |
278 | } while (ret < 0 && errno == EINTR); | |
fac6795d | 279 | if (ret < 0) { |
4c462e79 | 280 | PERROR("recvmsg"); |
fac6795d DG |
281 | } |
282 | ||
283 | return ret; | |
284 | } | |
285 | ||
286 | /* | |
917216f6 | 287 | * Send buf data of size len. Using sendmsg API. |
fac6795d | 288 | * |
917216f6 | 289 | * Return the size of sent data. |
fac6795d DG |
290 | */ |
291 | ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len) | |
292 | { | |
156ea65a | 293 | struct msghdr msg; |
fac6795d DG |
294 | struct iovec iov[1]; |
295 | ssize_t ret = -1; | |
296 | ||
156ea65a MD |
297 | memset(&msg, 0, sizeof(msg)); |
298 | ||
fac6795d DG |
299 | iov[0].iov_base = buf; |
300 | iov[0].iov_len = len; | |
301 | msg.msg_iov = iov; | |
302 | msg.msg_iovlen = 1; | |
303 | ||
304 | ret = sendmsg(sock, &msg, 0); | |
305 | if (ret < 0) { | |
d2641a83 MD |
306 | /* |
307 | * Only warn about EPIPE when quiet mode is deactivated. | |
308 | * We consider EPIPE as expected. | |
309 | */ | |
97e19046 | 310 | if (errno != EPIPE || !lttng_opt_quiet) { |
d2641a83 MD |
311 | PERROR("sendmsg"); |
312 | } | |
fac6795d DG |
313 | } |
314 | ||
315 | return ret; | |
316 | } | |
87378cf5 DG |
317 | |
318 | /* | |
917216f6 | 319 | * Shutdown cleanly a unix socket. |
87378cf5 DG |
320 | */ |
321 | int lttcomm_close_unix_sock(int sock) | |
322 | { | |
4c462e79 | 323 | int ret, closeret; |
87378cf5 DG |
324 | |
325 | /* Shutdown receptions and transmissions */ | |
326 | ret = shutdown(sock, SHUT_RDWR); | |
327 | if (ret < 0) { | |
4c462e79 | 328 | PERROR("shutdown"); |
87378cf5 DG |
329 | } |
330 | ||
4c462e79 MD |
331 | closeret = close(sock); |
332 | if (closeret) { | |
333 | PERROR("close"); | |
334 | } | |
b0ef677e | 335 | |
87378cf5 DG |
336 | return ret; |
337 | } | |
8c0faa1d DG |
338 | |
339 | /* | |
3bd1e081 MD |
340 | * Send a message accompanied by fd(s) over a unix socket. |
341 | * | |
342 | * Returns the size of data sent, or negative error value. | |
8c0faa1d | 343 | */ |
3bd1e081 | 344 | ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd) |
8c0faa1d | 345 | { |
156ea65a | 346 | struct msghdr msg; |
8c0faa1d DG |
347 | struct cmsghdr *cmptr; |
348 | struct iovec iov[1]; | |
349 | ssize_t ret = -1; | |
350 | unsigned int sizeof_fds = nb_fd * sizeof(int); | |
351 | char tmp[CMSG_SPACE(sizeof_fds)]; | |
3bd1e081 | 352 | char dummy = 0; |
8c0faa1d | 353 | |
156ea65a MD |
354 | memset(&msg, 0, sizeof(msg)); |
355 | ||
3bd1e081 MD |
356 | if (nb_fd > LTTCOMM_MAX_SEND_FDS) |
357 | return -EINVAL; | |
8c0faa1d DG |
358 | |
359 | msg.msg_control = (caddr_t)tmp; | |
360 | msg.msg_controllen = CMSG_LEN(sizeof_fds); | |
361 | ||
362 | cmptr = CMSG_FIRSTHDR(&msg); | |
8c0faa1d DG |
363 | cmptr->cmsg_level = SOL_SOCKET; |
364 | cmptr->cmsg_type = SCM_RIGHTS; | |
159c7ff4 | 365 | cmptr->cmsg_len = CMSG_LEN(sizeof_fds); |
8c0faa1d | 366 | memcpy(CMSG_DATA(cmptr), fds, sizeof_fds); |
159c7ff4 MD |
367 | /* Sum of the length of all control messages in the buffer: */ |
368 | msg.msg_controllen = cmptr->cmsg_len; | |
8c0faa1d | 369 | |
3bd1e081 MD |
370 | iov[0].iov_base = &dummy; |
371 | iov[0].iov_len = 1; | |
8c0faa1d DG |
372 | msg.msg_iov = iov; |
373 | msg.msg_iovlen = 1; | |
374 | ||
66724ea3 DG |
375 | do { |
376 | ret = sendmsg(sock, &msg, 0); | |
377 | } while (ret < 0 && errno == EINTR); | |
8c0faa1d | 378 | if (ret < 0) { |
d2641a83 MD |
379 | /* |
380 | * Only warn about EPIPE when quiet mode is deactivated. | |
381 | * We consider EPIPE as expected. | |
382 | */ | |
97e19046 | 383 | if (errno != EPIPE || !lttng_opt_quiet) { |
d2641a83 MD |
384 | PERROR("sendmsg"); |
385 | } | |
8c0faa1d | 386 | } |
8c0faa1d DG |
387 | return ret; |
388 | } | |
09de5c68 DG |
389 | |
390 | /* | |
3bd1e081 | 391 | * Recv a message accompanied by fd(s) from a unix socket. |
09de5c68 | 392 | * |
3bd1e081 MD |
393 | * Returns the size of received data, or negative error value. |
394 | * | |
395 | * Expect at most "nb_fd" file descriptors. Returns the number of fd | |
396 | * actually received in nb_fd. | |
09de5c68 | 397 | */ |
3bd1e081 | 398 | ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd) |
09de5c68 DG |
399 | { |
400 | struct iovec iov[1]; | |
3bd1e081 | 401 | ssize_t ret = 0; |
09de5c68 | 402 | struct cmsghdr *cmsg; |
3bd1e081 MD |
403 | size_t sizeof_fds = nb_fd * sizeof(int); |
404 | char recv_fd[CMSG_SPACE(sizeof_fds)]; | |
156ea65a | 405 | struct msghdr msg; |
3bd1e081 | 406 | char dummy; |
09de5c68 | 407 | |
156ea65a MD |
408 | memset(&msg, 0, sizeof(msg)); |
409 | ||
09de5c68 | 410 | /* Prepare to receive the structures */ |
3bd1e081 MD |
411 | iov[0].iov_base = &dummy; |
412 | iov[0].iov_len = 1; | |
09de5c68 DG |
413 | msg.msg_iov = iov; |
414 | msg.msg_iovlen = 1; | |
415 | msg.msg_control = recv_fd; | |
416 | msg.msg_controllen = sizeof(recv_fd); | |
417 | ||
91fe73e2 MD |
418 | do { |
419 | ret = recvmsg(sock, &msg, 0); | |
420 | } while (ret < 0 && errno == EINTR); | |
09de5c68 | 421 | if (ret < 0) { |
4c462e79 | 422 | PERROR("recvmsg fds"); |
09de5c68 DG |
423 | goto end; |
424 | } | |
3bd1e081 MD |
425 | if (ret != 1) { |
426 | fprintf(stderr, "Error: Received %zd bytes, expected %d\n", | |
427 | ret, 1); | |
428 | goto end; | |
429 | } | |
430 | if (msg.msg_flags & MSG_CTRUNC) { | |
431 | fprintf(stderr, "Error: Control message truncated.\n"); | |
432 | ret = -1; | |
09de5c68 DG |
433 | goto end; |
434 | } | |
09de5c68 DG |
435 | cmsg = CMSG_FIRSTHDR(&msg); |
436 | if (!cmsg) { | |
3bd1e081 | 437 | fprintf(stderr, "Error: Invalid control message header\n"); |
09de5c68 DG |
438 | ret = -1; |
439 | goto end; | |
440 | } | |
09de5c68 | 441 | if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) { |
3bd1e081 | 442 | fprintf(stderr, "Didn't received any fd\n"); |
09de5c68 DG |
443 | ret = -1; |
444 | goto end; | |
445 | } | |
3bd1e081 MD |
446 | if (cmsg->cmsg_len != CMSG_LEN(sizeof_fds)) { |
447 | fprintf(stderr, "Error: Received %zu bytes of ancillary data, expected %zu\n", | |
b17231c6 | 448 | (size_t) cmsg->cmsg_len, (size_t) CMSG_LEN(sizeof_fds)); |
3bd1e081 MD |
449 | ret = -1; |
450 | goto end; | |
09de5c68 | 451 | } |
3bd1e081 MD |
452 | memcpy(fds, CMSG_DATA(cmsg), sizeof_fds); |
453 | ret = sizeof_fds; | |
09de5c68 DG |
454 | end: |
455 | return ret; | |
456 | } | |
d19d9ada | 457 | |
6684bfa4 CB |
458 | ssize_t lttcomm_send_string(int sock, char *str, size_t len) |
459 | { | |
460 | ssize_t slen, ret = -1; | |
461 | ||
462 | if (!str) { | |
463 | goto end; | |
464 | } | |
465 | ||
466 | /* Send string len first */ | |
467 | slen = lttcomm_send_unix_sock(sock, &len, sizeof(len)); | |
468 | ||
469 | if (slen != sizeof(len)) { | |
470 | fprintf(stderr, | |
471 | "Unexpected sent size. Expected %zu got %zu\n", | |
472 | sizeof(len), slen); | |
473 | ret = -1; | |
474 | goto end; | |
475 | } | |
476 | ||
477 | /* Send the actual string */ | |
478 | slen = lttcomm_send_unix_sock(sock, str, len); | |
479 | if (slen != len) { | |
480 | fprintf(stderr, | |
481 | "Unexpected sent size. Expected %zu got %zu\n", | |
482 | len, slen); | |
483 | ret = -1; | |
484 | goto end; | |
485 | } | |
486 | ||
487 | ret = slen; | |
488 | ||
489 | end: | |
490 | return ret; | |
491 | } | |
492 | ||
493 | /* | |
494 | * Allocate and return the received string. | |
495 | * Return NULL on error. | |
496 | * Caller is responsible of freeing the allocated string. | |
497 | */ | |
498 | char *lttcomm_recv_string(int sock) | |
499 | { | |
500 | ssize_t rlen; | |
501 | size_t len; | |
502 | char *ret; | |
503 | ||
504 | /* Get the string len first */ | |
505 | rlen = lttcomm_recv_unix_sock(sock, &len, sizeof(len)); | |
506 | ||
507 | if (rlen != sizeof(len)) { | |
508 | fprintf(stderr, | |
509 | "Unexpected received size. Expected %zu got %zu\n", | |
510 | sizeof(len), rlen); | |
511 | ret = NULL; | |
512 | goto end; | |
513 | } | |
514 | ||
515 | /* Account for the NULL byte */ | |
516 | ret = malloc(len + 1); | |
517 | if (!ret) { | |
518 | ret = NULL; | |
519 | goto end; | |
520 | } | |
521 | ||
522 | /* Get the actual string */ | |
523 | rlen = lttcomm_recv_unix_sock(sock, ret, len); | |
524 | if (rlen != len) { | |
525 | fprintf(stderr, | |
526 | "Unexpected received size. Expected %zu got %zu\n", | |
527 | len, rlen); | |
528 | free(ret); | |
529 | ret = NULL; | |
530 | goto end; | |
531 | } | |
532 | ||
533 | /* Set terminating NULL byte */ | |
534 | ret[len] = '\0'; | |
535 | ||
536 | end: | |
537 | return ret; | |
538 | } | |
539 | ||
540 | ||
d19d9ada DG |
541 | /* |
542 | * Send a message with credentials over a unix socket. | |
543 | * | |
544 | * Returns the size of data sent, or negative error value. | |
545 | */ | |
546 | ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len) | |
547 | { | |
156ea65a | 548 | struct msghdr msg; |
d19d9ada DG |
549 | struct iovec iov[1]; |
550 | ssize_t ret = -1; | |
d27c42b8 MD |
551 | #ifdef __linux__ |
552 | struct cmsghdr *cmptr; | |
b17231c6 | 553 | size_t sizeof_cred = sizeof(lttng_sock_cred); |
d19d9ada | 554 | char anc_buf[CMSG_SPACE(sizeof_cred)]; |
b17231c6 | 555 | lttng_sock_cred *creds; |
d27c42b8 | 556 | #endif /* __linux__ */ |
d19d9ada | 557 | |
156ea65a MD |
558 | memset(&msg, 0, sizeof(msg)); |
559 | ||
d19d9ada DG |
560 | iov[0].iov_base = buf; |
561 | iov[0].iov_len = len; | |
562 | msg.msg_iov = iov; | |
563 | msg.msg_iovlen = 1; | |
564 | ||
d27c42b8 | 565 | #ifdef __linux__ |
d19d9ada DG |
566 | msg.msg_control = (caddr_t) anc_buf; |
567 | msg.msg_controllen = CMSG_LEN(sizeof_cred); | |
568 | ||
569 | cmptr = CMSG_FIRSTHDR(&msg); | |
570 | cmptr->cmsg_level = SOL_SOCKET; | |
b17231c6 | 571 | cmptr->cmsg_type = LTTNG_SOCK_CREDS; |
d19d9ada DG |
572 | cmptr->cmsg_len = CMSG_LEN(sizeof_cred); |
573 | ||
b17231c6 | 574 | creds = (lttng_sock_cred*) CMSG_DATA(cmptr); |
d19d9ada | 575 | |
b17231c6 DG |
576 | LTTNG_SOCK_SET_UID_CRED(creds, geteuid()); |
577 | LTTNG_SOCK_SET_GID_CRED(creds, getegid()); | |
578 | LTTNG_SOCK_SET_PID_CRED(creds, getpid()); | |
d27c42b8 | 579 | #endif /* __linux__ */ |
d19d9ada | 580 | |
66724ea3 DG |
581 | do { |
582 | ret = sendmsg(sock, &msg, 0); | |
583 | } while (ret < 0 && errno == EINTR); | |
d19d9ada | 584 | if (ret < 0) { |
d2641a83 MD |
585 | /* |
586 | * Only warn about EPIPE when quiet mode is deactivated. | |
587 | * We consider EPIPE as expected. | |
588 | */ | |
97e19046 | 589 | if (errno != EPIPE || !lttng_opt_quiet) { |
d2641a83 MD |
590 | PERROR("sendmsg"); |
591 | } | |
d19d9ada | 592 | } |
d19d9ada DG |
593 | return ret; |
594 | } | |
595 | ||
596 | /* | |
597 | * Recv a message accompanied with credentials from a unix socket. | |
598 | * | |
599 | * Returns the size of received data, or negative error value. | |
600 | */ | |
601 | ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len, | |
b17231c6 | 602 | lttng_sock_cred *creds) |
d19d9ada | 603 | { |
156ea65a | 604 | struct msghdr msg; |
d19d9ada DG |
605 | struct iovec iov[1]; |
606 | ssize_t ret; | |
d27c42b8 MD |
607 | #ifdef __linux__ |
608 | struct cmsghdr *cmptr; | |
b17231c6 | 609 | size_t sizeof_cred = sizeof(lttng_sock_cred); |
d19d9ada | 610 | char anc_buf[CMSG_SPACE(sizeof_cred)]; |
d27c42b8 | 611 | #endif /* __linux__ */ |
d19d9ada | 612 | |
156ea65a MD |
613 | memset(&msg, 0, sizeof(msg)); |
614 | ||
d19d9ada DG |
615 | /* Not allowed */ |
616 | if (creds == NULL) { | |
617 | ret = -1; | |
618 | goto end; | |
619 | } | |
620 | ||
621 | /* Prepare to receive the structures */ | |
622 | iov[0].iov_base = buf; | |
623 | iov[0].iov_len = len; | |
624 | msg.msg_iov = iov; | |
625 | msg.msg_iovlen = 1; | |
626 | ||
d27c42b8 | 627 | #ifdef __linux__ |
d19d9ada DG |
628 | msg.msg_control = anc_buf; |
629 | msg.msg_controllen = sizeof(anc_buf); | |
d27c42b8 | 630 | #endif /* __linux__ */ |
d19d9ada | 631 | |
91fe73e2 MD |
632 | do { |
633 | ret = recvmsg(sock, &msg, 0); | |
634 | } while (ret < 0 && errno == EINTR); | |
d19d9ada | 635 | if (ret < 0) { |
4c462e79 | 636 | PERROR("recvmsg fds"); |
d19d9ada DG |
637 | goto end; |
638 | } | |
639 | ||
d27c42b8 | 640 | #ifdef __linux__ |
d19d9ada DG |
641 | if (msg.msg_flags & MSG_CTRUNC) { |
642 | fprintf(stderr, "Error: Control message truncated.\n"); | |
643 | ret = -1; | |
644 | goto end; | |
645 | } | |
646 | ||
647 | cmptr = CMSG_FIRSTHDR(&msg); | |
648 | if (cmptr == NULL) { | |
649 | fprintf(stderr, "Error: Invalid control message header\n"); | |
650 | ret = -1; | |
651 | goto end; | |
652 | } | |
653 | ||
654 | if (cmptr->cmsg_level != SOL_SOCKET || | |
b17231c6 | 655 | cmptr->cmsg_type != LTTNG_SOCK_CREDS) { |
d19d9ada DG |
656 | fprintf(stderr, "Didn't received any credentials\n"); |
657 | ret = -1; | |
658 | goto end; | |
659 | } | |
660 | ||
661 | if (cmptr->cmsg_len != CMSG_LEN(sizeof_cred)) { | |
662 | fprintf(stderr, "Error: Received %zu bytes of ancillary data, expected %zu\n", | |
b17231c6 | 663 | (size_t) cmptr->cmsg_len, (size_t) CMSG_LEN(sizeof_cred)); |
d19d9ada DG |
664 | ret = -1; |
665 | goto end; | |
666 | } | |
667 | ||
668 | memcpy(creds, CMSG_DATA(cmptr), sizeof_cred); | |
d59cedb3 | 669 | #elif (defined(__FreeBSD__) || defined(__CYGWIN__)) |
9e89c931 MD |
670 | { |
671 | int peer_ret; | |
672 | ||
673 | peer_ret = getpeereid(sock, &creds->uid, &creds->gid); | |
674 | if (peer_ret != 0) { | |
675 | return peer_ret; | |
676 | } | |
67cf0ab7 | 677 | } |
d27c42b8 MD |
678 | #else |
679 | #error "Please implement credential support for your OS." | |
680 | #endif /* __linux__ */ | |
d19d9ada DG |
681 | |
682 | end: | |
683 | return ret; | |
684 | } | |
685 | ||
686 | /* | |
687 | * Set socket option to use credentials passing. | |
688 | */ | |
d27c42b8 | 689 | #ifdef __linux__ |
d19d9ada DG |
690 | int lttcomm_setsockopt_creds_unix_sock(int sock) |
691 | { | |
692 | int ret, on = 1; | |
693 | ||
694 | /* Set socket for credentials retrieval */ | |
695 | ret = setsockopt(sock, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on)); | |
696 | if (ret < 0) { | |
4c462e79 | 697 | PERROR("setsockopt creds unix sock"); |
d19d9ada | 698 | } |
d19d9ada DG |
699 | return ret; |
700 | } | |
d59cedb3 | 701 | #elif (defined(__FreeBSD__) || defined(__CYGWIN__)) |
d27c42b8 MD |
702 | int lttcomm_setsockopt_creds_unix_sock(int sock) |
703 | { | |
704 | return 0; | |
705 | } | |
706 | #else | |
707 | #error "Please implement credential support for your OS." | |
708 | #endif /* __linux__ */ |