Updating benchmark.xml and editing last typos

LXCR-7844

Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>

5 files changed, 261 insertions, 46 deletions

diff --git a/doc/book-enea-nfv-access-platform-guide/doc/benchmarks.xml b/doc/book-enea-nfv-access-platform-guide/doc/benchmarks.xml
index 7155e44..fa461fa 100644
--- a/doc/book-enea-nfv-access-platform-guide/doc/benchmarks.xml
+++ b/doc/book-enea-nfv-access-platform-guide/doc/benchmarks.xml
@@ -4,18 +4,231 @@
 <chapter id="benchmarks">
   <title>Benchmarks</title>
 
-  <para></para>
-
   <section id="hw-setup">
     <title>Hardware Setup</title>
 
-    <para></para>
+    <para>The following table describes all the needed prequisites for an apt
+    hardware setup:</para>
+
+    <table>
+      <title>Hardware Setup</title>
+
+      <tgroup cols="2">
+        <colspec align="left" />
+
+        <thead>
+          <row>
+            <entry align="center">Item</entry>
+
+            <entry align="center">Description</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry align="left">Server Platform</entry>
+
+            <entry align="left">Supermicro X10SDV-4C-TLN2F
+            http://www.supermicro.com/products/motherboard/xeon/d/X10SDV-4C-TLN2F.cfm</entry>
+          </row>
+
+          <row>
+            <entry align="left">ARCH</entry>
+
+            <entry>x86-64</entry>
+          </row>
+
+          <row>
+            <entry align="left">Processor</entry>
+
+            <entry>1 x Intel Xeon D-1521 (Broadwell), 4 cores, 8
+            hyper-threaded cores per processor</entry>
+          </row>
+
+          <row>
+            <entry align="left">CPU freq</entry>
+
+            <entry>2.40 GHz</entry>
+          </row>
+
+          <row>
+            <entry align="left">RAM</entry>
+
+            <entry>16GB</entry>
+          </row>
+
+          <row>
+            <entry align="left">Network</entry>
+
+            <entry>Dual integrated 10G ports</entry>
+          </row>
+
+          <row>
+            <entry align="left">Storage</entry>
+
+            <entry>Samsung 850 Pro 128GB SSD</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <para>Generic tests configuration:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>All tests use one port, one core and one Rx/TX queue for fast
+        path traffic.</para>
+      </listitem>
+    </itemizedlist>
   </section>
 
   <section id="bios">
