1 # Copyright 2016 Intel Corporation.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 """Various helper functions
22 from conf import settings as S
28 def settings_update_paths():
29 """ Configure paths to OVS, DPDK and QEMU sources and binaries based on
30 selected vswitch type and src/binary switch. Data are taken from
31 PATHS dictionary and after their processing they are stored inside TOOLS.
32 PATHS dictionary has specific section for 'vswitch', 'qemu' and 'dpdk'
33 Following processing is done for every item:
34 item 'type' - string, which defines the type of paths ('src' or 'bin') to be selected
36 'src' means, that VSPERF will use OVS, DPDK or QEMU built from sources
37 e.g. by execution of systems/build_base_machine.sh script during VSPERF
39 'bin' means, that VSPERF will use OVS, DPDK or QEMU binaries installed
40 in the OS, e.g. via OS specific packaging system
41 item 'path' - string with valid path; Its content is checked for existence, prefixed
42 with section name and stored into TOOLS for later use
43 e.g. TOOLS['dpdk_src'] or TOOLS['vswitch_src']
44 item 'modules' - list of strings; Every value from given list is checked for '.ko'
45 suffix. In case it matches and it is not an absolute path to the module, then
46 module name is prefixed with 'path' defined for the same section
47 e.g. TOOLS['vswitch_modules'] = [
48 '/tmp/vsperf/src_vanilla/ovs/ovs/datapath/linux/openvswitch.ko']
49 all other items - string - if given string is a relative path and item 'path'
50 is defined for a given section, then item content will be prefixed with
51 content of the 'path'. Otherwise tool name will be searched within
52 standard system directories. Also any OS filename wildcards will be
53 expanded to the real path. At the end of processing, every absolute
54 path is checked for its existence. In case that temporary path (i.e. path
55 with '_tmp' suffix) doesn't exist, then log will be written and vsperf will
56 continue. If any other path will not exist, then vsperf execution will
57 be terminated with runtime error.
59 Note: In case that 'bin' type is set for DPDK, then TOOLS['dpdk_src'] will be set to
60 the value of PATHS['dpdk']['src']['path']. The reason is, that VSPERF uses downloaded
61 DPDK sources to copy DPDK and testpmd into the GUEST, where testpmd is built. In case,
62 that DPDK sources are not available, then vsperf will continue with test execution,
63 but testpmd can't be used as a guest loopback. This is useful in case, that other guest
64 loopback applications (e.g. buildin) are used by CI jobs, etc.
66 # set dpdk and ovs paths accorfing to VNF and VSWITCH
68 vswitch_type = S.getValue('PATHS')['vswitch'][S.getValue('VSWITCH')]['type']
69 paths['vswitch'] = S.getValue('PATHS')['vswitch'][S.getValue('VSWITCH')][vswitch_type]
70 paths['dpdk'] = S.getValue('PATHS')['dpdk'][S.getValue('PATHS')['dpdk']['type']]
71 paths['qemu'] = S.getValue('PATHS')['qemu'][S.getValue('PATHS')['qemu']['type']]
73 paths['paths']['ovs_var_tmp'] = S.getValue('PATHS')['vswitch']['ovs_var_tmp']
74 paths['paths']['ovs_etc_tmp'] = S.getValue('PATHS')['vswitch']['ovs_etc_tmp']
77 for path_class in paths:
78 for tool in paths[path_class]:
79 tmp_tool = paths[path_class][tool]
81 # store valid path of given class into tools dict
83 if os.path.isdir(tmp_tool):
84 tools['{}_src'.format(path_class)] = tmp_tool
87 raise RuntimeError('Path {} does not exist.'.format(tmp_tool))
89 # store list of modules of given class into tools dict
92 for module in tmp_tool:
93 # add path to the .ko modules and check it for existence
94 if module.endswith('.ko') and not os.path.isabs(module):
95 module = os.path.join(paths[path_class]['path'], module)
96 if not os.path.exists(module):
97 raise RuntimeError('Cannot locate modlue {}'.format(module))
99 tmp_modules.append(module)
101 tools['{}_modules'.format(path_class)] = tmp_modules
104 # if path to the tool is relative, then 'path' will be prefixed
105 # in case that 'path' is not defined, then tool will be searched
106 # within standard system paths
107 if not os.path.isabs(tmp_tool):
108 if 'path' in paths[path_class]:
109 tmp_tool = os.path.join(paths[path_class]['path'], tmp_tool)
110 elif shutil.which(tmp_tool):
111 tmp_tool = shutil.which(tmp_tool)
113 raise RuntimeError('Cannot locate tool {}'.format(tmp_tool))
115 # expand OS wildcards in paths if needed
116 if glob.has_magic(tmp_tool):
117 tmp_glob = glob.glob(tmp_tool)
118 if len(tmp_glob) == 0:
119 raise RuntimeError('Path to the {} is not valid: {}.'.format(tool, tmp_tool))
120 elif len(tmp_glob) > 1:
121 raise RuntimeError('Path to the {} is ambiguous {}'.format(tool, tmp_glob))
122 elif len(tmp_glob) == 1:
123 tmp_tool = tmp_glob[0]
124 elif not os.path.exists(tmp_tool):
125 if tool.endswith('_tmp'):
126 logging.getLogger().debug('Temporary path to the {} does not '
127 'exist: {}.'.format(tool, tmp_tool))
129 raise RuntimeError('Path to the {} is not valid: {}'.format(tool, tmp_tool))
131 tools[tool] = tmp_tool
133 # ensure, that dpkg_src for bin will be set to downloaded DPDK sources, so it can
134 # be copied to the guest share dir and used by GUEST to build and run testpmd
135 # Validity of the path is not checked by purpose, so user can use VSPERF without
136 # downloading DPDK sources. In that case guest loopback can't be set to 'testpmd'
137 if S.getValue('PATHS')['dpdk']['type'] == 'bin':
138 tools['dpdk_src'] = S.getValue('PATHS')['dpdk']['src']['path']
140 S.setValue('TOOLS', tools)