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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """QEMU utilities library."""
16 from time import time, sleep
19 from robot.api import logger
21 from resources.libraries.python.ssh import SSH, SSHTimeout
22 from resources.libraries.python.constants import Constants
23 from resources.libraries.python.topology import NodeType
26 class QemuUtils(object):
29 def __init__(self, qemu_id=1):
30 self._qemu_id = qemu_id
32 self._qemu_bin = '/usr/bin/qemu-system-x86_64'
33 # QEMU Machine Protocol socket
34 self._qmp_sock = '/tmp/qmp{0}.sock'.format(self._qemu_id)
35 # QEMU Guest Agent socket
36 self._qga_sock = '/tmp/qga{0}.sock'.format(self._qemu_id)
38 self._pid_file = '/tmp/qemu{0}.pid'.format(self._qemu_id)
41 self._qemu_opt['smp'] = '-smp 1,sockets=1,cores=1,threads=1'
42 # Daemonize the QEMU process after initialization. Default one
43 # management interface.
44 self._qemu_opt['options'] = '-cpu host -daemonize -enable-kvm ' \
45 '-machine pc,accel=kvm,usb=off,mem-merge=off ' \
46 '-net nic,macaddr=52:54:00:00:{0:02x}:ff -balloon none'\
47 .format(self._qemu_id)
48 self._qemu_opt['ssh_fwd_port'] = 10021 + qemu_id
49 # Default serial console port
50 self._qemu_opt['serial_port'] = 4555 + qemu_id
51 # Default 512MB virtual RAM
52 self._qemu_opt['mem_size'] = 512
53 # Default huge page mount point, required for Vhost-user interfaces.
54 self._qemu_opt['huge_mnt'] = '/mnt/huge'
55 # Default do not allocate huge pages.
56 self._qemu_opt['huge_allocate'] = False
57 # Default image for CSIT virl setup
58 self._qemu_opt['disk_image'] = '/var/lib/vm/vhost-nested.img'
62 'port': self._qemu_opt['ssh_fwd_port'],
68 self._qemu_opt['queues'] = 1
72 self._socks = [self._qmp_sock, self._qga_sock]
74 def qemu_set_bin(self, path):
75 """Set binary path for QEMU.
77 :param path: Absolute path in filesystem.
82 def qemu_set_smp(self, cpus, cores, threads, sockets):
83 """Set SMP option for QEMU.
85 :param cpus: Number of CPUs.
86 :param cores: Number of CPU cores on one socket.
87 :param threads: Number of threads on one CPU core.
88 :param sockets: Number of discrete sockets in the system.
94 self._qemu_opt['smp'] = '-smp {},cores={},threads={},sockets={}'.format(
95 cpus, cores, threads, sockets)
97 def qemu_set_ssh_fwd_port(self, fwd_port):
98 """Set host port for guest SSH forwarding.
100 :param fwd_port: Port number on host for guest SSH forwarding.
103 self._qemu_opt['ssh_fwd_port'] = fwd_port
104 self._vm_info['port'] = fwd_port
106 def qemu_set_serial_port(self, port):
107 """Set serial console port.
109 :param port: Serial console port.
112 self._qemu_opt['serial_port'] = port
114 def qemu_set_mem_size(self, mem_size):
115 """Set virtual RAM size.
117 :param mem_size: RAM size in Mega Bytes.
120 self._qemu_opt['mem_size'] = int(mem_size)
122 def qemu_set_huge_mnt(self, huge_mnt):
123 """Set hugefile mount point.
125 :param huge_mnt: System hugefile mount point.
128 self._qemu_opt['huge_mnt'] = huge_mnt
130 def qemu_set_huge_allocate(self):
131 """Set flag to allocate more huge pages if needed."""
132 self._qemu_opt['huge_allocate'] = True
134 def qemu_set_disk_image(self, disk_image):
137 :param disk_image: Path of the disk image.
138 :type disk_image: str
140 self._qemu_opt['disk_image'] = disk_image
142 def qemu_set_affinity(self, *host_cpus):
143 """Set qemu affinity by getting thread PIDs via QMP and taskset to list
146 :param host_cpus: List of CPU cores.
147 :type host_cpus: list
149 qemu_cpus = self._qemu_qmp_exec('query-cpus')['return']
151 if len(qemu_cpus) != len(host_cpus):
152 logger.debug('Host CPU count {0}, Qemu Thread count {1}'.format(
153 len(host_cpus), len(qemu_cpus)))
154 raise ValueError('Host CPU count must match Qemu Thread count')
156 for qemu_cpu, host_cpu in zip(qemu_cpus, host_cpus):
157 cmd = 'taskset -pc {0} {1}'.format(host_cpu, qemu_cpu['thread_id'])
158 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
159 if int(ret_code) != 0:
160 logger.debug('Set affinity failed {0}'.format(stderr))
161 raise RuntimeError('Set affinity failed on {0}'.format(
164 def qemu_set_scheduler_policy(self):
165 """Set scheduler policy to SCHED_RR with priority 1 for all Qemu CPU
168 :raises RuntimeError: Set scheduler policy failed.
170 qemu_cpus = self._qemu_qmp_exec('query-cpus')['return']
172 for qemu_cpu in qemu_cpus:
173 cmd = 'chrt -r -p 1 {0}'.format(qemu_cpu['thread_id'])
174 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
175 if int(ret_code) != 0:
176 logger.debug('Set SCHED_RR failed {0}'.format(stderr))
177 raise RuntimeError('Set SCHED_RR failed on {0}'.format(
180 def qemu_set_node(self, node):
181 """Set node to run QEMU on.
183 :param node: Node to run QEMU on.
188 self._ssh.connect(node)
189 self._vm_info['host'] = node['host']
191 def qemu_add_vhost_user_if(self, socket, server=True, mac=None):
192 """Add Vhost-user interface.
194 :param socket: Path of the unix socket.
195 :param server: If True the socket shall be a listening socket.
196 :param mac: Vhost-user interface MAC address (optional, otherwise is
197 used auto-generated MAC 52:54:00:00:xx:yy).
203 # Create unix socket character device.
204 chardev = ' -chardev socket,id=char{0},path={1}'.format(self._vhost_id,
208 self._qemu_opt['options'] += chardev
209 # Create Vhost-user network backend.
210 netdev = (' -netdev vhost-user,id=vhost{0},chardev=char{0},queues={1}'
211 .format(self._vhost_id, self._qemu_opt['queues']))
212 self._qemu_opt['options'] += netdev
213 # If MAC is not specified use auto-generated MAC address based on
214 # template 52:54:00:00:<qemu_id>:<vhost_id>, e.g. vhost1 MAC of QEMU
215 # with ID 1 is 52:54:00:00:01:01
217 mac = '52:54:00:00:{0:02x}:{1:02x}'.\
218 format(self._qemu_id, self._vhost_id)
219 extend_options = 'mq=on,csum=off,gso=off,guest_tso4=off,'\
220 'guest_tso6=off,guest_ecn=off,mrg_rxbuf=off'
221 # Create Virtio network device.
222 device = ' -device virtio-net-pci,netdev=vhost{0},mac={1},{2}'.format(
223 self._vhost_id, mac, extend_options)
224 self._qemu_opt['options'] += device
225 # Add interface MAC and socket to the node dict
226 if_data = {'mac_address': mac, 'socket': socket}
227 if_name = 'vhost{}'.format(self._vhost_id)
228 self._vm_info['interfaces'][if_name] = if_data
229 # Add socket to the socket list
230 self._socks.append(socket)
232 def _qemu_qmp_exec(self, cmd):
233 """Execute QMP command.
235 QMP is JSON based protocol which allows to control QEMU instance.
237 :param cmd: QMP command to execute.
239 :return: Command output in python representation of JSON format. The
240 { "return": {} } response is QMP's success response. An error
241 response will contain the "error" keyword instead of "return".
243 # To enter command mode, the qmp_capabilities command must be issued.
244 qmp_cmd = 'echo "{ \\"execute\\": \\"qmp_capabilities\\" }' \
245 '{ \\"execute\\": \\"' + cmd + \
246 '\\" }" | sudo -S socat - UNIX-CONNECT:' + self._qmp_sock
248 (ret_code, stdout, stderr) = self._ssh.exec_command(qmp_cmd)
249 if int(ret_code) != 0:
250 logger.debug('QMP execute failed {0}'.format(stderr))
251 raise RuntimeError('QMP execute "{0}"'
252 ' failed on {1}'.format(cmd, self._node['host']))
254 # Skip capabilities negotiation messages.
255 out_list = stdout.splitlines()
256 if len(out_list) < 3:
257 raise RuntimeError('Invalid QMP output on {0}'.format(
259 return json.loads(out_list[2])
261 def _qemu_qga_flush(self):
262 """Flush the QGA parser state
264 qga_cmd = '(printf "\xFF"; sleep 1) | sudo -S socat - UNIX-CONNECT:' + \
266 #TODO: probably need something else
267 (ret_code, stdout, stderr) = self._ssh.exec_command(qga_cmd)
268 if int(ret_code) != 0:
269 logger.debug('QGA execute failed {0}'.format(stderr))
270 raise RuntimeError('QGA execute "{0}" '
271 'failed on {1}'.format(qga_cmd,
276 return json.loads(stdout.split('\n', 1)[0])
278 def _qemu_qga_exec(self, cmd):
279 """Execute QGA command.
281 QGA provide access to a system-level agent via standard QMP commands.
283 :param cmd: QGA command to execute.
286 qga_cmd = '(echo "{ \\"execute\\": \\"' + \
288 '\\" }"; sleep 1) | sudo -S socat - UNIX-CONNECT:' + \
290 (ret_code, stdout, stderr) = self._ssh.exec_command(qga_cmd)
291 if int(ret_code) != 0:
292 logger.debug('QGA execute failed {0}'.format(stderr))
293 raise RuntimeError('QGA execute "{0}"'
294 ' failed on {1}'.format(cmd, self._node['host']))
298 return json.loads(stdout.split('\n', 1)[0])
300 def _wait_until_vm_boot(self, timeout=60):
301 """Wait until QEMU VM is booted.
303 First try to flush qga until there is output.
304 Then ping QEMU guest agent each 5s until VM booted or timeout.
306 :param timeout: Waiting timeout in seconds (optional, default 60s).
311 if time() - start > timeout:
312 raise RuntimeError('timeout, VM {0} not booted on {1}'.format(
313 self._qemu_opt['disk_image'], self._node['host']))
316 out = self._qemu_qga_flush()
318 logger.trace('QGA qga flush unexpected output {}'.format(out))
319 # Empty output - VM not booted yet
325 if time() - start > timeout:
326 raise RuntimeError('timeout, VM {0} not booted on {1}'.format(
327 self._qemu_opt['disk_image'], self._node['host']))
330 out = self._qemu_qga_exec('guest-ping')
332 logger.trace('QGA guest-ping unexpected output {}'.format(out))
333 # Empty output - VM not booted yet
336 # Non-error return - VM booted
337 elif out.get('return') is not None:
339 # Skip error and wait
340 elif out.get('error') is not None:
343 # If there is an unexpected output from QGA guest-info, try
344 # again until timeout.
345 logger.trace('QGA guest-ping unexpected output {}'.format(out))
347 logger.trace('VM {0} booted on {1}'.format(self._qemu_opt['disk_image'],
350 def _update_vm_interfaces(self):
351 """Update interface names in VM node dict."""
352 # Send guest-network-get-interfaces command via QGA, output example:
353 # {"return": [{"name": "eth0", "hardware-address": "52:54:00:00:04:01"},
354 # {"name": "eth1", "hardware-address": "52:54:00:00:04:02"}]}
355 out = self._qemu_qga_exec('guest-network-get-interfaces')
356 interfaces = out.get('return')
359 raise RuntimeError('Get VM {0} interface list failed on {1}'.format(
360 self._qemu_opt['disk_image'], self._node['host']))
361 # Create MAC-name dict
362 for interface in interfaces:
363 if 'hardware-address' not in interface:
365 mac_name[interface['hardware-address']] = interface['name']
366 # Match interface by MAC and save interface name
367 for interface in self._vm_info['interfaces'].values():
368 mac = interface.get('mac_address')
369 if_name = mac_name.get(mac)
371 logger.trace('Interface name for MAC {} not found'.format(mac))
373 interface['name'] = if_name
375 def _huge_page_check(self, allocate=False):
376 """Huge page check."""
377 huge_mnt = self._qemu_opt.get('huge_mnt')
378 mem_size = self._qemu_opt.get('mem_size')
380 # Get huge pages information
381 huge_size = self._get_huge_page_size()
382 huge_free = self._get_huge_page_free(huge_size)
383 huge_total = self._get_huge_page_total(huge_size)
385 # Check if memory reqested by qemu is available on host
386 if (mem_size * 1024) > (huge_free * huge_size):
387 # If we want to allocate hugepage dynamically
389 mem_needed = abs((huge_free * huge_size) - (mem_size * 1024))
390 huge_to_allocate = ((mem_needed / huge_size) * 2) + huge_total
391 max_map_count = huge_to_allocate*4
392 # Increase maximum number of memory map areas a process may have
393 cmd = 'echo "{0}" | sudo tee /proc/sys/vm/max_map_count'.format(
395 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
396 # Increase hugepage count
397 cmd = 'echo "{0}" | sudo tee /proc/sys/vm/nr_hugepages'.format(
399 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
400 if int(ret_code) != 0:
401 logger.debug('Mount huge pages failed {0}'.format(stderr))
402 raise RuntimeError('Mount huge pages failed on {0}'.format(
404 # If we do not want to allocate dynamicaly end with error
407 'Not enough free huge pages: {0}, '
408 '{1} MB'.format(huge_free, huge_free * huge_size)
410 # Check if huge pages mount point exist
412 (_, output, _) = self._ssh.exec_command('cat /proc/mounts')
413 for line in output.splitlines():
414 # Try to find something like:
415 # none /mnt/huge hugetlbfs rw,relatime,pagesize=2048k 0 0
417 if mount[2] == 'hugetlbfs' and mount[1] == huge_mnt:
420 # If huge page mount point not exist create one
422 cmd = 'mkdir -p {0}'.format(huge_mnt)
423 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
424 if int(ret_code) != 0:
425 logger.debug('Create mount dir failed: {0}'.format(stderr))
426 raise RuntimeError('Create mount dir failed on {0}'.format(
428 cmd = 'mount -t hugetlbfs -o pagesize=2048k none {0}'.format(
430 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd)
431 if int(ret_code) != 0:
432 logger.debug('Mount huge pages failed {0}'.format(stderr))
433 raise RuntimeError('Mount huge pages failed on {0}'.format(
436 def _get_huge_page_size(self):
437 """Get default size of huge pages in system.
439 :returns: Default size of free huge pages in system.
441 :raises: RuntimeError if reading failed for three times.
443 # TODO: remove to dedicated library
444 cmd_huge_size = "grep Hugepagesize /proc/meminfo | awk '{ print $2 }'"
446 (ret, out, _) = self._ssh.exec_command_sudo(cmd_huge_size)
451 logger.trace('Reading huge page size information failed')
455 raise RuntimeError('Getting huge page size information failed.')
458 def _get_huge_page_free(self, huge_size):
459 """Get total number of huge pages in system.
461 :param huge_size: Size of hugepages.
463 :returns: Number of free huge pages in system.
465 :raises: RuntimeError if reading failed for three times.
467 # TODO: add numa aware option
468 # TODO: remove to dedicated library
469 cmd_huge_free = 'cat /sys/kernel/mm/hugepages/hugepages-{0}kB/'\
470 'free_hugepages'.format(huge_size)
472 (ret, out, _) = self._ssh.exec_command_sudo(cmd_huge_free)
477 logger.trace('Reading free huge pages information failed')
481 raise RuntimeError('Getting free huge pages information failed.')
484 def _get_huge_page_total(self, huge_size):
485 """Get total number of huge pages in system.
487 :param huge_size: Size of hugepages.
489 :returns: Total number of huge pages in system.
491 :raises: RuntimeError if reading failed for three times.
493 # TODO: add numa aware option
494 # TODO: remove to dedicated library
495 cmd_huge_total = 'cat /sys/kernel/mm/hugepages/hugepages-{0}kB/'\
496 'nr_hugepages'.format(huge_size)
498 (ret, out, _) = self._ssh.exec_command_sudo(cmd_huge_total)
501 huge_total = int(out)
503 logger.trace('Reading total huge pages information failed')
507 raise RuntimeError('Getting total huge pages information failed.')
510 def qemu_start(self):
511 """Start QEMU and wait until VM boot.
513 :return: VM node info.
515 .. note:: First set at least node to run QEMU on.
516 .. warning:: Starts only one VM on the node.
519 ssh_fwd = '-net user,hostfwd=tcp::{0}-:22'.format(
520 self._qemu_opt.get('ssh_fwd_port'))
521 # Memory and huge pages
522 mem = '-object memory-backend-file,id=mem,size={0}M,mem-path={1},' \
523 'share=on -m {0} -numa node,memdev=mem'.format(
524 self._qemu_opt.get('mem_size'), self._qemu_opt.get('huge_mnt'))
526 # By default check only if hugepages are available.
527 # If 'huge_allocate' is set to true try to allocate as well.
528 self._huge_page_check(allocate=self._qemu_opt.get('huge_allocate'))
531 drive = '-drive file={0},format=raw,cache=none,if=virtio'.format(
532 self._qemu_opt.get('disk_image'))
533 # Setup QMP via unix socket
534 qmp = '-qmp unix:{0},server,nowait'.format(self._qmp_sock)
535 # Setup serial console
536 serial = '-chardev socket,host=127.0.0.1,port={0},id=gnc0,server,' \
537 'nowait -device isa-serial,chardev=gnc0'.format(
538 self._qemu_opt.get('serial_port'))
539 # Setup QGA via chardev (unix socket) and isa-serial channel
540 qga = '-chardev socket,path={0},server,nowait,id=qga0 ' \
541 '-device isa-serial,chardev=qga0'.format(self._qga_sock)
543 graphic = '-monitor none -display none -vga none'
545 pid = '-pidfile {}'.format(self._pid_file)
548 cmd = '{0} {1} {2} {3} {4} {5} {6} {7} {8} {9} {10}'.format(
549 self._qemu_bin, self._qemu_opt.get('smp'), mem, ssh_fwd,
550 self._qemu_opt.get('options'),
551 drive, qmp, serial, qga, graphic, pid)
552 (ret_code, _, stderr) = self._ssh.exec_command_sudo(cmd, timeout=300)
553 if int(ret_code) != 0:
554 logger.debug('QEMU start failed {0}'.format(stderr))
555 raise RuntimeError('QEMU start failed on {0}'.format(
557 logger.trace('QEMU running')
560 self._wait_until_vm_boot()
561 except (RuntimeError, SSHTimeout):
563 self.qemu_clear_socks()
565 # Update interface names in VM node dict
566 self._update_vm_interfaces()
567 # Return VM node dict
571 """Quit the QEMU emulator."""
572 out = self._qemu_qmp_exec('quit')
573 err = out.get('error')
575 raise RuntimeError('QEMU quit failed on {0}, error: {1}'.format(
576 self._node['host'], json.dumps(err)))
578 def qemu_system_powerdown(self):
579 """Power down the system (if supported)."""
580 out = self._qemu_qmp_exec('system_powerdown')
581 err = out.get('error')
584 'QEMU system powerdown failed on {0}, '
585 'error: {1}'.format(self._node['host'], json.dumps(err))
588 def qemu_system_reset(self):
589 """Reset the system."""
590 out = self._qemu_qmp_exec('system_reset')
591 err = out.get('error')
594 'QEMU system reset failed on {0}, '
595 'error: {1}'.format(self._node['host'], json.dumps(err)))
598 """Kill qemu process."""
599 # Note: in QEMU start phase there are 3 QEMU processes because we
601 self._ssh.exec_command_sudo('chmod +r {}'.format(self._pid_file))
602 self._ssh.exec_command_sudo('kill -SIGKILL $(cat {})'
603 .format(self._pid_file))
605 cmd = 'rm -f {}'.format(self._pid_file)
606 self._ssh.exec_command_sudo(cmd)
608 def qemu_kill_all(self, node=None):
609 """Kill all qemu processes on DUT node if specified.
611 :param node: Node to kill all QEMU processes on.
615 self.qemu_set_node(node)
616 self._ssh.exec_command_sudo('pkill -SIGKILL qemu')
618 def qemu_clear_socks(self):
619 """Remove all sockets created by QEMU."""
620 # If serial console port still open kill process
621 cmd = 'fuser -k {}/tcp'.format(self._qemu_opt.get('serial_port'))
622 self._ssh.exec_command_sudo(cmd)
623 # Delete all created sockets
624 for sock in self._socks:
625 cmd = 'rm -f {}'.format(sock)
626 self._ssh.exec_command_sudo(cmd)
628 def qemu_system_status(self):
629 """Return current VM status.
631 VM should be in following status:
633 - debug: QEMU running on a debugger
634 - finish-migrate: paused to finish the migration process
635 - inmigrate: waiting for an incoming migration
636 - internal-error: internal error has occurred
637 - io-error: the last IOP has failed
639 - postmigrate: paused following a successful migrate
640 - prelaunch: QEMU was started with -S and guest has not started
641 - restore-vm: paused to restore VM state
642 - running: actively running
643 - save-vm: paused to save the VM state
644 - shutdown: shut down (and -no-shutdown is in use)
645 - suspended: suspended (ACPI S3)
646 - watchdog: watchdog action has been triggered
647 - guest-panicked: panicked as a result of guest OS panic
652 out = self._qemu_qmp_exec('query-status')
653 ret = out.get('return')
655 return ret.get('status')
657 err = out.get('error')
659 'QEMU query-status failed on {0}, '
660 'error: {1}'.format(self._node['host'], json.dumps(err)))
663 def build_qemu(node, force_install=False, apply_patch=False):
664 """Build QEMU from sources.
666 :param node: Node to build QEMU on.
667 :param force_install: If True, then remove previous build.
668 :param apply_patch: If True, then apply patches from qemu_patches dir.
670 :type force_install: bool
671 :type apply_patch: bool
672 :raises: RuntimeError if building QEMU failed.
677 directory = ' --directory={0}'.format(Constants.QEMU_INSTALL_DIR)
678 version = ' --version={0}'.format(Constants.QEMU_INSTALL_VERSION)
679 force = ' --force' if force_install else ''
680 patch = ' --patch' if apply_patch else ''
682 (ret_code, stdout, stderr) = \
684 "sudo -E sh -c '{0}/{1}/qemu_build.sh{2}{3}{4}{5}'"\
685 .format(Constants.REMOTE_FW_DIR, Constants.RESOURCES_LIB_SH,
686 version, directory, force, patch), 1000)
688 if int(ret_code) != 0:
689 logger.debug('QEMU build failed {0}'.format(stdout + stderr))
690 raise RuntimeError('QEMU build failed on {0}'.format(node['host']))