From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <spp-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by inbox.dpdk.org (Postfix) with ESMTP id C0BCDA055A
	for <public@inbox.dpdk.org>; Thu, 27 Feb 2020 10:44:32 +0100 (CET)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id AD8BB1BFD1;
	Thu, 27 Feb 2020 10:44:32 +0100 (CET)
Received: from dish-sg.nttdocomo.co.jp (dish-sg.nttdocomo.co.jp
 [202.19.227.74]) by dpdk.org (Postfix) with ESMTP id 7B40F1BFE0
 for <spp@dpdk.org>; Thu, 27 Feb 2020 10:44:31 +0100 (CET)
X-dD-Source: Outbound
Received: from zssg-mailmd101.ddreams.local (zssg-mailmd900.ddreams.local
 [10.160.172.63])
 by zssg-mailou104.ddreams.local (Postfix) with ESMTP id BEE88120148;
 Thu, 27 Feb 2020 18:44:30 +0900 (JST)
Received: from zssg-mailmf105.ddreams.local
 (zssg-mailmf900.ddreams.local [10.160.172.84]) by zssg-mailmd101.ddreams.local
 (dDREAMS) with ESMTP id <0Q6C00DYYTQ6QGD0@dDREAMS>; Thu,
 27 Feb 2020 18:44:30 +0900 (JST)
Received: from zssg-mailmf105.ddreams.local (unknown [127.0.0.1])
 by zssg-mailmf105.ddreams.local (Postfix) with ESMTP id A2B227E6034;	Thu,
 27 Feb 2020 18:44:30 +0900 (JST)
Received: from zssg-mailmf105.ddreams.local (unknown [127.0.0.1])
 by IMSVA (Postfix) with ESMTP id A101F8E6060;	Thu,
 27 Feb 2020 18:44:30 +0900 (JST)
Received: from localhost (unknown [127.0.0.1])	by IMSVA (Postfix)
 with SMTP id 9F75D8E6052;	Thu, 27 Feb 2020 18:44:30 +0900 (JST)
X-IMSS-HAND-OFF-DIRECTIVE: localhost:10026
Received: from zssg-mailmf105.ddreams.local (unknown [127.0.0.1])
 by IMSVA (Postfix) with ESMTP id 407D88E6058;	Thu,
 27 Feb 2020 18:44:30 +0900 (JST)
Received: from davinci.ntt-tx.co.jp (unknown [10.160.183.139])
 by zssg-mailmf105.ddreams.local (Postfix) with ESMTP;	Thu,
 27 Feb 2020 18:44:30 +0900 (JST)
From: x-fn-spp-ml@ntt-tx.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com
Date: Thu, 27 Feb 2020 18:44:21 +0900
Message-id: <20200227094422.7429-8-x-fn-spp-ml@ntt-tx.co.jp>
X-Mailer: git-send-email 2.18.0
In-reply-to: <20200227094422.7429-1-x-fn-spp-ml@ntt-tx.co.jp>
References: <20200227094422.7429-1-x-fn-spp-ml@ntt-tx.co.jp>
X-TM-AS-GCONF: 00
Subject: [spp] [PATCH 7/8] docs: adds sample Domain XML file for vhost
X-BeenThere: spp@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: Soft Patch Panel <spp.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/spp>,
 <mailto:spp-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/spp/>
List-Post: <mailto:spp@dpdk.org>
List-Help: <mailto:spp-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/spp>,
 <mailto:spp-request@dpdk.org?subject=subscribe>
Errors-To: spp-bounces@dpdk.org
Sender: "spp" <spp-bounces@dpdk.org>

From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

This patch introduce sample Domain XML file
for vhost use case. Document description is also
modified to refer this newly introduced file.

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@ntt-tx.co.jp>
Signed-off-by: Naoki Takada <ntakada14@gmail.com>
---
 docs/guides/gsg/howto_use.rst | 80 +++++++---------------------------
 docs/samples/gsg/spp-vm1.xml  | 81 +++++++++++++++++++++++++++++++++++
 2 files changed, 97 insertions(+), 64 deletions(-)
 create mode 100644 docs/samples/gsg/spp-vm1.xml

diff --git a/docs/guides/gsg/howto_use.rst b/docs/guides/gsg/howto_use.rst
index f4f1f08..4e42c58 100644
--- a/docs/guides/gsg/howto_use.rst
+++ b/docs/guides/gsg/howto_use.rst
@@ -924,6 +924,11 @@ Edit configuration of VM with virsh command. The name of VMs are found from
 
 You need to define namespace ``qemu`` to use tags such as
 ``<qemu:commandline>``.
