CSIT-1477: add 1n_tx2 VPP Device
[csit.git] / resources / libraries / python / Constants.py
1 # Copyright (c) 2019 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
17 class Constants(object):
18     """Constants used in CSIT.
19
20     TODO: Yaml files are easier for humans to edit.
21     Figure out how to set the attributes by parsing a file
22     that works regardless of current working directory.
23     """
24
25     # OpenVPP testing directory location at topology nodes
26     REMOTE_FW_DIR = '/tmp/openvpp-testing'
27
28     # shell scripts location
29     RESOURCES_LIB_SH = 'resources/libraries/bash'
30
31     # Python API provider location
32     RESOURCES_PAPI_PROVIDER = 'resources/tools/papi/vpp_papi_provider.py'
33
34     # vat templates location
35     RESOURCES_TPL_VAT = 'resources/templates/vat'
36
37     # Kubernetes templates location
38     RESOURCES_TPL_K8S = 'resources/templates/kubernetes'
39
40     # KernelVM templates location
41     RESOURCES_TPL_VM = 'resources/templates/vm'
42
43     # Container templates location
44     RESOURCES_TPL_CONTAINER = 'resources/templates/container'
45
46     # OpenVPP VAT binary name
47     VAT_BIN_NAME = 'vpp_api_test'
48
49     # VPP service unit name
50     VPP_UNIT = 'vpp'
51
52     # Number of system CPU cores.
53     CPU_CNT_SYSTEM = 1
54
55     # Number of vswitch main thread CPU cores.
56     CPU_CNT_MAIN = 1
57
58     # QEMU binary path
59     QEMU_BIN_PATH = '/usr/bin'
60
61     # QEMU VM kernel image path
62     QEMU_VM_KERNEL = '/opt/boot/vmlinuz'
63
64     # QEMU VM nested image path
65     QEMU_VM_IMAGE = '/var/lib/vm/vhost-nested.img'
66
67     # QEMU VM DPDK path
68     QEMU_VM_DPDK = '/opt/dpdk-19.02'
69
70     # Docker container SUT image
71     DOCKER_SUT_IMAGE_UBUNTU = 'snergster/csit-sut:latest'
72
73     # TRex install version
74     TREX_INSTALL_VERSION = '2.54'
75
76     # TRex install directory
77     TREX_INSTALL_DIR = '/opt/trex-core-2.54'
78
79     # Honeycomb directory location at topology nodes:
80     REMOTE_HC_DIR = '/opt/honeycomb'
81
82     # Honeycomb persistence files location
83     REMOTE_HC_PERSIST = '/var/lib/honeycomb/persist'
84
85     # Honeycomb log file location
86     REMOTE_HC_LOG = '/var/log/honeycomb/honeycomb.log'
87
88     # Honeycomb templates location
89     RESOURCES_TPL_HC = 'resources/templates/honeycomb'
90
91     # ODL Client Restconf listener port
92     ODL_PORT = 8181
93
94     # Sysctl kernel.core_pattern
95     KERNEL_CORE_PATTERN = '/tmp/%p-%u-%g-%s-%t-%h-%e.core'
96
97     # Core dump directory
98     CORE_DUMP_DIR = '/tmp'
99
100     # Equivalent to ~0 used in vpp code
101     BITWISE_NON_ZERO = 0xffffffff
102
103     # Maximum number of API calls per PapiExecutor execution
104     PAPI_MAX_API_BULK = 250
105
106     # Mapping from NIC name to its bps limit.
107     # TODO: Implement logic to lower limits to TG NIC or software. Or PCI.
108     NIC_NAME_TO_LIMIT = {
109         # TODO: Explain why ~40Gbps NICs are using ~25Gbps limit.
110         "Cisco-VIC-1227": 10000000000,
111         "Cisco-VIC-1385": 24500000000,
112         "Intel-X520-DA2": 10000000000,
113         "Intel-X553": 10000000000,
114         "Intel-X710": 10000000000,
115         "Intel-XL710": 24500000000,
116         "Intel-XXV710": 24500000000,
117         "virtual": 100000000,
118     }
119
120     # Suite file names use somewhat more rich (less readable) codes for NICs.
121     NIC_NAME_TO_CODE = {
122         "Cisco-VIC-1227": "10ge2p1vic1227",
123         "Cisco-VIC-1385": "40ge2p1vic1385",
124         "Intel-X520-DA2": "10ge2p1x520",
125         "Intel-X553": "10ge2p1x553",
126         "Intel-X710": "10ge2p1x710",
127         "Intel-XL710": "40ge2p1xl710",
128         "Intel-XXV710": "25ge2p1xxv710",
129     }
130
131     # TODO CSIT-1481: Crypto HW should be read from topology file instead.
132     NIC_NAME_TO_CRYPTO_HW = {
133         "Intel-X553": "HW_C3xxx",
134         "Intel-X710": "HW_DH895xcc",
135         "Intel-XL710": "HW_DH895xcc",
136     }
137
138     PERF_TYPE_TO_KEYWORD = {
139         "mrr": "Traffic should pass with maximum rate",
140         "ndrpdr": "Find NDR and PDR intervals using optimized search",
141         "soak": "Find critical load using PLRsearch",
142     }
143
144     PERF_TYPE_TO_SUITE_DOC_VER = {
145         "mrr" : '''fication:* In MaxReceivedRate tests TG sends traffic\\
146 | ... | at line rate and reports total received packets over trial period.\\''',
147         # TODO: Figure out how to include the full "*[Ver] TG verification:*"
148         # while keeping this readable and without breaking line length limit.
149         "ndrpdr": '''fication:* TG finds and reports throughput NDR (Non Drop\\
150 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
151 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
152 | ... | of packets transmitted. NDR and PDR are discovered for different\\
153 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
154         "soak": '''fication:* TG sends traffic at dynamically computed\\
155 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
156 | ... | of a rate at which a prescribed small fraction of packets\\
157 | ... | would be lost. After set time, the serarch stops\\
158 | ... | and the algorithm reports its current estimate.\\''',
159     }
160
161     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
162         "mrr": '''Measure MaxReceivedRate for ${frame_size}B frames\\
163 | | ... | using burst trials throughput test.\\''',
164         "ndrpdr": '''Measure NDR and PDR values using MLRsearch algorithm.\\''',
165         "soak": '''Estimate critical rate using PLRsearch algorithm.\\''',
166     }

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.