1 # Copyright (c) 2016 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 """VPP Configuration File Generator library."""
19 from resources.libraries.python.ssh import SSH
20 from resources.libraries.python.topology import NodeType
21 from resources.libraries.python.topology import Topology
23 __all__ = ['VppConfigGenerator']
25 class VppConfigGenerator(object):
26 """VPP Configuration File Generator."""
29 # VPP Node to apply configuration on
35 # Serialized VPP Configuration
38 self._vpp_service_name = 'vpp'
39 # VPP Configuration file path
40 self._vpp_config_filename = '/etc/vpp/startup.conf'
42 def set_node(self, node):
45 :param node: Node to store configuration on.
47 :raises RuntimeError: If Node type is not DUT.
50 if node['type'] != NodeType.DUT:
51 raise RuntimeError('Startup config can only be applied to DUT'
54 self._hostname = Topology.get_node_hostname(node)
56 def set_config_filename(self, filename):
57 """Set startup configuration filename.
59 :param filename: Startup configuration filename.
62 self._vpp_config_filename = filename
64 def add_config_item(self, config, value, path):
65 """Add startup configuration item.
67 :param config: Startup configuration of node.
68 :param value: Value to insert.
69 :param path: Path where to insert item.
76 config[path[0]] = value
78 if not config.has_key(path[0]):
80 self.add_config_item(config[path[0]], value, path[1:])
82 def dump_config(self, obj, level=-1):
83 """Dump the startup configuration in VPP config format.
85 :param obj: Python Object to print.
86 :param nested_level: Nested level for indentation.
88 :type nested_level: int
93 self._vpp_config += '{}{{\n'.format((level) * indent)
94 if isinstance(obj, dict):
95 for key, val in obj.items():
96 if hasattr(val, '__iter__'):
97 self._vpp_config += '{}{}\n'.format((level + 1) * indent,
99 self.dump_config(val, level + 1)
101 self._vpp_config += '{}{} {}\n'.format((level + 1) * indent,
105 self._vpp_config += '{}{}\n'.format((level + 1) * indent, val)
107 self._vpp_config += '{}}}\n'.format(level * indent)
109 def add_unix_log(self, value='/tmp/vpe.log'):
110 """Add UNIX log configuration.
112 :param value: Log file.
115 path = ['unix', 'log']
116 self.add_config_item(self._nodeconfig, value, path)
118 def add_unix_cli_listen(self, value='localhost:5002'):
119 """Add UNIX cli-listen configuration.
121 :param value: CLI listen address and port.
124 path = ['unix', 'cli-listen']
125 self.add_config_item(self._nodeconfig, value, path)
127 def add_unix_nodaemon(self):
128 """Add UNIX nodaemon configuration."""
129 path = ['unix', 'nodaemon']
130 self.add_config_item(self._nodeconfig, '', path)
132 def add_unix_exec(self, value):
133 """Add UNIX exec configuration."""
134 path = ['unix', 'exec']
135 self.add_config_item(self._nodeconfig, value, path)
137 def add_dpdk_dev(self, *devices):
138 """Add DPDK PCI device configuration.
140 :param devices: PCI device(s) (format xxxx:xx:xx.x)
142 :raises ValueError: If PCI address format is not valid.
145 pattern = re.compile("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:"
146 "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$")
147 for device in devices:
148 if not pattern.match(device):
149 raise ValueError('PCI address {} to be added to host {} '
150 'is not in valid format xxxx:xx:xx.x'.
151 format(device, self._hostname))
152 path = ['dpdk', 'dev {0}'.format(device)]
153 self.add_config_item(self._nodeconfig, '', path)
155 def add_dpdk_cryptodev(self, count):
156 """Add DPDK Crypto PCI device configuration.
158 :param count: Number of crypto devices to add.
161 cryptodev = Topology.get_cryptodev(self._node)
162 for i in range(count):
163 cryptodev_config = 'dev {0}'.format(
164 re.sub(r'\d.\d$', '1.'+str(i), cryptodev))
165 path = ['dpdk', cryptodev_config]
166 self.add_config_item(self._nodeconfig, '', path)
167 self.add_dpdk_uio_driver('igb_uio')
169 def add_dpdk_dev_default_rxq(self, value):
170 """Add DPDK dev default rxq configuration.
172 :param value: Default number of rxqs.
175 path = ['dpdk', 'dev default', 'num-rx-queues']
176 self.add_config_item(self._nodeconfig, value, path)
178 def add_dpdk_dev_default_txq(self, value):
179 """Add DPDK dev default txq configuration.
181 :param value: Default number of txqs.
184 path = ['dpdk', 'dev default', 'num-tx-queues']
185 self.add_config_item(self._nodeconfig, value, path)
187 def add_dpdk_socketmem(self, value):
188 """Add DPDK socket memory configuration.
190 :param value: Socket memory size.
193 path = ['dpdk', 'socket-mem']
194 self.add_config_item(self._nodeconfig, value, path)
196 def add_dpdk_uio_driver(self, value):
197 """Add DPDK uio-driver configuration.
199 :param value: DPDK uio-driver configuration.
202 path = ['dpdk', 'uio-driver']
203 self.add_config_item(self._nodeconfig, value, path)
205 def add_cpu_main_core(self, value):
206 """Add CPU main core configuration.
208 :param value: Main core option.
211 path = ['cpu', 'main-core']
212 self.add_config_item(self._nodeconfig, value, path)
214 def add_cpu_corelist_workers(self, value):
215 """Add CPU corelist-workers configuration.
217 :param value: Corelist-workers option.
220 path = ['cpu', 'corelist-workers']
221 self.add_config_item(self._nodeconfig, value, path)
223 def add_heapsize(self, value):
224 """Add Heapsize configuration.
226 :param value: Amount of heapsize.
230 self.add_config_item(self._nodeconfig, value, path)
232 def add_api_trace(self):
233 """Add API trace configuration."""
234 path = ['api-trace', 'on']
235 self.add_config_item(self._nodeconfig, '', path)
237 def add_ip6_hash_buckets(self, value):
238 """Add IP6 hash buckets configuration.
240 :param value: Number of IP6 hash buckets.
243 path = ['ip6', 'hash-buckets']
244 self.add_config_item(self._nodeconfig, value, path)
246 def add_ip6_heap_size(self, value):
247 """Add IP6 heap-size configuration.
249 :param value: IP6 Heapsize amount.
252 path = ['ip6', 'heap-size']
253 self.add_config_item(self._nodeconfig, value, path)
255 def add_plugin_disable(self, *plugins):
256 """Add plugin disable for specific plugin.
258 :param plugins: Plugin(s) to disable.
261 for plugin in plugins:
262 path = ['plugins', 'plugin {0}'.format(plugin), 'disable']
263 self.add_config_item(self._nodeconfig, ' ', path)
265 def add_dpdk_no_multi_seg(self):
266 """Add DPDK no-multi-seg configuration."""
267 path = ['dpdk', 'no-multi-seg']
268 self.add_config_item(self._nodeconfig, '', path)
270 def add_snat(self, value='deterministic'):
271 """Add SNAT configuration.
273 :param value: SNAT mode.
277 self.add_config_item(self._nodeconfig, value, path)
279 def apply_config(self, waittime=5, retries=12):
280 """Generate and apply VPP configuration for node.
282 Use data from calls to this class to form a startup.conf file and
283 replace /etc/vpp/startup.conf with it on node.
285 :param waittime: Time to wait for VPP to restart (default 5 seconds).
286 :param retries: Number of times (default 12) to re-try waiting.
289 :raises RuntimeError: If writing config file failed, or restarting of
292 self.dump_config(self._nodeconfig)
295 ssh.connect(self._node)
297 # We're using this "| sudo tee" construct because redirecting
298 # a sudo's output ("sudo echo xxx > /path/to/file") does not
299 # work on most platforms...
301 ssh.exec_command('echo "{0}" | sudo tee {1}'.
302 format(self._vpp_config,
303 self._vpp_config_filename))
306 raise RuntimeError('Writing config file failed to node {}'.
307 format(self._hostname))
309 # Instead of restarting, we'll do separate start and stop
310 # actions. This way we don't care whether VPP was running
312 ssh.exec_command('sudo service {} stop'
313 .format(self._vpp_service_name))
315 ssh.exec_command('sudo service {} start'
316 .format(self._vpp_service_name))
318 raise RuntimeError('Restarting VPP failed on node {}'.
319 format(self._hostname))
321 # Sleep <waittime> seconds, up to <retry> times,
322 # and verify if VPP is running.
323 for _ in range(retries):
326 ssh.exec_command('echo show hardware-interfaces | '
327 'nc 0 5002 || echo "VPP not yet running"')
331 raise RuntimeError('VPP failed to restart on node {}'.
332 format(self._hostname))
334 def apply_config_lxc(self, lxc_name, waittime=5, retries=12):
335 """Generate and apply VPP configuration for node in a container.
337 Use data from calls to this class to form a startup.conf file and
338 replace /etc/vpp/startup.conf with it on node inside a container.
340 :param lxc_name: LXC container name.
341 :param waittime: Time to wait for VPP to restart (default 5 seconds).
342 :param retries: Number of times (default 12) to re-try waiting.
346 :raises RuntimeError: If writing config file failed, or restarting of
349 self.dump_config(self._nodeconfig)
352 ssh.connect(self._node)
354 # We're using this "| sudo tee" construct because redirecting
355 # a sudo's output ("sudo echo xxx > /path/to/file") does not
356 # work on most platforms...
358 ssh.exec_command_lxc('echo "{0}" | sudo tee {1}'.
359 format(self._vpp_config,
360 self._vpp_config_filename), lxc_name)
363 raise RuntimeError('Writing config file failed in {0} to node {1}'.
364 format(lxc_name, self._hostname))
366 # Instead of restarting, we'll do separate start and stop
367 # actions. This way we don't care whether VPP was running
369 ssh.exec_command_lxc('service {0} stop'.
370 format(self._vpp_service_name), lxc_name)
372 ssh.exec_command_lxc('service {0} start'.
373 format(self._vpp_service_name), lxc_name)
375 raise RuntimeError('Restarting VPP failed in {0} on node {1}'.
376 format(lxc_name, self._hostname))
378 # Sleep <waittime> seconds, up to <retry> times,
379 # and verify if VPP is running.
380 for _ in range(retries):
383 ssh.exec_command_lxc('echo show hardware-interfaces | '
384 'nc 0 5002 || echo "VPP not yet running"',
389 raise RuntimeError('VPP failed to restart in {0} on node {1}'.
390 format(lxc_name, self._hostname))