xref: /openbmc/qemu/tests/avocado/replay_linux.py (revision 2f95279a) 
1# Record/replay test that boots a complete Linux system via a cloud image
2#
3# Copyright (c) 2020 ISP RAS
4#
5# Author:
6#  Pavel Dovgalyuk <Pavel.Dovgaluk@ispras.ru>
7#
8# This work is licensed under the terms of the GNU GPL, version 2 or
9# later.  See the COPYING file in the top-level directory.
10
11import os
12import logging
13import time
14
15from avocado import skipUnless
16from avocado_qemu import BUILD_DIR
17from avocado.utils import cloudinit
18from avocado.utils import network
19from avocado.utils import vmimage
20from avocado.utils import datadrainer
21from avocado.utils.path import find_command
22from avocado_qemu import LinuxTest
23
24class ReplayLinux(LinuxTest):
25    """
26    Boots a Linux system, checking for a successful initialization
27    """
28
29    timeout = 1800
30    chksum = None
31    hdd = 'ide-hd'
32    cd = 'ide-cd'
33    bus = 'ide'
34
35    def setUp(self):
36        # LinuxTest does many replay-incompatible things, but includes
37        # useful methods. Do not setup LinuxTest here and just
38        # call some functions.
39        super(LinuxTest, self).setUp()
40        self._set_distro()
41        self.boot_path = self.download_boot()
42        self.phone_server = cloudinit.PhoneHomeServer(('0.0.0.0', 0),
43                                                      self.name)
44        ssh_pubkey, self.ssh_key = self.set_up_existing_ssh_keys()
45        self.cloudinit_path = self.prepare_cloudinit(ssh_pubkey)
46
47    def vm_add_disk(self, vm, path, id, device):
48        bus_string = ''
49        if self.bus:
50            bus_string = ',bus=%s.%d' % (self.bus, id,)
51        vm.add_args('-drive', 'file=%s,snapshot=on,id=disk%s,if=none' % (path, id))
52        vm.add_args('-drive',
53            'driver=blkreplay,id=disk%s-rr,if=none,image=disk%s' % (id, id))
54        vm.add_args('-device',
55            '%s,drive=disk%s-rr%s' % (device, id, bus_string))
56
57    def vm_add_cdrom(self, vm, path, id, device):
58        vm.add_args('-drive', 'file=%s,id=disk%s,if=none,media=cdrom' % (path, id))
59
60    def launch_and_wait(self, record, args, shift):
61        self.require_netdev('user')
62        vm = self.get_vm()
63        vm.add_args('-smp', '1')
64        vm.add_args('-m', '1024')
65        vm.add_args('-netdev', 'user,id=vnet,hostfwd=:127.0.0.1:0-:22',
66                    '-device', 'virtio-net,netdev=vnet')
67        vm.add_args('-object', 'filter-replay,id=replay,netdev=vnet')
68        if args:
69            vm.add_args(*args)
70        self.vm_add_disk(vm, self.boot_path, 0, self.hdd)
71        self.vm_add_cdrom(vm, self.cloudinit_path, 1, self.cd)
72        logger = logging.getLogger('replay')
73        if record:
74            logger.info('recording the execution...')
75            mode = 'record'
76        else:
77            logger.info('replaying the execution...')
78            mode = 'replay'
79        replay_path = os.path.join(self.workdir, 'replay.bin')
80        vm.add_args('-icount', 'shift=%s,rr=%s,rrfile=%s' %
81                    (shift, mode, replay_path))
82
83        start_time = time.time()
84
85        vm.set_console()
86        vm.launch()
87        console_drainer = datadrainer.LineLogger(vm.console_socket.fileno(),
88                                    logger=self.log.getChild('console'),
89                                    stop_check=(lambda : not vm.is_running()))
90        console_drainer.start()
91        if record:
92            while not self.phone_server.instance_phoned_back:
93                self.phone_server.handle_request()
94            vm.shutdown()
95            logger.info('finished the recording with log size %s bytes'
96                % os.path.getsize(replay_path))
97        else:
98            vm.event_wait('SHUTDOWN', self.timeout)
99            vm.wait()
100            logger.info('successfully finished the replay')
101        elapsed = time.time() - start_time
102        logger.info('elapsed time %.2f sec' % elapsed)
103        return elapsed
104
105    def run_rr(self, args=None, shift=7):
106        t1 = self.launch_and_wait(True, args, shift)
107        t2 = self.launch_and_wait(False, args, shift)
108        logger = logging.getLogger('replay')
109        logger.info('replay overhead {:.2%}'.format(t2 / t1 - 1))
110
111@skipUnless(os.getenv('AVOCADO_TIMEOUT_EXPECTED'), 'Test might timeout')
112class ReplayLinuxX8664(ReplayLinux):
113    """
114    :avocado: tags=arch:x86_64
115    :avocado: tags=accel:tcg
116    """
117
118    chksum = 'e3c1b309d9203604922d6e255c2c5d098a309c2d46215d8fc026954f3c5c27a0'
119
120    def test_pc_i440fx(self):
121        """
122        :avocado: tags=machine:pc
123        """
124        self.run_rr(shift=1)
125
126    def test_pc_q35(self):
127        """
128        :avocado: tags=machine:q35
129        """
130        self.run_rr(shift=3)
131
132@skipUnless(os.getenv('AVOCADO_TIMEOUT_EXPECTED'), 'Test might timeout')
133class ReplayLinuxX8664Virtio(ReplayLinux):
134    """
135    :avocado: tags=arch:x86_64
136    :avocado: tags=virtio
137    :avocado: tags=accel:tcg
138    """
139
140    hdd = 'virtio-blk-pci'
141    cd = 'virtio-blk-pci'
142    bus = None
143
144    chksum = 'e3c1b309d9203604922d6e255c2c5d098a309c2d46215d8fc026954f3c5c27a0'
145
146    def test_pc_i440fx(self):
147        """
148        :avocado: tags=machine:pc
149        """
150        self.run_rr(shift=1)
151
152    def test_pc_q35(self):
153        """
154        :avocado: tags=machine:q35
155        """
156        self.run_rr(shift=3)
157
158@skipUnless(os.getenv('AVOCADO_TIMEOUT_EXPECTED'), 'Test might timeout')
159class ReplayLinuxAarch64(ReplayLinux):
160    """
161    :avocado: tags=accel:tcg
162    :avocado: tags=arch:aarch64
163    :avocado: tags=machine:virt
164    :avocado: tags=cpu:max
165    """
166
167    chksum = '1e18d9c0cf734940c4b5d5ec592facaed2af0ad0329383d5639c997fdf16fe49'
168
169    hdd = 'virtio-blk-device'
170    cd = 'virtio-blk-device'
171    bus = None
172
173    def get_common_args(self):
174        return ('-bios',
175                os.path.join(BUILD_DIR, 'pc-bios', 'edk2-aarch64-code.fd'),
176                "-cpu", "max,lpa2=off",
177                '-device', 'virtio-rng-pci,rng=rng0',
178                '-object', 'rng-builtin,id=rng0')
179
180    def test_virt_gicv2(self):
181        """
182        :avocado: tags=machine:gic-version=2
183        """
184
185        self.run_rr(shift=3,
186                    args=(*self.get_common_args(),
187                          "-machine", "virt,gic-version=2"))
188
189    def test_virt_gicv3(self):
190        """
191        :avocado: tags=machine:gic-version=3
192        """
193
194        self.run_rr(shift=3,
195                    args=(*self.get_common_args(),
196                          "-machine", "virt,gic-version=3"))
197