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.
25 #include <sys/socket.h>
27 #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_NOT_FOUND
) ] = "UST channel not found",
77 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_FAIL
) ] = "UST create channel failed",
78 [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY
) ] = "Kconsumerd command socket ready",
79 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD
) ] = "Kconsumerd success on receiving fds",
80 [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD
) ] = "Kconsumerd error on receiving fds",
81 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR
) ] = "Kconsumerd error in polling thread",
82 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL
) ] = "Kconsumerd polling on closed fd",
83 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP
) ] = "Kconsumerd all fd hung up",
84 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS
) ] = "Kconsumerd exiting normally",
85 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE
) ] = "Kconsumerd exiting on error",
86 [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR
) ] = "Kconsumerd error opening the tracefile",
87 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF
) ] = "Kconsumerd splice EBADF",
88 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL
) ] = "Kconsumerd splice EINVAL",
89 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM
) ] = "Kconsumerd splice ENOMEM",
90 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE
) ] = "Kconsumerd splice ESPIPE",
91 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT
) ] = "Event not found",
95 * Return ptr to string representing a human readable error code from the
96 * lttcomm_return_code enum.
98 * These code MUST be negative in other to treat that as an error value.
100 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
102 int tmp_code
= -code
;
104 if (tmp_code
>= LTTCOMM_OK
&& tmp_code
< LTTCOMM_NR
) {
105 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(tmp_code
)];
108 return "Unknown error code";
112 * Connect to unix socket using the path name.
114 int lttcomm_connect_unix_sock(const char *pathname
)
116 struct sockaddr_un sun
;
120 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
127 memset(&sun
, 0, sizeof(sun
));
128 sun
.sun_family
= AF_UNIX
;
129 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
130 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
132 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
135 * Don't print message on connect error, because connect is used in
136 * normal execution to detect if sessiond is alive.
150 * Do an accept(2) on the sock and return the new file descriptor. The socket
151 * MUST be bind(2) before.
153 int lttcomm_accept_unix_sock(int sock
)
156 struct sockaddr_un sun
;
160 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
173 * Creates a AF_UNIX local socket using pathname bind the socket upon creation
176 int lttcomm_create_unix_sock(const char *pathname
)
178 struct sockaddr_un sun
;
182 /* Create server socket */
183 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
188 memset(&sun
, 0, sizeof(sun
));
189 sun
.sun_family
= AF_UNIX
;
190 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
191 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
193 /* Unlink the old file if present */
194 (void) unlink(pathname
);
195 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
208 * Make the socket listen using MAX_LISTEN.
210 int lttcomm_listen_unix_sock(int sock
)
214 ret
= listen(sock
, MAX_LISTEN
);
223 * Receive data of size len in put that data into the buf param. Using recvmsg
226 * Return the size of received data.
228 ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
230 struct msghdr msg
= { 0 };
234 iov
[0].iov_base
= buf
;
235 iov
[0].iov_len
= len
;
239 ret
= recvmsg(sock
, &msg
, 0);
248 * Send buf data of size len. Using sendmsg API.
250 * Return the size of sent data.
252 ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
)
254 struct msghdr msg
= { 0 };
258 iov
[0].iov_base
= buf
;
259 iov
[0].iov_len
= len
;
263 ret
= sendmsg(sock
, &msg
, 0);
272 * Shutdown cleanly a unix socket.
274 int lttcomm_close_unix_sock(int sock
)
278 /* Shutdown receptions and transmissions */
279 ret
= shutdown(sock
, SHUT_RDWR
);
288 * Send multiple fds on a unix socket.
290 ssize_t
lttcomm_send_fds_unix_sock(int sock
, void *buf
, int *fds
,
291 size_t nb_fd
, size_t len
)
293 struct msghdr msg
= { 0 };
294 struct cmsghdr
*cmptr
;
297 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
298 char tmp
[CMSG_SPACE(sizeof_fds
)];
301 * Note: the consumerd receiver only supports receiving one FD per message.
305 msg
.msg_control
= (caddr_t
)tmp
;
306 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
308 cmptr
= CMSG_FIRSTHDR(&msg
);
309 cmptr
->cmsg_level
= SOL_SOCKET
;
310 cmptr
->cmsg_type
= SCM_RIGHTS
;
311 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
312 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
313 /* Sum of the length of all control messages in the buffer: */
314 msg
.msg_controllen
= cmptr
->cmsg_len
;
316 iov
[0].iov_base
= buf
;
317 iov
[0].iov_len
= len
;
321 ret
= sendmsg(sock
, &msg
, 0);
330 * Receives a single fd from socket.
332 * Returns the size of received data
334 ssize_t
lttcomm_recv_fds_unix_sock(int sock
, void *buf
, int *fds
,
335 size_t nb_fd
, size_t len
)
338 int data_fd
, i
, ret
= 0;
339 struct cmsghdr
*cmsg
;
340 char recv_fd
[CMSG_SPACE(sizeof(int))];
341 struct msghdr msg
= { 0 };
347 /* Prepare to receive the structures */
348 iov
[0].iov_base
= &data_fd
;
349 iov
[0].iov_len
= sizeof(data_fd
);
352 msg
.msg_control
= recv_fd
;
353 msg
.msg_controllen
= sizeof(recv_fd
);
355 ret
= recvmsg(sock
, &msg
, 0);
357 perror("recvmsg fds");
361 if (ret
!= sizeof(data_fd
)) {
362 fprintf(stderr
, "Error: Received %d bytes, expected %ld",
363 ret
, sizeof(data_fd
));
367 cmsg
= CMSG_FIRSTHDR(&msg
);
369 fprintf(stderr
, "Error: Invalid control message header");
374 if (cmsg
->cmsg_level
!= SOL_SOCKET
|| cmsg
->cmsg_type
!= SCM_RIGHTS
) {
375 fprintf(stderr
, "Didn't received any fd");
381 for (i
= 0; i
< sizeof(int); i
++) {
382 tmp
.vc
[i
] = CMSG_DATA(cmsg
)[i
];