669c5d10b1eab87c023ec8603f9c5f4f7043d45e
[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) / LinuxContainers (LXCs) over vhost-user/memif
58 interfaces, N of VM/LXC instances are created on SUT1 and SUT2. For N=1
59 DUT forwards packets between vhost/memif and physical interfaces. For
60 N>1 DUT a logical service chain forwarding topology is created on DUT by
61 applying L2 or IPv4/IPv6 configuration depending on the test suite. DUT
62 test topology with N VM/LXC instances is shown in the figure below
63 including applicable packet flow thru the DUTs and VMs/LXCs (marked in
64 the figure with ``***``).::
65
66     +-------------------------+           +-------------------------+
67     | +---------+ +---------+ |           | +---------+ +---------+ |
68     | |VM/LXC[1]| |VM/LXC[N]| |           | |VM/LXC[1]| |VM/LXC[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/LXC tests, packets are switched by DUT multiple times: twice for
89 a single VM/LXC, three times for two VMs/LXCs, N+1 times for N VMs/LXCs.
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/LXC-to-Phy (NIC-to-VM/LXC-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   - **IPv4** - IPv4 routed-forwarding.
139   - **IPv6** - IPv6 routed-forwarding.
140   - **IPv4 Scale** - IPv4 routed-forwarding with 20k, 200k and 2M FIB entries.
141   - **IPv6 Scale** - IPv6 routed-forwarding with 20k, 200k and 2M FIB entries.
142   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
143     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
144     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
145   - **COP** - IPv4 and IPv6 routed-forwarding with COP address security.
146   - **iACL** - IPv4 and IPv6 routed-forwarding with iACL address security.
147   - **LISP** - LISP overlay tunneling for IPv4-over-IPv4, IPv6-over-IPv4,
148     IPv6-over-IPv6, IPv4-over-IPv6 in IPv4 and IPv6 routed-forwarding modes.
149   - **VXLAN** - VXLAN overlay tunnelling integration with L2XC and L2BD.
150   - **QoS Policer** - ingress packet rate measuring, marking and limiting
151     (IPv4).
152   - **CGNAT** - Carrier Grade Network Address Translation tests with varying
153     number of users and ports per user.
154
155 - 2port40GE XL710 Intel
156
157   - **L2XC** - L2 Cross-Connect switched-forwarding of untagged Ethernet frames.
158   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
159     with MAC learning.
160   - **IPv4** - IPv4 routed-forwarding.
161   - **IPv6** - IPv6 routed-forwarding.
162   - **VMs with vhost-user** - virtual topologies with 1 VM and service chains
163     of 2 VMs using vhost-user interfaces, with VPP forwarding modes incl. L2
164     Cross-Connect, L2 Bridge-Domain, VXLAN with L2BD, IPv4 routed-forwarding.
165   - **IPSec** - IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in combination
166     with IPv4 routed-forwarding.
167   - **IPSec+LISP** - IPSec encryption with CBC-SHA1 ciphers, in combination
168     with LISP-GPE overlay tunneling for IPv4-over-IPv4.
169
170 - 2port10GE X710 Intel
171
172   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
173     with MAC learning.
174   - **VMs with vhost-user** - virtual topologies with 1 VM using vhost-user
175     interfaces, with VPP forwarding modes incl. L2 Bridge-Domain.
176
177 - 2port10GE VIC1227 Cisco
178
179   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
180     with MAC learning.
181
182 - 2port40GE VIC1385 Cisco
183
184   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames
185      with MAC learning.
186
187 Execution of performance tests takes time, especially the throughput discovery
188 tests. Due to limited HW testbed resources available within FD.io labs hosted
189 by :abbr:`LF (Linux Foundation)`, the number of tests for NICs other than X520
190 (a.k.a. Niantic) has been limited to few baseline tests. CSIT team expect the
191 HW testbed resources to grow over time, so that complete set of performance
192 tests can be regularly and(or) continuously executed against all models of
193 hardware present in FD.io labs.
194
195 Performance Tests Naming
196 ------------------------
197
198 CSIT |release| follows a common structured naming convention for all performance
199 and system functional tests, introduced in CSIT |release-1|.
200
201 The naming should be intuitive for majority of the tests. Complete description
202 of CSIT test naming convention is provided on `CSIT test naming wiki
203 <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
204
205 Methodology: Multi-Core and Multi-Threading
206 -------------------------------------------
207
208 **Intel Hyper-Threading** - CSIT |release| performance tests are executed with
209 SUT servers' Intel XEON processors configured in Intel Hyper-Threading Disabled
210 mode (BIOS setting). This is the simplest configuration used to establish
211 baseline single-thread single-core application packet processing and forwarding
212 performance. Subsequent releases of CSIT will add performance tests with Intel
213 Hyper-Threading Enabled (requires BIOS settings change and hard reboot of
214 server).
215
216 **Multi-core Tests** - CSIT |release| multi-core tests are executed in the
217 following VPP thread and core configurations:
218
219 #. 1t1c - 1 VPP worker thread on 1 CPU physical core.
220 #. 2t2c - 2 VPP worker threads on 2 CPU physical cores.
221
222 VPP worker threads are the data plane threads. VPP control thread is running on
223 a separate non-isolated core together with other Linux processes. Note that in
224 quite a few test cases running VPP workers on 2 physical cores hits the tested
225 NIC I/O bandwidth or packets-per-second limit.
226
227 Methodology: Packet Throughput
228 ------------------------------
229
230 Following values are measured and reported for packet throughput tests:
231
232 - NDR binary search per :rfc:`2544`:
233
234   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps
235     (2x <per direction packets-per-second>)"
236   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
237     second> Gbps (untagged)"
238
239 - PDR binary search per :rfc:`2544`:
240
241   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps (2x
242     <per direction packets-per-second>)"
243   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
244     second> Gbps (untagged)"
245   - Packet loss tolerance: "LOSS_ACCEPTANCE <accepted percentage of packets
246     lost at PDR rate>""
247
248 - NDR and PDR are measured for the following L2 frame sizes:
249
250   - IPv4: 64B, IMIX_v4_1 (28x64B,16x570B,4x1518B), 1518B, 9000B.
251   - IPv6: 78B, 1518B, 9000B.
252
253 All rates are reported from external Traffic Generator perspective.
254
255 Methodology: Packet Latency
256 ---------------------------
257
258 TRex Traffic Generator (TG) is used for measuring latency of VPP DUTs. Reported
259 latency values are measured using following methodology:
260
261 - Latency tests are performed at 10%, 50% of discovered NDR rate (non drop rate)
262   for each NDR throughput test and packet size (except IMIX).
263 - TG sends dedicated latency streams, one per direction, each at the rate of
264   10kpps at the prescribed packet size; these are sent in addition to the main
265   load streams.
266 - TG reports min/avg/max latency values per stream direction, hence two sets
267   of latency values are reported per test case; future release of TRex is
268   expected to report latency percentiles.
269 - Reported latency values are aggregate across two SUTs due to three node
270   topology used for all performance tests; for per SUT latency, reported value
271   should be divided by two.
272 - 1usec is the measurement accuracy advertised by TRex TG for the setup used in
273   FD.io labs used by CSIT project.
274 - TRex setup introduces an always-on error of about 2*2usec per latency flow -
275   additonal Tx/Rx interface latency induced by TRex SW writing and reading
276   packet timestamps on CPU cores without HW acceleration on NICs closer to the
277   interface line.
278
279
280 Methodology: KVM VM vhost
281 -------------------------
282
283 CSIT |release| introduced test environment configuration changes to KVM Qemu
284 vhost-user tests in order to more representatively measure |vpp-release|
285 performance in configurations with vhost-user interfaces and different Qemu
286 settings.
287
288 FD.io CSIT performance lab is testing VPP vhost with KVM VMs using following
289 environment settings:
290
291 - Tests with varying Qemu virtio queue (a.k.a. vring) sizes: [vr256] default 256
292   descriptors, [vr1024] 1024 descriptors to optimize for packet throughput;
293
294 - Tests with varying Linux :abbr:`CFS (Completely Fair Scheduler)` settings:
295   [cfs] default settings, [cfsrr1] CFS RoundRobin(1) policy applied to all data
296   plane threads handling test packet path including all VPP worker threads and
297   all Qemu testpmd poll-mode threads;
298
299 - Resulting test cases are all combinations with [vr256,vr1024] and
300   [cfs,cfsrr1] settings;
301
302 - Adjusted Linux kernel :abbr:`CFS (Completely Fair Scheduler)` scheduler policy
303   for data plane threads used in CSIT is documented in
304   `CSIT Performance Environment Tuning wiki <https://wiki.fd.io/view/CSIT/csit-perf-env-tuning-ubuntu1604>`_.
305   The purpose is to verify performance impact (NDR, PDR throughput) and
306   same test measurements repeatability, by making VPP and VM data plane
307   threads less susceptible to other Linux OS system tasks hijacking CPU
308   cores running those data plane threads.
309
310 Methodology: LXC and Docker Containers memif
311 --------------------------------------------
312
313 CSIT |release| introduced additional tests taking advantage of VPP memif
314 virtual interface (shared memory interface) tests to interconnect VPP
315 instances. VPP vswitch instance runs in bare-metal user-mode handling
316 Intel x520 NIC 10GbE interfaces and connecting over memif (Master side)
317 virtual interfaces to more instances of VPP running in :abbr:`LXC (Linux
318 Container)` or in Docker Containers,  both with memif virtual interfaces
319 (Slave side). LXCs and Docker Containers run in a priviliged mode with
320 VPP data plane worker threads pinned to dedicated physical CPU cores per
321 usual CSIT practice. All VPP instances run the same version of software.
322 This test topology is equivalent to existing tests with vhost-user and
323 VMs as described earlier in :ref:`tested_physical_topologies`.
324
325 More information about CSIT LXC and Docker Container setup and control
326 is available in :ref:`containter_orchestration_in_csit`.
327
328 Methodology: Container Topologies Orchestrated by K8s
329 -----------------------------------------------------
330
331 CSIT |release| introduced new tests of Container topologies connected
332 over the memif virtual interface (shared memory interface). In order to
333 provide simple topology coding flexibility and extensibility container
334 orchestration is done with `Kubernetes <https://github.com/kubernetes>`_
335 using `Docker <https://github.com/docker>`_ images for all container
336 applications including VPP. `Ligato <https://github.com/ligato>`_ is
337 used to address the container networking orchestration that is
338 integrated with K8s, including memif support.
339
340 For these tests VPP vswitch instance runs in a Docker Container handling
341 Intel x520 NIC 10GbE interfaces and connecting over memif (Master side)
342 virtual interfaces to more instances of VPP running in Docker Containers
343 with memif virtual interfaces (Slave side). All Docker Containers run in
344 a priviliged mode with VPP data plane worker threads pinned to dedicated
345 physical CPU cores per usual CSIT practice. All VPP instances run the
346 same version of software. This test topology is equivalent to existing
347 tests with vhost-user and VMs as described earlier in
348 :ref:`tested_physical_topologies`.
349
350 More information about CSIT Container Topologies Orchestrated by K8s is
351 available in :ref:`containter_orchestration_in_csit`.
352
353 Methodology: IPSec with Intel QAT HW cards
354 ------------------------------------------
355
356 VPP IPSec performance tests are using DPDK cryptodev device driver in
357 combination with HW cryptodev devices - Intel QAT 8950 50G - present in
358 LF FD.io physical testbeds. DPDK cryptodev can be used for all IPSec
359 data plane functions supported by VPP.
360
361 Currently CSIT |release| implements following IPSec test cases:
362
363 - AES-GCM, CBC-SHA1 ciphers, in combination with IPv4 routed-forwarding
364   with Intel xl710 NIC.
365 - CBC-SHA1 ciphers, in combination with LISP-GPE overlay tunneling for
366   IPv4-over-IPv4 with Intel xl710 NIC.
367
368 Methodology: TRex Traffic Generator Usage
369 -----------------------------------------
370
371 The `TRex traffic generator <https://wiki.fd.io/view/TRex>`_ is used for all
372 CSIT performance tests. TRex stateless mode is used to measure NDR and PDR
373 throughputs using binary search (NDR and PDR discovery tests) and for quick
374 checks of DUT performance against the reference NDRs (NDR check tests) for
375 specific configuration.
376
377 TRex is installed and run on the TG compute node. The typical procedure is:
378
379 - If the TRex is not already installed on TG, it is installed in the
380   suite setup phase - see `TRex intallation`_.
381 - TRex configuration is set in its configuration file
382   ::
383
384   /etc/trex_cfg.yaml
385
386 - TRex is started in the background mode
387   ::
388
389   $ 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
390
391 - There are traffic streams dynamically prepared for each test, based on traffic
392   profiles. The traffic is sent and the statistics obtained using
393   :command:`trex_stl_lib.api.STLClient`.
394
395 **Measuring packet loss**
396
397 - Create an instance of STLClient
398 - Connect to the client
399 - Add all streams
400 - Clear statistics
401 - Send the traffic for defined time
402 - Get the statistics
403
404 If there is a warm-up phase required, the traffic is sent also before test and
405 the statistics are ignored.
406
407 **Measuring latency**
408
409 If measurement of latency is requested, two more packet streams are created (one
410 for each direction) with TRex flow_stats parameter set to STLFlowLatencyStats. In
411 that case, returned statistics will also include min/avg/max latency values.