csit report static content updates for rls1710.
[csit.git] / docs / report / vpp_performance_tests / overview.rst
1 Overview
2 ========
3
4 .. _tested_physical_topologies:
5
6 Tested Physical Topologies
7 --------------------------
8
9 CSIT VPP performance tests are executed on physical baremetal servers hosted by
10 :abbr:`LF (Linux Foundation)` FD.io project. Testbed physical topology is shown
11 in the figure below.::
12
13     +------------------------+           +------------------------+
14     |                        |           |                        |
15     |  +------------------+  |           |  +------------------+  |
16     |  |                  |  |           |  |                  |  |
17     |  |                  <----------------->                  |  |
18     |  |       DUT1       |  |           |  |       DUT2       |  |
19     |  +--^---------------+  |           |  +---------------^--+  |
20     |     |                  |           |                  |     |
21     |     |            SUT1  |           |  SUT2            |     |
22     +------------------------+           +------------------^-----+
23           |                                                 |
24           |                                                 |
25           |                  +-----------+                  |
26           |                  |           |                  |
27           +------------------>    TG     <------------------+
28                              |           |
29                              +-----------+
30
31 SUT1 and SUT2 are two System Under Test servers (Cisco UCS C240, each with two
32 Intel XEON CPUs), TG is a Traffic Generator (TG, another Cisco UCS C240, with
33 two Intel XEON CPUs). SUTs run VPP SW application in Linux user-mode as a
34 Device Under Test (DUT). TG runs TRex SW application as a packet Traffic
35 Generator. Physical connectivity between SUTs and to TG is provided using
36 different NIC models that need to be tested for performance. Currently
37 installed and tested NIC models include:
38
39 #. 2port10GE X520-DA2 Intel.
40 #. 2port10GE X710 Intel.
41 #. 2port10GE VIC1227 Cisco.
42 #. 2port40GE VIC1385 Cisco.
43 #. 2port40GE XL710 Intel.
44
45 From SUT and DUT perspective, all performance tests involve forwarding packets
46 between two physical Ethernet ports (10GE or 40GE). Due to the number of
47 listed NIC models tested and available PCI slot capacity in SUT servers, in
48 all of the above cases both physical ports are located on the same NIC. In
49 some test cases this results in measured packet throughput being limited not
50 by VPP DUT but by either the physical interface or the NIC capacity.
51
52 Going forward CSIT project will be looking to add more hardware into FD.io
53 performance labs to address larger scale multi-interface and multi-NIC
54 performance testing scenarios.
55
56 For test cases that require DUT (VPP) to communicate with
57 VirtualMachines (VMs) / Containers (Linux or Docker Containers) over
58 vhost-user/memif interfaces, N of VM/Ctr instances are created on SUT1
59 and SUT2. For N=1 DUT forwards packets between vhost/memif and physical
60 interfaces. For N>1 DUT a logical service chain forwarding topology is
61 created on DUT by applying L2 or IPv4/IPv6 configuration depending on
62 the test suite. DUT test topology with N VM/Ctr instances is shown in
63 the figure below including applicable packet flow thru the DUTs and
64 VMs/Ctrs (marked in the figure with ``***``).::
65
66     +-------------------------+           +-------------------------+
67     | +---------+ +---------+ |           | +---------+ +---------+ |
68     | |VM/Ctr[1]| |VM/Ctr[N]| |           | |VM/Ctr[1]| |VM/Ctr[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/Ctr tests, packets are switched by DUT multiple times: twice for
89 a single VM/Ctr, three times for two VMs/Ctrs, N+1 times for N VMs/Ctrs.
90 Hence the external throughput rates measured by TG and listed in this
91 report must be multiplied by (N+1) to represent the actual DUT aggregate
92 packet forwarding rate.
93
94 Note that reported DUT (VPP) performance results are specific to the SUTs
95 tested. Current :abbr:`LF (Linux Foundation)` FD.io SUTs are based on Intel
96 XEON E5-2699v3 2.3GHz CPUs. SUTs with other CPUs are likely to yield different
97 results. A good rule of thumb, that can be applied to estimate VPP packet
98 thoughput for Phy-to-Phy (NIC-to-NIC, PCI-to-PCI) topology, is to expect
99 the forwarding performance to be proportional to CPU core frequency,
100 assuming CPU is the only limiting factor and all other SUT parameters
101 equivalent to FD.io CSIT environment. The same rule of thumb can be also
102 applied for Phy-to-VM/Ctr-to-Phy (NIC-to-VM/Ctr-to-NIC) topology, but due to
103 much higher dependency on intensive memory operations and sensitivity to Linux
104 kernel scheduler settings and behaviour, this estimation may not always yield
105 good enough accuracy.
106
107 For detailed :abbr:`LF (Linux Foundation)` FD.io test bed specification and
108 physical topology please refer to `LF FD.io CSIT testbed wiki page
109 <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed>`_.
110
111 Performance Tests Coverage
112 --------------------------
113
114 Performance tests are split into two main categories:
115
116 - Throughput discovery - discovery of packet forwarding rate using binary search
117   in accordance to :rfc:`2544`.
118
119   - NDR - discovery of Non Drop Rate packet throughput, at zero packet loss;
120     followed by one-way packet latency measurements at 10%, 50% and 100% of
121     discovered NDR throughput.
122   - PDR - discovery of Partial Drop Rate, with specified non-zero packet loss
123     currently set to 0.5%; followed by one-way packet latency measurements at
124     100% of discovered PDR throughput.
125
126 - Throughput verification - verification of packet forwarding rate against
127   previously discovered throughput rate. These tests are currently done against
128   0.9 of reference NDR, with reference rates updated periodically.
129
130 CSIT |release| includes following performance test suites, listed per NIC type:
131
132 - 2port10GE X520-DA2 Intel
133
134   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged, dot1q, dot1ad
135     VLAN tagged Ethernet frames.
136   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
137     with MAC learning; disabled MAC learning i.e. static MAC tests to be added.
138   - **L2BD Scale** - L2 Bridge-Domain switched-forwarding of untagged Ethernet
139     frames with MAC learning; disabled MAC learning i.e. static MAC tests to be
140     added with 20k, 200k and 2M FIB entries.
141   - **IPv4** - IPv4 routed-forwarding.
142   - **IPv6** - IPv6 routed-forwarding.
143   - **IPv4 Scale** - IPv4 routed-forwarding with 20k, 200k and 2M FIB entries.
144   - **IPv6 Scale** - IPv6 routed-forwarding with 20k, 200k and 2M FIB entries.
145   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
146     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
147     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
148   - **COP** - IPv4 and IPv6 routed-forwarding with COP address security.
149   - **ACL** - L2 Bridge-Domain switched-forwarding and IPv4 and IPv6 routed-
150     forwarding with iACL and oACL IP address, MAC address and L4 port security.
151   - **LISP** - LISP overlay tunneling for IPv4-over-IPv4, IPv6-over-IPv4,
152     IPv6-over-IPv6, IPv4-over-IPv6 in IPv4 and IPv6 routed-forwarding modes.
153   - **VXLAN** - VXLAN overlay tunnelling integration with L2XC and L2BD.
154   - **QoS Policer** - ingress packet rate measuring, marking and limiting
155     (IPv4).
156   - **NAT** - (Source) Network Address Translation tests with varying
157     number of users and ports per user.
158   - **Container memif connections** - VPP memif virtual interface tests to
159     interconnect VPP instances with L2XC and L2BD.
160   - **Container Orchestrated Topologies** - Container topologies connected over
161     the memif virtual interface.
162
163 - 2port40GE XL710 Intel
164
165   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged Ethernet frames.
166   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
167     with MAC learning.
168   - **IPv4** - IPv4 routed-forwarding.
169   - **IPv6** - IPv6 routed-forwarding.
170   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
171     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
172     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
173   - **IPSec** - IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in combination
174     with IPv4 routed-forwarding.
175   - **IPSec+LISP** - IPSec encryption with CBC-SHA1 ciphers, in combination
176     with LISP-GPE overlay tunneling for IPv4-over-IPv4.
177
178 - 2port10GE X710 Intel
179
180   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
181     with MAC learning.
182   - **VMs with vhost-user** - virtual topologies with 1 VM using vhost-user
183     interfaces, with VPP forwarding modes incl. L2 Bridge-Domain.
184
185 - 2port10GE VIC1227 Cisco
186
187   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
188     with MAC learning.
189
190 - 2port40GE VIC1385 Cisco
191
192   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
193      with MAC learning.
194
195 Execution of performance tests takes time, especially the throughput discovery
196 tests. Due to limited HW testbed resources available within FD.io labs hosted
197 by :abbr:`LF (Linux Foundation)`, the number of tests for NICs other than X520
198 (a.k.a. Niantic) has been limited to few baseline tests. CSIT team expect the
199 HW testbed resources to grow over time, so that complete set of performance
200 tests can be regularly and(or) continuously executed against all models of
201 hardware present in FD.io labs.
202
203 Performance Tests Naming
204 ------------------------
205
206 CSIT |release| follows a common structured naming convention for all performance
207 and system functional tests, introduced in CSIT |release-1|.
208
209 The naming should be intuitive for majority of the tests. Complete description
210 of CSIT test naming convention is provided on `CSIT test naming wiki
211 <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
212
213 Methodology: Multi-Core and Multi-Threading
214 -------------------------------------------
215
216 **Intel Hyper-Threading** - CSIT |release| performance tests are executed with
217 SUT servers' Intel XEON processors configured in Intel Hyper-Threading Disabled
218 mode (BIOS setting). This is the simplest configuration used to establish
219 baseline single-thread single-core application packet processing and forwarding
220 performance. Subsequent releases of CSIT will add performance tests with Intel
221 Hyper-Threading Enabled (requires BIOS settings change and hard reboot of
222 server).
223
224 **Multi-core Tests** - CSIT |release| multi-core tests are executed in the
225 following VPP thread and core configurations:
226
227 #. 1t1c - 1 VPP worker thread on 1 CPU physical core.
228 #. 2t2c - 2 VPP worker threads on 2 CPU physical cores.
229
230 VPP worker threads are the data plane threads. VPP control thread is running on
231 a separate non-isolated core together with other Linux processes. Note that in
232 quite a few test cases running VPP workers on 2 physical cores hits the tested
233 NIC I/O bandwidth or packets-per-second limit.
234
235 Methodology: Packet Throughput
236 ------------------------------
237
238 Following values are measured and reported for packet throughput tests:
239
240 - NDR binary search per :rfc:`2544`:
241
242   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps
243     (2x <per direction packets-per-second>)"
244   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
245     second> Gbps (untagged)"
246
247 - PDR binary search per :rfc:`2544`:
248
249   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps (2x
250     <per direction packets-per-second>)"
251   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
252     second> Gbps (untagged)"
253   - Packet loss tolerance: "LOSS_ACCEPTANCE <accepted percentage of packets
254     lost at PDR rate>""
255
256 - NDR and PDR are measured for the following L2 frame sizes:
257
258   - IPv4: 64B, IMIX_v4_1 (28x64B,16x570B,4x1518B), 1518B, 9000B.
259   - IPv6: 78B, 1518B, 9000B.
260
261 All rates are reported from external Traffic Generator perspective.
262
263 Methodology: Packet Latency
264 ---------------------------
265
266 TRex Traffic Generator (TG) is used for measuring latency of VPP DUTs. Reported
267 latency values are measured using following methodology:
268
269 - Latency tests are performed at 10%, 50% of discovered NDR rate (non drop rate)
270   for each NDR throughput test and packet size (except IMIX).
271 - TG sends dedicated latency streams, one per direction, each at the rate of
272   10kpps at the prescribed packet size; these are sent in addition to the main
273   load streams.
274 - TG reports min/avg/max latency values per stream direction, hence two sets
275   of latency values are reported per test case; future release of TRex is
276   expected to report latency percentiles.
277 - Reported latency values are aggregate across two SUTs due to three node
278   topology used for all performance tests; for per SUT latency, reported value
279   should be divided by two.
280 - 1usec is the measurement accuracy advertised by TRex TG for the setup used in
281   FD.io labs used by CSIT project.
282 - TRex setup introduces an always-on error of about 2*2usec per latency flow -
283   additonal Tx/Rx interface latency induced by TRex SW writing and reading
284   packet timestamps on CPU cores without HW acceleration on NICs closer to the
285   interface line.
286
287
288 Methodology: KVM VM vhost
289 -------------------------
290
291 CSIT |release| introduced test environment configuration changes to KVM Qemu
292 vhost-user tests in order to more representatively measure |vpp-release|
293 performance in configurations with vhost-user interfaces and different Qemu
294 settings.
295
296 FD.io CSIT performance lab is testing VPP vhost with KVM VMs using following
297 environment settings:
298
299 - Tests with varying Qemu virtio queue (a.k.a. vring) sizes: [vr256] default 256
300   descriptors, [vr1024] 1024 descriptors to optimize for packet throughput;
301
302 - Tests with varying Linux :abbr:`CFS (Completely Fair Scheduler)` settings:
303   [cfs] default settings, [cfsrr1] CFS RoundRobin(1) policy applied to all data
304   plane threads handling test packet path including all VPP worker threads and
305   all Qemu testpmd poll-mode threads;
306
307 - Resulting test cases are all combinations with [vr256,vr1024] and
308   [cfs,cfsrr1] settings;
309
310 - Adjusted Linux kernel :abbr:`CFS (Completely Fair Scheduler)` scheduler policy
311   for data plane threads used in CSIT is documented in
312   `CSIT Performance Environment Tuning wiki <https://wiki.fd.io/view/CSIT/csit-perf-env-tuning-ubuntu1604>`_.
313   The purpose is to verify performance impact (NDR, PDR throughput) and
314   same test measurements repeatability, by making VPP and VM data plane
315   threads less susceptible to other Linux OS system tasks hijacking CPU
316   cores running those data plane threads.
317
318 Methodology: LXC and Docker Containers memif
319 --------------------------------------------
320
321 CSIT |release| introduced additional tests taking advantage of VPP memif
322 virtual interface (shared memory interface) tests to interconnect VPP
323 instances. VPP vswitch instance runs in bare-metal user-mode handling
324 Intel x520 NIC 10GbE interfaces and connecting over memif (Master side)
325 virtual interfaces to more instances of VPP running in :abbr:`LXC (Linux
326 Container)` or in Docker Containers,  both with memif virtual interfaces
327 (Slave side). LXCs and Docker Containers run in a priviliged mode with
328 VPP data plane worker threads pinned to dedicated physical CPU cores per
329 usual CSIT practice. All VPP instances run the same version of software.
330 This test topology is equivalent to existing tests with vhost-user and
331 VMs as described earlier in :ref:`tested_physical_topologies`.
332
333 More information about CSIT LXC and Docker Container setup and control
334 is available in :ref:`containter_orchestration_in_csit`.
335
336 Methodology: Container Topologies Orchestrated by K8s
337 -----------------------------------------------------
338
339 CSIT |release| introduced new tests of Container topologies connected
340 over the memif virtual interface (shared memory interface). In order to
341 provide simple topology coding flexibility and extensibility container
342 orchestration is done with `Kubernetes <https://github.com/kubernetes>`_
343 using `Docker <https://github.com/docker>`_ images for all container
344 applications including VPP. `Ligato <https://github.com/ligato>`_ is
345 used to address the container networking orchestration that is
346 integrated with K8s, including memif support.
347
348 For these tests VPP vswitch instance runs in a Docker Container handling
349 Intel x520 NIC 10GbE interfaces and connecting over memif (Master side)
350 virtual interfaces to more instances of VPP running in Docker Containers
351 with memif virtual interfaces (Slave side). All Docker Containers run in
352 a priviliged mode with VPP data plane worker threads pinned to dedicated
353 physical CPU cores per usual CSIT practice. All VPP instances run the
354 same version of software. This test topology is equivalent to existing
355 tests with vhost-user and VMs as described earlier in
356 :ref:`tested_physical_topologies`.
357
358 More information about CSIT Container Topologies Orchestrated by K8s is
359 available in :ref:`containter_orchestration_in_csit`.
360
361 Methodology: IPSec with Intel QAT HW cards
362 ------------------------------------------
363
364 VPP IPSec performance tests are using DPDK cryptodev device driver in
365 combination with HW cryptodev devices - Intel QAT 8950 50G - present in
366 LF FD.io physical testbeds. DPDK cryptodev can be used for all IPSec
367 data plane functions supported by VPP.
368
369 Currently CSIT |release| implements following IPSec test cases:
370
371 - AES-GCM, CBC-SHA1 ciphers, in combination with IPv4 routed-forwarding
372   with Intel xl710 NIC.
373 - CBC-SHA1 ciphers, in combination with LISP-GPE overlay tunneling for
374   IPv4-over-IPv4 with Intel xl710 NIC.
375
376 Methodology: TRex Traffic Generator Usage
377 -----------------------------------------
378
379 The `TRex traffic generator <https://wiki.fd.io/view/TRex>`_ is used for all
380 CSIT performance tests. TRex stateless mode is used to measure NDR and PDR
381 throughputs using binary search (NDR and PDR discovery tests) and for quick
382 checks of DUT performance against the reference NDRs (NDR check tests) for
383 specific configuration.
384
385 TRex is installed and run on the TG compute node. The typical procedure is:
386
387 - If the TRex is not already installed on TG, it is installed in the
388   suite setup phase - see `TRex intallation`_.
389 - TRex configuration is set in its configuration file
390   ::
391
392   /etc/trex_cfg.yaml
393
394 - TRex is started in the background mode
395   ::
396
397   $ sh -c 'cd /opt/trex-core-2.25/scripts/ && sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &' > /dev/null
398
399 - There are traffic streams dynamically prepared for each test, based on traffic
400   profiles. The traffic is sent and the statistics obtained using
401   :command:`trex_stl_lib.api.STLClient`.
402
403 **Measuring packet loss**
404
405 - Create an instance of STLClient
406 - Connect to the client
407 - Add all streams
408 - Clear statistics
409 - Send the traffic for defined time
410 - Get the statistics
411
412 If there is a warm-up phase required, the traffic is sent also before test and
413 the statistics are ignored.
414
415 **Measuring latency**
416
417 If measurement of latency is requested, two more packet streams are created (one
418 for each direction) with TRex flow_stats parameter set to STLFlowLatencyStats. In
419 that case, returned statistics will also include min/avg/max latency values.