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