+In ``libvirt``, ``<qemu:commandline>`` tag is supported to utilize qemu specific
+features. In this example configuration of hugepage and/or network device is
+done via modifying domain XML file.
+Please see details in
+`libvirt document <https://libvirt.org/drvqemu.html#qemucommand>`_.
 
 .. code-block:: none
 
@@ -945,6 +950,10 @@ registering destinations for classifier's table.
 
 
 Here is an example of XML config for using with SPP.
+The following example is just excerpt from complete
+sample.
+The complete sample can be found in
+`spp-vm1.xml <http://git.dpdk.org/apps/spp/tree/docs/samples/spp-vm1.xml>`_.
 
 .. code-block:: xml
 
@@ -953,85 +962,28 @@ Here is an example of XML config for using with SPP.
       <uuid>d90f5420-861a-4479-8559-62d7a1545cb9</uuid>
       <memory unit='KiB'>4194304</memory>
       <currentMemory unit='KiB'>4194304</currentMemory>
-      <memoryBacking>
-        <hugepages/>
-      </memoryBacking>
-      <vcpu placement='static'>4</vcpu>
-      <os>
-        <type arch='x86_64' machine='pc-i440fx-2.3'>hvm</type>
-        <boot dev='hd'/>
-      </os>
-      <features>
-        <acpi/>
-        <apic/>
-        <pae/>
-      </features>
-      <clock offset='utc'/>
-      <on_poweroff>destroy</on_poweroff>
-      <on_reboot>restart</on_reboot>
-      <on_crash>restart</on_crash>
-      <devices>
-        <emulator>/usr/local/bin/qemu-system-x86_64</emulator>
-        <disk type='file' device='disk'>
-          <driver name='qemu' type='raw'/>
-          <source file='/var/lib/libvirt/images/spp-vm1.qcow2'/>
-          <target dev='hda' bus='ide'/>
-          <address type='drive' controller='0' bus='0' target='0' unit='0'/>
-        </disk>
-        <disk type='block' device='cdrom'>
-          <driver name='qemu' type='raw'/>
-          <target dev='hdc' bus='ide'/>
-          <readonly/>
-          <address type='drive' controller='0' bus='1' target='0' unit='0'/>
-        </disk>
-        <controller type='usb' index='0'>
-          <address type='pci' domain='0x0000' bus='0x00' slot='0x01'
-          function='0x2'/>
-        </controller>
-        <controller type='pci' index='0' model='pci-root'/>
-        <controller type='ide' index='0'>
-          <address type='pci' domain='0x0000' bus='0x00' slot='0x01'
-          function='0x1'/>
-        </controller>
-        <interface type='network'>
-          <mac address='52:54:00:99:aa:7f'/>
-          <source network='default'/>
-          <model type='rtl8139'/>
-          <address type='pci' domain='0x0000' bus='0x00' slot='0x02'
-          function='0x0'/>
-        </interface>
-        <serial type='pty'>
-          <target type='isa-serial' port='0'/>
-        </serial>
-        <console type='pty'>
-          <target type='serial' port='0'/>
-        </console>
-        <memballoon model='virtio'>
-          <address type='pci' domain='0x0000' bus='0x00' slot='0x03'
-          function='0x0'/>
-        </memballoon>
-      </devices>
+      "..."
       <qemu:commandline>
         <qemu:arg value='-cpu'/>
         <qemu:arg value='host'/>
         <qemu:arg value='-object'/>
-        <qemu:arg
-        value='memory-backend-file,id=mem,size=4096M,mem-path=/run/hugepages/kvm,share=on'/>
+        <qemu:arg value='memory-backend-file,
+        id=mem,size=4096M,mem-path=/run/hugepages/kvm,share=on'/>
         <qemu:arg value='-numa'/>
         <qemu:arg value='node,memdev=mem'/>
         <qemu:arg value='-mem-prealloc'/>
         <qemu:arg value='-chardev'/>
         <qemu:arg value='socket,id=chr0,path=/tmp/sock0,server'/>
         <qemu:arg value='-device'/>
