Fix: lttng-ust-comm.c: return number of fd rather size of array
[lttng-ust.git] / liblttng-ust-comm / lttng-ust-comm.c
index f469567690b3a9a88a2d7f4252417e130a1c6975..5b9cb85381fcb815998c7ecaa733a52a7d2a31e7 100644 (file)
@@ -19,6 +19,7 @@
 
 #define _GNU_SOURCE
 #include <limits.h>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <errno.h>
 #include <fcntl.h>
 
+#include <lttng/ust-ctl.h>
 #include <ust-comm.h>
+#include <ust-fd.h>
 #include <helper.h>
 #include <lttng/ust-error.h>
+#include <lttng/ust-events.h>
+#include <lttng/ust-dynamic-type.h>
+#include <usterr-signal-safe.h>
+
+#include "../liblttng-ust/compat.h"
 
 #define USTCOMM_CODE_OFFSET(code)      \
        (code == LTTNG_UST_OK ? 0 : (code - LTTNG_UST_ERR + 1))
 
 #define USTCOMM_MAX_SEND_FDS   4
 
+static
+ssize_t count_fields_recursive(size_t nr_fields,
+               const struct lttng_event_field *lttng_fields);
+static
+int serialize_one_field(struct lttng_session *session,
+               struct ustctl_field *fields, size_t *iter_output,
+               const struct lttng_event_field *lf);
+
 /*
  * Human readable error message.
  */
@@ -52,6 +68,10 @@ static const char *ustcomm_readable_code[] = {
        [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PERM) ] = "Permission denied",
        [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOSYS) ] = "Not implemented",
        [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXITING) ] = "Process is exiting",
+
+       [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_MAGIC) ] = "Invalid magic number",
+       [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_SOCKET_TYPE) ] = "Invalid socket type",
+       [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_UNSUP_MAJOR) ] = "Unsupported major version",
 };
 
 /*
@@ -70,15 +90,16 @@ const char *lttng_ust_strerror(int code)
        if (code >= LTTNG_UST_ERR_NR)
                code = LTTNG_UST_ERR;
        return ustcomm_readable_code[USTCOMM_CODE_OFFSET(code)];
-
 }
 
 /*
  * ustcomm_connect_unix_sock
  *
  * Connect to unix socket using the path name.
+ *
+ * Caller handles FD tracker.
  */
-int ustcomm_connect_unix_sock(const char *pathname)
+int ustcomm_connect_unix_sock(const char *pathname, long timeout)
 {
        struct sockaddr_un sun;
        int fd, ret;
@@ -89,13 +110,22 @@ int ustcomm_connect_unix_sock(const char *pathname)
         */
        fd = socket(PF_UNIX, SOCK_STREAM, 0);
        if (fd < 0) {
-               perror("socket");
+               PERROR("socket");
                ret = -errno;
                goto error;
        }
+       if (timeout >= 0) {
+               /* Give at least 10ms. */
+               if (timeout < 10)
+                       timeout = 10;
+               ret = ustcomm_setsockopt_snd_timeout(fd, timeout);
+               if (ret < 0) {
+                       WARN("Error setting connect socket send timeout");
+               }
+       }
        ret = fcntl(fd, F_SETFD, FD_CLOEXEC);
        if (ret < 0) {
-               perror("fcntl");
+               PERROR("fcntl");
                ret = -errno;
                goto error_fcntl;
        }
@@ -108,11 +138,18 @@ int ustcomm_connect_unix_sock(const char *pathname)
        ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun));
        if (ret < 0) {
                /*
-                * Don't print message on connect error, because connect
-                * is used in normal execution to detect if sessiond is
-                * alive.
+                * Don't print message on connect ENOENT error, because
+                * connect is used in normal execution to detect if
+                * sessiond is alive. ENOENT is when the unix socket
+                * file does not exist, and ECONNREFUSED is when the
+                * file exists but no sessiond is listening.
                 */
+               if (errno != ECONNREFUSED && errno != ECONNRESET
+                               && errno != ENOENT && errno != EACCES)
+                       PERROR("connect");
                ret = -errno;
+               if (ret == -ECONNREFUSED || ret == -ECONNRESET)
+                       ret = -EPIPE;
                goto error_connect;
        }
 
@@ -125,7 +162,7 @@ error_fcntl:
 
                closeret = close(fd);
                if (closeret)
-                       perror("close");
+                       PERROR("close");
        }
 error:
        return ret;
@@ -146,8 +183,11 @@ int ustcomm_accept_unix_sock(int sock)
        /* Blocking call */
        new_fd = accept(sock, (struct sockaddr *) &sun, &len);
        if (new_fd < 0) {
-               perror("accept");
-               return -errno;
+               if (errno != ECONNABORTED)
+                       PERROR("accept");
+               new_fd = -errno;
+               if (new_fd == -ECONNABORTED)
+                       new_fd = -EPIPE;
        }
        return new_fd;
 }
@@ -165,7 +205,7 @@ int ustcomm_create_unix_sock(const char *pathname)
 
        /* Create server socket */
        if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
-               perror("socket");
+               PERROR("socket");
                ret = -errno;
                goto error;
        }
@@ -179,7 +219,7 @@ int ustcomm_create_unix_sock(const char *pathname)
        (void) unlink(pathname);
        ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
        if (ret < 0) {
-               perror("bind");
+               PERROR("bind");
                ret = -errno;
                goto error_close;
        }
@@ -192,7 +232,7 @@ error_close:
 
                closeret = close(fd);
                if (closeret) {
-                       perror("close");
+                       PERROR("close");
                }
        }
 error:
@@ -211,7 +251,7 @@ int ustcomm_listen_unix_sock(int sock)
        ret = listen(sock, LTTNG_UST_COMM_MAX_LISTEN);
        if (ret < 0) {
                ret = -errno;
-               perror("listen");
+               PERROR("listen");
        }
 
        return ret;
