+ self._temp['startup'] = startup
+ self._temp['running'] = running
+ self._opt['vnf_bin'] = ('/usr/bin/vpp -c {startup}'.
+ format(startup=startup))
+
+ # Create VPP startup configuration.
+ vpp_config = VppConfigGenerator()
+ vpp_config.set_node(self._node)
+ vpp_config.add_unix_nodaemon()
+ vpp_config.add_unix_cli_listen()
+ vpp_config.add_unix_exec(running)
+ vpp_config.add_cpu_main_core('0')
+ vpp_config.add_cpu_corelist_workers('1-{smp}'.
+ format(smp=self._opt.get('smp')-1))
+ vpp_config.add_dpdk_dev('0000:00:06.0', '0000:00:07.0')
+ vpp_config.add_dpdk_log_level('debug')
+ if not kwargs['jumbo_frames']:
+ vpp_config.add_dpdk_no_multi_seg()
+ vpp_config.add_dpdk_no_tx_checksum_offload()
+ vpp_config.add_plugin('disable', 'default')
+ vpp_config.add_plugin('enable', 'dpdk_plugin.so')
+ vpp_config.write_config(startup)
+
+ # Create VPP running configuration.
+ template = '{res}/{tpl}.exec'.format(res=Constants.RESOURCES_TPL_VM,
+ tpl=self._opt.get('vnf'))
+ exec_cmd_no_error(self._node, 'rm -f {running}'.format(running=running),
+ sudo=True)
+
+ with open(template, 'r') as src_file:
+ src = Template(src_file.read())
+ exec_cmd_no_error(
+ self._node, "echo '{out}' | sudo tee {running}".format(
+ out=src.safe_substitute(**kwargs), running=running))
+
+ def create_kernelvm_config_testpmd_io(self, **kwargs):
+ """Create QEMU testpmd-io command line.
+
+ :param kwargs: Key-value pairs to construct command line parameters.
+ :type kwargs: dict
+ """
+ testpmd_path = ('{path}/{arch}-native-linuxapp-gcc/app'.
+ format(path=Constants.QEMU_VM_DPDK,
+ arch=Topology.get_node_arch(self._node)))
+ testpmd_cmd = DpdkUtil.get_testpmd_cmdline(
+ eal_corelist='0-{smp}'.format(smp=self._opt.get('smp') - 1),
+ eal_driver=False,
+ eal_in_memory=True,
+ pmd_num_mbufs=16384,
+ pmd_rxq=kwargs['queues'],
+ pmd_txq=kwargs['queues'],
+ pmd_tx_offloads=False,
+ pmd_disable_hw_vlan=False,
+ pmd_max_pkt_len=9200 if kwargs['jumbo_frames'] else None,
+ pmd_nb_cores=str(self._opt.get('smp') - 1))
+
+ self._opt['vnf_bin'] = ('{testpmd_path}/{testpmd_cmd}'.
+ format(testpmd_path=testpmd_path,
+ testpmd_cmd=testpmd_cmd))
+
+ def create_kernelvm_config_testpmd_mac(self, **kwargs):
+ """Create QEMU testpmd-mac command line.
+
+ :param kwargs: Key-value pairs to construct command line parameters.
+ :type kwargs: dict
+ """
+ testpmd_path = ('{path}/{arch}-native-linuxapp-gcc/app'.
+ format(path=Constants.QEMU_VM_DPDK,
+ arch=Topology.get_node_arch(self._node)))
+ testpmd_cmd = DpdkUtil.get_testpmd_cmdline(
+ eal_corelist='0-{smp}'.format(smp=self._opt.get('smp') - 1),
+ eal_driver=False,
+ eal_in_memory=True,
+ pmd_num_mbufs=16384,
+ pmd_fwd_mode='mac',
+ pmd_eth_peer_0='0,{mac}'.format(mac=kwargs['vif1_mac']),
+ pmd_eth_peer_1='1,{mac}'.format(mac=kwargs['vif2_mac']),
+ pmd_rxq=kwargs['queues'],
+ pmd_txq=kwargs['queues'],
+ pmd_tx_offloads=False,
+ pmd_disable_hw_vlan=False,
+ pmd_max_pkt_len=9200 if kwargs['jumbo_frames'] else None,
+ pmd_nb_cores=str(self._opt.get('smp') - 1))
+
+ self._opt['vnf_bin'] = ('{testpmd_path}/{testpmd_cmd}'.
+ format(testpmd_path=testpmd_path,
+ testpmd_cmd=testpmd_cmd))
+
+ def create_kernelvm_init(self, **kwargs):
+ """Create QEMU init script.
+
+ :param kwargs: Key-value pairs to replace content of init startup file.
+ :type kwargs: dict
+ """
+ template = '{res}/init.sh'.format(res=Constants.RESOURCES_TPL_VM)
+ init = self._temp.get('ini')
+ exec_cmd_no_error(
+ self._node, 'rm -f {init}'.format(init=init), sudo=True)
+
+ with open(template, 'r') as src_file:
+ src = Template(src_file.read())
+ exec_cmd_no_error(
+ self._node, "echo '{out}' | sudo tee {init}".format(
+ out=src.safe_substitute(**kwargs), init=init))
+ exec_cmd_no_error(
+ self._node, "chmod +x {init}".format(init=init), sudo=True)
+
+ def configure_kernelvm_vnf(self, **kwargs):
+ """Create KernelVM VNF configurations.
+
+ :param kwargs: Key-value pairs for templating configs.
+ :type kwargs: dict
+ """
+ if 'vpp' in self._opt.get('vnf'):
+ self.create_kernelvm_config_vpp(**kwargs)
+ elif 'testpmd_io' in self._opt.get('vnf'):
+ self.create_kernelvm_config_testpmd_io(**kwargs)
+ elif 'testpmd_mac' in self._opt.get('vnf'):
+ self.create_kernelvm_config_testpmd_mac(**kwargs)
+ else:
+ raise RuntimeError('QEMU: Unsupported VNF!')
+ self.create_kernelvm_init(vnf_bin=self._opt['vnf_bin'])
+
+ def get_qemu_pids(self):
+ """Get QEMU CPU pids.
+
+ :returns: List of QEMU CPU pids.
+ :rtype: list of str
+ """
+ command = ("grep -rwl 'CPU' /proc/$(sudo cat {pidfile})/task/*/comm ".
+ format(pidfile=self._temp.get('pidfile')))
+ command += (r"| xargs dirname | sed -e 's/\/.*\///g' | uniq")
+
+ stdout, _ = exec_cmd_no_error(self._node, command)
+ return stdout.splitlines()
+
+ def qemu_set_affinity(self, *host_cpus):
+ """Set qemu affinity by getting thread PIDs via QMP and taskset to list
+ of CPU cores. Function tries to execute 3 times to avoid race condition
+ in getting thread PIDs.
+
+ :param host_cpus: List of CPU cores.
+ :type host_cpus: list
+ """
+ for _ in range(3):
+ try:
+ qemu_cpus = self.get_qemu_pids()
+
+ if len(qemu_cpus) != len(host_cpus):
+ sleep(1)
+ continue
+ for qemu_cpu, host_cpu in zip(qemu_cpus, host_cpus):
+ command = ('taskset -pc {host_cpu} {thread}'.
+ format(host_cpu=host_cpu, thread=qemu_cpu))
+ message = ('QEMU: Set affinity failed on {host}!'.
+ format(host=self._node['host']))
+ exec_cmd_no_error(self._node, command, sudo=True,
+ message=message)
+ break
+ except (RuntimeError, ValueError):
+ self.qemu_kill_all()
+ raise
+ else:
+ self.qemu_kill_all()
+ raise RuntimeError('Failed to set Qemu threads affinity!')
+
+ 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.
+ """
+ try:
+ qemu_cpus = self.get_qemu_pids()
+
+ for qemu_cpu in qemu_cpus:
+ command = ('chrt -r -p 1 {thread}'.
+ format(thread=qemu_cpu))
+ message = ('QEMU: Set SCHED_RR failed on {host}'.
+ format(host=self._node['host']))
+ exec_cmd_no_error(self._node, command, sudo=True,
+ message=message)
+ except (RuntimeError, ValueError):
+ self.qemu_kill_all()
+ raise
+
+ def qemu_add_vhost_user_if(self, socket, server=True, jumbo_frames=False,
+ queue_size=None, queues=1):
+ """Add Vhost-user interface.
+
+ :param socket: Path of the unix socket.
+ :param server: If True the socket shall be a listening socket.
+ :param jumbo_frames: Set True if jumbo frames are used in the test.
+ :param queue_size: Vring queue size.
+ :param queues: Number of queues.
+ :type socket: str
+ :type server: bool
+ :type jumbo_frames: bool
+ :type queue_size: int
+ :type queues: int
+ """
+ self._vhost_id += 1
+ self._params.add_with_value(
+ 'chardev', 'socket,id=char{vhost},path={socket}{server}'.format(
+ vhost=self._vhost_id, socket=socket,
+ server=',server' if server is True else ''))
+ self._params.add_with_value(
+ 'netdev', 'vhost-user,id=vhost{vhost},chardev=char{vhost},'
+ 'queues={queues}'.format(vhost=self._vhost_id, queues=queues))
+ mac = ('52:54:00:00:{qemu:02x}:{vhost:02x}'.
+ format(qemu=self._opt.get('qemu_id'), vhost=self._vhost_id))
+ queue_size = ('rx_queue_size={queue_size},tx_queue_size={queue_size}'.
+ format(queue_size=queue_size)) if queue_size else ''
+ mbuf = 'on,host_mtu=9200'
+ self._params.add_with_value(
+ 'device', 'virtio-net-pci,netdev=vhost{vhost},mac={mac},bus=pci.0,'
+ 'addr={addr}.0,mq=on,vectors={vectors},csum=off,gso=off,'
+ 'guest_tso4=off,guest_tso6=off,guest_ecn=off,mrg_rxbuf={mbuf},'
+ '{queue_size}'.format(
+ addr=self._vhost_id+5, vhost=self._vhost_id, mac=mac,
+ mbuf=mbuf if jumbo_frames else 'off', queue_size=queue_size,
+ vectors=(2 * queues + 2)))
+
+ # Add interface MAC and socket to the node dict.
+ if_data = {'mac_address': mac, 'socket': socket}
+ if_name = 'vhost{vhost}'.format(vhost=self._vhost_id)
+ self._vm_info['interfaces'][if_name] = if_data
+ # Add socket to temporary file list.
+ self._temp[if_name] = 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
+ :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.
+ command = ('echo "{{ \\"execute\\": \\"qmp_capabilities\\" }}'
+ '{{ \\"execute\\": \\"{cmd}\\" }}" | '
+ 'sudo -S socat - UNIX-CONNECT:{qmp}'.
+ format(cmd=cmd, qmp=self._temp.get('qmp')))
+ message = ('QMP execute "{cmd}" failed on {host}'.
+ format(cmd=cmd, host=self._node['host']))
+ stdout, _ = exec_cmd_no_error(
+ self._node, command, sudo=False, message=message)
+
+ # Skip capabilities negotiation messages.
+ out_list = stdout.splitlines()
+ if len(out_list) < 3:
+ 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."""
+ command = ('(printf "\xFF"; sleep 1) | '
+ 'sudo -S socat - UNIX-CONNECT:{qga}'.
+ format(qga=self._temp.get('qga')))
+ message = ('QGA flush failed on {host}'.format(host=self._node['host']))
+ stdout, _ = exec_cmd_no_error(
+ self._node, command, sudo=False, message=message)
+
+ return json.loads(stdout.split('\n', 1)[0]) if stdout else dict()
+
+ 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
+ """
+ command = ('(echo "{{ \\"execute\\": \\"{cmd}\\" }}"; sleep 1) | '
+ 'sudo -S socat - UNIX-CONNECT:{qga}'.
+ format(cmd=cmd, qga=self._temp.get('qga')))
+ message = ('QGA execute "{cmd}" failed on {host}'.
+ format(cmd=cmd, host=self._node['host']))
+ stdout, _ = exec_cmd_no_error(
+ self._node, command, sudo=False, message=message)
+
+ return json.loads(stdout.split('\n', 1)[0]) if stdout else dict()
+
+ def _wait_until_vm_boot(self):
+ """Wait until QEMU with NestedVM is booted."""
+ if self._opt.get('vm_type') == 'nestedvm':
+ self._wait_until_nestedvm_boot()
+ self._update_vm_interfaces()
+ elif self._opt.get('vm_type') == 'kernelvm':
+ self._wait_until_kernelvm_boot()
+ else:
+ raise RuntimeError('QEMU: Unsupported VM type!')
+
+ def _wait_until_nestedvm_boot(self, retries=12):
+ """Wait until QEMU with NestedVM is booted.
+
+ First try to flush qga until there is output.
+ Then ping QEMU guest agent each 5s until VM booted or timeout.
+
+ :param retries: Number of retries with 5s between trials.
+ :type retries: int
+ """
+ for _ in range(retries):
+ 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
+ else:
+ raise RuntimeError('QEMU: Timeout, VM not booted on {host}!'.
+ format(host=self._node['host']))
+ for _ in range(retries):
+ 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)
+ # Non-error return - VM booted.
+ elif out.get('return') is not None:
+ break
+ # Skip error and wait.
+ elif out.get('error') is not None:
+ sleep(5)
+ else:
+ # 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))
+ else:
+ raise RuntimeError('QEMU: Timeout, VM not booted on {host}!'.
+ format(host=self._node['host']))
+
+ def _wait_until_kernelvm_boot(self, retries=60):
+ """Wait until QEMU KernelVM is booted.
+
+ :param retries: Number of retries.
+ :type retries: int
+ """
+ vpp_ver = VPPUtil.vpp_show_version(self._node)
+
+ for _ in range(retries):
+ command = ('tail -1 {log}'.format(log=self._temp.get('log')))
+ stdout = None
+ try:
+ stdout, _ = exec_cmd_no_error(self._node, command, sudo=True)
+ sleep(1)
+ except RuntimeError:
+ pass
+ if vpp_ver in stdout or 'Press enter to exit' in stdout:
+ break
+ if 'reboot: Power down' in stdout:
+ raise RuntimeError('QEMU: NF failed to run on {host}!'.
+ format(host=self._node['host']))
+ else:
+ raise RuntimeError('QEMU: Timeout, VM not booted on {host}!'.
+ format(host=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 interface list failed on {host}'.
+ format(host=self._node['host']))
+ # Create MAC-name dict.
+ for interface in interfaces:
+ if 'hardware-address' not in interface:
+ continue
+ 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 {mac} not found'.format(mac=mac))
+ else:
+ interface['name'] = if_name
+
+ def qemu_start(self):
+ """Start QEMU and wait until VM boot.
+
+ :returns: VM node info.
+ :rtype: dict
+ """
+ cmd_opts = OptionString()
+ cmd_opts.add('{bin_path}/qemu-system-{arch}'.format(
+ bin_path=Constants.QEMU_BIN_PATH,
+ arch=Topology.get_node_arch(self._node)))
+ cmd_opts.extend(self._params)
+ message = ('QEMU: Start failed on {host}!'.
+ format(host=self._node['host']))
+ try:
+ DUTSetup.check_huge_page(
+ self._node, '/dev/hugepages', self._opt.get('mem'))
+
+ exec_cmd_no_error(
+ self._node, cmd_opts, timeout=300, sudo=True, message=message)
+ self._wait_until_vm_boot()
+ except RuntimeError:
+ self.qemu_kill_all()
+ raise
+ return self._vm_info
+
+ def qemu_kill(self):
+ """Kill qemu process."""
+ exec_cmd(self._node, 'chmod +r {pidfile}'.
+ format(pidfile=self._temp.get('pidfile')), sudo=True)
+ exec_cmd(self._node, 'kill -SIGKILL $(cat {pidfile})'.
+ format(pidfile=self._temp.get('pidfile')), sudo=True)
+
+ for value in self._temp.values():
+ exec_cmd(self._node, 'cat {value}'.format(value=value), sudo=True)
+ exec_cmd(self._node, 'rm -f {value}'.format(value=value), sudo=True)
+
+ def qemu_kill_all(self):
+ """Kill all qemu processes on DUT node if specified."""
+ exec_cmd(self._node, 'pkill -SIGKILL qemu', sudo=True)
+
+ for value in self._temp.values():
+ exec_cmd(self._node, 'cat {value}'.format(value=value), sudo=True)
+ exec_cmd(self._node, 'rm -f {value}'.format(value=value), sudo=True)
+
+ def qemu_version(self, version=None):
+ """Return Qemu version or compare if version is higher than parameter.
+
+ :param version: Version to compare.
+ :type version: str
+ :returns: Qemu version or Boolean if version is higher than parameter.
+ :rtype: str or bool
+ """
+ command = ('{bin_path}/qemu-system-{arch} --version'.format(
+ bin_path=Constants.QEMU_BIN_PATH,
+ arch=Topology.get_node_arch(self._node)))
+ try:
+ stdout, _ = exec_cmd_no_error(self._node, command, sudo=True)
+ ver = match(r'QEMU emulator version ([\d.]*)', stdout).group(1)
+ return StrictVersion(ver) > StrictVersion(version) \
+ if version else ver
+ except RuntimeError:
+ self.qemu_kill_all()
+ raise