Update Qemu library

Incorporated changes from nested VM on VIRL.

Change-Id: I76ceeb2dde635c2cf0d3a53d29bf24fed72a5437
Signed-off-by: Matus Fabian <matfabia@cisco.com>

3 files changed, 110 insertions, 12 deletions

diff --git a/docs/qemu_vpp_vm b/docs/qemu_vpp_vm
new file mode 100644
index 0000000000..4b47f90009
--- /dev/null
+++ b/docs/qemu_vpp_vm
@@ -0,0 +1,49 @@
+# Copyright (c) 2016 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:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+QEMU is used for VPP-VM testing enviroment. You need to run qemu-2.2.1 or newer
+in order to Vhos-user support. In CSIT VIRL setup DUT has preinstalled QEMU and
+have small VM image "/var/lib/vm/vhost-nested.img". QEMU binary path must
+be "/opt/qemu/bin/qemu-system-x86_64". You can use following script to replicate
+QEMU setup on DUT "resources/libraries/bash/qemu_build.sh" for local testing,
+out of LF's VM setup. VM image must have installed at least qemu-guest-agent,
+sshd, bridge-utils and VirtIO support. Note that VPP must be installed before
+starting QEMU, because VPP will do the hugepages configuration as part of it's
+installation process. Username/password for the VM must be cisco/cisco and
+NOPASSWD sudo access. The interface naming is based on driver (management
+interface type is Intel E1000), all E1000 interfaces will be named mgmt<n> and
+all VirtIO interfaces will be named virtio<n>. In VM
+"/etc/init.d/qemu-guest-agent" you must set "TRANSPORT=isa-serial:/dev/ttyS1"
+because ttyS0 is used by serial console and ttyS1 is dedicated for
+qemu-guest-agent in QEMU setup.
+There is python library for QEMU setup, start and some utilities
+"resources/libraries/python/QemuUtils.py" and keyword "Stop and Clear QEMU" for
+teardown in resources/libraries/robot/qemu.robot. "Qemu Start" setup one
+management interface by default. You can add Vhost-user interfaces by
+"Qemu Add Vhost User If" keyword.
+Example usage in robot framework test:
+
+*** Settings ***
+| Resource | resources/libraries/robot/qemu.robot
+
+*** Test Cases ***
+| VM test
+| | [Tags] | VPP_VM_ENV
+| | Qemu Set Node | ${nodes['DUT1']}
+| | Qemu Add Vhost User If | /tmp/vhost_sock
+| | ${vm}= | Set Variable | ${None}
+| | ${vm}= | Qemu Start
+| | [Teardown] | Stop and Clear QEMU | ${dut1} | ${vm}
+
+Note that VPP must be started and cofigured before starting the VM when using
+Vhost-user interfaces.
diff --git a/resources/libraries/bash/qemu_build.sh b/resources/libraries/bash/qemu_build.sh
index 449cce664f..7b8ac41251 100644
--- a/resources/libraries/bash/qemu_build.sh
+++ b/resources/libraries/bash/qemu_build.sh
@@ -12,27 +12,34 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+QEMU_BUILD_DIR="/tmp/qemu-2.2.1"
+QEMU_INSTALL_DIR="/opt/qemu"
+
 echo
 echo Downloading QEMU source
 echo
-sudo rm -rf /tmp/qemu-2.2.1
+sudo rm -rf ${QEMU_BUILD_DIR}
+sudo rm -rf ${QEMU_INSTALL_DIR}
 cd /tmp
 wget -q http://wiki.qemu-project.org/download/qemu-2.2.1.tar.bz2 || exit
 
 echo
 echo Extracting QEMU
 echo
-tar xjf qemu-2.2.1.tar.bz2 || exit
-rm qemu-2.2.1.tar.bz2
+mkdir ${QEMU_BUILD_DIR}
+tar --strip-components 1 -xjf qemu-2.2.1.tar.bz2 -C ${QEMU_BUILD_DIR} || exit
+rm -f qemu-2.2.1.tar.bz2
 
 echo
 echo Building QEMU
 echo
