UTI: Export results
[csit.git] / resources / libraries / python / Constants.py
index 14fb795..672ce87 100644 (file)
@@ -117,12 +117,13 @@ def get_optimistic_bool_from_env(env_var_names):
 
 
 class Constants:
-    """Constants used in CSIT.
+    """Constants used in CSIT."""
 
-    TODO: Yaml files are easier for humans to edit.
-    Figure out how to set the attributes by parsing a file
-    that works regardless of current working directory.
-    """
+    # Version for CSIT data model. See docs/model/.
+    MODEL_VERSION = u"1.0.0"
+
+    # 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"
@@ -130,24 +131,33 @@ class Constants:
     # shell scripts location
     RESOURCES_LIB_SH = u"resources/libraries/bash"
 
+    # python scripts location
+    RESOURCES_LIB_PY = u"resources/libraries/python"
+
+    # shell scripts location
+    RESOURCES_TOOLS = u"resources/tools"
+
     # Python API provider location
     RESOURCES_PAPI_PROVIDER = u"resources/tools/papi/vpp_papi_provider.py"
 
+    # Templates location
+    RESOURCES_TPL = u"resources/templates"
+
     # vat templates location
     RESOURCES_TPL_VAT = u"resources/templates/vat"
 
     # Kubernetes templates location
     RESOURCES_TPL_K8S = u"resources/templates/kubernetes"
 
-    # Templates location
-    RESOURCES_TPL = u"resources/templates"
-
     # Container templates location
     RESOURCES_TPL_CONTAINER = u"resources/templates/container"
 
     # VPP Communications Library templates location
     RESOURCES_TPL_VCL = u"resources/templates/vcl"
 
+    # VPP Communications Library templates location
+    RESOURCES_TPL_TELEMETRY = u"resources/templates/telemetry"
+
     # VPP Communications Library LD_PRELOAD library
     VCL_LDPRELOAD_LIBRARY = u"/usr/lib/x86_64-linux-gnu/libvcl_ldpreload.so"
 
@@ -176,7 +186,7 @@ class Constants:
     QEMU_VM_IMAGE = u"/var/lib/vm/image.iso"
 
     # QEMU VM DPDK path
-    QEMU_VM_DPDK = u"/opt/dpdk-20.02"
+    QEMU_VM_DPDK = u"/opt/dpdk-21.08"
 
     # Docker container SUT image
     DOCKER_SUT_IMAGE_UBUNTU = u"csit_sut-ubuntu2004:local"
@@ -187,7 +197,6 @@ class Constants:
     # TRex install directory
     TREX_INSTALL_DIR = u"/opt/trex-core-2.88"
 
-    # TODO: Find the right way how to use it in trex profiles
     # TRex pcap files directory
     TREX_PCAP_DIR = f"{TREX_INSTALL_DIR}/scripts/avl"
 
@@ -199,8 +208,12 @@ class Constants:
 
     # TRex set number of RX/TX descriptors
     # Set to 0 to use default values
-    TREX_TX_DESCRIPTORS_COUNT = get_int_from_env(u"TREX_TX_DESCRIPTORS_COUNT", 0)
-    TREX_RX_DESCRIPTORS_COUNT = get_int_from_env(u"TREX_RX_DESCRIPTORS_COUNT", 0)
+    TREX_TX_DESCRIPTORS_COUNT = get_int_from_env(
+        u"TREX_TX_DESCRIPTORS_COUNT", 0
+    )
+    TREX_RX_DESCRIPTORS_COUNT = get_int_from_env(
+        u"TREX_RX_DESCRIPTORS_COUNT", 0
+    )
 
     # Trex force start regardless ports state
     TREX_SEND_FORCE = get_pessimistic_bool_from_env(u"TREX_SEND_FORCE")
