1 # Copyright (c) 2023 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """Constants used in CSIT.
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.
24 def get_str_from_env(env_var_names, default_value):
25 """Attempt to read string from environment variable, return that or default.
27 If environment variable exists, but is empty (and default is not),
28 empty string is returned.
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.
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.
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)
53 def get_int_from_env(env_var_names, default_value):
54 """Attempt to read int from environment variable, return that or default.
56 String value is read, default is returned also if conversion fails.
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.
65 env_str = get_str_from_env(env_var_names, u"")
72 def get_float_from_env(env_var_names, default_value):
73 """Attempt to read float from environment variable, return that or default.
75 String value is read, default is returned also if conversion fails.
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.
84 env_str = get_str_from_env(env_var_names, u"")
91 def get_pessimistic_bool_from_env(env_var_names):
92 """Attempt to read bool from environment variable, assume False by default.
94 Conversion is lenient and pessimistic, only few strings are considered true.
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.
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"))
105 def get_optimistic_bool_from_env(env_var_names):
106 """Attempt to read bool from environment variable, assume True by default.
108 Conversion is lenient and optimistic, only few strings are considered false.
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.
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"))
120 """Constants used in CSIT."""
122 # Version for CSIT data model. See docs/model/.
123 MODEL_VERSION = u"1.4.0"
125 # Global off-switch in case JSON export is large or slow.
126 EXPORT_JSON = get_optimistic_bool_from_env(u"EXPORT_JSON")
128 # OpenVPP testing directory location at topology nodes
129 REMOTE_FW_DIR = u"/tmp/openvpp-testing"
131 # shell scripts location
132 RESOURCES_LIB_SH = u"resources/libraries/bash"
134 # python scripts location
135 RESOURCES_LIB_PY = u"resources/libraries/python"
137 # shell scripts location
138 RESOURCES_TOOLS = u"resources/tools"
140 # Python API provider location
141 RESOURCES_PAPI_PROVIDER = u"resources/tools/papi/vpp_papi_provider.py"
144 RESOURCES_TPL = u"resources/templates"
146 # Kubernetes templates location
147 RESOURCES_TPL_K8S = u"resources/templates/kubernetes"
149 # Container templates location
150 RESOURCES_TPL_CONTAINER = u"resources/templates/container"
152 # VPP Communications Library templates location
153 RESOURCES_TPL_VCL = u"resources/templates/vcl"
155 # VPP Communications Library templates location
156 RESOURCES_TPL_TELEMETRY = u"resources/templates/telemetry"
158 # VPP Communications Library LD_PRELOAD library
159 VCL_LDPRELOAD_LIBRARY = u"/usr/lib/x86_64-linux-gnu/libvcl_ldpreload.so"
161 # VPP service unit name
164 # Number of system CPU cores.
167 # Number of vswitch main thread CPU cores.
171 QEMU_BIN_PATH = u"/usr/bin"
173 # QEMU VM kernel image path
174 QEMU_VM_KERNEL = u"/opt/boot/vmlinuz"
176 # QEMU VM kernel initrd path
177 QEMU_VM_KERNEL_INITRD = u"/opt/boot/initrd.img"
179 # QEMU VM nested image path
180 QEMU_VM_IMAGE = u"/var/lib/vm/image.iso"
183 QEMU_VM_DPDK = u"/opt/dpdk-23.07"
185 # Docker container SUT image
186 DOCKER_SUT_IMAGE_UBUNTU = u"csit_sut-ubuntu2204:local"
188 # Docker container arm SUT image
189 DOCKER_SUT_IMAGE_UBUNTU_ARM = u"csit_sut-ubuntu2204:local"
191 # TRex install directory
192 TREX_INSTALL_DIR = u"/opt/trex-core-3.03"
194 # TRex pcap files directory
195 TREX_PCAP_DIR = f"{TREX_INSTALL_DIR}/scripts/avl"
198 TREX_LIMIT_MEMORY = get_int_from_env(u"TREX_LIMIT_MEMORY", 8192)
200 # TRex number of cores
201 TREX_CORE_COUNT = get_int_from_env(u"TREX_CORE_COUNT", 16)
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(
206 u"TREX_TX_DESCRIPTORS_COUNT", 0
208 TREX_RX_DESCRIPTORS_COUNT = get_int_from_env(
209 u"TREX_RX_DESCRIPTORS_COUNT", 0
212 # Trex force start regardless ports state
213 TREX_SEND_FORCE = get_pessimistic_bool_from_env(u"TREX_SEND_FORCE")
215 # TRex extra commandline arguments
216 TREX_EXTRA_CMDLINE = get_str_from_env(
217 u"TREX_EXTRA_CMDLINE", u"--mbuf-factor 32")
219 # TRex port driver default vfio-pci or set to igb_uio
220 TREX_PORT_DRIVER = get_str_from_env(
221 u"TREX_PORT_DRIVER", u"vfio-pci")
223 # Graph node variant value
224 GRAPH_NODE_VARIANT = get_str_from_env(u"GRAPH_NODE_VARIANT", u"")
226 # Default memory page size in case multiple configured in system
227 DEFAULT_HUGEPAGE_SIZE = get_str_from_env(u"DEFAULT_HUGEPAGE_SIZE", u"2M")
229 # Sysctl kernel.core_pattern
230 KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core"
232 # Core dump directory
233 CORE_DUMP_DIR = u"/tmp"
235 # Perf stat events (comma separated).
236 PERF_STAT_EVENTS = get_str_from_env(
238 u"cpu-clock,context-switches,cpu-migrations,page-faults,"
239 u"cycles,instructions,branches,branch-misses,L1-icache-load-misses")
241 # Equivalent to ~0 used in vpp code
242 BITWISE_NON_ZERO = 0xffffffff
244 # Default path to VPP API socket.
245 SOCKSVR_PATH = u"/run/vpp/api.sock"
247 # Default path to VPP CLI socket.
248 SOCKCLI_PATH = u"/run/vpp/cli.sock"
250 # Default path to VPP API Stats socket.
251 SOCKSTAT_PATH = u"/run/vpp/stats.sock"
253 # This MTU value is used to force VPP to fragment 1518B packet into two.
254 MTU_FOR_FRAGMENTATION = 1043
256 # Number of trials to execute in MRR test.
257 PERF_TRIAL_MULTIPLICITY = get_int_from_env(u"PERF_TRIAL_MULTIPLICITY", 10)
259 # Duration [s] of one trial in MRR test.
260 PERF_TRIAL_DURATION = get_float_from_env(u"PERF_TRIAL_DURATION", 1.0)
262 # Whether to use latency streams in main search trials.
263 PERF_USE_LATENCY = get_pessimistic_bool_from_env(u"PERF_USE_LATENCY")
265 # Duration of one latency-specific trial in NDRPDR test.
266 PERF_TRIAL_LATENCY_DURATION = get_float_from_env(
267 u"PERF_TRIAL_LATENCY_DURATION", 5.0)
269 # For some testbeds TG takes longer than usual to start sending traffic.
270 # This constant [s] allows longer wait, without affecting
271 # the approximate duration. For example, use 0.098 for AWS.
272 PERF_TRIAL_STL_DELAY = get_float_from_env(u"PERF_TRIAL_STL_DELAY", 0.0)
274 # ASTF usually needs a different value for the delay.
275 PERF_TRIAL_ASTF_DELAY = get_float_from_env(
276 u"PERF_TRIAL_ASTF_DELAY", 0.112
279 # Number of data frames in TPUT transaction, used both by TCP and UDP.
280 # The value should be 33 to keep historic continuity for UDP TPUT tests,
281 # but we are limited by TRex window of 48 KiB, so for 9000B tests
282 # it means we can send only 5 full data frames in a burst.
283 # https://github.com/cisco-system-traffic-generator/
284 # trex-core/blob/v2.88/src/44bsd/tcp_var.h#L896-L903
285 ASTF_N_DATA_FRAMES = get_int_from_env(u"ASTF_N_DATA_FRAMES", 5)
287 # Extended debug (incl. vpp packet trace, linux perf stat, ...).
288 # Full list is available as suite variable (__init__.robot) or is
290 EXTENDED_DEBUG = get_pessimistic_bool_from_env(u"EXTENDED_DEBUG")
292 # UUID string of DUT1 /tmp volume created outside of the
293 # DUT1 docker in case of vpp-device test. ${EMPTY} value means that
294 # /tmp directory is inside the DUT1 docker.
295 DUT1_UUID = get_str_from_env(u"DUT1_UUID", u"")
297 # Global "kill switch" for CRC checking during runtime.
298 FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env(
299 u"FAIL_ON_CRC_MISMATCH"
302 # Default IP4 prefix length (if not defined in topology file)
303 DEFAULT_IP4_PREFIX_LENGTH = u"24"
305 # Maximum number of interfaces in a data path
306 DATAPATH_INTERFACES_MAX = 100
308 # Mapping from NIC name to its bps limit.
309 NIC_NAME_TO_BPS_LIMIT = {
310 u"Intel-X520-DA2": 10000000000,
311 u"Intel-X710": 10000000000,
312 u"Intel-XL710": 24500000000,
313 u"Intel-XXV710": 24500000000,
314 u"Intel-E810XXV": 24500000000,
315 u"Intel-E822CQ": 24500000000,
316 u"Intel-E810CQ": 100000000000,
317 u"Mellanox-CX556A": 100000000000,
318 u"Mellanox-CX6DX": 100000000000,
319 u"Mellanox-CX7VEAT": 200000000000,
320 u"Amazon-Nitro-50G": 10000000000,
321 u"Amazon-Nitro-100G": 10000000000,
322 u"Amazon-Nitro-200G": 20000000000,
323 u"virtual": 100000000,
326 # Mapping from NIC name to its pps limit.
327 NIC_NAME_TO_PPS_LIMIT = {
328 u"Intel-X520-DA2": 14880952,
329 u"Intel-X710": 14880952,
330 u"Intel-XL710": 18750000,
331 u"Intel-XXV710": 18750000,
332 u"Intel-E810XXV": 29000000,
333 u"Intel-E822CQ": 29000000,
334 u"Intel-E810CQ": 58500000,
335 u"Mellanox-CX556A": 148809523,
336 u"Mellanox-CX6DX": 148809523,
337 u"Mellanox-CX7VEAT": 297619046,
338 u"Amazon-Nitro-50G": 1500000,
339 u"Amazon-Nitro-100G": 3000000,
340 u"Amazon-Nitro-200G": 6000000,
341 u"virtual": 14880952,
344 # Suite file names use codes for NICs.
346 u"Intel-X520-DA2": u"10ge2p1x520",
347 u"Intel-X710": u"10ge2p1x710",
348 u"Intel-XL710": u"40ge2p1xl710",
349 u"Intel-XXV710": u"25ge2p1xxv710",
350 u"Intel-E810XXV": u"25ge2p1e810xxv",
351 u"Intel-E822CQ": u"25ge2p1e822cq",
352 u"Intel-E810CQ": u"100ge2p1e810cq",
353 u"Amazon-Nitro-50G": u"50ge1p1ena",
354 u"Amazon-Nitro-100G": u"100ge1p1ena",
355 u"Amazon-Nitro-200G": u"200ge1p1ena",
356 u"Mellanox-CX556A": u"100ge2p1cx556a",
357 u"Mellanox-CX6DX": u"100ge2p1cx6dx",
358 u"Mellanox-CX7VEAT": u"200ge2p1cx7veat",
361 # Shortened lowercase NIC model name, useful for presentation.
362 NIC_CODE_TO_SHORT_NAME = {
363 u"10ge2p1x520": u"x520",
364 u"10ge2p1x710": u"x710",
365 u"40ge2p1xl710": u"xl710",
366 u"25ge2p1xxv710": u"xxv710",
367 u"25ge2p1e810xxv": u"e810xxv",
368 u"25ge2p1e822cq": u"e822cq",
369 u"100ge2p1e810cq": u"e810cq",
370 u"50ge1p1ena": u"ena",
371 u"100ge1p1ena": u"ena100",
372 u"200ge1p1ena": u"ena200",
373 u"100ge2p1cx556a": u"cx556a",
374 u"100ge2p1cx6dx": u"cx6dx",
375 u"200ge2p1cx7veat": u"cx7veat",
378 # Not each driver is supported by each NIC.
379 NIC_NAME_TO_DRIVER = {
380 u"Intel-X520-DA2": [u"vfio-pci", u"af_xdp"],
381 u"Intel-X710": [u"vfio-pci", u"avf", u"af_xdp"],
382 u"Intel-XL710": [u"vfio-pci", u"avf", u"af_xdp"],
383 u"Intel-XXV710": [u"vfio-pci", u"avf", u"af_xdp"],
384 u"Intel-E810XXV": [u"vfio-pci", u"avf", u"af_xdp"],
385 u"Intel-E822CQ": [u"vfio-pci", u"avf", u"af_xdp"],
386 u"Intel-E810CQ": [u"vfio-pci", u"avf", u"af_xdp"],
387 u"Amazon-Nitro-50G": [u"vfio-pci"],
388 u"Amazon-Nitro-100G": [u"vfio-pci"],
389 u"Amazon-Nitro-200G": [u"vfio-pci"],
390 u"Mellanox-CX556A": [u"rdma-core", u"mlx5_core", u"af_xdp"],
391 u"Mellanox-CX6DX": [u"rdma-core", u"mlx5_core", u"af_xdp"],
392 u"Mellanox-CX7VEAT": [u"rdma-core", u"mlx5_core", u"af_xdp"],
395 # Each driver needs different plugin to work.
396 NIC_DRIVER_TO_PLUGINS = {
397 u"vfio-pci": u"dpdk_plugin.so",
398 u"avf": u"avf_plugin.so",
399 u"rdma-core": u"rdma_plugin.so",
400 u"mlx5_core": u"dpdk_plugin.so",
401 u"af_xdp": u"af_xdp_plugin.so",
404 # Tags to differentiate tests for different NIC driver.
405 NIC_DRIVER_TO_TAG = {
406 u"vfio-pci": u"DRV_VFIO_PCI",
408 u"rdma-core": u"DRV_RDMA_CORE",
409 u"mlx5_core": u"DRV_MLX5_CORE",
410 u"af_xdp": u"DRV_AF_XDP",
413 # Suite names have to be different, add prefix.
414 NIC_DRIVER_TO_SUITE_PREFIX = {
417 u"rdma-core": u"rdma-",
418 u"mlx5_core": u"mlx5-",
419 u"af_xdp": u"af-xdp-",
422 # Number of virtual functions of physical nic.
423 NIC_DRIVER_TO_VFS = {
424 u"vfio-pci": u"nic_vfs}= | 0",
425 u"avf": u"nic_vfs}= | 1",
426 u"rdma-core": u"nic_vfs}= | 0",
427 u"mlx5_core": u"nic_vfs}= | 0",
428 u"af_xdp": u"nic_vfs}= | 0",
431 # Not each driver is supported by each NIC.
432 DPDK_NIC_NAME_TO_DRIVER = {
433 u"Intel-X520-DA2": [u"vfio-pci"],
434 u"Intel-X710": [u"vfio-pci"],
435 u"Intel-XL710": [u"vfio-pci"],
436 u"Intel-XXV710": [u"vfio-pci"],
437 u"Intel-E810XXV": [u"vfio-pci"],
438 u"Intel-E822CQ": [u"vfio-pci"],
439 u"Intel-E810CQ": [u"vfio-pci"],
440 u"Amazon-Nitro-50G": [u"vfio-pci"],
441 u"Amazon-Nitro-100G": [u"vfio-pci"],
442 u"Amazon-Nitro-200G": [u"vfio-pci"],
443 u"Mellanox-CX556A": [u"mlx5_core"],
444 u"Mellanox-CX6DX": [u"mlx5_core"],
445 u"Mellanox-CX7VEAT": [u"mlx5_core"],
448 # Tags to differentiate tests for different NIC driver.
449 DPDK_NIC_DRIVER_TO_TAG = {
450 u"vfio-pci": u"DRV_VFIO_PCI",
451 u"mlx5_core": u"DRV_MLX5_CORE",
454 # Suite names have to be different, add prefix.
455 DPDK_NIC_DRIVER_TO_SUITE_PREFIX = {
457 u"mlx5_core": u"mlx5-",
460 # Some identifiers constructed from suite names
461 # have to be independent of NIC driver used.
462 # In order to remove or reject the NIC driver part,
463 # it is useful to have a list of such prefixes precomputed.
464 FORBIDDEN_SUITE_PREFIX_LIST = [
465 prefix for prefix in NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
467 FORBIDDEN_SUITE_PREFIX_LIST += [
468 prefix for prefix in DPDK_NIC_DRIVER_TO_SUITE_PREFIX.values() if prefix
471 # TODO CSIT-1481: Crypto HW should be read from topology file instead.
472 NIC_NAME_TO_CRYPTO_HW = {
473 u"Intel-E810CQ": u"HW_4xxx",
474 u"Intel-E822CQ": u"HW_C4xxx",
475 u"Intel-X710": u"HW_DH895xcc",
476 u"Intel-XL710": u"HW_DH895xcc",
479 DEVICE_TYPE_TO_KEYWORD = {
483 PERF_TYPE_TO_KEYWORD = {
484 u"mrr": u"Traffic should pass with maximum rate",
485 u"ndrpdr": u"Find NDR and PDR intervals using optimized search",
486 u"soak": u"Find critical load using PLRsearch",
489 PERF_TYPE_TO_SUITE_DOC_VER = {
490 u"mrr": u'''fication:** In MaxReceivedRate tests TG sends traffic at \\
491 | ... | line rate and reports total received packets over trial period. \\''',
492 u"ndrpdr": u'''rification:** TG finds and reports throughput NDR (Non \\
493 | ... | Drop Rate) with zero packet loss tolerance and throughput PDR \\
494 | ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \\
495 | ... | expressed in percentage of packets transmitted. NDR and PDR are \\
496 | ... | discovered for different Ethernet L2 frame sizes using MLRsearch \\
498 u"soak": u'''rification:** TG sends traffic at dynamically computed \\
499 | ... | rate as PLRsearch algorithm gathers data and improves its estimate \\
500 | ... | of a rate at which a prescribed small fraction of packets \\
501 | ... | would be lost. After set time, the serarch stops \\
502 | ... | and the algorithm reports its current estimate. \\''',
505 PERF_TYPE_TO_TEMPLATE_DOC_VER = {
506 u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames \\
507 | | ... | using burst trials throughput test. \\''',
508 u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.",
509 u"soak": u"Estimate critical rate using PLRsearch algorithm. \\",