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/resources/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
  34 #. **Header 2**: testbeds and NIC models
  35
  36    - section name format:
  37
  38      - {**testbed_type**}-{**nic_model**}
  39
  40    - **testbed_type**:
  41
  42      - 2n-icx: 2-node Xeon Icelake
  43      - 3n-icx: 3-node Xeon Icelake
  44      - 2n-aws: 2-node AWS
  45      - 2n-clx: 2-node Xeon Cascade Lake
  46      - 2n-zn2: 2-node AMD Zen2
  47      - 3n-alt: 2-node Arm Altra
  48      - 3n-tsh: 3-node Arm TaiShan
  49      - 2n-tx2: 2-node Arm ThunderX2
  50      - 3n-snr: 3-node Atom Snowridge
  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      - cx556a: cx556a-edat 2p100GE Mellanox ConnectX5
  60      - e810cq: E810-2CQDA2 2p100GE Intel Columbiaville
  61
  62 #. **Header 3**: test group names
  63
  64    - section name format:
  65
  66      - {**frame_size**}-{**worker_thread_core_cfg**}-{**vpp_functionality**}-{**vpp_lookup_type**}-{**baseline_scale**}-{**nic_driver**}
  67
  68    - **frame_size**:
  69
  70      - 64b: 64 byte frames, smallest frame size for untagged IPv4 packets
  71      - 78b: 78 byte frames, smallest frame size for untagged IPv6 packets
  72      - 114b: VXLAN encapsulated L2 frames
  73      - imix: a sequence of (7x64B, 4x570, 1x1518) byte frames
  74
  75    - **worker_thread_core_cfg**:
  76
  77      - 1t1c: 1 worker thread on 1 core, hyper-threading not used
  78      - 2t1c: 2 worker threads on 1 core, hyper-threading used
  79
  80    - **vpp_functionality** (optional):
  81
  82      - features: including input-acl, output-acl, macip-iacl, nat44
  83      - srv6: srv6 encap/decap, proxy
  84      - link-bonding: L2 link aggregation with 1 or 2 bonded links
  85      - ipsec: IPsec encryption/decryption with different ciphers
  86      - vts: Virtual Topology System specific tests
  87
  88    - **vpp_lookup_type**:
  89
  90      - l2switching, ip4routing, ip6routing, ip4tunnel, vhost, memif
  91
  92    - **baseline_scale**:
  93
  94      - base: baseline tests with less than 10 forwarding entries
  95      - scale: scale tests with up to 2 million forwarding entries
  96      - base-scale: both baseline and scale tests grouped together
  97
  98    - **nic_driver**:
  99
 100      - avf: VPP native avf driver for Intel Fortville NICs
 101      - i40e: dpdk poll mode driver for Intel Fortville NICs
 102      - ixgbe: dpdk poll mode driver for Intel Niantic NICs
 103
 104 For each test case, Box-and-Whisker plots show the quartiles (Min, 1st
 105 quartile / 25th percentile, 2nd quartile / 50th percentile / mean, 3rd
 106 quartile / 75th percentile, Max) across collected data set. Outliers are
 107 plotted as individual points.
 108
 109 Additional information about graph data:
 110
 111 #. **Graph Title**: describes tested packet path, testbed topology,
 112    processor model, NIC model, packet size, number of cores and
 113    threads used by data plane workers and indication of VPP DUT
 114    configuration.
 115
 116 #. **X-axis Labels**: indices of individual test suites as listed in
 117    Graph Legend.
 118
 119 #. **Y-axis Labels**: measured Packets Per Second [pps] throughput
 120    values.
 121
 122 #. **Graph Legend**: lists X-axis indices with associated CSIT test
 123    suites executed to generate graphed test results.
 124
 125 #. **Hover Information**: lists minimum, first quartile, median,
 126    third quartile, and maximum. If either type of outlier is present the
 127    whisker on the appropriate side is taken to 1.5×IQR from the quartile
 128    (the "inner fence") rather than the max or min, and individual outlying
 129    data points are displayed as unfilled circles (for suspected outliers)
 130    or filled circles (for outliers). (The "outer fence" is 3×IQR from the
 131    quartile.)
 132
 133 .. note::
 134
 135     Test results are stored in
 136     `build logs from FD.io vpp performance job 2n-icx`_,
 137     `build logs from FD.io vpp performance job 3n-icx`_,
 138     `build logs from FD.io vpp performance job 2n-aws`_,
 139     `build logs from FD.io vpp performance job 2n-clx`_,
 140     `build logs from FD.io vpp performance job 2n-zn2`_,
 141     `build logs from FD.io vpp performance job 3n-alt`_,
 142     `build logs from FD.io vpp performance job 3n-tsh`_,
 143     `build logs from FD.io vpp performance job 2n-tx2`_,
 144     `build logs from FD.io vpp performance job 3n-snr`_ with RF
 145     result files csit-vpp-perf-|srelease|-\*.zip
 146     `archived here <../../_static/archive/>`_.
 147     Required per test case data set size is **10**, but for VPP tests
 148     the actual size varies per test case and is <=10.
 149
 150 .. toctree::
 151     :maxdepth: 3
 152
 153     l2
 154     ip4
 155     ip6
 156     srv6
 157     ip4_tunnels
 158     nat44
 159     vm_vhost
 160     container_memif
 161     ipsec