-    <title>Bios</title>
+    <title>BIOS Settings</title>
+
+    <para>The table below details the BIOS settings for which the default
+    values were changed when doing performance measurements.</para>
+
+    <table>
+      <title>BIOS Settings</title>
+
+      <tgroup cols="4">
+        <colspec align="left" />
+
+        <thead>
+          <row>
+            <entry align="center">Menu Path</entry>
+
+            <entry align="center">Setting Name</entry>
+
+            <entry align="center">Enea NFV Access value</entry>
+
+            <entry align="center">BIOS Default value</entry>
+          </row>
+        </thead>
+
+        <tbody>
+          <row>
+            <entry align="left">CPU Configuration</entry>
+
+            <entry align="left">Direct Cache Access (DCA)</entry>
+
+            <entry>Enable</entry>
+
+            <entry>Auto</entry>
+          </row>
+
+          <row>
+            <entry>CPU Configuration / Advanced Power Management
+            Configuration</entry>
+
+            <entry align="left">EIST (P-States)</entry>
+
+            <entry>Disable</entry>
+
+            <entry>Enable</entry>
+          </row>
+
+          <row>
+            <entry>CPU Configuration / Advanced Power Management Configuration
+            / CPU C State Control</entry>
+
+            <entry align="left">CPU C State</entry>
+
+            <entry>Disable</entry>
+
+            <entry>Enable</entry>
+          </row>
+
+          <row>
+            <entry>CPU Configuration / Advanced Power Management Configuration
+            / CPU Advanced PM Turning / Energy Perf BIAS</entry>
+
+            <entry align="left">Energy Performance Tuning</entry>
+
+            <entry>Disable</entry>
+
+            <entry>Enable</entry>
+          </row>
+
+          <row>
+            <entry>CPU Configuration / Advanced Power Management Configuration
+            / CPU Advanced PM Turning / Energy Perf BIAS</entry>
+
+            <entry align="left">Energy Performance BIAS Setting</entry>
+
+            <entry>Performance</entry>
+
+            <entry>Balanced Performance</entry>
+          </row>
+
+          <row>
+            <entry>CPU Configuration / Advanced Power Management Configuration
+            / CPU Advanced PM Turning / Energy Perf BIAS</entry>
+
+            <entry align="left">Power/Performance Switch</entry>
+
+            <entry>Disable</entry>
+
+            <entry>Enable</entry>
+          </row>
+
+          <row>
+            <entry>CPU Configuration / Advanced Power Management Configuration
+            / CPU Advanced PM Turning / Program PowerCTL _MSR</entry>
+
+            <entry align="left">Energy Efficient Turbo</entry>
+
+            <entry>Disable</entry>
+
+            <entry>Enable</entry>
+          </row>
+
+          <row>
+            <entry>Chipset Configuration / North Bridge / IIO
+            Configuration</entry>
+
+            <entry align="left">EV DFX Features</entry>
+
+            <entry>Enable</entry>
+
+            <entry>Disable</entry>
+          </row>
+
+          <row>
+            <entry>Chipset Configuration / North Bridge / Memory
+            Configuration</entry>
+
+            <entry align="left">Enforce POR</entry>
+
+            <entry>Disable</entry>
+
+            <entry>Enable</entry>
+          </row>
+
+          <row>
+            <entry>Chipset Configuration / North Bridge / Memory
+            Configuration</entry>
+
+            <entry align="left">Memory Frequency</entry>
+
+            <entry>2400</entry>
+
+            <entry>Auto</entry>
+          </row>
+
+          <row>
+            <entry>Chipset Configuration / North Bridge / Memory
+            Configuration</entry>
+
+            <entry align="left">DRAM RAPL Baseline</entry>
+
+            <entry>Disable</entry>
 
-    <para></para>
+            <entry>DRAM RAPL Mode 1</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
   </section>
 
   <section id="use-cases">
@@ -25,14 +238,14 @@
       <title>Docker related benchmarks</title>
 
       <section>
-        <title>Use Case - Forward traffic in docker</title>
+        <title>Forward traffic in Docker</title>
 
         <para>Benchmarking traffic forwarding using testpmd in a Docker
         container.</para>
 
         <para>Pktgen is used to generate UDP traffic that will reach testpmd,
-        running in a docker image. It will then be forwarded back to source on
-        the return trip (Forwarding). </para>
+        running in a Docker image. It will then be forwarded back to source on
+        the return trip (Forwarding).</para>
 
         <para>This test measures:</para>
 
@@ -92,7 +305,7 @@ processor.max_cstate=0 mce=ignore_ce audit=0 nmi_watchdog=0 iommu=pt /
 intel_iommu=on  hugepagesz=1GB hugepages=8 default_hugepagesz=1GB /
 hugepagesz=2M hugepages=2048 vfio_iommu_type1.allow_unsafe_interrupts=1</programlisting>
 
