1*bbbd9b6eSWillian Rampazzo""" 2*bbbd9b6eSWillian RampazzoCheck compatibility of virtio device types 3*bbbd9b6eSWillian Rampazzo""" 4*bbbd9b6eSWillian Rampazzo# Copyright (c) 2018 Red Hat, Inc. 5*bbbd9b6eSWillian Rampazzo# 6*bbbd9b6eSWillian Rampazzo# Author: 7*bbbd9b6eSWillian Rampazzo# Eduardo Habkost <ehabkost@redhat.com> 8*bbbd9b6eSWillian Rampazzo# 9*bbbd9b6eSWillian Rampazzo# This work is licensed under the terms of the GNU GPL, version 2 or 10*bbbd9b6eSWillian Rampazzo# later. See the COPYING file in the top-level directory. 11*bbbd9b6eSWillian Rampazzoimport sys 12*bbbd9b6eSWillian Rampazzoimport os 13*bbbd9b6eSWillian Rampazzo 14*bbbd9b6eSWillian Rampazzosys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python')) 15*bbbd9b6eSWillian Rampazzofrom qemu.machine import QEMUMachine 16*bbbd9b6eSWillian Rampazzofrom avocado_qemu import Test 17*bbbd9b6eSWillian Rampazzo 18*bbbd9b6eSWillian Rampazzo# Virtio Device IDs: 19*bbbd9b6eSWillian RampazzoVIRTIO_NET = 1 20*bbbd9b6eSWillian RampazzoVIRTIO_BLOCK = 2 21*bbbd9b6eSWillian RampazzoVIRTIO_CONSOLE = 3 22*bbbd9b6eSWillian RampazzoVIRTIO_RNG = 4 23*bbbd9b6eSWillian RampazzoVIRTIO_BALLOON = 5 24*bbbd9b6eSWillian RampazzoVIRTIO_RPMSG = 7 25*bbbd9b6eSWillian RampazzoVIRTIO_SCSI = 8 26*bbbd9b6eSWillian RampazzoVIRTIO_9P = 9 27*bbbd9b6eSWillian RampazzoVIRTIO_RPROC_SERIAL = 11 28*bbbd9b6eSWillian RampazzoVIRTIO_CAIF = 12 29*bbbd9b6eSWillian RampazzoVIRTIO_GPU = 16 30*bbbd9b6eSWillian RampazzoVIRTIO_INPUT = 18 31*bbbd9b6eSWillian RampazzoVIRTIO_VSOCK = 19 32*bbbd9b6eSWillian RampazzoVIRTIO_CRYPTO = 20 33*bbbd9b6eSWillian Rampazzo 34*bbbd9b6eSWillian RampazzoPCI_VENDOR_ID_REDHAT_QUMRANET = 0x1af4 35*bbbd9b6eSWillian Rampazzo 36*bbbd9b6eSWillian Rampazzo# Device IDs for legacy/transitional devices: 37*bbbd9b6eSWillian RampazzoPCI_LEGACY_DEVICE_IDS = { 38*bbbd9b6eSWillian Rampazzo VIRTIO_NET: 0x1000, 39*bbbd9b6eSWillian Rampazzo VIRTIO_BLOCK: 0x1001, 40*bbbd9b6eSWillian Rampazzo VIRTIO_BALLOON: 0x1002, 41*bbbd9b6eSWillian Rampazzo VIRTIO_CONSOLE: 0x1003, 42*bbbd9b6eSWillian Rampazzo VIRTIO_SCSI: 0x1004, 43*bbbd9b6eSWillian Rampazzo VIRTIO_RNG: 0x1005, 44*bbbd9b6eSWillian Rampazzo VIRTIO_9P: 0x1009, 45*bbbd9b6eSWillian Rampazzo VIRTIO_VSOCK: 0x1012, 46*bbbd9b6eSWillian Rampazzo} 47*bbbd9b6eSWillian Rampazzo 48*bbbd9b6eSWillian Rampazzodef pci_modern_device_id(virtio_devid): 49*bbbd9b6eSWillian Rampazzo return virtio_devid + 0x1040 50*bbbd9b6eSWillian Rampazzo 51*bbbd9b6eSWillian Rampazzodef devtype_implements(vm, devtype, implements): 52*bbbd9b6eSWillian Rampazzo return devtype in [d['name'] for d in vm.command('qom-list-types', implements=implements)] 53*bbbd9b6eSWillian Rampazzo 54*bbbd9b6eSWillian Rampazzodef get_pci_interfaces(vm, devtype): 55*bbbd9b6eSWillian Rampazzo interfaces = ('pci-express-device', 'conventional-pci-device') 56*bbbd9b6eSWillian Rampazzo return [i for i in interfaces if devtype_implements(vm, devtype, i)] 57*bbbd9b6eSWillian Rampazzo 58*bbbd9b6eSWillian Rampazzoclass VirtioVersionCheck(Test): 59*bbbd9b6eSWillian Rampazzo """ 60*bbbd9b6eSWillian Rampazzo Check if virtio-version-specific device types result in the 61*bbbd9b6eSWillian Rampazzo same device tree created by `disable-modern` and 62*bbbd9b6eSWillian Rampazzo `disable-legacy`. 63*bbbd9b6eSWillian Rampazzo 64*bbbd9b6eSWillian Rampazzo :avocado: tags=arch:x86_64 65*bbbd9b6eSWillian Rampazzo """ 66*bbbd9b6eSWillian Rampazzo 67*bbbd9b6eSWillian Rampazzo # just in case there are failures, show larger diff: 68*bbbd9b6eSWillian Rampazzo maxDiff = 4096 69*bbbd9b6eSWillian Rampazzo 70*bbbd9b6eSWillian Rampazzo def run_device(self, devtype, opts=None, machine='pc'): 71*bbbd9b6eSWillian Rampazzo """ 72*bbbd9b6eSWillian Rampazzo Run QEMU with `-device DEVTYPE`, return device info from `query-pci` 73*bbbd9b6eSWillian Rampazzo """ 74*bbbd9b6eSWillian Rampazzo with QEMUMachine(self.qemu_bin) as vm: 75*bbbd9b6eSWillian Rampazzo vm.set_machine(machine) 76*bbbd9b6eSWillian Rampazzo if opts: 77*bbbd9b6eSWillian Rampazzo devtype += ',' + opts 78*bbbd9b6eSWillian Rampazzo vm.add_args('-device', '%s,id=devfortest' % (devtype)) 79*bbbd9b6eSWillian Rampazzo vm.add_args('-S') 80*bbbd9b6eSWillian Rampazzo vm.launch() 81*bbbd9b6eSWillian Rampazzo 82*bbbd9b6eSWillian Rampazzo pcibuses = vm.command('query-pci') 83*bbbd9b6eSWillian Rampazzo alldevs = [dev for bus in pcibuses for dev in bus['devices']] 84*bbbd9b6eSWillian Rampazzo devfortest = [dev for dev in alldevs 85*bbbd9b6eSWillian Rampazzo if dev['qdev_id'] == 'devfortest'] 86*bbbd9b6eSWillian Rampazzo return devfortest[0], get_pci_interfaces(vm, devtype) 87*bbbd9b6eSWillian Rampazzo 88*bbbd9b6eSWillian Rampazzo 89*bbbd9b6eSWillian Rampazzo def assert_devids(self, dev, devid, non_transitional=False): 90*bbbd9b6eSWillian Rampazzo self.assertEqual(dev['id']['vendor'], PCI_VENDOR_ID_REDHAT_QUMRANET) 91*bbbd9b6eSWillian Rampazzo self.assertEqual(dev['id']['device'], devid) 92*bbbd9b6eSWillian Rampazzo if non_transitional: 93*bbbd9b6eSWillian Rampazzo self.assertTrue(0x1040 <= dev['id']['device'] <= 0x107f) 94*bbbd9b6eSWillian Rampazzo self.assertGreaterEqual(dev['id']['subsystem'], 0x40) 95*bbbd9b6eSWillian Rampazzo 96*bbbd9b6eSWillian Rampazzo def check_all_variants(self, qemu_devtype, virtio_devid): 97*bbbd9b6eSWillian Rampazzo """Check if a virtio device type and its variants behave as expected""" 98*bbbd9b6eSWillian Rampazzo # Force modern mode: 99*bbbd9b6eSWillian Rampazzo dev_modern, _ = self.run_device(qemu_devtype, 100*bbbd9b6eSWillian Rampazzo 'disable-modern=off,disable-legacy=on') 101*bbbd9b6eSWillian Rampazzo self.assert_devids(dev_modern, pci_modern_device_id(virtio_devid), 102*bbbd9b6eSWillian Rampazzo non_transitional=True) 103*bbbd9b6eSWillian Rampazzo 104*bbbd9b6eSWillian Rampazzo # <prefix>-non-transitional device types should be 100% equivalent to 105*bbbd9b6eSWillian Rampazzo # <prefix>,disable-modern=off,disable-legacy=on 106*bbbd9b6eSWillian Rampazzo dev_1_0, nt_ifaces = self.run_device('%s-non-transitional' % (qemu_devtype)) 107*bbbd9b6eSWillian Rampazzo self.assertEqual(dev_modern, dev_1_0) 108*bbbd9b6eSWillian Rampazzo 109*bbbd9b6eSWillian Rampazzo # Force transitional mode: 110*bbbd9b6eSWillian Rampazzo dev_trans, _ = self.run_device(qemu_devtype, 111*bbbd9b6eSWillian Rampazzo 'disable-modern=off,disable-legacy=off') 112*bbbd9b6eSWillian Rampazzo self.assert_devids(dev_trans, PCI_LEGACY_DEVICE_IDS[virtio_devid]) 113*bbbd9b6eSWillian Rampazzo 114*bbbd9b6eSWillian Rampazzo # Force legacy mode: 115*bbbd9b6eSWillian Rampazzo dev_legacy, _ = self.run_device(qemu_devtype, 116*bbbd9b6eSWillian Rampazzo 'disable-modern=on,disable-legacy=off') 117*bbbd9b6eSWillian Rampazzo self.assert_devids(dev_legacy, PCI_LEGACY_DEVICE_IDS[virtio_devid]) 118*bbbd9b6eSWillian Rampazzo 119*bbbd9b6eSWillian Rampazzo # No options: default to transitional on PC machine-type: 120*bbbd9b6eSWillian Rampazzo no_opts_pc, generic_ifaces = self.run_device(qemu_devtype) 121*bbbd9b6eSWillian Rampazzo self.assertEqual(dev_trans, no_opts_pc) 122*bbbd9b6eSWillian Rampazzo 123*bbbd9b6eSWillian Rampazzo #TODO: check if plugging on a PCI Express bus will make the 124*bbbd9b6eSWillian Rampazzo # device non-transitional 125*bbbd9b6eSWillian Rampazzo #no_opts_q35 = self.run_device(qemu_devtype, machine='q35') 126*bbbd9b6eSWillian Rampazzo #self.assertEqual(dev_modern, no_opts_q35) 127*bbbd9b6eSWillian Rampazzo 128*bbbd9b6eSWillian Rampazzo # <prefix>-transitional device types should be 100% equivalent to 129*bbbd9b6eSWillian Rampazzo # <prefix>,disable-modern=off,disable-legacy=off 130*bbbd9b6eSWillian Rampazzo dev_trans, trans_ifaces = self.run_device('%s-transitional' % (qemu_devtype)) 131*bbbd9b6eSWillian Rampazzo self.assertEqual(dev_trans, dev_trans) 132*bbbd9b6eSWillian Rampazzo 133*bbbd9b6eSWillian Rampazzo # ensure the interface information is correct: 134*bbbd9b6eSWillian Rampazzo self.assertIn('conventional-pci-device', generic_ifaces) 135*bbbd9b6eSWillian Rampazzo self.assertIn('pci-express-device', generic_ifaces) 136*bbbd9b6eSWillian Rampazzo 137*bbbd9b6eSWillian Rampazzo self.assertIn('conventional-pci-device', nt_ifaces) 138*bbbd9b6eSWillian Rampazzo self.assertIn('pci-express-device', nt_ifaces) 139*bbbd9b6eSWillian Rampazzo 140*bbbd9b6eSWillian Rampazzo self.assertIn('conventional-pci-device', trans_ifaces) 141*bbbd9b6eSWillian Rampazzo self.assertNotIn('pci-express-device', trans_ifaces) 142*bbbd9b6eSWillian Rampazzo 143*bbbd9b6eSWillian Rampazzo 144*bbbd9b6eSWillian Rampazzo def test_conventional_devs(self): 145*bbbd9b6eSWillian Rampazzo self.check_all_variants('virtio-net-pci', VIRTIO_NET) 146*bbbd9b6eSWillian Rampazzo # virtio-blk requires 'driver' parameter 147*bbbd9b6eSWillian Rampazzo #self.check_all_variants('virtio-blk-pci', VIRTIO_BLOCK) 148*bbbd9b6eSWillian Rampazzo self.check_all_variants('virtio-serial-pci', VIRTIO_CONSOLE) 149*bbbd9b6eSWillian Rampazzo self.check_all_variants('virtio-rng-pci', VIRTIO_RNG) 150*bbbd9b6eSWillian Rampazzo self.check_all_variants('virtio-balloon-pci', VIRTIO_BALLOON) 151*bbbd9b6eSWillian Rampazzo self.check_all_variants('virtio-scsi-pci', VIRTIO_SCSI) 152*bbbd9b6eSWillian Rampazzo # virtio-9p requires 'fsdev' parameter 153*bbbd9b6eSWillian Rampazzo #self.check_all_variants('virtio-9p-pci', VIRTIO_9P) 154*bbbd9b6eSWillian Rampazzo 155*bbbd9b6eSWillian Rampazzo def check_modern_only(self, qemu_devtype, virtio_devid): 156*bbbd9b6eSWillian Rampazzo """Check if a modern-only virtio device type behaves as expected""" 157*bbbd9b6eSWillian Rampazzo # Force modern mode: 158*bbbd9b6eSWillian Rampazzo dev_modern, _ = self.run_device(qemu_devtype, 159*bbbd9b6eSWillian Rampazzo 'disable-modern=off,disable-legacy=on') 160*bbbd9b6eSWillian Rampazzo self.assert_devids(dev_modern, pci_modern_device_id(virtio_devid), 161*bbbd9b6eSWillian Rampazzo non_transitional=True) 162*bbbd9b6eSWillian Rampazzo 163*bbbd9b6eSWillian Rampazzo # No options: should be modern anyway 164*bbbd9b6eSWillian Rampazzo dev_no_opts, ifaces = self.run_device(qemu_devtype) 165*bbbd9b6eSWillian Rampazzo self.assertEqual(dev_modern, dev_no_opts) 166*bbbd9b6eSWillian Rampazzo 167*bbbd9b6eSWillian Rampazzo self.assertIn('conventional-pci-device', ifaces) 168*bbbd9b6eSWillian Rampazzo self.assertIn('pci-express-device', ifaces) 169*bbbd9b6eSWillian Rampazzo 170*bbbd9b6eSWillian Rampazzo def test_modern_only_devs(self): 171*bbbd9b6eSWillian Rampazzo self.check_modern_only('virtio-vga', VIRTIO_GPU) 172*bbbd9b6eSWillian Rampazzo self.check_modern_only('virtio-gpu-pci', VIRTIO_GPU) 173*bbbd9b6eSWillian Rampazzo self.check_modern_only('virtio-mouse-pci', VIRTIO_INPUT) 174*bbbd9b6eSWillian Rampazzo self.check_modern_only('virtio-tablet-pci', VIRTIO_INPUT) 175*bbbd9b6eSWillian Rampazzo self.check_modern_only('virtio-keyboard-pci', VIRTIO_INPUT) 176