diff options
Diffstat (limited to 'test/py/test_dirty_pages.py')
| -rw-r--r-- | test/py/test_dirty_pages.py | 498 |
1 files changed, 0 insertions, 498 deletions
diff --git a/test/py/test_dirty_pages.py b/test/py/test_dirty_pages.py deleted file mode 100644 index b3d4e34..0000000 --- a/test/py/test_dirty_pages.py +++ /dev/null @@ -1,498 +0,0 @@ -# -# 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 -# SERVICESLOSS 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 mmap -import tempfile - -ctx = None -quiesce_errno = 0 - - -@vfu_dma_register_cb_t -def dma_register(ctx, info): - return 0 - - -@vfu_dma_unregister_cb_t -def dma_unregister(ctx, info): - return 0 - - -@vfu_device_quiesce_cb_t -def quiesce_cb(ctx): - if quiesce_errno: - c.set_errno(errno.EBUSY) - return -1 - return 0 - - -def test_dirty_pages_setup(): - global ctx, sock - - ctx = vfu_create_ctx(flags=LIBVFIO_USER_FLAG_ATTACH_NB) - assert ctx is not None - - ret = vfu_pci_init(ctx) - assert ret == 0 - - vfu_setup_device_quiesce_cb(ctx, quiesce_cb=quiesce_cb) - - ret = vfu_setup_device_dma(ctx, dma_register, dma_unregister) - assert ret == 0 - - f = tempfile.TemporaryFile() - f.truncate(2 << PAGE_SHIFT) - - mmap_areas = [(PAGE_SIZE, PAGE_SIZE)] - - ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_MIGR_REGION_IDX, - size=2 << PAGE_SHIFT, flags=VFU_REGION_FLAG_RW, - mmap_areas=mmap_areas, fd=f.fileno()) - assert ret == 0 - - ret = vfu_realize_ctx(ctx) - assert ret == 0 - - sock = connect_client(ctx) - - f = tempfile.TemporaryFile() - f.truncate(0x10 << PAGE_SHIFT) - - payload = vfio_user_dma_map(argsz=len(vfio_user_dma_map()), - flags=(VFIO_USER_F_DMA_REGION_READ | VFIO_USER_F_DMA_REGION_WRITE), - offset=0, addr=0x10 << PAGE_SHIFT, size=0x20 << PAGE_SHIFT) - - msg(ctx, sock, VFIO_USER_DMA_MAP, payload, fds=[f.fileno()]) - - payload = vfio_user_dma_map(argsz=len(vfio_user_dma_map()), - flags=(VFIO_USER_F_DMA_REGION_READ | VFIO_USER_F_DMA_REGION_WRITE), - offset=0, addr=0x40 << PAGE_SHIFT, size=0x10 << PAGE_SHIFT) - - msg(ctx, sock, VFIO_USER_DMA_MAP, payload) - - -def test_dirty_pages_short_write(): - payload = struct.pack("I", 8) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def test_dirty_pages_bad_argsz(): - payload = vfio_user_dirty_pages(argsz=4, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_START) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def test_dirty_pages_start_no_migration(): - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_START) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.ENOTSUP) - - -def test_setup_migr_region(): - ret = vfu_setup_device_migration_callbacks(ctx, offset=PAGE_SIZE) - assert ret == 0 - - -def test_dirty_pages_start_bad_flags(): - # - # This is a little cheeky, after vfu_realize_ctx(), but it works at the - # moment. - # - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=(VFIO_IOMMU_DIRTY_PAGES_FLAG_START | - VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP)) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=(VFIO_IOMMU_DIRTY_PAGES_FLAG_START | - VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP)) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def start_logging(): - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_START) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload) - - -def test_dirty_pages_start(): - start_logging() - # should be idempotent - start_logging() - - -def test_dirty_pages_get_short_read(): - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -# -# This should in fact work; update when it does. -# -def test_dirty_pages_get_sub_range(): - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - dirty_pages = vfio_user_dirty_pages(argsz=argsz, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8) - br = vfio_user_bitmap_range(iova=0x11 << PAGE_SHIFT, size=PAGE_SIZE, - bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.ENOTSUP) - - -def test_dirty_pages_get_bad_page_size(): - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - dirty_pages = vfio_user_dirty_pages(argsz=argsz, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=2 << PAGE_SHIFT, size=8) - br = vfio_user_bitmap_range(iova=0x10 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def test_dirty_pages_get_bad_bitmap_size(): - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - dirty_pages = vfio_user_dirty_pages(argsz=argsz, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=1) - br = vfio_user_bitmap_range(iova=0x10 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def test_dirty_pages_get_bad_argsz(): - dirty_pages = vfio_user_dirty_pages(argsz=SERVER_MAX_DATA_XFER_SIZE + 8, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, - size=SERVER_MAX_DATA_XFER_SIZE + 8) - br = vfio_user_bitmap_range(iova=0x10 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def test_dirty_pages_get_short_reply(): - dirty_pages = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8) - br = vfio_user_bitmap_range(iova=0x10 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - result = msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload) - - assert len(result) == len(vfio_user_dirty_pages()) - - dirty_pages, _ = vfio_user_dirty_pages.pop_from_buffer(result) - - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - - assert dirty_pages.argsz == argsz - assert dirty_pages.flags == VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP - - -def test_get_dirty_page_bitmap_unmapped(): - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - - dirty_pages = vfio_user_dirty_pages(argsz=argsz, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8) - br = vfio_user_bitmap_range(iova=0x40 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, - expect=errno.EINVAL) - - -def test_dirty_pages_get_unmodified(): - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - - dirty_pages = vfio_user_dirty_pages(argsz=argsz, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8) - br = vfio_user_bitmap_range(iova=0x10 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - result = msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload) - - assert len(result) == argsz - - dirty_pages, result = vfio_user_dirty_pages.pop_from_buffer(result) - - assert dirty_pages.argsz == argsz - assert dirty_pages.flags == VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP - - br, result = vfio_user_bitmap_range.pop_from_buffer(result) - - assert br.iova == 0x10 << PAGE_SHIFT - assert br.size == 0x10 << PAGE_SHIFT - - assert br.bitmap.pgsize == PAGE_SIZE - assert br.bitmap.size == 8 - - -def get_dirty_page_bitmap(): - argsz = len(vfio_user_dirty_pages()) + len(vfio_user_bitmap_range()) + 8 - - dirty_pages = vfio_user_dirty_pages(argsz=argsz, - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP) - bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8) - br = vfio_user_bitmap_range(iova=0x10 << PAGE_SHIFT, - size=0x10 << PAGE_SHIFT, bitmap=bitmap) - - payload = bytes(dirty_pages) + bytes(br) - - result = msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload) - - _, result = vfio_user_dirty_pages.pop_from_buffer(result) - _, result = vfio_user_bitmap_range.pop_from_buffer(result) - - assert len(result) == 8 - - return struct.unpack("Q", result)[0] - - -sg3 = None -iovec3 = None - - -def write_to_page(ctx, page, nr_pages, get_bitmap=True): - """Simulate a write to the given address and size.""" - ret, sg = vfu_addr_to_sgl(ctx, dma_addr=page << PAGE_SHIFT, - length=nr_pages << PAGE_SHIFT) - assert ret == 1 - iovec = iovec_t() - ret = vfu_sgl_get(ctx, sg, iovec) - assert ret == 0 - vfu_sgl_put(ctx, sg, iovec) - if get_bitmap: - return get_dirty_page_bitmap() - return None - - -def test_dirty_pages_get_modified(): - ret, sg1 = vfu_addr_to_sgl(ctx, dma_addr=0x10 << PAGE_SHIFT, - length=PAGE_SIZE) - assert ret == 1 - iovec1 = iovec_t() - ret = vfu_sgl_get(ctx, sg1, iovec1) - assert ret == 0 - - # read only - ret, sg2 = vfu_addr_to_sgl(ctx, dma_addr=0x11 << PAGE_SHIFT, - length=PAGE_SIZE, prot=mmap.PROT_READ) - assert ret == 1 - iovec2 = iovec_t() - ret = vfu_sgl_get(ctx, sg2, iovec2) - assert ret == 0 - - # simple single bitmap entry map - ret, sg3 = vfu_addr_to_sgl(ctx, dma_addr=0x12 << PAGE_SHIFT, - length=PAGE_SIZE) - assert ret == 1 - iovec3 = iovec_t() - ret = vfu_sgl_get(ctx, sg3, iovec3) - assert ret == 0 - - # write that spans bytes in bitmap - ret, sg4 = vfu_addr_to_sgl(ctx, dma_addr=0x16 << PAGE_SHIFT, - length=0x4 << PAGE_SHIFT) - assert ret == 1 - iovec4 = iovec_t() - ret = vfu_sgl_get(ctx, sg4, iovec4) - assert ret == 0 - - # not put yet, dirty bitmap should be zero - bitmap = get_dirty_page_bitmap() - assert bitmap == 0b0000000000000000 - - # put SGLs, dirty bitmap should be updated - vfu_sgl_put(ctx, sg1, iovec1) - vfu_sgl_put(ctx, sg4, iovec4) - bitmap = get_dirty_page_bitmap() - assert bitmap == 0b0000001111000001 - - # after another two puts, should just be one dirty page - vfu_sgl_put(ctx, sg2, iovec2) - vfu_sgl_put(ctx, sg3, iovec3) - bitmap = get_dirty_page_bitmap() - assert bitmap == 0b0000000000000100 - - # and should now be clear - bitmap = get_dirty_page_bitmap() - assert bitmap == 0b0000000000000000 - - # - # check various edge cases of bitmap values. - # - - # very first bit - bitmap = write_to_page(ctx, 0x10, 1) - assert bitmap == 0b0000000000000001 - - # top bit of first byte - bitmap = write_to_page(ctx, 0x17, 1) - assert bitmap == 0b0000000010000000 - - # all bits except top one of first byte - bitmap = write_to_page(ctx, 0x10, 7) - assert bitmap == 0b0000000001111111 - - # all bits of first byte - bitmap = write_to_page(ctx, 0x10, 8) - assert bitmap == 0b0000000011111111 - - # all bits of first byte plus bottom bit of next - bitmap = write_to_page(ctx, 0x10, 9) - assert bitmap == 0b0000000111111111 - - # straddle top/bottom bit - bitmap = write_to_page(ctx, 0x17, 2) - assert bitmap == 0b0000000110000000 - - # top bit of second byte - bitmap = write_to_page(ctx, 0x1f, 1) - assert bitmap == 0b1000000000000000 - - # top bit of third byte - bitmap = write_to_page(ctx, 0x27, 1) - assert bitmap == 0b100000000000000000000000 - - # bits in third and first byte - write_to_page(ctx, 0x26, 1, get_bitmap=False) - write_to_page(ctx, 0x12, 2, get_bitmap=False) - bitmap = get_dirty_page_bitmap() - assert bitmap == 0b010000000000000000001100 - - -def test_dirty_pages_stop(): - # FIXME we have a memory leak as we don't free dirty bitmaps when - # destroying the context. - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload) - - -def test_dirty_pages_start_with_quiesce(): - global quiesce_errno - - quiesce_errno = errno.EBUSY - - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_START) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, rsp=False, busy=True) - - ret = vfu_device_quiesced(ctx, 0) - assert ret == 0 - - # now should be able to get the reply - get_reply(sock, expect=0) - - quiesce_errno = 0 - - -def test_dirty_pages_bitmap_with_quiesce(): - global quiesce_errno - - quiesce_errno = errno.EBUSY - - ret, sg1 = vfu_addr_to_sgl(ctx, dma_addr=0x10 << PAGE_SHIFT, - length=PAGE_SIZE) - assert ret == 1 - iovec1 = iovec_t() - ret = vfu_sgl_get(ctx, sg1, iovec1) - assert ret == 0 - vfu_sgl_put(ctx, sg1, iovec1) - - bitmap = get_dirty_page_bitmap() - assert bitmap == 0b0000000000000001 - - -def test_dirty_pages_stop_with_quiesce(): - global quiesce_errno - - quiesce_errno = errno.EBUSY - - payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()), - flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP) - - msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload, rsp=False, busy=True) - - ret = vfu_device_quiesced(ctx, 0) - assert ret == 0 - - # now should be able to get the reply - get_reply(sock, expect=0) - - quiesce_errno = 0 - - -def test_dirty_pages_cleanup(): - disconnect_client(ctx, sock) - vfu_destroy_ctx(ctx) - -# ex: set tabstop=4 shiftwidth=4 softtabstop=4 expandtab: |