python tests: add vfu_setup_region() tests (#474)

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

3 files changed, 130 insertions, 107 deletions

diff --git a/test/py/libvfio_user.py b/test/py/libvfio_user.py
index 61cb7cc..930c88a 100644
--- a/test/py/libvfio_user.py
+++ b/test/py/libvfio_user.py
@@ -429,15 +429,19 @@ def vfu_destroy_ctx(ctx):
         os.remove(SOCK_PATH)
 
 def vfu_setup_region(ctx, index, size, cb=None, flags=0,
-                     mmap_areas=None, fd=-1, offset=0):
+                     mmap_areas=None, nr_mmap_areas=None, fd=-1, offset=0):
     assert ctx != None
 
-    nr_mmap_areas = 0
     c_mmap_areas = None
 
     if mmap_areas:
-        nr_mmap_areas = len(mmap_areas)
-        c_mmap_areas = (iovec_t * nr_mmap_areas)(*mmap_areas)
+        c_mmap_areas = (iovec_t * len(mmap_areas))(*mmap_areas)
+
+    if nr_mmap_areas is None:
+        if mmap_areas:
+            nr_mmap_areas = len(mmap_areas)
+        else:
+            nr_mmap_areas = 0
 
     # We're sending a file descriptor to ourselves; to pretend the server is
     # separate, we need to dup() here.
@@ -447,6 +451,10 @@ def vfu_setup_region(ctx, index, size, cb=None, flags=0,
     ret = lib.vfu_setup_region(ctx, index, size,
                                c.cast(cb, vfu_region_access_cb_t),
                                flags, c_mmap_areas, nr_mmap_areas, fd, offset)
+
+    if fd != -1 and ret != 0:
+        os.close(fd)
+
     return ret
 
 def vfu_setup_device_nr_irqs(ctx, irqtype, count):
diff --git a/test/py/test_setup_region.py b/test/py/test_setup_region.py
new file mode 100644
index 0000000..0bf120d
--- /dev/null
+++ b/test/py/test_setup_region.py
@@ -0,0 +1,118 @@
+#
+# 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 ctypes as c
+import errno
+import tempfile
+
+ctx = None
+
+def test_device_set_irqs_setup():
+    global ctx
+
+    ctx = vfu_create_ctx(flags=LIBVFIO_USER_FLAG_ATTACH_NB)
+    assert ctx != None
+
+def test_setup_region_bad_mmap_areas():
+
+    f = tempfile.TemporaryFile()
+    f.truncate(65536)
+
+    mmap_areas = [ (0x2000, 0x1000), (0x4000, 0x2000) ]
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_BAR2_REGION_IDX, size=0x10000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM),
+                           mmap_areas=mmap_areas, nr_mmap_areas=0,
+                           fd=f.fileno())
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_BAR2_REGION_IDX, size=0x10000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM),
+                           mmap_areas=None, nr_mmap_areas=1, fd=f.fileno())
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_BAR2_REGION_IDX, size=0x10000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM),
+                           mmap_areas=mmap_areas, fd=-1)
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+    mmap_areas = [ (0x2000, 0x1000), (0x4000, 0x2000) ]
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_BAR2_REGION_IDX, size=0x5000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM),
+                           mmap_areas=mmap_areas, fd=f.fileno())
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+def test_setup_region_bad_index():
+    ret = vfu_setup_region(ctx, index=-2, size=0x10000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM))
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_NUM_REGIONS, size=0x10000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM))
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+def test_setup_region_bad_pci():
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_CFG_REGION_IDX, size=0x1000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM))
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+def test_setup_region_bad_migr():
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_MIGR_REGION_IDX, size=512,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM))
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+    f = tempfile.TemporaryFile()
+    f.truncate(0x2000)
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_MIGR_REGION_IDX, size=0x2000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM),
+                           fd=f.fileno())
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+    mmap_areas = [ (0x0, 0x1000), (0x1000, 0x1000) ]
+
+    ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_MIGR_REGION_IDX, size=0x2000,
+                           flags=(VFU_REGION_FLAG_RW | VFU_REGION_FLAG_MEM),
+                           mmap_areas=mmap_areas, fd=f.fileno())
+    assert ret == -1
+    assert c.get_errno() == errno.EINVAL
+
+def test_setup_region_cleanup():
+    vfu_destroy_ctx(ctx)
diff --git a/test/unit-tests.c b/test/unit-tests.c
index 3953b0c..3ae2825 100644
--- a/test/unit-tests.c
+++ b/test/unit-tests.c
@@ -550,60 +550,6 @@ typedef struct {
     int conn_fd;
 } tran_sock_t;
 
