diff options
Diffstat (limited to 'resources/libraries/python/QemuUtils.py')
| -rw-r--r-- | resources/libraries/python/QemuUtils.py | 360 |
1 files changed, 358 insertions, 2 deletions
diff --git a/resources/libraries/python/QemuUtils.py b/resources/libraries/python/QemuUtils.py index c723878499..7249b5e206 100644 --- a/resources/libraries/python/QemuUtils.py +++ b/resources/libraries/python/QemuUtils.py @@ -13,14 +13,370 @@ """QEMU utilities library.""" +import json +import re +from time import time, sleep from robot.api import logger -from ssh import SSH -from constants import Constants +from resources.libraries.python.ssh import SSH +from resources.libraries.python.constants import Constants +from resources.libraries.python.topology import NodeType class QemuUtils(object): """QEMU utilities.""" + __QEMU_BIN = '/tmp/qemu-2.2.1/build/x86_64-softmmu/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): + self._qemu_opt = {} + # 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'] = '-daemonize -enable-kvm ' \ + '-machine pc-1.0,accel=kvm,usb=off,mem-merge=off ' \ + '-net nic,macaddr=52:54:00:00:02:01' + self._qemu_opt['ssh_fwd_port'] = 10022 + # Default 512MB virtual RAM + self._qemu_opt['mem_size'] = 512 + # Default huge page mount point, required for Vhost-user interfaces. + self._qemu_opt['huge_mnt'] = '/mnt/huge' + # VM node info dict + self._vm_info = { + 'type': NodeType.VM, + 'port': 10022, + 'username': 'cisco', + 'password': 'cisco', + 'interfaces': {}, + } + self._vhost_id = 0 + self._ssh = None + self._node = None + self._socks = [self.__QMP_SOCK, self.__QGA_SOCK] + + def qemu_set_smp(self, cpus, cores, threads, sockets): + """Set SMP option for QEMU + + :param cpus: 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 cores: int + :type threads: int + :type sockets: int + """ + self._qemu_opt['smp'] = '-smp {},cores={},threads={},sockets={}'.format( + cpus, cores, threads, sockets) + + def qemu_set_ssh_fwd_port(self, fwd_port): + """Set host port for guest SSH forwarding. + + :param fwd_port: Port number on host for guest SSH forwarding. + :type fwd_port: int + """ + self._qemu_opt['ssh_fwd_port'] = fwd_port + self._vm_info['port'] = fwd_port + + def qemu_set_mem_size(self, mem_size): + """Set virtual RAM size. + + :param mem_size: RAM size in Mega Bytes. + :type mem_size: int + """ + self._qemu_opt['mem_size'] = mem_size + + def qemu_set_huge_mnt(self, huge_mnt): + """Set hugefile mount point. + + :param huge_mnt: System hugefile mount point. + :type huge_mnt: int + """ + self._qemu_opt['huge_mnt'] = huge_mnt + + def qemu_set_disk_image(self, disk_image): + """Set disk image. + + :param disk_image: Path of the disk image. + :type disk_image: str + """ + self._qemu_opt['disk_image'] = disk_image + + def qemu_set_node(self, node): + """Set node to run QEMU on. + + :param node: Node to run QEMU on. + :param node: dict + """ + self._node = node + self._ssh = SSH() + self._ssh.connect(node) + self._vm_info['host'] = node['host'] + + def qemu_add_vhost_user_if(self, socket, server=True, mac=None): + """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). + :type socket: str + :type server: bool + :type mac: str + """ + 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' + self._qemu_opt['options'] += chardev + # Create Vhost-user network backend. + netdev = ' -netdev vhost-user,id=vhost{0},chardev=char{0}'.format( + self._vhost_id) + self._qemu_opt['options'] += netdev + # If MAC is not specified use autogenerated 52:54:00:00:04:<vhost_id> + # 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) + # Create Virtio network device. + device = ' -device virtio-net-pci,netdev=vhost{0},mac={1}'.format( + self._vhost_id, mac) + 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) + self._vm_info['interfaces'][if_name] = if_data + # Add socket to the socket list + self._socks.append(socket) + + def _qemu_qmp_exec(self, cmd): + """Execute QMP command. + + QMP is JSON based protocol which allows to control QEMU instance. + + :param cmd: QMP command to execute. + :type cmd: str + :return: 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) + # Skip capabilities negotiation messages. + out_list = stdout.splitlines() + if len(out_list) < 3: + raise RuntimeError('Invalid QMP output on {0}'.format( + self._node['host'])) + return json.loads(out_list[2]) + + def _qemu_qga_exec(self, cmd): + """Execute QGA command. + + QGA provide access to a system-level agent via standard QMP commands. + + :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) + if not stdout: + return {} + return json.loads(stdout) + + def _wait_until_vm_boot(self, timeout=300): + """Wait until QEMU VM is booted. + + Ping QEMU guest agent each 5s until VM booted or timeout. + + :param timeout: Waiting timeout in seconds (optional, default 300s). + :type timeout: int + """ + start = time() + while 1: + if time() - start > timeout: + raise RuntimeError('timeout, VM {0} not booted on {1}'.format( + self._qemu_opt['disk_image'], self._node['host'])) + out = self._qemu_qga_exec('guest-ping') + # Empty output - VM not booted yet + if not out: + sleep(5) + # Non-error return - VM booted + elif out.get('return') is not None: + break + 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'])) + + def _update_vm_interfaces(self): + """Update interface names in VM node dict.""" + # Send guest-network-get-interfaces command via QGA, output example: + # {"return": [{"name": "eth0", "hardware-address": "52:54:00:00:04:01"}, + # {"name": "eth1", "hardware-address": "52:54:00:00:04:02"}]} + out = self._qemu_qga_exec('guest-network-get-interfaces') + 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'])) + # Create MAC-name dict + for interface in interfaces: + mac_name[interface['hardware-address']] = interface['name'] + # Match interface by MAC and save interface name + for interface in self._vm_info['interfaces'].values(): + 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)) + 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 qemu_start(self): + """Start QEMU and wait until VM boot. + + :return: VM node info + :rtype: dict + .. note:: First set at least disk image and node to run QEMU on. + """ + # 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')) + self._huge_page_check() + # Setup QMP via unix socket + qmp = '-qmp unix:{0},server,nowait'.format(self.__QMP_SOCK) + # Setup QGA via chardev (unix socket) and virtio-serial channel + qga = '-chardev socket,path=/tmp/qga.sock,server,nowait,id=qga0 ' \ + '-device virtio-serial ' \ + '-device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0' + # Run QEMU + cmd = '{0} {1} {2} {3} {4} -hda {5} {6} {7}'.format( + self.__QEMU_BIN, self._qemu_opt.get('smp'), mem, ssh_fwd, + self._qemu_opt.get('options'), + self._qemu_opt.get('disk_image'), qmp, qga) + (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() + # Update interface names in VM node dict + self._update_vm_interfaces() + # Return VM node dict + return self._vm_info + + def qemu_quit(self): + """Quit the QEMU emulator.""" + 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))) + + 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))) + + 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))) + + 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('pkill -SIGKILL qemu') + + def qemu_clear_socks(self): + """Remove all sockets created by QEMU.""" + for sock in self._socks: + cmd = 'rm -f {}'.format(sock) + self._ssh.exec_command_sudo(cmd) + + def qemu_system_status(self): + """Return current VM status. + + :return: VM status. + :rtype: str + """ + out = self._qemu_qmp_exec('query-status') + ret = out.get('return') + if ret is not None: + 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))) + @staticmethod def build_qemu(node): """Build QEMU from sources. |