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; either version 2
7 * of the License, or (at your option) any later version.
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.
24 #include <sys/socket.h>
26 #include <sys/types.h>
30 #include "liblttsessiondcomm.h"
33 * Human readable error message.
35 static const char *lttcomm_readable_code
[] = {
36 [ LTTCOMM_ERR_INDEX(LTTCOMM_OK
) ] = "Success",
37 [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR
) ] = "Unknown error",
38 [ LTTCOMM_ERR_INDEX(LTTCOMM_UND
) ] = "Undefined command",
39 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION
) ] = "No session found",
40 [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL
) ] = "Unable to list traceable apps",
41 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS
) ] = "No traceable apps found",
42 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESS
) ] = "No session found",
43 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE
) ] = "No trace found",
44 [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL
) ] = "Fatal error of the session daemon",
45 [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_FAIL
) ] = "Create trace failed",
46 [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL
) ] = "Start trace failed",
47 [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL
) ] = "Stop trace failed",
48 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE
) ] = "App is not traceable",
49 [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS
) ] = "A session MUST be selected",
50 [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS
) ] = "Session name already exist",
51 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA
) ] = "Kernel tracer not available",
52 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL
) ] = "Kernel create session failed",
53 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL
) ] = "Kernel create channel failed",
54 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL
) ] = "Enable kernel event failed",
55 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL
) ] = "Disable kernel event failed",
56 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL
) ] = "Opening metadata failed",
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL
) ] = "Starting kernel trace failed",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL
) ] = "Stoping kernel trace failed",
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL
) ] = "Kernel consumer start failed",
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL
) ] = "Kernel create stream failed",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL
) ] = "Kernel trace directory creation failed",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST
) ] = "Kernel trace directory already exist",
63 [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY
) ] = "Kconsumerd command socket ready",
64 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD
) ] = "Kconsumerd success on receiving fds",
65 [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD
) ] = "Kconsumerd error on receiving fds",
66 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR
) ] = "Kconsumerd error in polling thread",
67 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL
) ] = "Kconsumerd polling on closed fd",
68 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP
) ] = "Kconsumerd all fd hung up",
69 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS
) ] = "Kconsumerd exiting normally",
70 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE
) ] = "Kconsumerd exiting on error",
71 [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR
) ] = "Kconsumerd error opening the tracefile",
72 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF
) ] = "Kconsumerd splice EBADF",
73 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL
) ] = "Kconsumerd splice EINVAL",
74 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM
) ] = "Kconsumerd splice ENOMEM",
75 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE
) ] = "Kconsumerd splice ESPIPE",
76 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT
) ] = "No event found",
80 * lttcom_get_readable_code
82 * Return ptr to string representing a human readable
83 * error code from the lttcomm_return_code enum.
85 * These code MUST be negative in other to treat that
88 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
92 if (tmp_code
>= LTTCOMM_OK
&& tmp_code
< LTTCOMM_NR
) {
93 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(tmp_code
)];
96 return "Unknown error code";
100 * lttcomm_connect_unix_sock
102 * Connect to unix socket using the path name.
104 int lttcomm_connect_unix_sock(const char *pathname
)
106 struct sockaddr_un sun
;
110 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
116 memset(&sun
, 0, sizeof(sun
));
117 sun
.sun_family
= AF_UNIX
;
118 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
120 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
133 * lttcomm_accept_unix_sock
135 * Do an accept(2) on the sock and return the
136 * new file descriptor. The socket MUST be bind(2) before.
138 int lttcomm_accept_unix_sock(int sock
)
141 struct sockaddr_un sun
;
145 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
158 * lttcomm_create_unix_sock
160 * Creates a AF_UNIX local socket using pathname
161 * bind the socket upon creation and return the fd.
163 int lttcomm_create_unix_sock(const char *pathname
)
165 struct sockaddr_un sun
;
169 /* Create server socket */
170 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
175 memset(&sun
, 0, sizeof(sun
));
176 sun
.sun_family
= AF_UNIX
;
177 strncpy(sun
.sun_path
, pathname
, strlen(pathname
));
179 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
192 * lttcomm_listen_unix_sock
194 * Make the socket listen using MAX_LISTEN.
196 int lttcomm_listen_unix_sock(int sock
)
200 ret
= listen(sock
, MAX_LISTEN
);
209 * lttcomm_recv_unix_sock
211 * Receive data of size len in put that data into
212 * the buf param. Using recvmsg API.
213 * Return the size of received data.
215 ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
221 memset(&msg
, 0, sizeof(msg
));
223 iov
[0].iov_base
= buf
;
224 iov
[0].iov_len
= len
;
228 ret
= recvmsg(sock
, &msg
, 0);
237 * lttcomm_send_unix_sock
239 * Send buf data of size len. Using sendmsg API.
240 * Return the size of sent data.
242 ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
)
248 memset(&msg
, 0, sizeof(msg
));
250 iov
[0].iov_base
= buf
;
251 iov
[0].iov_len
= len
;
255 ret
= sendmsg(sock
, &msg
, 0);
264 * lttcomm_close_unix_sock
266 * Shutdown cleanly a unix socket.
268 int lttcomm_close_unix_sock(int sock
)
272 /* Shutdown receptions and transmissions */
273 ret
= shutdown(sock
, SHUT_RDWR
);
282 * lttcomm_send_fds_unix_sock
284 * Send multiple fds on a unix socket.
286 ssize_t
lttcomm_send_fds_unix_sock(int sock
, void *buf
, int *fds
, size_t nb_fd
, size_t len
)
289 struct cmsghdr
*cmptr
;
292 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
293 char tmp
[CMSG_SPACE(sizeof_fds
)];
295 memset(&msg
, 0, sizeof(msg
));
297 msg
.msg_control
= (caddr_t
)tmp
;
298 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
300 cmptr
= CMSG_FIRSTHDR(&msg
);
301 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
302 cmptr
->cmsg_level
= SOL_SOCKET
;
303 cmptr
->cmsg_type
= SCM_RIGHTS
;
304 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
306 iov
[0].iov_base
= buf
;
307 iov
[0].iov_len
= len
;
311 ret
= sendmsg(sock
, &msg
, 0);