X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FConstants.py;h=0e8ac42638a55aa956d35019c77f870f9ec99112;hp=506b71af69858d9994ab70081805ac6e8235e9fd;hb=6ec31b8aa67f4af2b963b3984f047e94ba790b3d;hpb=33bd6f2425ddff8e4167d36ea61b64ac81da3a65 diff --git a/resources/libraries/python/Constants.py b/resources/libraries/python/Constants.py index 506b71af69..0e8ac42638 100644 --- a/resources/libraries/python/Constants.py +++ b/resources/libraries/python/Constants.py @@ -1,4 +1,4 @@ -# Copyright (c) 2019 Cisco and/or its affiliates. +# Copyright (c) 2021 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: @@ -11,10 +11,112 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Constants used in CSIT.""" +"""Constants used in CSIT. +"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. +""" -class Constants(object): + +import os + + +def get_str_from_env(env_var_names, default_value): + """Attempt to read string from environment variable, return that or default. + + If environment variable exists, but is empty (and default is not), + empty string is returned. + + Several environment variable names are examined, as CSIT currently supports + 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. + :param default_value: Value to return if the env var does not exist. + :type env_var_names: str, or list of str, or tuple of str + :type default_value: str + :returns: The value read, or default value. + :rtype: str + """ + prefixes = (u"FDIO_CSIT_", u"CSIT_", u"") + if not isinstance(env_var_names, (list, tuple)): + env_var_names = [env_var_names] + for name in env_var_names: + for prefix in prefixes: + value = os.environ.get(prefix + name, None) + if value is not None: + return value + return default_value + + +def get_int_from_env(env_var_names, default_value): + """Attempt to read int from environment variable, return that or default. + + String value is read, default is returned also if conversion fails. + + :param env_var_names: Base names of environment variable to attempt to read. + :param default_value: Value to return if read or conversion fails. + :type env_var_names: str, or list of str, or tuple of str + :type default_value: int + :returns: The value read, or default value. + :rtype: int + """ + env_str = get_str_from_env(env_var_names, u"") + try: + return int(env_str) + except ValueError: + return default_value + + +def get_float_from_env(env_var_names, default_value): + """Attempt to read float from environment variable, return that or default. + + String value is read, default is returned also if conversion fails. + + :param env_var_names: Base names of environment variable to attempt to read. + :param default_value: Value to return if read or conversion fails. + :type env_var_names: str, or list of str, or tuple of str + :type default_value: float + :returns: The value read, or default value. + :rtype: float + """ + env_str = get_str_from_env(env_var_names, u"") + try: + return float(env_str) + except ValueError: + return default_value + + +def get_pessimistic_bool_from_env(env_var_names): + """Attempt to read bool from environment variable, assume False by default. + + Conversion is lenient and pessimistic, only few strings are considered true. + + :param env_var_names: Base names of environment variable to attempt to read. + :type env_var_names: str, or list of str, or tuple of str + :returns: The value read, or False. + :rtype: bool + """ + env_str = get_str_from_env(env_var_names, u"").lower() + return bool(env_str in (u"true", u"yes", u"y", u"1")) + + +def get_optimistic_bool_from_env(env_var_names): + """Attempt to read bool from environment variable, assume True by default. + + Conversion is lenient and optimistic, only few strings are considered false. + + :param env_var_names: Base names of environment variable to attempt to read. + :type env_var_names: str, or list of str, or tuple of str + :returns: The value read, or True. + :rtype: bool + """ + env_str = get_str_from_env(env_var_names, u"").lower() + return bool(env_str not in (u"false", u"no", u"n", u"0")) + + +class Constants: """Constants used in CSIT. TODO: Yaml files are easier for humans to edit. @@ -23,64 +125,306 @@ class Constants(object): """ # OpenVPP testing directory location at topology nodes - REMOTE_FW_DIR = '/tmp/openvpp-testing' + REMOTE_FW_DIR = u"/tmp/openvpp-testing" # shell scripts location - RESOURCES_LIB_SH = 'resources/libraries/bash' + RESOURCES_LIB_SH = u"resources/libraries/bash" # Python API provider location - RESOURCES_PAPI_PROVIDER = 'resources/tools/papi/vpp_papi_provider.py' + RESOURCES_PAPI_PROVIDER = u"resources/tools/papi/vpp_papi_provider.py" # vat templates location - RESOURCES_TPL_VAT = 'resources/templates/vat' + 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 LD_PRELOAD library + VCL_LDPRELOAD_LIBRARY = u"/usr/lib/x86_64-linux-gnu/libvcl_ldpreload.so" # OpenVPP VAT binary name - VAT_BIN_NAME = 'vpp_api_test' + VAT_BIN_NAME = u"vpp_api_test" # VPP service unit name - VPP_UNIT = 'vpp' + VPP_UNIT = u"vpp" - # QEMU version to install - QEMU_INSTALL_VERSION = 'qemu-2.11.2' + # Number of system CPU cores. + CPU_CNT_SYSTEM = 1 - # QEMU install directory - QEMU_INSTALL_DIR = '/opt/qemu-2.11.2' + # Number of vswitch main thread CPU cores. + CPU_CNT_MAIN = 1 - # QEMU performance test VM kernel image path - QEMU_PERF_VM_KERNEL = '/opt/boot/vmlinuz' + # QEMU binary path + QEMU_BIN_PATH = u"/usr/bin" - # QEMU performance test VM nested image path - QEMU_PERF_VM_IMAGE = '/var/lib/vm/csit-nested-1.7.img' + # QEMU VM kernel image path + QEMU_VM_KERNEL = u"/opt/boot/vmlinuz" - # TRex install version - TREX_INSTALL_VERSION = '2.35' + # QEMU VM kernel initrd path + QEMU_VM_KERNEL_INITRD = u"/opt/boot/initrd.img" - # TRex install directory - TREX_INSTALL_DIR = '/opt/trex-core-2.35' + # QEMU VM nested image path + QEMU_VM_IMAGE = u"/var/lib/vm/image.iso" - # Kubernetes templates location - RESOURCES_TPL_K8S = 'resources/templates/kubernetes' + # QEMU VM DPDK path + QEMU_VM_DPDK = u"/opt/dpdk-20.02" + + # Docker container SUT image + DOCKER_SUT_IMAGE_UBUNTU = u"csit_sut-ubuntu1804:local" - # KernelVM templates location - RESOURCES_TPL_VM = 'resources/templates/vm' + # Docker container arm SUT image + DOCKER_SUT_IMAGE_UBUNTU_ARM = u"csit_sut-ubuntu1804:local" + + # TRex install directory + TREX_INSTALL_DIR = u"/opt/trex-core-2.88" - # Honeycomb directory location at topology nodes: - REMOTE_HC_DIR = '/opt/honeycomb' + # 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" - # Honeycomb persistence files location - REMOTE_HC_PERSIST = '/var/lib/honeycomb/persist' + # TRex limit memory. + TREX_LIMIT_MEMORY = get_int_from_env(u"TREX_LIMIT_MEMORY", 8192) - # Honeycomb log file location - REMOTE_HC_LOG = '/var/log/honeycomb/honeycomb.log' + # TRex number of cores + TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 8) - # Honeycomb templates location - RESOURCES_TPL_HC = 'resources/templates/honeycomb' + # Trex force start regardless ports state + TREX_SEND_FORCE = get_pessimistic_bool_from_env(u"TREX_SEND_FORCE") - # ODL Client Restconf listener port - ODL_PORT = 8181 + # TRex extra commandline arguments + 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"") # Sysctl kernel.core_pattern - KERNEL_CORE_PATTERN = '/tmp/%p-%u-%g-%s-%t-%h-%e.core' + KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core" # Core dump directory - CORE_DUMP_DIR = '/tmp' + CORE_DUMP_DIR = u"/tmp" + + # Perf stat events (comma separated). + PERF_STAT_EVENTS = get_str_from_env( + u"PERF_STAT_EVENTS", + u"cpu-clock,context-switches,cpu-migrations,page-faults," + u"cycles,instructions,branches,branch-misses,L1-icache-load-misses") + + # Equivalent to ~0 used in vpp code + BITWISE_NON_ZERO = 0xffffffff + + # Default path to VPP API socket. + SOCKSVR_PATH = u"/run/vpp/api.sock" + + # Number of trials to execute in MRR test. + PERF_TRIAL_MULTIPLICITY = get_int_from_env(u"PERF_TRIAL_MULTIPLICITY", 10) + + # Duration of one trial in MRR test. + PERF_TRIAL_DURATION = get_float_from_env(u"PERF_TRIAL_DURATION", 1.0) + + # Whether to use latency streams in main search trials. + PERF_USE_LATENCY = get_pessimistic_bool_from_env(u"PERF_USE_LATENCY") + + # Duration of one latency-specific trial in NDRPDR test. + PERF_TRIAL_LATENCY_DURATION = get_float_from_env( + u"PERF_TRIAL_LATENCY_DURATION", 5.0) + + # Extended debug (incl. vpp packet trace, linux perf stat, ...). + # Full list is available as suite variable (__init__.robot) or is + # override by test. + EXTENDED_DEBUG = get_pessimistic_bool_from_env(u"EXTENDED_DEBUG") + + # UUID string of DUT1 /tmp volume created outside of the + # DUT1 docker in case of vpp-device test. ${EMPTY} value means that + # /tmp directory is inside the DUT1 docker. + DUT1_UUID = get_str_from_env(u"DUT1_UUID", u"") + + # Default path to VPP API Stats socket. + SOCKSTAT_PATH = u"/run/vpp/stats.sock" + + # Global "kill switch" for CRC checking during runtime. + FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env( + 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, + u"Cisco-VIC-1385": 24500000000, + u"Intel-X520-DA2": 10000000000, + u"Intel-X553": 10000000000, + u"Intel-X710": 10000000000, + u"Intel-XL710": 24500000000, + u"Intel-XXV710": 24500000000, + u"Intel-E810CQ": 100000000000, + u"Mellanox-CX556A": 100000000000, + u"Amazon-Nitro-50G": 10000000000, + u"virtual": 100000000, + } + + # 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, + u"Intel-XL710": 18750000, + u"Intel-XXV710": 18750000, + u"Intel-E810CQ": 58500000, + # 2n-clx testbeds show duration stretching on high rates, + # depending on encapsulation TRex has to generate. + # 40 Mpps is still too much for dot1q (~8% stretching). + # 36 Mpps is around the maximal VPP throughput (l2patch 4c8t). + # Vxlan traffic will still show stretching at 36 Mpps (>12%), + # but we do not care about those tests that much. + u"Mellanox-CX556A": 36000000, # 148809523, + u"Amazon-Nitro-50G": 1500000, + u"virtual": 14880952, + } + + # 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", + u"Intel-XL710": u"40ge2p1xl710", + u"Intel-XXV710": u"25ge2p1xxv710", + u"Intel-E810CQ": u"100ge2p1e810cq", + u"Amazon-Nitro-50G": u"50ge1p1ENA", + 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"Intel-E810CQ": [u"vfio-pci", u"avf"], + u"Amazon-Nitro-50G": [u"vfio-pci"], + 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-", + } + + # Number of virtual functions of physical nic. + NIC_DRIVER_TO_VFS = { + u"vfio-pci": u"nic_vfs}= | 0", + u"avf": u"nic_vfs}= | 1", + u"rdma-core": 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"], + u"Intel-XL710": [u"vfio-pci"], + u"Intel-XXV710": [u"vfio-pci"], + u"Intel-E810CQ": [u"vfio-pci"], + u"Amazon-Nitro-50G": [u"vfio-pci"], + u"Mellanox-CX556A": [u"mlx5_core"], + } + + # Tags to differentiate tests for different NIC driver. + DPDK_NIC_DRIVER_TO_TAG = { + u"vfio-pci": u"DRV_VFIO_PCI", + u"mlx5_core": u"DRV_MLX5_CORE", + } + + # Suite names have to be different, add prefix. + DPDK_NIC_DRIVER_TO_SUITE_PREFIX = { + u"vfio-pci": u"", + u"mlx5_core": u"mlx5-", + } + + # 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 + ] + FORBIDDEN_SUITE_PREFIX_LIST += [ + prefix for prefix in DPDK_NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix + ] + + # TODO CSIT-1481: Crypto HW should be read from topology file instead. + NIC_NAME_TO_CRYPTO_HW = { + u"Intel-X553": u"HW_C3xxx", + u"Intel-X710": u"HW_DH895xcc", + u"Intel-XL710": u"HW_DH895xcc", + } + + PERF_TYPE_TO_KEYWORD = { + u"mrr": u"Traffic should pass with maximum rate", + u"ndrpdr": u"Find NDR and PDR intervals using optimized search", + u"soak": u"Find critical load using PLRsearch", + } + + 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.\\''', + } + + 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.\\", + }