resources/libraries/python/Constants.py

   1 # Copyright (c) 2021 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Constants used in CSIT.
  15
  16 "Constant" means a value that keeps its value since initialization. The value
  17 does not need to be hard coded here, but can be read from environment variables.
  18 """
  19
  20
  21 import os
  22
  23
  24 def get_str_from_env(env_var_names, default_value):
  25     """Attempt to read string from environment variable, return that or default.
  26
  27     If environment variable exists, but is empty (and default is not),
  28     empty string is returned.
  29
  30     Several environment variable names are examined, as CSIT currently supports
  31     a mix of naming conventions.
  32     Here "several" means there are hard coded prefixes to try,
  33     and env_var_names itself can be single name, or a list or a tuple of names.
  34
  35     :param env_var_names: Base names of environment variable to attempt to read.
  36     :param default_value: Value to return if the env var does not exist.
  37     :type env_var_names: str, or list of str, or tuple of str
  38     :type default_value: str
  39     :returns: The value read, or default value.
  40     :rtype: str
  41     """
  42     prefixes = (u"FDIO_CSIT_", u"CSIT_", u"")
  43     if not isinstance(env_var_names, (list, tuple)):
  44         env_var_names = [env_var_names]
  45     for name in env_var_names:
  46         for prefix in prefixes:
  47             value = os.environ.get(prefix + name, None)
  48             if value is not None:
  49                 return value
  50     return default_value
  51
  52
  53 def get_int_from_env(env_var_names, default_value):
  54     """Attempt to read int from environment variable, return that or default.
  55
  56     String value is read, default is returned also if conversion fails.
  57
  58     :param env_var_names: Base names of environment variable to attempt to read.
  59     :param default_value: Value to return if read or conversion fails.
  60     :type env_var_names: str, or list of str, or tuple of str
  61     :type default_value: int
  62     :returns: The value read, or default value.
  63     :rtype: int
  64     """
  65     env_str = get_str_from_env(env_var_names, u"")
  66     try:
  67         return int(env_str)
  68     except ValueError:
  69         return default_value
  70
  71
  72 def get_float_from_env(env_var_names, default_value):
  73     """Attempt to read float from environment variable, return that or default.
  74
  75     String value is read, default is returned also if conversion fails.
  76
  77     :param env_var_names: Base names of environment variable to attempt to read.
  78     :param default_value: Value to return if read or conversion fails.
  79     :type env_var_names: str, or list of str, or tuple of str
  80     :type default_value: float
  81     :returns: The value read, or default value.
  82     :rtype: float
  83     """
  84     env_str = get_str_from_env(env_var_names, u"")
  85     try:
  86         return float(env_str)
  87     except ValueError:
  88         return default_value
  89
  90
  91 def get_pessimistic_bool_from_env(env_var_names):
  92     """Attempt to read bool from environment variable, assume False by default.
  93
  94     Conversion is lenient and pessimistic, only few strings are considered true.
  95
  96     :param env_var_names: Base names of environment variable to attempt to read.
  97     :type env_var_names: str, or list of str, or tuple of str
  98     :returns: The value read, or False.
  99     :rtype: bool
 100     """
 101     env_str = get_str_from_env(env_var_names, u"").lower()
 102     return bool(env_str in (u"true", u"yes", u"y", u"1"))
 103
 104
 105 def get_optimistic_bool_from_env(env_var_names):
 106     """Attempt to read bool from environment variable, assume True by default.
 107
 108     Conversion is lenient and optimistic, only few strings are considered false.
 109
 110     :param env_var_names: Base names of environment variable to attempt to read.
 111     :type env_var_names: str, or list of str, or tuple of str
 112     :returns: The value read, or True.
 113     :rtype: bool
 114     """
 115     env_str = get_str_from_env(env_var_names, u"").lower()
 116     return bool(env_str not in (u"false", u"no", u"n", u"0"))
 117
 118
 119 class Constants:
 120     """Constants used in CSIT.
 121
 122     TODO: Yaml files are easier for humans to edit.
 123     Figure out how to set the attributes by parsing a file
 124     that works regardless of current working directory.
 125     """
 126
 127     # OpenVPP testing directory location at topology nodes
 128     REMOTE_FW_DIR = u"/tmp/openvpp-testing"
 129
 130     # shell scripts location
 131     RESOURCES_LIB_SH = u"resources/libraries/bash"
 132
 133     # Python API provider location
 134     RESOURCES_PAPI_PROVIDER = u"resources/tools/papi/vpp_papi_provider.py"
 135
 136     # vat templates location
 137     RESOURCES_TPL_VAT = u"resources/templates/vat"
 138
 139     # Kubernetes templates location
 140     RESOURCES_TPL_K8S = u"resources/templates/kubernetes"
 141
 142     # Templates location
 143     RESOURCES_TPL = u"resources/templates"
 144
 145     # Container templates location
 146     RESOURCES_TPL_CONTAINER = u"resources/templates/container"
 147
 148     # VPP Communications Library templates location
 149     RESOURCES_TPL_VCL = u"resources/templates/vcl"
 150
 151     # VPP Communications Library LD_PRELOAD library
 152     VCL_LDPRELOAD_LIBRARY = u"/usr/lib/x86_64-linux-gnu/libvcl_ldpreload.so"
 153
 154     # OpenVPP VAT binary name
 155     VAT_BIN_NAME = u"vpp_api_test"
 156
 157     # VPP service unit name
 158     VPP_UNIT = u"vpp"
 159
 160     # Number of system CPU cores.
 161     CPU_CNT_SYSTEM = 1
 162
 163     # Number of vswitch main thread CPU cores.
 164     CPU_CNT_MAIN = 1
 165
 166     # QEMU binary path
 167     QEMU_BIN_PATH = u"/usr/bin"
 168
 169     # QEMU VM kernel image path
 170     QEMU_VM_KERNEL = u"/opt/boot/vmlinuz"
 171
 172     # QEMU VM kernel initrd path
 173     QEMU_VM_KERNEL_INITRD = u"/opt/boot/initrd.img"
 174
 175     # QEMU VM nested image path
 176     QEMU_VM_IMAGE = u"/var/lib/vm/image.iso"
 177
 178     # QEMU VM DPDK path
 179     QEMU_VM_DPDK = u"/opt/dpdk-20.02"
 180
 181     # Docker container SUT image
 182     DOCKER_SUT_IMAGE_UBUNTU = u"csit_sut-ubuntu2004:local"
 183
 184     # Docker container arm SUT image
 185     DOCKER_SUT_IMAGE_UBUNTU_ARM = u"csit_sut-ubuntu2004:local"
 186
 187     # TRex install directory
 188     TREX_INSTALL_DIR = u"/opt/trex-core-2.88"
 189
 190     # TODO: Find the right way how to use it in trex profiles
 191     # TRex pcap files directory
 192     TREX_PCAP_DIR = f"{TREX_INSTALL_DIR}/scripts/avl"
 193
 194     # TRex limit memory.
 195     TREX_LIMIT_MEMORY = get_int_from_env(u"TREX_LIMIT_MEMORY", 8192)
 196
 197     # TRex number of cores
 198     TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 8)
 199
 200     # TRex set number of RX/TX descriptors
 201     # Set to 0 to use default values
 202     TREX_TX_DESCRIPTORS_COUNT = get_int_from_env(u"TREX_TX_DESCRIPTORS_COUNT", 0)
 203     TREX_RX_DESCRIPTORS_COUNT = get_int_from_env(u"TREX_RX_DESCRIPTORS_COUNT", 0)
 204
 205     # Trex force start regardless ports state
 206     TREX_SEND_FORCE = get_pessimistic_bool_from_env(u"TREX_SEND_FORCE")
 207
 208     # TRex extra commandline arguments
 209     TREX_EXTRA_CMDLINE = get_str_from_env(
 210         u"TREX_EXTRA_CMDLINE", u"--mbuf-factor 32")
 211
 212     # graph node variant value
 213     GRAPH_NODE_VARIANT = get_str_from_env(
 214         u"GRAPH_NODE_VARIANT", u"")
 215
 216     # Sysctl kernel.core_pattern
 217     KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core"
 218
 219     # Core dump directory
 220     CORE_DUMP_DIR = u"/tmp"
 221
 222     # Perf stat events (comma separated).
 223     PERF_STAT_EVENTS = get_str_from_env(
 224         u"PERF_STAT_EVENTS",
 225         u"cpu-clock,context-switches,cpu-migrations,page-faults,"
 226         u"cycles,instructions,branches,branch-misses,L1-icache-load-misses")
 227
 228     # Equivalent to ~0 used in vpp code
 229     BITWISE_NON_ZERO = 0xffffffff
 230
 231     # Default path to VPP API socket.
 232     SOCKSVR_PATH = u"/run/vpp/api.sock"
 233
 234     # Number of trials to execute in MRR test.
 235     PERF_TRIAL_MULTIPLICITY = get_int_from_env(u"PERF_TRIAL_MULTIPLICITY", 10)
 236
 237     # Duration [s] of one trial in MRR test.
 238     PERF_TRIAL_DURATION = get_float_from_env(u"PERF_TRIAL_DURATION", 1.0)
 239
 240     # Whether to use latency streams in main search trials.
 241     PERF_USE_LATENCY = get_pessimistic_bool_from_env(u"PERF_USE_LATENCY")
 242
 243     # Duration of one latency-specific trial in NDRPDR test.
 244     PERF_TRIAL_LATENCY_DURATION = get_float_from_env(
 245         u"PERF_TRIAL_LATENCY_DURATION", 5.0)
 246
 247     # For some testbeds TG takes longer than usual to start sending traffic.
 248     # This constant [s] allows longer wait, without affecting
 249     # the approximate duration. For example, use 0.098 for AWS.
 250     PERF_TRIAL_STL_DELAY = get_float_from_env(u"PERF_TRIAL_STL_DELAY", 0.0)
 251
 252     # ASTF usually needs a different value for the delay.
 253     PERF_TRIAL_ASTF_DELAY = get_float_from_env(
 254         u"PERF_TRIAL_ASTF_DELAY", 0.112
 255     )
 256
 257     # Extended debug (incl. vpp packet trace, linux perf stat, ...).
 258     # Full list is available as suite variable (__init__.robot) or is
 259     # override by test.
 260     EXTENDED_DEBUG = get_pessimistic_bool_from_env(u"EXTENDED_DEBUG")
 261
 262     # UUID string of DUT1 /tmp volume created outside of the
 263     # DUT1 docker in case of vpp-device test. ${EMPTY} value means that
 264     #  /tmp directory is inside the DUT1 docker.
 265     DUT1_UUID = get_str_from_env(u"DUT1_UUID", u"")
 266
 267     # Default path to VPP API Stats socket.
 268     SOCKSTAT_PATH = u"/run/vpp/stats.sock"
 269
 270     # Global "kill switch" for CRC checking during runtime.
 271     FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env(
 272         u"FAIL_ON_CRC_MISMATCH"
 273     )
 274
 275     # Default IP4 prefix length (if not defined in topology file)
 276     DEFAULT_IP4_PREFIX_LENGTH = u"24"
 277
 278     # Maximum number of interfaces in a data path
 279     DATAPATH_INTERFACES_MAX = 100
 280
 281     # Mapping from NIC name to its bps limit.
 282     NIC_NAME_TO_BPS_LIMIT = {
 283         u"Cisco-VIC-1227": 10000000000,
 284         u"Cisco-VIC-1385": 24500000000,
 285         u"Intel-X520-DA2": 10000000000,
 286         u"Intel-X553": 10000000000,
 287         u"Intel-X710": 10000000000,
 288         u"Intel-XL710": 24500000000,
 289         u"Intel-XXV710": 24500000000,
 290         u"Intel-E810CQ": 100000000000,
 291         u"Mellanox-CX556A": 100000000000,
 292         u"Amazon-Nitro-50G": 10000000000,
 293         u"virtual": 100000000,
 294     }
 295
 296     # Mapping from NIC name to its pps limit.
 297     NIC_NAME_TO_PPS_LIMIT = {
 298         u"Cisco-VIC-1227": 14880952,
 299         u"Cisco-VIC-1385": 18750000,
 300         u"Intel-X520-DA2": 14880952,
 301         u"Intel-X553": 14880952,
 302         u"Intel-X710": 14880952,
 303         u"Intel-XL710": 18750000,
 304         u"Intel-XXV710": 18750000,
 305         u"Intel-E810CQ": 58500000,
 306         # 2n-clx testbeds show duration stretching on high rates,
 307         # depending on encapsulation TRex has to generate.
 308         # 40 Mpps is still too much for dot1q (~8% stretching).
 309         # 36 Mpps is around the maximal VPP throughput (l2patch 4c8t).
 310         # Vxlan traffic will still show stretching at 36 Mpps (>12%),
 311         # but we do not care about those tests that much.
 312         u"Mellanox-CX556A": 36000000, # 148809523,
 313         u"Amazon-Nitro-50G": 1200000,
 314         u"virtual": 14880952,
 315     }
 316
 317     # Suite file names use codes for NICs.
 318     NIC_NAME_TO_CODE = {
 319         u"Cisco-VIC-1227": u"10ge2p1vic1227",
 320         u"Cisco-VIC-1385": u"40ge2p1vic1385",
 321         u"Intel-X520-DA2": u"10ge2p1x520",
 322         u"Intel-X553": u"10ge2p1x553",
 323         u"Intel-X710": u"10ge2p1x710",
 324         u"Intel-XL710": u"40ge2p1xl710",
 325         u"Intel-XXV710": u"25ge2p1xxv710",
 326         u"Intel-E810CQ": u"100ge2p1e810cq",
 327         u"Amazon-Nitro-50G": u"50ge1p1ENA",
 328         u"Mellanox-CX556A": u"100ge2p1cx556a",
 329     }
 330
 331     # Not each driver is supported by each NIC.
 332     NIC_NAME_TO_DRIVER = {
 333         u"Cisco-VIC-1227": [u"vfio-pci"],
 334         u"Cisco-VIC-1385": [u"vfio-pci"],
 335         u"Intel-X520-DA2": [u"vfio-pci"],
 336         u"Intel-X553": [u"vfio-pci"],
 337         u"Intel-X710": [u"vfio-pci", u"avf"],
 338         u"Intel-XL710": [u"vfio-pci", u"avf"],
 339         u"Intel-XXV710": [u"vfio-pci", u"avf"],
 340         u"Intel-E810CQ": [u"vfio-pci", u"avf"],
 341         u"Amazon-Nitro-50G": [u"vfio-pci"],
 342         u"Mellanox-CX556A": [u"rdma-core"],
 343     }
 344
 345     # Each driver needs different prugin to work.
 346     NIC_DRIVER_TO_PLUGINS = {
 347         u"vfio-pci": u"dpdk_plugin.so",
 348         u"avf": u"avf_plugin.so",
 349         u"rdma-core": u"rdma_plugin.so",
 350     }
 351
 352     # Tags to differentiate tests for different NIC driver.
 353     NIC_DRIVER_TO_TAG = {
 354         u"vfio-pci": u"DRV_VFIO_PCI",
 355         u"avf": u"DRV_AVF",
 356         u"rdma-core": u"DRV_RDMA_CORE",
 357     }
 358
 359     # Suite names have to be different, add prefix.
 360     NIC_DRIVER_TO_SUITE_PREFIX = {
 361         u"vfio-pci": u"",
 362         u"avf": u"avf-",
 363         u"rdma-core": u"rdma-",
 364     }
 365
 366     # Number of virtual functions of physical nic.
 367     NIC_DRIVER_TO_VFS = {
 368         u"vfio-pci": u"nic_vfs}= | 0",
 369         u"avf": u"nic_vfs}= | 1",
 370         u"rdma-core": u"nic_vfs}= | 0",
 371     }
 372
 373     # Not each driver is supported by each NIC.
 374     DPDK_NIC_NAME_TO_DRIVER = {
 375         u"Cisco-VIC-1227": [u"vfio-pci"],
 376         u"Cisco-VIC-1385": [u"vfio-pci"],
 377         u"Intel-X520-DA2": [u"vfio-pci"],
 378         u"Intel-X553": [u"vfio-pci"],
 379         u"Intel-X710": [u"vfio-pci"],
 380         u"Intel-XL710": [u"vfio-pci"],
 381         u"Intel-XXV710": [u"vfio-pci"],
 382         u"Intel-E810CQ": [u"vfio-pci"],
 383         u"Amazon-Nitro-50G": [u"vfio-pci"],
 384         u"Mellanox-CX556A": [u"mlx5_core"],
 385     }
 386
 387     # Tags to differentiate tests for different NIC driver.
 388     DPDK_NIC_DRIVER_TO_TAG = {
 389         u"vfio-pci": u"DRV_VFIO_PCI",
 390         u"mlx5_core": u"DRV_MLX5_CORE",
 391     }
 392
 393     # Suite names have to be different, add prefix.
 394     DPDK_NIC_DRIVER_TO_SUITE_PREFIX = {
 395         u"vfio-pci": u"",
 396         u"mlx5_core": u"mlx5-",
 397     }
 398
 399     # Some identifiers constructed from suite names
 400     # have to be independent of NIC driver used.
 401     # In order to remove or reject the NIC driver part,
 402     # it is useful to have a list of such prefixes precomputed.
 403     FORBIDDEN_SUITE_PREFIX_LIST = [
 404         prefix for prefix in NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
 405     ]
 406     FORBIDDEN_SUITE_PREFIX_LIST += [
 407         prefix for prefix in DPDK_NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
 408     ]
 409
 410     # TODO CSIT-1481: Crypto HW should be read from topology file instead.
 411     NIC_NAME_TO_CRYPTO_HW = {
 412         u"Intel-X553": u"HW_C3xxx",
 413         u"Intel-X710": u"HW_DH895xcc",
 414         u"Intel-XL710": u"HW_DH895xcc",
 415     }
 416
 417     PERF_TYPE_TO_KEYWORD = {
 418         u"mrr": u"Traffic should pass with maximum rate",
 419         u"ndrpdr": u"Find NDR and PDR intervals using optimized search",
 420         u"soak": u"Find critical load using PLRsearch",
 421     }
 422
 423     PERF_TYPE_TO_SUITE_DOC_VER = {
 424         u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\
 425 | ... | at line rate and reports total received packets over trial period.\\''',
 426         # TODO: Figure out how to include the full "*[Ver] TG verification:*"
 427         # while keeping this readable and without breaking line length limit.
 428         u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\
 429 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
 430 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
 431 | ... | of packets transmitted. NDR and PDR are discovered for different\\
 432 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
 433         u"soak": u'''fication:* TG sends traffic at dynamically computed\\
 434 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
 435 | ... | of a rate at which a prescribed small fraction of packets\\
 436 | ... | would be lost. After set time, the serarch stops\\
 437 | ... | and the algorithm reports its current estimate.\\''',
 438     }
 439
 440     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
 441         u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\
 442 | | ... | using burst trials throughput test.\\''',
 443         u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\",
 444         u"soak": u"Estimate critical rate using PLRsearch algorithm.\\",
 445     }