CSIT-725: Use csv files for performance improvments table
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 4c942e1..0a5d25e 100644 (file)
@@ -6,203 +6,120 @@ Changes in CSIT |release|
 \r
 #. VPP performance test environment changes\r
 \r
-    - further VM and vhost-user test environment optimizations - Qemu virtio queue size increased from default value of 256 to 1024\r
-    - addition of HW cryptodev devices in all three LF FD.io physical testbeds\r
+   - Further optimizations of VM and vhost-user test environment - various\r
+     Qemu virtio queue size testing with value of 256 and 1024. Applied\r
+     Linux CFS optimization to run VPP worker threads and Qemu worker threads\r
+     with highest priority.\r
 \r
-#. Added tests\r
+#. VPP performance test framework changes\r
 \r
-    - NICs\r
+   - Full code review, optimization and refactor.\r
 \r
-      - Intel x710 (L2 Bridge Domain switched-forwarding, vhost-user)\r
-      - Cisco VIC1385 (L2 Bridge Domain switched-forwarding)\r
-      - Cisco VIC1227 (L2 Bridge Domain switched-forwarding)\r
+#. T-rex changes\r
 \r
-    - vhost-user tests with VM\r
+   - Full refactor of T-rex driver and introduce of traffic profiles that\r
+     improves readability, manageability of traffic profiles for various\r
+     test scenarios.\r
 \r
-      - L2 Bridge Domain switched-forwarding with Intel x710 NIC\r
-      - L2 Bridge Domain switched-forwarding with VxLAN and Intel x520 NIC\r
-      - L2 Bridge Domain switched-forwarding with Intel xl710 NIC\r
+#. Added VPP performance tests\r
 \r
-    - Tests with VxLAN\r
+   - **LXC memif**\r
 \r
-      - L2 Bridge Domain switched-forwarding with Intel x520 NIC\r
-      - L2 Bridge Domain switched-forwarding with vhost-user, VM and Intel x520\r
-        NIC\r
+     - Memif interface tests interconnecting two VPP instances on single SUT.\r
+       Master VPP instance running on native OS with Intel x520 NIC and guest\r
+       VPP instance running in Linux Container (LXC) doing the L2 cross\r
+       connect loop. LXC running in privileged mode is pinned to dedicated\r
+       cores. All VPP instances are same version.\r
+\r
+   - **Stateful Security Groups**\r
+\r
+   - **VM vhost use cases**\r
 \r
 Performance Improvements\r
 ------------------------\r
 \r
-Substantial improvements in measured packet throughput, with relative increase\r
-of double-digit percentage points, have been observed in a number of CSIT\r
-|release| tests listed below. Relative improvements are calculated against the\r
-test results in CSIT rls1701 report.\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 are\r
+calculated against the test results listed in CSIT |release-1| report.\r
+VPP-16.09 numbers are provided for reference.\r
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Non-Drop Rate Throughput discovery tests:\r
 \r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01       | Relative Improvement |\r
-+===================+=================================================================+===========+=================+======================+\r
-| L2XC              | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-ndrdisc                      | 9.4 Mpps  | 12.7 Mpps       | 35%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC              | 10ge2p1xl710: 64B-1t1c-eth-l2xcbase-ndrdisc                     | 9.5 Mpps  | 12.2..12.4 Mpps | 28..30%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC dot1ad       | 10ge2p1x520: 64B-1t1c-dot1ad-l2xcbase-ndrdisc                   | 7.4 Mpps  | 8.8..9.0 Mpps   | 19..23%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC dot1q        | 10ge2p1x520: 64B-1t1c-dot1q-l2xcbase-ndrdisc                    | 7.5 Mpps  | 8.8..9.0 Mpps   | 17..20%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC VxLAN        | 10ge2p1x520: 64B-1t1c-ethip4vxlan-l2xcbase-ndrdisc              | 5.4 Mpps  | 6.5 Mpps        | 20%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-eth-2vhost-1vm-ndrdisc       | 0.5 Mpps  | 2.8..3.2 Mpps   | 460..540%            |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2BD              | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-ndrdisc                | 7.8 Mpps  | 10.4..10.6 Mpps | 33..36%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2BD-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc | 0.4 Mpps  | 2.7..2.8 Mpps   | 575..600%            |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4              | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-ndrdisc                    | 8.7 Mpps  | 9.7 Mpps        | 12%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 COP          | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-copwhtlistbase-ndrdisc     | 7.1 Mpps  | 8.3..8.5 Mpps   | 17..20%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 iAcl         | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-iacldstbase-ndrdisc        | 6.9 Mpps  | 7.6..7.8 Mpps   | 10..13%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 vhost        | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-eth-2vhost-1vm-ndrdisc     | 0.3 Mpps  | 2.6 Mpps        | 767%                 |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6              | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-ndrdisc                    | 3.0 Mpps  | 7.3..7.7 Mpps   | 143..157%            |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
+.. csv-table::\r
+    :align: center\r
+    :header-rows: 1\r
+    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/ndr_throughput.csv\r
 \r
 PDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
 \r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01       | Relative Improvement |\r
