Report: add geneve to perf release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
1 Release Notes
2 =============
3
4 Changes in |csit-release|
5 -------------------------
6
7 #. VPP PERFORMANCE TESTS
8
9    - CSIT test environment is versioned, see
10      :ref:`test_environment_versioning`.
11
12    - To identify performance changes due to VPP code changes from
13      v20.05.0 to v20.09.0, both have been tested in CSIT environment
14      ver. 5 and compared against each other. All substantial
15      progressions has been marked up with RCA analysis. See
16      :ref:`vpp_compare_current_vs_previous_release` and
17      :ref:`vpp_known_issues`.
18
19    - **GENEVE tests**: Added VPP performance tests for GENEVE tunnels.
20
21      - See :ref:`geneve_methodology` for more details.
22
23    - **NAT44 tests**: Adapted existing and added new tests.
24
25      - Refactored NAT44 deterministic mode (nat44det) tests to use separate
26        det44 vpp plugin and to use the same scheme of inside and outside
27        addresses and ports, as used in new NAT44 endpoint-dependent mode tests.
28
29      - Added new NAT44 endpoint-depended mode uni-directional (nat44ed-udir)
30        tests that measure packet throughput in one direction with usage of TRex
31        in stateless mode.
32
33      - Added new NAT44 endpoint-dependent mode CPS tests that measure
34        connections per second with usage of TRex in stateful mode.
35        UPD packet size is 64 bytes. Size of TCP control packets
36        is not configurable, please ignore the -64b- part of test names.
37
38      - Added new NAT44 endpoint-dependent mode PPS tests that measure
39        packets per second (control and data together) with usage of TRex
40        in stateful mode. UPD packet size is 64 bytes. Size of TCP
41        data packets is governed by the default MSS value, so most data packets
42        are 1460 bytes long, please ignore the -64b- part of test names.
43
44      - See :ref:`nat44_methodology` for more details.
45
46    - **IPSec async mode tests**: Added VPP performance tests for async crypto
47      engine.
48
49    - **AMD 2n-zn2 testbed**: New physical testbed type installed in
50      FD.io CSIT, with VPP and DPDK performance data added to CSIT
51      trending and this report.
52
53    - **AMD 2n-tx2 testbed**: New physical testbed type installed in
54      FD.io CSIT, with VPP and DPDK performance data added to CSIT
55      trending and this report.
56
57 #. TEST FRAMEWORK
58
59    - **TRex ASTF**: Added capability to run TRex in advanced stateful mode.
60
61    - **CSIT PAPI support**: Due to issues with PAPI performance, VAT is
62      still used in CSIT for all VPP scale tests. See known issues below.
63
64    - **General Code Housekeeping**: Ongoing RF keywords optimizations,
65      removal of redundant RF keywords and aligning of suite/test
66      setup/teardowns.
67
68    - **Intel E810CQ 100G NIC**: Added configuration for Intel E810CQ 100G NIC.
69      No tests run for this NIC as it is not present in FD.io CSIT lab yet.
70
71 #. PRESENTATION AND ANALYTICS LAYER
72
73    - **Graphs improvements**: Added possibility to use Gbps on Y-axis in
74      Packet Throughput and Speedup Multi-Core graphs, added unidirectional
75      mode to the Latency graphs.
76
77 .. raw:: latex
78
79     \clearpage
80
81 .. _vpp_known_issues:
82
83 Known Issues
84 ------------
85
86 List of known issues in |csit-release| for VPP performance tests:
87
88 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
89 | #  | JiraID                                  | Issue Description                                                                                         |
90 +====+=========================================+===========================================================================================================+
91 |  1 | `CSIT-570                               | Sporadic (1 in 200) NDR discovery test failures on x520. DPDK reporting rx-errors, indicating L1 issue.   |
92 |    | <https://jira.fd.io/browse/CSIT-570>`_  | Suspected issue with HW combination of X710-X520 in LF testbeds. Not observed outside of LF testbeds.     |
93 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
94 |  2 | `VPP-662                                | 9000B packets not supported by NICs VIC1227 and VIC1387.                                                  |
95 |    | <https://jira.fd.io/browse/VPP-662>`_   |                                                                                                           |
96 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
97 |  3 | `CSIT-1763                              | Adapt ramp-up phase of nat44 tests for different frame sizes.                                             |
98 |    | <https://jira.fd.io/browse/CSIT-1763>`_ | Currently ramp-up phase rate and duration values are correctly set for tests with 64B frame size.         |
99 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
100 |  4 | `CSIT-1671                              | All CSIT scale tests can not use PAPI due to much slower performance compared to VAT/CLI (it takes much   |
101 |    | <https://jira.fd.io/browse/CSIT-1671>`_ | longer to program VPP). This needs to be addressed on the PAPI side.                                      |
102 |    +-----------------------------------------+ The usual PAPI library spends too much time parsing arguments, so even with async processing (hundreds of |
103 |    | `VPP-1763                               | commands in flight over socket), the VPP configuration for large scale tests (millions of messages) takes |
104 |    | <https://jira.fd.io/browse/VPP-1763>`_  | too long.                                                                                                 |
105 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
106 |  5 | `CSIT-1771                              | IPv4 IPSEC 9000B packet tests had been failing when chained buffers were not supported.                   |
107 |    | <https://jira.fd.io/browse/CSIT-1771>`_ | This has been fixed on VPP side, but CSIT still needs to re-enable jumbo tests.                           |
108 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
109 |  6 | `VPP-1934                               | [i40e] Interfaces are not brought up from carrier-down.                                                   |
110 |    | <https://jira.fd.io/browse/VPP-1934>`_  | In case of i40e -based interface (e.g Intel x700 series NIC) is bound to kernel driver (i40e) and is in   |
111 |    |                                         | state "no-carrier" (<NO-CARRIER,BROADCAST,MULTICAST,UP>) because previously it was disabled via           |
112 |    |                                         | "I40E_AQ_PHY_LINK_ENABLED" call, then VPP during initialization of AVF interface is not re-enabling       |
113 |    |                                         | interface link via i40e driver to up.                                                                     |
114 |    |                                         | CSIT implemented `workaround for AVF interface <https://gerrit.fd.io/r/c/csit/+/29086>`_ until fixed.     |
115 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
116 |  7 | `CSIT-1760                              | All Mellanox / rdma driver tests are failing on LF testbed28 while successfully run on other LF testbeds. |
117 |    | <https://jira.fd.io/browse/CSIT-1760>`_ |                                                                                                           |
118 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
119
120 Root Cause Analysis for Performance Changes
121 -------------------------------------------
122
123 List of RCAs in |csit-release| for VPP performance changes:
124
125 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
126 | #  | JiraID                                  | Issue Description                                                                                         |
127 +====+=========================================+===========================================================================================================+
128 |  1 |                                         |                                                                                                           |
129 |    |                                         |                                                                                                           |
130 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+