text: # Functional test that boots an s390x Linux guest with ccw and PCI devices
  # attached and checks whether the devices are recognized by Linux
  #
  # Copyright (c) 2020 Red Hat, Inc.
  #
  # Author:
  #  Cornelia Huck <cohuck@redhat.com>
  #
  # This work is licensed under the terms of the GNU GPL, version 2 or
  # later.  See the COPYING file in the top-level directory.
  
  import os
  import tempfile
  
  from avocado import skipIf
  from avocado_qemu import Test
  from avocado_qemu import exec_command_and_wait_for_pattern
  from avocado_qemu import wait_for_console_pattern
  from avocado.utils import archive
  
  class S390CCWVirtioMachine(Test):
      KERNEL_COMMON_COMMAND_LINE = 'printk.time=0 '
  
      timeout = 120
  
      def wait_for_console_pattern(self, success_message, vm=None):
          wait_for_console_pattern(self, success_message,
                                   failure_message='Kernel panic - not syncing',
                                   vm=vm)
  
      def wait_for_crw_reports(self):
          exec_command_and_wait_for_pattern(self,
                          'while ! (dmesg -c | grep CRW) ; do sleep 1 ; done',
                          'CRW reports')
  
      dmesg_clear_count = 1
      def clear_guest_dmesg(self):
          exec_command_and_wait_for_pattern(self, 'dmesg -c > /dev/null; '
                      'echo dm_clear\ ' + str(self.dmesg_clear_count),
                      'dm_clear ' + str(self.dmesg_clear_count))
          self.dmesg_clear_count += 1
  
      def test_s390x_devices(self):
  
          """
          :avocado: tags=arch:s390x
          :avocado: tags=machine:s390-ccw-virtio
          """
  
          kernel_url = ('https://snapshot.debian.org/archive/debian/'
                        '20201126T092837Z/dists/buster/main/installer-s390x/'
                        '20190702+deb10u6/images/generic/kernel.debian')
          kernel_hash = '5821fbee57d6220a067a8b967d24595621aa1eb6'
          kernel_path = self.fetch_asset(kernel_url, asset_hash=kernel_hash)
  
          initrd_url = ('https://snapshot.debian.org/archive/debian/'
                        '20201126T092837Z/dists/buster/main/installer-s390x/'
                        '20190702+deb10u6/images/generic/initrd.debian')
          initrd_hash = '81ba09c97bef46e8f4660ac25b4ac0a5be3a94d6'
          initrd_path = self.fetch_asset(initrd_url, asset_hash=initrd_hash)
  
          self.vm.set_console()
          kernel_command_line = (self.KERNEL_COMMON_COMMAND_LINE +
                                'console=sclp0 root=/dev/ram0 BOOT_DEBUG=3')
          self.vm.add_args('-nographic',
                           '-kernel', kernel_path,
                           '-initrd', initrd_path,
                           '-append', kernel_command_line,
                           '-device', 'virtio-net-ccw,devno=fe.1.1111',
                           '-device',
                           'virtio-rng-ccw,devno=fe.2.0000,max_revision=0,id=rn1',
                           '-device',
                           'virtio-rng-ccw,devno=fe.3.1234,max_revision=2,id=rn2',
                           '-device', 'zpci,uid=5,target=zzz',
                           '-device', 'virtio-net-pci,id=zzz',
                           '-device', 'zpci,uid=0xa,fid=12,target=serial',
                           '-device', 'virtio-serial-pci,id=serial',
                           '-device', 'virtio-balloon-ccw')
          self.vm.launch()
  
          shell_ready = "sh: can't access tty; job control turned off"
          self.wait_for_console_pattern(shell_ready)
          # first debug shell is too early, we need to wait for device detection
          exec_command_and_wait_for_pattern(self, 'exit', shell_ready)
  
          ccw_bus_ids="0.1.1111  0.2.0000  0.3.1234"
          pci_bus_ids="0005:00:00.0  000a:00:00.0"
          exec_command_and_wait_for_pattern(self, 'ls /sys/bus/ccw/devices/',
                                            ccw_bus_ids)
          exec_command_and_wait_for_pattern(self, 'ls /sys/bus/pci/devices/',
                                            pci_bus_ids)
          # check that the device at 0.2.0000 is in legacy mode, while the
          # device at 0.3.1234 has the virtio-1 feature bit set
          virtio_rng_features="00000000000000000000000000001100" + \
                              "10000000000000000000000000000000"
          virtio_rng_features_legacy="00000000000000000000000000001100" + \
                                     "00000000000000000000000000000000"
          exec_command_and_wait_for_pattern(self,
                          'cat /sys/bus/ccw/devices/0.2.0000/virtio?/features',
                          virtio_rng_features_legacy)
          exec_command_and_wait_for_pattern(self,
                          'cat /sys/bus/ccw/devices/0.3.1234/virtio?/features',
                          virtio_rng_features)
          # check that /dev/hwrng works - and that it's gone after ejecting
          exec_command_and_wait_for_pattern(self,
                          'dd if=/dev/hwrng of=/dev/null bs=1k count=10',
                          '10+0 records out')
          self.clear_guest_dmesg()
          self.vm.command('device_del', id='rn1')
          self.wait_for_crw_reports()
          self.clear_guest_dmesg()
          self.vm.command('device_del', id='rn2')
          self.wait_for_crw_reports()
          exec_command_and_wait_for_pattern(self,
                          'dd if=/dev/hwrng of=/dev/null bs=1k count=10',
                          'dd: /dev/hwrng: No such device')
          # verify that we indeed have virtio-net devices (without having the
          # virtio-net driver handy)
          exec_command_and_wait_for_pattern(self,
                                      'cat /sys/bus/ccw/devices/0.1.1111/cutype',
                                      '3832/01')
          exec_command_and_wait_for_pattern(self,
                      'cat /sys/bus/pci/devices/0005\:00\:00.0/subsystem_vendor',
                      '0x1af4')
          exec_command_and_wait_for_pattern(self,
                      'cat /sys/bus/pci/devices/0005\:00\:00.0/subsystem_device',
                      '0x0001')
          # check fid propagation
          exec_command_and_wait_for_pattern(self,
                          'cat /sys/bus/pci/devices/000a\:00\:00.0/function_id',
                          '0x0000000c')
          # add another device
          self.clear_guest_dmesg()
          self.vm.command('device_add', driver='virtio-net-ccw',
                          devno='fe.0.4711', id='net_4711')
          self.wait_for_crw_reports()
          exec_command_and_wait_for_pattern(self, 'for i in 1 2 3 4 5 6 7 ; do '
                      'if [ -e /sys/bus/ccw/devices/*4711 ]; then break; fi ;'
                      'sleep 1 ; done ; ls /sys/bus/ccw/devices/',
                      '0.0.4711')
          # and detach it again
          self.clear_guest_dmesg()
          self.vm.command('device_del', id='net_4711')
          self.vm.event_wait(name='DEVICE_DELETED',
                             match={'data': {'device': 'net_4711'}})
          self.wait_for_crw_reports()
          exec_command_and_wait_for_pattern(self,
                                            'ls /sys/bus/ccw/devices/0.0.4711',
                                            'No such file or directory')
          # test the virtio-balloon device
          exec_command_and_wait_for_pattern(self, 'head -n 1 /proc/meminfo',
                                            'MemTotal:         115640 kB')
          self.vm.command('human-monitor-command', command_line='balloon 96')
          exec_command_and_wait_for_pattern(self, 'head -n 1 /proc/meminfo',
                                            'MemTotal:          82872 kB')
          self.vm.command('human-monitor-command', command_line='balloon 128')
          exec_command_and_wait_for_pattern(self, 'head -n 1 /proc/meminfo',
                                            'MemTotal:         115640 kB')
  
  
      @skipIf(os.getenv('GITLAB_CI'), 'Running on GitLab')
      def test_s390x_fedora(self):
  
          """
          :avocado: tags=arch:s390x
          :avocado: tags=machine:s390-ccw-virtio
          :avocado: tags=device:virtio-gpu
          :avocado: tags=device:virtio-crypto
          :avocado: tags=device:virtio-net
          """
  
          kernel_url = ('https://archives.fedoraproject.org/pub/archive'
                        '/fedora-secondary/releases/31/Server/s390x/os'
                        '/images/kernel.img')
          kernel_hash = 'b93d1efcafcf29c1673a4ce371a1f8b43941cfeb'
          kernel_path = self.fetch_asset(kernel_url, asset_hash=kernel_hash)
  
          initrd_url = ('https://archives.fedoraproject.org/pub/archive'
                        '/fedora-secondary/releases/31/Server/s390x/os'
                        '/images/initrd.img')
          initrd_hash = '3de45d411df5624b8d8ef21cd0b44419ab59b12f'
          initrd_path_xz = self.fetch_asset(initrd_url, asset_hash=initrd_hash)
          initrd_path = os.path.join(self.workdir, 'initrd-raw.img')
          archive.lzma_uncompress(initrd_path_xz, initrd_path)
  
          self.vm.set_console()
          kernel_command_line = (self.KERNEL_COMMON_COMMAND_LINE + ' audit=0 '
                                'rd.plymouth=0 plymouth.enable=0 rd.rescue')
          self.vm.add_args('-nographic',
                           '-smp', '4',
                           '-m', '512',
                           '-name', 'Some Guest Name',
                           '-uuid', '30de4fd9-b4d5-409e-86a5-09b387f70bfa',
                           '-kernel', kernel_path,
                           '-initrd', initrd_path,
                           '-append', kernel_command_line,
                           '-device', 'zpci,uid=7,target=n',
                           '-device', 'virtio-net-pci,id=n,mac=02:ca:fe:fa:ce:12',
                           '-device', 'virtio-rng-ccw,devno=fe.1.9876',
                           '-device', 'virtio-gpu-ccw,devno=fe.2.5432')
          self.vm.launch()
          self.wait_for_console_pattern('Entering emergency mode')
  
          # Some tests to see whether the CLI options have been considered:
          self.log.info("Test whether QEMU CLI options have been considered")
          exec_command_and_wait_for_pattern(self,
                          'while ! (dmesg | grep enP7p0s0) ; do sleep 1 ; done',
                          'virtio_net virtio0 enP7p0s0: renamed')
          exec_command_and_wait_for_pattern(self, 'lspci',
                               '0007:00:00.0 Class 0200: Device 1af4:1000')
          exec_command_and_wait_for_pattern(self,
                               'cat /sys/class/net/enP7p0s0/address',
                               '02:ca:fe:fa:ce:12')
          exec_command_and_wait_for_pattern(self, 'lscss', '0.1.9876')
          exec_command_and_wait_for_pattern(self, 'lscss', '0.2.5432')
          exec_command_and_wait_for_pattern(self, 'cat /proc/cpuinfo',
                               'processors    : 4')
          exec_command_and_wait_for_pattern(self, 'grep MemTotal /proc/meminfo',
                               'MemTotal:         499848 kB')
          exec_command_and_wait_for_pattern(self, 'grep Name /proc/sysinfo',
                               'Extended Name:   Some Guest Name')
          exec_command_and_wait_for_pattern(self, 'grep UUID /proc/sysinfo',
                               '30de4fd9-b4d5-409e-86a5-09b387f70bfa')
  
          # Disable blinking cursor, then write some stuff into the framebuffer.
          # QEMU's PPM screendumps contain uncompressed 24-bit values, while the
          # framebuffer uses 32-bit, so we pad our text with some spaces when
          # writing to the framebuffer. Since the PPM is uncompressed, we then
          # can simply read the written "magic bytes" back from the PPM file to
          # check whether the framebuffer is working as expected.
          self.log.info("Test screendump of virtio-gpu device")
          exec_command_and_wait_for_pattern(self,
                          'while ! (dmesg | grep gpudrmfb) ; do sleep 1 ; done',
                          'virtio_gpudrmfb frame buffer device')
          exec_command_and_wait_for_pattern(self,
              'echo -e "\e[?25l" > /dev/tty0', ':/#')
          exec_command_and_wait_for_pattern(self, 'for ((i=0;i<250;i++)); do '
              'echo " The  qu ick  fo x j ump s o ver  a  laz y d og" >> fox.txt;'
              'done',
              ':/#')
          exec_command_and_wait_for_pattern(self,
              'dd if=fox.txt of=/dev/fb0 bs=1000 oflag=sync,nocache ; rm fox.txt',
              '12+0 records out')
          with tempfile.NamedTemporaryFile(suffix='.ppm',
                                           prefix='qemu-scrdump-') as ppmfile:
              self.vm.command('screendump', filename=ppmfile.name)
              ppmfile.seek(0)
              line = ppmfile.readline()
              self.assertEqual(line, b"P6\n")
              line = ppmfile.readline()
              self.assertEqual(line, b"1024 768\n")
              line = ppmfile.readline()
              self.assertEqual(line, b"255\n")
              line = ppmfile.readline(256)
              self.assertEqual(line, b"The quick fox jumps over a lazy dog\n")
  
          # Hot-plug a virtio-crypto device and see whether it gets accepted
          self.log.info("Test hot-plug virtio-crypto device")
          self.clear_guest_dmesg()
          self.vm.command('object-add', qom_type='cryptodev-backend-builtin',
                          id='cbe0')
          self.vm.command('device_add', driver='virtio-crypto-ccw', id='crypdev0',
                          cryptodev='cbe0', devno='fe.0.2342')
          exec_command_and_wait_for_pattern(self,
                          'while ! (dmesg -c | grep Accelerator.device) ; do'
                          ' sleep 1 ; done', 'Accelerator device is ready')
          exec_command_and_wait_for_pattern(self, 'lscss', '0.0.2342')
          self.vm.command('device_del', id='crypdev0')
          self.vm.command('object-del', id='cbe0')
          exec_command_and_wait_for_pattern(self,
                          'while ! (dmesg -c | grep Start.virtcrypto_remove) ; do'
                          ' sleep 1 ; done', 'Start virtcrypto_remove.')
  