resources/libraries/python/QemuUtils.py

   1 # Copyright (c) 2016 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """QEMU utilities library."""
  15
  16 from time import time, sleep
  17 import json
  18
  19 from robot.api import logger
  20
  21 from resources.libraries.python.ssh import SSH
  22 from resources.libraries.python.constants import Constants
  23 from resources.libraries.python.topology import NodeType
  24
  25
  26 class QemuUtils(object):
  27     """QEMU utilities."""
  28
  29     __QEMU_BIN = '/usr/bin/qemu-system-x86_64'
  30     # QEMU Machine Protocol socket
  31     __QMP_SOCK = '/tmp/qmp.sock'
  32     # QEMU Guest Agent socket
  33     __QGA_SOCK = '/tmp/qga.sock'
  34
  35     def __init__(self):
  36         self._qemu_opt = {}
  37         # Default 1 CPU.
  38         self._qemu_opt['smp'] = '-smp 1,sockets=1,cores=1,threads=1'
  39         # Daemonize the QEMU process after initialization. Default one
  40         # management interface.
  41         self._qemu_opt['options'] = '-cpu host -daemonize -enable-kvm ' \
  42             '-machine pc,accel=kvm,usb=off,mem-merge=off ' \
  43             '-net nic,macaddr=52:54:00:00:02:01 -balloon none'
  44         self._qemu_opt['ssh_fwd_port'] = 10022
  45         # Default serial console port
  46         self._qemu_opt['serial_port'] = 4556
  47         # Default 512MB virtual RAM
  48         self._qemu_opt['mem_size'] = 512
  49         # Default huge page mount point, required for Vhost-user interfaces.
  50         self._qemu_opt['huge_mnt'] = '/mnt/huge'
  51         # Default do not allocate huge pages.
  52         self._qemu_opt['huge_allocate'] = False
  53         # Default image for CSIT virl setup
  54         self._qemu_opt['disk_image'] = '/var/lib/vm/vhost-nested.img'
  55         # VM node info dict
  56         self._vm_info = {
  57             'type': NodeType.VM,
  58             'port': 10022,
  59             'username': 'cisco',
  60             'password': 'cisco',
  61             'interfaces': {},
  62         }
  63         # Virtio queue count
  64         self._qemu_opt['queues'] = 1
  65         self._vhost_id = 0
  66         self._ssh = None
  67         self._node = None
  68         self._socks = [self.__QMP_SOCK, self.__QGA_SOCK]
  69
  70     def qemu_set_smp(self, cpus, cores, threads, sockets):
  71         """Set SMP option for QEMU
  72
  73         :param cpus: Number of CPUs.
  74         :param cores: Number of CPU cores on one socket.
  75         :param threads: Number of threads on one CPU core.
  76         :param sockets: Number of discrete sockets in the system.
  77         :type cpus: int
  78         :type cores: int
  79         :type threads: int
  80         :type sockets: int
  81         """
  82         self._qemu_opt['smp'] = '-smp {},cores={},threads={},sockets={}'.format(
  83             cpus, cores, threads, sockets)
  84
  85     def qemu_set_ssh_fwd_port(self, fwd_port):
  86         """Set host port for guest SSH forwarding.
  87
  88         :param fwd_port: Port number on host for guest SSH forwarding.
  89         :type fwd_port: int
  90         """
  91         self._qemu_opt['ssh_fwd_port'] = fwd_port
  92         self._vm_info['port'] = fwd_port
  93
  94     def qemu_set_serial_port(self, port):
  95         """Set serial console port.
  96
  97         :param port: Serial console port.
  98         :type port: int
  99         """
 100         self._qemu_opt['serial_port'] = port
 101
 102     def qemu_set_mem_size(self, mem_size):
 103         """Set virtual RAM size.
 104
 105         :param mem_size: RAM size in Mega Bytes.
 106         :type mem_size: int
 107         """
 108         self._qemu_opt['mem_size'] = int(mem_size)
 109
 110     def qemu_set_huge_mnt(self, huge_mnt):
 111         """Set hugefile mount point.
 112
 113         :param huge_mnt: System hugefile mount point.
 114         :type huge_mnt: int
 115         """
 116         self._qemu_opt['huge_mnt'] = huge_mnt
 117
 118     def qemu_set_huge_allocate(self):
 119         """Set flag to allocate more huge pages if needed."""
 120         self._qemu_opt['huge_allocate'] = True
 121
 122     def qemu_set_disk_image(self, disk_image):
 123         """Set disk image.
 124
 125         :param disk_image: Path of the disk image.
 126         :type disk_image: str
 127         """
 128         self._qemu_opt['disk_image'] = disk_image
 129
 130     def qemu_set_affinity(self, *host_cpus):
 131         """Set qemu affinity by getting thread PIDs via QMP and taskset to list
 132         of CPU cores.
 133
 134         :param host_cpus: List of CPU cores.
 135         :type host_cpus: list
 136         """
 137         qemu_cpus = self._qemu_qmp_exec('query-cpus')['return']
 138
 139         if len(qemu_cpus) != len(host_cpus):
 140             logger.debug('Host CPU count {0}, Qemu Thread count {1}'.format(
 141                 len(host_cpus), len(qemu_cpus)))
 142             raise ValueError('Host CPU count must match Qemu Thread count')
 143
 144         for qemu_cpu, host_cpu in zip(qemu_cpus, host_cpus):
 145             cmd = 'taskset -pc {0} {1}'.format(host_cpu, qemu_cpu['thread_id'])
 146             (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
 147             if int(ret_code) != 0:
 148                 logger.debug('Set affinity failed {0}'.format(stderr))
 149                 raise RuntimeError('Set affinity failed on {0}'.format(
 150                     self._node['host']))
 151
 152     def qemu_set_scheduler_policy(self):
 153         """Set scheduler policy to SCHED_RR with priority 1 for all Qemu CPU
 154         processes.
 155
 156        :raises RuntimeError: Set scheduler policy failed.
 157         """
 158         qemu_cpus = self._qemu_qmp_exec('query-cpus')['return']
 159
 160         for qemu_cpu in qemu_cpus:
 161             cmd = 'chrt -r -p 1 {0}'.format(qemu_cpu['thread_id'])
 162             (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
 163             if int(ret_code) != 0:
 164                 logger.debug('Set SCHED_RR failed {0}'.format(stderr))
 165                 raise RuntimeError('Set SCHED_RR failed on {0}'.format(
 166                     self._node['host']))
 167
 168     def qemu_set_node(self, node):
 169         """Set node to run QEMU on.
 170
 171         :param node: Node to run QEMU on.
 172         :type node: dict
 173         """
 174         self._node = node
 175         self._ssh = SSH()
 176         self._ssh.connect(node)
 177         self._vm_info['host'] = node['host']
 178
 179     def qemu_add_vhost_user_if(self, socket, server=True, mac=None):
 180         """Add Vhost-user interface.
 181
 182         :param socket: Path of the unix socket.
 183         :param server: If True the socket shall be a listening socket.
 184         :param mac: Vhost-user interface MAC address (optional, otherwise is
 185             used autogenerated MAC 52:54:00:00:04:xx).
 186         :type socket: str
 187         :type server: bool
 188         :type mac: str
 189         """
 190         self._vhost_id += 1
 191         # Create unix socket character device.
 192         chardev = ' -chardev socket,id=char{0},path={1}'.format(self._vhost_id,
 193                                                                 socket)
 194         if server is True:
 195             chardev += ',server'
 196         self._qemu_opt['options'] += chardev
 197         # Create Vhost-user network backend.
 198         netdev = ' -netdev vhost-user,id=vhost{0},chardev=char{0},'\
 199             'queues={1}'.format(self._vhost_id, self._qemu_opt['queues'])
 200         self._qemu_opt['options'] += netdev
 201         # If MAC is not specified use autogenerated 52:54:00:00:04:<vhost_id>
 202         # e.g. vhost1 MAC is 52:54:00:00:04:01
 203         if mac is None:
 204             mac = '52:54:00:00:04:{0:02x}'.format(self._vhost_id)
 205         extend_options = 'mq=on,csum=off,gso=off,guest_tso4=off,'\
 206             'guest_tso6=off,guest_ecn=off,mrg_rxbuf=off'
 207         # Create Virtio network device.
 208         device = ' -device virtio-net-pci,netdev=vhost{0},mac={1},{2}'.format(
 209             self._vhost_id, mac, extend_options)
 210         self._qemu_opt['options'] += device
 211         # Add interface MAC and socket to the node dict
 212         if_data = {'mac_address': mac, 'socket': socket}
 213         if_name = 'vhost{}'.format(self._vhost_id)
 214         self._vm_info['interfaces'][if_name] = if_data
 215         # Add socket to the socket list
 216         self._socks.append(socket)
 217
 218     def _qemu_qmp_exec(self, cmd):
 219         """Execute QMP command.
 220
 221         QMP is JSON based protocol which allows to control QEMU instance.
 222
 223         :param cmd: QMP command to execute.
 224         :type cmd: str
 225         :return: Command output in python representation of JSON format. The
 226             { "return": {} } response is QMP's success response. An error
 227             response will contain the "error" keyword instead of "return".
 228         """
 229         # To enter command mode, the qmp_capabilities command must be issued.
 230         qmp_cmd = 'echo "{ \\"execute\\": \\"qmp_capabilities\\" }' + \
 231             '{ \\"execute\\": \\"' + cmd + '\\" }" | sudo -S nc -U ' + \
 232             self.__QMP_SOCK
 233         (ret_code, stdout, stderr) = self._ssh.exec_command(qmp_cmd)
 234         if int(ret_code) != 0:
 235             logger.debug('QMP execute failed {0}'.format(stderr))
 236             raise RuntimeError('QMP execute "{0}"'
 237                                ' failed on {1}'.format(cmd, self._node['host']))
 238         logger.trace(stdout)
 239         # Skip capabilities negotiation messages.
 240         out_list = stdout.splitlines()
 241         if len(out_list) < 3:
 242             raise RuntimeError('Invalid QMP output on {0}'.format(
 243                 self._node['host']))
 244         return json.loads(out_list[2])
 245
 246     def _qemu_qga_flush(self):
 247         """Flush the QGA parser state
 248         """
 249         qga_cmd = 'printf "\xFF" | sudo -S nc ' \
 250             '-q 1 -U ' + self.__QGA_SOCK
 251         (ret_code, stdout, stderr) = self._ssh.exec_command(qga_cmd)
 252         if int(ret_code) != 0:
 253             logger.debug('QGA execute failed {0}'.format(stderr))
 254             raise RuntimeError('QGA execute "{0}" '
 255                                'failed on {1}'.format(qga_cmd,
 256                                                       self._node['host']))
 257         logger.trace(stdout)
 258         if not stdout:
 259             return {}
 260         return json.loads(stdout.split('\n', 1)[0])
 261
 262     def _qemu_qga_exec(self, cmd):
 263         """Execute QGA command.
 264
 265         QGA provide access to a system-level agent via standard QMP commands.
 266
 267         :param cmd: QGA command to execute.
 268         :type cmd: str
 269         """
 270         qga_cmd = 'echo "{ \\"execute\\": \\"' + cmd + '\\" }" | sudo -S nc ' \
 271             '-q 1 -U ' + self.__QGA_SOCK
 272         (ret_code, stdout, stderr) = self._ssh.exec_command(qga_cmd)
 273         if int(ret_code) != 0:
 274             logger.debug('QGA execute failed {0}'.format(stderr))
 275             raise RuntimeError('QGA execute "{0}"'
 276                                ' failed on {1}'.format(cmd, self._node['host']))
 277         logger.trace(stdout)
 278         if not stdout:
 279             return {}
 280         return json.loads(stdout.split('\n', 1)[0])
 281
 282     def _wait_until_vm_boot(self, timeout=60):
 283         """Wait until QEMU VM is booted.
 284
 285         Ping QEMU guest agent each 5s until VM booted or timeout.
 286
 287         :param timeout: Waiting timeout in seconds (optional, default 60s).
 288         :type timeout: int
 289         """
 290         start = time()
 291         while True:
 292             if time() - start > timeout:
 293                 raise RuntimeError('timeout, VM {0} not booted on {1}'.format(
 294                     self._qemu_opt['disk_image'], self._node['host']))
 295             try:
 296                 self._qemu_qga_flush()
 297                 out = self._qemu_qga_exec('guest-ping')
 298             except ValueError:
 299                 logger.trace('QGA guest-ping unexpected output {}'.format(out))
 300             # Empty output - VM not booted yet
 301             if not out:
 302                 sleep(5)
 303             # Non-error return - VM booted
 304             elif out.get('return') is not None:
 305                 break
 306             # Skip error and wait
 307             elif out.get('error') is not None:
 308                 sleep(5)
 309             else:
 310                 # If there is an unexpected output from QGA guest-info, try
 311                 # again until timeout.
 312                 logger.trace('QGA guest-ping unexpected output {}'.format(out))
 313
 314         logger.trace('VM {0} booted on {1}'.format(self._qemu_opt['disk_image'],
 315                                                    self._node['host']))
 316
 317     def _update_vm_interfaces(self):
 318         """Update interface names in VM node dict."""
 319         # Send guest-network-get-interfaces command via QGA, output example:
 320         # {"return": [{"name": "eth0", "hardware-address": "52:54:00:00:04:01"},
 321         # {"name": "eth1", "hardware-address": "52:54:00:00:04:02"}]}
 322         out = self._qemu_qga_exec('guest-network-get-interfaces')
 323         interfaces = out.get('return')
 324         mac_name = {}
 325         if not interfaces:
 326             raise RuntimeError('Get VM {0} interface list failed on {1}'.format(
 327                 self._qemu_opt['disk_image'], self._node['host']))
 328         # Create MAC-name dict
 329         for interface in interfaces:
 330             if 'hardware-address' not in interface:
 331                 continue
 332             mac_name[interface['hardware-address']] = interface['name']
 333         # Match interface by MAC and save interface name
 334         for interface in self._vm_info['interfaces'].values():
 335             mac = interface.get('mac_address')
 336             if_name = mac_name.get(mac)
 337             if if_name is None:
 338                 logger.trace('Interface name for MAC {} not found'.format(mac))
 339             else:
 340                 interface['name'] = if_name
 341
 342     def _huge_page_check(self, allocate=False):
 343         """Huge page check."""
 344         huge_mnt = self._qemu_opt.get('huge_mnt')
 345         mem_size = self._qemu_opt.get('mem_size')
 346
 347         # Get huge pages information
 348         huge_size = self._get_huge_page_size()
 349         huge_free = self._get_huge_page_free(huge_size)
 350         huge_total = self._get_huge_page_total(huge_size)
 351
 352         # Check if memory reqested by qemu is available on host
 353         if (mem_size * 1024) > (huge_free * huge_size):
 354             # If we want to allocate hugepage dynamically
 355             if allocate:
 356                 mem_needed = abs((huge_free * huge_size) - (mem_size * 1024))
 357                 huge_to_allocate = ((mem_needed / huge_size) * 2) + huge_total
 358                 max_map_count = huge_to_allocate*4
 359                 # Increase maximum number of memory map areas a process may have
 360                 cmd = 'echo "{0}" | sudo tee /proc/sys/vm/max_map_count'.format(
 361                     max_map_count)
 362                 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
 363                 # Increase hugepage count
 364                 cmd = 'echo "{0}" | sudo tee /proc/sys/vm/nr_hugepages'.format(
 365                     huge_to_allocate)
 366                 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
 367                 if int(ret_code) != 0:
 368                     logger.debug('Mount huge pages failed {0}'.format(stderr))
 369                     raise RuntimeError('Mount huge pages failed on {0}'.format(
 370                         self._node['host']))
 371             # If we do not want to allocate dynamicaly end with error
 372             else:
 373                 raise RuntimeError(
 374                     'Not enough free huge pages: {0}, '
 375                     '{1} MB'.format(huge_free, huge_free * huge_size)
 376                 )
 377         # Check if huge pages mount point exist
 378         has_huge_mnt = False
 379         (_, output, _) = self._ssh.exec_command('cat /proc/mounts')
 380         for line in output.splitlines():
 381             # Try to find something like:
 382             # none /mnt/huge hugetlbfs rw,relatime,pagesize=2048k 0 0
 383             mount = line.split()
 384             if mount[2] == 'hugetlbfs' and mount[1] == huge_mnt:
 385                 has_huge_mnt = True
 386                 break
 387         # If huge page mount point not exist create one
 388         if not has_huge_mnt:
 389             cmd = 'mkdir -p {0}'.format(huge_mnt)
 390             (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
 391             if int(ret_code) != 0:
 392                 logger.debug('Create mount dir failed: {0}'.format(stderr))
 393                 raise RuntimeError('Create mount dir failed on {0}'.format(
 394                     self._node['host']))
 395             cmd = 'mount -t hugetlbfs -o pagesize=2048k none {0}'.format(
 396                 huge_mnt)
 397             (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
 398             if int(ret_code) != 0:
 399                 logger.debug('Mount huge pages failed {0}'.format(stderr))
 400                 raise RuntimeError('Mount huge pages failed on {0}'.format(
 401                     self._node['host']))
 402
 403     def _get_huge_page_size(self):
 404         """Get default size of huge pages in system.
 405
 406         :returns: Default size of free huge pages in system.
 407         :rtype: int
 408         :raises: RuntimeError if reading failed for three times.
 409         """
 410         # TODO: remove to dedicated library
 411         cmd_huge_size = "grep Hugepagesize /proc/meminfo | awk '{ print $2 }'"
 412         for _ in range(3):
 413             (ret, out, _) = self._ssh.exec_command_sudo(cmd_huge_size)
 414             if ret == 0:
 415                 try:
 416                     huge_size = int(out)
 417                 except ValueError:
 418                     logger.trace('Reading huge page size information failed')
 419                 else:
 420                     break
 421         else:
 422             raise RuntimeError('Getting huge page size information failed.')
 423         return huge_size
 424
 425     def _get_huge_page_free(self, huge_size):
 426         """Get total number of huge pages in system.
 427
 428         :param huge_size: Size of hugepages.
 429         :type huge_size: int
 430         :returns: Number of free huge pages in system.
 431         :rtype: int
 432         :raises: RuntimeError if reading failed for three times.
 433         """
 434         # TODO: add numa aware option
 435         # TODO: remove to dedicated library
 436         cmd_huge_free = 'cat /sys/kernel/mm/hugepages/hugepages-{0}kB/'\
 437             'free_hugepages'.format(huge_size)
 438         for _ in range(3):
 439             (ret, out, _) = self._ssh.exec_command_sudo(cmd_huge_free)
 440             if ret == 0:
 441                 try:
 442                     huge_free = int(out)
 443                 except ValueError:
 444                     logger.trace('Reading free huge pages information failed')
 445                 else:
 446                     break
 447         else:
 448             raise RuntimeError('Getting free huge pages information failed.')
 449         return huge_free
 450
 451     def _get_huge_page_total(self, huge_size):
 452         """Get total number of huge pages in system.
 453
 454         :param huge_size: Size of hugepages.
 455         :type huge_size: int
 456         :returns: Total number of huge pages in system.
 457         :rtype: int
 458         :raises: RuntimeError if reading failed for three times.
 459         """
 460         # TODO: add numa aware option
 461         # TODO: remove to dedicated library
 462         cmd_huge_total = 'cat /sys/kernel/mm/hugepages/hugepages-{0}kB/'\
 463             'nr_hugepages'.format(huge_size)
 464         for _ in range(3):
 465             (ret, out, _) = self._ssh.exec_command_sudo(cmd_huge_total)
 466             if ret == 0:
 467                 try:
 468                     huge_total = int(out)
 469                 except ValueError:
 470                     logger.trace('Reading total huge pages information failed')
 471                 else:
 472                     break
 473         else:
 474             raise RuntimeError('Getting total huge pages information failed.')
 475         return huge_total
 476
 477     def qemu_start(self):
 478         """Start QEMU and wait until VM boot.
 479
 480         :return: VM node info.
 481         :rtype: dict
 482         .. note:: First set at least node to run QEMU on.
 483         .. warning:: Starts only one VM on the node.
 484         """
 485         # SSH forwarding
 486         ssh_fwd = '-net user,hostfwd=tcp::{0}-:22'.format(
 487             self._qemu_opt.get('ssh_fwd_port'))
 488         # Memory and huge pages
 489         mem = '-object memory-backend-file,id=mem,size={0}M,mem-path={1},' \
 490             'share=on -m {0} -numa node,memdev=mem'.format(
 491                 self._qemu_opt.get('mem_size'), self._qemu_opt.get('huge_mnt'))
 492
 493         # By default check only if hugepages are availbale.
 494         # If 'huge_allocate' is set to true try to allocate as well.
 495         self._huge_page_check(allocate=self._qemu_opt.get('huge_allocate'))
 496
 497         # Setup QMP via unix socket
 498         qmp = '-qmp unix:{0},server,nowait'.format(self.__QMP_SOCK)
 499         # Setup serial console
 500         serial = '-chardev socket,host=127.0.0.1,port={0},id=gnc0,server,' \
 501             'nowait -device isa-serial,chardev=gnc0'.format(
 502                 self._qemu_opt.get('serial_port'))
 503         # Setup QGA via chardev (unix socket) and isa-serial channel
 504         qga = '-chardev socket,path=/tmp/qga.sock,server,nowait,id=qga0 ' \
 505             '-device isa-serial,chardev=qga0'
 506         # Graphic setup
 507         graphic = '-monitor none -display none -vga none'
 508         # Run QEMU
 509         cmd = '{0} {1} {2} {3} {4} -hda {5} {6} {7} {8} {9}'.format(
 510             self.__QEMU_BIN, self._qemu_opt.get('smp'), mem, ssh_fwd,
 511             self._qemu_opt.get('options'),
 512             self._qemu_opt.get('disk_image'), qmp, serial, qga, graphic)
 513         (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd, timeout=300)
 514         if int(ret_code) != 0:
 515             logger.debug('QEMU start failed {0}'.format(stderr))
 516             raise RuntimeError('QEMU start failed on {0}'.format(
 517                 self._node['host']))
 518         logger.trace('QEMU running')
 519         # Wait until VM boot
 520         try:
 521             self._wait_until_vm_boot()
 522         except RuntimeError:
 523             self.qemu_kill()
 524             self.qemu_clear_socks()
 525             raise
 526         # Update interface names in VM node dict
 527         self._update_vm_interfaces()
 528         # Return VM node dict
 529         return self._vm_info
 530
 531     def qemu_quit(self):
 532         """Quit the QEMU emulator."""
 533         out = self._qemu_qmp_exec('quit')
 534         err = out.get('error')
 535         if err is not None:
 536             raise RuntimeError('QEMU quit failed on {0}, error: {1}'.format(
 537                 self._node['host'], json.dumps(err)))
 538
 539     def qemu_system_powerdown(self):
 540         """Power down the system (if supported)."""
 541         out = self._qemu_qmp_exec('system_powerdown')
 542         err = out.get('error')
 543         if err is not None:
 544             raise RuntimeError(
 545                 'QEMU system powerdown failed on {0}, '
 546                 'error: {1}'.format(self._node['host'], json.dumps(err))
 547             )
 548
 549     def qemu_system_reset(self):
 550         """Reset the system."""
 551         out = self._qemu_qmp_exec('system_reset')
 552         err = out.get('error')
 553         if err is not None:
 554             raise RuntimeError(
 555                 'QEMU system reset failed on {0}, '
 556                 'error: {1}'.format(self._node['host'], json.dumps(err)))
 557
 558     def qemu_kill(self):
 559         """Kill qemu process."""
 560         # TODO: add PID storage so that we can kill specific PID
 561         # Note: in QEMU start phase there are 3 QEMU processes because we
 562         # daemonize QEMU
 563         self._ssh.exec_command_sudo('pkill -SIGKILL qemu')
 564
 565     def qemu_clear_socks(self):
 566         """Remove all sockets created by QEMU."""
 567         # If serial console port still open kill process
 568         cmd = 'fuser -k {}/tcp'.format(self._qemu_opt.get('serial_port'))
 569         self._ssh.exec_command_sudo(cmd)
 570         # Delete all created sockets
 571         for sock in self._socks:
 572             cmd = 'rm -f {}'.format(sock)
 573             self._ssh.exec_command_sudo(cmd)
 574
 575     def qemu_system_status(self):
 576         """Return current VM status.
 577
 578         VM should be in following status:
 579
 580             - debug: QEMU running on a debugger
 581             - finish-migrate: paused to finish the migration process
 582             - inmigrate: waiting for an incoming migration
 583             - internal-error: internal error has occurred
 584             - io-error: the last IOP has failed
 585             - paused: paused
 586             - postmigrate: paused following a successful migrate
 587             - prelaunch: QEMU was started with -S and guest has not started
 588             - restore-vm: paused to restore VM state
 589             - running: actively running
 590             - save-vm: paused to save the VM state
 591             - shutdown: shut down (and -no-shutdown is in use)
 592             - suspended: suspended (ACPI S3)
 593             - watchdog: watchdog action has been triggered
 594             - guest-panicked: panicked as a result of guest OS panic
 595
 596         :return: VM status.
 597         :rtype: str
 598         """
 599         out = self._qemu_qmp_exec('query-status')
 600         ret = out.get('return')
 601         if ret is not None:
 602             return ret.get('status')
 603         else:
 604             err = out.get('error')
 605             raise RuntimeError(
 606                 'QEMU query-status failed on {0}, '
 607                 'error: {1}'.format(self._node['host'], json.dumps(err)))
 608
 609     @staticmethod
 610     def build_qemu(node):
 611         """Build QEMU from sources.
 612
 613         :param node: Node to build QEMU on.
 614         :type node: dict
 615         """
 616         ssh = SSH()
 617         ssh.connect(node)
 618
 619         (ret_code, stdout, stderr) = \
 620             ssh.exec_command('sudo -Sn bash {0}/{1}/qemu_build.sh'.format(
 621                 Constants.REMOTE_FW_DIR, Constants.RESOURCES_LIB_SH), 1000)
 622         logger.trace(stdout)
 623         if int(ret_code) != 0:
 624             logger.debug('QEMU build failed {0}'.format(stderr))
 625             raise RuntimeError('QEMU build failed on {0}'.format(node['host']))