Fix: liblttng-ust-fork Makefile flags mismatch
[lttng-ust.git] / liblttng-ust-comm / lttng-ust-comm.c
index 2903d57574b68d3d11f839604a324fb81079bde2..db9910ded9c3fcf2a660fa77c5a35851df07fdc8 100644 (file)
@@ -1,19 +1,20 @@
 /*
  * 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 <unistd.h>
 #include <assert.h>
 #include <errno.h>
+#include <fcntl.h>
 
-#include <lttng/ust-comm.h>
+#include <ust-comm.h>
+#include <lttng/ust-error.h>
+
+#define USTCOMM_CODE_OFFSET(code)      \
+       (code == LTTNG_UST_OK ? 0 : (code - LTTNG_UST_ERR + 1))
 
 /*
  * Human readable error message.
  */
 static const char *ustcomm_readable_code[] = {
-       [ USTCOMM_ERR_INDEX(USTCOMM_ERR) ] = "Unknown error",
-       [ USTCOMM_ERR_INDEX(USTCOMM_UND) ] = "Undefined command",
-       [ USTCOMM_ERR_INDEX(USTCOMM_NOT_IMPLEMENTED) ] = "Not implemented",
-       [ USTCOMM_ERR_INDEX(USTCOMM_UNKNOWN_DOMAIN) ] = "Unknown tracing domain",
-       [ USTCOMM_ERR_INDEX(USTCOMM_NO_SESSION) ] = "No session found",
-       [ USTCOMM_ERR_INDEX(USTCOMM_LIST_FAIL) ] = "Unable to list traceable apps",
-       [ USTCOMM_ERR_INDEX(USTCOMM_NO_APPS) ] = "No traceable apps found",
-       [ USTCOMM_ERR_INDEX(USTCOMM_SESS_NOT_FOUND) ] = "Session name not found",
-       [ USTCOMM_ERR_INDEX(USTCOMM_NO_TRACE) ] = "No trace found",
-       [ USTCOMM_ERR_INDEX(USTCOMM_FATAL) ] = "Fatal error of the session daemon",
-       [ USTCOMM_ERR_INDEX(USTCOMM_CREATE_FAIL) ] = "Create trace failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_START_FAIL) ] = "Start trace failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_STOP_FAIL) ] = "Stop trace failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_NO_TRACEABLE) ] = "App is not traceable",
-       [ USTCOMM_ERR_INDEX(USTCOMM_SELECT_SESS) ] = "A session MUST be selected",
-       [ USTCOMM_ERR_INDEX(USTCOMM_EXIST_SESS) ] = "Session name already exist",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_NA) ] = "UST tracer not available",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_EVENT_EXIST) ] = "UST event already exists",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_SESS_FAIL) ] = "UST create session failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_CHAN_FAIL) ] = "UST create channel failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_CHAN_NOT_FOUND) ] = "UST channel not found",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_CHAN_DISABLE_FAIL) ] = "Disable UST channel failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_CHAN_ENABLE_FAIL) ] = "Enable UST channel failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_CONTEXT_FAIL) ] = "Add UST context failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_ENABLE_FAIL) ] = "Enable UST event failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_DISABLE_FAIL) ] = "Disable UST event failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_META_FAIL) ] = "Opening metadata failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_START_FAIL) ] = "Starting UST trace failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_STOP_FAIL) ] = "Stoping UST trace failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_CONSUMER_FAIL) ] = "UST consumer start failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_STREAM_FAIL) ] = "UST create stream failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_DIR_FAIL) ] = "UST trace directory creation failed",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_DIR_EXIST) ] = "UST trace directory already exist",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_NO_SESSION) ] = "No UST session found",
-       [ USTCOMM_ERR_INDEX(USTCOMM_KERN_LIST_FAIL) ] = "Listing UST events failed",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_COMMAND_SOCK_READY) ] = "UST consumer command socket ready",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_SUCCESS_RECV_FD) ] = "UST consumer success on receiving fds",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_ERROR_RECV_FD) ] = "UST consumer error on receiving fds",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_POLL_ERROR) ] = "UST consumer error in polling thread",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_POLL_NVAL) ] = "UST consumer polling on closed fd",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_POLL_HUP) ] = "UST consumer all fd hung up",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_EXIT_SUCCESS) ] = "UST consumer exiting normally",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_EXIT_FAILURE) ] = "UST consumer exiting on error",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_OUTFD_ERROR) ] = "UST consumer error opening the tracefile",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_SPLICE_EBADF) ] = "UST consumer splice EBADF",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_SPLICE_EINVAL) ] = "UST consumer splice EINVAL",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_SPLICE_ENOMEM) ] = "UST consumer splice ENOMEM",
-       [ USTCOMM_ERR_INDEX(USTCONSUMER_SPLICE_ESPIPE) ] = "UST consumer splice ESPIPE",
-       [ USTCOMM_ERR_INDEX(USTCOMM_NO_EVENT) ] = "Event not found",
+       [ 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 ustcomm_return_code enum.
+ * Receives positive error value.
+ * Return ptr to string representing a human readable
+ * error code from the ustcomm_return_code enum.
  */
-const char *ustcomm_get_readable_code(int code)
+const char *lttng_ust_strerror(int code)
 {
-       if (code == USTCOMM_OK) {
-               return "Success";
-       }
-       if (code >= USTCOMM_ERR && code < USTCOMM_NR) {
-               return ustcomm_readable_code[USTCOMM_ERR_INDEX(code)];
-       }
-       return strerror(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)];
+
 }
 
 /*
@@ -111,19 +77,24 @@ const char *ustcomm_get_readable_code(int code)
 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;
@@ -137,13 +108,21 @@ int ustcomm_connect_unix_sock(const char *pathname)
                 * 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;
 }
@@ -164,13 +143,9 @@ int ustcomm_accept_unix_sock(int sock)
        new_fd = accept(sock, (struct sockaddr *) &sun, &len);
        if (new_fd < 0) {
                perror("accept");
-               goto error;
+               return -errno;
        }
-
        return new_fd;
-
-error:
-       return -1;
 }
 
 /*
@@ -182,12 +157,12 @@ error:
 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;
        }
 
@@ -201,11 +176,21 @@ int ustcomm_create_unix_sock(const char *pathname)
        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;
 }
@@ -221,6 +206,7 @@ int ustcomm_listen_unix_sock(int sock)
 
        ret = listen(sock, LTTNG_UST_COMM_MAX_LISTEN);
        if (ret < 0) {
+               ret = -errno;
                perror("listen");
        }
 
@@ -236,18 +222,31 @@ int ustcomm_listen_unix_sock(int sock)
  */
 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;