@@ -221,16 +261,22 @@ int ustcomm_listen_unix_sock(int sock)
  * ustcomm_close_unix_sock
  *
  * Shutdown cleanly a unix socket.
+ *
+ * Handles fd tracker internally.
  */
 int ustcomm_close_unix_sock(int sock)
 {
        int ret;
 
+       lttng_ust_lock_fd_tracker();
        ret = close(sock);
-       if (ret < 0) {
-               perror("close");
+       if (!ret) {
+               lttng_ust_delete_fd_from_tracker(sock);
+       } else {
+               PERROR("close");
                ret = -errno;
        }
+       lttng_ust_unlock_fd_tracker();
 
        return ret;
 }
@@ -247,7 +293,8 @@ ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
 {
        struct msghdr msg;
        struct iovec iov[1];
-       ssize_t ret;
+       ssize_t ret = -1;
+       size_t len_last;
 
        memset(&msg, 0, sizeof(msg));
 
@@ -257,20 +304,31 @@ ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
        msg.msg_iovlen = 1;
 
        do {
+               len_last = iov[0].iov_len;
                ret = recvmsg(sock, &msg, 0);
-       } while (ret < 0 && errno == EINTR);
+               if (ret > 0) {
+                       iov[0].iov_base += ret;
+                       iov[0].iov_len -= ret;
+                       assert(ret <= len_last);
+               }
+       } while ((ret > 0 && ret < len_last) || (ret < 0 && errno == EINTR));
 
        if (ret < 0) {
                int shutret;
 
-               if (errno != EPIPE && errno != ECONNRESET)
-                       perror("recvmsg");
+               if (errno != EPIPE && errno != ECONNRESET && errno != ECONNREFUSED)
+                       PERROR("recvmsg");
                ret = -errno;
+               if (ret == -ECONNRESET || ret == -ECONNREFUSED)
+                       ret = -EPIPE;
 
                shutret = shutdown(sock, SHUT_RDWR);
                if (shutret)
-                       fprintf(stderr, "Socket shutdown error");
+                       ERR("Socket shutdown error");
+       } else if (ret > 0) {
+               ret = len;
        }
+       /* ret = 0 means an orderly shutdown. */
 
        return ret;
 }
@@ -281,7 +339,7 @@ ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
  * Send buf data of size len. Using sendmsg API.
  * Return the size of sent data.
  */
-ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len)
+ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len)
 {
        struct msghdr msg;
        struct iovec iov[1];
@@ -289,7 +347,7 @@ ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len)
 
        memset(&msg, 0, sizeof(msg));
 
-       iov[0].iov_base = buf;
+       iov[0].iov_base = (void *) buf;
        iov[0].iov_len = len;
        msg.msg_iov = iov;
        msg.msg_iovlen = 1;
@@ -309,12 +367,14 @@ ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len)
                int shutret;
 
                if (errno != EPIPE && errno != ECONNRESET)
-                       perror("sendmsg");
+                       PERROR("sendmsg");
                ret = -errno;
+               if (ret == -ECONNRESET)
+                       ret = -EPIPE;
 
                shutret = shutdown(sock, SHUT_RDWR);
                if (shutret)
-                       fprintf(stderr, "Socket shutdown error");
+                       ERR("Socket shutdown error");
        }
 
        return ret;
@@ -345,6 +405,8 @@ ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
        msg.msg_controllen = CMSG_LEN(sizeof_fds);
 
        cmptr = CMSG_FIRSTHDR(&msg);
+       if (!cmptr)
+               return -EINVAL;
        cmptr->cmsg_level = SOL_SOCKET;
        cmptr->cmsg_type = SCM_RIGHTS;
        cmptr->cmsg_len = CMSG_LEN(sizeof_fds);
@@ -358,15 +420,18 @@ ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
        msg.msg_iovlen = 1;
 
        do {
-               ret = sendmsg(sock, &msg, 0);
+               ret = sendmsg(sock, &msg, MSG_NOSIGNAL);
        } while (ret < 0 && errno == EINTR);
        if (ret < 0) {
                /*
                 * We consider EPIPE and ECONNRESET as expected.
                 */
                if (errno != EPIPE && errno != ECONNRESET) {
-                       perror("sendmsg");
+                       PERROR("sendmsg");
                }
+               ret = -errno;
+               if (ret == -ECONNRESET)
+                       ret = -EPIPE;
        }
        return ret;
 }
@@ -374,8 +439,6 @@ ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
 /*
  * Recv a message accompanied by fd(s) from a unix socket.
  *
- * Returns the size of received data, or negative error value.
- *
  * Expect at most "nb_fd" file descriptors. Returns the number of fd
  * actually received in nb_fd.
  * Returns -EPIPE on orderly shutdown.
@@ -405,10 +468,11 @@ ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd)
        } while (ret < 0 && errno == EINTR);
        if (ret < 0) {
                if (errno != EPIPE && errno != ECONNRESET) {
-                       perror("recvmsg fds");
+                       PERROR("recvmsg fds");
                }
-               if (errno == EPIPE || errno == ECONNRESET)
-                       ret = -errno;
+               ret = -errno;
+               if (ret == -ECONNRESET)
+                       ret = -EPIPE;
                goto end;
        }
        if (ret == 0) {
@@ -417,34 +481,34 @@ ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd)
                goto end;
        }
        if (ret != 1) {
-               fprintf(stderr, "Error: Received %zd bytes, expected %d\n",
+               ERR("Error: Received %zd bytes, expected %d\n",
                                ret, 1);
                goto end;
        }
        if (msg.msg_flags & MSG_CTRUNC) {
-               fprintf(stderr, "Error: Control message truncated.\n");
+               ERR("Error: Control message truncated.\n");
                ret = -1;
                goto end;
        }
        cmsg = CMSG_FIRSTHDR(&msg);
        if (!cmsg) {
-               fprintf(stderr, "Error: Invalid control message header\n");
+               ERR("Error: Invalid control message header\n");
                ret = -1;
                goto end;
        }
        if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) {
-               fprintf(stderr, "Didn't received any fd\n");
+               ERR("Didn't received any fd\n");
                ret = -1;
                goto end;
        }
        if (cmsg->cmsg_len != CMSG_LEN(sizeof_fds)) {
-               fprintf(stderr, "Error: Received %zu bytes of ancillary data, expected %zu\n",
+               ERR("Error: Received %zu bytes of ancillary data, expected %zu\n",
                                (size_t) cmsg->cmsg_len, (size_t) CMSG_LEN(sizeof_fds));
                ret = -1;
                goto end;
        }
        memcpy(fds, CMSG_DATA(cmsg), sizeof_fds);
-       ret = sizeof_fds;
+       ret = nb_fd;
 end:
        return ret;
 }
@@ -461,7 +525,7 @@ int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum)
                if (len < 0) {
                        return len;
                } else {
-                       fprintf(stderr, "incorrect message size: %zd\n", len);
+                       ERR("incorrect message size: %zd\n", len);
                        return -EINVAL;
                }
        }
@@ -479,29 +543,32 @@ int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
        case 0: /* orderly shutdown */
                return -EPIPE;
        case sizeof(*lur):
