python tests: add VFIO_USER_DEVICE_GET_INFO (#454)

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

5 files changed, 94 insertions, 40 deletions

diff --git a/lib/libvfio-user.c b/lib/libvfio-user.c
index 4a03995..e147091 100644
--- a/lib/libvfio-user.c
+++ b/lib/libvfio-user.c
@@ -344,7 +344,7 @@ handle_region_access(vfu_ctx_t *vfu_ctx, vfu_msg_t *msg)
     return 0;
 }
 
-int
+static int
 handle_device_get_info(vfu_ctx_t *vfu_ctx, vfu_msg_t *msg)
 {
     struct vfio_user_device_info *in_info;
diff --git a/lib/private.h b/lib/private.h
index b397612..97b2469 100644
--- a/lib/private.h
+++ b/lib/private.h
@@ -178,9 +178,6 @@ int
 handle_dma_map_or_unmap(vfu_ctx_t *vfu_ctx, vfu_msg_t *msg);
 
 int
-handle_device_get_info(vfu_ctx_t *vfu_ctx, vfu_msg_t *msg);
-
-int
 handle_device_get_region_info(vfu_ctx_t *vfu_ctx, vfu_msg_t *msg);
 
 MOCK_DECLARE(int, handle_dirty_pages, vfu_ctx_t *vfu_ctx, vfu_msg_t *msg);
diff --git a/test/py/libvfio_user.py b/test/py/libvfio_user.py
index 60a93a8..a8127de 100644
--- a/test/py/libvfio_user.py
+++ b/test/py/libvfio_user.py
@@ -65,6 +65,11 @@ PCI_EXT_CAP_DSN_SIZEOF = 12
 
 PCI_EXT_CAP_VNDR_HDR_SIZEOF = 8
 
+# from linux/vfio.h
+
+VFIO_DEVICE_FLAGS_RESET = (1 << 0)
+VFIO_DEVICE_FLAGS_PCI = (1 << 1)
+
 # libvfio-user defines
 
 VFU_TRANS_SOCK = 0
diff --git a/test/py/test_device_get_info.py b/test/py/test_device_get_info.py
new file mode 100644
index 0000000..fe44fee
--- /dev/null
+++ b/test/py/test_device_get_info.py
@@ -0,0 +1,88 @@
+#
+# Copyright (c) 2021 Nutanix Inc. All rights reserved.
+#
+# Authors: John Levon <john.levon@nutanix.com>
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions are met:
+#      * Redistributions of source code must retain the above copyright
+#        notice, this list of conditions and the following disclaimer.
+#      * Redistributions in binary form must reproduce the above copyright
+#        notice, this list of conditions and the following disclaimer in the
+#        documentation and/or other materials provided with the distribution.
+#      * Neither the name of Nutanix nor the names of its contributors may be
+#        used to endorse or promote products derived from this software without
+#        specific prior written permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+#  ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+#  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+#  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+#  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+#  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+#  DAMAGE.
+#
+
+from libvfio_user import *
+import errno
+
+def test_device_get_info():
+    global ctx
+
+    ctx = vfu_create_ctx(flags=LIBVFIO_USER_FLAG_ATTACH_NB)
+    assert ctx != None
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_BAR0_REGION_IDX, size=4096,
+                           flags=VFU_REGION_FLAG_RW)
+    assert ret == 0
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_BAR1_REGION_IDX, size=4096,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM))
+    assert ret == 0
+
+    ret = vfu_realize_ctx(ctx)
+    assert ret == 0
+
+    # test short write
+
+    sock = connect_client(ctx)
+
+    payload = struct.pack("II", 0, 0)
+
+    hdr = vfio_user_header(VFIO_USER_DEVICE_GET_INFO, size=len(payload))
+    sock.send(hdr + payload)
+    vfu_run_ctx(ctx)
+    get_reply(sock, expect=errno.EINVAL)
+
+    # bad argsz
+
+    # struct vfio_device_info
+    payload = struct.pack("IIII", 8, 0, 0, 0)
+
+    hdr = vfio_user_header(VFIO_USER_DEVICE_GET_INFO, size=len(payload))
+    sock.send(hdr + payload)
+    vfu_run_ctx(ctx)
+    get_reply(sock, expect=errno.EINVAL)
+
+    # valid with larger argsz
+
+    payload = struct.pack("IIII", 32, 0, 0, 0)
+
+    hdr = vfio_user_header(VFIO_USER_DEVICE_GET_INFO, size=len(payload))
+    sock.send(hdr + payload)
+    vfu_run_ctx(ctx)
+    result = get_reply(sock)
+
+    (argsz, flags, num_regions, num_irqs) = struct.unpack("IIII", result)
+
+    assert argsz == 16
+    assert flags == VFIO_DEVICE_FLAGS_PCI | VFIO_DEVICE_FLAGS_RESET
+    assert num_regions == VFU_PCI_DEV_NUM_REGIONS
+    assert num_irqs == VFU_DEV_NUM_IRQS
+
+    disconnect_client(ctx, sock)
+
+    vfu_destroy_ctx(ctx)
diff --git a/test/unit-tests.c b/test/unit-tests.c
index 00c71c4..7c7685d 100644
--- a/test/unit-tests.c
+++ b/test/unit-tests.c
@@ -696,41 +696,6 @@ test_get_region_info(UNUSED void **state)
     /* FIXME add check  for multiple sparse areas */
 }
 
-static void
-test_device_get_info(void **state UNUSED)
-{
-    struct vfio_user_device_info d_in = { .argsz = sizeof(d_in) + 1 };
-    struct vfio_user_device_info *d_out;
-    int ret;
-
-    vfu_ctx.nr_regions = 0xdeadbeef;
-
-    ret = handle_device_get_info(&vfu_ctx, mkmsg(VFIO_USER_DEVICE_GET_INFO,
-                                 &d_in, sizeof (d_in)));
-
-    assert_int_equal(0, ret);
-
-
-    d_out = msg.out_data;
-    assert_int_equal(sizeof(*d_out), d_out->argsz);
-    assert_int_equal(VFIO_DEVICE_FLAGS_PCI | VFIO_DEVICE_FLAGS_RESET,
-                     d_out->flags);
-    assert_int_equal(vfu_ctx.nr_regions, d_out->num_regions);
-    assert_int_equal(VFU_DEV_NUM_IRQS, d_out->num_irqs);
-
-    free(msg.out_data);
-    msg.out_data = NULL;
-    msg.out_size = 0;
-
-    /* bad size */
-    ret = handle_device_get_info(&vfu_ctx, mkmsg(VFIO_USER_DEVICE_GET_INFO,
-                                 &d_in, sizeof (d_in) - 1));
-    assert_int_equal(-1, ret);
-    assert_int_equal(EINVAL, errno);
-    assert_ptr_equal(NULL, msg.out_data);
-    assert_ptr_equal(0, msg.out_size);
-}
-
 /*
  * Performs various checks when adding sparse memory regions.
  */
@@ -1438,7 +1403,6 @@ main(void)
         cmocka_unit_test_setup(test_dma_addr_to_sg, setup),
         cmocka_unit_test_setup(test_vfu_setup_device_dma, setup),
         cmocka_unit_test_setup(test_get_region_info, setup),
-        cmocka_unit_test_setup(test_device_get_info, setup),
         cmocka_unit_test_setup(test_setup_sparse_region, setup),
         cmocka_unit_test_setup(test_dirty_pages_without_dma, setup),
         cmocka_unit_test_setup(test_device_set_irqs, setup),