rls1801 report: added TCP/IP test methodology, other minor edits of static content.
[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) / Linux or Docker Containers (Ctrs) 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 FD.io CSIT testbed specification and topology, as well as
108 configuration and setup of SUTs and DUTs testbeds please refer to
109 :ref:`test_environment`.
110
111 Similar SUT compute node and DUT VPP settings can be arrived to in a
112 standalone VPP setup by using a `vpp-config configuration tool
113 <https://wiki.fd.io/view/VPP/Configuration_Tool>`_ developed within the
114 VPP project using CSIT recommended settings and scripts.
115
116 Performance Tests Coverage
117 --------------------------
118
119 Performance tests are split into two main categories:
120
121 - Throughput discovery - discovery of packet forwarding rate using binary search
122   in accordance to :rfc:`2544`.
123
124   - NDR - discovery of Non Drop Rate packet throughput, at zero packet loss;
125     followed by one-way packet latency measurements at 10%, 50% and 100% of
126     discovered NDR throughput.
127   - PDR - discovery of Partial Drop Rate, with specified non-zero packet loss
128     currently set to 0.5%; followed by one-way packet latency measurements at
129     100% of discovered PDR throughput.
130
131 - Throughput verification - verification of packet forwarding rate against
132   previously discovered throughput rate. These tests are currently done against
133   0.9 of reference NDR, with reference rates updated periodically.
134
135 CSIT |release| includes following performance test suites, listed per NIC type:
136
137 - 2port10GE X520-DA2 Intel
138
139   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged, dot1q, dot1ad
140     VLAN tagged Ethernet frames.
141   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
142     with MAC learning; disabled MAC learning i.e. static MAC tests to be added.
143   - **L2BD Scale** - L2 Bridge-Domain switched-forwarding of untagged Ethernet
144     frames with MAC learning; disabled MAC learning i.e. static MAC tests to be
145     added with 20k, 200k and 2M FIB entries.
146   - **IPv4** - IPv4 routed-forwarding.
147   - **IPv6** - IPv6 routed-forwarding.
148   - **IPv4 Scale** - IPv4 routed-forwarding with 20k, 200k and 2M FIB entries.
149   - **IPv6 Scale** - IPv6 routed-forwarding with 20k, 200k and 2M FIB entries.
150   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
151     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
152     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
153   - **COP** - IPv4 and IPv6 routed-forwarding with COP address security.
154   - **ACL** - L2 Bridge-Domain switched-forwarding and IPv4 and IPv6 routed-
155     forwarding with iACL and oACL IP address, MAC address and L4 port security.
156   - **LISP** - LISP overlay tunneling for IPv4-over-IPv4, IPv6-over-IPv4,
157     IPv6-over-IPv6, IPv4-over-IPv6 in IPv4 and IPv6 routed-forwarding modes.
158   - **VXLAN** - VXLAN overlay tunnelling integration with L2XC and L2BD.
159   - **QoS Policer** - ingress packet rate measuring, marking and limiting
160     (IPv4).
161   - **NAT** - (Source) Network Address Translation tests with varying
162     number of users and ports per user.
163   - **Container memif connections** - VPP memif virtual interface tests to
164     interconnect VPP instances with L2XC and L2BD.
165   - **Container K8s Orchestrated Topologies** - Container topologies connected over
166     the memif virtual interface.
167   - **SRv6** - Segment Routing IPv6 tests.
168
169 - 2port40GE XL710 Intel
170
171   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged Ethernet frames.
172   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
173     with MAC learning.
174   - **IPv4** - IPv4 routed-forwarding.
175   - **IPv6** - IPv6 routed-forwarding.
176   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
177     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
178     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
179   - **IPSecSW** - IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in
180     combination with IPv4 routed-forwarding.
181   - **IPSecHW** - IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in
182     combination with IPv4 routed-forwarding. Intel QAT HW acceleration.
183   - **IPSec+LISP** - IPSec encryption with CBC-SHA1 ciphers, in combination
184     with LISP-GPE overlay tunneling for IPv4-over-IPv4.
185   - **VPP TCP/IP stack** - tests of VPP TCP/IP stack used with VPP built-in HTTP
186     server.
187
188 - 2port10GE X710 Intel
189
190   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
191     with MAC learning.
192   - **VMs with vhost-user** - virtual topologies with 1 VM using vhost-user
193     interfaces, with VPP forwarding modes incl. L2 Bridge-Domain.
194
195 - 2port10GE VIC1227 Cisco
196
197   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
198     with MAC learning.
199
200 - 2port40GE VIC1385 Cisco
201
202   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
203      with MAC learning.
204
205 Execution of performance tests takes time, especially the throughput discovery
206 tests. Due to limited HW testbed resources available within FD.io labs hosted
207 by :abbr:`LF (Linux Foundation)`, the number of tests for NICs other than X520
208 (a.k.a. Niantic) has been limited to few baseline tests. CSIT team expect the
209 HW testbed resources to grow over time, so that complete set of performance
210 tests can be regularly and(or) continuously executed against all models of
211 hardware present in FD.io labs.
212
213 Performance Tests Naming
214 ------------------------
215
216 CSIT |release| follows a common structured naming convention for all performance
217 and system functional tests, introduced in CSIT |release-1|.
218
219 The naming should be intuitive for majority of the tests. Complete description
220 of CSIT test naming convention is provided on `CSIT test naming wiki
221 <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
222
223 Methodology: Multi-Core and Multi-Threading
224 -------------------------------------------
225
226 **Intel Hyper-Threading** - CSIT |release| performance tests are executed with
227 SUT servers' Intel XEON processors configured in Intel Hyper-Threading Disabled
228 mode (BIOS setting). This is the simplest configuration used to establish
229 baseline single-thread single-core application packet processing and forwarding
230 performance. Subsequent releases of CSIT will add performance tests with Intel
231 Hyper-Threading Enabled (requires BIOS settings change and hard reboot of
232 server).
233
234 **Multi-core Tests** - CSIT |release| multi-core tests are executed in the
235 following VPP thread and core configurations:
236
237 #. 1t1c - 1 VPP worker thread on 1 CPU physical core.
238 #. 2t2c - 2 VPP worker threads on 2 CPU physical cores.
239
240 VPP worker threads are the data plane threads. VPP control thread is running on
241 a separate non-isolated core together with other Linux processes. Note that in
242 quite a few test cases running VPP workers on 2 physical cores hits the tested
243 NIC I/O bandwidth or packets-per-second limit.
244
245 Methodology: Packet Throughput
246 ------------------------------
247
248 Following values are measured and reported for packet throughput tests:
249
250 - NDR binary search per :rfc:`2544`:
251
252   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps
253     (2x <per direction packets-per-second>)"
254   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
255     second> Gbps (untagged)"
256
257 - PDR binary search per :rfc:`2544`:
258
259   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps (2x
260     <per direction packets-per-second>)"
261   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
262     second> Gbps (untagged)"
263   - Packet loss tolerance: "LOSS_ACCEPTANCE <accepted percentage of packets
264     lost at PDR rate>""
265
266 - NDR and PDR are measured for the following L2 frame sizes:
267
268   - IPv4: 64B, IMIX_v4_1 (28x64B,16x570B,4x1518B), 1518B, 9000B.
269   - IPv6: 78B, 1518B, 9000B.
270
271 All rates are reported from external Traffic Generator perspective.
272
273 Methodology: Packet Latency
274 ---------------------------
275
276 TRex Traffic Generator (TG) is used for measuring latency of VPP DUTs. Reported
277 latency values are measured using following methodology:
278
279 - Latency tests are performed at 10%, 50% of discovered NDR rate (non drop rate)
280   for each NDR throughput test and packet size (except IMIX).
281 - TG sends dedicated latency streams, one per direction, each at the rate of
282   10kpps at the prescribed packet size; these are sent in addition to the main
283   load streams.
284 - TG reports min/avg/max latency values per stream direction, hence two sets
285   of latency values are reported per test case; future release of TRex is
286   expected to report latency percentiles.
287 - Reported latency values are aggregate across two SUTs due to three node
288   topology used for all performance tests; for per SUT latency, reported value
289   should be divided by two.
290 - 1usec is the measurement accuracy advertised by TRex TG for the setup used in
291   FD.io labs used by CSIT project.
292 - TRex setup introduces an always-on error of about 2*2usec per latency flow -
293   additonal Tx/Rx interface latency induced by TRex SW writing and reading
294   packet timestamps on CPU cores without HW acceleration on NICs closer to the
295   interface line.
296
297
298 Methodology: KVM VM vhost
299 -------------------------
300
301 CSIT |release| introduced test environment configuration changes to KVM Qemu
302 vhost-user tests in order to more representatively measure |vpp-release|
303 performance in configurations with vhost-user interfaces and different Qemu
304 settings.
305
306 FD.io CSIT performance lab is testing VPP vhost with KVM VMs using following
307 environment settings:
308
309 - Tests with varying Qemu virtio queue (a.k.a. vring) sizes: [vr256] default 256
310   descriptors, [vr1024] 1024 descriptors to optimize for packet throughput;
311
312 - Tests with varying Linux :abbr:`CFS (Completely Fair Scheduler)` settings:
313   [cfs] default settings, [cfsrr1] CFS RoundRobin(1) policy applied to all data
314   plane threads handling test packet path including all VPP worker threads and
315   all Qemu testpmd poll-mode threads;
316
317 - Resulting test cases are all combinations with [vr256,vr1024] and
318   [cfs,cfsrr1] settings;
319
320 - Adjusted Linux kernel :abbr:`CFS (Completely Fair Scheduler)` scheduler policy
321   for data plane threads used in CSIT is documented in
322   `CSIT Performance Environment Tuning wiki <https://wiki.fd.io/view/CSIT/csit-perf-env-tuning-ubuntu1604>`_.
323   The purpose is to verify performance impact (NDR, PDR throughput) and
324   same test measurements repeatability, by making VPP and VM data plane
325   threads less susceptible to other Linux OS system tasks hijacking CPU
326   cores running those data plane threads.
327
328 Methodology: LXC and Docker Containers memif
329 --------------------------------------------
330
331 CSIT |release| introduced additional tests taking advantage of VPP memif
332 virtual interface (shared memory interface) tests to interconnect VPP
333 instances. VPP vswitch instance runs in bare-metal user-mode handling
334 Intel x520 NIC 10GbE interfaces and connecting over memif (Master side)
335 virtual interfaces to more instances of VPP running in :abbr:`LXC (Linux
336 Container)` or in Docker Containers,  both with memif virtual interfaces
337 (Slave side). LXCs and Docker Containers run in a priviliged mode with
338 VPP data plane worker threads pinned to dedicated physical CPU cores per
339 usual CSIT practice. All VPP instances run the same version of software.
340 This test topology is equivalent to existing tests with vhost-user and
341 VMs as described earlier in :ref:`tested_physical_topologies`.
342
343 More information about CSIT LXC and Docker Container setup and control
344 is available in :ref:`containter_orchestration_in_csit`.
345
346 Methodology: Container Topologies Orchestrated by K8s
347 -----------------------------------------------------
348
349 CSIT |release| introduced new tests of Container topologies connected
350 over the memif virtual interface (shared memory interface). In order to
351 provide simple topology coding flexibility and extensibility container
352 orchestration is done with `Kubernetes <https://github.com/kubernetes>`_
353 using `Docker <https://github.com/docker>`_ images for all container
354 applications including VPP. `Ligato <https://github.com/ligato>`_ is
355 used to address the container networking orchestration that is
356 integrated with K8s, including memif support.
357
358 For these tests VPP vswitch instance runs in a Docker Container handling
359 Intel x520 NIC 10GbE interfaces and connecting over memif (Master side)
360 virtual interfaces to more instances of VPP running in Docker Containers
361 with memif virtual interfaces (Slave side). All Docker Containers run in
362 a priviliged mode with VPP data plane worker threads pinned to dedicated
363 physical CPU cores per usual CSIT practice. All VPP instances run the
364 same version of software. This test topology is equivalent to existing
365 tests with vhost-user and VMs as described earlier in
366 :ref:`tested_physical_topologies`.
367
368 More information about CSIT Container Topologies Orchestrated by K8s is
369 available in :ref:`containter_orchestration_in_csit`.
370
371 Methodology: IPSec with Intel QAT HW cards
372 ------------------------------------------
373
374 VPP IPSec performance tests are using DPDK cryptodev device driver in
375 combination with HW cryptodev devices - Intel QAT 8950 50G - present in
376 LF FD.io physical testbeds. DPDK cryptodev can be used for all IPSec
377 data plane functions supported by VPP.
378
379 Currently CSIT |release| implements following IPSec test cases:
380
381 - AES-GCM, CBC-SHA1 ciphers, in combination with IPv4 routed-forwarding
382   with Intel xl710 NIC.
383 - CBC-SHA1 ciphers, in combination with LISP-GPE overlay tunneling for
384   IPv4-over-IPv4 with Intel xl710 NIC.
385
386 Methodology: TRex Traffic Generator Usage
387 -----------------------------------------
388
389 `TRex traffic generator <https://wiki.fd.io/view/TRex>`_ is used for all
390 CSIT performance tests. TRex stateless mode is used to measure NDR and PDR
391 throughputs using binary search (NDR and PDR discovery tests) and for quick
392 checks of DUT performance against the reference NDRs (NDR check tests) for
393 specific configuration.
394
395 TRex is installed and run on the TG compute node. The typical procedure is:
396
397 - If the TRex is not already installed on TG, it is installed in the
398   suite setup phase - see `TRex intallation`_.
399 - TRex configuration is set in its configuration file
400   ::
401
402   /etc/trex_cfg.yaml
403
404 - TRex is started in the background mode
405   ::
406
407   $ sh -c 'cd <t-rex-install-dir>/scripts/ && sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /tmp/trex.log 2>&1 &' > /dev/null
408
409 - There are traffic streams dynamically prepared for each test, based on traffic
410   profiles. The traffic is sent and the statistics obtained using
411   :command:`trex_stl_lib.api.STLClient`.
412
413 **Measuring packet loss**
414
415 - Create an instance of STLClient
416 - Connect to the client
417 - Add all streams
418 - Clear statistics
419 - Send the traffic for defined time
420 - Get the statistics
421
422 If there is a warm-up phase required, the traffic is sent also before test and
423 the statistics are ignored.
424
425 **Measuring latency**
426
427 If measurement of latency is requested, two more packet streams are created (one
428 for each direction) with TRex flow_stats parameter set to STLFlowLatencyStats. In
429 that case, returned statistics will also include min/avg/max latency values.
430
431 Methodology: TCP/IP tests with WRK tool
432 ---------------------------------------
433
434 `WRK HTTP benchmarking tool <https://github.com/wg/wrk>`_ is used for
435 experimental TCP/IP and HTTP tests of VPP TCP/IP stack and built-in
436 static HTTP server. WRK has been chosen as it is capable of generating
437 significant TCP/IP and HTTP loads by scaling number of threads across
438 multi-core processors.
439
440 This in turn enables quite high scale benchmarking of the main TCP/IP
441 and HTTP service including HTTP TCP/IP Connections-Per-Second (CPS),
442 HTTP Requests-Per-Second and HTTP Bandwidth Throughput.
443
444 The initial tests are designed as follows:
445
446 - HTTP and TCP/IP Connections-Per-Second (CPS)
447
448   - WRK configured to use 8 threads across 8 cores, 1 thread per core.
449   - Maximum of 50 concurrent connections across all WRK threads.
450   - Timeout for server responses set to 5 seconds.
451   - Test duration is 30 seconds.
452   - Expected HTTP test sequence:
453
454     - Single HTTP GET Request sent per open connection.
455     - Connection close after valid HTTP reply.
456     - Resulting flow sequence - 8 packets: >S,<S-A,>A,>Req,<Rep,>F,<F,> A.
457
458 - HTTP Requests-Per-Second
459
460   - WRK configured to use 8 threads across 8 cores, 1 thread per core.
461   - Maximum of 50 concurrent connections across all WRK threads.
462   - Timeout for server responses set to 5 seconds.
463   - Test duration is 30 seconds.
464   - Expected HTTP test sequence:
465
466     - Multiple HTTP GET Requests sent in sequence per open connection.
467     - Connection close after set test duration time.
468     - Resulting flow sequence: >S,<S-A,>A,>Req[1],<Rep[1],..,>Req[n],<Rep[n],>F,<F,>A.

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.