2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
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
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <sys/types.h>
30 #include <common/defaults.h>
32 #include "sessiond-comm.h"
35 * Human readable error message.
37 static const char *lttcomm_readable_code
[] = {
38 [ LTTCOMM_ERR_INDEX(LTTCOMM_OK
) ] = "Success",
39 [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR
) ] = "Unknown error",
40 [ LTTCOMM_ERR_INDEX(LTTCOMM_UND
) ] = "Undefined command",
41 [ LTTCOMM_ERR_INDEX(LTTCOMM_NOT_IMPLEMENTED
) ] = "Not implemented",
42 [ LTTCOMM_ERR_INDEX(LTTCOMM_UNKNOWN_DOMAIN
) ] = "Unknown tracing domain",
43 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION
) ] = "No session found",
44 [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL
) ] = "Unable to list traceable apps",
45 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS
) ] = "No traceable apps found",
46 [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND
) ] = "Session name not found",
47 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE
) ] = "No trace found",
48 [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL
) ] = "Fatal error of the session daemon",
49 [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_DIR_FAIL
) ] = "Create directory failed",
50 [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL
) ] = "Start trace failed",
51 [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL
) ] = "Stop trace failed",
52 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE
) ] = "App is not traceable",
53 [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS
) ] = "A session MUST be selected",
54 [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS
) ] = "Session name already exist",
55 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONNECT_FAIL
) ] = "Unable to connect to Unix socket",
56 [ LTTCOMM_ERR_INDEX(LTTCOMM_APP_NOT_FOUND
) ] = "Application not found",
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_EPERM
) ] = "Permission denied",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA
) ] = "Kernel tracer not available",
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_VERSION
) ] = "Kernel tracer version is not compatible",
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST
) ] = "Kernel event already exists",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL
) ] = "Kernel create session failed",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL
) ] = "Kernel create channel failed",
63 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND
) ] = "Kernel channel not found",
64 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL
) ] = "Disable kernel channel failed",
65 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL
) ] = "Enable kernel channel failed",
66 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL
) ] = "Add kernel context failed",
67 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL
) ] = "Enable kernel event failed",
68 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL
) ] = "Disable kernel event failed",
69 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL
) ] = "Opening metadata failed",
70 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL
) ] = "Starting kernel trace failed",
71 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL
) ] = "Stoping kernel trace failed",
72 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL
) ] = "Kernel consumer start failed",
73 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL
) ] = "Kernel create stream failed",
74 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL
) ] = "Kernel trace directory creation failed",
75 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST
) ] = "Kernel trace directory already exist",
76 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION
) ] = "No kernel session found",
77 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL
) ] = "Listing kernel events failed",
78 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CALIBRATE_FAIL
) ] = "UST calibration failed",
79 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_VERSION
) ] = "UST tracer version is not compatible",
80 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_SESS_FAIL
) ] = "UST create session failed",
81 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_FAIL
) ] = "UST create channel failed",
82 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_EXIST
) ] = "UST channel already exist",
83 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_NOT_FOUND
) ] = "UST channel not found",
84 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_DISABLE_FAIL
) ] = "Disable UST channel failed",
85 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_ENABLE_FAIL
) ] = "Enable UST channel failed",
86 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_FAIL
) ] = "Add UST context failed",
87 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_ENABLE_FAIL
) ] = "Enable UST event failed",
88 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DISABLE_FAIL
) ] = "Disable UST event failed",
89 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_META_FAIL
) ] = "Opening metadata failed",
90 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_START_FAIL
) ] = "Starting UST trace failed",
91 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STOP_FAIL
) ] = "Stoping UST trace failed",
92 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER64_FAIL
) ] = "64-bit UST consumer start failed",
93 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER32_FAIL
) ] = "32-bit UST consumer start failed",
94 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STREAM_FAIL
) ] = "UST create stream failed",
95 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_FAIL
) ] = "UST trace directory creation failed",
96 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_EXIST
) ] = "UST trace directory already exist",
97 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_NO_SESSION
) ] = "No UST session found",
98 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_LIST_FAIL
) ] = "Listing UST events failed",
99 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_EXIST
) ] = "UST event already exist",
100 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_NOT_FOUND
)] = "UST event not found",
101 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_EXIST
)] = "UST context already exist",
102 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_INVAL
)] = "UST invalid context",
103 [ LTTCOMM_ERR_INDEX(CONSUMERD_COMMAND_SOCK_READY
) ] = "consumerd command socket ready",
104 [ LTTCOMM_ERR_INDEX(CONSUMERD_SUCCESS_RECV_FD
) ] = "consumerd success on receiving fds",
105 [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_FD
) ] = "consumerd error on receiving fds",
106 [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_CMD
) ] = "consumerd error on receiving command",
107 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_ERROR
) ] = "consumerd error in polling thread",
108 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_NVAL
) ] = "consumerd polling on closed fd",
109 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_HUP
) ] = "consumerd all fd hung up",
110 [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_SUCCESS
) ] = "consumerd exiting normally",
111 [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_FAILURE
) ] = "consumerd exiting on error",
112 [ LTTCOMM_ERR_INDEX(CONSUMERD_OUTFD_ERROR
) ] = "consumerd error opening the tracefile",
113 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EBADF
) ] = "consumerd splice EBADF",
114 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EINVAL
) ] = "consumerd splice EINVAL",
115 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ENOMEM
) ] = "consumerd splice ENOMEM",
116 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ESPIPE
) ] = "consumerd splice ESPIPE",
117 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT
) ] = "Event not found",
121 * Return ptr to string representing a human readable error code from the
122 * lttcomm_return_code enum.
124 * These code MUST be negative in other to treat that as an error value.
126 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
128 int tmp_code
= -code
;
130 if (tmp_code
>= LTTCOMM_OK
&& tmp_code
< LTTCOMM_NR
) {
131 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(tmp_code
)];
134 return "Unknown error code";
138 * Connect to unix socket using the path name.
140 int lttcomm_connect_unix_sock(const char *pathname
)
142 struct sockaddr_un sun
;
146 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
153 memset(&sun
, 0, sizeof(sun
));
154 sun
.sun_family
= AF_UNIX
;
155 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
156 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
158 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
161 * Don't print message on connect error, because connect is used in
162 * normal execution to detect if sessiond is alive.
176 * Do an accept(2) on the sock and return the new file descriptor. The socket
177 * MUST be bind(2) before.
179 int lttcomm_accept_unix_sock(int sock
)
182 struct sockaddr_un sun
;
186 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
195 * Creates a AF_UNIX local socket using pathname bind the socket upon creation
198 int lttcomm_create_unix_sock(const char *pathname
)
200 struct sockaddr_un sun
;
204 /* Create server socket */
205 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
210 memset(&sun
, 0, sizeof(sun
));
211 sun
.sun_family
= AF_UNIX
;
212 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
213 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
215 /* Unlink the old file if present */
216 (void) unlink(pathname
);
217 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
230 * Make the socket listen using LTTNG_SESSIOND_COMM_MAX_LISTEN.
232 int lttcomm_listen_unix_sock(int sock
)
236 ret
= listen(sock
, LTTNG_SESSIOND_COMM_MAX_LISTEN
);
245 * Receive data of size len in put that data into the buf param. Using recvmsg
248 * Return the size of received data.
250 ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
256 memset(&msg
, 0, sizeof(msg
));
258 iov
[0].iov_base
= buf
;
259 iov
[0].iov_len
= len
;
263 ret
= recvmsg(sock
, &msg
, MSG_WAITALL
);
272 * Send buf data of size len. Using sendmsg API.
274 * Return the size of sent data.
276 ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
)
282 memset(&msg
, 0, sizeof(msg
));
284 iov
[0].iov_base
= buf
;
285 iov
[0].iov_len
= len
;
289 ret
= sendmsg(sock
, &msg
, 0);
298 * Shutdown cleanly a unix socket.
300 int lttcomm_close_unix_sock(int sock
)
304 /* Shutdown receptions and transmissions */
305 ret
= shutdown(sock
, SHUT_RDWR
);
316 * Send a message accompanied by fd(s) over a unix socket.
318 * Returns the size of data sent, or negative error value.
320 ssize_t
lttcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
323 struct cmsghdr
*cmptr
;
326 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
327 char tmp
[CMSG_SPACE(sizeof_fds
)];
330 memset(&msg
, 0, sizeof(msg
));
332 if (nb_fd
> LTTCOMM_MAX_SEND_FDS
)
335 msg
.msg_control
= (caddr_t
)tmp
;
336 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
338 cmptr
= CMSG_FIRSTHDR(&msg
);
339 cmptr
->cmsg_level
= SOL_SOCKET
;
340 cmptr
->cmsg_type
= SCM_RIGHTS
;
341 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
342 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
343 /* Sum of the length of all control messages in the buffer: */
344 msg
.msg_controllen
= cmptr
->cmsg_len
;
346 iov
[0].iov_base
= &dummy
;
351 ret
= sendmsg(sock
, &msg
, 0);
359 * Recv a message accompanied by fd(s) from a unix socket.
361 * Returns the size of received data, or negative error value.
363 * Expect at most "nb_fd" file descriptors. Returns the number of fd
364 * actually received in nb_fd.
366 ssize_t
lttcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
370 struct cmsghdr
*cmsg
;
371 size_t sizeof_fds
= nb_fd
* sizeof(int);
372 char recv_fd
[CMSG_SPACE(sizeof_fds
)];
376 memset(&msg
, 0, sizeof(msg
));
378 /* Prepare to receive the structures */
379 iov
[0].iov_base
= &dummy
;
383 msg
.msg_control
= recv_fd
;
384 msg
.msg_controllen
= sizeof(recv_fd
);
386 ret
= recvmsg(sock
, &msg
, 0);
388 perror("recvmsg fds");
392 fprintf(stderr
, "Error: Received %zd bytes, expected %d\n",
396 if (msg
.msg_flags
& MSG_CTRUNC
) {
397 fprintf(stderr
, "Error: Control message truncated.\n");
401 cmsg
= CMSG_FIRSTHDR(&msg
);
403 fprintf(stderr
, "Error: Invalid control message header\n");
407 if (cmsg
->cmsg_level
!= SOL_SOCKET
|| cmsg
->cmsg_type
!= SCM_RIGHTS
) {
408 fprintf(stderr
, "Didn't received any fd\n");
412 if (cmsg
->cmsg_len
!= CMSG_LEN(sizeof_fds
)) {
413 fprintf(stderr
, "Error: Received %zu bytes of ancillary data, expected %zu\n",
414 (size_t) cmsg
->cmsg_len
, (size_t) CMSG_LEN(sizeof_fds
));
418 memcpy(fds
, CMSG_DATA(cmsg
), sizeof_fds
);
425 * Send a message with credentials over a unix socket.
427 * Returns the size of data sent, or negative error value.
429 ssize_t
lttcomm_send_creds_unix_sock(int sock
, void *buf
, size_t len
)
432 struct cmsghdr
*cmptr
;
435 size_t sizeof_cred
= sizeof(lttng_sock_cred
);
436 char anc_buf
[CMSG_SPACE(sizeof_cred
)];
437 lttng_sock_cred
*creds
;
439 memset(&msg
, 0, sizeof(msg
));
441 iov
[0].iov_base
= buf
;
442 iov
[0].iov_len
= len
;
446 msg
.msg_control
= (caddr_t
) anc_buf
;
447 msg
.msg_controllen
= CMSG_LEN(sizeof_cred
);
449 cmptr
= CMSG_FIRSTHDR(&msg
);
450 cmptr
->cmsg_level
= SOL_SOCKET
;
451 cmptr
->cmsg_type
= LTTNG_SOCK_CREDS
;
452 cmptr
->cmsg_len
= CMSG_LEN(sizeof_cred
);
454 creds
= (lttng_sock_cred
*) CMSG_DATA(cmptr
);
456 LTTNG_SOCK_SET_UID_CRED(creds
, geteuid());
457 LTTNG_SOCK_SET_GID_CRED(creds
, getegid());
458 LTTNG_SOCK_SET_PID_CRED(creds
, getpid());
460 ret
= sendmsg(sock
, &msg
, 0);
469 * Recv a message accompanied with credentials from a unix socket.
471 * Returns the size of received data, or negative error value.
473 ssize_t
lttcomm_recv_creds_unix_sock(int sock
, void *buf
, size_t len
,
474 lttng_sock_cred
*creds
)
477 struct cmsghdr
*cmptr
;
480 size_t sizeof_cred
= sizeof(lttng_sock_cred
);
481 char anc_buf
[CMSG_SPACE(sizeof_cred
)];
483 memset(&msg
, 0, sizeof(msg
));
491 /* Prepare to receive the structures */
492 iov
[0].iov_base
= buf
;
493 iov
[0].iov_len
= len
;
497 msg
.msg_control
= anc_buf
;
498 msg
.msg_controllen
= sizeof(anc_buf
);
500 ret
= recvmsg(sock
, &msg
, 0);
502 perror("recvmsg fds");
506 if (msg
.msg_flags
& MSG_CTRUNC
) {
507 fprintf(stderr
, "Error: Control message truncated.\n");
512 cmptr
= CMSG_FIRSTHDR(&msg
);
514 fprintf(stderr
, "Error: Invalid control message header\n");
519 if (cmptr
->cmsg_level
!= SOL_SOCKET
||
520 cmptr
->cmsg_type
!= LTTNG_SOCK_CREDS
) {
521 fprintf(stderr
, "Didn't received any credentials\n");
526 if (cmptr
->cmsg_len
!= CMSG_LEN(sizeof_cred
)) {
527 fprintf(stderr
, "Error: Received %zu bytes of ancillary data, expected %zu\n",
528 (size_t) cmptr
->cmsg_len
, (size_t) CMSG_LEN(sizeof_cred
));
533 memcpy(creds
, CMSG_DATA(cmptr
), sizeof_cred
);
540 * Set socket option to use credentials passing.
542 int lttcomm_setsockopt_creds_unix_sock(int sock
)
546 /* Set socket for credentials retrieval */
547 ret
= setsockopt(sock
, SOL_SOCKET
, SO_PASSCRED
, &on
, sizeof(on
));
549 perror("setsockopt creds unix sock");