@@ -209,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"
@@ -280,8 +295,6 @@ class Constants:
 
     # Mapping from NIC name to its bps limit.
     NIC_NAME_TO_BPS_LIMIT = {
-        u"Cisco-VIC-1227": 10000000000,
-        u"Cisco-VIC-1385": 24500000000,
         u"Intel-X520-DA2": 10000000000,
         u"Intel-X553": 10000000000,
         u"Intel-X710": 10000000000,
@@ -295,8 +308,6 @@ class Constants:
 
     # Mapping from NIC name to its pps limit.
     NIC_NAME_TO_PPS_LIMIT = {
-        u"Cisco-VIC-1227": 14880952,
-        u"Cisco-VIC-1385": 18750000,
         u"Intel-X520-DA2": 14880952,
         u"Intel-X553": 14880952,
         u"Intel-X710": 14880952,
@@ -316,8 +327,6 @@ class Constants:
 
     # Suite file names use codes for NICs.
     NIC_NAME_TO_CODE = {
-        u"Cisco-VIC-1227": u"10ge2p1vic1227",
-        u"Cisco-VIC-1385": u"40ge2p1vic1385",
         u"Intel-X520-DA2": u"10ge2p1x520",
         u"Intel-X553": u"10ge2p1x553",
         u"Intel-X710": u"10ge2p1x710",
@@ -328,18 +337,28 @@ class Constants:
         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"100ge2p1e810cq": u"e810cq",
+        u"50ge1p1ENA": u"ena",
+        u"100ge2p1cx556a": u"cx556a",
+    }
+
     # Not each driver is supported by each NIC.
     NIC_NAME_TO_DRIVER = {
-        u"Cisco-VIC-1227": [u"vfio-pci"],
-        u"Cisco-VIC-1385": [u"vfio-pci"],
-        u"Intel-X520-DA2": [u"vfio-pci"],
-        u"Intel-X553": [u"vfio-pci"],
-        u"Intel-X710": [u"vfio-pci", u"avf"],
-        u"Intel-XL710": [u"vfio-pci", u"avf"],
-        u"Intel-XXV710": [u"vfio-pci", u"avf"],
-        u"Intel-E810CQ": [u"vfio-pci", u"avf"],
+        u"Intel-X520-DA2": [u"vfio-pci", u"af_xdp"],
+        u"Intel-X553": [u"vfio-pci", u"af_xdp"],
+        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-E810CQ": [u"vfio-pci", u"avf", u"af_xdp"],
         u"Amazon-Nitro-50G": [u"vfio-pci"],
-        u"Mellanox-CX556A": [u"rdma-core"],
+        u"Mellanox-CX556A": [u"rdma-core", u"af_xdp"],
     }
 
     # Each driver needs different prugin to work.
@@ -347,6 +366,7 @@ class Constants:
         u"vfio-pci": u"dpdk_plugin.so",
         u"avf": u"avf_plugin.so",
         u"rdma-core": u"rdma_plugin.so",
+        u"af_xdp": u"af_xdp_plugin.so",
     }
 
     # Tags to differentiate tests for different NIC driver.
@@ -354,6 +374,7 @@ class Constants:
         u"vfio-pci": u"DRV_VFIO_PCI",
         u"avf": u"DRV_AVF",
         u"rdma-core": u"DRV_RDMA_CORE",
+        u"af_xdp": u"DRV_AF_XDP",
     }
 
     # Suite names have to be different, add prefix.
@@ -361,6 +382,7 @@ class Constants:
         u"vfio-pci": u"",
         u"avf": u"avf-",
         u"rdma-core": u"rdma-",
+        u"af_xdp": u"af-xdp-",
     }
 
     # Number of virtual functions of physical nic.
@@ -368,12 +390,11 @@ class Constants:
         u"vfio-pci": u"nic_vfs}= | 0",
         u"avf": u"nic_vfs}= | 1",
         u"rdma-core": u"nic_vfs}= | 0",
+        u"af_xdp": u"nic_vfs}= | 0",
     }
 
     # Not each driver is supported by each NIC.
     DPDK_NIC_NAME_TO_DRIVER = {
-        u"Cisco-VIC-1227": [u"vfio-pci"],
-        u"Cisco-VIC-1385": [u"vfio-pci"],
         u"Intel-X520-DA2": [u"vfio-pci"],
         u"Intel-X553": [u"vfio-pci"],
         u"Intel-X710": [u"vfio-pci"],
@@ -414,6 +435,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",
@@ -421,25 +446,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.\\''',
-        # TODO: Figure out how to include the full "*[Ver] TG verification:*"
-        # while keeping this readable and without breaking line length limit.
-        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. \\",
     }