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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
#
# 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 errno
import mmap
import tempfile
ctx = None
@vfu_dma_register_cb_t
def dma_register(ctx, info):
return 0
@vfu_dma_unregister_cb_t
def dma_unregister(ctx, info):
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
ret = vfu_setup_device_dma(ctx, dma_register, dma_unregister)
assert ret == 0
f = tempfile.TemporaryFile()
f.truncate(0x2000)
mmap_areas = [(0x1000, 0x1000)]
ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_MIGR_REGION_IDX, size=0x2000,
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(0x10000)
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=0x10000, size=0x10000)
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=0x20000, size=0x10000)
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_dirty_pages_start_bad_flags():
#
# This is a little cheeky, after vfu_realize_ctx(), but it works at the
# moment.
#
vfu_setup_device_migration_callbacks(ctx, offset=0x1000)
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=0x1000, size=8)
br = vfio_user_bitmap_range(iova=0x11000, size=0x1000, 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=0x2000, size=8)
br = vfio_user_bitmap_range(iova=0x10000, size=0x10000, 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=0x1000, size=1)
br = vfio_user_bitmap_range(iova=0x10000, size=0x10000, 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=0x1000,
size=SERVER_MAX_DATA_XFER_SIZE + 8)
br = vfio_user_bitmap_range(iova=0x10000, size=0x10000, 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=0x1000, size=8)
br = vfio_user_bitmap_range(iova=0x10000, size=0x10000, 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=0x1000, size=8)
br = vfio_user_bitmap_range(iova=0x20000, size=0x10000, 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=0x1000, size=8)
br = vfio_user_bitmap_range(iova=0x10000, size=0x10000, 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 == 0x10000
assert br.size == 0x10000
assert br.bitmap.pgsize == 0x1000
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=0x1000, size=8)
br = vfio_user_bitmap_range(iova=0x10000, size=0x10000, bitmap=bitmap)
payload = bytes(dirty_pages) + bytes(br)
result = msg(ctx, sock, VFIO_USER_DIRTY_PAGES, payload)
dirty_pages, result = vfio_user_dirty_pages.pop_from_buffer(result)
br, result = vfio_user_bitmap_range.pop_from_buffer(result)
return struct.unpack("Q", result)[0]
sg3 = None
iovec3 = None
def test_dirty_pages_get_modified():
ret, sg1 = vfu_addr_to_sg(ctx, dma_addr=0x10000, length=0x1000)
assert ret == 1
iovec1 = iovec_t()
ret = vfu_map_sg(ctx, sg1, iovec1)
assert ret == 0
ret, sg2 = vfu_addr_to_sg(ctx, dma_addr=0x11000, length=0x1000,
prot=mmap.PROT_READ)
assert ret == 1
iovec2 = iovec_t()
ret = vfu_map_sg(ctx, sg2, iovec2)
assert ret == 0
global sg3, iovec3
ret, sg3 = vfu_addr_to_sg(ctx, dma_addr=0x14000, length=0x4000)
assert ret == 1
iovec3 = iovec_t()
ret = vfu_map_sg(ctx, sg3, iovec3)
assert ret == 0
bitmap = get_dirty_page_bitmap()
assert bitmap == 0b11110001
# unmap segment, dirty bitmap should be the same
vfu_unmap_sg(ctx, sg1, iovec1)
bitmap = get_dirty_page_bitmap()
assert bitmap == 0b11110001
# check again, previously unmapped segment should be clean
bitmap = get_dirty_page_bitmap()
assert bitmap == 0b11110000
def stop_logging():
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_stop():
stop_logging()
# one segment is still mapped, starting logging again and bitmap should be
# dirty
start_logging()
assert get_dirty_page_bitmap() == 0b11110000
# unmap segment, bitmap should still be dirty
vfu_unmap_sg(ctx, sg3, iovec3)
assert get_dirty_page_bitmap() == 0b11110000
# bitmap should be clear after it was unmapped before previous reqeust for
# dirty pages
assert get_dirty_page_bitmap() == 0b00000000
# FIXME we have a memory leak as we don't free dirty bitmaps when
# destroying the context.
stop_logging()
def test_dirty_pages_cleanup():
disconnect_client(ctx, sock)
vfu_destroy_ctx(ctx)
# ex: set tabstop=4 shiftwidth=4 softtabstop=4 expandtab:
|