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>
31 #include <lttng-sessiond-comm.h>
34 * Human readable error message.
36 static const char *lttcomm_readable_code
[] = {
37 [ LTTCOMM_ERR_INDEX(LTTCOMM_OK
) ] = "Success",
38 [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR
) ] = "Unknown error",
39 [ LTTCOMM_ERR_INDEX(LTTCOMM_UND
) ] = "Undefined command",
40 [ LTTCOMM_ERR_INDEX(LTTCOMM_NOT_IMPLEMENTED
) ] = "Not implemented",
41 [ LTTCOMM_ERR_INDEX(LTTCOMM_UNKNOWN_DOMAIN
) ] = "Unknown tracing domain",
42 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION
) ] = "No session found",
43 [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL
) ] = "Unable to list traceable apps",
44 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS
) ] = "No traceable apps found",
45 [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND
) ] = "Session name not found",
46 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE
) ] = "No trace found",
47 [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL
) ] = "Fatal error of the session daemon",
48 [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_FAIL
) ] = "Create trace failed",
49 [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL
) ] = "Start trace failed",
50 [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL
) ] = "Stop trace failed",
51 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE
) ] = "App is not traceable",
52 [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS
) ] = "A session MUST be selected",
53 [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS
) ] = "Session name already exist",
54 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONNECT_FAIL
) ] = "Unable to connect to Unix socket",
55 [ LTTCOMM_ERR_INDEX(LTTCOMM_APP_NOT_FOUND
) ] = "Application not found",
56 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA
) ] = "Kernel tracer not available",
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST
) ] = "Kernel event already exists",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL
) ] = "Kernel create session failed",
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL
) ] = "Kernel create channel failed",
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND
) ] = "Kernel channel not found",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL
) ] = "Disable kernel channel failed",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL
) ] = "Enable kernel channel failed",
63 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL
) ] = "Add kernel context failed",
64 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL
) ] = "Enable kernel event failed",
65 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL
) ] = "Disable kernel event failed",
66 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL
) ] = "Opening metadata failed",
67 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL
) ] = "Starting kernel trace failed",
68 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL
) ] = "Stoping kernel trace failed",
69 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL
) ] = "Kernel consumer start failed",
70 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL
) ] = "Kernel create stream failed",
71 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL
) ] = "Kernel trace directory creation failed",
72 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST
) ] = "Kernel trace directory already exist",
73 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION
) ] = "No kernel session found",
74 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL
) ] = "Listing kernel events failed",
75 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_SESS_FAIL
) ] = "UST create session failed",
76 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_FAIL
) ] = "UST create channel failed",
77 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_EXIST
) ] = "UST channel already exist",
78 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_NOT_FOUND
) ] = "UST channel not found",
79 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_DISABLE_FAIL
) ] = "Disable UST channel failed",
80 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_ENABLE_FAIL
) ] = "Enable UST channel failed",
81 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_FAIL
) ] = "Add UST context failed",
82 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_ENABLE_FAIL
) ] = "Enable UST event failed",
83 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DISABLE_FAIL
) ] = "Disable UST event failed",
84 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_META_FAIL
) ] = "Opening metadata failed",
85 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_START_FAIL
) ] = "Starting UST trace failed",
86 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STOP_FAIL
) ] = "Stoping UST trace failed",
87 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER64_FAIL
) ] = "64-bit UST consumer start failed",
88 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER32_FAIL
) ] = "32-bit UST consumer start failed",
89 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STREAM_FAIL
) ] = "UST create stream failed",
90 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_FAIL
) ] = "UST trace directory creation failed",
91 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_EXIST
) ] = "UST trace directory already exist",
92 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_NO_SESSION
) ] = "No UST session found",
93 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_LIST_FAIL
) ] = "Listing UST events failed",
94 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_EXIST
) ] = "UST event already exist",
95 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_NOT_FOUND
)] = "UST event not found",
96 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_EXIST
)] = "UST context already exist",
97 [ LTTCOMM_ERR_INDEX(CONSUMERD_COMMAND_SOCK_READY
) ] = "consumerd command socket ready",
98 [ LTTCOMM_ERR_INDEX(CONSUMERD_SUCCESS_RECV_FD
) ] = "consumerd success on receiving fds",
99 [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_FD
) ] = "consumerd error on receiving fds",
100 [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_CMD
) ] = "consumerd error on receiving command",
101 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_ERROR
) ] = "consumerd error in polling thread",
102 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_NVAL
) ] = "consumerd polling on closed fd",
103 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_HUP
) ] = "consumerd all fd hung up",
104 [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_SUCCESS
) ] = "consumerd exiting normally",
105 [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_FAILURE
) ] = "consumerd exiting on error",
106 [ LTTCOMM_ERR_INDEX(CONSUMERD_OUTFD_ERROR
) ] = "consumerd error opening the tracefile",
107 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EBADF
) ] = "consumerd splice EBADF",
108 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EINVAL
) ] = "consumerd splice EINVAL",
109 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ENOMEM
) ] = "consumerd splice ENOMEM",
110 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ESPIPE
) ] = "consumerd splice ESPIPE",
111 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT
) ] = "Event not found",
115 * Return ptr to string representing a human readable error code from the
116 * lttcomm_return_code enum.
118 * These code MUST be negative in other to treat that as an error value.
120 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
122 int tmp_code
= -code
;
124 if (tmp_code
>= LTTCOMM_OK
&& tmp_code
< LTTCOMM_NR
) {
125 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(tmp_code
)];
128 return "Unknown error code";
132 * Connect to unix socket using the path name.
134 int lttcomm_connect_unix_sock(const char *pathname
)
136 struct sockaddr_un sun
;
140 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
147 memset(&sun
, 0, sizeof(sun
));
148 sun
.sun_family
= AF_UNIX
;
149 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
150 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
152 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
155 * Don't print message on connect error, because connect is used in
156 * normal execution to detect if sessiond is alive.
170 * Do an accept(2) on the sock and return the new file descriptor. The socket
171 * MUST be bind(2) before.
173 int lttcomm_accept_unix_sock(int sock
)
176 struct sockaddr_un sun
;
180 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
189 * Creates a AF_UNIX local socket using pathname bind the socket upon creation
192 int lttcomm_create_unix_sock(const char *pathname
)
194 struct sockaddr_un sun
;
198 /* Create server socket */
199 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
204 memset(&sun
, 0, sizeof(sun
));
205 sun
.sun_family
= AF_UNIX
;
206 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
207 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
209 /* Unlink the old file if present */
210 (void) unlink(pathname
);
211 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
224 * Make the socket listen using LTTNG_SESSIOND_COMM_MAX_LISTEN.
226 int lttcomm_listen_unix_sock(int sock
)
230 ret
= listen(sock
, LTTNG_SESSIOND_COMM_MAX_LISTEN
);
239 * Receive data of size len in put that data into the buf param. Using recvmsg
242 * Return the size of received data.
244 ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
246 struct msghdr msg
= { 0 };
250 iov
[0].iov_base
= buf
;
251 iov
[0].iov_len
= len
;
255 ret
= recvmsg(sock
, &msg
, 0);
264 * Send buf data of size len. Using sendmsg API.
266 * Return the size of sent data.
268 ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
)
270 struct msghdr msg
= { 0 };
274 iov
[0].iov_base
= buf
;
275 iov
[0].iov_len
= len
;
279 ret
= sendmsg(sock
, &msg
, 0);
288 * Shutdown cleanly a unix socket.
290 int lttcomm_close_unix_sock(int sock
)
294 /* Shutdown receptions and transmissions */
295 ret
= shutdown(sock
, SHUT_RDWR
);
304 * Send a message accompanied by fd(s) over a unix socket.
306 * Returns the size of data sent, or negative error value.
308 ssize_t
lttcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
310 struct msghdr msg
= { 0 };
311 struct cmsghdr
*cmptr
;
314 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
315 char tmp
[CMSG_SPACE(sizeof_fds
)];
318 if (nb_fd
> LTTCOMM_MAX_SEND_FDS
)
321 msg
.msg_control
= (caddr_t
)tmp
;
322 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
324 cmptr
= CMSG_FIRSTHDR(&msg
);
325 cmptr
->cmsg_level
= SOL_SOCKET
;
326 cmptr
->cmsg_type
= SCM_RIGHTS
;
327 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
328 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
329 /* Sum of the length of all control messages in the buffer: */
330 msg
.msg_controllen
= cmptr
->cmsg_len
;
332 iov
[0].iov_base
= &dummy
;
337 ret
= sendmsg(sock
, &msg
, 0);
345 * Recv a message accompanied by fd(s) from a unix socket.
347 * Returns the size of received data, or negative error value.
349 * Expect at most "nb_fd" file descriptors. Returns the number of fd
350 * actually received in nb_fd.
352 ssize_t
lttcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
356 struct cmsghdr
*cmsg
;
357 size_t sizeof_fds
= nb_fd
* sizeof(int);
358 char recv_fd
[CMSG_SPACE(sizeof_fds
)];
359 struct msghdr msg
= { 0 };
362 /* Prepare to receive the structures */
363 iov
[0].iov_base
= &dummy
;
367 msg
.msg_control
= recv_fd
;
368 msg
.msg_controllen
= sizeof(recv_fd
);
370 ret
= recvmsg(sock
, &msg
, 0);
372 perror("recvmsg fds");
376 fprintf(stderr
, "Error: Received %zd bytes, expected %d\n",
380 if (msg
.msg_flags
& MSG_CTRUNC
) {
381 fprintf(stderr
, "Error: Control message truncated.\n");
385 cmsg
= CMSG_FIRSTHDR(&msg
);
387 fprintf(stderr
, "Error: Invalid control message header\n");
391 if (cmsg
->cmsg_level
!= SOL_SOCKET
|| cmsg
->cmsg_type
!= SCM_RIGHTS
) {
392 fprintf(stderr
, "Didn't received any fd\n");
396 if (cmsg
->cmsg_len
!= CMSG_LEN(sizeof_fds
)) {
397 fprintf(stderr
, "Error: Received %zu bytes of ancillary data, expected %zu\n",
398 cmsg
->cmsg_len
, CMSG_LEN(sizeof_fds
));
402 memcpy(fds
, CMSG_DATA(cmsg
), sizeof_fds
);
409 * Send a message with credentials over a unix socket.
411 * Returns the size of data sent, or negative error value.
413 ssize_t
lttcomm_send_creds_unix_sock(int sock
, void *buf
, size_t len
)
415 struct msghdr msg
= { 0 };
416 struct cmsghdr
*cmptr
;
420 size_t sizeof_cred
= sizeof(struct ucred
);
421 char anc_buf
[CMSG_SPACE(sizeof_cred
)];
423 iov
[0].iov_base
= buf
;
424 iov
[0].iov_len
= len
;
428 msg
.msg_control
= (caddr_t
) anc_buf
;
429 msg
.msg_controllen
= CMSG_LEN(sizeof_cred
);
431 cmptr
= CMSG_FIRSTHDR(&msg
);
432 cmptr
->cmsg_level
= SOL_SOCKET
;
433 cmptr
->cmsg_type
= SCM_CREDENTIALS
;
434 cmptr
->cmsg_len
= CMSG_LEN(sizeof_cred
);
436 creds
= (struct ucred
*) CMSG_DATA(cmptr
);
438 creds
->uid
= geteuid();
439 creds
->gid
= getegid();
440 creds
->pid
= getpid();
442 ret
= sendmsg(sock
, &msg
, 0);
451 * Recv a message accompanied with credentials from a unix socket.
453 * Returns the size of received data, or negative error value.
455 ssize_t
lttcomm_recv_creds_unix_sock(int sock
, void *buf
, size_t len
,
458 struct msghdr msg
= { 0 };
459 struct cmsghdr
*cmptr
;
462 size_t sizeof_cred
= sizeof(struct ucred
);
463 char anc_buf
[CMSG_SPACE(sizeof_cred
)];
471 /* Prepare to receive the structures */
472 iov
[0].iov_base
= buf
;
473 iov
[0].iov_len
= len
;
477 msg
.msg_control
= anc_buf
;
478 msg
.msg_controllen
= sizeof(anc_buf
);
480 ret
= recvmsg(sock
, &msg
, 0);
482 perror("recvmsg fds");
486 if (msg
.msg_flags
& MSG_CTRUNC
) {
487 fprintf(stderr
, "Error: Control message truncated.\n");
492 cmptr
= CMSG_FIRSTHDR(&msg
);
494 fprintf(stderr
, "Error: Invalid control message header\n");
499 if (cmptr
->cmsg_level
!= SOL_SOCKET
||
500 cmptr
->cmsg_type
!= SCM_CREDENTIALS
) {
501 fprintf(stderr
, "Didn't received any credentials\n");
506 if (cmptr
->cmsg_len
!= CMSG_LEN(sizeof_cred
)) {
507 fprintf(stderr
, "Error: Received %zu bytes of ancillary data, expected %zu\n",
508 cmptr
->cmsg_len
, CMSG_LEN(sizeof_cred
));
513 memcpy(creds
, CMSG_DATA(cmptr
), sizeof_cred
);
520 * Set socket option to use credentials passing.
522 int lttcomm_setsockopt_creds_unix_sock(int sock
)
526 /* Set socket for credentials retrieval */
527 ret
= setsockopt(sock
, SOL_SOCKET
, SO_PASSCRED
, &on
, sizeof(on
));
529 perror("setsockopt creds unix sock");