aboutsummaryrefslogtreecommitdiff
path: root/test/py/test_dma_unmap.py
blob: a1fa94b30ac03d4656dcd3f9975ca74fcb1bead5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
#
# Copyright (c) 2021 Nutanix Inc. All rights reserved.
#
# Authors: John Levon <john.levon@nutanix.com>
#          Swapnil Ingle <swapnil.ingle@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.
#

import errno
from unittest.mock import patch
from libvfio_user import *

ctx = None
client = None


def setup_function(function):
    global ctx, client
    ctx = prepare_ctx_for_dma()
    assert ctx is not None

    ret = vfu_realize_ctx(ctx)
    assert ret == 0

    client = connect_client(ctx)


def teardown_function(function):
    global ctx, client
    client.disconnect(ctx)
    vfu_destroy_ctx(ctx)


def setup_dma_regions(dma_regions=[(0x0, PAGE_SIZE)]):
    global ctx, client
    for dma_region in dma_regions:
        payload = struct.pack("II", 0, 0)
        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=dma_region[0], size=dma_region[1])
        msg(ctx, client.sock, VFIO_USER_DMA_MAP, payload)


def test_dma_unmap_short_write():
    payload = struct.pack("II", 0, 0)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_bad_argsz():

    payload = vfio_user_dma_unmap(argsz=8, flags=0, addr=PAGE_SIZE,
                                  size=PAGE_SIZE)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_bad_argsz2():

    payload = vfio_user_dma_unmap(argsz=SERVER_MAX_DATA_XFER_SIZE + 8, flags=0,
                                  addr=PAGE_SIZE, size=PAGE_SIZE)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_dirty_bad_argsz():

    argsz = len(vfio_user_dma_unmap()) + len(vfio_user_bitmap())
    unmap = vfio_user_dma_unmap(argsz=argsz,
        flags=VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP, addr=PAGE_SIZE,
        size=PAGE_SIZE)
    bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=(UINT64_MAX - argsz) + 8)
    payload = bytes(unmap) + bytes(bitmap)

    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_dirty_not_tracking():

    setup_dma_regions([(PAGE_SIZE, PAGE_SIZE)])
    argsz = len(vfio_user_dma_unmap()) + len(vfio_user_bitmap()) + 8
    unmap = vfio_user_dma_unmap(argsz=argsz,
        flags=VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP, addr=PAGE_SIZE,
        size=PAGE_SIZE)
    bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8)
    payload = bytes(unmap) + bytes(bitmap) + bytes(8)

    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_dirty_not_mapped():

    setup_dma_regions([(PAGE_SIZE, PAGE_SIZE)])
    vfu_setup_device_migration_callbacks(ctx, offset=PAGE_SIZE)
    payload = vfio_user_dirty_pages(argsz=len(vfio_user_dirty_pages()),
                                    flags=VFIO_IOMMU_DIRTY_PAGES_FLAG_START)

    msg(ctx, client.sock, VFIO_USER_DIRTY_PAGES, payload)

    argsz = len(vfio_user_dma_unmap()) + len(vfio_user_bitmap()) + 8
    unmap = vfio_user_dma_unmap(argsz=argsz,
        flags=VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP, addr=PAGE_SIZE,
        size=PAGE_SIZE)
    bitmap = vfio_user_bitmap(pgsize=PAGE_SIZE, size=8)
    payload = bytes(unmap) + bytes(bitmap) + bytes(8)

    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_invalid_flags():

    setup_dma_regions()
    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
                                  flags=0x4, addr=PAGE_SIZE, size=PAGE_SIZE)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap():

    setup_dma_regions()
    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
                                  flags=0, addr=0x0, size=PAGE_SIZE)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload)


def test_dma_unmap_invalid_addr():

    setup_dma_regions()
    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
                                  addr=0x10 << PAGE_SHIFT, size=PAGE_SIZE)

    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.ENOENT)


@patch('libvfio_user.quiesce_cb')
def test_dma_unmap_async(mock_quiesce):

    setup_dma_regions()
    mock_quiesce.side_effect = fail_with_errno(errno.EBUSY)
    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
                                  flags=0, addr=0x0, size=PAGE_SIZE)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload, rsp=False,
        busy=True)

    ret = vfu_device_quiesced(ctx, 0)
    assert ret == 0

    get_reply(client.sock)

    ret = vfu_run_ctx(ctx)
    assert ret == 0


def test_dma_unmap_all():

    dma_regions = [(PAGE_SIZE * i, PAGE_SIZE) for i in range(MAX_DMA_REGIONS)]
    setup_dma_regions(dma_regions)
    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
        flags=VFIO_DMA_UNMAP_FLAG_ALL, addr=0, size=0)
    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload)


def test_dma_unmap_all_invalid_addr():

    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
        flags=VFIO_DMA_UNMAP_FLAG_ALL, addr=0x10 << PAGE_SHIFT, size=PAGE_SIZE)

    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)


def test_dma_unmap_all_invalid_flags():

    payload = vfio_user_dma_unmap(argsz=len(vfio_user_dma_unmap()),
        flags=(VFIO_DMA_UNMAP_FLAG_ALL | VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP),
               addr=0, size=0)

    msg(ctx, client.sock, VFIO_USER_DMA_UNMAP, payload,
        expect=errno.EINVAL)

# FIXME need to add unit tests that test errors in get_request_header,
# do_reply, vfu_dma_transfer

# ex: set tabstop=4 shiftwidth=4 softtabstop=4 expandtab: #