-+===================+=================================================================+===========+=================+======================+\r
-| L2XC              | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-pdrdisc                      | 9.4 Mpps  | 12.7..12.9 Mpps | 35..37%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC dot1ad       | 10ge2p1x520: 64B-1t1c-dot1ad-l2xcbase-pdrdisc                   | 7.4 Mpps  | 8.8..9.1 Mpps   | 19..23%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC dot1q        | 10ge2p1x520: 64B-1t1c-dot1q-l2xcbase-pdrdisc                    | 7.5 Mpps  | 8.8..9.0 Mpps   | 17..20%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC VxLAN        | 10ge2p1x520: 64B-1t1c-ethip4vxlan-l2xcbase-pdrdisc              | 5.4 Mpps  | 6.5 Mpps        | 20%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2XC-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-eth-2vhost-1vm-pdrdisc       | 2.6 Mpps  | 3.2..3.3 Mpps   | 23..26%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2BD              | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-pdrdisc                | 7.8 Mpps  | 10.6 Mpps       | 36%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| L2BD-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-eth-2vhost-1vm-pdrdisc | 2.1 Mpps  | 2.9 Mpps        | 38%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4              | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-pdrdisc                    | 8.7 Mpps  | 9.7 Mpps        | 11%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 COP          | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-copwhtlistbase-pdrdisc     | 7.1 Mpps  | 8.3..8.5 Mpps   | 17..20%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 vhost        | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-eth-2vhost-1vm-pdrdisc     | 2.0 Mpps  | 2.7 Mpps        | 35%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
+.. csv-table::\r
+    :align: center\r
+    :header-rows: 1\r
+    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/pdr_throughput.csv\r
 \r
 Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-17.01 release notes\r