-          <para>It is expected to have docker/guest image on target. Configure
+          <para>It is expected to have Docker/guest image on target. Configure
           the OVS bridge:<programlisting># OVS old config clean-up
 killall ovsdb-server ovs-vswitchd
 rm -rf /etc/openvswitch/*
@@ -286,8 +499,8 @@ start</programlisting><table>
       </section>
 
       <section id="usecase-three-four">
-        <title>Use Case - Forward traffic from Docker to another Docker on the
-        same host</title>
+        <title>Forward traffic from Docker to another Docker on the same
+        host</title>
 
         <para>Benchmark a combo test using testpmd running in two Docker
         instances, one which Forwards traffic to the second one, which
@@ -396,13 +609,13 @@ ovs-ofctl add-flow ovsbr0 in_port=2,action=output:1</programlisting>Import a
 --rxq=1 --txq=1 --txd=512 --rxd=512 --txqflags=0xf00 --port-topology=chained</programlisting>Configure
           it in termination mode:<programlisting>set fwd rxonly</programlisting>Run
           the testpmd application:<programlisting>start</programlisting>Open a
-          new console to the host and start the second docker
+          new console to the host and start the second Docker
           instance:<programlisting>docker run -it --rm --cpuset-cpus=0,1 -v /var/run/openvswitch/:/var/run/openvswitch/ /
 -v /mnt/huge:/mnt/huge el7_guest /bin/bash</programlisting>In the second
           container start testpmd:<programlisting>testpmd -c 0x0F --file-prefix prog2 --socket-mem 512 --no-pci /
 --vdev=virtio_user0,path=/var/run/openvswitch/vhost-user2 /
 -d /usr/lib/librte_pmd_virtio.so.1.1 -- -i --disable-hw-vlan</programlisting>Run
-          the TestPmd application in the second docker:<programlisting>testpmd -c 0x3 -n 2 --file-prefix prog2  --socket-mem 512 --no-pci /
+          the TestPmd application in the second Docker:<programlisting>testpmd -c 0x3 -n 2 --file-prefix prog2  --socket-mem 512 --no-pci /
 --vdev=virtio_user0,path=/var/run/openvswitch/vhost-user2 /
 -d /usr/lib/librte_pmd_virtio.so.1.1 -- --burst 64 --disable-hw-vlan /
 --disable-rss  -i --portmask=0x1 --coremask=0x2  --nb-cores=1 --rxq=1 /
@@ -414,7 +627,7 @@ ovs-ofctl add-flow ovsbr0 in_port=2,action=output:1</programlisting>Import a
           should be used in testpmd applications.</para>
 
           <table>
-            <title>Results </title>
+            <title>Results</title>
 
             <tgroup cols="5">
               <tbody>
@@ -495,15 +708,15 @@ ovs-ofctl add-flow ovsbr0 in_port=2,action=output:1</programlisting>Import a
       <title>VM related benchmarks</title>
 
       <section id="usecase-four">
-        <title>Use Case - Forward/termination traffic in one VM</title>
+        <title>Forward/termination traffic in one VM</title>
 
         <para>Benchmarking traffic (UDP) forwarding and termination using
-        testpmd in a virtual machine. </para>
+        testpmd in a virtual machine.</para>
 
         <para>The Pktgen application is used to generate traffic that will
         reach testpmd running on a virtual machine, and be forwarded back to
         source on the return trip. With the same setup a second measurement
-        will be done with traffic termination in the virtual machine. </para>
+        will be done with traffic termination in the virtual machine.</para>
 
         <para>This test case measures:</para>
 
@@ -778,7 +991,7 @@ show port stats 0</programlisting><table>
       </section>
 
       <section id="usecase-six">
-        <title>Use Case - Forward traffic between two VMs</title>
+        <title>Forward traffic between two VMs</title>
 
         <para>Benchmark a combo test using two virtual machines, the first
         with traffic forwarding to the second, which terminates it.</para>
diff --git a/doc/book-enea-nfv-access-platform-guide/doc/container_virtualization.xml b/doc/book-enea-nfv-access-platform-guide/doc/container_virtualization.xml
index c6ce223..055de7c 100644
--- a/doc/book-enea-nfv-access-platform-guide/doc/container_virtualization.xml
+++ b/doc/book-enea-nfv-access-platform-guide/doc/container_virtualization.xml
@@ -15,7 +15,7 @@
     <para>The software container mechanism uses resource isolation features
     inside the Linux kernel, such as cgroups and kernel namespaces to allow
     multiple containers to run within a single Linux instance, avoiding the
-    overhead of starting and maintaining virtual machines. </para>
+    overhead of starting and maintaining virtual machines.</para>
 
     <para>Containers are lightweight and include everything needed to run
     themselves: code, runtime, system tools, system libraries and settings.
@@ -23,7 +23,7 @@
     software is isolated from its surroundings. For example, differences
     between development and staging environments can be kept separate in order
     to reduce conflicts between teams running different software on the same
-    infrastructure. </para>
+    infrastructure.</para>
 
     <para>For a better understanding of what Docker is and how it works, the
     official documentation provided on the Docker website should be consulted:
@@ -37,12 +37,10 @@
       system is running the daemon correctly. This container can be launched
       by simply running:</para>
 
-      <programlisting>&gt;docker run hello-world
+      <programlisting>docker run hello-world</programlisting>
 
-Hello from Docker!</programlisting>
-
-      <para>This message shows that your installation appears to be working
-      correctly.</para>
+      <para>If your installation is working correctly, the following message
+      should be outputted:<programlisting>Hello from Docker!</programlisting></para>
     </section>
 
     <section id="run-enfv-guest-image">
@@ -52,17 +50,17 @@ Hello from Docker!</programlisting>
       other container can. Before starting an Enea NFV Access Platform guest
       image, a root filesystem has to be imported in Docker:</para>
 
-      <programlisting>&gt;docker import enea-linux-virtualization-guest-x86-64.tar.gz el7guest</programlisting>
+      <programlisting>docker import enea-linux-virtualization-guest-qemux86-64.tar.gz el7guest</programlisting>
 
       <para>To check that the Docker image has been imported successfully,
       run:</para>
 
-      <programlisting>&gt;docker images</programlisting>
+      <programlisting>docker images</programlisting>
 
       <para>Finally, start an Enea NFV Access Platform container with
       <literal>bash</literal> running as the shell, by running:</para>
 
-      <programlisting>&gt;docker run -it el7guest /bin/bash</programlisting>
+      <programlisting>docker run -it el7guest /bin/bash</programlisting>
     </section>
 
     <section id="attach-ext-resources-docker-containers">
@@ -77,7 +75,7 @@ Hello from Docker!</programlisting>
       <literal>roots</literal> home folder to a container, the command line
       for Docker should have the following format:</para>
 
-      <programlisting>&gt;docker run -it -v /home/root:/home/host_root/ el7guest /bin/bash</programlisting>
+      <programlisting>docker run -it -v /home/root:/home/host_root/ el7guest /bin/bash</programlisting>
 
       <para>To check that folders have been properly passed from the host to
       the container, create a file in the source folder on the host root
@@ -103,7 +101,7 @@ Hello from Docker!</programlisting>
             <para>Mapping a file descriptor is done in a similar way, but the
             <literal>-v</literal> flag needs to point directly to it:</para>
 
-            <programlisting>&gt;docker run -it --rm -v /var/run/openvswitch/vhost-user1 el7guest /bin/bash</programlisting>
+            <programlisting>docker run -it --rm -v /var/run/openvswitch/vhost-user1 el7guest /bin/bash</programlisting>
           </listitem>
         </itemizedlist>
       </section>
@@ -118,7 +116,7 @@ Hello from Docker!</programlisting>
         <literal>/mnt/huge</literal> location, a container can also access
         hugepages by being launched with:</para>
 
-        <programlisting>&gt;docker run -it -v /mnt/huge el7guest /bin/bash</programlisting>
+        <programlisting>docker run -it -v /mnt/huge el7guest /bin/bash</programlisting>
       </section>
 
       <section id="access-pci-bus">
@@ -131,7 +129,7 @@ Hello from Docker!</programlisting>
         container if the <literal>--privileged</literal> flag is passed to the
         command line:</para>
 
-        <programlisting>&gt;docker run --privileged -it el7guest /bin/bash</programlisting>
+        <programlisting>docker run --privileged -it el7guest /bin/bash</programlisting>
       </section>
     </section>
   </section>
diff --git a/doc/book-enea-nfv-access-platform-guide/doc/dpdk.xml b/doc/book-enea-nfv-access-platform-guide/doc/dpdk.xml
index 91b36d3..e96dd80 100644
--- a/doc/book-enea-nfv-access-platform-guide/doc/dpdk.xml
+++ b/doc/book-enea-nfv-access-platform-guide/doc/dpdk.xml
@@ -94,7 +94,8 @@ mount -t hugetlbfs nodev /mnt/huge</programlisting>
       <listitem>
         <para>On board 1, start the Pktgen application:</para>
 
-        <programlisting>cd /usr/share/apps/pktgen/./pktgen -c 0x7 -n 4 --socket-mem 1024 -- -P -m "[1:2].0"</programlisting>
+        <programlisting>cd /usr/share/apps/pktgen/
+./pktgen -c 0x7 -n 4 --socket-mem 1024 -- -P -m "[1:2].0"</programlisting>
 
         <para>In the Pktgen console, run:</para>
 
diff --git a/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml
index aa0dcb5..913ba81 100644
--- a/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml
+++ b/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml
@@ -85,7 +85,9 @@
 -- rmc.db
    /* Central RMC Database */
 -- systemd-bootx64.efi