@@ -261,9 +260,11 @@ ssize_t ustcomm_recv_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;
@@ -277,9 +278,20 @@ ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t 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;
@@ -294,10 +306,10 @@ 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;
@@ -310,15 +322,17 @@ int ustcomm_close_unix_sock(int sock)
  */
 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);
@@ -339,9 +353,20 @@ ssize_t ustcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd,
        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) {
-               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;
@@ -354,17 +379,16 @@ int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum)
        len = ustcomm_send_unix_sock(sock, lum, sizeof(*lum));
        switch (len) {
        case sizeof(*lum):
-               printf("message successfully sent\n");
                break;
-       case -1:
-               if (errno == ECONNRESET) {
-                       printf("remote end closed connection\n");
-                       return 0;
-               }
-               return -1;
        default:
-               printf("incorrect message size: %zd\n", len);
-               return -1;
+               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;
 }
@@ -378,34 +402,27 @@ int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
        len = ustcomm_recv_unix_sock(sock, lur, sizeof(*lur));
        switch (len) {
        case 0: /* orderly shutdown */
-               printf("Application has performed an orderly shutdown\n");
                return -EINVAL;
        case sizeof(*lur):
-               printf("result message received\n");
                if (lur->handle != expected_handle) {
-                       printf("Unexpected result message handle\n");
+                       fprintf(stderr, "Unexpected result message handle\n");
                        return -EINVAL;
                }
-
                if (lur->cmd != expected_cmd) {
-                       printf("Unexpected result message command\n");
+                       fprintf(stderr, "Unexpected result message command\n");
                        return -EINVAL;
                }
-               if (lur->ret_code != USTCOMM_OK) {
-                       printf("remote operation failed with code %d.\n",
-                               lur->ret_code);
-                       return lur->ret_code;
-               }
-               return 0;
-       case -1:
-               if (errno == ECONNRESET) {
-                       printf("remote end closed connection\n");
-                       return -EINVAL;
-               }
-               return -1;
+               return lur->ret_code;
        default:
-               printf("incorrect message size: %zd\n", len);
-               return len > 0 ? -1 : len;
+               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;
+               }
        }
 }
 
@@ -419,16 +436,16 @@ int ustcomm_send_app_cmd(int sock,
        if (ret)
                return ret;
        ret = ustcomm_recv_app_reply(sock, lur, lum->handle, lum->cmd);
-       if (ret)
-               return ret;
-       return 0;
+       if (ret > 0)
+               return -EIO;
+       return ret;
 }
 
-
 /*
  * Receives a single fd from socket.
  *
- * Returns the size of received data
+ * Returns negative error value on error, or file descriptor number on
+ * success.
  */
 int ustcomm_recv_fd(int sock)
 {
@@ -437,13 +454,15 @@ int ustcomm_recv_fd(int sock)
        int data_fd;
        struct cmsghdr *cmsg;
        char recv_fd[CMSG_SPACE(sizeof(int))];
-       struct msghdr msg = { 0 };
+       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);
@@ -452,31 +471,47 @@ int ustcomm_recv_fd(int sock)
        msg.msg_control = recv_fd;
        msg.msg_controllen = sizeof(recv_fd);
 
-       printf("Waiting to receive fd\n");
-       if ((ret = recvmsg(sock, &msg, 0)) < 0) {
-               perror("recvmsg");
+       do {
+               ret = recvmsg(sock, &msg, 0);
+       } while (ret < 0 && errno == EINTR);
+       if (ret < 0) {
+               if (errno != EPIPE) {
+                       perror("recvmsg");
+               }
+               ret = -errno;
                goto end;
        }
        if (ret != sizeof(data_fd)) {
-               printf("Received %d bytes, expected %ld", 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) {
-               printf("Invalid control message header\n");
-               ret = -1;
+               fprintf(stderr, "Invalid control message header\n");
+               ret = -EINVAL;
                goto end;
        }
        if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) {
-               printf("Didn't received any fd\n");
-               ret = -1;
+               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;
-       printf("received fd %d\n", ret);
+       /*
+        * 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;
 }
This page took 0.039458 seconds and 4 git commands to generate.