+       {
+               int err = 0;
+
                if (lur->handle != expected_handle) {
-                       fprintf(stderr, "Unexpected result message handle: "
+                       ERR("Unexpected result message handle: "
                                "expected: %u vs received: %u\n",
                                expected_handle, lur->handle);
-                       return -EINVAL;
+                       err = 1;
                }
                if (lur->cmd != expected_cmd) {
-                       fprintf(stderr, "Unexpected result message command "
+                       ERR("Unexpected result message command "
                                "expected: %u vs received: %u\n",
                                expected_cmd, lur->cmd);
+                       err = 1;
+               }
+               if (err) {
                        return -EINVAL;
+               } else {
+                       return lur->ret_code;
                }
-               return lur->ret_code;
+       }
        default:
-               if (len < 0) {
-                       /* Transport level error */
-                       if (errno == EPIPE || errno == ECONNRESET)
-                               len = -errno;
-                       return len;
-               } else {
-                       fprintf(stderr, "incorrect message size: %zd\n", len);
-                       return len;
+               if (len >= 0) {
+                       ERR("incorrect message size: %zd\n", len);
                }
+               return len;
        }
 }
 
@@ -525,10 +592,12 @@ int ustcomm_send_app_cmd(int sock,
  * expected var_len.
  */
 ssize_t ustcomm_recv_channel_from_sessiond(int sock,
-               void **_chan_data, uint64_t var_len)
+               void **_chan_data, uint64_t var_len,
+               int *_wakeup_fd)
 {
        void *chan_data;
-       ssize_t len;
+       ssize_t len, nr_fd;
+       int wakeup_fd, ret;
 
        if (var_len > LTTNG_UST_CHANNEL_DATA_MAX_LEN) {
                len = -EINVAL;
@@ -544,6 +613,34 @@ ssize_t ustcomm_recv_channel_from_sessiond(int sock,
        if (len != var_len) {
                goto error_recv;
        }
+       /* recv wakeup fd */
+       lttng_ust_lock_fd_tracker();
+       nr_fd = ustcomm_recv_fds_unix_sock(sock, &wakeup_fd, 1);
+       if (nr_fd <= 0) {
+               lttng_ust_unlock_fd_tracker();
+               if (nr_fd < 0) {
+                       len = nr_fd;
+                       goto error_recv;
+               } else {
+                       len = -EIO;
+                       goto error_recv;
+               }
+       }
+
+       ret = lttng_ust_add_fd_to_tracker(wakeup_fd);
+       if (ret < 0) {
+               ret = close(wakeup_fd);
+               if (ret) {
+                       PERROR("close on wakeup_fd");
+               }
+               len = -EIO;
+               lttng_ust_unlock_fd_tracker();
+               goto error_recv;
+       }
+
+       *_wakeup_fd = ret;
+       lttng_ust_unlock_fd_tracker();
+
        *_chan_data = chan_data;
        return len;
 
@@ -563,8 +660,10 @@ int ustcomm_recv_stream_from_sessiond(int sock,
        int fds[2];
 
        /* recv shm fd and wakeup fd */
+       lttng_ust_lock_fd_tracker();
        len = ustcomm_recv_fds_unix_sock(sock, fds, 2);
        if (len <= 0) {
+               lttng_ust_unlock_fd_tracker();
                if (len < 0) {
                        ret = len;
                        goto error;
@@ -573,10 +672,940 @@ int ustcomm_recv_stream_from_sessiond(int sock,
                        goto error;
                }
        }
-       *shm_fd = fds[0];
-       *wakeup_fd = fds[1];
+
+       ret = lttng_ust_add_fd_to_tracker(fds[0]);
+       if (ret < 0) {
+               ret = close(fds[0]);
+               if (ret) {
+                       PERROR("close on received shm_fd");
+               }
+               ret = -EIO;
+               lttng_ust_unlock_fd_tracker();
+               goto error;
+       }
+       *shm_fd = ret;
+
+       ret = lttng_ust_add_fd_to_tracker(fds[1]);
+       if (ret < 0) {
+               ret = close(*shm_fd);
+               if (ret) {
+                       PERROR("close on shm_fd");
+               }
+               *shm_fd = -1;
+               ret = close(fds[1]);
+               if (ret) {
+                       PERROR("close on received wakeup_fd");
+               }
+               ret = -EIO;
+               lttng_ust_unlock_fd_tracker();
+               goto error;
+       }
+       *wakeup_fd = ret;
+       lttng_ust_unlock_fd_tracker();
        return 0;
 
 error:
        return ret;
 }
+
+/*
+ * Returns 0 on success, negative error value on error.
+ */
+int ustcomm_send_reg_msg(int sock,
+               enum ustctl_socket_type type,
+               uint32_t bits_per_long,
+               uint32_t uint8_t_alignment,
+               uint32_t uint16_t_alignment,
+               uint32_t uint32_t_alignment,
+               uint32_t uint64_t_alignment,
+               uint32_t long_alignment)
+{
+       ssize_t len;
+       struct ustctl_reg_msg reg_msg;
+
+       reg_msg.magic = LTTNG_UST_COMM_MAGIC;
+       reg_msg.major = LTTNG_UST_ABI_MAJOR_VERSION;
+       reg_msg.minor = LTTNG_UST_ABI_MINOR_VERSION;
+       reg_msg.pid = getpid();
+       reg_msg.ppid = getppid();
+       reg_msg.uid = getuid();
+       reg_msg.gid = getgid();
+       reg_msg.bits_per_long = bits_per_long;
+       reg_msg.uint8_t_alignment = uint8_t_alignment;
+       reg_msg.uint16_t_alignment = uint16_t_alignment;
+       reg_msg.uint32_t_alignment = uint32_t_alignment;
+       reg_msg.uint64_t_alignment = uint64_t_alignment;
+       reg_msg.long_alignment = long_alignment;
+       reg_msg.socket_type = type;
+       lttng_ust_getprocname(reg_msg.name);
+       memset(reg_msg.padding, 0, sizeof(reg_msg.padding));
+
+       len = ustcomm_send_unix_sock(sock, &reg_msg, sizeof(reg_msg));
+       if (len > 0 && len != sizeof(reg_msg))
+               return -EIO;
+       if (len < 0)
+               return len;
+       return 0;
+}
+
+static
+ssize_t count_one_type(const struct lttng_type *lt)
+{
+       switch (lt->atype) {
+       case atype_integer:
+       case atype_float:
+       case atype_string:
+       case atype_enum:
+       case atype_array:
+       case atype_sequence:
+               return 1;
+       case atype_struct:
+               //TODO: implement non-empty struct.
+               return 1;
+       case atype_dynamic:
+       {
+               const struct lttng_event_field *choices;
+               size_t nr_choices;
+               int ret;
+
+               ret = lttng_ust_dynamic_type_choices(&nr_choices,
+                       &choices);
+               if (ret)
+                       return ret;
+               /*
+                * One field for enum, one field for variant, and
+                * one field per choice.
+                */
+               return count_fields_recursive(nr_choices, choices) + 2;
+       }
+       default:
+               return -EINVAL;
+       }
+       return 0;
+}
+
+static
+ssize_t count_fields_recursive(size_t nr_fields,
+               const struct lttng_event_field *lttng_fields)
+{
+       int i;
+       ssize_t ret, count = 0;
+
+       for (i = 0; i < nr_fields; i++) {
+               const struct lttng_event_field *lf;
+
+               lf = &lttng_fields[i];
+               /* skip 'nowrite' fields */
+               if (lf->nowrite)
+                       continue;
+               ret = count_one_type(&lf->type);
+               if (ret < 0)
+                       return ret;     /* error */
+               count += ret;
+       }
+       return count;
+}
+
+static
+ssize_t count_ctx_fields_recursive(size_t nr_fields,
+               const struct lttng_ctx_field *lttng_fields)
+{
+       int i;
+       ssize_t ret, count = 0;
+
+       for (i = 0; i < nr_fields; i++) {
+               const struct lttng_event_field *lf;
+
+               lf = &lttng_fields[i].event_field;
+               /* skip 'nowrite' fields */
+               if (lf->nowrite)
+                       continue;
+               ret = count_one_type(&lf->type);
+               if (ret < 0)
+                       return ret;     /* error */
+               count += ret;
+       }
+       return count;
+}
+
+static
+int serialize_string_encoding(int32_t *ue,
+               enum lttng_string_encodings le)
+{
+       switch (le) {
+       case lttng_encode_none:
+               *ue = ustctl_encode_none;
+               break;
+       case lttng_encode_UTF8:
+               *ue = ustctl_encode_UTF8;
+               break;
+       case lttng_encode_ASCII:
+               *ue = ustctl_encode_ASCII;
+               break;
+       default:
+               return -EINVAL;
+       }
+       return 0;
+}
+
+static
+int serialize_integer_type(struct ustctl_integer_type *uit,
+               const struct lttng_integer_type *lit)
+{
+       int32_t encoding;
+
+       uit->size = lit->size;
+       uit->signedness = lit->signedness;
+       uit->reverse_byte_order = lit->reverse_byte_order;
+       uit->base = lit->base;
+       if (serialize_string_encoding(&encoding, lit->encoding))
+               return -EINVAL;
+       uit->encoding = encoding;
+       uit->alignment = lit->alignment;
+       return 0;
+}
+
+static
+int serialize_basic_type(struct lttng_session *session,
+               enum ustctl_abstract_types *uatype,
+               enum lttng_abstract_types atype,
+               union _ustctl_basic_type *ubt,
+               const union _lttng_basic_type *lbt)
+{
+       switch (atype) {
+       case atype_integer:
+       {
+               if (serialize_integer_type(&ubt->integer, &lbt->integer))
+                       return -EINVAL;
+               *uatype = ustctl_atype_integer;
+               break;
+       }
+       case atype_string:
+       {
+               int32_t encoding;
+
+               if (serialize_string_encoding(&encoding, lbt->string.encoding))
+                       return -EINVAL;
+               ubt->string.encoding = encoding;
+               *uatype = ustctl_atype_string;
+               break;
+       }
+       case atype_float:
+       {
+               struct ustctl_float_type *uft;
+               const struct lttng_float_type *lft;
+
+               uft = &ubt->_float;
+               lft = &lbt->_float;
+               uft->exp_dig = lft->exp_dig;
+               uft->mant_dig = lft->mant_dig;
+               uft->alignment = lft->alignment;
+               uft->reverse_byte_order = lft->reverse_byte_order;
+               *uatype = ustctl_atype_float;
+               break;
+       }
+       case atype_enum:
+       {
+               strncpy(ubt->enumeration.name, lbt->enumeration.desc->name,
+                               LTTNG_UST_SYM_NAME_LEN);
+               ubt->enumeration.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+               if (serialize_integer_type(&ubt->enumeration.container_type,
+                               &lbt->enumeration.container_type))
+                       return -EINVAL;
+               if (session) {
+                       const struct lttng_enum *_enum;
+
+                       _enum = lttng_ust_enum_get_from_desc(session, lbt->enumeration.desc);
+                       if (!_enum)
+                               return -EINVAL;
+                       ubt->enumeration.id = _enum->id;
+               } else {
+                       ubt->enumeration.id = -1ULL;
+               }
+               *uatype = ustctl_atype_enum;
+               break;
+       }
+       case atype_array:
+       case atype_sequence:
+       default:
+               return -EINVAL;
+       }
+       return 0;
+}
+
+static
+int serialize_dynamic_type(struct lttng_session *session,
+               struct ustctl_field *fields, size_t *iter_output,
+               const struct lttng_event_field *lf)
+{
+       const struct lttng_event_field *choices;
+       char tag_field_name[LTTNG_UST_SYM_NAME_LEN];
+       const struct lttng_type *tag_type;
+       const struct lttng_event_field *tag_field_generic;
+       struct lttng_event_field tag_field = {
+               .name = tag_field_name,
+               .nowrite = 0,
+       };
+       struct ustctl_field *uf;
+       size_t nr_choices, i;
+       int ret;
+
+       tag_field_generic = lttng_ust_dynamic_type_tag_field();
+       tag_type = &tag_field_generic->type;
+
+       /* Serialize enum field. */
+       strncpy(tag_field_name, lf->name, LTTNG_UST_SYM_NAME_LEN);
+       tag_field_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+       strncat(tag_field_name,
+               "_tag",
+               LTTNG_UST_SYM_NAME_LEN - strlen(tag_field_name) - 1);
+       tag_field.type = *tag_type;
+       ret = serialize_one_field(session, fields, iter_output,
+               &tag_field);
+       if (ret)
+               return ret;
+
+       /* Serialize variant field. */
+       uf = &fields[*iter_output];
+       ret = lttng_ust_dynamic_type_choices(&nr_choices, &choices);
+       if (ret)
+               return ret;
+
+       strncpy(uf->name, lf->name, LTTNG_UST_SYM_NAME_LEN);
+       uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+       uf->type.atype = ustctl_atype_variant;
+       uf->type.u.variant.nr_choices = nr_choices;
+       strncpy(uf->type.u.variant.tag_name,
+               tag_field_name,
+               LTTNG_UST_SYM_NAME_LEN);
+       uf->type.u.variant.tag_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+       (*iter_output)++;
+
+       /* Serialize choice fields after variant. */
+       for (i = 0; i < nr_choices; i++) {
+               ret = serialize_one_field(session, fields,
+                       iter_output, &choices[i]);
+               if (ret)
+                       return ret;
+       }
+       return 0;
+}
+
+static
+int serialize_one_field(struct lttng_session *session,
+               struct ustctl_field *fields, size_t *iter_output,
+               const struct lttng_event_field *lf)
+{
+       const struct lttng_type *lt = &lf->type;
+       int ret;
+
+       /* skip 'nowrite' fields */
+       if (lf->nowrite)
+               return 0;
+
+       switch (lt->atype) {
+       case atype_integer:
+       case atype_float:
+       case atype_string:
+       case atype_enum:
+       {
+               struct ustctl_field *uf = &fields[*iter_output];
+               struct ustctl_type *ut = &uf->type;
+               enum ustctl_abstract_types atype;
+
+               strncpy(uf->name, lf->name, LTTNG_UST_SYM_NAME_LEN);
+               uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+               ret = serialize_basic_type(session, &atype, lt->atype,
+                       &ut->u.basic, &lt->u.basic);
+               if (ret)
+                       return ret;
+               ut->atype = atype;
+               (*iter_output)++;
+               break;
+       }
+       case atype_array:
+       {
+               struct ustctl_field *uf = &fields[*iter_output];
+               struct ustctl_type *ut = &uf->type;
+               struct ustctl_basic_type *ubt;
+               const struct lttng_basic_type *lbt;
+               enum ustctl_abstract_types atype;
+
+               strncpy(uf->name, lf->name, LTTNG_UST_SYM_NAME_LEN);
+               uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+               uf->type.atype = ustctl_atype_array;
+               ubt = &ut->u.array.elem_type;
+               lbt = &lt->u.array.elem_type;
+               ut->u.array.length = lt->u.array.length;
+               ret = serialize_basic_type(session, &atype, lbt->atype,
+                       &ubt->u.basic, &lbt->u.basic);
+               if (ret)
+                       return -EINVAL;
+               ubt->atype = atype;
+               ut->atype = ustctl_atype_array;
+               (*iter_output)++;
+               break;
+       }
+       case atype_sequence:
+       {
+               struct ustctl_field *uf = &fields[*iter_output];
+               struct ustctl_type *ut = &uf->type;
+               struct ustctl_basic_type *ubt;
+               const struct lttng_basic_type *lbt;
+               enum ustctl_abstract_types atype;
+               int ret;
+
+               strncpy(uf->name, lf->name, LTTNG_UST_SYM_NAME_LEN);
+               uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+               uf->type.atype = ustctl_atype_sequence;
+               ubt = &ut->u.sequence.length_type;
+               lbt = &lt->u.sequence.length_type;
+               ret = serialize_basic_type(session, &atype, lbt->atype,
+                       &ubt->u.basic, &lbt->u.basic);
+               if (ret)
+                       return -EINVAL;
+               ubt->atype = atype;
+               ubt = &ut->u.sequence.elem_type;
+               lbt = &lt->u.sequence.elem_type;
+               ret = serialize_basic_type(session, &atype, lbt->atype,
+                       &ubt->u.basic, &lbt->u.basic);
+               if (ret)
+                       return -EINVAL;
+               ubt->atype = atype;
+               ut->atype = ustctl_atype_sequence;
+               (*iter_output)++;
+               break;
+       }
+       case atype_dynamic:
+       {
+               ret = serialize_dynamic_type(session, fields, iter_output, lf);
+               if (ret)
+                       return -EINVAL;
+               break;
+       }
+       case atype_struct:
+       {
+               struct ustctl_field *uf = &fields[*iter_output];
+
+               /*
+                * TODO: add support for non-empty struct.
+                */
+               if (lf->type.u._struct.nr_fields != 0) {
+                       return -EINVAL;
+               }
+               strncpy(uf->name, lf->name, LTTNG_UST_SYM_NAME_LEN);
+               uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+               uf->type.atype = ustctl_atype_struct;
+               uf->type.u._struct.nr_fields = 0;
+               (*iter_output)++;
+               break;
+       }
+       default:
+               return -EINVAL;
+       }
+       return 0;
+}
+
+static
+int serialize_fields(struct lttng_session *session,
+               size_t *_nr_write_fields,
+               struct ustctl_field **ustctl_fields,
+               size_t nr_fields,
+               const struct lttng_event_field *lttng_fields)
+{
+       struct ustctl_field *fields;
+       int ret;
+       size_t i, iter_output = 0;
+       ssize_t nr_write_fields;
+
+       nr_write_fields = count_fields_recursive(nr_fields, lttng_fields);
+       if (nr_write_fields < 0) {
+               return (int) nr_write_fields;
+       }
+
+       fields = zmalloc(nr_write_fields * sizeof(*fields));
+       if (!fields)
+               return -ENOMEM;
+
+       for (i = 0; i < nr_fields; i++) {
+               ret = serialize_one_field(session, fields, &iter_output,
+                               &lttng_fields[i]);
+               if (ret)
+                       goto error_type;
+       }
+
+       *_nr_write_fields = nr_write_fields;
+       *ustctl_fields = fields;
+       return 0;
+
+error_type:
+       free(fields);
+       return ret;
+}
+
+static
+int serialize_entries(struct ustctl_enum_entry **_entries,
+               size_t nr_entries,
+               const struct lttng_enum_entry *lttng_entries)
+{
+       struct ustctl_enum_entry *entries;
+       int i;
+
+       /* Serialize the entries */
+       entries = zmalloc(nr_entries * sizeof(*entries));
+       if (!entries)
+               return -ENOMEM;
+       for (i = 0; i < nr_entries; i++) {
+               struct ustctl_enum_entry *uentry;
+               const struct lttng_enum_entry *lentry;
+
+               uentry = &entries[i];
+               lentry = &lttng_entries[i];
+
+               uentry->start.value = lentry->start.value;
+               uentry->start.signedness = lentry->start.signedness;
+               uentry->end.value = lentry->end.value;
+               uentry->end.signedness = lentry->end.signedness;
+               strncpy(uentry->string, lentry->string, LTTNG_UST_SYM_NAME_LEN);
+               uentry->string[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+
+               if (lentry->u.extra.options & LTTNG_ENUM_ENTRY_OPTION_IS_AUTO) {
+                       uentry->u.extra.options |=
+                               USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO;
+               }
+       }
+       *_entries = entries;
+       return 0;
+}
+
+static
+int serialize_ctx_fields(struct lttng_session *session,
+               size_t *_nr_write_fields,
+               struct ustctl_field **ustctl_fields,
+               size_t nr_fields,
+               const struct lttng_ctx_field *lttng_fields)
+{
+       struct ustctl_field *fields;
+       int ret;
+       size_t i, iter_output = 0;
+       ssize_t nr_write_fields;
+
+       nr_write_fields = count_ctx_fields_recursive(nr_fields,
+                       lttng_fields);
+       if (nr_write_fields < 0) {
+               return (int) nr_write_fields;
+       }
+
+       fields = zmalloc(nr_write_fields * sizeof(*fields));
+       if (!fields)
+               return -ENOMEM;
+
+       for (i = 0; i < nr_fields; i++) {
+               ret = serialize_one_field(session, fields, &iter_output,
+                               &lttng_fields[i].event_field);
+               if (ret)
+                       goto error_type;
+       }
+
+       *_nr_write_fields = nr_write_fields;
+       *ustctl_fields = fields;
+       return 0;
+
+error_type:
+       free(fields);
+       return ret;
+}
+
+/*
+ * Returns 0 on success, negative error value on error.
+ */
+int ustcomm_register_event(int sock,
+       struct lttng_session *session,
+       int session_objd,               /* session descriptor */
+       int channel_objd,               /* channel descriptor */
+       const char *event_name,         /* event name (input) */
+       int loglevel,
+       const char *signature,          /* event signature (input) */
+       size_t nr_fields,               /* fields */
+       const struct lttng_event_field *lttng_fields,
+       const char *model_emf_uri,
+       uint32_t *id)                   /* event id (output) */
+{
+       ssize_t len;
+       struct {
+               struct ustcomm_notify_hdr header;
+               struct ustcomm_notify_event_msg m;
+       } msg;
+       struct {
+               struct ustcomm_notify_hdr header;
+               struct ustcomm_notify_event_reply r;
+       } reply;
+       size_t signature_len, fields_len, model_emf_uri_len;
+       struct ustctl_field *fields = NULL;
+       size_t nr_write_fields = 0;
+       int ret;
+
+       memset(&msg, 0, sizeof(msg));
+       msg.header.notify_cmd = USTCTL_NOTIFY_CMD_EVENT;
+       msg.m.session_objd = session_objd;
+       msg.m.channel_objd = channel_objd;
+       strncpy(msg.m.event_name, event_name, LTTNG_UST_SYM_NAME_LEN);
+       msg.m.event_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+       msg.m.loglevel = loglevel;
+       signature_len = strlen(signature) + 1;
+       msg.m.signature_len = signature_len;
+
+       /* Calculate fields len, serialize fields. */
+       if (nr_fields > 0) {
+               ret = serialize_fields(session, &nr_write_fields, &fields,
+                               nr_fields, lttng_fields);
+               if (ret)
+                       return ret;
+       }
+
+       fields_len = sizeof(*fields) * nr_write_fields;
+       msg.m.fields_len = fields_len;
+       if (model_emf_uri) {
+               model_emf_uri_len = strlen(model_emf_uri) + 1;
+       } else {
+               model_emf_uri_len = 0;
+       }
+       msg.m.model_emf_uri_len = model_emf_uri_len;
+
+       len = ustcomm_send_unix_sock(sock, &msg, sizeof(msg));
+       if (len > 0 && len != sizeof(msg)) {
+               ret = -EIO;
+               goto error_fields;
+       }
+       if (len < 0) {
+               ret = len;
+               goto error_fields;
+       }
+
+       /* send signature */
+       len = ustcomm_send_unix_sock(sock, signature, signature_len);
+       if (len > 0 && len != signature_len) {
+               ret = -EIO;
+               goto error_fields;
+       }
+       if (len < 0) {
+               ret = len;
+               goto error_fields;
+       }
+
+       /* send fields */
+       if (fields_len > 0) {
+               len = ustcomm_send_unix_sock(sock, fields, fields_len);
+               if (len > 0 && len != fields_len) {
+                       ret = -EIO;
+                       goto error_fields;
+               }
+               if (len < 0) {
+                       ret = len;
+                       goto error_fields;
+               }
+       }
+       free(fields);
+
+       if (model_emf_uri_len) {
+               /* send model_emf_uri */
+               len = ustcomm_send_unix_sock(sock, model_emf_uri,
+                               model_emf_uri_len);
+               if (len > 0 && len != model_emf_uri_len) {
+                       return -EIO;
+               }
+               if (len < 0) {
+                       return len;
+               }
+       }
+
+       /* receive reply */
+       len = ustcomm_recv_unix_sock(sock, &reply, sizeof(reply));
+       switch (len) {
+       case 0: /* orderly shutdown */
+               return -EPIPE;
+       case sizeof(reply):
+               if (reply.header.notify_cmd != msg.header.notify_cmd) {
+                       ERR("Unexpected result message command "
+                               "expected: %u vs received: %u\n",
+                               msg.header.notify_cmd, reply.header.notify_cmd);
+                       return -EINVAL;
+               }
+               if (reply.r.ret_code > 0)
+                       return -EINVAL;
+               if (reply.r.ret_code < 0)
+                       return reply.r.ret_code;
+               *id = reply.r.event_id;
+               DBG("Sent register event notification for name \"%s\": ret_code %d, event_id %u\n",
+                       event_name, reply.r.ret_code, reply.r.event_id);
+               return 0;
+       default:
+               if (len < 0) {
+                       /* Transport level error */
+                       if (errno == EPIPE || errno == ECONNRESET)
+                               len = -errno;
+                       return len;
+               } else {
+                       ERR("incorrect message size: %zd\n", len);
+                       return len;
+               }
+       }
+       /* Unreached. */
+
+       /* Error path only. */
+error_fields:
+       free(fields);
+       return ret;
+}
+
+/*
+ * Returns 0 on success, negative error value on error.
+ * Returns -EPIPE or -ECONNRESET if other end has hung up.
+ */
+int ustcomm_register_enum(int sock,
+       int session_objd,               /* session descriptor */
+       const char *enum_name,          /* enum name (input) */
+       size_t nr_entries,              /* entries */
+       const struct lttng_enum_entry *lttng_entries,
+       uint64_t *id)
+{
+       ssize_t len;
+       struct {
+               struct ustcomm_notify_hdr header;
+               struct ustcomm_notify_enum_msg m;
+       } msg;
+       struct {
+               struct ustcomm_notify_hdr header;
+               struct ustcomm_notify_enum_reply r;
+       } reply;
+       size_t entries_len;
+       struct ustctl_enum_entry *entries = NULL;
+       int ret;
+
+       memset(&msg, 0, sizeof(msg));
+       msg.header.notify_cmd = USTCTL_NOTIFY_CMD_ENUM;
+       msg.m.session_objd = session_objd;
+       strncpy(msg.m.enum_name, enum_name, LTTNG_UST_SYM_NAME_LEN);
+       msg.m.enum_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+
+       /* Calculate entries len, serialize entries. */
+       if (nr_entries > 0) {
+               ret = serialize_entries(&entries,
+                               nr_entries, lttng_entries);
+               if (ret)
+                       return ret;
+       }
+
+       entries_len = sizeof(*entries) * nr_entries;
+       msg.m.entries_len = entries_len;
+
+       len = ustcomm_send_unix_sock(sock, &msg, sizeof(msg));
+       if (len > 0 && len != sizeof(msg)) {
+               ret = -EIO;
+               goto error_entries;
+       }
+       if (len < 0) {
+               ret = len;
+               goto error_entries;
+       }
+
+       /* send entries */
+       if (entries_len > 0) {
+               len = ustcomm_send_unix_sock(sock, entries, entries_len);
+               if (len > 0 && len != entries_len) {
+                       ret = -EIO;
+                       goto error_entries;
+               }
+               if (len < 0) {
+                       ret = len;
+                       goto error_entries;
+               }
+       }
+       free(entries);
+       entries = NULL;
+
+       /* receive reply */
+       len = ustcomm_recv_unix_sock(sock, &reply, sizeof(reply));
+       switch (len) {
+       case 0: /* orderly shutdown */
+               return -EPIPE;
+       case sizeof(reply):
+               if (reply.header.notify_cmd != msg.header.notify_cmd) {
+                       ERR("Unexpected result message command "
+                               "expected: %u vs received: %u\n",
+                               msg.header.notify_cmd, reply.header.notify_cmd);
+                       return -EINVAL;
+               }
+               if (reply.r.ret_code > 0)
+                       return -EINVAL;
+               if (reply.r.ret_code < 0)
+                       return reply.r.ret_code;
+               *id = reply.r.enum_id;
+               DBG("Sent register enum notification for name \"%s\": ret_code %d\n",
+                       enum_name, reply.r.ret_code);
+               return 0;
+       default:
+               if (len < 0) {
+                       /* Transport level error */
+                       if (errno == EPIPE || errno == ECONNRESET)
+                               len = -errno;
+                       return len;
+               } else {
+                       ERR("incorrect message size: %zd\n", len);
+                       return len;
+               }
+       }
+       return ret;
+
+error_entries:
+       free(entries);
+       return ret;
+}
+
+/*
+ * Returns 0 on success, negative error value on error.
+ * Returns -EPIPE or -ECONNRESET if other end has hung up.
+ */
+int ustcomm_register_channel(int sock,
+       struct lttng_session *session,
+       int session_objd,               /* session descriptor */
+       int channel_objd,               /* channel descriptor */
+       size_t nr_ctx_fields,
+       const struct lttng_ctx_field *ctx_fields,
+       uint32_t *chan_id,              /* channel id (output) */
+       int *header_type)               /* header type (output) */
+{
+       ssize_t len;
+       struct {
+               struct ustcomm_notify_hdr header;
+               struct ustcomm_notify_channel_msg m;
+       } msg;
+       struct {
+               struct ustcomm_notify_hdr header;
+               struct ustcomm_notify_channel_reply r;
+       } reply;
+       size_t fields_len;
+       struct ustctl_field *fields = NULL;
+       int ret;
+       size_t nr_write_fields = 0;
+
+       memset(&msg, 0, sizeof(msg));
+       msg.header.notify_cmd = USTCTL_NOTIFY_CMD_CHANNEL;
+       msg.m.session_objd = session_objd;
+       msg.m.channel_objd = channel_objd;
+
+       /* Calculate fields len, serialize fields. */
+       if (nr_ctx_fields > 0) {
+               ret = serialize_ctx_fields(session, &nr_write_fields, &fields,
+                               nr_ctx_fields, ctx_fields);
+               if (ret)
+                       return ret;
+       }
+
+       fields_len = sizeof(*fields) * nr_write_fields;
+       msg.m.ctx_fields_len = fields_len;
+       len = ustcomm_send_unix_sock(sock, &msg, sizeof(msg));
+       if (len > 0 && len != sizeof(msg)) {
+               free(fields);
+               return -EIO;
+       }
+       if (len < 0) {
+               free(fields);
+               return len;
+       }
+
+       /* send fields */
+       if (fields_len > 0) {
+               len = ustcomm_send_unix_sock(sock, fields, fields_len);
+               free(fields);
+               if (len > 0 && len != fields_len) {
+                       return -EIO;
+               }
+               if (len < 0) {
+                       return len;
+               }
+       } else {
+               free(fields);
+       }
+
+       len = ustcomm_recv_unix_sock(sock, &reply, sizeof(reply));
+       switch (len) {
+       case 0: /* orderly shutdown */
+               return -EPIPE;
+       case sizeof(reply):
+               if (reply.header.notify_cmd != msg.header.notify_cmd) {
+                       ERR("Unexpected result message command "
+                               "expected: %u vs received: %u\n",
+                               msg.header.notify_cmd, reply.header.notify_cmd);
+                       return -EINVAL;
+               }
+               if (reply.r.ret_code > 0)
+                       return -EINVAL;
+               if (reply.r.ret_code < 0)
+                       return reply.r.ret_code;
+               *chan_id = reply.r.chan_id;
+               switch (reply.r.header_type) {
+               case 1:
+               case 2:
+                       *header_type = reply.r.header_type;
+                       break;
+               default:
+                       ERR("Unexpected channel header type %u\n",
+                               reply.r.header_type);
+                       return -EINVAL;
+               }
+               DBG("Sent register channel notification: chan_id %d, header_type %d\n",
+                       reply.r.chan_id, reply.r.header_type);
+               return 0;
+       default:
+               if (len < 0) {
+                       /* Transport level error */
+                       if (errno == EPIPE || errno == ECONNRESET)
+                               len = -errno;
+                       return len;
+               } else {
+                       ERR("incorrect message size: %zd\n", len);
+                       return len;
+               }
+       }
+}
+
+/*
+ * Set socket reciving timeout.
+ */
+int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec)
+{
+       int ret;
+       struct timeval tv;
+
+       tv.tv_sec = msec / 1000;
+       tv.tv_usec = (msec * 1000 % 1000000);
+
+       ret = setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
+       if (ret < 0) {
+               PERROR("setsockopt SO_RCVTIMEO");
+               ret = -errno;
+       }
+
+       return ret;
+}
+
+/*
+ * Set socket sending timeout.
+ */
+int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec)
+{
+       int ret;
+       struct timeval tv;
+
+       tv.tv_sec = msec / 1000;
+       tv.tv_usec = (msec * 1000) % 1000000;
+
+       ret = setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
+       if (ret < 0) {
+               PERROR("setsockopt SO_SNDTIMEO");
+               ret = -errno;
+       }
+
+       return ret;
+}
This page took 0.03965 seconds and 4 git commands to generate.