Adjust the relayd protocol on version check
[lttng-tools.git] / src / common / relayd / relayd.c
index cf3649397425840b9c0c0e0ae07d22073255f0fa..da54939f9a28153e4ae343d281ec1352e07b8ef9 100644 (file)
@@ -33,7 +33,7 @@
  * Send command. Fill up the header and append the data.
  */
 static int send_command(struct lttcomm_sock *sock,
-               enum lttcomm_sessiond_command cmd, void *data, size_t size,
+               enum lttcomm_relayd_command cmd, void *data, size_t size,
                int flags)
 {
        int ret;
@@ -67,6 +67,7 @@ static int send_command(struct lttcomm_sock *sock,
 
        ret = sock->ops->sendmsg(sock, buf, buf_size, flags);
        if (ret < 0) {
+               ret = -errno;
                goto error;
        }
 
@@ -89,10 +90,67 @@ static int recv_reply(struct lttcomm_sock *sock, void *data, size_t size)
        DBG3("Relayd waiting for reply of size %ld", size);
 
        ret = sock->ops->recvmsg(sock, data, size, 0);
+       if (ret <= 0 || ret != size) {
+               if (ret == 0) {
+                       /* Orderly shutdown. */
+                       DBG("Socket %d has performed an orderly shutdown", sock->fd);
+               } else {
+                       DBG("Receiving reply failed on sock %d for size %lu with ret %d",
+                                       sock->fd, size, ret);
+               }
+               /* Always return -1 here and the caller can use errno. */
+               ret = -1;
+               goto error;
+       }
+
+error:
+       return ret;
+}
+
+/*
+ * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
+ * set session_id of the relayd if we have a successful reply from the relayd.
+ *
+ * On success, return 0 else a negative value which is either an errno error or
+ * a lttng error code from the relayd.
+ */
+int relayd_create_session(struct lttcomm_sock *sock, uint64_t *session_id)
+{
+       int ret;
+       struct lttcomm_relayd_status_session reply;
+
+       assert(sock);
+       assert(session_id);
+
+       DBG("Relayd create session");
+
+       /* Send command */
+       ret = send_command(sock, RELAYD_CREATE_SESSION, NULL, 0, 0);
        if (ret < 0) {
                goto error;
        }
 
+       /* Receive response */
+       ret = recv_reply(sock, (void *) &reply, sizeof(reply));
+       if (ret < 0) {
+               goto error;
+       }
+
+       reply.session_id = be64toh(reply.session_id);
+       reply.ret_code = be32toh(reply.ret_code);
+
+       /* Return session id or negative ret code. */
+       if (reply.ret_code != LTTNG_OK) {
+               ret = -1;
+               ERR("Relayd create session replied error %d", reply.ret_code);
+               goto error;
+       } else {
+               ret = 0;
+               *session_id = reply.session_id;
+       }
+
+       DBG("Relayd session created with id %" PRIu64, reply.session_id);
+
 error:
        return ret;
 }
@@ -137,8 +195,8 @@ int relayd_add_stream(struct lttcomm_sock *sock, const char *channel_name,
 
        /* Return session id or negative ret code. */
        if (reply.ret_code != LTTNG_OK) {
-               ret = -reply.ret_code;
-               ERR("Relayd add stream replied error %d", ret);
+               ret = -1;
+               ERR("Relayd add stream replied error %d", reply.ret_code);
        } else {
                /* Success */
                ret = 0;
@@ -154,50 +212,73 @@ error:
 
 /*
  * Check version numbers on the relayd.
+ * If major versions are compatible, we assign minor_to_use to the
+ * minor version of the procotol we are going to use for this session.
  *
  * Return 0 if compatible else negative value.
  */
 int relayd_version_check(struct lttcomm_sock *sock, uint32_t major,
-               uint32_t minor)
+               uint32_t minor, uint32_t *minor_to_use)
 {
        int ret;
-       struct lttcomm_relayd_version reply;
+       struct lttcomm_relayd_version msg;
 
        /* Code flow error. Safety net. */
        assert(sock);
 
        DBG("Relayd version check for major.minor %u.%u", major, minor);
 
+       /* Prepare network byte order before transmission. */
+       msg.major = htobe32(major);
+       msg.minor = htobe32(minor);
+
        /* Send command */
-       ret = send_command(sock, RELAYD_VERSION, NULL, 0, 0);
+       ret = send_command(sock, RELAYD_VERSION, (void *) &msg, sizeof(msg), 0);
        if (ret < 0) {
                goto error;
        }
 
-       /* Recevie response */
-       ret = recv_reply(sock, (void *) &reply, sizeof(reply));
+       /* Receive response */
+       ret = recv_reply(sock, (void *) &msg, sizeof(msg));
        if (ret < 0) {
                goto error;
        }
 
        /* Set back to host bytes order */
-       reply.major = be32toh(reply.major);
-       reply.minor = be32toh(reply.minor);
-
-       /* Validate version */
-       if (reply.major <= major) {
-               if (reply.minor <= minor) {
-                       /* Compatible */
-                       ret = 0;
-                       DBG2("Relayd version is compatible");
-                       goto error;
-               }
+       msg.major = be32toh(msg.major);
+       msg.minor = be32toh(msg.minor);
+
+       /*
+        * Only validate the major version. If the other side is higher,
+        * communication is not possible. Only major version equal can talk to each
+        * other. If the minor version differs, the lowest version is used by both
+        * sides.
+        */
+       if (msg.major != major) {
+               /* Not compatible */
+               ret = -1;
+               DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
+                               msg.major, major);
+               goto error;
        }
 
-       /* Version number not compatible */
-       DBG2("Relayd version is NOT compatible %u.%u > %u.%u", reply.major,
-                       reply.minor, major, minor);
-       ret = -1;
+       /*
+        * After 2.1.0 release, for the 2.2 release, at this point will have to
+        * check the minor version in order for the session daemon to know which
+        * structure to use to communicate with the relayd. If the relayd's minor
+        * version is higher, it will adapt to our version so we can continue to
+        * use the latest relayd communication data structure.
+        */
+       if (minor <= msg.minor) {
+               *minor_to_use = minor;
+       } else {
+               *minor_to_use = msg.minor;
+       }
+
+       /* Version number compatible */
+       DBG2("Relayd version is compatible, using protocol version %u.%u",
+                       major, *minor_to_use);
+       ret = 0;
 
 error:
        return ret;
@@ -250,15 +331,44 @@ int relayd_connect(struct lttcomm_sock *sock)
 
 /*
  * Close relayd socket with an allocated lttcomm_sock.
+ *
+ * If no socket operations are found, simply return 0 meaning that everything
+ * is fine. Without operations, the socket can not possibly be opened or used.
+ * This is possible if the socket was allocated but not created. However, the
+ * caller could simply use it to store a valid file descriptor for instance
+ * passed over a Unix socket and call this to cleanup but still without a valid
+ * ops pointer.
+ *
+ * Return the close returned value. On error, a negative value is usually
+ * returned back from close(2).
  */
 int relayd_close(struct lttcomm_sock *sock)
 {
+       int ret;
+
        /* Code flow error. Safety net. */
        assert(sock);
 
+       /* An invalid fd is fine, return success. */
+       if (sock->fd < 0) {
+               ret = 0;
+               goto end;
+       }
+
        DBG3("Relayd closing socket %d", sock->fd);
 
-       return sock->ops->close(sock);
+       if (sock->ops) {
+               ret = sock->ops->close(sock);
+       } else {
+               /* Default call if no specific ops found. */
+               ret = close(sock->fd);
+               if (ret < 0) {
+                       PERROR("relayd_close default close");
+               }
+       }
+
+end:
+       return ret;
 }
 
 /*
@@ -283,6 +393,7 @@ int relayd_send_data_hdr(struct lttcomm_sock *sock,
        /* Only send data header. */
        ret = sock->ops->sendmsg(sock, hdr, size, 0);
        if (ret < 0) {
+               ret = -errno;
                goto error;
        }
 
@@ -319,7 +430,7 @@ int relayd_send_close_stream(struct lttcomm_sock *sock, uint64_t stream_id,
                goto error;
        }
 
-       /* Recevie response */
+       /* Receive response */
        ret = recv_reply(sock, (void *) &reply, sizeof(reply));
        if (ret < 0) {
                goto error;
@@ -329,8 +440,8 @@ int relayd_send_close_stream(struct lttcomm_sock *sock, uint64_t stream_id,
 
        /* Return session id or negative ret code. */
        if (reply.ret_code != LTTNG_OK) {
-               ret = -reply.ret_code;
-               ERR("Relayd close stream replied error %d", ret);
+               ret = -1;
+               ERR("Relayd close stream replied error %d", reply.ret_code);
        } else {
                /* Success */
                ret = 0;
@@ -341,3 +452,189 @@ int relayd_send_close_stream(struct lttcomm_sock *sock, uint64_t stream_id,
 error:
        return ret;
 }
+
+/*
+ * Check for data availability for a given stream id.
+ *
+ * Return 0 if NOT pending, 1 if so and a negative value on error.
+ */
+int relayd_data_pending(struct lttcomm_sock *sock, uint64_t stream_id,
+               uint64_t last_net_seq_num)
+{
+       int ret;
+       struct lttcomm_relayd_data_pending msg;
+       struct lttcomm_relayd_generic_reply reply;
+
+       /* Code flow error. Safety net. */
+       assert(sock);
+
+       DBG("Relayd data pending for stream id %" PRIu64, stream_id);
+
+       msg.stream_id = htobe64(stream_id);
+       msg.last_net_seq_num = htobe64(last_net_seq_num);
+
+       /* Send command */
+       ret = send_command(sock, RELAYD_DATA_PENDING, (void *) &msg,
+                       sizeof(msg), 0);
+       if (ret < 0) {
+               goto error;
+       }
+
+       /* Receive response */
+       ret = recv_reply(sock, (void *) &reply, sizeof(reply));
+       if (ret < 0) {
+               goto error;
+       }
+
+       reply.ret_code = be32toh(reply.ret_code);
+
+       /* Return session id or negative ret code. */
+       if (reply.ret_code >= LTTNG_OK) {
+               ERR("Relayd data pending replied error %d", reply.ret_code);
+       }
+
+       /* At this point, the ret code is either 1 or 0 */
+       ret = reply.ret_code;
+
+       DBG("Relayd data is %s pending for stream id %" PRIu64,
+                       ret == 1 ? "" : "NOT", stream_id);
+
+error:
+       return ret;
+}
+
+/*
+ * Check on the relayd side for a quiescent state on the control socket.
+ */
+int relayd_quiescent_control(struct lttcomm_sock *sock,
+               uint64_t metadata_stream_id)
+{
+       int ret;
+       struct lttcomm_relayd_quiescent_control msg;
+       struct lttcomm_relayd_generic_reply reply;
+
+       /* Code flow error. Safety net. */
+       assert(sock);
+
+       DBG("Relayd checking quiescent control state");
+
+       msg.stream_id = htobe64(metadata_stream_id);
+
+       /* Send command */
+       ret = send_command(sock, RELAYD_QUIESCENT_CONTROL, &msg, sizeof(msg), 0);
+       if (ret < 0) {
+               goto error;
+       }
+
+       /* Receive response */
+       ret = recv_reply(sock, (void *) &reply, sizeof(reply));
+       if (ret < 0) {
+               goto error;
+       }
+
+       reply.ret_code = be32toh(reply.ret_code);
+
+       /* Return session id or negative ret code. */
+       if (reply.ret_code != LTTNG_OK) {
+               ret = -1;
+               ERR("Relayd quiescent control replied error %d", reply.ret_code);
+               goto error;
+       }
+
+       /* Control socket is quiescent */
+       return 0;
+
+error:
+       return ret;
+}
+
+/*
+ * Begin a data pending command for a specific session id.
+ */
+int relayd_begin_data_pending(struct lttcomm_sock *sock, uint64_t id)
+{
+       int ret;
+       struct lttcomm_relayd_begin_data_pending msg;
+       struct lttcomm_relayd_generic_reply reply;
+
+       /* Code flow error. Safety net. */
+       assert(sock);
+
+       DBG("Relayd begin data pending");
+
+       msg.session_id = htobe64(id);
+
+       /* Send command */
+       ret = send_command(sock, RELAYD_BEGIN_DATA_PENDING, &msg, sizeof(msg), 0);
+       if (ret < 0) {
+               goto error;
+       }
+
+       /* Receive response */
+       ret = recv_reply(sock, (void *) &reply, sizeof(reply));
+       if (ret < 0) {
+               goto error;
+       }
+
+       reply.ret_code = be32toh(reply.ret_code);
+
+       /* Return session id or negative ret code. */
+       if (reply.ret_code != LTTNG_OK) {
+               ret = -1;
+               ERR("Relayd begin data pending replied error %d", reply.ret_code);
+               goto error;
+       }
+
+       return 0;
+
+error:
+       return ret;
+}
+
+/*
+ * End a data pending command for a specific session id.
+ *
+ * Return 0 on success and set is_data_inflight to 0 if no data is being
+ * streamed or 1 if it is the case.
+ */
+int relayd_end_data_pending(struct lttcomm_sock *sock, uint64_t id,
+               unsigned int *is_data_inflight)
+{
+       int ret;
+       struct lttcomm_relayd_end_data_pending msg;
+       struct lttcomm_relayd_generic_reply reply;
+
+       /* Code flow error. Safety net. */
+       assert(sock);
+
+       DBG("Relayd end data pending");
+
+       msg.session_id = htobe64(id);
+
+       /* Send command */
+       ret = send_command(sock, RELAYD_END_DATA_PENDING, &msg, sizeof(msg), 0);
+       if (ret < 0) {
+               goto error;
+       }
+
+       /* Receive response */
+       ret = recv_reply(sock, (void *) &reply, sizeof(reply));
+       if (ret < 0) {
+               goto error;
+       }
+
+       reply.ret_code = be32toh(reply.ret_code);
+       if (reply.ret_code < 0) {
+               ret = reply.ret_code;
+               goto error;
+       }
+
+       *is_data_inflight = reply.ret_code;
+
+       DBG("Relayd end data pending is data inflight: %d", reply.ret_code);
+
+       return 0;
+
+error:
+       return ret;
+}
This page took 0.027888 seconds and 4 git commands to generate.