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