-<https://docs.fd.io/vpp/17.01/release_notes_1701.html>`_.\r
-\r
-Additionally, vhost-VM performance improvements are due to both VPP code\r
-optimizations as well as due to the FD.io CSIT Linux KVM test environment\r
-optimizations for vhost-VM tests - see section "2.1.7. Methodology: KVM VM\r
-vhost".\r
-\r
+`VPP-17.07 release notes\r
+<https://docs.fd.io/vpp/17.07/release_notes_1707.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| tests\r
-listed below. Relative changes are calculated against the test results in CSIT\r
-rls1701 report.\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
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Non-Drop Rate Throughput discovery tests:\r
 \r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01       | Relative Change      |\r
-+===================+=================================================================+===========+=================+======================+\r
-| IPv4 FIB 200k     | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale200k-ndrdisc               | 8.5 Mpps  | 9.0 Mpps        | 6%                   |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 FIB 20k      | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale20k-ndrdisc                | 8.5 Mpps  | 9.0..9.2 Mpps   | 6..8%                |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 FIB 2M       | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale2m-ndrdisc                 | 8.5 Mpps  | 7.8..8.1 Mpps   | -8..-5%              |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 Policer      | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-ipolicemarkbase-ndrdisc    | 6.9 Mpps  | 7.4..7.6 Mpps   | 7..10%               |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 LISP         | 10ge2p1x520: 64B-1t1c-ethip4lispip4-ip4base-ndrdisc             | 4.4 Mpps  | 4.8 Mpps        | 9%                   |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 COP          | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-copwhtlistbase-ndrdisc     | 6.1 Mpps  | 6.1..6.5 Mpps   | 0..7%                |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 FIB 200k     | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale200k-ndrdisc               | 6.5 Mpps  | 5.3..5.7 Mpps   | -18..-12%            |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 FIB 20k      | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale20k-ndrdisc                | 6.9 Mpps  | 6.5 Mpps        | -6%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 FIB 2M       | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale2m-ndrdisc                 | 5.3 Mpps  | 4.2 Mpps        | -21%                 |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 iAcl         | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-iacldstbase-ndrdisc        | 6.5 Mpps  | 6.1..6.5 Mpps   | -6..0%               |\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
 \r
 PDR Throughput\r
 ~~~~~~~~~~~~~~\r
 \r
 Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
 \r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01       | Relative Change      |\r
-+===================+=================================================================+===========+=================+======================+\r
-| IPv4 FIB 200k     | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale200k-pdrdisc               | 8.5 Mpps  | 9.0 Mpps        | 6%                   |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 FIB 20k      | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale20k-pdrdisc                | 8.5 Mpps  | 9.0..9.2 Mpps   | 6..8%                |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 FIB 2M       | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale2m-pdrdisc                 | 8.3 Mpps  | 8.1 Mpps        | -2%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 iAcl         | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-iacldstbase-pdrdisc        | 7.1 Mpps  | 7.6..7.8 Mpps   | 7..10%               |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 Policer      | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-ipolicemarkbase-pdrdisc    | 7.1 Mpps  | 7.4..7.6 Mpps   | 4..7%                |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv4 LISP         | 10ge2p1x520: 64B-1t1c-ethip4lispip4-ip4base-pdrdisc             | 4.6 Mpps  | 4.8 Mpps        | 9%                   |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6              | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-pdrdisc                    | 7.7 Mpps  | 7.3..7.7 Mpps   | -5..0%               |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 COP          | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-copwhtlistbase-pdrdisc     | 6.1 Mpps  | 6.1..6.5 Mpps   | 0..7%                |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 FIB 200k     | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale200k-pdrdisc               | 6.9 Mpps  | 5.3..5.7 Mpps   | -23..-17%            |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 FIB 20k      | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale20k-pdrdisc                | 6.9 Mpps  | 6.5 Mpps        | -6%                  |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 FIB 2M       | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale2m-pdrdisc                 | 5.3 Mpps  | 4.2 Mpps        | -21%                 |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------------+----------------------+\r
-| IPv6 iAcl         | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-iacldstbase-pdrdisc        | 6.5 Mpps  | 6.1..6.5 Mpps   | -6..0%               |\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
+\r
 \r
 Known Issues\r
 ------------\r
 \r
 Here is the list of known issues in CSIT |release| for VPP performance tests:\r
 \r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| # | Issue                                           | Description                                                     |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 1 | Sporadic IPv4 routed-forwarding NDR discovery   | Suspected issue with DPDK IPv4 checksum calculation.            |\r
-|   | test failures for 1518B frame size              | Observed frequency: sporadic, ca. 20% to 30% of test runs.      |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 2 | Vic1385 and Vic1227 NICs jumbo frames test      | Suspected issue with VIC DPDK drivers that do not support jumbo |\r
-|   | failures (9000B)                                | frames (dropped rx-miss). Observed frequency: 100%.             |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 3 | Vic1385 and Vic1227 performance                 | Low performance of NDR results. Big difference between NDR and  |\r
-|   |                                                 | PDR.                                  .                         |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 4 | Sporadic NDR discovery test failures on x520    | Suspected issue with HW settings (BIOS, FW) in LF               |\r
-|   |                                                 | infrastructure. Issue can't be replicated outside LF.           |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 5 | Non-repeatible zig-zagging NDR throughput       | Suspected NIC driver issue in multi-thread multi-core operation |\r
-|   | results for multi-thread multi-core tests       | affectin NDR throughput. Applies to XL710 and X710 NICs tested. |\r
-|   | - 2t2c, 4t4c - for some tested NICs.            |                                                                 |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
++---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
+| # | Issue                                           | Jira ID    | Description                                                     |\r
++---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
+| 1 | 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
+| 2 | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
+|   |                                                 |            |                                                                 |\r
++---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
+| 3 | 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
+| 4 | 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
+| 5 | 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