docs/report/testpmd_performance_tests_hw/csit_release_notes.rst

   1 CSIT Release Notes
   2 ==================
   3
   4 Changes in CSIT |release|
   5 -------------------------
   6
   7 #. Naming change for all Testpmd performance test suites and test cases.
   8
   9 #. Added Testpmd tests
  10
  11     - new NICs - Intel x520
  12
  13
  14 Performance Tests Naming
  15 ------------------------
  16
  17 CSIT |release| introduced a common structured naming convention for all
  18 performance and functional tests. This change was driven by substantially
  19 growing number and type of CSIT test cases. Firstly, the original practice did
  20 not always follow any strict naming convention. Secondly test names did not
  21 always clearly capture tested packet encapsulations, and the actual type or
  22 content of the tests. Thirdly HW configurations in terms of NICs, ports and
  23 their locality were not captured either. These were but few reasons that drove
  24 the decision to change and define a new more complete and stricter test naming
  25 convention, and to apply this to all existing and new test cases.
  26
  27 The new naming should be intuitive for majority of the tests. The complete
  28 description of CSIT test naming convention is provided on `CSIT test naming wiki
  29 <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
  30
  31 Here few illustrative examples of the new naming usage for performance test
  32 suites:
  33
  34 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**
  35
  36     - *PortNICConfig-WireEncapsulation-PacketForwardingFunction-
  37       PacketProcessingFunction1-...-PacketProcessingFunctionN-TestType*
  38     - *10ge2p1x520-dot1q-l2bdbasemaclrn-ndrdisc.robot* => 2 ports of 10GE on
  39       Intel x520 NIC, dot1q tagged Ethernet, L2 bridge-domain baseline switching
  40       with MAC learning, NDR throughput discovery.
  41     - *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-ndrchk.robot* => 2 ports of 10GE
  42       on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain baseline
  43       switching with MAC learning, NDR throughput discovery.
  44     - *10ge2p1x520-ethip4-ip4base-ndrdisc.robot* => 2 ports of 10GE on Intel
  45       x520 NIC, IPv4 baseline routed forwarding, NDR throughput discovery.
  46     - *10ge2p1x520-ethip6-ip6scale200k-ndrdisc.robot* => 2 ports of 10GE on
  47       Intel x520 NIC, IPv6 scaled up routed forwarding, NDR throughput
  48       discovery.
  49
  50 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,
  51    P2V2P, NIC2VMchain2NIC, P2V2V2P**
  52
  53     - *PortNICConfig-WireEncapsulation-PacketForwardingFunction-
  54       PacketProcessingFunction1-...-PacketProcessingFunctionN-VirtEncapsulation-
  55       VirtPortConfig-VMconfig-TestType*
  56     - *10ge2p1x520-dot1q-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc.robot* => 2 ports
  57       of 10GE on Intel x520 NIC, dot1q tagged Ethernet, L2 bridge-domain
  58       switching to/from two vhost interfaces and one VM, NDR throughput
  59       discovery.
  60     - *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc.robot* => 2
  61       ports of 10GE on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain
  62       switching to/from two vhost interfaces and one VM, NDR throughput
  63       discovery.
  64     - *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-eth-4vhost-2vm-ndrdisc.robot* => 2
  65       ports of 10GE on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain
  66       switching to/from four vhost interfaces and two VMs, NDR throughput
  67       discovery.
  68
  69 Multi-Thread and Multi-Core Measurements
  70 ----------------------------------------
  71
  72 **HyperThreading** - CSIT |release| performance tests are executed with SUT
  73 servers' Intel XEON CPUs configured in HyperThreading Disabled mode (BIOS
  74 settings). This is the simplest configuration used to establish baseline
  75 single-thread single-core SW packet processing and forwarding performance.
  76 Subsequent releases of CSIT will add performance tests with Intel
  77 HyperThreading Enabled (requires BIOS settings change and hard reboot).
  78
  79 **Multi-core Test** - CSIT |release| multi-core tests are executed in the
  80 following Testpmd thread and core configurations:
  81
  82 #. 1t1c - 1 Testpmd worker thread on 1 CPU physical core.
  83 #. 2t2c - 2 Testpmd worker threads on 2 CPU physical cores.
  84 #. 4t4c - 4 Testpmd threads on 4 CPU physical cores.
  85
  86 Note that in quite a few test cases running Testpmd on 2 or 4 physical cores
  87 hits the tested NIC I/O bandwidth or packets-per-second limit.
  88
  89 Packet Throughput Measurements
  90 ------------------------------
  91
  92 Following values are measured and reported for packet throughput tests:
  93
  94 - NDR binary search per RFC2544:
  95
  96   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps
  97     (2x <per direction packets-per-second>)"
  98   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
  99     second> Gbps (untagged)"
 100
 101 - PDR binary search per RFC2544:
 102
 103   - Packet rate: "RATE: <aggregate packet rate in packets-per-second> pps (2x
 104     <per direction packets-per-second>)"
 105   - Aggregate bandwidth: "BANDWIDTH: <aggregate bandwidth in Gigabits per
 106     second> Gbps (untagged)"
 107   - Packet loss tolerance: "LOSS_ACCEPTANCE <accepted percentage of packets
 108     lost at PDR rate>""
 109
 110 - NDR and PDR are measured for the following L2 frame sizes:
 111
 112   - IPv4: 64B, 1518B, 9000B.
 113
 114
 115 Packet Latency Measurements
 116 ---------------------------
 117
 118 TRex Traffic Generator (TG) is used for measuring latency of Testpmd DUTs.
 119 Reported latency values are measured using following methodology:
 120
 121 - Latency tests are performed at 10%, 50% of discovered NDR rate (non drop rate)
 122   for each NDR throughput test and packet size (except IMIX).
 123 - TG sends dedicated latency streams, one per direction, each at the rate of
 124   10kpps at the prescribed packet size; these are sent in addition to the main
 125   load streams.
 126 - TG reports min/avg/max latency values per stream direction, hence two sets
 127   of latency values are reported per test case; future release of TRex is
 128   expected to report latency percentiles.
 129 - Reported latency values are aggregate across two SUTs due to three node
 130   topology used for all performance tests; for per SUT latency, reported value
 131   should be divided by two.
 132 - 1usec is the measurement accuracy advertised by TRex TG for the setup used in
 133   FD.io labs used by CSIT project.
 134 - TRex setup introduces an always-on error of about 2*2usec per latency flow -
 135   additonal Tx/Rx interface latency induced by TRex SW writing and reading
 136   packet timestamps on CPU cores without HW acceleration on NICs closer to the
 137   interface line.
 138
 139
 140 Report Addendum Tests - More NICs
 141 ---------------------------------
 142
 143 Adding test cases with more NIC types. Once the results become available, they
 144 will be published as an addendum to the current version of CSIT |release|
 145 report.