Report-gen update
[csit.git] / docs / report / vpp_performance_tests / overview.rst
1 Overview
2 ========
3
4 Tested Physical Topologies
5 --------------------------
6
7 CSIT VPP performance tests are executed on physical baremetal servers hosted by
8 LF FD.io project. Testbed physical topology is shown in the figure below.
9
10 ::
11
12     +------------------------+           +------------------------+
13     |                        |           |                        |
14     |  +------------------+  |           |  +------------------+  |
15     |  |                  |  |           |  |                  |  |
16     |  |                  <----------------->                  |  |
17     |  |       DUT1       |  |           |  |       DUT2       |  |
18     |  +--^---------------+  |           |  +---------------^--+  |
19     |     |                  |           |                  |     |
20     |     |            SUT1  |           |  SUT2            |     |
21     +------------------------+           +------------------^-----+
22           |                                                 |
23           |                                                 |
24           |                  +-----------+                  |
25           |                  |           |                  |
26           +------------------>    TG     <------------------+
27                              |           |
28                              +-----------+
29
30 SUT1 and SUT2 are two System Under Test servers (Cisco UCS C240, each with two
31 Intel XEON CPUs), TG is a Traffic Generator (TG, another Cisco UCS C240, with
32 two Intel XEON CPUs). SUTs run VPP SW application in Linux user-mode as a
33 Device Under Test (DUT). TG runs TRex SW application as a packet Traffic
34 Generator. Physical connectivity between SUTs and to TG is provided using
35 different NIC models that need to be tested for performance. Currently
36 installed and tested NIC models include:
37
38 #. 2port10GE X520-DA2 Intel.
39 #. 2port10GE X710 Intel.
40 #. 2port10GE VIC1227 Cisco.
41 #. 2port40GE VIC1385 Cisco.
42 #. 2port40GE XL710 Intel.
43
44 From SUT and DUT perspective, all performance tests involve forwarding packets
45 between two physical Ethernet ports (10GE or 40GE). Due to the number of
46 listed NIC models tested and available PCI slot capacity in SUT servers, in
47 all of the above cases both physical ports are located on the same NIC. In
48 some test cases this results in measured packet throughput being limited not
49 by VPP DUT but by either the physical interface or the NIC capacity.
50
51 Going forward CSIT project will be looking to add more hardware into FD.io
52 performance labs to address larger scale multi-interface and multi-NIC
53 performance testing scenarios.
54
55 For test cases that require DUT (VPP) to communicate with VM(s) over vhost-user
56 interfaces, N of VM instances are created on SUT1 and SUT2. For N=1 DUT (VPP)
57 forwards packets between vhostuser and physical interfaces. For N>1 DUT (VPP) a
58 logical service chain forwarding topology is created on DUT (VPP) by applying L2
59 or IPv4/IPv6 configuration depending on the test suite.
60 DUT (VPP) test topology with N VM instances
61 is shown in the figure below including applicable packet flow thru the DUTs and
62 VMs (marked in the figure with ``***``).
63
64 ::
65
66     +-------------------------+           +-------------------------+
67     | +---------+ +---------+ |           | +---------+ +---------+ |
68     | |  VM[1]  | |  VM[N]  | |           | |  VM[1]  | |  VM[N]  | |
69     | |  *****  | |  *****  | |           | |  *****  | |  *****  | |
70     | +--^---^--+ +--^---^--+ |           | +--^---^--+ +--^---^--+ |
71     |   *|   |*     *|   |*   |           |   *|   |*     *|   |*   |
72     | +--v---v-------v---v--+ |           | +--v---v-------v---v--+ |
73     | |  *   *       *   *  |*|***********|*|  *   *       *   *  | |
74     | |  *   *********   ***<-|-----------|->***   *********   *  | |
75     | |  *    DUT1          | |           | |       DUT2       *  | |
76     | +--^------------------+ |           | +------------------^--+ |
77     |   *|                    |           |                    |*   |
78     |   *|            SUT1    |           |  SUT2              |*   |
79     +-------------------------+           +-------------------------+
80         *|                                                     |*
81         *|                                                     |*
82         *|                    +-----------+                    |*
83         *|                    |           |                    |*
84         *+-------------------->    TG     <--------------------+*
85         **********************|           |**********************
86                               +-----------+
87
88 For VM tests, packets are switched by DUT (VPP) multiple times: twice for a
89 single VM, three times for two VMs, N+1 times for N VMs.
90 Hence the external
91 throughput rates measured by TG and listed in this report must be multiplied
92 by (N+1) to represent the actual DUT aggregate packet forwarding rate.
93
94 Note that reported VPP performance results are specific to the SUTs tested.
95 Current LF FD.io SUTs are based on Intel XEON E5-2699v3 2.3GHz CPUs. SUTs with
96 other CPUs are likely to yield different results. A good rule of thumb, that
97 can be applied to estimate VPP packet thoughput for Phy-to-Phy (NIC-to-NIC,
98 PCI-to-PCI) topology, is to expect the forwarding performance to be
99 proportional to CPU core frequency, assuming CPU is the only limiting factor
100 and all other SUT parameters equivalent to FD.io CSIT environment. The same rule
101 of thumb can be also applied for Phy-to-VM-to-Phy (NIC-to-VM-to-NIC) topology,
102 but due to much higher dependency on intensive memory operations and
103 sensitivity to Linux kernel scheduler settings and behaviour, this estimation
104 may not always yield good enough accuracy.
105
106 For detailed LF FD.io test bed specification and physical topology please refer
107 to `LF FDio CSIT testbed wiki page <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed>`_.
108
109 Performance Tests Coverage
110 --------------------------
111
112 Performance tests are split into the two main categories:
113
114 - Throughput discovery - discovery of packet forwarding rate using binary search
115   in accordance to RFC2544.
116
117   - NDR - discovery of Non Drop Rate packet throughput, at zero packet loss;
118     followed by one-way packet latency measurements at 10%, 50% and 100% of
119     discovered NDR throughput.
120   - PDR - discovery of Partial Drop Rate, with specified non-zero packet loss
121     currently set to 0.5%; followed by one-way packet latency measurements at
122     100% of discovered PDR throughput.
123
124 - Throughput verification - verification of packet forwarding rate against
125   previously discovered throughput rate. These tests are currently done against
126   0.9 of reference NDR, with reference rates updated periodically.
127
128 CSIT |release| includes following performance test suites, listed per NIC type:
129
130 - 2port10GE X520-DA2 Intel
131
132   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged, dot1q, dot1ad
133     VLAN tagged Ethernet frames.
134   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
135     with MAC learning; disabled MAC learning i.e. static MAC tests to be added.
136   - **IPv4** - IPv4 routed-forwarding.
137   - **IPv6** - IPv6 routed-forwarding.
138   - **IPv4 Scale** - IPv4 routed-forwarding with 20k, 200k and 2M FIB entries.
139   - **IPv6 Scale** - IPv6 routed-forwarding with 20k, 200k and 2M FIB entries.
140   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
141     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
142     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
143   - **COP** - IPv4 and IPv6 routed-forwarding with COP address security.
144   - **iACL** - IPv4 and IPv6 routed-forwarding with iACL address security.
145   - **LISP** - LISP overlay tunneling for IPv4-over-IPv4, IPv6-over-IPv4,
146     IPv6-over-IPv6, IPv4-over-IPv6 in IPv4 and IPv6 routed-forwarding modes.
147   - **VXLAN** - VXLAN overlay tunnelling integration with L2XC and L2BD.
148   - **QoS Policer** - ingress packet rate measuring, marking and limiting
149     (IPv4).
150   - **CGNAT** - Carrier Grade Network Address Translation tests with varying
151     number of users and ports per user.
152
153 - 2port40GE XL710 Intel
154
155   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged Ethernet frames.
156   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
157     with MAC learning.
158   - **IPv4** - IPv4 routed-forwarding.
159   - **IPv6** - IPv6 routed-forwarding.
160   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
161     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
162     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
163   - **IPSec** - IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in combination
164     with IPv4 routed-forwarding.
165   - **IPSec+LISP** - IPSec encryption with CBC-SHA1 ciphers, in combination
166     with LISP-GPE overlay tunneling for IPv4-over-IPv4.
167
168 - 2port10GE X710 Intel
169
170   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
171     with MAC learning.
172   - **VMs with vhost-user** - virtual topologies with 1 VM using vhost-user
173     interfaces, with VPP forwarding modes incl. L2 Bridge-Domain.
174
175 - 2port10GE VIC1227 Cisco
176
177   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
178     with MAC learning.
179
180 - 2port40GE VIC1385 Cisco
181
182   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
183      with MAC learning.
184
185 Execution of performance tests takes time, especially the throughput discovery
186 tests. Due to limited HW testbed resources available within FD.io labs hosted
187 by Linux Foundation, the number of tests for NICs other than X520 (a.k.a.
188 Niantic) has been limited to few baseline tests. Over time we expect the HW
189 testbed resources to grow, and will be adding complete set of performance
190 tests for all models of hardware to be executed regularly and(or)
191 continuously.
192
193 Performance Tests Naming
194 ------------------------
195
196 CSIT |release| follows a common structured naming convention for all
197 performance and system functional tests, introduced in CSIT rls1701.
198
199 The naming should be intuitive for majority of the tests. Complete
200 description of CSIT test naming convention is provided on `CSIT test naming wiki
201 <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
202
203 Here few illustrative examples of the new naming usage for performance test
204 suites:
205
206 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**
207
208     - *PortNICConfig-WireEncapsulation-PacketForwardingFunction-
209       PacketProcessingFunction1-...-PacketProcessingFunctionN-TestType*
210     - *10ge2p1x520-dot1q-l2bdbasemaclrn-ndrdisc.robot* => 2 ports of 10GE on
211       Intel x520 NIC, dot1q tagged Ethernet, L2 bridge-domain baseline switching
212       with MAC learning, NDR throughput discovery.
213     - *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-ndrchk.robot* => 2 ports of 10GE
214       on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain baseline
215       switching with MAC learning, NDR throughput discovery.
216     - *10ge2p1x520-ethip4-ip4base-ndrdisc.robot* => 2 ports of 10GE on Intel
217       x520 NIC, IPv4 baseline routed forwarding, NDR throughput discovery.
218     - *10ge2p1x520-ethip6-ip6scale200k-ndrdisc.robot* => 2 ports of 10GE on
219       Intel x520 NIC, IPv6 scaled up routed forwarding, NDR throughput
220       discovery.
221
222 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,
223    P2V2P, NIC2VMchain2NIC, P2V2V2P**
224
225     - *PortNICConfig-WireEncapsulation-PacketForwardingFunction-
226       PacketProcessingFunction1-...-PacketProcessingFunctionN-VirtEncapsulation-
227       VirtPortConfig-VMconfig-TestType*
228     - *10ge2p1x520-dot1q-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc.robot* => 2 ports
229       of 10GE on Intel x520 NIC, dot1q tagged Ethernet, L2 bridge-domain
230       switching to/from two vhost interfaces and one VM, NDR throughput
231       discovery.
232     - *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc.robot* => 2
233       ports of 10GE on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain
234       switching to/from two vhost interfaces and one VM, NDR throughput
235       discovery.
236     - *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-eth-4vhost-2vm-ndrdisc.robot* => 2
237       ports of 10GE on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain
238       switching to/from four vhost interfaces and two VMs, NDR throughput
239       discovery.
240
241 Methodology: Multi-Thread and Multi-Core
242 ----------------------------------------
243
244 **HyperThreading** - CSIT |release| performance tests are executed with SUT
245 servers' Intel XEON CPUs configured in HyperThreading Disabled mode (BIOS
246 settings). This is the simplest configuration used to establish baseline
247 single-thread single-core SW packet processing and forwarding performance.
248 Subsequent releases of CSIT will add performance tests with Intel
249 HyperThreading Enabled (requires BIOS settings change and hard reboot).
250
251 **Multi-core Test** - CSIT |release| multi-core tests are executed in the
252 following VPP thread and core configurations:
253
254 #. 1t1c - 1 VPP worker thread on 1 CPU physical core.
255 #. 2t2c - 2 VPP worker threads on 2 CPU physical cores.
256
257 Note that in quite a few test cases running VPP on 2 physical cores hits
258 the tested NIC I/O bandwidth or packets-per-second limit.
259
260 Methodology: Packet Throughput
261 ------------------------------
262
263 Following values are measured and reported for packet throughput tests:
264
265 - NDR binary search per RFC2544:
266
267   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps
268     (2x <per direction packets-per-second>)"
269   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
270     second> Gbps (untagged)"
271
272 - PDR binary search per RFC2544:
273
274   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps (2x
275     <per direction packets-per-second>)"
276   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
277     second> Gbps (untagged)"
278   - Packet loss tolerance: "LOSS_ACCEPTANCE <accepted percentage of packets
279     lost at PDR rate>""
280
281 - NDR and PDR are measured for the following L2 frame sizes:
282
283   - IPv4: 64B, IMIX_v4_1 (28x64B,16x570B,4x1518B), 1518B, 9000B.
284   - IPv6: 78B, 1518B, 9000B.
285
286
287 Methodology: Packet Latency
288 ---------------------------
289
290 TRex Traffic Generator (TG) is used for measuring latency of VPP DUTs. Reported
291 latency values are measured using following methodology:
292
293 - Latency tests are performed at 10%, 50% of discovered NDR rate (non drop rate)
294   for each NDR throughput test and packet size (except IMIX).
295 - TG sends dedicated latency streams, one per direction, each at the rate of
296   10kpps at the prescribed packet size; these are sent in addition to the main
297   load streams.
298 - TG reports min/avg/max latency values per stream direction, hence two sets
299   of latency values are reported per test case; future release of TRex is
300   expected to report latency percentiles.
301 - Reported latency values are aggregate across two SUTs due to three node
302   topology used for all performance tests; for per SUT latency, reported value
303   should be divided by two.
304 - 1usec is the measurement accuracy advertised by TRex TG for the setup used in
305   FD.io labs used by CSIT project.
306 - TRex setup introduces an always-on error of about 2*2usec per latency flow -
307   additonal Tx/Rx interface latency induced by TRex SW writing and reading
308   packet timestamps on CPU cores without HW acceleration on NICs closer to the
309   interface line.
310
311
312 Methodology: KVM VM vhost
313 -------------------------
314
315 CSIT |release| introduced environment configuration changes to KVM Qemu vhost-
316 user tests in order to more representatively measure VPP-17.04 performance in
317 configurations with vhost-user interfaces and VMs.
318
319 Current setup of CSIT FD.io performance lab is using tuned settings for more
320 optimal performance of KVM Qemu:
321
322 - Qemu virtio queue size has been increased from default value of 256 to 1024
323   descriptors.
324 - Adjusted Linux kernel CFS scheduler settings, as detailed on this CSIT wiki
325   page: https://wiki.fd.io/view/CSIT/csit-perf-env-tuning-ubuntu1604.
326
327 Adjusted Linux kernel CFS settings make the NDR and PDR throughput performance
328 of VPP+VM system less sensitive to other Linux OS system tasks by reducing
329 their interference on CPU cores that are designated for critical software
330 tasks under test, namely VPP worker threads in host and Testpmd threads in
331 guest dealing with data plan.
332
333 Methodology: IPSec with Intel QAT HW cards
334 ------------------------------------------
335
336 VPP IPSec performance tests are using DPDK cryptodev device driver in
337 combination with HW cryptodev devices - Intel QAT 8950 50G - present in
338 LF FD.io physical testbeds. DPDK cryptodev can be used for all IPSec
339 data plane functions supported by VPP.
340
341 Currently CSIT |release| implements following IPSec test cases:
342
343 - AES-GCM, CBC-SHA1 ciphers, in combination with IPv4 routed-forwarding
344   with Intel xl710 NIC.
345 - CBC-SHA1 ciphers, in combination with LISP-GPE overlay tunneling for
346   IPv4-over-IPv4 with Intel xl710 NIC.
347
348 Methodology: TRex Traffic Generator Usage
349 -----------------------------------------
350
351 The `TRex traffic generator <https://wiki.fd.io/view/TRex>`_ is used for all
352 CSIT performance tests. TRex stateless mode is used to measure NDR and PDR
353 throughputs using binary search (NDR and PDR discovery tests) and for quick
354 checks of DUT performance against the reference NDRs (NDR check tests) for
355 specific configuration.
356
357 TRex is installed and run on the TG compute node. The typical procedure is:
358
359     - If the TRex is not already installed on TG, it is installed in the
360       suite setup phase - see `TRex intallation <https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-installer.sh;h=8090b7568327ac5f869e82664bc51b24f89f603f;hb=refs/heads/rls1704>`_.
361     - TRex configuration is set in its configuration file
362       ::
363
364         /etc/trex_cfg.yaml
365
366     - TRex is started in the background mode
367       ::
368
369         sh -c 'cd /opt/trex-core-2.22/scripts/ && sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &' > /dev/null
370
371     - There are traffic streams dynamically prepared for each test. The traffic
372       is sent and the statistics obtained using trex_stl_lib.api.STLClient.
373
374 **Measuring packet loss**
375
376     - Create an instance of STLClient
377     - Connect to the client
378     - Add all streams
379     - Clear statistics
380     - Send the traffic for defined time
381     - Get the statistics
382
383 If there is a warm-up phase required, the traffic is sent also before test and
384 the statistics are ignored.
385
386 **Measuring latency**
387
388 If measurement of latency is requested, two more packet streams are created (one
389 for each direction) with TRex flow_stats parameter set to STLFlowLatencyStats. In
390 that case, returned statistics will also include min/avg/max latency values.