use tran_sock_*() namespace (#308)

Rename (again!) all internal tran_sock APIs so it's very clear which cases are
directly using them, perhaps when they shouldn't.

Signed-off-by: John Levon <john.levon@nutanix.com>
Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>

4 files changed, 122 insertions, 120 deletions

diff --git a/lib/irq.c b/lib/irq.c
index 0410926..36d7346 100644
--- a/lib/irq.c
+++ b/lib/irq.c
@@ -427,10 +427,10 @@ vfu_irq_message(vfu_ctx_t *vfu_ctx, uint32_t subindex)
     }
 
     irq_info.subindex = subindex;
-    ret = vfu_msg(vfu_ctx->conn_fd, msg_id,
-                 VFIO_USER_VM_INTERRUPT,
-                 &irq_info, sizeof irq_info,
-                 NULL, NULL, 0);
+    ret = tran_sock_msg(vfu_ctx->conn_fd, msg_id,
+                        VFIO_USER_VM_INTERRUPT,
+                        &irq_info, sizeof irq_info,
+                        NULL, NULL, 0);
     if (ret < 0) {
         /* FIXME should return -errno */
 	    errno = -ret;
diff --git a/lib/libvfio-user.c b/lib/libvfio-user.c
index fce7923..98ddef3 100644
--- a/lib/libvfio-user.c
+++ b/lib/libvfio-user.c
@@ -932,8 +932,9 @@ process_request(vfu_ctx_t *vfu_ctx)
 
     if (!(hdr.flags.no_reply)) {
         // FIXME: SPEC: should the reply include the command? I'd say yes?
-        ret = vfu_send_iovec(vfu_ctx->conn_fd, hdr.msg_id, true,
-                             0, iovecs, nr_iovecs, fds_out, nr_fds_out, -ret);
+        ret = tran_sock_send_iovec(vfu_ctx->conn_fd, hdr.msg_id, true, 0,
+                                   iovecs, nr_iovecs, fds_out, nr_fds_out,
+                                   -ret);
         if (unlikely(ret < 0)) {
             vfu_log(vfu_ctx, LOG_ERR, "failed to complete command: %s",
                     strerror(-ret));
@@ -1149,7 +1150,7 @@ vfu_create_ctx(vfu_trans_t trans, const char *path, int flags, void *pvt,
     vfu_ctx->fd = -1;
     vfu_ctx->conn_fd = -1;
     vfu_ctx->dev_type = dev_type;
-    vfu_ctx->trans = &sock_transport_ops;
+    vfu_ctx->trans = &tran_sock_ops;
     vfu_ctx->pvt = pvt;
     vfu_ctx->flags = flags;
     vfu_ctx->log_level = LOG_ERR;
@@ -1444,9 +1445,9 @@ vfu_dma_read(vfu_ctx_t *vfu_ctx, dma_sg_t *sg, void *data)
 
     dma_send.addr = sg->dma_addr;
     dma_send.count = sg->length;
-    ret = vfu_msg(vfu_ctx->conn_fd, msg_id, VFIO_USER_DMA_READ,
-                  &dma_send, sizeof dma_send, NULL,
-                  dma_recv, recv_size);
+    ret = tran_sock_msg(vfu_ctx->conn_fd, msg_id, VFIO_USER_DMA_READ,
+                        &dma_send, sizeof dma_send, NULL,
+                        dma_recv, recv_size);
     memcpy(data, dma_recv->data, sg->length); /* FIXME no need for memcpy */
     free(dma_recv);
 
@@ -1470,9 +1471,9 @@ vfu_dma_write(vfu_ctx_t *vfu_ctx, dma_sg_t *sg, void *data)
     dma_send->addr = sg->dma_addr;
     dma_send->count = sg->length;
     memcpy(dma_send->data, data, sg->length); /* FIXME no need to copy! */
-    ret = vfu_msg(vfu_ctx->conn_fd, msg_id, VFIO_USER_DMA_WRITE,
-                  dma_send, send_size, NULL,
-                  &dma_recv, sizeof(dma_recv));
+    ret = tran_sock_msg(vfu_ctx->conn_fd, msg_id, VFIO_USER_DMA_WRITE,
+                        dma_send, send_size, NULL,
+                        &dma_recv, sizeof(dma_recv));
     free(dma_send);
 
     return ret;
diff --git a/lib/tran_sock.c b/lib/tran_sock.c
index aadbdd2..fe54736 100644
--- a/lib/tran_sock.c
+++ b/lib/tran_sock.c
@@ -71,7 +71,7 @@ recv_blocking(int sock, void *buf, size_t len, int flags)
 }
 
 static int
-init_sock(vfu_ctx_t *vfu_ctx)
+tran_sock_init(vfu_ctx_t *vfu_ctx)
 {
     struct sockaddr_un addr = { .sun_family = AF_UNIX };
     int ret, unix_sock;
@@ -128,10 +128,10 @@ out:
 }
 
 int
-vfu_send_iovec(int sock, uint16_t msg_id, bool is_reply,
-               enum vfio_user_command cmd,
-               struct iovec *iovecs, size_t nr_iovecs,
-               int *fds, int count, int err)
+tran_sock_send_iovec(int sock, uint16_t msg_id, bool is_reply,
+                     enum vfio_user_command cmd,
+                     struct iovec *iovecs, size_t nr_iovecs,
+                     int *fds, int count, int err)
 {
     int ret;
     struct vfio_user_header hdr = {.msg_id = msg_id};
@@ -195,9 +195,9 @@ vfu_send_iovec(int sock, uint16_t msg_id, bool is_reply,
 }
 
 int
-vfu_send(int sock, uint16_t msg_id, bool is_reply,
-         enum vfio_user_command cmd,
-         void *data, size_t data_len)
+tran_sock_send(int sock, uint16_t msg_id, bool is_reply,
+               enum vfio_user_command cmd,
+               void *data, size_t data_len)
 {
     /* [0] is for the header. */
     struct iovec iovecs[2] = {
@@ -206,16 +206,17 @@ vfu_send(int sock, uint16_t msg_id, bool is_reply,
             .iov_len = data_len
         }
     };
-    return vfu_send_iovec(sock, msg_id, is_reply, cmd, iovecs,
-                          ARRAY_SIZE(iovecs), NULL, 0, 0);
+    return tran_sock_send_iovec(sock, msg_id, is_reply, cmd, iovecs,
+                                ARRAY_SIZE(iovecs), NULL, 0, 0);
 }
 
 int
-vfu_send_error(int sock, uint16_t msg_id,
+tran_sock_send_error(int sock, uint16_t msg_id,
                      enum vfio_user_command cmd,
                      int error)
 {
-    return vfu_send_iovec(sock, msg_id, true, cmd, NULL, 0, NULL, 0, error);
+    return tran_sock_send_iovec(sock, msg_id, true, cmd,
+                                NULL, 0, NULL, 0, error);
 }
 
 static int
@@ -274,9 +275,9 @@ get_msg(void *data, size_t len, int *fds, size_t *nr_fds, int sock_fd,
  * better.
  */
 int
-vfu_recv_fds(int sock, struct vfio_user_header *hdr, bool is_reply,
-             uint16_t *msg_id, void *data, size_t *len, int *fds,
-             size_t *nr_fds)
+tran_sock_recv_fds(int sock, struct vfio_user_header *hdr, bool is_reply,
+                   uint16_t *msg_id, void *data, size_t *len, int *fds,
+                   size_t *nr_fds)
 {
     int ret;
 
@@ -329,26 +330,27 @@ vfu_recv_fds(int sock, struct vfio_user_header *hdr, bool is_reply,
 }
 
 int
-vfu_recv(int sock, struct vfio_user_header *hdr, bool is_reply,
+tran_sock_recv(int sock, struct vfio_user_header *hdr, bool is_reply,
          uint16_t *msg_id, void *data, size_t *len)
 {
-    return vfu_recv_fds(sock, hdr, is_reply, msg_id, data, len, NULL, NULL);
+    return tran_sock_recv_fds(sock, hdr, is_reply, msg_id,
+                              data, len, NULL, NULL);
 }
 
 /*
- * Like vfu_recv(), but will automatically allocate reply data.
+ * Like tran_sock_recv(), but will automatically allocate reply data.
  *
  * FIXME: this does an unconstrained alloc of client-supplied data.
  */
 int
-vfu_recv_alloc(int sock, struct vfio_user_header *hdr, bool is_reply,
-              uint16_t *msg_id, void **datap, size_t *lenp)
+tran_sock_recv_alloc(int sock, struct vfio_user_header *hdr, bool is_reply,
+                     uint16_t *msg_id, void **datap, size_t *lenp)
 {
     void *data;
     size_t len;
     int ret;
 
-    ret = vfu_recv(sock, hdr, is_reply, msg_id, NULL, NULL);
+    ret = tran_sock_recv(sock, hdr, is_reply, msg_id, NULL, NULL);
 
     if (ret != 0) {
         return ret;
@@ -391,31 +393,31 @@ vfu_recv_alloc(int sock, struct vfio_user_header *hdr, bool is_reply,
  * messages.
  */
 int
-vfu_msg_iovec(int sock, uint16_t msg_id, enum vfio_user_command cmd,
-              struct iovec *iovecs, size_t nr_iovecs,
-              int *send_fds, size_t send_fd_count,
-              struct vfio_user_header *hdr,
-              void *recv_data, size_t recv_len,
-              int *recv_fds, size_t *recv_fd_count)
+tran_sock_msg_iovec(int sock, uint16_t msg_id, enum vfio_user_command cmd,
+                    struct iovec *iovecs, size_t nr_iovecs,
+                    int *send_fds, size_t send_fd_count,
+                    struct vfio_user_header *hdr,
+                    void *recv_data, size_t recv_len,
+                    int *recv_fds, size_t *recv_fd_count)
 {
-    int ret = vfu_send_iovec(sock, msg_id, false, cmd, iovecs, nr_iovecs,
-                             send_fds, send_fd_count, 0);
+    int ret = tran_sock_send_iovec(sock, msg_id, false, cmd, iovecs, nr_iovecs,
+                                   send_fds, send_fd_count, 0);
     if (ret < 0) {
         return ret;
     }
     if (hdr == NULL) {
         hdr = alloca(sizeof *hdr);
     }
-    return vfu_recv_fds(sock, hdr, true, &msg_id, recv_data, &recv_len,
-                        recv_fds, recv_fd_count);
+    return tran_sock_recv_fds(sock, hdr, true, &msg_id, recv_data, &recv_len,
+                              recv_fds, recv_fd_count);
 }
 
 int
-vfu_msg_fds(int sock, uint16_t msg_id, enum vfio_user_command cmd,
-            void *send_data, size_t send_len,
-            struct vfio_user_header *hdr,
-            void *recv_data, size_t recv_len, int *recv_fds,
-            size_t *recv_fd_count)
+tran_sock_msg_fds(int sock, uint16_t msg_id, enum vfio_user_command cmd,
+                  void *send_data, size_t send_len,
+                  struct vfio_user_header *hdr,
+                  void *recv_data, size_t recv_len, int *recv_fds,
+                  size_t *recv_fd_count)
 {
     /* [0] is for the header. */
     struct iovec iovecs[2] = {
@@ -424,19 +426,19 @@ vfu_msg_fds(int sock, uint16_t msg_id, enum vfio_user_command cmd,
             .iov_len = send_len
         }
     };
-    return vfu_msg_iovec(sock, msg_id, cmd, iovecs, ARRAY_SIZE(iovecs),
-                         NULL, 0, hdr, recv_data, recv_len, recv_fds,
-                         recv_fd_count);
+    return tran_sock_msg_iovec(sock, msg_id, cmd, iovecs, ARRAY_SIZE(iovecs),
+                               NULL, 0, hdr, recv_data, recv_len, recv_fds,
+                               recv_fd_count);
 }
 
 int
-vfu_msg(int sock, uint16_t msg_id, enum vfio_user_command cmd,
-        void *send_data, size_t send_len,
-        struct vfio_user_header *hdr,
-        void *recv_data, size_t recv_len)
+tran_sock_msg(int sock, uint16_t msg_id, enum vfio_user_command cmd,
+              void *send_data, size_t send_len,
+              struct vfio_user_header *hdr,
+              void *recv_data, size_t recv_len)
 {
-    return vfu_msg_fds(sock, msg_id, cmd, send_data, send_len, hdr, recv_data,
-                       recv_len, NULL, NULL);
+    return tran_sock_msg_fds(sock, msg_id, cmd, send_data, send_len, hdr,
+                             recv_data, recv_len, NULL, NULL);
 }
 
 /*
@@ -455,8 +457,8 @@ vfu_msg(int sock, uint16_t msg_id, enum vfio_user_command cmd,
  * available in newer library versions, so we don't use it.
  */
 int
-vfu_parse_version_json(const char *json_str,
-                       int *client_max_fdsp, size_t *pgsizep)
+tran_parse_version_json(const char *json_str,
+                        int *client_max_fdsp, size_t *pgsizep)
 {
     struct json_object *jo_caps = NULL;
     struct json_object *jo_top = NULL;
@@ -529,8 +531,8 @@ recv_version(vfu_ctx_t *vfu_ctx, int sock, uint16_t *msg_idp,
 
     *versionp = NULL;
 
-    ret = vfu_recv_alloc(sock, &hdr, false, msg_idp,
-                         (void **)&cversion, &vlen);
+    ret = tran_sock_recv_alloc(sock, &hdr, false, msg_idp,
+                               (void **)&cversion, &vlen);
 
     if (ret < 0) {
         vfu_log(vfu_ctx, LOG_ERR, "failed to receive version: %s",
@@ -572,8 +574,8 @@ recv_version(vfu_ctx_t *vfu_ctx, int sock, uint16_t *msg_idp,
             goto out;
         }
 
-        ret = vfu_parse_version_json(json_str, &vfu_ctx->client_max_fds,
-                                     &pgsize);
+        ret = tran_parse_version_json(json_str, &vfu_ctx->client_max_fds,
+                                      &pgsize);
 
         if (ret < 0) {
             /* No client-supplied strings in the log for release build. */
@@ -609,7 +611,7 @@ recv_version(vfu_ctx_t *vfu_ctx, int sock, uint16_t *msg_idp,
 out:
     if (ret != 0) {
         // FIXME: spec, is it OK to just have the header?
-        (void) vfu_send_error(sock, *msg_idp, hdr.cmd, ret);
+        (void) tran_sock_send_error(sock, *msg_idp, hdr.cmd, ret);
         free(cversion);
         cversion = NULL;
     }
@@ -658,8 +660,8 @@ send_version(vfu_ctx_t *vfu_ctx, int sock, uint16_t msg_id,
     /* Include the NUL. */
     iovecs[2].iov_len = slen + 1;
 
-    return vfu_send_iovec(sock, msg_id, true, VFIO_USER_VERSION,
-                          iovecs, ARRAY_SIZE(iovecs), NULL, 0, 0);
+    return tran_sock_send_iovec(sock, msg_id, true, VFIO_USER_VERSION,
+                                iovecs, ARRAY_SIZE(iovecs), NULL, 0, 0);
 }
 
 static int
@@ -688,7 +690,7 @@ negotiate(vfu_ctx_t *vfu_ctx, int sock)
 }
 
 static int
-open_sock(vfu_ctx_t *vfu_ctx)
+tran_sock_attach(vfu_ctx_t *vfu_ctx)
 {
     int ret;
     int conn_fd;
@@ -711,8 +713,8 @@ open_sock(vfu_ctx_t *vfu_ctx)
 }
 
 static int
-get_request_sock(vfu_ctx_t *vfu_ctx, struct vfio_user_header *hdr,
-                 int *fds, size_t *nr_fds)
+tran_sock_get_request(vfu_ctx_t *vfu_ctx, struct vfio_user_header *hdr,
+                      int *fds, size_t *nr_fds)
 {
     int sock_flags = 0;
 
@@ -728,7 +730,7 @@ get_request_sock(vfu_ctx_t *vfu_ctx, struct vfio_user_header *hdr,
 }
 
 static void
-detach_sock(vfu_ctx_t *vfu_ctx)
+tran_sock_detach(vfu_ctx_t *vfu_ctx)
 {
     if (vfu_ctx->conn_fd != -1) {
         (void) close(vfu_ctx->conn_fd);
@@ -737,7 +739,7 @@ detach_sock(vfu_ctx_t *vfu_ctx)
 }
 
 static void
-fini_sock(vfu_ctx_t *vfu_ctx)
+tran_sock_fini(vfu_ctx_t *vfu_ctx)
 {
     if (vfu_ctx->fd != -1) {
         (void) close(vfu_ctx->fd);
@@ -745,12 +747,12 @@ fini_sock(vfu_ctx_t *vfu_ctx)
     }
 }
 
-struct transport_ops sock_transport_ops = {
-    .init = init_sock,
-    .attach = open_sock,
-    .get_request = get_request_sock,
-    .detach = detach_sock,
-    .fini = fini_sock,
+struct transport_ops tran_sock_ops = {
+    .init = tran_sock_init,
+    .attach = tran_sock_attach,
+    .get_request = tran_sock_get_request,
+    .detach = tran_sock_detach,
+    .fini = tran_sock_fini
 };
 
 /* ex: set tabstop=4 shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/lib/tran_sock.h b/lib/tran_sock.h
index c4ed30c..9b37776 100644
--- a/lib/tran_sock.h
+++ b/lib/tran_sock.h
@@ -46,41 +46,40 @@
 // FIXME: value?
 #define VFIO_USER_CLIENT_MAX_FDS_LIMIT (1024)
 
-extern struct transport_ops sock_transport_ops;
+extern struct transport_ops tran_sock_ops;
 
 /*
  * Parse JSON supplied from the other side into the known parameters. Note: they
  * will not be set if not found in the JSON.
  */
 int
-vfu_parse_version_json(const char *json_str, int *client_max_fdsp,
-                       size_t *pgsizep);
+tran_parse_version_json(const char *json_str, int *client_max_fdsp,
+                        size_t *pgsizep);
 
 /*
  * Send a message to the other end.  The iovecs array should leave the first
  * entry empty, as it will be used for the header.
  */
 int
-vfu_send_iovec(int sock, uint16_t msg_id, bool is_reply,
-               enum vfio_user_command cmd,
-               struct iovec *iovecs, size_t nr_iovecs,
-               int *fds, int count,
-               int err);
+tran_sock_send_iovec(int sock, uint16_t msg_id, bool is_reply,
+                     enum vfio_user_command cmd,
+                     struct iovec *iovecs, size_t nr_iovecs,
+                     int *fds, int count,
+                     int err);
 
 /*
  * Send a message to the other end with the given data.
  */
 int
-vfu_send(int sock, uint16_t msg_id, bool is_reply, enum vfio_user_command cmd,
-         void *data, size_t data_len);
+tran_sock_send(int sock, uint16_t msg_id, bool is_reply,
+               enum vfio_user_command cmd, void *data, size_t data_len);
 
 /*
  * Send an empty reply back to the other end with the given errno.
  */
 int
-vfu_send_error(int sock, uint16_t msg_id,
-               enum vfio_user_command cmd,
-               int error);
+tran_sock_send_error(int sock, uint16_t msg_id,
+                     enum vfio_user_command cmd, int error);
 
 /*
  * Receive a message from the other end, and place the data into the given
@@ -88,17 +87,17 @@ vfu_send_error(int sock, uint16_t msg_id,
  * size.
  */
 int
-vfu_recv(int sock, struct vfio_user_header *hdr, bool is_reply,
-         uint16_t *msg_id, void *data, size_t *len);
+tran_sock_recv(int sock, struct vfio_user_header *hdr, bool is_reply,
+               uint16_t *msg_id, void *data, size_t *len);
 
 /*
- * Same as vfu_recv except it receives passed file descriptors. See vfu_msg on
- * the semantics of @fds and @nr_fds.
+ * Same as tran_sock_recv except it receives passed file descriptors. See
+ * tran_sock_msg on the semantics of @fds and @nr_fds.
  */
 int
-vfu_recv_fds(int sock, struct vfio_user_header *hdr, bool is_reply,
-             uint16_t *msg_id, void *data, size_t *len, int *fds,
-             size_t *nr_fds);
+tran_sock_recv_fds(int sock, struct vfio_user_header *hdr, bool is_reply,
+                   uint16_t *msg_id, void *data, size_t *len, int *fds,
+                   size_t *nr_fds);
 
 /*
  * Receive a message from the other end, but automatically allocate a buffer for
@@ -106,8 +105,8 @@ vfu_recv_fds(int sock, struct vfio_user_header *hdr, bool is_reply,
  * NULL.
  */
 int
-vfu_recv_alloc(int sock, struct vfio_user_header *hdr, bool is_reply,
-               uint16_t *msg_id, void **datap, size_t *lenp);
+tran_sock_recv_alloc(int sock, struct vfio_user_header *hdr, bool is_reply,
+                     uint16_t *msg_id, void **datap, size_t *lenp);
 
 /*
  * Send and receive a message to the other end, using iovecs for the send. The
@@ -126,36 +125,36 @@ vfu_recv_alloc(int sock, struct vfio_user_header *hdr, bool is_reply,
  * original value of @recv_fd_count.
  */
 int
-vfu_msg_iovec(int sock, uint16_t msg_id,
-              enum vfio_user_command cmd,
-              struct iovec *iovecs, size_t nr_iovecs,
-              int *send_fds, size_t send_fd_count,
-              struct vfio_user_header *hdr,
-              void *recv_data, size_t recv_len,
-              int *recv_fds, size_t *recv_fd_count);
+tran_sock_msg_iovec(int sock, uint16_t msg_id,
+                    enum vfio_user_command cmd,
+                    struct iovec *iovecs, size_t nr_iovecs,
+                    int *send_fds, size_t send_fd_count,
+                    struct vfio_user_header *hdr,
+                    void *recv_data, size_t recv_len,
+                    int *recv_fds, size_t *recv_fd_count);
 
 /*
  * Send and receive a message to the other end.  @hdr is filled with the reply
  * header if non-NULL.
  */
 int
-vfu_msg(int sock, uint16_t msg_id,
-        enum vfio_user_command cmd,
-        void *send_data, size_t send_len,
-        struct vfio_user_header *hdr,
-        void *recv_data, size_t recv_len);
+tran_sock_msg(int sock, uint16_t msg_id,
+              enum vfio_user_command cmd,
+              void *send_data, size_t send_len,
+              struct vfio_user_header *hdr,
+              void *recv_data, size_t recv_len);
 
 /*
- * Same as vfu_msg excecpt that file descriptors can be received, see
- * vfu_msg_iovec for the semantics of @recv_fds and @recv_fd_count.
+ * Same as tran_sock_msg excecpt that file descriptors can be received, see
+ * tran_sock_msg_iovec for the semantics of @recv_fds and @recv_fd_count.
  */
 int
-vfu_msg_fds(int sock, uint16_t msg_id,
-            enum vfio_user_command cmd,
-            void *send_data, size_t send_len,
-            struct vfio_user_header *hdr,
-            void *recv_data, size_t recv_len,
-            int *recv_fds, size_t *recv_fd_count);
+tran_sock_msg_fds(int sock, uint16_t msg_id,
+                  enum vfio_user_command cmd,
+                  void *send_data, size_t send_len,
+                  struct vfio_user_header *hdr,
+                  void *recv_data, size_t recv_len,
+                  int *recv_fds, size_t *recv_fd_count);
 
 
 #endif /* LIB_VFIO_USER_TRAN_SOCK_H */