-        <qemu:arg
-        value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>
+        <qemu:arg value='virtio-net-pci,netdev=vhost-net0,
+        mac=52:54:00:12:34:56'/>
         <qemu:arg value='-netdev'/>
         <qemu:arg value='vhost-user,id=vhost-net0,chardev=chr0,vhostforce'/>
         <qemu:arg value='-chardev'/>
         <qemu:arg value='socket,id=chr1,path=/tmp/sock1,server'/>
         <qemu:arg value='-device'/>
-        <qemu:arg
-        value='virtio-net-pci,netdev=vhost-net1,mac=52:54:00:12:34:57'/>
+        <qemu:arg value='virtio-net-pci,netdev=vhost-net1,
+        mac=52:54:00:12:34:57'/>
         <qemu:arg value='-netdev'/>
         <qemu:arg value='vhost-user,id=vhost-net1,chardev=chr1,vhostforce'/>
       </qemu:commandline>
diff --git a/docs/samples/gsg/spp-vm1.xml b/docs/samples/gsg/spp-vm1.xml
new file mode 100644
index 0000000..0b5e126
--- /dev/null
+++ b/docs/samples/gsg/spp-vm1.xml
@@ -0,0 +1,81 @@
+<domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
+  <name>spp-vm1</name>
+  <uuid>d90f5420-861a-4479-8559-62d7a1545cb9</uuid>
+  <memory unit='KiB'>4194304</memory>
+  <currentMemory unit='KiB'>4194304</currentMemory>
+  <memoryBacking>
+    <hugepages/>
+  </memoryBacking>
+  <vcpu placement='static'>4</vcpu>
+  <os>
+    <type arch='x86_64' machine='pc-i440fx-2.3'>hvm</type>
+    <boot dev='hd'/>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <clock offset='utc'/>
+  <on_poweroff>destroy</on_poweroff>
+  <on_reboot>restart</on_reboot>
+  <on_crash>restart</on_crash>
+  <devices>
+    <emulator>/usr/local/bin/qemu-system-x86_64</emulator>
+    <disk type='file' device='disk'>
+      <driver name='qemu' type='raw'/>
+      <source file='/var/lib/libvirt/images/spp-vm1.qcow2'/>
+      <target dev='hda' bus='ide'/>
+      <address type='drive' controller='0' bus='0' target='0' unit='0'/>
+    </disk>
+    <disk type='block' device='cdrom'>
+      <driver name='qemu' type='raw'/>
+      <target dev='hdc' bus='ide'/>
+      <readonly/>
+      <address type='drive' controller='0' bus='1' target='0' unit='0'/>
+    </disk>
+    <controller type='usb' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x2'/>
+    </controller>
+    <controller type='pci' index='0' model='pci-root'/>
+    <controller type='ide' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x1'/>
+    </controller>
+    <interface type='network'>
+      <mac address='52:54:00:99:aa:7f'/>
+      <source network='default'/>
+      <model type='rtl8139'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>
+    </interface>
+    <serial type='pty'>
+      <target type='isa-serial' port='0'/>
+    </serial>
+    <console type='pty'>
+      <target type='serial' port='0'/>
+    </console>
+    <memballoon model='virtio'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
+    </memballoon>
+  </devices>
+  <qemu:commandline>
+    <qemu:arg value='-cpu'/>
+    <qemu:arg value='host'/>
+    <qemu:arg value='-object'/>
+    <qemu:arg value='memory-backend-file,id=mem,size=4096M,mem-path=/run/hugepages/kvm,share=on'/>
+    <qemu:arg value='-numa'/>
+    <qemu:arg value='node,memdev=mem'/>
+    <qemu:arg value='-mem-prealloc'/>
+    <qemu:arg value='-chardev'/>
+    <qemu:arg value='socket,id=chr0,path=/tmp/sock0,server'/>
+    <qemu:arg value='-device'/>
+    <qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>
+    <qemu:arg value='-netdev'/>
+    <qemu:arg value='vhost-user,id=vhost-net0,chardev=chr0,vhostforce'/>
+    <qemu:arg value='-chardev'/>
+    <qemu:arg value='socket,id=chr1,path=/tmp/sock1,server'/>
+    <qemu:arg value='-device'/>
+    <qemu:arg value='virtio-net-pci,netdev=vhost-net1,mac=52:54:00:12:34:57'/>
+    <qemu:arg value='-netdev'/>
+    <qemu:arg value='vhost-user,id=vhost-net1,chardev=chr1,vhostforce'/>
+  </qemu:commandline>
+</domain>
\ No newline at end of file
-- 
2.17.1