/*
* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; only version 2
- * of the License.
- *
- * This program is distributed in the hope that it will be useful,
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; only
+ * version 2.1 of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#define _GNU_SOURCE
#include <sys/un.h>
#include <unistd.h>
#include <assert.h>
+#include <errno.h>
+#include <fcntl.h>
+
+#include <ust-comm.h>
+#include <lttng/ust-error.h>
-#include <lttng-ust-comm.h>
+#define USTCOMM_CODE_OFFSET(code) \
+ (code == LTTNG_UST_OK ? 0 : (code - LTTNG_UST_ERR + 1))
/*
* Human readable error message.
*/
-static const char *lttcomm_readable_code[] = {
- [ LTTCOMM_ERR_INDEX(LTTCOMM_OK) ] = "Success",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR) ] = "Unknown error",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_UND) ] = "Undefined command",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_NOT_IMPLEMENTED) ] = "Not implemented",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_UNKNOWN_DOMAIN) ] = "Unknown tracing domain",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION) ] = "No session found",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL) ] = "Unable to list traceable apps",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS) ] = "No traceable apps found",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND) ] = "Session name not found",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE) ] = "No trace found",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL) ] = "Fatal error of the session daemon",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_FAIL) ] = "Create trace failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL) ] = "Start trace failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL) ] = "Stop trace failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE) ] = "App is not traceable",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS) ] = "A session MUST be selected",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS) ] = "Session name already exist",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA) ] = "Kernel tracer not available",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST) ] = "Kernel event already exists",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL) ] = "Kernel create session failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL) ] = "Kernel create channel failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND) ] = "Kernel channel not found",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL) ] = "Disable kernel channel failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL) ] = "Enable kernel channel failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL) ] = "Add kernel context failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL) ] = "Enable kernel event failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL) ] = "Disable kernel event failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL) ] = "Opening metadata failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL) ] = "Starting kernel trace failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL) ] = "Stoping kernel trace failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL) ] = "Kernel create stream failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL) ] = "Kernel trace directory creation failed",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST) ] = "Kernel trace directory already exist",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION) ] = "No kernel session found",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL) ] = "Listing kernel events failed",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY) ] = "Kconsumerd command socket ready",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD) ] = "Kconsumerd success on receiving fds",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD) ] = "Kconsumerd error on receiving fds",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR) ] = "Kconsumerd error in polling thread",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL) ] = "Kconsumerd polling on closed fd",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP) ] = "Kconsumerd all fd hung up",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS) ] = "Kconsumerd exiting normally",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE) ] = "Kconsumerd exiting on error",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR) ] = "Kconsumerd error opening the tracefile",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF) ] = "Kconsumerd splice EBADF",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL) ] = "Kconsumerd splice EINVAL",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM) ] = "Kconsumerd splice ENOMEM",
- [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE) ] = "Kconsumerd splice ESPIPE",
- [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "Event not found",
+static const char *ustcomm_readable_code[] = {
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_OK) ] = "Success",
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR) ] = "Unknown error",
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOENT) ] = "No entry",
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXIST) ] = "Object already exists",
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL) ] = "Invalid argument",
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PERM) ] = "Permission denied",
+ [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOSYS) ] = "Not implemented",
};
/*
- * lttcom_get_readable_code
+ * lttng_ust_strerror
*
- * Return ptr to string representing a human readable
- * error code from the lttcomm_return_code enum.
- *
- * These code MUST be negative in other to treat that
- * as an error value.
+ * Receives positive error value.
+ * Return ptr to string representing a human readable
+ * error code from the ustcomm_return_code enum.
*/
-const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
+const char *lttng_ust_strerror(int code)
{
- int tmp_code = -code;
+ if (code == LTTNG_UST_OK)
+ return ustcomm_readable_code[USTCOMM_CODE_OFFSET(code)];
+ if (code < LTTNG_UST_ERR)
+ return strerror(code);
+ if (code >= LTTNG_UST_ERR_NR)
+ code = LTTNG_UST_ERR;
+ return ustcomm_readable_code[USTCOMM_CODE_OFFSET(code)];
- if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) {
- return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)];
- }
-
- return "Unknown error code";
}
/*
- * lttcomm_connect_unix_sock
+ * ustcomm_connect_unix_sock
*
* Connect to unix socket using the path name.
*/
-int lttcomm_connect_unix_sock(const char *pathname)
+int ustcomm_connect_unix_sock(const char *pathname)
{
struct sockaddr_un sun;
- int fd;
- int ret;
+ int fd, ret;
/*
* libust threads require the close-on-exec flag for all
* resources so it does not leak file descriptors upon exec.
*/
- fd = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0);
+ fd = socket(PF_UNIX, SOCK_STREAM, 0);
if (fd < 0) {
perror("socket");
- ret = fd;
+ ret = -errno;
goto error;
}
+ ret = fcntl(fd, F_SETFD, FD_CLOEXEC);
+ if (ret < 0) {
+ perror("fcntl");
+ ret = -errno;
+ goto error_fcntl;
+ }
memset(&sun, 0, sizeof(sun));
sun.sun_family = AF_UNIX;
* is used in normal execution to detect if sessiond is
* alive.
*/
+ ret = -errno;
goto error_connect;
}
return fd;
error_connect:
- close(fd);
+error_fcntl:
+ {
+ int closeret;
+
+ closeret = close(fd);
+ if (closeret)
+ perror("close");
+ }
error:
return ret;
}
/*
- * lttcomm_accept_unix_sock
+ * ustcomm_accept_unix_sock
*
* Do an accept(2) on the sock and return the
* new file descriptor. The socket MUST be bind(2) before.
*/
-int lttcomm_accept_unix_sock(int sock)
+int ustcomm_accept_unix_sock(int sock)
{
int new_fd;
struct sockaddr_un sun;
new_fd = accept(sock, (struct sockaddr *) &sun, &len);
if (new_fd < 0) {
perror("accept");
- goto error;
+ return -errno;
}
-
return new_fd;
-
-error:
- return -1;
}
/*
- * lttcomm_create_unix_sock
+ * ustcomm_create_unix_sock
*
* Creates a AF_UNIX local socket using pathname
* bind the socket upon creation and return the fd.
*/
-int lttcomm_create_unix_sock(const char *pathname)
+int ustcomm_create_unix_sock(const char *pathname)
{
struct sockaddr_un sun;
- int fd;
- int ret = -1;
+ int fd, ret;
/* Create server socket */
if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
perror("socket");
+ ret = -errno;
goto error;
}
ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
if (ret < 0) {
perror("bind");
- goto error;
+ ret = -errno;
+ goto error_close;
}
return fd;
+error_close:
+ {
+ int closeret;
+
+ closeret = close(fd);
+ if (closeret) {
+ perror("close");
+ }
+ }
error:
return ret;
}
/*
- * lttcomm_listen_unix_sock
+ * ustcomm_listen_unix_sock
*
- * Make the socket listen using MAX_LISTEN.
+ * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN.
*/
-int lttcomm_listen_unix_sock(int sock)
+int ustcomm_listen_unix_sock(int sock)
{
int ret;
- ret = listen(sock, MAX_LISTEN);
+ ret = listen(sock, LTTNG_UST_COMM_MAX_LISTEN);
if (ret < 0) {
+ ret = -errno;
perror("listen");
}
}
/*
- * lttcomm_recv_unix_sock
+ * ustcomm_recv_unix_sock
*
* Receive data of size len in put that data into
* the buf param. Using recvmsg API.
* Return the size of received data.
*/
-ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len)
+ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
{
- struct msghdr msg = { 0 };
+ struct msghdr msg;
struct iovec iov[1];
- ssize_t ret = -1;
+ ssize_t ret;
+
+ memset(&msg, 0, sizeof(msg));
iov[0].iov_base = buf;
iov[0].iov_len = len;
msg.msg_iov = iov;
msg.msg_iovlen = 1;
- ret = recvmsg(sock, &msg, 0);
+ do {
+ ret = recvmsg(sock, &msg, 0);
+ } while (ret < 0 && errno == EINTR);
+
if (ret < 0) {
- perror("recvmsg");
+ int shutret;
+
+ if (errno != EPIPE)
+ perror("recvmsg");
+ ret = -errno;
+
+ shutret = shutdown(sock, SHUT_RDWR);
+ if (shutret)
+ fprintf(stderr, "Socket shutdown error");
}
return ret;
}
/*
- * lttcomm_send_unix_sock
+ * ustcomm_send_unix_sock
*
* Send buf data of size len. Using sendmsg API.
* Return the size of sent data.
*/
-ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len)
+ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len)
{
- struct msghdr msg = { 0 };
+ struct msghdr msg;
struct iovec iov[1];
- ssize_t ret = -1;
+ ssize_t ret;
+
+ memset(&msg, 0, sizeof(msg));
iov[0].iov_base = buf;
iov[0].iov_len = len;
* by ignoring SIGPIPE, but we don't have this luxury on the
* libust side.
*/
- ret = sendmsg(sock, &msg, MSG_NOSIGNAL);
+ do {
+ ret = sendmsg(sock, &msg, MSG_NOSIGNAL);
+ } while (ret < 0 && errno == EINTR);
+
if (ret < 0) {
- perror("sendmsg");
+ int shutret;
+
+ if (errno != EPIPE)
+ perror("recvmsg");
+ ret = -errno;
+
+ shutret = shutdown(sock, SHUT_RDWR);
+ if (shutret)
+ fprintf(stderr, "Socket shutdown error");
}
return ret;
}
/*
- * lttcomm_close_unix_sock
+ * ustcomm_close_unix_sock
*
* Shutdown cleanly a unix socket.
*/
-int lttcomm_close_unix_sock(int sock)
+int ustcomm_close_unix_sock(int sock)
{
int ret;
- /* Shutdown receptions and transmissions */
- ret = shutdown(sock, SHUT_RDWR);
+ ret = close(sock);
if (ret < 0) {
- perror("shutdown");
+ perror("close");
+ ret = -errno;
}
return ret;
}
/*
- * lttcomm_send_fds_unix_sock
+ * ustcomm_send_fds_unix_sock
*
* Send multiple fds on a unix socket.
*/
-ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, size_t len)
+ssize_t ustcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, size_t len)
{
- struct msghdr msg = { 0 };
+ struct msghdr msg;
struct cmsghdr *cmptr;
struct iovec iov[1];
ssize_t ret = -1;
unsigned int sizeof_fds = nb_fd * sizeof(int);
char tmp[CMSG_SPACE(sizeof_fds)];
+ memset(&msg, 0, sizeof(msg));
+
/*
- * Note: the consumerd receiver only supports receiving one FD per
+ * Note: we currently only support sending a single FD per
* message.
*/
assert(nb_fd == 1);
msg.msg_iov = iov;
msg.msg_iovlen = 1;
- ret = sendmsg(sock, &msg, 0);
+ do {
+ ret = sendmsg(sock, &msg, MSG_NOSIGNAL);
+ } while (ret < 0 && errno == EINTR);
+
+ if (ret < 0) {
+ int shutret;
+
+ if (errno != EPIPE)
+ perror("recvmsg");
+ ret = -errno;
+
+ shutret = shutdown(sock, SHUT_RDWR);
+ if (shutret)
+ fprintf(stderr, "Socket shutdown error");
+ }
+
+ return ret;
+}
+
+int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum)
+{
+ ssize_t len;
+
+ len = ustcomm_send_unix_sock(sock, lum, sizeof(*lum));
+ switch (len) {
+ case sizeof(*lum):
+ break;
+ default:
+ if (len < 0) {
+ if (len == -ECONNRESET)
+ fprintf(stderr, "remote end closed connection\n");
+ return len;
+ } else {
+ fprintf(stderr, "incorrect message size: %zd\n", len);
+ return -EINVAL;
+ }
+ }
+ return 0;
+}
+
+int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
+ uint32_t expected_handle, uint32_t expected_cmd)
+{
+ ssize_t len;
+
+ memset(lur, 0, sizeof(*lur));
+ len = ustcomm_recv_unix_sock(sock, lur, sizeof(*lur));
+ switch (len) {
+ case 0: /* orderly shutdown */
+ return -EINVAL;
+ case sizeof(*lur):
+ if (lur->handle != expected_handle) {
+ fprintf(stderr, "Unexpected result message handle\n");
+ return -EINVAL;
+ }
+ if (lur->cmd != expected_cmd) {
+ fprintf(stderr, "Unexpected result message command\n");
+ return -EINVAL;
+ }
+ return lur->ret_code;
+ default:
+ if (len < 0) {
+ /* Transport level error */
+ if (len == -ECONNRESET)
+ fprintf(stderr, "remote end closed connection\n");
+ return len;
+ } else {
+ fprintf(stderr, "incorrect message size: %zd\n", len);
+ return len;
+ }
+ }
+}
+
+int ustcomm_send_app_cmd(int sock,
+ struct ustcomm_ust_msg *lum,
+ struct ustcomm_ust_reply *lur)
+{
+ int ret;
+
+ ret = ustcomm_send_app_msg(sock, lum);
+ if (ret)
+ return ret;
+ return ustcomm_recv_app_reply(sock, lur, lum->handle, lum->cmd);
+}
+
+/*
+ * Receives a single fd from socket.
+ *
+ * Returns negative error value on error, or file descriptor number on
+ * success.
+ */
+int ustcomm_recv_fd(int sock)
+{
+ struct iovec iov[1];
+ int ret = 0;
+ int data_fd;
+ struct cmsghdr *cmsg;
+ char recv_fd[CMSG_SPACE(sizeof(int))];
+ struct msghdr msg;
+ union {
+ unsigned char vc[4];
+ int vi;
+ } tmp;
+ int i;
+
+ memset(&msg, 0, sizeof(msg));
+
+ /* Prepare to receive the structures */
+ iov[0].iov_base = &data_fd;
+ iov[0].iov_len = sizeof(data_fd);
+ msg.msg_iov = iov;
+ msg.msg_iovlen = 1;
+ msg.msg_control = recv_fd;
+ msg.msg_controllen = sizeof(recv_fd);
+
+ do {
+ ret = recvmsg(sock, &msg, 0);
+ } while (ret < 0 && errno == EINTR);
if (ret < 0) {
- perror("sendmsg");
+ if (errno != EPIPE) {
+ perror("recvmsg");
+ }
+ ret = -errno;
+ goto end;
+ }
+ if (ret != sizeof(data_fd)) {
+ fprintf(stderr, "Received %d bytes, expected %zd", ret, sizeof(data_fd));
+ ret = -EINVAL;
+ goto end;
+ }
+ cmsg = CMSG_FIRSTHDR(&msg);
+ if (!cmsg) {
+ fprintf(stderr, "Invalid control message header\n");
+ ret = -EINVAL;
+ goto end;
+ }
+ if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) {
+ fprintf(stderr, "Didn't received any fd\n");
+ ret = -EINVAL;
+ goto end;
}
+ /* this is our fd */
+ for (i = 0; i < sizeof(int); i++)
+ tmp.vc[i] = CMSG_DATA(cmsg)[i];
+ ret = tmp.vi;
+ /*
+ * Useful for fd leak debug.
+ * fprintf(stderr, "received fd %d\n", ret);
+ */
+end:
+ if (ret < 0) {
+ int shutret;
+ shutret = shutdown(sock, SHUT_RDWR);
+ if (shutret)
+ fprintf(stderr, "Socket shutdown error");
+ }
return ret;
}