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 scripts location
 134     RESOURCES_LIB_PY = u"resources/libraries/python"
 135
 136     # Python API provider location
 137     RESOURCES_PAPI_PROVIDER = u"resources/tools/papi/vpp_papi_provider.py"
 138
 139     # vat templates location
 140     RESOURCES_TPL_VAT = u"resources/templates/vat"
 141
 142     # Kubernetes templates location
 143     RESOURCES_TPL_K8S = u"resources/templates/kubernetes"
 144
 145     # Templates location
 146     RESOURCES_TPL = u"resources/templates"
 147
 148     # Container templates location
 149     RESOURCES_TPL_CONTAINER = u"resources/templates/container"
 150
 151     # VPP Communications Library templates location
 152     RESOURCES_TPL_VCL = u"resources/templates/vcl"
 153
 154     # VPP Communications Library LD_PRELOAD library
 155     VCL_LDPRELOAD_LIBRARY = u"/usr/lib/x86_64-linux-gnu/libvcl_ldpreload.so"
 156
 157     # OpenVPP VAT binary name
 158     VAT_BIN_NAME = u"vpp_api_test"
 159
 160     # VPP service unit name
 161     VPP_UNIT = u"vpp"
 162
 163     # Number of system CPU cores.
 164     CPU_CNT_SYSTEM = 1
 165
 166     # Number of vswitch main thread CPU cores.
 167     CPU_CNT_MAIN = 1
 168
 169     # QEMU binary path
 170     QEMU_BIN_PATH = u"/usr/bin"
 171
 172     # QEMU VM kernel image path
 173     QEMU_VM_KERNEL = u"/opt/boot/vmlinuz"
 174
 175     # QEMU VM kernel initrd path
 176     QEMU_VM_KERNEL_INITRD = u"/opt/boot/initrd.img"
 177
 178     # QEMU VM nested image path
 179     QEMU_VM_IMAGE = u"/var/lib/vm/image.iso"
 180
 181     # QEMU VM DPDK path
 182     QEMU_VM_DPDK = u"/opt/dpdk-21.02"
 183
 184     # Docker container SUT image
 185     DOCKER_SUT_IMAGE_UBUNTU = u"csit_sut-ubuntu2004:local"
 186
 187     # Docker container arm SUT image
 188     DOCKER_SUT_IMAGE_UBUNTU_ARM = u"csit_sut-ubuntu2004:local"
 189
 190     # TRex install directory
 191     TREX_INSTALL_DIR = u"/opt/trex-core-2.88"
 192
 193     # TODO: Find the right way how to use it in trex profiles
 194     # TRex pcap files directory
 195     TREX_PCAP_DIR = f"{TREX_INSTALL_DIR}/scripts/avl"
 196
 197     # TRex limit memory.
 198     TREX_LIMIT_MEMORY = get_int_from_env(u"TREX_LIMIT_MEMORY", 8192)
 199
 200     # TRex number of cores
 201     TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 8)
 202
 203     # TRex set number of RX/TX descriptors
 204     # Set to 0 to use default values
 205     TREX_TX_DESCRIPTORS_COUNT = get_int_from_env(u"TREX_TX_DESCRIPTORS_COUNT", 0)
 206     TREX_RX_DESCRIPTORS_COUNT = get_int_from_env(u"TREX_RX_DESCRIPTORS_COUNT", 0)
 207
 208     # Trex force start regardless ports state
 209     TREX_SEND_FORCE = get_pessimistic_bool_from_env(u"TREX_SEND_FORCE")
 210
 211     # TRex extra commandline arguments
 212     TREX_EXTRA_CMDLINE = get_str_from_env(
 213         u"TREX_EXTRA_CMDLINE", u"--mbuf-factor 32")
 214
 215     # graph node variant value
 216     GRAPH_NODE_VARIANT = get_str_from_env(
 217         u"GRAPH_NODE_VARIANT", u"")
 218
 219     # Sysctl kernel.core_pattern
 220     KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core"
 221
 222     # Core dump directory
 223     CORE_DUMP_DIR = u"/tmp"
 224
 225     # Perf stat events (comma separated).
 226     PERF_STAT_EVENTS = get_str_from_env(
 227         u"PERF_STAT_EVENTS",
 228         u"cpu-clock,context-switches,cpu-migrations,page-faults,"
 229         u"cycles,instructions,branches,branch-misses,L1-icache-load-misses")
 230
 231     # Equivalent to ~0 used in vpp code
 232     BITWISE_NON_ZERO = 0xffffffff
 233
 234     # Default path to VPP API socket.
 235     SOCKSVR_PATH = u"/run/vpp/api.sock"
 236
 237     # Number of trials to execute in MRR test.
 238     PERF_TRIAL_MULTIPLICITY = get_int_from_env(u"PERF_TRIAL_MULTIPLICITY", 10)
 239
 240     # Duration [s] of one trial in MRR test.
 241     PERF_TRIAL_DURATION = get_float_from_env(u"PERF_TRIAL_DURATION", 1.0)
 242
 243     # Whether to use latency streams in main search trials.
 244     PERF_USE_LATENCY = get_pessimistic_bool_from_env(u"PERF_USE_LATENCY")
 245
 246     # Duration of one latency-specific trial in NDRPDR test.
 247     PERF_TRIAL_LATENCY_DURATION = get_float_from_env(
 248         u"PERF_TRIAL_LATENCY_DURATION", 5.0)
 249
 250     # For some testbeds TG takes longer than usual to start sending traffic.
 251     # This constant [s] allows longer wait, without affecting
 252     # the approximate duration. For example, use 0.098 for AWS.
 253     PERF_TRIAL_STL_DELAY = get_float_from_env(u"PERF_TRIAL_STL_DELAY", 0.0)
 254
 255     # ASTF usually needs a different value for the delay.
 256     PERF_TRIAL_ASTF_DELAY = get_float_from_env(
 257         u"PERF_TRIAL_ASTF_DELAY", 0.112
 258     )
 259
 260     # Extended debug (incl. vpp packet trace, linux perf stat, ...).
 261     # Full list is available as suite variable (__init__.robot) or is
 262     # override by test.
 263     EXTENDED_DEBUG = get_pessimistic_bool_from_env(u"EXTENDED_DEBUG")
 264
 265     # UUID string of DUT1 /tmp volume created outside of the
 266     # DUT1 docker in case of vpp-device test. ${EMPTY} value means that
 267     #  /tmp directory is inside the DUT1 docker.
 268     DUT1_UUID = get_str_from_env(u"DUT1_UUID", u"")
 269
 270     # Default path to VPP API Stats socket.
 271     SOCKSTAT_PATH = u"/run/vpp/stats.sock"
 272
 273     # Global "kill switch" for CRC checking during runtime.
 274     FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env(
 275         u"FAIL_ON_CRC_MISMATCH"
 276     )
 277
 278     # Default IP4 prefix length (if not defined in topology file)
 279     DEFAULT_IP4_PREFIX_LENGTH = u"24"
 280
 281     # Maximum number of interfaces in a data path
 282     DATAPATH_INTERFACES_MAX = 100
 283
 284     # Mapping from NIC name to its bps limit.
 285     NIC_NAME_TO_BPS_LIMIT = {
 286         u"Cisco-VIC-1227": 10000000000,
 287         u"Cisco-VIC-1385": 24500000000,
 288         u"Intel-X520-DA2": 10000000000,
 289         u"Intel-X553": 10000000000,
 290         u"Intel-X710": 10000000000,
 291         u"Intel-XL710": 24500000000,
 292         u"Intel-XXV710": 24500000000,
 293         u"Intel-E810CQ": 100000000000,
 294         u"Mellanox-CX556A": 100000000000,
 295         u"Amazon-Nitro-50G": 10000000000,
 296         u"virtual": 100000000,
 297     }
 298
 299     # Mapping from NIC name to its pps limit.
 300     NIC_NAME_TO_PPS_LIMIT = {
 301         u"Cisco-VIC-1227": 14880952,
 302         u"Cisco-VIC-1385": 18750000,
 303         u"Intel-X520-DA2": 14880952,
 304         u"Intel-X553": 14880952,
 305         u"Intel-X710": 14880952,
 306         u"Intel-XL710": 18750000,
 307         u"Intel-XXV710": 18750000,
 308         u"Intel-E810CQ": 58500000,
 309         # 2n-clx testbeds show duration stretching on high rates,
 310         # depending on encapsulation TRex has to generate.
 311         # 40 Mpps is still too much for dot1q (~8% stretching).
 312         # 36 Mpps is around the maximal VPP throughput (l2patch 4c8t).
 313         # Vxlan traffic will still show stretching at 36 Mpps (>12%),
 314         # but we do not care about those tests that much.
 315         u"Mellanox-CX556A": 36000000, # 148809523,
 316         u"Amazon-Nitro-50G": 1200000,
 317         u"virtual": 14880952,
 318     }
 319
 320     # Suite file names use codes for NICs.
 321     NIC_NAME_TO_CODE = {
 322         u"Cisco-VIC-1227": u"10ge2p1vic1227",
 323         u"Cisco-VIC-1385": u"40ge2p1vic1385",
 324         u"Intel-X520-DA2": u"10ge2p1x520",
 325         u"Intel-X553": u"10ge2p1x553",
 326         u"Intel-X710": u"10ge2p1x710",
 327         u"Intel-XL710": u"40ge2p1xl710",
 328         u"Intel-XXV710": u"25ge2p1xxv710",
 329         u"Intel-E810CQ": u"100ge2p1e810cq",
 330         u"Amazon-Nitro-50G": u"50ge1p1ENA",
 331         u"Mellanox-CX556A": u"100ge2p1cx556a",
 332     }
 333
 334     # Not each driver is supported by each NIC.
 335     NIC_NAME_TO_DRIVER = {
 336         u"Cisco-VIC-1227": [u"vfio-pci"],
 337         u"Cisco-VIC-1385": [u"vfio-pci"],
 338         u"Intel-X520-DA2": [u"vfio-pci"],
 339         u"Intel-X553": [u"vfio-pci"],
 340         u"Intel-X710": [u"vfio-pci", u"avf"],
 341         u"Intel-XL710": [u"vfio-pci", u"avf"],
 342         u"Intel-XXV710": [u"vfio-pci", u"avf"],
 343         u"Intel-E810CQ": [u"vfio-pci", u"avf"],
 344         u"Amazon-Nitro-50G": [u"vfio-pci"],
 345         u"Mellanox-CX556A": [u"rdma-core"],
 346     }
 347
 348     # Each driver needs different prugin to work.
 349     NIC_DRIVER_TO_PLUGINS = {
 350         u"vfio-pci": u"dpdk_plugin.so",
 351         u"avf": u"avf_plugin.so",
 352         u"rdma-core": u"rdma_plugin.so",
 353     }
 354
 355     # Tags to differentiate tests for different NIC driver.
 356     NIC_DRIVER_TO_TAG = {
 357         u"vfio-pci": u"DRV_VFIO_PCI",
 358         u"avf": u"DRV_AVF",
 359         u"rdma-core": u"DRV_RDMA_CORE",
 360     }
 361
 362     # Suite names have to be different, add prefix.
 363     NIC_DRIVER_TO_SUITE_PREFIX = {
 364         u"vfio-pci": u"",
 365         u"avf": u"avf-",
 366         u"rdma-core": u"rdma-",
 367     }
 368
 369     # Number of virtual functions of physical nic.
 370     NIC_DRIVER_TO_VFS = {
 371         u"vfio-pci": u"nic_vfs}= | 0",
 372         u"avf": u"nic_vfs}= | 1",
 373         u"rdma-core": u"nic_vfs}= | 0",
 374     }
 375
 376     # Not each driver is supported by each NIC.
 377     DPDK_NIC_NAME_TO_DRIVER = {
 378         u"Cisco-VIC-1227": [u"vfio-pci"],
 379         u"Cisco-VIC-1385": [u"vfio-pci"],
 380         u"Intel-X520-DA2": [u"vfio-pci"],
 381         u"Intel-X553": [u"vfio-pci"],
 382         u"Intel-X710": [u"vfio-pci"],
 383         u"Intel-XL710": [u"vfio-pci"],
 384         u"Intel-XXV710": [u"vfio-pci"],
 385         u"Intel-E810CQ": [u"vfio-pci"],
 386         u"Amazon-Nitro-50G": [u"vfio-pci"],
 387         u"Mellanox-CX556A": [u"mlx5_core"],
 388     }
 389
 390     # Tags to differentiate tests for different NIC driver.
 391     DPDK_NIC_DRIVER_TO_TAG = {
 392         u"vfio-pci": u"DRV_VFIO_PCI",
 393         u"mlx5_core": u"DRV_MLX5_CORE",
 394     }
 395
 396     # Suite names have to be different, add prefix.
 397     DPDK_NIC_DRIVER_TO_SUITE_PREFIX = {
 398         u"vfio-pci": u"",
 399         u"mlx5_core": u"mlx5-",
 400     }
 401
 402     # Some identifiers constructed from suite names
 403     # have to be independent of NIC driver used.
 404     # In order to remove or reject the NIC driver part,
 405     # it is useful to have a list of such prefixes precomputed.
 406     FORBIDDEN_SUITE_PREFIX_LIST = [
 407         prefix for prefix in NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
 408     ]
 409     FORBIDDEN_SUITE_PREFIX_LIST += [
 410         prefix for prefix in DPDK_NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
 411     ]
 412
 413     # TODO CSIT-1481: Crypto HW should be read from topology file instead.
 414     NIC_NAME_TO_CRYPTO_HW = {
 415         u"Intel-X553": u"HW_C3xxx",
 416         u"Intel-X710": u"HW_DH895xcc",
 417         u"Intel-XL710": u"HW_DH895xcc",
 418     }
 419
 420     PERF_TYPE_TO_KEYWORD = {
 421         u"mrr": u"Traffic should pass with maximum rate",
 422         u"ndrpdr": u"Find NDR and PDR intervals using optimized search",
 423         u"soak": u"Find critical load using PLRsearch",
 424     }
 425
 426     PERF_TYPE_TO_SUITE_DOC_VER = {
 427         u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\
 428 | ... | at line rate and reports total received packets over trial period.\\''',
 429         # TODO: Figure out how to include the full "*[Ver] TG verification:*"
 430         # while keeping this readable and without breaking line length limit.
 431         u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\
 432 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
 433 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
 434 | ... | of packets transmitted. NDR and PDR are discovered for different\\
 435 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
 436         u"soak": u'''fication:* TG sends traffic at dynamically computed\\
 437 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
 438 | ... | of a rate at which a prescribed small fraction of packets\\
 439 | ... | would be lost. After set time, the serarch stops\\
 440 | ... | and the algorithm reports its current estimate.\\''',
 441     }
 442
 443     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
 444         u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\
 445 | | ... | using burst trials throughput test.\\''',
 446         u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\",
 447         u"soak": u"Estimate critical rate using PLRsearch algorithm.\\",
 448     }