X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Ftag_documentation.rst;h=da2c790f6ef1ddda7c0af604f18e46ec634b3c97;hb=b8502d5ccf9030270fafe06fe860143b5f9b78d0;hp=5e51b918df57d03cf96130e1f418d9d750046ca7;hpb=73a01b1a7fc836c964627eea2c08106df0da5aee;p=csit.git diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst index 5e51b918df..da2c790f6e 100644 --- a/docs/tag_documentation.rst +++ b/docs/tag_documentation.rst @@ -9,6 +9,16 @@ documentation. Topology TAGs ------------- +.. topic:: 2_NODE_DOUBLE_LINK_TOPO + + 2 nodes connected in a circular topology with two links interconnecting + the devices. + +.. topic:: 2_NODE_SINGLE_LINK_TOPO + + 2 nodes connected in a circular topology with at least one link + interconnecting devices. + .. topic:: 3_NODE_DOUBLE_LINK_TOPO 3 nodes connected in a circular topology with two links interconnecting @@ -61,6 +71,10 @@ NIC model tags Intel X710 NIC. +.. topic:: NIC_Intel-XXV710 + + Intel XXV710 NIC. + .. topic:: NIC_Cisco-VIC-1227 VIC-1227 by Cisco. @@ -137,36 +151,17 @@ Tags marking functional vs. performance of tests Performance testing tags ------------------------ -.. topic:: PDRDISC - - Partial Drop Rate evaluation of single run result, with non-zero packet - loss tolerance (LT) expressed in percentage of packets transmitted. - -.. topic:: NDRDISC - - Non Drop Rate evaluation of results. Loss acceptance of dropped packets is - set to zero lost packets. +.. topic:: NDRPDR -.. topic:: NDRCHK - - Performance tests where TG verifies DUTs' throughput at ref-NDR (reference - Non Drop Rate) with zero packet loss tolerance. - -.. topic:: PDRCHK - - Performance tests where TG verifies DUTs' throughput at ref-PDR (reference - Partial Drop Rate) with 0.5% loss tolerance. + Single test finding both No Drop Rate and Partial Drop Rate simultaneously. + The search is done by optimized algorithm which performs + multiple trial runs at different durations and transmit rates. .. topic:: MRR Performance tests where TG sends the traffic at maximum rate (line rate) and reports total sent/received packets over performance trial duration. -.. topic:: NDRPDRDISC - - Find performance of DUT based on :rfc:`2544` with linear / binary / combined - search. (Previous LONG tests.) - Ethernet frame size tags for performance tests ---------------------------------------------- @@ -178,6 +173,10 @@ Ethernet frame size tags for performance tests 78B frames used for test. +.. topic:: 114B + + 114B frames used for test. + .. topic:: IMIX IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test. @@ -229,6 +228,11 @@ Test type tags L2BD baseline test cases, no encapsulation, no feature(s) configured in tests. +.. topic:: L2PATCH + + L2PATCH baseline test cases, no encapsulation, no feature(s) configured in + tests. + .. topic:: SCALE Scale test cases. @@ -245,6 +249,10 @@ Test type tags Functional test cases for TLDK. +.. topic:: DMM + + Functional test cases for DMM. + .. topic:: TCP Tests which use TCP. @@ -399,6 +407,36 @@ Interface tags All test cases which uses Memif. +.. topic:: SINGLE_MEMIF + + All test cases which uses only single Memif connection per DUT. One DUT + instance is running in container having one physical interface exposed to + container. + +.. topic:: LBOND + + All test cases which uses link bonding (BondEthernet interface). + +.. topic:: LBOND_DPDK + + All test cases which uses DPDK link bonding. + +.. topic:: LBOND_VPP + + All test cases which uses VPP link bonding. + +.. topic:: LBOND_MODE_XOR + + All test cases which uses link bonding with mode XOR. + +.. topic:: LBOND_MODE_LACP + + All test cases which uses link bonding with mode LACP. + +.. topic:: LBOND_LB_L34 + + All test cases which uses link bonding with load-balance mode l34. + Feature tags ------------ @@ -542,10 +580,12 @@ Multi-threading tags .. topic:: STHREAD - All test cases using single poll mode thread. + *Dynamic tag*. + All test cases using single poll mode thread. .. topic:: MTHREAD + *Dynamic tag*. All test cases using more then one poll mode driver thread. .. topic:: 1NUMA @@ -556,38 +596,61 @@ Multi-threading tags All test cases with packet processing on two sockets. -.. topic:: SMT +.. topic:: 1C + + 1 worker thread pinned to 1 dedicated physical core; or if HyperThreading is + enabled, 2 worker threads each pinned to a separate logical core within 1 + dedicated physical core. Main thread pinned to core 1. + +.. topic:: 2C - All test cases with symmetric Multi-Threading (HyperThreading) enabled. + 2 worker threads pinned to 2 dedicated physical cores; or if HyperThreading + is enabled, 4 worker threads each pinned to a separate logical core within 2 + dedicated physical cores. Main thread pinned to core 1. -.. topic:: NOSMT +.. topic:: 4C - All test cases with symmetric Multi-Threading (HyperThreading) disabled. + 4 worker threads pinned to 4 dedicated physical cores; or if HyperThreading + is enabled, 8 worker threads each pinned to a separate logical core within 4 + dedicated physical cores. Main thread pinned to core 1. .. topic:: 1T1C + *Dynamic tag*. 1 worker thread pinned to 1 dedicated physical core. 1 receive queue per - interface. Main thread pinned to core 0. + interface. Main thread pinned to core 1. .. topic:: 2T2C + *Dynamic tag*. 2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per - interface. Main thread pinned to core 0. + interface. Main thread pinned to core 1. .. topic:: 4T4C + *Dynamic tag*. 4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per - interface. Main thread pinned to core 0. + interface. Main thread pinned to core 1. + +.. topic:: 2T1C + + *Dynamic tag*. + 2 worker threads each pinned to a separate logical core within 1 dedicated + physical core. 1 receive queue per interface. Main thread pinned to core 1. -.. topic:: 6T6C +.. topic:: 4T2C - 6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per - interface. Main thread pinned to core 0. + *Dynamic tag*. + 4 worker threads each pinned to a separate logical core within 2 dedicated + physical cores. 2 receive queues per interface. Main thread pinned to core + 1. -.. topic:: 8T8C +.. topic:: 8T4C - 8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per - interface. Main thread pinned to core 0. + *Dynamic tag*. + 8 worker threads each pinned to a separate logical core within 4 dedicated + physical cores. 4 receive queues per interface. Main thread pinned to core + 1. Honeycomb tags --------------