-cd qemu-2.2.1
+cd ${QEMU_BUILD_DIR}
+sudo mkdir ${QEMU_INSTALL_DIR}
 mkdir build
 cd build
-../configure --target-list=x86_64-softmmu || exit
+../configure --target-list=x86_64-softmmu --prefix=${QEMU_INSTALL_DIR} || exit
 make -j`nproc` || exit
+sudo make install || exit
 
 echo
 echo QEMU ready
diff --git a/resources/libraries/python/QemuUtils.py b/resources/libraries/python/QemuUtils.py
index 7249b5e206..7f74106177 100644
--- a/resources/libraries/python/QemuUtils.py
+++ b/resources/libraries/python/QemuUtils.py
@@ -25,7 +25,7 @@ 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_BIN = '/opt/qemu/bin/qemu-system-x86_64'
     # QEMU Machine Protocol socket
     __QMP_SOCK = '/tmp/qmp.sock'
     # QEMU Guest Agent socket
@@ -41,10 +41,14 @@ class QemuUtils(object):
             '-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 serial console port
+        self._qemu_opt['serial_port'] = 4556
         # 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'
+        # Default image for CSIT virl setup
+        self._qemu_opt['disk_image'] = '/var/lib/vm/vhost-nested.img'
         # VM node info dict
         self._vm_info = {
             'type': NodeType.VM,
@@ -82,6 +86,14 @@ class QemuUtils(object):
         self._qemu_opt['ssh_fwd_port'] = fwd_port
         self._vm_info['port'] = fwd_port
 
+    def qemu_set_serial_port(self, port):
+        """Set serial console port.
+
+        :param port: Serial console port.
+        :type port: int
+        """
+        self._qemu_opt['serial_port'] = port
+
     def qemu_set_mem_size(self, mem_size):
         """Set virtual RAM size.
 
@@ -241,6 +253,8 @@ class QemuUtils(object):
                 self._qemu_opt['disk_image'], 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():
@@ -291,7 +305,8 @@ class QemuUtils(object):
 
         :return: VM node info
         :rtype: dict
-        .. note:: First set at least disk image and node to run QEMU on.
+        .. note:: First set at least node to run QEMU on.
+        .. warning:: Starts only one VM on the node.
         """
         # SSH forwarding
         ssh_fwd = '-net user,hostfwd=tcp::{0}-:22'.format(
@@ -303,15 +318,20 @@ class QemuUtils(object):
         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
+        # 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'))
+        # Setup QGA via chardev (unix socket) and isa-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'
+            '-device isa-serial,chardev=qga0'
+        # Graphic setup
+        graphic = '-monitor none -display none -vga none'
         # Run QEMU
-        cmd = '{0} {1} {2} {3} {4} -hda {5} {6} {7}'.format(
+        cmd = '{0} {1} {2} {3} {4} -hda {5} {6} {7} {8} {9}'.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)
+            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))
@@ -358,6 +378,10 @@ class QemuUtils(object):
 
     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)
+        # Delete all created sockets
         for sock in self._socks:
             cmd = 'rm -f {}'.format(sock)
             self._ssh.exec_command_sudo(cmd)
@@ -365,6 +389,24 @@ class QemuUtils(object):
     def qemu_system_status(self):
         """Return current VM status.
 
+        VM should be in following status:
+
+            - debug: QEMU running on a debugger
+            - finish-migrate: paused to finish the migration process
+            - inmigrate: waiting for an incoming migration
+            - internal-error: internal error has occurred
+            - io-error: the last IOP has failed
+            - paused: paused
+            - postmigrate: paused following a successful migrate
+            - prelaunch: QEMU was started with -S and guest has not started
+            - restore-vm: paused to restore VM state
+            - running: actively running
+            - save-vm: paused to save the VM state
+            - shutdown: shut down (and -no-shutdown is in use)
+            - suspended: suspended (ACPI S3)
+            - watchdog: watchdog action has been triggered
+            - guest-panicked: panicked as a result of guest OS panic
+
         :return: VM status.
         :rtype: str
         """