VIC-1385 by Cisco.
+.. topic:: NIC_Amazon-Nitro-50G
+
+ Amazon EC2 ENA NIC.
+
Scaling Tags
------------
IPSec in tunnel mode - {t} tunnels.
-.. topic:: SRC_USER_1
-
- Traffic flow with 1 unique IP (users) in one direction.
-
-.. topic:: SRC_USER_10
-
- Traffic flow with 10 unique IPs (users) in one direction.
-
-.. topic:: SRC_USER_100
-
- Traffic flow with 100 unique IPs (users) in one direction.
+.. topic:: SRC_USER_{u}
-.. topic:: SRC_USER_1000
-
- Traffic flow with 1000 unique IPs (users) in one direction.
-
-.. topic:: SRC_USER_2000
-
- Traffic flow with 2000 unique IPs (users) in one direction.
-
-.. topic:: SRC_USER_4000
-
- Traffic flow with 4000 unique IPs (users) in one direction.
+ Traffic flow with {u} unique IPs (users) in one direction.
+ {u}=(1,10,100,1000,2000,4000).
.. topic:: 100_FLOWS
Traffic stream with 100 000 unique flows (100 IPs/users x 1000 UDP ports) in
one direction.
+.. topic:: HOSTS_{h}
+
+ Stateless or stateful traffic stream with {h} client source IP4 addresses,
+ usually with 63 flow differing in source port number. Could be UDP or TCP.
+ If NAT is used, the clients are inside. Outside IP range can differ.
+ {h}=(1024,4096,16384,65536,262144).
+
+.. topic:: GENEVE4_{t}TUN
+
+ Test with {t} GENEVE IPv4 tunnel. {t}=(1,4,16,64,256,1024)
+
Test Category Tags
------------------
-.. topic:: FUNCTEST
+.. topic:: DEVICETEST
- All functional test cases.
+ All vpp_device functional test cases.
.. topic:: PERFTEST
All performance test cases.
+VPP Device Type Tags
+--------------------
+
+.. topic:: SCAPY
+
+ All test cases that uses Scapy for packet generation and validation.
+
Performance Type Tags
---------------------
"primary" traffic in case of asymmetric load.
For traffic between DUTs, or for "secondary" traffic, see ${overhead} value.
-.. topic:: 64B
-
- 64B frames used for test. Generic ethernet or IPv4.
+.. topic:: {b}B
-.. topic:: 78B
-
- 78B frames used for test. Ipv6.
-
-.. topic:: 114B
-
- 114B frames used for test. IPv4+vxlan.
-
-.. topic:: 118B
-
- 118B frames used for test. Dot1q+IPv4+vxlan.
+ {b} Bytes frames used for test.
.. topic:: IMIX
IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
-.. topic:: 1460B
-
- 1460B frames used for test.
-
-.. topic:: 1480B
-
- 1480B frames used for test.
-
-.. topic:: 1514B
-
- 1514B frames used for test.
-
-.. topic:: 1518B
-
- 1518B frames used for test.
-
-.. topic:: 9000B
-
- 9000B frames used for test.
-
Test Type Tags
--------------
.. topic:: BASE
Baseline test cases, no encapsulation, no feature(s) configured in tests.
+ No scaling whatsoever, beyond minimum needed for RSS.
.. topic:: IP4BASE
IPv4 baseline test cases, no encapsulation, no feature(s) configured in
- tests.
+ tests. Minimal number of routes. Other quantities may be scaled.
.. topic:: IP6BASE
.. topic:: SCALE
- Scale test cases.
+ Scale test cases. Other tags specify which quantities are scaled.
+ Also applies if scaling is set on TG only (e.g. DUT works as IP4BASE).
.. topic:: ENCAP
At least one feature is configured in test cases. Use also feature tag(s).
-.. topic:: TLDK
+.. topic:: UDP
- Functional test cases for TLDK.
+ Tests which use any kind of UDP traffic (STL or ASTF profile).
-.. topic:: DMM
+.. topic:: TCP
- Functional test cases for DMM.
+ Tests which use any kind of TCP traffic (STL or ASTF profile).
-.. topic:: TCP
+.. topic:: TREX
+
+ Tests which test trex traffic without any software DUTs in the traffic path.
+
+..
+ TODO: Should we define tags STL and ASTF?
+
+.. topic:: UDP_UDIR
- Tests which use TCP.
+ Tests which use unidirectional UDP traffic (STL profile only).
+
+.. topic:: UDP_BIDIR
+
+ Tests which use bidirectional UDP traffic (STL profile only).
+
+.. topic:: UDP_CPS
+
+ Tests which measure connections per second on minimal UDP pseudoconnections.
+ This implies ASTF traffic profile is used.
+ This tag selects specific output processing in PAL.
.. topic:: TCP_CPS
- Performance tests which measure connections per second using http requests.
+ Tests which measure connections per second on empty TCP connections.
+ This implies ASTF traffic profile is used.
+ This tag selects specific output processing in PAL.
.. topic:: TCP_RPS
- Performance tests which measure requests per second using http requests.
+ Tests which measure requests per second on empty TCP connections.
+ This implies ASTF traffic profile is used.
+ This tag selects specific output processing in PAL.
+
+.. topic:: UDP_PPS
+
+ Tests which measure packets per second on lightweight UDP transactions.
+ This implies ASTF traffic profile is used.
+ This tag selects specific output processing in PAL.
+
+.. topic:: TCP_PPS
+
+ Tests which measure packets per second on lightweight TCP transactions.
+ This implies ASTF traffic profile is used.
+ This tag selects specific output processing in PAL.
.. topic:: HTTP
- Tests which use HTTP.
+ Tests which use traffic formed of valid HTTP requests (and responses).
+
+..
+ TODO: Add HTTP tag to the current hoststack tests.
+ TODO: Document other tags already used by hoststack tests.
+
+.. topic:: LDP_NGINX
+
+ LDP NGINX is un-modified NGINX with VPP via LD_PRELOAD.
.. topic:: NF_DENSITY
VPP Load balancer nat4 mode.
+.. topic:: N2N
+
+ Mode, where NICs from the same physical server are directly
+ connected with a cable.
+
Underlay Tags
-------------
All test cases with GRE.
+.. topic:: GTPU
+
+ All test cases with GTPU.
+
.. topic:: IPSEC
All test cases with IPSEC.
All SRv6 test cases with two SIDs and without decapsulation.
+.. topic:: GENEVE
+
+ All test cases with GENEVE.
+
+.. topic:: GENEVE_L3MODE
+
+ All test cases with GENEVE tunnel in L3 mode.
+
+.. topic:: FLOW
+
+ All test cases with FLOW.
+
+.. topic:: NTUPLE
+
+ All test cases with NTUPLE.
+
+.. topic:: L2TPV3
+
+ All test cases with L2TPV3.
+
Interface Tags
--------------
All test cases which use physical interface(s).
+.. topic:: GSO
+
+ All test cases which uses Generic Segmentation Offload.
+
.. topic:: VHOST
All test cases which uses VHOST.
-.. topic:: VHOST_256
+.. topic:: VHOST_1024
- All test cases which uses VHOST with qemu queue size set to 256.
+ All test cases which uses VHOST DPDK driver with qemu queue size set
+ to 1024.
-.. topic:: VHOST_1024
+.. topic:: VIRTIO
+
+ All test cases which uses VIRTIO native VPP driver.
+
+.. topic:: VIRTIO_1024
- All test cases which uses VHOST with qemu queue size set to 1024.
+ All test cases which uses VIRTIO native VPP driver with qemu queue size set
+ to 1024.
.. topic:: CFS_OPT
All test cases which uses link bonding with load-balance mode l34.
-.. topic:: LBOND_1L
+.. topic:: LBOND_{n}L
- All test cases which uses one link for link bonding.
+ All test cases which use {n} link(s) for link bonding.
-.. topic:: LBOND_2L
+.. topic:: DRV_{d}
- All test cases which uses two links for link bonding.
+ All test cases which NIC Driver for DUT is set to {d}. Default is VFIO_PCI.
+ {d}=(AVF, RDMA_CORE, VFIO_PCI, AF_XDP).
-.. topic:: DRV_AVF
+.. topic:: TG_DRV_{d}
- All test cases which uses Intel Adaptive Virtual Function (AVF) device
- plugin for VPP. This plugins provides native device support for Intel AVF.
- AVF is driver specification for current and future Intel Virtual Function
- devices. In essence, today this driver can be used only with Intel
- XL710 / X710 / XXV710 adapters.
+ All test cases which NIC Driver for TG is set to {d}. Default is IGB_UIO.
+ {d}=(RDMA_CORE, IGB_UIO).
-.. topic:: DRV_VFIO_PCI
+.. topic:: RXQ_SIZE_{n}
- All test cases which uses vfio-pci device driver. It supports variety of NIC
- adapters.
+ All test cases which RXQ size (RX descriptors) are set to {n}. Default is 0,
+ which means VPP (API) default.
-.. topic:: DRV_RDMA_CORE
+.. topic:: TXQ_SIZE_{n}
- All test cases which uses rdma-core device driver. It supports Mellanox
- NIC adapters.
+ All test cases which TXQ size (TX descriptors) are set to {n}. Default is 0,
+ which means VPP (API) default.
Feature Tags
------------
iACL destination.
-.. topic:: COPWHLIST
+.. topic:: ADLALWLIST
- COP whitelist.
+ ADL allowlist.
.. topic:: NAT44
IPSec using HMAC SHA 512 integrity algorithms.
+.. topic:: SCHEDULER
+
+ IPSec using crypto sw scheduler engine.
+
Client-Workload Tags
--------------------
Container Orchestration Tags
----------------------------
-.. topic:: 1VSWITCH
-
- VPP running in Docker container acting as VSWITCH.
+.. topic:: {n}VSWITCH
-.. topic:: 1VNF
+ {n} VPP running in {n} Docker container(s) acting as a VSWITCH.
+ {n}=(1).
- 1 VPP running in Docker container acting as VNF work load.
+.. topic:: {n}VNF
-.. topic:: 2VNF
-
- 2 VPP running in 2 Docker containers acting as VNF work load.
-
-.. topic:: 4VNF
-
- 4 VPP running in 4 Docker containers acting as VNF work load.
+ {n} VPP running in {n} Docker container(s) acting as a VNF work load.
+ {n}=(1).
Multi-Threading Tags
--------------------
*Dynamic tag*.
All test cases using more then one poll mode driver thread.
-.. topic:: 1NUMA
-
- All test cases with packet processing on single socket.
-
-.. topic:: 2NUMA
-
- All test cases with packet processing on two sockets.
-
-.. topic:: 1C
+.. topic:: {n}NUMA
- 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.
+ All test cases with packet processing on {n} socket(s). {n}=(1,2).
-.. topic:: 2C
+.. topic:: {c}C
- 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.
+ {c} worker thread pinned to {c} dedicated physical core; or if
+ HyperThreading is enabled, {c}*2 worker threads each pinned to a separate
+ logical core within 1 dedicated physical core. Main thread pinned to core 1.
+ {t}=(1,2,4).
-.. topic:: 4C
-
- 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 1.
-
-.. topic:: 2T2C
-
- *Dynamic tag*.
- 2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
- 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 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:: 4T2C
+.. topic:: {t}T{c}C
*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:: 8T4C
-
- *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
---------------
-
-.. topic:: HC_FUNC
-
- Honeycomb functional test cases.
-
-.. topic:: HC_NSH
-
- Honeycomb NSH test cases.
-
-.. topic:: HC_PERSIST
-
- Honeycomb persistence test cases.
-
-.. topic:: HC_REST_ONLY
-
- (Exclusion tag) Honeycomb test cases that cannot be run in Netconf mode
- using ODL client for Restfconf -> Netconf translation.
+ {t} worker threads pinned to {c} dedicated physical cores. Main thread
+ pinned to core 1. By default CSIT is configuring same amount of receive
+ queues per interface as worker threads. {t}=(1,2,4,8), {t}=(1,2,4).