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   - **MRR Throughput**: MRR (Maximum Receive Rate) test code has now
  10     configurable trial duration and number of consecutive executions.
  11     Coverage of MRR tests has been extended across more test
  12     scenarios. MRR tests are used for continuous performance trending
  13     and for comparison between VPP releases.
  14
  15   - **MLRsearch Throughput**: MLRsearch algorithm has been introduced
  16     for all NDR and PDR throughput tests. All tests that previously
  17     used binary search got converted to MLRsearch. Coverage of NDR/PDR
  18     tests has been extended across more test scenarios.
  19
  20   - **L2patch Tests**: Tests measure performance of VPP L2patch, the
  21     fastest L2 forwarding path implemented in VPP, that cross-links
  22     RX and TX of two physical interfaces.
  23
  24   - **2-Node Tests**: A new baseline set of 2-node tests covering base
  25     ip4, ip6, l2patch, l2bd, l2xc, running on new Xeon Skylake
  26     testbeds.
  27
  28   - **Generated tests**: Simplified and unified test structure, semi-
  29     autogenerated by generator script. Test generator is currently
  30     able to create test combinations with various frame size and
  31     cores combinations. All existing test cases were converted to new
  32     format.
  33
  34   - **Simultaneous Multi-Threading**: SMT-aware detection of server
  35     processor operation mode (HyperThreading enabled/disabled) with
  36     associated compute resource configuration including thread
  37     affinity, number of Rx queues and DPDK I/O mbufs. Tests are
  38     automatically tagged during execution to indicate executed thread
  39     configuration.
  40
  41   - **Intel Xeon Skylake Support**: Support for 2-Node and 3-Node
  42     physical testbed topologies based on the new SuperMirco servers
  43     each with two Intel Xeon Skylake Platinum processors. Full
  44     Ansible playbooks refactor for quick server (re)installation and
  45     reference pointers of configuration.
  46
  47 #. **Presentation and Analytics Layer**
  48
  49   - **Performance trending**: Further improved continuous performance
  50     trending with anomaly detection and analysis.
  51
  52 #. **Test Framework Optimizations**
  53
  54   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
  55     removal of redundant RF keywords.
  56
  57 Performance Changes
  58 -------------------
  59
  60 Relative performance changes in measured NDR, PDR and MRR packet
  61 throughput in |csit-release| are calculated against the test results
  62 from |csit-release-1| report, for tests running on 3-Node Intel Xeon
  63 Haswell testbeds (3n-hsw) in 1-core, 2-core and 4-core (MRR only)
  64 configurations.
  65
  66 Listed mean and standard deviation values are computed based on a series
  67 of the same tests executed against respective VPP releases to verify
  68 test results repeatability, with percentage change calculated for mean
  69 values. Note that the standard deviation is quite high for a small
  70 number of packet throughput tests, what indicates poor test results
  71 repeatability and makes the relative change of mean throughput value not
  72 fully representative for these tests. The root causes behind poor
  73 results repeatability vary between the test cases.
  74
  75 NDR Changes
  76 ~~~~~~~~~~~
  77
  78 NDR throughput changes between releases are available in CSV and pretty
  79 ASCII formats:
  80
  81   - `CSV 1t1c NDR changes <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
  82   - `CSV 2t2c NDR changes <../_static/vpp/performance-changes-2t2c-ndr.csv>`_,
  83   - `ASCII 1t1c NDR changes <../_static/vpp/performance-changes-1t1c-ndr.txt>`_,
  84   - `ASCII 2t2c NDR changes <../_static/vpp/performance-changes-2t2c-ndr.txt>`_.
  85
  86 .. note::
  87
  88     Test results have been generated by
  89     `FD.io test executor vpp performance job 3n-hsw`_,
  90     with RF result
  91     files csit-vpp-perf-|srelease|-\*.zip
  92     `archived here <../_static/archive/>`_.
  93
  94 PDR Changes
  95 ~~~~~~~~~~~
  96
  97 PDR throughput changes between releases are available in CSV and pretty
  98 ASCII formats:
  99
 100   - `CSV 1t1c PDR changes <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
 101   - `CSV 2t2c PDR changes <../_static/vpp/performance-changes-2t2c-pdr.csv>`_,
 102   - `ASCII 1t1c PDR changes <../_static/vpp/performance-changes-1t1c-pdr.txt>`_,
 103   - `ASCII 2t2c PDR changes <../_static/vpp/performance-changes-2t2c-pdr.txt>`_.
 104
 105 .. note::
 106
 107     Test results have been generated by
 108     `FD.io test executor vpp performance job 3n-hsw`_,
 109     with RF result
 110     files csit-vpp-perf-|srelease|-\*.zip
 111     `archived here <../_static/archive/>`_.
 112
 113 MRR Changes
 114 ~~~~~~~~~~~
 115
 116 MRR throughput changes between releases are available in CSV and pretty
 117 ASCII formats:
 118
 119   - `CSV 1t1c MRR changes <../_static/vpp/performance-changes-1t1c-mrr.csv>`_,
 120   - `CSV 2t2c MRR changes <../_static/vpp/performance-changes-2t2c-mrr.csv>`_,
 121   - `CSV 4t4c MRR changes <../_static/vpp/performance-changes-4t4c-mrr.csv>`_,
 122   - `ASCII 1t1c MRR changes <../_static/vpp/performance-changes-1t1c-mrr.txt>`_,
 123   - `ASCII 2t2c MRR changes <../_static/vpp/performance-changes-2t2c-mrr.txt>`_,
 124   - `ASCII 4t4c MRR changes <../_static/vpp/performance-changes-4t4c-mrr.txt>`_.
 125
 126 .. note::
 127
 128     Test results have been generated by
 129     `FD.io test executor vpp performance job 3n-hsw`_,
 130     with RF result
 131     files csit-vpp-perf-|srelease|-\*.zip
 132     `archived here <../_static/archive/>`_.
 133
 134 Skx vs. Hsw Comparison
 135 ----------------------
 136
 137 Relative performance comparison in measured NDR, PDR and MRR packet
 138 throughput is calculated for tests executed on 3-Node Skylake (3n-skx)
 139 and 3-Node Haswell (3n-hsw) physical testbed types in 1-core
 140 configurations.
 141
 142 NDR Comparison
 143 ~~~~~~~~~~~~~~
 144
 145 NDR comparison between testbed types is available in CSV and pretty
 146 ASCII formats:
 147
 148   - `CSV 1c NDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
 149   - `ASCII 1c NDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
 150
 151 .. note::
 152
 153     Test results have been generated by
 154     `FD.io test executor vpp performance job 3n-hsw`_ and
 155     `FD.io test executor vpp performance job 3n-skx`_
 156     with RF result
 157     files csit-vpp-perf-|srelease|-\*.zip
 158     `archived here <../_static/archive/>`_.
 159
 160 PDR Comparison
 161 ~~~~~~~~~~~~~~
 162
 163 PDR comparison between testbed types is available in CSV and pretty
 164 ASCII formats:
 165
 166   - `CSV 1c PDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
 167   - `ASCII 1c PDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
 168
 169 .. note::
 170
 171     Test results have been generated by
 172     `FD.io test executor vpp performance job 3n-hsw`_ and
 173     `FD.io test executor vpp performance job 3n-skx`_
 174     with RF result
 175     files csit-vpp-perf-|srelease|-\*.zip
 176     `archived here <../_static/archive/>`_.
 177
 178 MRR Comparison
 179 ~~~~~~~~~~~~~~
 180
 181 MRR comparison between testbed types is available in CSV and pretty
 182 ASCII formats:
 183
 184   - `CSV 1c MRR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.csv>`_,
 185   - `ASCII 1c MRR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.txt>`_.
 186
 187 .. note::
 188
 189     Test results have been generated by
 190     `FD.io test executor vpp performance job 3n-hsw`_ and
 191     `FD.io test executor vpp performance job 3n-skx`_
 192     with RF result
 193     files csit-vpp-perf-|srelease|-\*.zip
 194     `archived here <../_static/archive/>`_.
 195
 196 Throughput Trending
 197 -------------------
 198
 199 In addition to reporting throughput changes between VPP releases, CSIT
 200 provides continuous performance trending for VPP master branch:
 201
 202 #. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_
 203    - per VPP test case throughput trend, trend compliance and summary of
 204    detected anomalies.
 205
 206 #. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_
 207    - throughput test metrics, trend calculations and anomaly
 208    classification (progression, regression, outlier).
 209
 210 #. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_
 211    - per VPP build MRR throughput measurements against the trendline
 212    with anomaly highlights, with associated CSIT test jobs.
 213
 214 Known Issues
 215 ------------
 216
 217 List of known issues in |csit-release| for VPP performance tests:
 218
 219 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
 220 | # | Issue                                           | Jira ID    | Description                                                     |
 221 +===+=================================================+============+=================================================================+
 222 | 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570   | DPDK reporting rx-errors, indicating L1 issue. Suspected issue  |
 223 |   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |
 224 |   |                                                 |            | outside of LF testbeds.                                         |
 225 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
 226 | 2 | High failure rate of api call                   | VPP-1361   | Failure rate: 30-40% of tests failing due to interfaces not     |
 227 |   | sw_interface_set_flags [admin-up|link-up]       |            | in link-up state after API call sw_interface_set_flags.         |
 228 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
 229 | 3 | Scale IPSecHW Interface mode throughput         | CSIT-1234  | IPSec throughput regression: NDR -28%..-31%, PDR -28%..-31%,    |
 230 |   | regression.                                     |            | MRR -40%. Affects IPSec HW Scale 1000tnl tests with Int mode.   |
 231 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+