-   /* systemd-boot EFI file */</programlisting>
+   /* systemd-boot EFI file */
+-- grub-efi-bootx64.efi
+   /* GRUB EFI file */</programlisting>
   </section>
 
   <section id="docs">
@@ -171,7 +173,7 @@ label el_ramfs
       the Ethernet interface used for PXE boot. From the PXE Boot Menu select
       <emphasis role="bold">Enea Linux_RAMfs</emphasis>. Once the Enea NFV
       Access Platform is started you can partition the HDD/SDD and install
-      GRUB as described in in the following section.s</para>
+      GRUB as described in in the following section.</para>
     </section>
 
     <section id="install-grub">
@@ -187,9 +189,10 @@ label el_ramfs
         </listitem>
 
         <listitem>
-          <para><literal>e2fsprogs-mke2fs_1.43.4-r0.0_amd64.deb,
-          dosfstools_4.1-r0.0_amd64.deb</literal> - available under
-          <literal>inteld1521/deb</literal>.</para>
+          <para><literal>e2fsprogs-mke2fs_1.43.4-r0.0_amd64.deb,/</literal></para>
+
+          <para><literal>dosfstools_4.1-r0.0_amd64.deb</literal> - available
+          under <literal>inteld1521/deb</literal>.</para>
         </listitem>
       </itemizedlist>
 
