Update perf release notes 1904
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 4c942e1..7a8bf9b 100644 (file)
-CSIT Release Notes\r
-==================\r
-\r
-Changes in CSIT |release|\r
--------------------------\r
-\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
-\r
-#. Added tests\r
-\r
-    - NICs\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
-\r
-    - vhost-user tests with VM\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
-\r
-    - Tests with VxLAN\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
-\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
-\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
-\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
-\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
-\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
-\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
-\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
-\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
+Release Notes
+=============
+
+Changes in |csit-release|
+-------------------------
+
+#. VPP PERFORMANCE TESTS
+
+   - **Service density 2n-skx tests**: Added higher NF density tests with two
+     NFs' data-plane threads sharing a physical core. VPP IPv4 routing is now
+     used as a VNF payload similar to CNF tests.
+
+   - **Soak Tests**: Optimized performamce soak tests framework
+     code for extended time duration tests and throughput discovery
+     at given PLR and at give total test time e.g. minutes, hours,
+     days, weeks. See updated
+     :ref:`test_methodology` section for more details.
+
+#. TEST FRAMEWORK
+
+   - **Qemu code refactor**: Complete code refactor of the key components of
+     QemuUtil.py and QemuManager.py (L1 and L2 KW counterparts). Added
+     implementation of kernel-image-kvm based VM replacing the previously used
+     NestedVM images. Added ability to run VPP as a payload in VNF.
+
+   - **CSIT PAPI Support**: Continued conversion of CSIT VAT L1 keywords to
+     PAPI L1 KWs in CSIT using VPP Python bindings. Redesign of key components
+     of PAPI Executor and PAPI history.
+
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+     removal of redundant RF keywords.
+
+   - **Test suite generator**: Added capability to generate suites for
+     different NIC models as well as throughput search algorithm types. Uses
+     base tests suites as source.
+
+   - **TOX verification**: Added verifications for test suite generator.
+
+#. PRESENTATION AND ANALYTICS LAYER
+
+   - **Graphs Layout Improvements**: Improved performance graphs layout
+     for better readibility and maintenance: test grouping, axis
+     labels, descriptions, other informative decoration.
+
+..
+    #. MISCELLANEOUS
+
+       - **2n-dnv Tests (3rd Party)**: Published performance tests for 2n-
+         dnv (2-Node Atom Denverton) from 3rd party testbeds running FD.io
+         |csit-release| automated testing code.
+         Only graphs for Packet Throughput and Speedup Multi-core and not
+         for Packet Latency were published as there are no results for Packet
+         Latency available.
+
+.. raw:: latex
+
+    \clearpage
+
+.. _vpp_known_issues:
+
+Known Issues
+------------
+
+List of known issues in |csit-release| for VPP performance tests:
+
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                        |
++====+=========================================+==========================================================================================================+
+| 1  | `CSIT-570                               | Sporadic (1 in 200) NDR discovery test failures on x520. DPDK reporting rx-errors, indicating L1 issue.  |
+|    | <https://jira.fd.io/browse/CSIT-570>`_  | Suspected issue with HW combination of X710-X520 in LF testbeds. Not observed outside of LF testbeds.    |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 2  | `CSIT-1503                              | [`TRex-519 <https://trex-tgn.cisco.com/youtrack/issue/trex-519>`_] XL710/XXV710 with FW 6.0.1 will have  |
+|    | <https://jira.fd.io/browse/CSIT-1503>`_ | Rx drop rate of 27MPPS.                                                                                  |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 3  | `CSIT-1501                              | Sporadic crypto backend fails loading `VPP-1670 <https://jira.fd.io/browse/VPP-1670>`_                   |
+|    | <https://jira.fd.io/browse/CSIT-1501>`_ |                                                                                                          |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 4  | `CSIT-1427                              | Sporadic HW aes-128-cbc-sha1 tunnel-interface tests are failing.                                         |
+|    | <https://jira.fd.io/browse/CSIT-1427>`_ | `VPP-1671 <https://jira.fd.io/browse/VPP-1671>`_                                                         |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 5  | `CSIT-1498                              | Memif tests are sporadically failing on initialization of memif connection.                              |
+|    | <https://jira.fd.io/browse/CSIT-1498>`_ |                                                                                                          |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 6  | `CSIT-1499                              | AVF tests are sporadically failing on initialization of AVF interface.                                   |
+|    | <https://jira.fd.io/browse/CSIT-1499>`_ |                                                                                                          |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+