Report: add 2n-tx2 static content
[csit.git] / docs / report / vpp_performance_tests / packet_throughput_graphs / index.rst
1
2 .. raw:: latex
3
4     \clearpage
5
6 .. _VPP_Packet_Throughput:
7
8 Packet Throughput
9 =================
10
11 Throughput graphs are generated based on the results data obtained from
12 the |csit-release| test jobs. In order to verify benchmark results
13 repeatibility selected, CSIT performance tests are executed multiple
14 times (target: 10 times) on each physical testbed type. Box-and-Whisker
15 plots are used to display variations in measured throughput values.
16
17 Lists of tests selected for multiple execution and graphing are captured
18 per testbed type in `test_select_list_{testbed_type}.md
19 <https://git.fd.io/csit/tree/docs/job_specs>`_ files.
20
21 Graphs are split into sections as follows:
22
23 #. **Header 1**: VPP packet path and lookup types
24
25    - **L2 Ethernet Switching**: L2 bridge-doman, L2 cross-connect and L2 patch
26    - **IPv4 Routing**: IPv4 routing with /32 prefixes
27    - **IPv6 Routing**: IPv6 routing with /128 prefixes
28    - **SRv6 Routing**: SRv6 with IPv6 routing
29    - **IPv4 Tunnels**: IPv4 overlay tunnels
30    - **KVM VMs vhost-user**: KVM VMs connected over virtio and vhost-user interfaces
31    - **LXC/DRC Container Memif**: Linux containers and Docker containers connected over Memif interfaces
32    - **IPsec IPv4 Routing**: IPsec encryption/decryption with IPv4 routing
33    - **Virtual Topology System**: VXLAN configurations with L2 bridge-domains
34
35 #. **Header 2**: testbeds and NIC models
36
37    - section name format:
38
39      - {**testbed_type**}-{**nic_model**}
40
41    - **testbed_type**:
42
43      - 2n-skx: 2-node Xeon Skylake
44      - 3n-skx: 3-node Xeon Skylake
45      - 2n-clx: 2-node Xeon Cascade Lake
46      - 3n-hsw: 3-node Xeon Haswell
47      - 3n-tsh: 3-node Arm TaiShan
48      - 2n-tx2: 2-node Arm ThunderX2
49      - 2n-dnv: 2-node Atom Denverton
50      - 3n-dnv: 3-node Atom Denverton
51
52    - **nic_model**:
53
54      - xxv710: xxv710 2p25GE Intel (Fortville)
55      - x710: x710 4p10GE Intel (Fortville)
56      - xl710: xl710 2p40GE Intel (Fortville)
57      - x520: x520 2p10GE Intel (Niantic)
58      - x553: x553 2p10GE Intel (Niantic)
59
60 #. **Header 3**: test group names
61
62    - section name format:
63
64      - {**frame_size**}-{**worker_thread_core_cfg**}-{**vpp_functionality**}-{**vpp_lookup_type**}-{**baseline_scale**}-{**nic_driver**}
65
66    - **frame_size**:
67
68      - 64b: 64 byte frames, smallest frame size for untagged IPv4 packets
69      - 78b: 78 byte frames, smallest frame size for untagged IPv6 packets
70      - 114b: VXLAN encapsulated L2 frames
71      - imix: a sequence of (7x64B, 4x570, 1x1518) byte frames
72
73    - **worker_thread_core_cfg**:
74
75      - 1t1c: 1 worker thread on 1 core, hyper-threading not used
76      - 2t1c: 2 worker threads on 1 core, hyper-threading used
77
78    - **vpp_functionality** (optional):
79
80      - features: including input-acl, output-acl, macip-iacl, nat44
81      - srv6: srv6 encap/decap, proxy
82      - link-bonding: L2 link aggregation with 1 or 2 bonded links
83      - ipsec: IPsec encryption/decryption with different ciphers
84      - vts: Virtual Topology System specific tests
85
86    - **vpp_lookup_type**:
87
88      - l2switching, ip4routing, ip6routing, ip4tunnel, vhost, memif
89
90    - **baseline_scale**:
91
92      - base: baseline tests with less than 10 forwarding entries
93      - scale: scale tests with up to 2 million forwarding entries
94      - base-scale: both baseline and scale tests grouped together
95
96    - **nic_driver**:
97
98      - avf: VPP native avf driver for Intel Fortville NICs
99      - i40e: dpdk poll mode driver for Intel Fortville NICs
100      - ixgbe: dpdk poll mode driver for Intel Niantic NICs
101
102 For each test case, Box-and-Whisker plots show the quartiles (Min, 1st
103 quartile / 25th percentile, 2nd quartile / 50th percentile / mean, 3rd
104 quartile / 75th percentile, Max) across collected data set. Outliers are
105 plotted as individual points.
106
107 Additional information about graph data:
108
109 #. **Graph Title**: describes tested packet path, testbed topology,
110    processor model, NIC model, packet size, number of cores and
111    threads used by data plane workers and indication of VPP DUT
112    configuration.
113
114 #. **X-axis Labels**: indices of individual test suites as listed in
115    Graph Legend.
116
117 #. **Y-axis Labels**: measured Packets Per Second [pps] throughput
118    values.
119
120 #. **Graph Legend**: lists X-axis indices with associated CSIT test
121    suites executed to generate graphed test results.
122
123 #. **Hover Information**: lists minimum, first quartile, median,
124    third quartile, and maximum. If either type of outlier is present the
125    whisker on the appropriate side is taken to 1.5×IQR from the quartile
126    (the "inner fence") rather than the max or min, and individual outlying
127    data points are displayed as unfilled circles (for suspected outliers)
128    or filled circles (for outliers). (The "outer fence" is 3×IQR from the
129    quartile.)
130
131 .. note::
132
133     Test results have been generated by
134     `FD.io test executor vpp performance job 2n-skx`_,
135     `FD.io test executor vpp performance job 3n-skx`_,
136     `FD.io test executor vpp performance job 2n-clx`_,
137     `FD.io test executor vpp performance job 2n-zn2`_,
138     `FD.io test executor vpp performance job 3n-hsw`_,
139     `FD.io test executor vpp performance job 3n-tsh`_,
140     `FD.io test executor vpp performance job 2n-tx2`_,
141     `FD.io test executor vpp performance job 2n-dnv`_ and
142     `FD.io test executor vpp performance job 3n-dnv`_ with RF
143     result files csit-vpp-perf-|srelease|-\*.zip
144     `archived here <../../_static/archive/>`_.
145     Required per test case data set size is **10**, but for VPP tests
146     the actual size varies per test case and is <=10.
147
148 .. toctree::
149     :maxdepth: 3
150
151     l2
152     ip4
153     ip6
154     srv6
155     ip4_tunnels
156     nat44
157     vm_vhost
158     container_memif
159     ipsec
160     vts