diff --git a/doc/book-enea-nfv-access-platform-guide/doc/hypervisor_virtualization.xml b/doc/book-enea-nfv-access-platform-guide/doc/hypervisor_virtualization.xml
index 6242de4..f7f186c 100644
--- a/doc/book-enea-nfv-access-platform-guide/doc/hypervisor_virtualization.xml
+++ b/doc/book-enea-nfv-access-platform-guide/doc/hypervisor_virtualization.xml
@@ -440,8 +440,8 @@ $ testpmd -c 0x7 -- -i --rxq=2 --txq=2 --nb-cores=2 ...</programlisting>
       containers by referencing the network in the guest XML file. It is
       possible to have a virtual network persistently running on the host by
       starting the network with command <command>virsh net-define</command>
-      instead of the previously mentioned <command>virsh net-create</command>.
-      </para>
+      instead of the previously mentioned <command>virsh
+      net-create</command>.</para>
 
       <para>An example for the sample network defined in
       <literal>meta-vt/recipes-example/virt-example/files/example-net.xml</literal>:</para>
@@ -462,17 +462,17 @@ $ testpmd -c 0x7 -- -i --rxq=2 --txq=2 --nb-cores=2 ...</programlisting>
     &lt;/interface&gt;</programlisting>
 
       <para>The following presented here are a few modes of network access
-      from guest using virsh:</para>
+      from guest using <command>virsh</command>:</para>
 
       <itemizedlist>
         <listitem>
           <para><emphasis role="bold">vhost-user interface</emphasis></para>
 
-          <para>See Openvswitch chapter on how to create vhost-user interface
-          using OpenVSwitch. Currently there is no Open vSwitch support for
-          networks that are managed by libvirt (e.g. NAT). As of now, only
-          bridged networks are supported (those where the user has to manually
-          create the bridge).</para>
+          <para>See the Open vSwitch chapter on how to create vhost-user
+          interface using Open vSwitch. Currently there is no Open vSwitch
+          support for networks that are managed by libvirt (e.g. NAT). As of
+          now, only bridged networks are supported (those where the user has
+          to manually create the bridge).</para>
 
           <programlisting>    &lt;interface type='vhostuser'&gt;
       &lt;mac address='00:00:00:00:00:01'/&gt;