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