2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; only version 2
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple 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_KERN_NA
) ] = "Kernel tracer not available",
56 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST
) ] = "Kernel event already exists",
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL
) ] = "Kernel create session failed",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL
) ] = "Kernel create channel failed",
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND
) ] = "Kernel channel not found",
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL
) ] = "Disable kernel channel failed",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL
) ] = "Enable kernel channel failed",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL
) ] = "Add kernel context failed",
63 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL
) ] = "Enable kernel event failed",
64 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL
) ] = "Disable kernel event failed",
65 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL
) ] = "Opening metadata failed",
66 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL
) ] = "Starting kernel trace failed",
67 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL
) ] = "Stoping kernel trace failed",
68 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL
) ] = "Kernel consumer start failed",
69 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL
) ] = "Kernel create stream failed",
70 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL
) ] = "Kernel trace directory creation failed",
71 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST
) ] = "Kernel trace directory already exist",
72 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION
) ] = "No kernel session found",
73 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL
) ] = "Listing kernel events failed",
74 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_SESS_FAIL
) ] = "UST create session failed",
75 [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY
) ] = "Kconsumerd command socket ready",
76 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD
) ] = "Kconsumerd success on receiving fds",
77 [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD
) ] = "Kconsumerd error on receiving fds",
78 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR
) ] = "Kconsumerd error in polling thread",
79 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL
) ] = "Kconsumerd polling on closed fd",
80 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP
) ] = "Kconsumerd all fd hung up",
81 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS
) ] = "Kconsumerd exiting normally",
82 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE
) ] = "Kconsumerd exiting on error",
83 [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR
) ] = "Kconsumerd error opening the tracefile",
84 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF
) ] = "Kconsumerd splice EBADF",
85 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL
) ] = "Kconsumerd splice EINVAL",
86 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM
) ] = "Kconsumerd splice ENOMEM",
87 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE
) ] = "Kconsumerd splice ESPIPE",
88 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT
) ] = "Event not found",
92 * lttcom_get_readable_code
94 * Return ptr to string representing a human readable
95 * error code from the lttcomm_return_code enum.
97 * These code MUST be negative in other to treat that
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 * lttcomm_connect_unix_sock
114 * Connect to unix socket using the path name.
116 int lttcomm_connect_unix_sock(const char *pathname
)
118 struct sockaddr_un sun
;
122 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
129 memset(&sun
, 0, sizeof(sun
));
130 sun
.sun_family
= AF_UNIX
;
131 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
132 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
134 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
137 * Don't print message on connect error, because connect
138 * is used in normal execution to detect if sessiond is
153 * lttcomm_accept_unix_sock
155 * Do an accept(2) on the sock and return the
156 * new file descriptor. The socket MUST be bind(2) before.
158 int lttcomm_accept_unix_sock(int sock
)
161 struct sockaddr_un sun
;
165 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
178 * lttcomm_create_unix_sock
180 * Creates a AF_UNIX local socket using pathname
181 * bind the socket upon creation and return the fd.
183 int lttcomm_create_unix_sock(const char *pathname
)
185 struct sockaddr_un sun
;
189 /* Create server socket */
190 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
195 memset(&sun
, 0, sizeof(sun
));
196 sun
.sun_family
= AF_UNIX
;
197 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
198 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
200 /* Unlink the old file if present */
201 (void) unlink(pathname
);
202 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
215 * lttcomm_listen_unix_sock
217 * Make the socket listen using MAX_LISTEN.
219 int lttcomm_listen_unix_sock(int sock
)
223 ret
= listen(sock
, MAX_LISTEN
);
232 * lttcomm_recv_unix_sock
234 * Receive data of size len in put that data into
235 * the buf param. Using recvmsg API.
236 * Return the size of received data.
238 ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
240 struct msghdr msg
= { 0 };
244 iov
[0].iov_base
= buf
;
245 iov
[0].iov_len
= len
;
249 ret
= recvmsg(sock
, &msg
, 0);
258 * lttcomm_send_unix_sock
260 * Send buf data of size len. Using sendmsg API.
261 * Return the size of sent data.
263 ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
)
265 struct msghdr msg
= { 0 };
269 iov
[0].iov_base
= buf
;
270 iov
[0].iov_len
= len
;
274 ret
= sendmsg(sock
, &msg
, 0);
283 * lttcomm_close_unix_sock
285 * Shutdown cleanly a unix socket.
287 int lttcomm_close_unix_sock(int sock
)
291 /* Shutdown receptions and transmissions */
292 ret
= shutdown(sock
, SHUT_RDWR
);
301 * lttcomm_send_fds_unix_sock
303 * Send multiple fds on a unix socket.
305 ssize_t
lttcomm_send_fds_unix_sock(int sock
, void *buf
, int *fds
, size_t nb_fd
, size_t len
)
307 struct msghdr msg
= { 0 };
308 struct cmsghdr
*cmptr
;
311 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
312 char tmp
[CMSG_SPACE(sizeof_fds
)];
315 * Note: the consumerd receiver only supports receiving one FD per
320 msg
.msg_control
= (caddr_t
)tmp
;
321 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
323 cmptr
= CMSG_FIRSTHDR(&msg
);
324 cmptr
->cmsg_level
= SOL_SOCKET
;
325 cmptr
->cmsg_type
= SCM_RIGHTS
;
326 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
327 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
328 /* Sum of the length of all control messages in the buffer: */
329 msg
.msg_controllen
= cmptr
->cmsg_len
;
331 iov
[0].iov_base
= buf
;
332 iov
[0].iov_len
= len
;
336 ret
= sendmsg(sock
, &msg
, 0);