perf: add TCP Iperf3+LDPRELOAD test suite
[csit.git] / resources / libraries / python / Constants.py
index eee9177..eded294 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2020 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:
 
 """Constants used in CSIT.
 
-Here, "constant" means a value that keeps its value since initialization.
-However, the value does not need to be hardcoded here,
-some values are affected by environment variables.
-
-TODO: Review env and constant names, make them matching if possible.
+"Constant" means a value that keeps its value since initialization. The value
+does not need to be hard coded here, but can be read from environment variables.
 """
 
 
@@ -31,8 +28,8 @@ def get_str_from_env(env_var_names, default_value):
     empty string is returned.
 
     Several environment variable names are examined, as CSIT currently supports
-    a mix of naming convensions.
-    Here "several" means there are hardcoded prefixes to try,
+    a mix of naming conventions.
+    Here "several" means there are hard coded prefixes to try,
     and env_var_names itself can be single name, or a list or a tuple of names.
 
     :param env_var_names: Base names of environment variable to attempt to read.
@@ -148,9 +145,15 @@ class Constants:
     # Container templates location
     RESOURCES_TPL_CONTAINER = u"resources/templates/container"
 
+    # VPP Communications Library templates location
+    RESOURCES_TPL_VCL = u"resources/templates/vcl"
+
     # HTTP Server www root directory
     RESOURCES_TP_WRK_WWW = u"resources/traffic_profiles/wrk/www"
 
+    # VPP Communications Library LD_PRELOAD library
+    VCL_LDPRELOAD_LIBRARY=u"/usr/lib/x86_64-linux-gnu/libvcl_ldpreload.so"
+
     # OpenVPP VAT binary name
     VAT_BIN_NAME = u"vpp_api_test"
 
@@ -185,7 +188,16 @@ class Constants:
     DOCKER_SUT_IMAGE_UBUNTU_ARM = u"snergster/csit-arm-sut:latest"
 
     # TRex install directory
-    TREX_INSTALL_DIR = u"/opt/trex-core-2.61"
+    TREX_INSTALL_DIR = u"/opt/trex-core-2.73"
+
+    # TRex limit memory.
+    TREX_LIMIT_MEMORY = get_int_from_env(u"TREX_LIMIT_MEMORY", 4096)
+
+    # TRex number of cores
+    TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 7)
+
+    # TRex extra commandline arguments
+    TREX_EXTRA_CMDLINE = get_str_from_env(u"TREX_EXTRA_CMDLINE", u"")
 
     # Sysctl kernel.core_pattern
     KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core"
@@ -218,6 +230,12 @@ class Constants:
         u"FAIL_ON_CRC_MISMATCH"
     )
 
+    # Default IP4 prefix length (if not defined in topology file)
+    DEFAULT_IP4_PREFIX_LENGTH = u"24"
+
+    # Maximum number of interfaces in a data path
+    DATAPATH_INTERFACES_MAX = 100
+
     # Mapping from NIC name to its bps limit.
     NIC_NAME_TO_BPS_LIMIT = {
         u"Cisco-VIC-1227": 10000000000,
@@ -228,6 +246,7 @@ class Constants:
         u"Intel-XL710": 24500000000,
         u"Intel-XXV710": 24500000000,
         u"Mellanox-CX556A": 100000000000,
+        u"Amazon-Nitro-50G": 10000000000,
         u"virtual": 100000000,
     }
 
@@ -241,6 +260,7 @@ class Constants:
         u"Intel-XL710": 18750000,
         u"Intel-XXV710": 18750000,
         u"Mellanox-CX556A": 60000000, # 148809523,
+        u"Amazon-Nitro-50G": 1500000,
         u"virtual": 14880952,
     }
 
@@ -256,6 +276,55 @@ class Constants:
         u"Mellanox-CX556A": u"100ge2p1cx556a",
     }
 
+    # 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"Mellanox-CX556A": [u"rdma-core"],
+    }
+
+    # Each driver needs different prugin to work.
+    NIC_DRIVER_TO_PLUGINS = {
+        u"vfio-pci": u"dpdk_plugin.so",
+        u"avf": u"avf_plugin.so",
+        u"rdma-core": u"rdma_plugin.so",
+    }
+
+    # Tags to differentiate tests for different NIC driver.
+    NIC_DRIVER_TO_TAG = {
+        u"vfio-pci": u"DRV_VFIO_PCI",
+        u"avf": u"DRV_AVF",
+        u"rdma-core": u"DRV_RDMA_CORE",
+    }
+
+    # Suite names have to be different, add prefix.
+    NIC_DRIVER_TO_SUITE_PREFIX = {
+        u"vfio-pci": u"",
+        u"avf": u"avf-",
+        u"rdma-core": u"rdma-",
+    }
+
+    # Some identifiers constructed from suite names
+    # have to be independent of NIC driver used.
+    # In order to remove or reject the NIC driver part,
+    # it is useful to have a list of such prefixes precomputed.
+    FORBIDDEN_SUITE_PREFIX_LIST = [
+        prefix for prefix in NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
+    ]
+
+    # Additional step for perf needs to know driver type.
+    # Contains part of suite setup line, matching both single and double link.
+    NIC_DRIVER_TO_SETUP_ARG = {
+        u"vfio-pci": u"le link | performance",
+        u"avf": u"le link | performance_avf",
+        u"rdma-core": u"le link | performance_rdma",
+    }
+
     # TODO CSIT-1481: Crypto HW should be read from topology file instead.
     NIC_NAME_TO_CRYPTO_HW = {
         u"Intel-X553": u"HW_C3xxx",