refactor sock send/recv functions (#114)

Use shorter, more readable, function names, add re-jig the wrappers such that
the most common operations are shortest.

1 files changed, 85 insertions, 69 deletions

diff --git a/samples/client.c b/samples/client.c
index 9daab81..3231e60 100644
--- a/samples/client.c
+++ b/samples/client.c
@@ -116,7 +116,7 @@ send_version(int sock)
     /* Include the NUL. */
     iovecs[2].iov_len = slen + 1;
 
-    ret = _send_vfio_user_msg(sock, msg_id, false, VFIO_USER_VERSION,
+    ret = vfio_user_send_iovec(sock, msg_id, false, VFIO_USER_VERSION,
                               iovecs, ARRAY_SIZE(iovecs), NULL, 0, 0);
 
     if (ret < 0) {
@@ -133,8 +133,8 @@ recv_version(int sock, int *server_max_fds, size_t *pgsize)
     size_t vlen;
     int ret;
 
-    ret = recv_vfio_user_msg_alloc(sock, &hdr, true, &msg_id,
-                                   (void **)&sversion, &vlen);
+    ret = vfio_user_recv_alloc(sock, &hdr, true, &msg_id,
+                               (void **)&sversion, &vlen);
 
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to receive version: %s", strerror(-ret));
@@ -177,7 +177,7 @@ recv_version(int sock, int *server_max_fds, size_t *pgsize)
             errx(EXIT_FAILURE, "ignoring invalid JSON from server");
         }
 
-        ret = parse_version_json(json_str, server_max_fds, pgsize);
+        ret = vfio_user_parse_version_json(json_str, server_max_fds, pgsize);
 
         if (ret < 0) {
             errx(EXIT_FAILURE, "failed to parse server JSON \"%s\"", json_str);
@@ -197,8 +197,8 @@ negotiate(int sock, int *server_max_fds, size_t *pgsize)
 static void
 send_device_reset(int sock)
 {
-    int ret = send_recv_vfio_user_msg(sock, 1, VFIO_USER_DEVICE_RESET,
-                                      NULL, 0, NULL, 0, NULL, NULL, 0);
+    int ret = vfio_user_msg(sock, 1, VFIO_USER_DEVICE_RESET,
+                            NULL, 0, NULL, NULL, 0);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to reset device: %s\n", strerror(-ret));
     }
@@ -266,22 +266,21 @@ static int
 get_device_region_info(int sock, struct vfio_device_info *client_dev_info)
 {
     struct vfio_region_info region_info;
-    uint16_t msg_id = 0;
+    uint16_t msg_id = 1;
     size_t cap_sz;
     int ret, migr_reg_index = -1;
     unsigned int i;
 
-    msg_id = 1;
     for (i = 0; i < client_dev_info->num_regions; i++) {
         memset(&region_info, 0, sizeof(region_info));
         region_info.argsz = sizeof(region_info);
         region_info.index = i;
         msg_id++;
-        ret = send_recv_vfio_user_msg(sock, msg_id,
-                                      VFIO_USER_DEVICE_GET_REGION_INFO,
-                                      &region_info, sizeof region_info,
-                                      NULL, 0, NULL,
-                                      &region_info, sizeof(region_info));
+        ret = vfio_user_msg(sock, msg_id,
+                            VFIO_USER_DEVICE_GET_REGION_INFO,
+                            &region_info, sizeof region_info,
+                            NULL,
+                            &region_info, sizeof(region_info));
         if (ret < 0) {
             errx(EXIT_FAILURE, "failed to get device region info: %s",
                     strerror(-ret));
@@ -304,14 +303,17 @@ get_device_region_info(int sock, struct vfio_device_info *client_dev_info)
 static void
 get_device_info(int sock, struct vfio_device_info *dev_info)
 {
-    uint16_t msg_id;
+    uint16_t msg_id = 2;
     int ret;
 
     dev_info->argsz = sizeof(*dev_info);
-    msg_id = 1;
-    ret = send_recv_vfio_user_msg(sock, msg_id, VFIO_USER_DEVICE_GET_INFO,
-                                  dev_info, sizeof(*dev_info), NULL, 0, NULL,
-                                  dev_info, sizeof(*dev_info));
+
+    ret = vfio_user_msg(sock, msg_id,
+                        VFIO_USER_DEVICE_GET_INFO,
+                        dev_info, sizeof(*dev_info),
+                        NULL,
+                        dev_info, sizeof(*dev_info));
+
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to get device info: %s", strerror(-ret));
     }
@@ -323,21 +325,22 @@ get_device_info(int sock, struct vfio_device_info *dev_info)
 static int
 configure_irqs(int sock)
 {
-    int i, ret;
+    struct iovec iovecs[2] = { { 0, } };
     struct vfio_irq_set irq_set;
-    uint16_t msg_id = 1;
+    uint16_t msg_id = 3;
     int irq_fd;
+    int i, ret;
 
     for (i = 0; i < LM_DEV_NUM_IRQS; i++) { /* TODO move body of loop into function */
         struct vfio_irq_info vfio_irq_info = {
             .argsz = sizeof vfio_irq_info,
             .index = i
         };
-        ret = send_recv_vfio_user_msg(sock, msg_id,
-                                      VFIO_USER_DEVICE_GET_IRQ_INFO,
-                                      &vfio_irq_info, sizeof vfio_irq_info,
-                                      NULL, 0, NULL,
-                                      &vfio_irq_info, sizeof vfio_irq_info);
+        ret = vfio_user_msg(sock, msg_id,
+                            VFIO_USER_DEVICE_GET_IRQ_INFO,
+                            &vfio_irq_info, sizeof vfio_irq_info,
+                            NULL,
+                            &vfio_irq_info, sizeof vfio_irq_info);
         if (ret < 0) {
             errx(EXIT_FAILURE, "failed to get  %s info: %s", irq_to_str[i],
                  strerror(-ret));
@@ -359,9 +362,16 @@ configure_irqs(int sock)
     if (irq_fd == -1) {
         err(EXIT_FAILURE, "failed to create eventfd");
     }
-    ret = send_recv_vfio_user_msg(sock, msg_id, VFIO_USER_DEVICE_SET_IRQS,
-                                  &irq_set, sizeof irq_set, &irq_fd, 1, NULL,
-                                  NULL, 0);
+
+    /* [0] is for the header. */
+    iovecs[1].iov_base = &irq_set;
+    iovecs[1].iov_len = sizeof (irq_set);
+
+    ret = vfio_user_msg_iovec(sock, msg_id, VFIO_USER_DEVICE_SET_IRQS,
+                              iovecs, ARRAY_SIZE(iovecs),
+                              &irq_fd, 1,
+                              NULL, NULL, 0);
+
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to send configure IRQs message: %s",
              strerror(-ret));
@@ -406,10 +416,10 @@ access_region(int sock, int region, bool is_write, uint64_t offset,
         recv_data_len = sizeof(recv_data);
     }
 
-    ret = _send_recv_vfio_user_msg(sock, 0, op,
-                                   send_iovecs, nr_send_iovecs,
-                                   NULL, 0, NULL,
-                                   &recv_data, recv_data_len);
+    ret = vfio_user_msg_iovec(sock, 0, op,
+                              send_iovecs, nr_send_iovecs,
+                              NULL, 0, NULL,
+                              &recv_data, recv_data_len);
     if (ret != 0) {
         warnx("failed to %s region %d %#lx-%#lx: %s",
              is_write ? "write to" : "read from", region, offset,
@@ -424,7 +434,7 @@ access_region(int sock, int region, bool is_write, uint64_t offset,
     }
 
     /*
-     * TODO we could avoid the memcpy if _sed_recv_vfio_user_msg received the
+     * TODO we could avoid the memcpy if _sed_vfio_user_recv received the
      * response into an iovec, but it's some work to implement it.
      */
     if (!is_write) {
@@ -441,7 +451,7 @@ wait_for_irqs(int sock, int irq_fd)
     size_t size;
     struct vfio_user_irq_info vfio_user_irq_info;
     struct vfio_user_header hdr;
-    uint16_t msg_id = 1;
+    uint16_t msg_id = 4;
 
     if (read(irq_fd, &val, sizeof val) == -1) {
         err(EXIT_FAILURE, "failed to read from irqfd");
@@ -449,24 +459,28 @@ wait_for_irqs(int sock, int irq_fd)
     printf("INTx triggered!\n");
 
     size = sizeof(vfio_user_irq_info);
-    ret = recv_vfio_user_msg(sock, &hdr, false, &msg_id, &vfio_user_irq_info,
-                             &size);
+    ret = vfio_user_recv(sock, &hdr, false, &msg_id,
+                         &vfio_user_irq_info, &size);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to receive IRQ message: %s",
              strerror(-ret));
     }
+
+    if (hdr.cmd != VFIO_USER_VM_INTERRUPT) {
+        errx(EXIT_FAILURE, "unexpected cmd %d\n", hdr.cmd);
+    }
+
     if (vfio_user_irq_info.subindex >= 1) {
         errx(EXIT_FAILURE, "bad IRQ %d, max=1\n", vfio_user_irq_info.subindex);
     }
 
-    ret = send_vfio_user_msg(sock, msg_id, true, VFIO_USER_VM_INTERRUPT,
-                             NULL, 0, NULL, 0);
+    // Is a NULL iovec like this OK?
+    ret = vfio_user_send(sock, msg_id, true, hdr.cmd, NULL, 0);
     if (ret < 0) {
         errx(EXIT_FAILURE,
              "failed to send reply for VFIO_USER_VM_INTERRUPT: %s",
              strerror(-ret));
     }
-    printf("INTx messaged triggered!\n");
 }
 
 static void
@@ -501,11 +515,10 @@ handle_dma_write(int sock, struct vfio_user_dma_region *dma_regions,
     struct vfio_user_header hdr;
     int ret, i;
     size_t size = sizeof(dma_access);
-    uint16_t msg_id;
+    uint16_t msg_id = 5;
     void *data;
 
-    msg_id = 1;
-    ret = recv_vfio_user_msg(sock, &hdr, false, &msg_id, &dma_access, &size);
+    ret = vfio_user_recv(sock, &hdr, false, &msg_id, &dma_access, &size);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to receive DMA read: %s", strerror(-ret));
     }
@@ -535,8 +548,8 @@ handle_dma_write(int sock, struct vfio_user_dma_region *dma_regions,
     }
 
     dma_access.count = 0;
-    ret = send_vfio_user_msg(sock, msg_id, true, VFIO_USER_DMA_WRITE,
-                             &dma_access, sizeof dma_access, NULL, 0);
+    ret = vfio_user_send(sock, msg_id, true, VFIO_USER_DMA_WRITE,
+                         &dma_access, sizeof dma_access);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to send reply of DMA write: %s",
              strerror(-ret));
@@ -552,11 +565,10 @@ handle_dma_read(int sock, struct vfio_user_dma_region *dma_regions,
     struct vfio_user_header hdr;
     int ret, i, response_sz;
     size_t size = sizeof(dma_access);
-    uint16_t msg_id;
+    uint16_t msg_id = 6;
     void *data;
 
-    msg_id = 1;
-    ret = recv_vfio_user_msg(sock, &hdr, false, &msg_id, &dma_access, &size);
+    ret = vfio_user_recv(sock, &hdr, false, &msg_id, &dma_access, &size);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to recieve DMA read");
     }
@@ -580,8 +592,8 @@ handle_dma_read(int sock, struct vfio_user_dma_region *dma_regions,
 	    }
     }
 
-    ret = send_vfio_user_msg(sock, msg_id, true, VFIO_USER_DMA_READ,
-                             response, response_sz, NULL, 0);
+    ret = vfio_user_send(sock, msg_id, true, VFIO_USER_DMA_READ,
+                         response, response_sz);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to send reply of DMA write: %s",
              strerror(-ret));
@@ -633,10 +645,10 @@ get_dirty_bitmaps(int sock, struct vfio_user_dma_region *dma_regions,
      */
     dirty_bitmap.argsz = sizeof(dirty_bitmap) + ARRAY_SIZE(bitmaps) * sizeof(struct vfio_iommu_type1_dirty_bitmap_get);
     dirty_bitmap.flags = VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP;
-    ret = _send_recv_vfio_user_msg(sock, 0, VFIO_USER_DIRTY_PAGES,
-                                  iovecs, ARRAY_SIZE(iovecs),
-                                  NULL, 0,
-                                  &hdr, data, ARRAY_SIZE(data));
+    ret = vfio_user_msg_iovec(sock, 0, VFIO_USER_DIRTY_PAGES,
+                              iovecs, ARRAY_SIZE(iovecs),
+                              NULL, 0,
+                              &hdr, data, ARRAY_SIZE(data));
     if (ret != 0) {
         errx(EXIT_FAILURE, "failed to start dirty page logging: %s",
              strerror(-ret));
@@ -861,16 +873,21 @@ migrate_to(char *old_sock_path, int *server_max_fds,
 
 static void
 map_dma_regions(int sock, int max_fds, struct vfio_user_dma_region *dma_regions,
-                int *dma_region_fds, int nr_dma_regions) 
+                int *dma_region_fds, int nr_dma_regions)
 {
     int i, ret;
 
     for (i = 0; i < nr_dma_regions / max_fds; i++) {
-        ret = send_recv_vfio_user_msg(sock, i, VFIO_USER_DMA_MAP,
-                                      dma_regions + (i * max_fds),
-                                      sizeof(*dma_regions) * max_fds,
-                                      dma_region_fds + (i * max_fds),
-                                      max_fds, NULL, NULL, 0);
+        struct iovec iovecs[2] = { { 0, } };
+
+        /* [0] is for the header. */
+        iovecs[1].iov_base = dma_regions + (i * max_fds);
+        iovecs[1].iov_len = sizeof (*dma_regions) * max_fds;
+
+        ret = vfio_user_msg_iovec(sock, i, VFIO_USER_DMA_MAP,
+                                  iovecs, ARRAY_SIZE(iovecs),
+                                  dma_region_fds + (i * max_fds), max_fds,
+                                  NULL, NULL, 0);
         if (ret < 0) {
             errx(EXIT_FAILURE, "failed to map DMA regions: %s", strerror(-ret));
         }
@@ -883,7 +900,6 @@ int main(int argc, char *argv[])
     struct vfio_user_dma_region *dma_regions;
     struct vfio_device_info client_dev_info = {0};
     int *dma_region_fds;
-    uint16_t msg_id = 1;
     int i;
     FILE *fp;
     int server_max_fds;
@@ -994,9 +1010,9 @@ int main(int argc, char *argv[])
 
     dirty_bitmap.argsz = sizeof dirty_bitmap;
     dirty_bitmap.flags = VFIO_IOMMU_DIRTY_PAGES_FLAG_START;
-    ret = send_recv_vfio_user_msg(sock, 0, VFIO_USER_DIRTY_PAGES,
-                                  &dirty_bitmap, sizeof dirty_bitmap,
-                                  NULL, 0, NULL, NULL, 0);
+    ret = vfio_user_msg(sock, 0, VFIO_USER_DIRTY_PAGES,
+                        &dirty_bitmap, sizeof dirty_bitmap,
+                        NULL, NULL, 0);
     if (ret != 0) {
         errx(EXIT_FAILURE, "failed to start dirty page logging: %s",
              strerror(-ret));
@@ -1019,9 +1035,9 @@ int main(int argc, char *argv[])
 
     dirty_bitmap.argsz = sizeof dirty_bitmap;
     dirty_bitmap.flags = VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP;
-    ret = send_recv_vfio_user_msg(sock, 0, VFIO_USER_DIRTY_PAGES,
-                                  &dirty_bitmap, sizeof dirty_bitmap,
-                                  NULL, 0, NULL, NULL, 0);
+    ret = vfio_user_msg(sock, 0, VFIO_USER_DIRTY_PAGES,
+                        &dirty_bitmap, sizeof dirty_bitmap,
+                        NULL, NULL, 0);
     if (ret != 0) {
         errx(EXIT_FAILURE, "failed to stop dirty page logging: %s",
              strerror(-ret));
@@ -1034,9 +1050,9 @@ int main(int argc, char *argv[])
      *
      * unmap the first group of the DMA regions
      */
-    ret = send_recv_vfio_user_msg(sock, msg_id, VFIO_USER_DMA_UNMAP,
-                                  dma_regions, sizeof *dma_regions * server_max_fds,
-                                  NULL, 0, NULL, NULL, 0);
+    ret = vfio_user_msg(sock, 7, VFIO_USER_DMA_UNMAP,
+                        dma_regions, sizeof *dma_regions * server_max_fds,
+                        NULL, NULL, 0);
     if (ret < 0) {
         errx(EXIT_FAILURE, "failed to unmap DMA regions: %s", strerror(-ret));
     }