aboutsummaryrefslogtreecommitdiff
path: root/test/py/test_device_set_irqs.py
blob: a2a2701826c9f40ad6f2257bfa899d36205e5a42 (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
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
#
# 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 unittest.mock import patch
from unittest.mock import ANY

from libvfio_user import *
import errno
import os

ctx = None
client = None

argsz = len(vfio_irq_set())


def test_device_set_irqs_setup():
    global ctx, client

    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_nr_irqs(ctx, VFU_DEV_REQ_IRQ, 1)
    assert ret == 0
    ret = vfu_setup_device_nr_irqs(ctx, VFU_DEV_ERR_IRQ, 1)
    assert ret == 0
    ret = vfu_setup_device_nr_irqs(ctx, VFU_DEV_MSIX_IRQ, 2048)
    assert ret == 0

    vfu_setup_irq_state_callback(ctx, VFU_DEV_MSIX_IRQ)
    assert ret == 0

    ret = vfu_realize_ctx(ctx)
    assert ret == 0

    client = connect_client(ctx)


def test_device_set_irqs_no_irq_set():
    hdr = vfio_user_header(VFIO_USER_DEVICE_SET_IRQS, size=0)
    client.sock.send(hdr)
    vfu_run_ctx(ctx)
    get_reply(client.sock, expect=errno.EINVAL)


def test_device_set_irqs_short_write():
    payload = struct.pack("II", 0, 0)

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


def test_device_set_irqs_bad_argsz():
    payload = vfio_irq_set(argsz=3, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_REQ_IRQ,
                           start=0, count=0)

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


def test_device_set_irqs_bad_index():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_NUM_IRQS,
                           start=0, count=0)

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


def test_device_set_irqs_bad_flags_MASK_and_UNMASK():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_ACTION_UNMASK, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=0)

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


def test_device_set_irqs_bad_flags_DATA_NONE_and_DATA_BOOL():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_BOOL,
                           index=VFU_DEV_MSIX_IRQ, start=0, count=0)

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


def test_device_set_irqs_bad_start_count_range():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_MSIX_IRQ,
                           start=2047, count=2)

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


def test_device_set_irqs_bad_start_count_range2():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_MSIX_IRQ,
                           start=2049, count=1)

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


def test_device_set_irqs_bad_action_for_err_irq():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_ERR_IRQ,
                           start=0, count=1)

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


def test_device_set_irqs_bad_action_for_req_irq():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_REQ_IRQ,
                           start=0, count=1)

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


def test_device_set_irqs_bad_start_count_range_for_err_irq():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_ERR_IRQ,
                           start=0, count=2)

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


def test_device_set_irqs_bad_start_count_range_for_req_irq():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_REQ_IRQ,
                           start=0, count=2)

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


def test_device_set_irqs_bad_start_for_count_0():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_MSIX_IRQ,
                           start=1, count=0)

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


def test_device_set_irqs_bad_action_for_count_0():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_MASK |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=0)

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


def test_device_set_irqs_bad_action_and_data_type_for_count_0():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_BOOL, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=0)

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


def test_device_set_irqs_bad_fds_for_DATA_BOOL():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_BOOL, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=1)

    payload = bytes(payload) + struct.pack("?", False)

    fd = eventfd()

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload,
        expect=errno.EINVAL, fds=[fd])

    os.close(fd)


def test_device_set_irqs_bad_fds_for_DATA_NONE():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=1)

    fd = eventfd()

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload,
        expect=errno.EINVAL, fds=[fd])

    os.close(fd)


def test_device_set_irqs_bad_fds_for_count_2():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_EVENTFD, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=2)

    fd = eventfd()

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload,
        expect=errno.EINVAL, fds=[fd])

    os.close(fd)


def test_device_set_irqs_disable():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_REQ_IRQ,
                           start=0, count=0)

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

    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_EVENTFD, index=VFU_DEV_REQ_IRQ,
                           start=0, count=1)

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


def test_device_set_irqs_enable():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_EVENTFD, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=1)

    fd = eventfd()

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload, fds=[fd])


def test_device_set_irqs_trigger_bool_too_small():
    payload = vfio_irq_set(argsz=argsz + 1, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_BOOL, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=2)
    payload = bytes(payload) + struct.pack("?", False)

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


def test_device_set_irqs_trigger_bool_too_large():
    payload = vfio_irq_set(argsz=argsz + 3, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_BOOL, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=2)
    payload = bytes(payload) + struct.pack("???", False, False, False)

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


def test_device_set_irqs_enable_update():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_EVENTFD, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=1)

    fd = eventfd()

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload, fds=[fd])


def test_device_set_irqs_enable_trigger_none():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_EVENTFD, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=2)

    fd1 = eventfd(initval=4)
    fd2 = eventfd(initval=8)

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload, fds=[fd1, fd2])

    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_NONE, index=VFU_DEV_MSIX_IRQ,
                           start=1, count=1)

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

    assert struct.unpack("Q", os.read(fd1, 8))[0] == 4
    assert struct.unpack("Q", os.read(fd2, 8))[0] == 9


def test_device_set_irqs_enable_trigger_bool():
    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_EVENTFD, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=2)

    fd1 = eventfd(initval=4)
    fd2 = eventfd(initval=8)

    msg(ctx, client.sock, VFIO_USER_DEVICE_SET_IRQS, payload, fds=[fd1, fd2])

    payload = vfio_irq_set(argsz=argsz + 2, flags=VFIO_IRQ_SET_ACTION_TRIGGER |
                           VFIO_IRQ_SET_DATA_BOOL, index=VFU_DEV_MSIX_IRQ,
                           start=0, count=2)
    payload = bytes(payload) + struct.pack("??", False, True)

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

    assert struct.unpack("Q", os.read(fd1, 8))[0] == 4
    assert struct.unpack("Q", os.read(fd2, 8))[0] == 9


@patch('libvfio_user.irq_state')
def test_irq_state(mock_irq_state):
    assert mock_irq_state.call_count == 0

    payload = vfio_irq_set(argsz=argsz, flags=VFIO_IRQ_SET_DATA_NONE |
                           VFIO_IRQ_SET_ACTION_MASK,
                           index=VFU_DEV_MSIX_IRQ,
                           start=0, count=1)

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

    mock_irq_state.assert_called_with(ANY, 0, 1, True)

    assert mock_irq_state.call_count == 1


def test_device_set_irqs_cleanup():
    vfu_destroy_ctx(ctx)

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