X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FQemuUtils.py;h=a61a11d37a4ed9ebfd64c459db1f34ab35ec2d78;hb=ada7009a3c826430e83a29c31bdf9a5973986ad9;hp=3751cd6da9e991dd9fd6c944b6aa6c39ec84d638;hpb=411b4dfab6252c55d8235afaf3d1324b50b61f00;p=csit.git diff --git a/resources/libraries/python/QemuUtils.py b/resources/libraries/python/QemuUtils.py index 3751cd6da9..a61a11d37a 100644 --- a/resources/libraries/python/QemuUtils.py +++ b/resources/libraries/python/QemuUtils.py @@ -1,4 +1,4 @@ -# Copyright (c) 2016 Cisco and/or its affiliates. +# Copyright (c) 2018 Cisco and/or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -16,35 +16,48 @@ from time import time, sleep import json import re +# Disable due to pylint bug +# pylint: disable=no-name-in-module,import-error +from distutils.version import StrictVersion from robot.api import logger -from resources.libraries.python.ssh import SSH +from resources.libraries.python.ssh import SSH, SSHTimeout from resources.libraries.python.constants import Constants -from resources.libraries.python.topology import NodeType +from resources.libraries.python.DUTSetup import DUTSetup +from resources.libraries.python.topology import NodeType, Topology class QemuUtils(object): """QEMU utilities.""" - __QEMU_BIN = '/opt/qemu/bin/qemu-system-x86_64' - # QEMU Machine Protocol socket - __QMP_SOCK = '/tmp/qmp.sock' - # QEMU Guest Agent socket - __QGA_SOCK = '/tmp/qga.sock' - - def __init__(self): + def __init__(self, qemu_id=1): + self._qemu_id = qemu_id + self._vhost_id = 0 + self._ssh = None + self._node = None + # Qemu Options self._qemu_opt = {} + # Path to QEMU binary. Use x86_64 by default + self._qemu_opt['qemu_path'] = '/usr/bin/' + self._qemu_opt['qemu_bin'] = 'qemu-system-x86_64' + # QEMU Machine Protocol socket + self._qemu_opt['qmp_sock'] = '/tmp/qmp{0}.sock'.format(self._qemu_id) + # QEMU Guest Agent socket + self._qemu_opt['qga_sock'] = '/tmp/qga{0}.sock'.format(self._qemu_id) + # QEMU PID file + self._qemu_opt['pid_file'] = '/tmp/qemu{0}.pid'.format(self._qemu_id) # Default 1 CPU. self._qemu_opt['smp'] = '-smp 1,sockets=1,cores=1,threads=1' # Daemonize the QEMU process after initialization. Default one # management interface. self._qemu_opt['options'] = '-cpu host -daemonize -enable-kvm ' \ - '-machine pc-1.0,accel=kvm,usb=off,mem-merge=off ' \ - '-net nic,macaddr=52:54:00:00:02:01 -balloon none' - self._qemu_opt['ssh_fwd_port'] = 10022 + '-machine pc,accel=kvm,usb=off,mem-merge=off ' \ + '-net nic,macaddr=52:54:00:00:{0:02x}:ff -balloon none'\ + .format(self._qemu_id) + self._qemu_opt['ssh_fwd_port'] = 10021 + qemu_id # Default serial console port - self._qemu_opt['serial_port'] = 4556 + self._qemu_opt['serial_port'] = 4555 + qemu_id # Default 512MB virtual RAM self._qemu_opt['mem_size'] = 512 # Default huge page mount point, required for Vhost-user interfaces. @@ -53,35 +66,61 @@ class QemuUtils(object): self._qemu_opt['huge_allocate'] = False # Default image for CSIT virl setup self._qemu_opt['disk_image'] = '/var/lib/vm/vhost-nested.img' - # Affinity of qemu processes - self._qemu_opt['affinity'] = False + # Virtio queue count + self._qemu_opt['queue_count'] = 1 + # Virtio queue size + self._qemu_opt['queue_size'] = None # VM node info dict self._vm_info = { 'type': NodeType.VM, - 'port': 10022, + 'port': self._qemu_opt['ssh_fwd_port'], 'username': 'cisco', 'password': 'cisco', 'interfaces': {}, } - self._vhost_id = 0 - self._ssh = None - self._node = None - self._socks = [self.__QMP_SOCK, self.__QGA_SOCK] + # Qemu Sockets + self._socks = [self._qemu_opt.get('qmp_sock'), + self._qemu_opt.get('qga_sock')] + + def qemu_set_path(self, path): + """Set binary path for QEMU. + + :param path: Absolute path in filesystem. + :type path: str + """ + self._qemu_opt['qemu_path'] = path - def qemu_set_smp(self, cpus, cores, threads, sockets): - """Set SMP option for QEMU + def qemu_set_queue_count(self, count): + """Set number of virtio queues. - :param cpus: Number of CPUs. + :param count: Number of virtio queues. + :type count: int + """ + self._qemu_opt['queue_count'] = int(count) + + def qemu_set_queue_size(self, size): + """Set RX/TX size of virtio queues. + + :param size: Size of virtio queues. + :type size: int + """ + self._qemu_opt['queue_size'] = int(size) + + def qemu_set_smp(self, smp, cores, threads, sockets): + """Set SMP option for QEMU. + + :param smp: Number of CPUs. :param cores: Number of CPU cores on one socket. :param threads: Number of threads on one CPU core. :param sockets: Number of discrete sockets in the system. - :type cpus: int + :type smp: int :type cores: int :type threads: int :type sockets: int """ - self._qemu_opt['smp'] = '-smp {},cores={},threads={},sockets={}'.format( - cpus, cores, threads, sockets) + self._qemu_opt['smp'] = \ + ('-smp {smp},cores={cores},threads={threads},sockets={sockets}'. + format(smp=smp, cores=cores, threads=threads, sockets=sockets)) def qemu_set_ssh_fwd_port(self, fwd_port): """Set host port for guest SSH forwarding. @@ -128,13 +167,41 @@ class QemuUtils(object): """ self._qemu_opt['disk_image'] = disk_image - def qemu_set_affinity(self, mask): - """Set qemu affinity by taskset with cpu mask. + def qemu_set_affinity(self, *host_cpus): + """Set qemu affinity by getting thread PIDs via QMP and taskset to list + of CPU cores. - :param mask: Hex CPU mask. - :type mask: str + :param host_cpus: List of CPU cores. + :type host_cpus: list """ - self._qemu_opt['affinity'] = mask + qemu_cpus = self._qemu_qmp_exec('query-cpus')['return'] + + if len(qemu_cpus) != len(host_cpus): + raise ValueError('Host CPU count must match Qemu Thread count') + + for qemu_cpu, host_cpu in zip(qemu_cpus, host_cpus): + ret_code, _, _ = self._ssh.exec_command_sudo( + 'taskset -pc {host_cpu} {thread_id}'. + format(host_cpu=host_cpu, thread_id=qemu_cpu['thread_id'])) + if int(ret_code) != 0: + raise RuntimeError('Set affinity failed on {host}'. + format(host=self._node['host'])) + + def qemu_set_scheduler_policy(self): + """Set scheduler policy to SCHED_RR with priority 1 for all Qemu CPU + processes. + + :raises RuntimeError: Set scheduler policy failed. + """ + qemu_cpus = self._qemu_qmp_exec('query-cpus')['return'] + + for qemu_cpu in qemu_cpus: + ret_code, _, _ = self._ssh.exec_command_sudo( + 'chrt -r -p 1 {thread_id}'. + format(thread_id=qemu_cpu['thread_id'])) + if int(ret_code) != 0: + raise RuntimeError('Set SCHED_RR failed on {host}'. + format(host=self._node['host'])) def qemu_set_node(self, node): """Set node to run QEMU on. @@ -147,41 +214,58 @@ class QemuUtils(object): self._ssh.connect(node) self._vm_info['host'] = node['host'] - def qemu_add_vhost_user_if(self, socket, server=True, mac=None): + arch = Topology.get_node_arch(node) + self._qemu_opt['qemu_bin'] = 'qemu-system-{arch}'.format(arch=arch) + + def qemu_add_vhost_user_if(self, socket, server=True, mac=None, + jumbo_frames=False): """Add Vhost-user interface. :param socket: Path of the unix socket. :param server: If True the socket shall be a listening socket. :param mac: Vhost-user interface MAC address (optional, otherwise is - used autogenerated MAC 52:54:00:00:04:xx). + used auto-generated MAC 52:54:00:00:xx:yy). + :param jumbo_frames: Set True if jumbo frames are used in the test. :type socket: str :type server: bool :type mac: str + :type jumbo_frames: bool """ self._vhost_id += 1 # Create unix socket character device. - chardev = ' -chardev socket,id=char{0},path={1}'.format(self._vhost_id, - socket) - if server is True: - chardev += ',server' + chardev = (' -chardev socket,id=char{vhost_id},path={socket}{server}'. + format(vhost_id=self._vhost_id, + socket=socket, + server=',server' if server is True else '')) self._qemu_opt['options'] += chardev # Create Vhost-user network backend. - netdev = ' -netdev vhost-user,id=vhost{0},chardev=char{0}'.format( - self._vhost_id) + netdev = (' -netdev vhost-user,id=vhost{vhost_id},' + 'chardev=char{vhost_id},queues={queue_count}'. + format(vhost_id=self._vhost_id, + queue_count=self._qemu_opt.get('queue_count'))) self._qemu_opt['options'] += netdev - # If MAC is not specified use autogenerated 52:54:00:00:04: - # e.g. vhost1 MAC is 52:54:00:00:04:01 - if mac is None: - mac = '52:54:00:00:04:{0:02x}'.format(self._vhost_id) - extend_options = 'csum=off,gso=off,guest_tso4=off,guest_tso6=off,'\ - 'guest_ecn=off,mrg_rxbuf=off' + # If MAC is not specified use auto-generated MAC address based on + # template 52:54:00:00::, e.g. vhost1 MAC of QEMU + # with ID 1 is 52:54:00:00:01:01 + mac = ('52:54:00:00:{qemu_id:02x}:{vhost_id:02x}'. + format(qemu_id=self._qemu_id, vhost_id=self._vhost_id))\ + if mac is None else mac + + queue_size = (',rx_queue_size={queue_size},tx_queue_size={queue_size}'. + format(queue_size=self._qemu_opt.get('queue_size')))\ + if self._qemu_opt.get('queue_size') else '' + # Create Virtio network device. - device = ' -device virtio-net-pci,netdev=vhost{0},mac={1},{2}'.format( - self._vhost_id, mac, extend_options) + device = (' -device virtio-net-pci,netdev=vhost{vhost_id},mac={mac},' + 'mq=on,csum=off,gso=off,guest_tso4=off,guest_tso6=off,' + 'guest_ecn=off,mrg_rxbuf={mbuf}{queue_size}'. + format(vhost_id=self._vhost_id, mac=mac, + mbuf='on,host_mtu=9200' if jumbo_frames else 'off', + queue_size=queue_size)) self._qemu_opt['options'] += device # Add interface MAC and socket to the node dict if_data = {'mac_address': mac, 'socket': socket} - if_name = 'vhost{}'.format(self._vhost_id) + if_name = 'vhost{vhost_id}'.format(vhost_id=self._vhost_id) self._vm_info['interfaces'][if_name] = if_data # Add socket to the socket list self._socks.append(socket) @@ -193,38 +277,35 @@ class QemuUtils(object): :param cmd: QMP command to execute. :type cmd: str - :return: Command output in python representation of JSON format. The + :returns: Command output in python representation of JSON format. The { "return": {} } response is QMP's success response. An error response will contain the "error" keyword instead of "return". """ # To enter command mode, the qmp_capabilities command must be issued. - qmp_cmd = 'echo "{ \\"execute\\": \\"qmp_capabilities\\" }' + \ - '{ \\"execute\\": \\"' + cmd + '\\" }" | sudo -S nc -U ' + \ - self.__QMP_SOCK - (ret_code, stdout, stderr) = self._ssh.exec_command(qmp_cmd) - if 0 != int(ret_code): - logger.debug('QMP execute failed {0}'.format(stderr)) - raise RuntimeError('QMP execute "{0}" failed on {1}'.format(cmd, - self._node['host'])) - logger.trace(stdout) + ret_code, stdout, _ = self._ssh.exec_command( + 'echo "{{ \\"execute\\": \\"qmp_capabilities\\" }}' + '{{ \\"execute\\": \\"{cmd}\\" }}" | ' + 'sudo -S socat - UNIX-CONNECT:{qmp_sock}'. + format(cmd=cmd, qmp_sock=self._qemu_opt.get('qmp_sock'))) + if int(ret_code) != 0: + raise RuntimeError('QMP execute "{cmd}" failed on {host}'. + format(cmd=cmd, host=self._node['host'])) # Skip capabilities negotiation messages. out_list = stdout.splitlines() if len(out_list) < 3: - raise RuntimeError('Invalid QMP output on {0}'.format( - self._node['host'])) + raise RuntimeError('Invalid QMP output on {host}'. + format(host=self._node['host'])) return json.loads(out_list[2]) def _qemu_qga_flush(self): - """Flush the QGA parser state - """ - qga_cmd = 'printf "\xFF" | sudo -S nc ' \ - '-q 1 -U ' + self.__QGA_SOCK - (ret_code, stdout, stderr) = self._ssh.exec_command(qga_cmd) - if 0 != int(ret_code): - logger.debug('QGA execute failed {0}'.format(stderr)) - raise RuntimeError('QGA execute "{0}" failed on {1}'.format(cmd, - self._node['host'])) - logger.trace(stdout) + """Flush the QGA parser state.""" + ret_code, stdout, _ = self._ssh.exec_command( + '(printf "\xFF"; sleep 1) | ' + 'sudo -S socat - UNIX-CONNECT:{qga_sock}'. + format(qga_sock=self._qemu_opt.get('qga_sock'))) + if int(ret_code) != 0: + raise RuntimeError('QGA flush failed on {host}'. + format(host=self._node['host'])) if not stdout: return {} return json.loads(stdout.split('\n', 1)[0]) @@ -237,33 +318,55 @@ class QemuUtils(object): :param cmd: QGA command to execute. :type cmd: str """ - qga_cmd = 'echo "{ \\"execute\\": \\"' + cmd + '\\" }" | sudo -S nc ' \ - '-q 1 -U ' + self.__QGA_SOCK - (ret_code, stdout, stderr) = self._ssh.exec_command(qga_cmd) - if 0 != int(ret_code): - logger.debug('QGA execute failed {0}'.format(stderr)) - raise RuntimeError('QGA execute "{0}" failed on {1}'.format(cmd, - self._node['host'])) - logger.trace(stdout) + ret_code, stdout, _ = self._ssh.exec_command( + '(echo "{{ \\"execute\\": \\"{cmd}\\" }}"; sleep 1) | ' + 'sudo -S socat - UNIX-CONNECT:{qga_sock}'. + format(cmd=cmd, qga_sock=self._qemu_opt.get('qga_sock'))) + if int(ret_code) != 0: + raise RuntimeError('QGA execute "{cmd}" failed on {host}'. + format(cmd=cmd, host=self._node['host'])) if not stdout: return {} return json.loads(stdout.split('\n', 1)[0]) - def _wait_until_vm_boot(self, timeout=300): + def _wait_until_vm_boot(self, timeout=60): """Wait until QEMU VM is booted. - Ping QEMU guest agent each 5s until VM booted or timeout. + First try to flush qga until there is output. + Then ping QEMU guest agent each 5s until VM booted or timeout. - :param timeout: Waiting timeout in seconds (optional, default 300s). + :param timeout: Waiting timeout in seconds (optional, default 60s). :type timeout: int """ start = time() - while 1: + while True: if time() - start > timeout: - raise RuntimeError('timeout, VM {0} not booted on {1}'.format( - self._qemu_opt['disk_image'], self._node['host'])) - self._qemu_qga_flush() - out = self._qemu_qga_exec('guest-ping') + raise RuntimeError('timeout, VM {disk} not booted on {host}'. + format(disk=self._qemu_opt['disk_image'], + host=self._node['host'])) + out = None + try: + out = self._qemu_qga_flush() + except ValueError: + logger.trace('QGA qga flush unexpected output {out}'. + format(out=out)) + # Empty output - VM not booted yet + if not out: + sleep(5) + else: + break + while True: + if time() - start > timeout: + raise RuntimeError('timeout, VM with {disk} not booted ' + 'on {host}'. + format(disk=self._qemu_opt['disk_image'], + host=self._node['host'])) + out = None + try: + out = self._qemu_qga_exec('guest-ping') + except ValueError: + logger.trace('QGA guest-ping unexpected output {out}'. + format(out=out)) # Empty output - VM not booted yet if not out: sleep(5) @@ -274,10 +377,14 @@ class QemuUtils(object): elif out.get('error') is not None: sleep(5) else: - raise RuntimeError('QGA guest-ping unexpected output {}'.format( - out)) - logger.trace('VM {0} booted on {1}'.format(self._qemu_opt['disk_image'], - self._node['host'])) + # If there is an unexpected output from QGA guest-info, try + # again until timeout. + logger.trace('QGA guest-ping unexpected output {out}'. + format(out=out)) + + logger.trace('VM with {disk_image} booted on {host}'. + format(disk_image=self._qemu_opt['disk_image'], + host=self._node['host'])) def _update_vm_interfaces(self): """Update interface names in VM node dict.""" @@ -288,8 +395,10 @@ class QemuUtils(object): interfaces = out.get('return') mac_name = {} if not interfaces: - raise RuntimeError('Get VM {0} interface list failed on {1}'.format( - self._qemu_opt['disk_image'], self._node['host'])) + raise RuntimeError('Get VM {disk_image} interface list failed ' + 'on {host}'. + format(disk_image=self._qemu_opt['disk_image'], + host=self._node['host'])) # Create MAC-name dict for interface in interfaces: if 'hardware-address' not in interface: @@ -300,131 +409,84 @@ class QemuUtils(object): mac = interface.get('mac_address') if_name = mac_name.get(mac) if if_name is None: - logger.trace('Interface name for MAC {} not found'.format(mac)) + logger.trace('Interface name for MAC {mac} not found'. + format(mac=mac)) else: interface['name'] = if_name - def _huge_page_check(self): - """Huge page check.""" - huge_mnt = self._qemu_opt.get('huge_mnt') - mem_size = self._qemu_opt.get('mem_size') - # Check size of free huge pages - (_, output, _) = self._ssh.exec_command('grep Huge /proc/meminfo') - regex = re.compile(r'HugePages_Free:\s+(\d+)') - match = regex.search(output) - huge_free = int(match.group(1)) - regex = re.compile(r'Hugepagesize:\s+(\d+)') - match = regex.search(output) - huge_size = int(match.group(1)) - if (mem_size * 1024) > (huge_free * huge_size): - raise RuntimeError('Not enough free huge pages {0} kB, required ' - '{1} MB'.format(huge_free * huge_size, mem_size)) - # Check if huge pages mount point exist - has_huge_mnt = False - (_, output, _) = self._ssh.exec_command('cat /proc/mounts') - for line in output.splitlines(): - # Try to find something like: - # none /mnt/huge hugetlbfs rw,relatime,pagesize=2048k 0 0 - mount = line.split() - if mount[2] == 'hugetlbfs' and mount[1] == huge_mnt: - has_huge_mnt = True - break - # If huge page mount point not exist create one - if not has_huge_mnt: - cmd = 'mount -t hugetlbfs -o pagesize=2048k none {0}'.format( - huge_mnt) - (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd) - if int(ret_code) != 0: - logger.debug('Mount huge pages failed {0}'.format(stderr)) - raise RuntimeError('Mount huge pages failed on {0}'.format( - self._node['host'])) - - def _huge_page_allocate(self): - """Huge page allocate.""" - huge_mnt = self._qemu_opt.get('huge_mnt') - mem_size = self._qemu_opt.get('mem_size') - # Check size of free huge pages - (_, output, _) = self._ssh.exec_command('grep Huge /proc/meminfo') - regex = re.compile(r'HugePages_Free:\s+(\d+)') - match = regex.search(output) - huge_free = int(match.group(1)) - regex = re.compile(r'HugePages_Total:\s+(\d+)') - match = regex.search(output) - huge_total = int(match.group(1)) - regex = re.compile(r'Hugepagesize:\s+(\d+)') - match = regex.search(output) - huge_size = int(match.group(1)) - - mem_needed = abs((huge_free * huge_size) - (mem_size * 1024)) - - if mem_needed: - huge_to_allocate = (mem_needed / huge_size) + huge_total - # Increase limit of allowed max hugepage count - cmd = 'echo "{0}" | sudo tee /proc/sys/vm/max_map_count'.format( - huge_to_allocate*3) - (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd) - # Increase hugepage count - cmd = 'echo "{0}" | sudo tee /proc/sys/vm/nr_hugepages'.format( - huge_to_allocate) - (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd) - if int(ret_code) != 0: - logger.debug('Mount huge pages failed {0}'.format(stderr)) - raise RuntimeError('Mount huge pages failed on {0}'.format( - self._node['host'])) - def qemu_start(self): """Start QEMU and wait until VM boot. - :return: VM node info. - :rtype: dict .. note:: First set at least node to run QEMU on. - .. warning:: Starts only one VM on the node. + + :returns: VM node info. + :rtype: dict """ - # SSH forwarding - ssh_fwd = '-net user,hostfwd=tcp::{0}-:22'.format( - self._qemu_opt.get('ssh_fwd_port')) - # Memory and huge pages - mem = '-object memory-backend-file,id=mem,size={0}M,mem-path={1},' \ - 'share=on -m {0} -numa node,memdev=mem'.format( - self._qemu_opt.get('mem_size'), self._qemu_opt.get('huge_mnt')) + # Qemu binary path + bin_path = ('{qemu_path}{qemu_bin}'. + format(qemu_path=self._qemu_opt.get('qemu_path'), + qemu_bin=self._qemu_opt.get('qemu_bin'))) - # By default check only if hugepages are availbale. - # If 'huge_allocate' is set to true try to allocate as well. - try: - self._huge_page_check() - except RuntimeError as runtime_error: - if self._qemu_opt.get('huge_allocate'): - self._huge_page_allocate() - else: - raise runtime_error + # Memory and huge pages + mem = ('-object memory-backend-file,id=mem,size={mem_size}M,' + 'mem-path={path},share=on -m {mem_size} -numa node,memdev=mem'. + format(mem_size=self._qemu_opt.get('mem_size'), + path=self._qemu_opt.get('huge_mnt'))) + + # Drive option + drive = ('-drive file={disk_image},format=raw,cache=none,if=virtio' + '{locking}'. + format(disk_image=self._qemu_opt.get('disk_image'), + locking=',file.locking=off'\ + if self._qemu_version_is_greater('2.10') else '')) + # SSH forwarding + ssh = ('-net user,hostfwd=tcp::{ssh_fwd_port}-:22'. + format(ssh_fwd_port=self._qemu_opt.get('ssh_fwd_port'))) # Setup QMP via unix socket - qmp = '-qmp unix:{0},server,nowait'.format(self.__QMP_SOCK) - # Setup serial console - serial = '-chardev socket,host=127.0.0.1,port={0},id=gnc0,server,' \ - 'nowait -device isa-serial,chardev=gnc0'.format( - self._qemu_opt.get('serial_port')) + qmp = ('-qmp unix:{qmp_sock},server,nowait'. + format(qmp_sock=self._qemu_opt.get('qmp_sock'))) # Setup QGA via chardev (unix socket) and isa-serial channel - qga = '-chardev socket,path=/tmp/qga.sock,server,nowait,id=qga0 ' \ - '-device isa-serial,chardev=qga0' + qga = ('-chardev socket,path={qga_sock},server,nowait,id=qga0 ' + '-device isa-serial,chardev=qga0'. + format(qga_sock=self._qemu_opt.get('qga_sock'))) + # Setup serial console + serial = ('-chardev socket,host=127.0.0.1,port={serial_port},id=gnc0,' + 'server,nowait -device isa-serial,chardev=gnc0'. + format(serial_port=self._qemu_opt.get('serial_port'))) + # Graphic setup graphic = '-monitor none -display none -vga none' - qbin = 'taskset {0} {1}'.format(self._qemu_opt.get('affinity'), - self.__QEMU_BIN) if self._qemu_opt.get( - 'affinity') else self.__QEMU_BIN + + # PID file + pid = ('-pidfile {pid_file}'. + format(pid_file=self._qemu_opt.get('pid_file'))) + + # By default check only if hugepages are available. + # If 'huge_allocate' is set to true try to allocate as well. + DUTSetup.check_huge_page(self._node, self._qemu_opt.get('huge_mnt'), + self._qemu_opt.get('mem_size'), + allocate=self._qemu_opt.get('huge_allocate')) + # Run QEMU - cmd = '{0} {1} {2} {3} {4} -hda {5} {6} {7} {8} {9}'.format( - qbin, self._qemu_opt.get('smp'), mem, ssh_fwd, - self._qemu_opt.get('options'), - self._qemu_opt.get('disk_image'), qmp, serial, qga, graphic) - (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd, timeout=300) - if int(ret_code) != 0: - logger.debug('QEMU start failed {0}'.format(stderr)) - raise RuntimeError('QEMU start failed on {0}'.format( - self._node['host'])) - logger.trace('QEMU running') - # Wait until VM boot - self._wait_until_vm_boot() + cmd = ('{bin_path} {smp} {mem} {ssh} {options} {drive} {qmp} {serial} ' + '{qga} {graphic} {pid}'. + format(bin_path=bin_path, smp=self._qemu_opt.get('smp'), + mem=mem, ssh=ssh, options=self._qemu_opt.get('options'), + drive=drive, qmp=qmp, serial=serial, qga=qga, + graphic=graphic, pid=pid)) + try: + ret_code, _, _ = self._ssh.exec_command_sudo(cmd, timeout=300) + if int(ret_code) != 0: + raise RuntimeError('QEMU start failed on {host}'. + format(host=self._node['host'])) + # Wait until VM boot + self._wait_until_vm_boot() + except (RuntimeError, SSHTimeout): + self.qemu_kill_all() + self.qemu_clear_socks() + raise + logger.trace('QEMU started successfully.') # Update interface names in VM node dict self._update_vm_interfaces() # Return VM node dict @@ -435,41 +497,60 @@ class QemuUtils(object): out = self._qemu_qmp_exec('quit') err = out.get('error') if err is not None: - raise RuntimeError('QEMU quit failed on {0}, error: {1}'.format( - self._node['host'], json.dumps(err))) + raise RuntimeError('QEMU quit failed on {host}: {error}'. + format(host=self._node['host'], + error=json.dumps(err))) def qemu_system_powerdown(self): """Power down the system (if supported).""" out = self._qemu_qmp_exec('system_powerdown') err = out.get('error') if err is not None: - raise RuntimeError('QEMU system powerdown failed on {0}, ' - 'error: {1}'.format(self._node['host'], json.dumps(err))) + raise RuntimeError( + 'QEMU system powerdown failed on {host}: {error}'. + format(host=self._node['host'], error=json.dumps(err))) def qemu_system_reset(self): """Reset the system.""" out = self._qemu_qmp_exec('system_reset') err = out.get('error') if err is not None: - raise RuntimeError('QEMU system reset failed on {0}, ' - 'error: {1}'.format(self._node['host'], json.dumps(err))) + raise RuntimeError( + 'QEMU system reset failed on {host}: {error}'. + format(host=self._node['host'], error=json.dumps(err))) def qemu_kill(self): """Kill qemu process.""" - # TODO: add PID storage so that we can kill specific PID # Note: in QEMU start phase there are 3 QEMU processes because we # daemonize QEMU + self._ssh.exec_command_sudo('chmod +r {pid}'. + format(pid=self._qemu_opt.get('pid_file'))) + self._ssh.exec_command_sudo('kill -SIGKILL $(cat {pid})'. + format(pid=self._qemu_opt.get('pid_file'))) + # Delete PID file + self._ssh.exec_command_sudo('rm -f {pid}'. + format(pid=self._qemu_opt.get('pid_file'))) + + def qemu_kill_all(self, node=None): + """Kill all qemu processes on DUT node if specified. + + :param node: Node to kill all QEMU processes on. + :type node: dict + """ + if node: + self.qemu_set_node(node) self._ssh.exec_command_sudo('pkill -SIGKILL qemu') def qemu_clear_socks(self): """Remove all sockets created by QEMU.""" # If serial console port still open kill process - cmd = 'fuser -k {}/tcp'.format(self._qemu_opt.get('serial_port')) - self._ssh.exec_command_sudo(cmd) + self._ssh.exec_command_sudo('fuser -k {serial_port}/tcp'. + format(serial_port=\ + self._qemu_opt.get('serial_port'))) # Delete all created sockets - for sock in self._socks: - cmd = 'rm -f {}'.format(sock) - self._ssh.exec_command_sudo(cmd) + for socket in self._socks: + self._ssh.exec_command_sudo('rm -f {socket}'. + format(socket=socket)) def qemu_system_status(self): """Return current VM status. @@ -492,7 +573,7 @@ class QemuUtils(object): - watchdog: watchdog action has been triggered - guest-panicked: panicked as a result of guest OS panic - :return: VM status. + :returns: VM status. :rtype: str """ out = self._qemu_qmp_exec('query-status') @@ -501,23 +582,77 @@ class QemuUtils(object): return ret.get('status') else: err = out.get('error') - raise RuntimeError('QEMU query-status failed on {0}, ' - 'error: {1}'.format(self._node['host'], json.dumps(err))) + raise RuntimeError('QEMU query-status failed on {host}: {error}'. + format(host=self._node['host'], + error=json.dumps(err))) + + def qemu_version(self): + """Return Qemu version. + + :returns: Qemu version. + :rtype: str + """ + # Qemu binary path + bin_path = ('{qemu_path}{qemu_bin}'. + format(qemu_path=self._qemu_opt.get('qemu_path'), + qemu_bin=self._qemu_opt.get('qemu_bin'))) + + try: + ret_code, stdout, _ = self._ssh.exec_command_sudo( + '{bin_path} --version'. + format(bin_path=bin_path)) + if int(ret_code) != 0: + raise RuntimeError('Failed to get QEMU version on {host}'. + format(host=self._node['host'])) + + return re.match(r'QEMU emulator version ([\d.]*)', stdout).group(1) + except (RuntimeError, SSHTimeout): + self.qemu_kill_all() + self.qemu_clear_socks() + raise + + def _qemu_version_is_greater(self, version): + """Compare Qemu versions. + + :returns: True if installed Qemu version is greater. + :rtype: bool + """ + return StrictVersion(self.qemu_version()) > StrictVersion(version) @staticmethod - def build_qemu(node): + def build_qemu(node, force_install=False, apply_patch=False): """Build QEMU from sources. :param node: Node to build QEMU on. + :param force_install: If True, then remove previous build. + :param apply_patch: If True, then apply patches from qemu_patches dir. :type node: dict + :type force_install: bool + :type apply_patch: bool + :raises RuntimeError: If building QEMU failed. """ ssh = SSH() ssh.connect(node) - (ret_code, stdout, stderr) = \ - ssh.exec_command('sudo -Sn bash {0}/{1}/qemu_build.sh'.format( - Constants.REMOTE_FW_DIR, Constants.RESOURCES_LIB_SH), 1000) - logger.trace(stdout) - if 0 != int(ret_code): - logger.debug('QEMU build failed {0}'.format(stderr)) - raise RuntimeError('QEMU build failed on {0}'.format(node['host'])) + directory = (' --directory={install_dir}{patch}'. + format(install_dir=Constants.QEMU_INSTALL_DIR, + patch='-patch' if apply_patch else '-base')) + version = (' --version={install_version}'. + format(install_version=Constants.QEMU_INSTALL_VERSION)) + force = ' --force' if force_install else '' + patch = ' --patch' if apply_patch else '' + arch = Topology.get_node_arch(node) + target_list = (' --target-list={arch}-softmmu'. + format(arch=arch)) + + ret_code, _, _ = ssh.exec_command( + "sudo -E sh -c '{fw_dir}/{lib_sh}/qemu_build.sh{version}{directory}" + "{force}{patch}{target_list}'". + format(fw_dir=Constants.REMOTE_FW_DIR, + lib_sh=Constants.RESOURCES_LIB_SH, + version=version, directory=directory, force=force, + patch=patch, target_list=target_list), 1000) + + if int(ret_code) != 0: + raise RuntimeError('QEMU build failed on {host}'. + format(host=node['host']))