Add ligato test results
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 782fa42..34d943e 100644 (file)
@@ -6,18 +6,18 @@ Changes in CSIT |release|
 \r
 #. Test environment changes in VPP data plane performance tests:\r
 \r
-   - Further characterization and optimizations of VPP vhost-user and VM\r
-     test methodology and test environment;\r
+   - Further characterization and optimizations of VPP vhost-user and VM test\r
+     methodology and test environment;\r
 \r
      - Tests with varying Qemu virtio queue (a.k.a. vring) sizes:\r
        [vr256] default 256 descriptors, [vr1024] 1024 descriptors to\r
        optimize for packet throughput;\r
 \r
-     - Tests with varying Linux CFS (Completely Fair Scheduler)\r
-       settings: [cfs] default settings, [cfsrr1] CFS RoundRobin(1)\r
-       policy applied to all data plane threads handling test packet\r
-       path including all VPP worker threads and all Qemu testpmd\r
-       poll-mode threads;\r
+     - Tests with varying Linux :abbr:`CFS (Completely Fair Scheduler)`\r
+       settings: [cfs] default settings, [cfsrr1] :abbr:`CFS (Completely Fair\r
+       Scheduler)` RoundRobin(1) policy applied to all data plane threads\r
+       handling test packet path including all VPP worker threads and all Qemu\r
+       testpmd poll-mode threads;\r
 \r
      - Resulting test cases are all combinations with [vr256,vr1024] and\r
        [cfs,cfsrr1] settings;\r
@@ -28,11 +28,11 @@ Changes in CSIT |release|
 #. Code updates and optimizations in CSIT performance framework:\r
 \r
    - Complete CSIT framework code revision and optimizations as descried\r
-     on CSIT wiki page\r
-     `Design_Optimizations <https://wiki.fd.io/view/CSIT/Design_Optimizations>`_.\r
+     on CSIT wiki page `Design_Optimizations\r
+     <https://wiki.fd.io/view/CSIT/Design_Optimizations>`_.\r
 \r
-   - For more detail see the CSIT Framework Design section in this\r
-     report;\r
+   - For more detail see the :ref:`CSIT Framework Design <csit-design>` section\r
+     in this report;\r
 \r
 #. Changes to CSIT driver for TRex Traffic Generator:\r
 \r
@@ -85,66 +85,153 @@ Changes in CSIT |release|
 Performance Improvements\r
 ------------------------\r
 \r
