feat(infra): Topology file for 3n-snr
[csit.git] / resources / libraries / python / Constants.py
index f8c4c7f..ace8e55 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Cisco and/or its affiliates.
+# Copyright (c) 2022 Cisco and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
@@ -119,6 +119,12 @@ def get_optimistic_bool_from_env(env_var_names):
 class Constants:
     """Constants used in CSIT."""
 
+    # Version for CSIT data model. See docs/model/.
+    MODEL_VERSION = u"1.0.1"
+
+    # Global off-switch in case JSON export is large or slow.
+    EXPORT_JSON = get_optimistic_bool_from_env(u"EXPORT_JSON")
+
     # OpenVPP testing directory location at topology nodes
     REMOTE_FW_DIR = u"/tmp/openvpp-testing"
 
@@ -180,7 +186,7 @@ class Constants:
     QEMU_VM_IMAGE = u"/var/lib/vm/image.iso"
 
     # QEMU VM DPDK path
-    QEMU_VM_DPDK = u"/opt/dpdk-21.02"
+    QEMU_VM_DPDK = u"/opt/dpdk-22.03"
 
     # Docker container SUT image
     DOCKER_SUT_IMAGE_UBUNTU = u"csit_sut-ubuntu2004:local"
@@ -189,7 +195,7 @@ class Constants:
     DOCKER_SUT_IMAGE_UBUNTU_ARM = u"csit_sut-ubuntu2004:local"
 
     # TRex install directory
-    TREX_INSTALL_DIR = u"/opt/trex-core-2.88"
+    TREX_INSTALL_DIR = u"/opt/trex-core-2.97"
 
     # TRex pcap files directory
     TREX_PCAP_DIR = f"{TREX_INSTALL_DIR}/scripts/avl"
@@ -198,7 +204,7 @@ class Constants:
     TREX_LIMIT_MEMORY = get_int_from_env(u"TREX_LIMIT_MEMORY", 8192)
 
     # TRex number of cores
-    TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 8)
+    TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 16)
 
     # TRex set number of RX/TX descriptors
     # Set to 0 to use default values
@@ -216,9 +222,11 @@ class Constants:
     TREX_EXTRA_CMDLINE = get_str_from_env(
         u"TREX_EXTRA_CMDLINE", u"--mbuf-factor 32")
 
-    # graph node variant value
-    GRAPH_NODE_VARIANT = get_str_from_env(
-        u"GRAPH_NODE_VARIANT", u"")
+    # Graph node variant value
+    GRAPH_NODE_VARIANT = get_str_from_env(u"GRAPH_NODE_VARIANT", u"")
+
+    # Default memory page size in case multiple configured in system
+    DEFAULT_HUGEPAGE_SIZE = get_str_from_env(u"DEFAULT_HUGEPAGE_SIZE", u"2M")
 
     # Sysctl kernel.core_pattern
     KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core"
@@ -238,6 +246,12 @@ class Constants:
     # Default path to VPP API socket.
     SOCKSVR_PATH = u"/run/vpp/api.sock"
 
+    # Default path to VPP CLI socket.
+    SOCKCLI_PATH = u"/run/vpp/cli.sock"
+
+    # Default path to VPP API Stats socket.
+    SOCKSTAT_PATH = u"/run/vpp/stats.sock"
+
     # Number of trials to execute in MRR test.
     PERF_TRIAL_MULTIPLICITY = get_int_from_env(u"PERF_TRIAL_MULTIPLICITY", 10)
 
@@ -261,6 +275,14 @@ class Constants:
         u"PERF_TRIAL_ASTF_DELAY", 0.112
     )
 
+    # Number of data frames in TPUT transaction, used both by TCP and UDP.
+    # The value should be 33 to keep historic continuity for UDP TPUT tests,
+    # but we are limited by TRex window of 48 KiB, so for 9000B tests
+    # it means we can send only 5 full data frames in a burst.
+    # https://github.com/cisco-system-traffic-generator/
+    # trex-core/blob/v2.88/src/44bsd/tcp_var.h#L896-L903
+    ASTF_N_DATA_FRAMES = get_int_from_env(u"ASTF_N_DATA_FRAMES", 5)
+
     # Extended debug (incl. vpp packet trace, linux perf stat, ...).
     # Full list is available as suite variable (__init__.robot) or is
     # override by test.
@@ -271,9 +293,6 @@ class Constants:
     #  /tmp directory is inside the DUT1 docker.
     DUT1_UUID = get_str_from_env(u"DUT1_UUID", u"")
 
-    # Default path to VPP API Stats socket.
-    SOCKSTAT_PATH = u"/run/vpp/stats.sock"
-
     # Global "kill switch" for CRC checking during runtime.
     FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env(
         u"FAIL_ON_CRC_MISMATCH"
@@ -292,6 +311,8 @@ class Constants:
         u"Intel-X710": 10000000000,
         u"Intel-XL710": 24500000000,
         u"Intel-XXV710": 24500000000,
+        u"Intel-E810XXV": 24500000000,
+        u"Intel-E822CQ": 24500000000,
         u"Intel-E810CQ": 100000000000,
         u"Mellanox-CX556A": 100000000000,
         u"Amazon-Nitro-50G": 10000000000,
@@ -305,14 +326,10 @@ class Constants:
         u"Intel-X710": 14880952,
         u"Intel-XL710": 18750000,
         u"Intel-XXV710": 18750000,
+        u"Intel-E810XXV": 29000000,
+        u"Intel-E822CQ": 29000000,
         u"Intel-E810CQ": 58500000,
-        # 2n-clx testbeds show duration stretching on high rates,
-        # depending on encapsulation TRex has to generate.
-        # 40 Mpps is still too much for dot1q (~8% stretching).
-        # 36 Mpps is around the maximal VPP throughput (l2patch 4c8t).
-        # Vxlan traffic will still show stretching at 36 Mpps (>12%),
-        # but we do not care about those tests that much.
-        u"Mellanox-CX556A": 36000000, # 148809523,
+        u"Mellanox-CX556A": 148809523,
         u"Amazon-Nitro-50G": 1200000,
         u"virtual": 14880952,
     }
