docs: TRex static documentation
[csit.git] / docs / report / trex_performance_tests / overview.rst
1 Overview
2 ========
3
4 TREX performance test results are reported for a range of processors.
5 For description of physical testbeds used for TREX performance tests
6 please refer to :ref:`tested_physical_topologies`.
7
8 Logical Topology
9 ----------------
10
11 CSIT TREX performance tests are executed on physical testbeds described
12 in :ref:`tested_physical_topologies`. Logical topology use 1 nic that has
13 loopback connected ports. See figure below.
14
15 .. only:: latex
16
17     .. raw:: latex
18
19         \begin{figure}[H]
20             \centering
21                 \graphicspath{{../_tmp/src/trex_performance_tests/}}
22                 \includegraphics[width=0.90\textwidth]{logical-TRex-nic2nic}
23                 \label{fig:logical-TRex-nic2nic}
24         \end{figure}
25
26 .. only:: html
27
28     .. figure:: logical-TRex-nic2nic.svg
29         :alt: logical-TRex-nic2nic
30         :align: center
31
32
33 Performance Tests Coverage
34 --------------------------
35
36 Performance tests measure following metrics for tested TRex
37 topologies and configurations:
38
39 - Packet Throughput: measured in accordance with :rfc:`2544`, using
40   FD.io CSIT Multiple Loss Ratio search (MLRsearch), an optimized binary
41   search algorithm, producing throughput at different Packet Loss Ratio
42   (PLR) values:
43
44   - Non Drop Rate (NDR): packet throughput at PLR=0%.
45   - Partial Drop Rate (PDR): packet throughput at PLR=0.5%.
46
47 - Two-way Packet Latency: measured both east-west and west-east at different
48   offered packet loads:
49
50   - 90% of discovered PDR throughput.
51   - 50% of discovered PDR throughput.
52   - 10% of discovered PDR throughput.
53   - Minimal offered load.
54
55 |csit-release| includes following TRex data plane functionality
56 performance tested across a range of NIC drivers and NIC models:
57
58 +-----------------------+----------------------------------------------+
59 | Functionality         |  Description                                 |
60 +=======================+==============================================+
61 | IPv4 Base             | IPv4 routing.                                |
62 +-----------------------+----------------------------------------------+
63 | IPv4 Scale            | IPv4 routing with 2M entries.                |
64 +-----------------------+----------------------------------------------+
65 | IPv6 Base             | IPv6 routing.                                |
66 +-----------------------+----------------------------------------------+
67 | IPv6 Scale            | IPv6 routing with 2M entries.                |
68 +-----------------------+----------------------------------------------+
69 | L2BD Scale            | L2 Bridge-Domain switching of untagged       |
70 |                       | Ethernet frames.                             |
71 +-----------------------+----------------------------------------------+
72
73
74 Performance Tests Naming
75 ------------------------
76
77 FD.io |csit-release| follows a common structured naming convention for
78 all performance and system functional tests, introduced in CSIT-17.01.
79
80 The naming should be intuitive for majority of the tests. Complete
81 description of FD.io CSIT test naming convention is provided on
82 :ref:`csit_test_naming`.