-Substantial improvements in measured packet throughput have been\r
-observed in a number of CSIT |release| tests listed below, with relative\r
-increase  of double-digit percentage points. Relative improvements for\r
-this release are calculated against the test results listed in CSIT\r
-|release-1| report. The comparison is calculated between the mean values\r
-based on collected and archived test results' samples for involved VPP\r
-releases. Standard deviation has been also listed for CSIT |release|.\r
-VPP-16.09 and VPP-17.01 numbers are provided for reference.\r
+Substantial improvements in measured packet throughput have been observed in a\r
+number of CSIT |release| tests listed below, with relative increase of\r
+double-digit percentage points. Relative improvements for this release are\r
+calculated against the test results listed in CSIT |release-1| report. The\r
+comparison is calculated between the mean values based on collected and\r
+archived test results' samples for involved VPP releases. Standard deviation\r
+has been also listed for CSIT |release|. VPP-16.09 and VPP-17.01 numbers are\r
+provided for reference.\r
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Non-Drop Rate Throughput discovery tests:\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/ndr_throughput.csv\r
+.. only:: html\r
+\r
+   .. csv-table::\r
+      :align: center\r
+      :file: performance_improvements/performance_improvements_ndr_top.csv\r
+\r
+.. only:: latex\r
+\r
+   .. raw:: latex\r
+\r
+      \makeatletter\r
+      \csvset{\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{5cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+      }\r
+      \makeatother\r
+\r
+      {\tiny\r
+      \csvautobooklongtable[separator=comma,\r
+        respect all,\r
+        no check column count,\r
+        perfimprovements column width=1cm,\r
+        late after line={\\\hline},\r
+        late after last line={\end{longtable}}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_ndr_top.csv}\r
+      }\r
+\r
 \r
 PDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/pdr_throughput.csv\r
+.. only:: html\r
+\r
+   .. csv-table::\r
+      :align: center\r
+      :file: performance_improvements/performance_improvements_pdr_top.csv\r
+\r
+.. only:: latex\r
+\r
+   .. raw:: latex\r
+\r
+      \makeatletter\r
+      \csvset{\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{5cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+      }\r
+      \makeatother\r
+\r
+      {\tiny\r
+      \csvautobooklongtable[separator=comma,\r
+        respect all,\r
+        no check column count,\r
+        perfimprovements column width=1cm,\r
+        late after line={\\\hline},\r
+        late after last line={\end{longtable}}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_pdr_top.csv}\r
+      }\r
+\r
 \r
 Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-17.07 release notes\r
-<https://docs.fd.io/vpp/17.07/release_notes_1707.html>`_.\r
+`VPP-17.10 release notes\r
+<https://docs.fd.io/vpp/17.10/release_notes_1710.html>`_.\r
 \r
 Other Performance Changes\r
 -------------------------\r
 \r
-Other changes in measured packet throughput, with either minor relative\r
-increase or decrease, have been observed in a number of CSIT |release|\r
-tests listed below. Relative changes are calculated against the test\r
-results listed in CSIT |release-1| report.\r
+Other changes in measured packet throughput, with either minor relative increase\r
+or decrease, have been observed in a number of CSIT |release| tests listed\r
+below. Relative changes are calculated against the test results listed in CSIT\r
+|release-1| report.\r
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Non-Drop Rate Throughput discovery tests:\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/ndr_throughput_others.csv\r
+.. only:: html\r
+\r
+   .. csv-table::\r
+      :align: center\r
+      :file: performance_improvements/performance_improvements_ndr_low.csv\r
+\r
+.. only:: latex\r
+\r
+   .. raw:: latex\r
+\r
+      \makeatletter\r
+      \csvset{\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{5cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+      }\r
+      \makeatother\r
+\r
+      {\tiny\r
+      \csvautobooklongtable[separator=comma,\r
+        respect all,\r
+        no check column count,\r
+        perfimprovements column width=1cm,\r
+        late after line={\\\hline},\r
+        late after last line={\end{longtable}}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_ndr_low.csv}\r
+      }\r
+\r
 \r
 PDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/pdr_throughput_others.csv\r
+.. only:: html\r
+\r
+   .. csv-table::\r
+      :align: center\r
+      :file: performance_improvements/performance_improvements_pdr_low.csv\r
+\r
+.. only:: latex\r
+\r
+   .. raw:: latex\r
+\r
+      \makeatletter\r
+      \csvset{\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{5cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+      }\r
+      \makeatother\r
+\r
+      {\tiny\r
+      \csvautobooklongtable[separator=comma,\r
+        respect all,\r
+        no check column count,\r
+        perfimprovements column width=1cm,\r
+        late after line={\\\hline},\r
+        late after last line={\end{longtable}}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_pdr_low.csv}\r
+      }\r
 \r
 \r
 Known Issues\r
@@ -155,27 +242,17 @@ Here is the list of known issues in CSIT |release| for VPP performance tests:
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
 | # | Issue                                           | Jira ID    | Description                                                     |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 1 | Security-groups acl-plugin scale tests failure  | CSIT-xxx   | VPP with 2 worker threads crashes during security-groups        |\r
-|   | with stateful acls if VPP with 2 worker threads | VPP-912    | iaclNsf and oaclNsf tests with 100k flows.                      |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 2 | VPP fails memif tests in 4 worker 2 core setup  | CSIT-xxx   | VPP with 4 worker threads running on 2 physical cores crashes   |\r
-|   |                                                 | VPP-xxx    | during memif tests. Initial debugging points to DPDK code       |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| X | NDR discovery test failures 1518B frame size    | VPP-663    | VPP reporting errors: dpdk-input Rx ip checksum errors.         |\r
-|   | for ip4scale200k, ip4scale2m scale IPv4 routed- |            | Observed frequency: all test runs.                              |\r
-|   | forwarding tests. ip4scale20k tests are fine.   |            |                                                                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| X | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
+| 1 | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
 |   |                                                 |            |                                                                 |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| X | Sporadic NDR discovery test failures on x520.   | CSIT-750   | Suspected issue with HW settings (BIOS, FW) in LF               |\r
+| 2 | Sporadic NDR discovery test failures on x520.   | CSIT-750   | Suspected issue with HW settings (BIOS, FW) in LF               |\r
 |   |                                                 |            | infrastructure. Issue can't be replicated outside LF.           |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| X | VPP in 2t2c setups - large variation            | CSIT-568   | Suspected NIC firmware or DPDK driver issue affecting NDR       |\r
+| 3 | VPP in 2t2c setups - large variation            | CSIT-568   | Suspected NIC firmware or DPDK driver issue affecting NDR       |\r
 |   | of discovered NDR throughput values across      |            | throughput. Applies to XL710 and X710 NICs, x520 NICs are fine. |\r
 |   | multiple test runs with xl710 and x710 NICs.    |            |                                                                 |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| X | Lower than expected NDR and PDR throughput with | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
+| 4 | Lower than expected NDR and PDR throughput with | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
 |   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
 \r