@@ -324,11 +341,27 @@ class Constants:
         u"Intel-X710": u"10ge2p1x710",
         u"Intel-XL710": u"40ge2p1xl710",
         u"Intel-XXV710": u"25ge2p1xxv710",
+        u"Intel-E810XXV": u"25ge2p1e810xxv",
+        u"Intel-E822CQ": u"25ge2p1e822cq",
         u"Intel-E810CQ": u"100ge2p1e810cq",
-        u"Amazon-Nitro-50G": u"50ge1p1ENA",
+        u"Amazon-Nitro-50G": u"50ge1p1ena",
         u"Mellanox-CX556A": u"100ge2p1cx556a",
     }
 
+    # Shortened lowercase NIC model name, useful for presentation.
+    NIC_CODE_TO_SHORT_NAME = {
+        u"10ge2p1x520": u"x520",
+        u"10ge2p1x553": u"x553",
+        u"10ge2p1x710": u"x710",
+        u"40ge2p1xl710": u"xl710",
+        u"25ge2p1xxv710": u"xxv710",
+        u"25ge2p1e810xxv": u"e810xxv",
+        u"25ge2p1e822cq": u"e822cq",
+        u"100ge2p1e810cq": u"e810cq",
+        u"50ge1p1ena": u"ena",
+        u"100ge2p1cx556a": u"cx556a",
+    }
+
     # Not each driver is supported by each NIC.
     NIC_NAME_TO_DRIVER = {
         u"Intel-X520-DA2": [u"vfio-pci", u"af_xdp"],
@@ -336,6 +369,8 @@ class Constants:
         u"Intel-X710": [u"vfio-pci", u"avf", u"af_xdp"],
         u"Intel-XL710": [u"vfio-pci", u"avf", u"af_xdp"],
         u"Intel-XXV710": [u"vfio-pci", u"avf", u"af_xdp"],
+        u"Intel-E810XXV": [u"vfio-pci", u"avf", u"af_xdp"],
+        u"Intel-E822CQ": [u"vfio-pci", u"avf", u"af_xdp"],
         u"Intel-E810CQ": [u"vfio-pci", u"avf", u"af_xdp"],
         u"Amazon-Nitro-50G": [u"vfio-pci"],
         u"Mellanox-CX556A": [u"rdma-core", u"af_xdp"],
@@ -380,6 +415,8 @@ class Constants:
         u"Intel-X710": [u"vfio-pci"],
         u"Intel-XL710": [u"vfio-pci"],
         u"Intel-XXV710": [u"vfio-pci"],
+        u"Intel-E810XXV": [u"vfio-pci"],
+        u"Intel-E822CQ": [u"vfio-pci"],
         u"Intel-E810CQ": [u"vfio-pci"],
         u"Amazon-Nitro-50G": [u"vfio-pci"],
         u"Mellanox-CX556A": [u"mlx5_core"],
@@ -415,6 +452,10 @@ class Constants:
         u"Intel-XL710": u"HW_DH895xcc",
     }
 
+    DEVICE_TYPE_TO_KEYWORD = {
+        u"scapy": None
+    }
+
     PERF_TYPE_TO_KEYWORD = {
         u"mrr": u"Traffic should pass with maximum rate",
         u"ndrpdr": u"Find NDR and PDR intervals using optimized search",
@@ -422,23 +463,24 @@ class Constants:
     }
 
     PERF_TYPE_TO_SUITE_DOC_VER = {
-        u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\
-| ... | at line rate and reports total received packets over trial period.\\''',
-        u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\
-| ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
-| ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
-| ... | of packets transmitted. NDR and PDR are discovered for different\\
-| ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
-        u"soak": u'''fication:* TG sends traffic at dynamically computed\\
-| ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
-| ... | of a rate at which a prescribed small fraction of packets\\
-| ... | would be lost. After set time, the serarch stops\\
-| ... | and the algorithm reports its current estimate.\\''',
+        u"mrr": u'''fication:** In MaxReceivedRate tests TG sends traffic at \\
+| ... | line rate and reports total received packets over trial period. \\''',
+        u"ndrpdr": u'''rification:** TG finds and reports throughput NDR (Non \\
+| ... | Drop Rate) with zero packet loss tolerance and throughput PDR \\
+| ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \\
+| ... | expressed in percentage of packets transmitted. NDR and PDR are \\
+| ... | discovered for different Ethernet L2 frame sizes using MLRsearch \\
+| ... | library.''',
+        u"soak": u'''rification:** TG sends traffic at dynamically computed \\
+| ... | rate as PLRsearch algorithm gathers data and improves its estimate \\
+| ... | of a rate at which a prescribed small fraction of packets \\
+| ... | would be lost. After set time, the serarch stops \\
+| ... | and the algorithm reports its current estimate. \\''',
     }
 
     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
-        u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\
-| | ... | using burst trials throughput test.\\''',
-        u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\",
-        u"soak": u"Estimate critical rate using PLRsearch algorithm.\\",
+        u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames \\
+| | ... | using burst trials throughput test. \\''',
+        u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.",
+        u"soak": u"Estimate critical rate using PLRsearch algorithm. \\",
     }