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
|
#
# Copyright (c) 2021 Nutanix Inc. All rights reserved.
#
# Authors: Thanos Makatos <thanos@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
from unittest.mock import patch
ctx = None
sock = 0
def setup_function(function):
global ctx, sock
ctx = vfu_create_ctx(flags=LIBVFIO_USER_FLAG_ATTACH_NB)
assert ctx is not None
ret = vfu_setup_region(ctx, index=VFU_PCI_DEV_MIGR_REGION_IDX, size=0x2000,
flags=VFU_REGION_FLAG_RW)
assert ret == 0
ret = vfu_setup_device_migration_callbacks(ctx)
assert ret == 0
vfu_setup_device_quiesce_cb(ctx)
ret = vfu_realize_ctx(ctx)
assert ret == 0
sock = connect_client(ctx)
def teardown_function(function):
global ctx
vfu_destroy_ctx(ctx)
@patch('libvfio_user.quiesce_cb')
@patch('libvfio_user.migr_trans_cb')
def test_migration_bad_access(mock_trans, mock_quiesce):
"""
Tests that attempting to access the migration state register in an
non-aligned manner fails.
This test is important because we tell whether we need to quiesce by
checking for a register-sized access, otherwise we'll change migration
state without having quiesced.
"""
global ctx, sock
data = VFIO_DEVICE_STATE_SAVING.to_bytes(c.sizeof(c.c_int), 'little')
write_region(ctx, sock, VFU_PCI_DEV_MIGR_REGION_IDX, offset=0,
count=len(data)-1, data=data, expect=errno.EINVAL)
mock_trans.assert_not_called()
@patch('libvfio_user.quiesce_cb')
@patch('libvfio_user.migr_trans_cb', return_value=0)
def test_migration_trans_sync(mock_trans, mock_quiesce):
"""
Tests transitioning to the saving state.
"""
global ctx, sock
data = VFIO_DEVICE_STATE_SAVING.to_bytes(c.sizeof(c.c_int), 'little')
write_region(ctx, sock, VFU_PCI_DEV_MIGR_REGION_IDX, offset=0,
count=len(data), data=data)
ret = vfu_run_ctx(ctx)
assert ret == 0
@patch('libvfio_user.migr_trans_cb', side_effect=fail_with_errno(errno.EPERM))
def test_migration_trans_sync_err(mock_trans):
"""
Tests the device returning an error when the migration state is written to.
"""
global ctx, sock
data = VFIO_DEVICE_STATE_SAVING.to_bytes(c.sizeof(c.c_int), 'little')
write_region(ctx, sock, VFU_PCI_DEV_MIGR_REGION_IDX, offset=0,
count=len(data), data=data, expect=errno.EPERM)
ret = vfu_run_ctx(ctx)
assert ret == 0
@patch('libvfio_user.quiesce_cb', side_effect=fail_with_errno(errno.EBUSY))
@patch('libvfio_user.migr_trans_cb', return_value=0)
def test_migration_trans_async(mock_trans, mock_quiesce):
"""
Tests transitioning to the saving state where the device is initially busy
quiescing.
"""
global ctx, sock
mock_quiesce
data = VFIO_DEVICE_STATE_SAVING.to_bytes(c.sizeof(c.c_int), 'little')
write_region(ctx, sock, VFU_PCI_DEV_MIGR_REGION_IDX, offset=0,
count=len(data), data=data, rsp=False,
expect_run_ctx_errno=errno.EBUSY)
ret = vfu_device_quiesced(ctx, 0)
assert ret == 0
get_reply(sock)
ret = vfu_run_ctx(ctx)
assert ret == 0
@patch('libvfio_user.quiesce_cb', side_effect=fail_with_errno(errno.EBUSY))
@patch('libvfio_user.migr_trans_cb', side_effect=fail_with_errno(errno.ENOTTY))
def test_migration_trans_async_err(mock_trans, mock_quiesce):
"""
Tests writing to the migration state register, the device not being able to
immediately quiesce, and then finally the device failing to transition to
the new migration state.
"""
global ctx, sock
data = VFIO_DEVICE_STATE_RUNNING.to_bytes(c.sizeof(c.c_int), 'little')
write_region(ctx, sock, VFU_PCI_DEV_MIGR_REGION_IDX, offset=0,
count=len(data), data=data, rsp=False,
expect_run_ctx_errno=errno.EBUSY)
ret = vfu_device_quiesced(ctx, 0)
assert ret == 0
print("waiting for reply")
get_reply(sock, errno.ENOTTY)
print("received reply")
# ex: set tabstop=4 shiftwidth=4 softtabstop=4 expandtab: #
|