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>

2 files changed, 130 insertions, 4 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)