-/*
- * Performs various checks when adding sparse memory regions.
- */
-static void
-test_setup_sparse_region(void **state UNUSED)
-{
-    vfu_reg_info_t reg_info = { 0 };
-    struct iovec mmap_areas[2] = {
-        [0] = {
-            .iov_base = (void*)0x0,
-            .iov_len = 0x1000
-        },
-        [1] = {
-            .iov_base = (void*)0x1000,
-            .iov_len = 0x1000
-        }
-    };
-
-    vfu_ctx.reg_info = &reg_info;
-
-    /* invalid mappable settings */
-    ret = vfu_setup_region(&vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX,
-                           0x2000, NULL, 0, mmap_areas, 2, -1, 0);
-    assert_int_equal(-1, ret);
-    assert_int_equal(EINVAL, errno);
-
-    ret = vfu_setup_region(&vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX,
-                           0x2000, NULL, 0, mmap_areas, 0, 1, 0);
-    assert_int_equal(-1, ret);
-    assert_int_equal(EINVAL, errno);
-
-    /* default mmap area if not given */
-    ret = vfu_setup_region(&vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX,
-                           0x2000, NULL, 0, NULL, 0, 1, 0);
-    assert_int_equal(0, ret);
-
-    free(reg_info.mmap_areas);
-
-    /* sparse region exceeds region size */
-    mmap_areas[1].iov_len = 0x1001;
-    ret = vfu_setup_region(&vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX,
-                            0x2000, NULL, 0, mmap_areas, 2, 0, 0);
-    assert_int_equal(-1, ret);
-    assert_int_equal(EINVAL, errno);
-
-    /* sparse region within region size */
-    mmap_areas[1].iov_len = 0x1000;
-    ret = vfu_setup_region(&vfu_ctx, VFU_PCI_DEV_BAR0_REGION_IDX,
-                           0x2000, NULL, 0, mmap_areas, 2, 0, 0);
-    assert_int_equal(0, ret);
-
-    free(reg_info.mmap_areas);
-}
-
 static void
 test_dirty_pages_without_dma(UNUSED void **state)
 {
@@ -747,17 +693,6 @@ teardown_test_setup_migration_region(void **state)
 }
 
 static void
-test_setup_migration_region_too_small(void **state)
-{
-    vfu_ctx_t *v = get_vfu_ctx(state);
-    int r = vfu_setup_region(v, VFU_PCI_DEV_MIGR_REGION_IDX,
-        vfu_get_migr_register_area_size() - 1, NULL,
-        VFU_REGION_FLAG_READ | VFU_REGION_FLAG_WRITE, NULL, 0, -1, 0);
-    assert_int_equal(-1, r);
-    assert_int_equal(EINVAL, errno);
-}
-
-static void
 test_setup_migration_region_size_ok(void **state)
 {
     vfu_ctx_t *v = get_vfu_ctx(state);
@@ -768,34 +703,6 @@ test_setup_migration_region_size_ok(void **state)
 }
 
 static void
-test_setup_migration_region_fully_mappable(void **state)
-{
-    struct test_setup_migr_reg_dat *p = *state;
-    int r = vfu_setup_region(p->v, VFU_PCI_DEV_MIGR_REGION_IDX, p->s,
-        NULL, VFU_REGION_FLAG_READ | VFU_REGION_FLAG_WRITE, NULL, 0,
-        0xdeadbeef, 0);
-    assert_int_equal(-1, r);
-    assert_int_equal(EINVAL, errno);
-}
-
-static void
-test_setup_migration_region_sparsely_mappable_over_migration_registers(void **state)
-{
-    struct test_setup_migr_reg_dat *p = *state;
-    struct iovec mmap_areas[] = {
-        [0] = {
-            .iov_base = 0,
-            .iov_len = p->rs
-        }
-    };
-    int r = vfu_setup_region(p->v, VFU_PCI_DEV_MIGR_REGION_IDX, p->s, NULL,
-        VFU_REGION_FLAG_READ | VFU_REGION_FLAG_WRITE, mmap_areas, 1,
-        0xdeadbeef, 0);
-    assert_int_equal(-1, r);
-    assert_int_equal(EINVAL, errno);
-}
-
-static void
 test_setup_migration_region_sparsely_mappable_valid(void **state)
 {
     struct test_setup_migr_reg_dat *p = *state;
@@ -1052,21 +959,11 @@ main(void)
         cmocka_unit_test_setup(test_dma_map_sg, setup),
         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_setup_sparse_region, setup),
         cmocka_unit_test_setup(test_dirty_pages_without_dma, setup),
         cmocka_unit_test_setup(test_migration_state_transitions, setup),
-        cmocka_unit_test_setup_teardown(test_setup_migration_region_too_small,
-            setup_test_setup_migration_region,
-            teardown_test_setup_migration_region),
         cmocka_unit_test_setup_teardown(test_setup_migration_region_size_ok,
             setup_test_setup_migration_region,
             teardown_test_setup_migration_region),
-        cmocka_unit_test_setup_teardown(test_setup_migration_region_fully_mappable,
-            setup_test_setup_migration_region,
-            teardown_test_setup_migration_region),
-        cmocka_unit_test_setup_teardown(test_setup_migration_region_sparsely_mappable_over_migration_registers,
-            setup_test_setup_migration_region,
-            teardown_test_setup_migration_region),
         cmocka_unit_test_setup_teardown(test_setup_migration_region_sparsely_mappable_valid,
             setup_test_setup_migration_region,
             teardown_test_setup_migration_region),