X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=liblttng-ust-comm%2Flttng-ust-comm.c;h=b0e4484abdccfba9078c94d84a46ab744559ca7f;hb=17ea789c184782cbfa5789c5e644a1774029dcb8;hp=1e2fd1a04395a2f364342d0b5c4d4bf49272489f;hpb=8d9baf68ad7e264e89e26c066826a7c3429952e2;p=lttng-ust.git diff --git a/liblttng-ust-comm/lttng-ust-comm.c b/liblttng-ust-comm/lttng-ust-comm.c index 1e2fd1a0..b0e4484a 100644 --- a/liblttng-ust-comm/lttng-ust-comm.c +++ b/liblttng-ust-comm/lttng-ust-comm.c @@ -1,6 +1,6 @@ /* * Copyright (C) 2011 - David Goulet - * Copyright (C) 2011 - Mathieu Desnoyers + * Copyright (C) 2011-2013 - Mathieu Desnoyers * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -31,90 +31,65 @@ #include #include +#include #include +#include +#include +#include +#include + +#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 /* * 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", + [ 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", }; /* - * 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)]; } /* - * ustcomm_connect_unix_sock + * ustcomm_connect_unix_sock * - * Connect to unix socket using the path name. + * Connect to unix socket using the path name. */ 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 @@ -122,13 +97,14 @@ int ustcomm_connect_unix_sock(const char *pathname) */ fd = socket(PF_UNIX, SOCK_STREAM, 0); if (fd < 0) { - perror("socket"); - ret = fd; + PERROR("socket"); + ret = -errno; goto error; } ret = fcntl(fd, F_SETFD, FD_CLOEXEC); if (ret < 0) { - perror("fcntl"); + PERROR("fcntl"); + ret = -errno; goto error_fcntl; } @@ -140,10 +116,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; } @@ -151,16 +135,22 @@ int ustcomm_connect_unix_sock(const char *pathname) error_connect: error_fcntl: - close(fd); + { + int closeret; + + closeret = close(fd); + if (closeret) + PERROR("close"); + } error: return ret; } /* - * ustcomm_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. + * Do an accept(2) on the sock and return the + * new file descriptor. The socket MUST be bind(2) before. */ int ustcomm_accept_unix_sock(int sock) { @@ -171,27 +161,30 @@ int ustcomm_accept_unix_sock(int sock) /* Blocking call */ new_fd = accept(sock, (struct sockaddr *) &sun, &len); if (new_fd < 0) { - perror("accept"); - return -1; + if (errno != ECONNABORTED) + PERROR("accept"); + new_fd = -errno; + if (new_fd == -ECONNABORTED) + new_fd = -EPIPE; } return new_fd; } /* - * ustcomm_create_unix_sock + * ustcomm_create_unix_sock * - * Creates a AF_UNIX local socket using pathname - * bind the socket upon creation and return the fd. + * Creates a AF_UNIX local socket using pathname + * bind the socket upon creation and return the fd. */ 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"); + PERROR("socket"); + ret = -errno; goto error; } @@ -204,20 +197,30 @@ int ustcomm_create_unix_sock(const char *pathname) (void) unlink(pathname); ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun)); if (ret < 0) { - perror("bind"); - goto error; + PERROR("bind"); + ret = -errno; + goto error_close; } return fd; +error_close: + { + int closeret; + + closeret = close(fd); + if (closeret) { + PERROR("close"); + } + } error: return ret; } /* - * ustcomm_listen_unix_sock + * ustcomm_listen_unix_sock * - * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN. + * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN. */ int ustcomm_listen_unix_sock(int sock) { @@ -225,24 +228,44 @@ int ustcomm_listen_unix_sock(int sock) ret = listen(sock, LTTNG_UST_COMM_MAX_LISTEN); if (ret < 0) { - perror("listen"); + ret = -errno; + PERROR("listen"); + } + + return ret; +} + +/* + * ustcomm_close_unix_sock + * + * Shutdown cleanly a unix socket. + */ +int ustcomm_close_unix_sock(int sock) +{ + int ret; + + ret = close(sock); + if (ret < 0) { + PERROR("close"); + ret = -errno; } return ret; } /* - * ustcomm_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. + * Receive data of size len in put that data into + * the buf param. Using recvmsg API. + * Return the size of received data. + * Return 0 on orderly shutdown. */ ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len) { struct msghdr msg; struct iovec iov[1]; - ssize_t ret = -1; + ssize_t ret; memset(&msg, 0, sizeof(msg)); @@ -254,28 +277,39 @@ ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len) do { ret = recvmsg(sock, &msg, 0); } while (ret < 0 && errno == EINTR); - if (ret < 0 && errno != EPIPE) { - perror("recvmsg"); + + if (ret < 0) { + int shutret; + + 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) + ERR("Socket shutdown error"); } return ret; } /* - * ustcomm_send_unix_sock + * ustcomm_send_unix_sock * - * Send buf data of size len. Using sendmsg API. - * Return the size of sent data. + * 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]; - ssize_t ret = -1; + ssize_t ret; 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; @@ -290,36 +324,30 @@ ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len) do { ret = sendmsg(sock, &msg, MSG_NOSIGNAL); } while (ret < 0 && errno == EINTR); - if (ret < 0 && errno != EPIPE) { - perror("sendmsg"); - } - return ret; -} + if (ret < 0) { + int shutret; -/* - * ustcomm_close_unix_sock - * - * Shutdown cleanly a unix socket. - */ -int ustcomm_close_unix_sock(int sock) -{ - int ret; + if (errno != EPIPE && errno != ECONNRESET) + PERROR("sendmsg"); + ret = -errno; + if (ret == -ECONNRESET) + ret = -EPIPE; - ret = close(sock); - if (ret < 0) { - perror("close"); + shutret = shutdown(sock, SHUT_RDWR); + if (shutret) + ERR("Socket shutdown error"); } return ret; } /* - * ustcomm_send_fds_unix_sock + * Send a message accompanied by fd(s) over a unix socket. * - * Send multiple fds on a unix socket. + * Returns the size of data sent, or negative error value. */ -ssize_t ustcomm_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, int *fds, size_t nb_fd) { struct msghdr msg; struct cmsghdr *cmptr; @@ -327,14 +355,13 @@ ssize_t ustcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, ssize_t ret = -1; unsigned int sizeof_fds = nb_fd * sizeof(int); char tmp[CMSG_SPACE(sizeof_fds)]; + char dummy = 0; memset(&msg, 0, sizeof(msg)); + memset(tmp, 0, CMSG_SPACE(sizeof_fds) * sizeof(char)); - /* - * Note: the consumerd receiver only supports receiving one FD per - * message. - */ - assert(nb_fd == 1); + if (nb_fd > USTCOMM_MAX_SEND_FDS) + return -EINVAL; msg.msg_control = (caddr_t)tmp; msg.msg_controllen = CMSG_LEN(sizeof_fds); @@ -347,18 +374,104 @@ ssize_t ustcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, /* Sum of the length of all control messages in the buffer: */ msg.msg_controllen = cmptr->cmsg_len; - iov[0].iov_base = buf; - iov[0].iov_len = len; + iov[0].iov_base = &dummy; + iov[0].iov_len = 1; msg.msg_iov = iov; msg.msg_iovlen = 1; do { - ret = sendmsg(sock, &msg, MSG_NOSIGNAL); + ret = sendmsg(sock, &msg, 0); } while (ret < 0 && errno == EINTR); - if (ret < 0 && errno != EPIPE) { - perror("sendmsg"); + if (ret < 0) { + /* + * We consider EPIPE and ECONNRESET as expected. + */ + if (errno != EPIPE && errno != ECONNRESET) { + PERROR("sendmsg"); + } + ret = -errno; + if (ret == -ECONNRESET) + ret = -EPIPE; } + return ret; +} +/* + * 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. + */ +ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd) +{ + struct iovec iov[1]; + ssize_t ret = 0; + struct cmsghdr *cmsg; + size_t sizeof_fds = nb_fd * sizeof(int); + char recv_fd[CMSG_SPACE(sizeof_fds)]; + struct msghdr msg; + char dummy; + + memset(&msg, 0, sizeof(msg)); + + /* Prepare to receive the structures */ + iov[0].iov_base = &dummy; + iov[0].iov_len = 1; + 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) { + if (errno != EPIPE && errno != ECONNRESET) { + PERROR("recvmsg fds"); + } + ret = -errno; + if (ret == -ECONNRESET) + ret = -EPIPE; + goto end; + } + if (ret == 0) { + /* orderly shutdown */ + ret = -EPIPE; + goto end; + } + if (ret != 1) { + ERR("Error: Received %zd bytes, expected %d\n", + ret, 1); + goto end; + } + if (msg.msg_flags & MSG_CTRUNC) { + ERR("Error: Control message truncated.\n"); + ret = -1; + goto end; + } + cmsg = CMSG_FIRSTHDR(&msg); + if (!cmsg) { + ERR("Error: Invalid control message header\n"); + ret = -1; + goto end; + } + if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) { + ERR("Didn't received any fd\n"); + ret = -1; + goto end; + } + if (cmsg->cmsg_len != CMSG_LEN(sizeof_fds)) { + 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; +end: return ret; } @@ -370,15 +483,13 @@ int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum) switch (len) { case sizeof(*lum): break; - case -1: - if (errno == ECONNRESET) { - fprintf(stderr, "remote end closed connection\n"); - return 0; - } - return -1; default: - fprintf(stderr, "incorrect message size: %zd\n", len); - return -1; + if (len < 0) { + return len; + } else { + ERR("incorrect message size: %zd\n", len); + return -EINVAL; + } } return 0; } @@ -392,36 +503,26 @@ 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 */ - return -EINVAL; + return -EPIPE; case sizeof(*lur): if (lur->handle != expected_handle) { - fprintf(stderr, "Unexpected result message handle\n"); + ERR("Unexpected result message handle: " + "expected: %u vs received: %u\n", + expected_handle, lur->handle); return -EINVAL; } - if (lur->cmd != expected_cmd) { - fprintf(stderr, "Unexpected result message command\n"); + ERR("Unexpected result message command " + "expected: %u vs received: %u\n", + expected_cmd, lur->cmd); return -EINVAL; } - if (lur->ret_code != USTCOMM_OK) { - /* - * Some errors are normal.. we should put this - * in a debug level message... - * fprintf(stderr, "remote operation failed with code %d.\n", - * lur->ret_code); - */ - return lur->ret_code; - } - return 0; - case -1: - if (errno == ECONNRESET) { - fprintf(stderr, "remote end closed connection\n"); - return -EINVAL; - } - return -1; + return lur->ret_code; default: - fprintf(stderr, "incorrect message size: %zd\n", len); - return len > 0 ? -1 : len; + if (len >= 0) { + ERR("incorrect message size: %zd\n", len); + } + return len; } } @@ -435,73 +536,614 @@ 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; + if (ret > 0) + return -EIO; + return ret; +} + +/* + * chan_data is allocated internally if this function returns the + * expected var_len. + */ +ssize_t ustcomm_recv_channel_from_sessiond(int sock, + void **_chan_data, uint64_t var_len, + int *_wakeup_fd) +{ + void *chan_data; + ssize_t len, nr_fd; + int wakeup_fd; + + if (var_len > LTTNG_UST_CHANNEL_DATA_MAX_LEN) { + len = -EINVAL; + goto error_check; + } + /* Receive variable length data */ + chan_data = zmalloc(var_len); + if (!chan_data) { + len = -ENOMEM; + goto error_alloc; + } + len = ustcomm_recv_unix_sock(sock, chan_data, var_len); + if (len != var_len) { + goto error_recv; + } + /* recv wakeup fd */ + nr_fd = ustcomm_recv_fds_unix_sock(sock, &wakeup_fd, 1); + if (nr_fd <= 0) { + if (nr_fd < 0) { + len = nr_fd; + goto error_recv; + } else { + len = -EIO; + goto error_recv; + } + } + *_wakeup_fd = wakeup_fd; + *_chan_data = chan_data; + return len; + +error_recv: + free(chan_data); +error_alloc: +error_check: + return len; +} + +int ustcomm_recv_stream_from_sessiond(int sock, + uint64_t *memory_map_size, + int *shm_fd, int *wakeup_fd) +{ + ssize_t len; + int ret; + int fds[2]; + + /* recv shm fd and wakeup fd */ + len = ustcomm_recv_fds_unix_sock(sock, fds, 2); + if (len <= 0) { + if (len < 0) { + ret = len; + goto error; + } else { + ret = -EIO; + goto error; + } + } + *shm_fd = fds[0]; + *wakeup_fd = fds[1]; + 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, ®_msg, sizeof(reg_msg)); + if (len > 0 && len != sizeof(reg_msg)) + return -EIO; + if (len < 0) + return len; + return 0; +} + +static +int serialize_string_encoding(enum ustctl_string_encodings *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_basic_type(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: + { + struct ustctl_integer_type *uit; + const struct lttng_integer_type *lit; + + uit = &ubt->integer; + lit = &lbt->integer; + uit->size = lit->size; + uit->signedness = lit->signedness; + uit->reverse_byte_order = lit->reverse_byte_order; + uit->base = lit->base; + if (serialize_string_encoding(&uit->encoding, lit->encoding)) + return -EINVAL; + uit->alignment = lit->alignment; + *uatype = ustctl_atype_integer; + break; + } + case atype_string: + { + if (serialize_string_encoding(&ubt->string.encoding, + lbt->string.encoding)) + return -EINVAL; + *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: + case atype_array: + case atype_sequence: + default: + return -EINVAL; + } + return 0; +} + +static +int serialize_one_type(struct ustctl_type *ut, const struct lttng_type *lt) +{ + int ret; + + switch (lt->atype) { + case atype_integer: + case atype_float: + case atype_string: + ret = serialize_basic_type(&ut->atype, lt->atype, + &ut->u.basic, <->u.basic); + if (ret) + return ret; + break; + case atype_array: + { + struct ustctl_basic_type *ubt; + const struct lttng_basic_type *lbt; + int ret; + + ubt = &ut->u.array.elem_type; + lbt = <->u.array.elem_type; + ut->u.array.length = lt->u.array.length; + ret = serialize_basic_type(&ubt->atype, lbt->atype, + &ubt->u.basic, &lbt->u.basic); + if (ret) + return -EINVAL; + ut->atype = ustctl_atype_array; + break; + } + case atype_sequence: + { + struct ustctl_basic_type *ubt; + const struct lttng_basic_type *lbt; + int ret; + + ubt = &ut->u.sequence.length_type; + lbt = <->u.sequence.length_type; + ret = serialize_basic_type(&ubt->atype, lbt->atype, + &ubt->u.basic, &lbt->u.basic); + if (ret) + return -EINVAL; + ubt = &ut->u.sequence.elem_type; + lbt = <->u.sequence.elem_type; + ret = serialize_basic_type(&ubt->atype, lbt->atype, + &ubt->u.basic, &lbt->u.basic); + if (ret) + return -EINVAL; + ut->atype = ustctl_atype_sequence; + break; + } + case atype_enum: + default: + return -EINVAL; + } + return 0; +} + +static +int serialize_fields(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 i, ret; + size_t nr_write_fields = 0; + + fields = zmalloc(nr_fields * sizeof(*fields)); + if (!fields) + return -ENOMEM; + + for (i = 0; i < nr_fields; i++) { + struct ustctl_field *f; + const struct lttng_event_field *lf; + + f = &fields[nr_write_fields]; + lf = <tng_fields[i]; + + /* skip 'nowrite' fields */ + if (lf->nowrite) + continue; + strncpy(f->name, lf->name, LTTNG_UST_SYM_NAME_LEN); + f->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0'; + ret = serialize_one_type(&f->type, &lf->type); + if (ret) + goto error_type; + nr_write_fields++; + } + + *_nr_write_fields = nr_write_fields; + *ustctl_fields = fields; + return 0; + +error_type: + free(fields); + return ret; +} + +static +int serialize_ctx_fields(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 i, ret; + size_t nr_write_fields = 0; + + fields = zmalloc(nr_fields * sizeof(*fields)); + if (!fields) + return -ENOMEM; + + for (i = 0; i < nr_fields; i++) { + struct ustctl_field *f; + const struct lttng_event_field *lf; + + f = &fields[nr_write_fields]; + lf = <tng_fields[i].event_field; + + /* skip 'nowrite' fields */ + if (lf->nowrite) + continue; + strncpy(f->name, lf->name, LTTNG_UST_SYM_NAME_LEN); + f->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0'; + ret = serialize_one_type(&f->type, &lf->type); + if (ret) + goto error_type; + nr_write_fields++; + } + + *_nr_write_fields = nr_write_fields; + *ustctl_fields = fields; + return 0; + +error_type: + free(fields); + return ret; +} /* - * Receives a single fd from socket. - * - * Returns the size of received data + * Returns 0 on success, negative error value on error. */ -int ustcomm_recv_fd(int sock) +int ustcomm_register_event(int sock, + 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) */ { - 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; + 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; - /* 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); + /* Calculate fields len, serialize fields. */ + if (nr_fields > 0) { + ret = serialize_fields(&nr_write_fields, &fields, + nr_fields, lttng_fields); + if (ret) + return ret; + } - do { - ret = recvmsg(sock, &msg, 0); - } while (ret < 0 && errno == EINTR); - if (ret < 0) { - if (errno != EPIPE) { - perror("recvmsg"); + 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)) { + free(fields); + return -EIO; + } + if (len < 0) { + free(fields); + return len; + } + + /* send signature */ + len = ustcomm_send_unix_sock(sock, signature, signature_len); + if (len > 0 && len != signature_len) { + 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; } - goto end; } - if (ret != sizeof(data_fd)) { - fprintf(stderr, "Received %d bytes, expected %zd", ret, sizeof(data_fd)); - goto end; + + 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; } - cmsg = CMSG_FIRSTHDR(&msg); - if (!cmsg) { - fprintf(stderr, "Invalid control message header\n"); - ret = -1; - goto end; + + /* 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; + } } - if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) { - fprintf(stderr, "Didn't received any fd\n"); - ret = -1; - goto end; +} + +/* + * 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, + 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(&nr_write_fields, &fields, + nr_ctx_fields, ctx_fields); + if (ret) + return ret; } - /* 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: + + 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; }