Host network configuration tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

944 lines
34 KiB

# -*- coding: utf-8 -*-
# Copyright 2014 Red Hat, Inc.
# 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
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import glob
import logging
import os
import re
import time
import yaml
from os_net_config import common
from os_net_config import sriov_config
from oslo_concurrency import processutils
logger = logging.getLogger(__name__)
_SYS_BUS_PCI_DEV = '/sys/bus/pci/devices'
# File to contain the DPDK mapped nics, as nic name will not be available after
# binding driver, which is required for correct nic numbering.
# Format of the file (list mapped nic's details):
# -
# name: eth1
# pci_address: 0000:02:00.0
# mac_address: 01:02:03:04:05:06
# driver: vfio-pci
_DPDK_MAPPING_FILE = '/var/lib/os-net-config/dpdk_mapping.yaml'
# sriov_config service shall be created and enabled so that the various
# SR-IOV PF and VF configurations shall be done during reboot as well using
# installed in path /usr/bin/os-net-config-sriov
_SRIOV_CONFIG_SERVICE_FILE = "/etc/systemd/system/sriov_config.service"
Description=SR-IOV numvfs configuration
After=systemd-udev-settle.service openibd.service
Before=system-driverctl.slice openvswitch.service
# VPP startup operational configuration file. The content of this file will
# be executed when VPP starts as if typed from CLI.
_VPP_EXEC_FILE = '/etc/vpp/vpp-exec'
class InvalidInterfaceException(ValueError):
class OvsDpdkBindException(ValueError):
class VppException(ValueError):
class ContrailVrouterException(ValueError):
class SriovVfNotFoundException(ValueError):
def write_config(filename, data):
with open(filename, 'w') as f:
def write_yaml_config(filepath, data):
with open(filepath, 'w') as f:
yaml.safe_dump(data, f, default_flow_style=False)
def ensure_directory_presence(filepath):
dir_path = os.path.dirname(filepath)
if not os.path.exists(dir_path):
def get_file_data(filename):
if not os.path.exists(filename):
return ''
with open(filename, 'r') as f:
except IOError:
logger.error("Error reading file: %s" % filename)
return ''
def interface_mac(name):
try: # If the iface is part of a Linux bond, the real MAC is only here.
with open(common.get_dev_path(name, 'bonding_slave/perm_hwaddr'),
'r') as f:
except IOError:
pass # Iface is not part of a bond, continue
with open(common.get_dev_path(name, '_address'), 'r') as f:
except IOError:
# If the interface is bound to a DPDK driver, get the mac address from
# the DPDK mapping file as /sys files will be removed after binding.
dpdk_mac_address = _get_dpdk_mac_address(name)
if dpdk_mac_address:
return dpdk_mac_address
logger.error("Unable to read mac address: %s" % name)
def is_active_nic(interface_name):
return _is_available_nic(interface_name, True)
def is_real_nic(interface_name):
if interface_name == 'lo':
return True
device_dir = common.get_dev_path(interface_name, '_device')
has_device_dir = os.path.isdir(device_dir)
address = None
with open(common.get_dev_path(interface_name, "_address"), 'r') as f:
address =
except IOError:
return False
if has_device_dir and address:
return True
return False
def _is_vf(pci_address):
# If DPDK drivers are bound on a VF, then the path common.SYS_CLASS_NET
# wouldn't exist. Instead we look for the path
# /sys/bus/pci/devices/<PCI addr>/physfn to understand if the device
# is actually a VF. This path could be used by VFs not bound with
# DPDK drivers as well
vf_path_check = _SYS_BUS_PCI_DEV + '/%s/physfn' % pci_address
is_sriov_vf = os.path.isdir(vf_path_check)
return is_sriov_vf
def _is_vf_by_name(interface_name, check_mapping_file=False):
vf_path_check = common.get_dev_path(interface_name, 'physfn')
is_sriov_vf = os.path.isdir(vf_path_check)
if not is_sriov_vf and check_mapping_file:
sriov_map = _get_sriov_map()
for item in sriov_map:
if (item['name'] == interface_name and
item['device_type'] == 'vf'):
is_sriov_vf = True
return is_sriov_vf
def _is_available_nic(interface_name, check_active=True):
if interface_name == 'lo':
return False
if not is_real_nic(interface_name):
return False
operstate = None
with open(common.get_dev_path(interface_name, '_operstate'),
'r') as f:
operstate =
if check_active and operstate != 'up':
return False
# If SR-IOV Virtual Functions (VF) are enabled in an interface, there
# will be additional nics created for each VF. It has to be ignored in
# the nic numbering. All the VFs will have a reference to the PF with
# directory name as 'physfn', if this directory is present it should be
# ignored.
if _is_vf_by_name(interface_name):
return False
# nic is available
return True
except IOError:
return False
def _natural_sort_key(s):
nsre = re.compile('([0-9]+)')
return [int(text) if text.isdigit() else text
for text in re.split(nsre, s)]
def _is_embedded_nic(nic):
if nic.startswith('em') or nic.startswith('eth') or nic.startswith('eno'):
return True
return False
def ordered_available_nics():
return _ordered_nics(False)
def ordered_active_nics():
return _ordered_nics(True)
def _ordered_nics(check_active):
embedded_nics = []
nics = []"Finding active nics")
for name in glob.iglob(common.SYS_CLASS_NET + '/*'):
nic = name[(len(common.SYS_CLASS_NET) + 1):]
if _is_available_nic(nic, check_active):
if _is_embedded_nic(nic):"%s is an embedded active nic" % nic)
else:"%s is an active nic" % nic)
else:"%s is not an active nic" % nic)
# Adding nics which are bound to DPDK as it will not be found in '/sys'
# after it is bound to DPDK driver.
contents = get_file_data(_DPDK_MAPPING_FILE)
if contents:
dpdk_map = yaml.safe_load(contents)
for item in dpdk_map:
# If the DPDK drivers are bound to a VF, the same needs
# to be skipped for the NIC ordering
nic = item['name']
if _is_vf(item['pci_address']):"%s is a VF, skipping it for NIC ordering" % nic)
elif _is_vf_by_name(nic, True):"%s is a VF, skipping it for NIC ordering" % nic)
elif _is_embedded_nic(nic):"%s is an embedded DPDK bound nic" % nic)
if nic not in embedded_nics:
else:"%s is an DPDK bound nic" % nic)
if nic not in nics:
else:"No DPDK mapping available in path (%s)" %
# NOTE: we could just natural sort all active devices,
# but this ensures em, eno, and eth are ordered first
# (more backwards compatible)
active_nics = (sorted(embedded_nics, key=_natural_sort_key) +
sorted(nics, key=_natural_sort_key))"Active nics are %s" % active_nics)
return active_nics
def diff(filename, data):
file_data = get_file_data(filename)
logger.debug("Diff file data:\n%s" % file_data)
logger.debug("Diff data:\n%s" % data)
# convert to string as JSON may have unicode in it
return not file_data == data
def bind_dpdk_interfaces(ifname, driver, noop):
iface_driver = get_interface_driver(ifname)
if iface_driver == driver:"Driver (%s) is already bound to the device (%s)" %
(driver, ifname))
pci_address = get_pci_address(ifname, noop)
if not noop:
if pci_address:
# modbprobe of the driver has to be done before binding.
# for reboots, puppet will add the modprobe to /etc/rc.modules
if 'vfio-pci' in driver:
processutils.execute('modprobe', 'vfio-pci')
except processutils.ProcessExecutionError:
msg = "Failed to modprobe vfio-pci module"
raise OvsDpdkBindException(msg)
mac_address = interface_mac(ifname)
vendor_id = common.get_vendor_id(ifname)
out, err = processutils.execute('driverctl', 'set-override',
pci_address, driver)
if err:
msg = "Failed to bind dpdk interface err - %s" % err
raise OvsDpdkBindException(msg)
_update_dpdk_map(ifname, pci_address, mac_address, driver)
# Not like other nics, beacause mellanox nics keep the
# interface after binding it to dpdk, so we are adding
# ethtool command with 10 attempts after binding the driver
# just to make sure that the interface is initialized
# successfully in order not to fail in each of this cases:
# - get_dpdk_devargs() in case of OvsDpdkPort and
# OvsDpdkBond.
# - bind_dpdk_interface() in case of OvsDpdkBond.
if vendor_id == "0x15b3":
processutils.execute('ethtool', '-i', ifname,
except processutils.ProcessExecutionError:
msg = "Failed to bind interface %s with dpdk" % ifname
raise OvsDpdkBindException(msg)
# Check if the pci address is already fetched and stored.
# If the pci address could not be fetched from dpdk_mapping.yaml
# raise OvsDpdkBindException, since the interface is neither
# available nor bound with dpdk.
if not get_stored_pci_address(ifname, noop):
msg = "Interface %s cannot be found" % ifname
raise OvsDpdkBindException(msg)
else:'Interface %(name)s bound to DPDK driver %(driver)s '
'using driverctl command' %
{'name': ifname, 'driver': driver})
def get_pci_address(ifname, noop):
# TODO(skramaja): Validate if the given interface supports dpdk
if not noop:
out, err = processutils.execute('ethtool', '-i', ifname)
if not err:
for item in out.split('\n'):
if 'bus-info' in item:
return item.split(' ')[1]
except processutils.ProcessExecutionError:
# If ifname is already bound, then ethtool will not be able to
# list the device, in which case, binding is already done, proceed
# with scripts generation.
else:'Fetch the PCI address of the interface %s using '
'ethtool' % ifname)
def get_stored_pci_address(ifname, noop):
if not noop:
dpdk_map = _get_dpdk_map()
for dpdk_nic in dpdk_map:
if dpdk_nic['name'] == ifname:
return dpdk_nic['pci_address']
else:'Fetch the PCI address of the interface %s using '
'ethtool' % ifname)
def translate_ifname_to_pci_address(ifname, noop):
pci_address = get_stored_pci_address(ifname, noop)
if pci_address is None and not noop:
pci_address = get_pci_address(ifname, noop=False)
mac_address = interface_mac(ifname)
_update_dpdk_map(ifname, pci_address, mac_address, driver=None)
return pci_address
def get_interface_driver(ifname):
uevent = common.get_dev_path(ifname, 'device/uevent')
with open(uevent, 'r') as f:
out =
for line in out.split('\n'):
if 'DRIVER' in line:
driver = line.split('=')
if len(driver) == 2:
return driver[1]
except IOError:
def get_dpdk_devargs(ifname, noop):
if not noop:
vendor_id = common.get_vendor_id(ifname)
device_id = common.get_device_id(ifname)
if vendor_id == "0x15b3":"Getting devargs for Mellanox cards")
if device_id == "0x1007":
# Some NICs (i.e. Mellanox ConnectX-3) have only one PCI
# address associated with multiple ports. Using a PCI
# device won’t work. Instead, we should use
# "class=eth,mac=<MAC>"
dpdk_devargs = "class=eth,mac=%s" % interface_mac(ifname)
elif is_active_nic(ifname):
# Other Mellanox devices are active and they are not stored
# in dpdk_mapping.yaml file, so we need to get their pci
# address with ethtool.
dpdk_devargs = get_pci_address(ifname, noop)
elif _is_vf_by_name(ifname):
# For Mellanox devices the VFs bound with DPDK shall
# be treated the same as VFs of other devices
dpdk_devargs = get_pci_address(ifname, noop)
msg = ("Unable to get devargs for interface %s" % ifname)
raise InvalidInterfaceException(msg)
else:"Getting stored PCI address as devarg")
dpdk_devargs = get_stored_pci_address(ifname, noop)
logger.debug("Devargs found: %s" % (dpdk_devargs))
return dpdk_devargs
# Once the interface is bound to a DPDK driver, all the references to the
# interface including '/sys' and '/proc', will be removed. And there is no
# way to identify the nic name after it is bound. So, the DPDK bound nic info
# is stored persistently in _DPDK_MAPPING_FILE and is used to for nic numbering
# on subsequent runs of os-net-config.
def _update_dpdk_map(ifname, pci_address, mac_address, driver):
dpdk_map = _get_dpdk_map()
for item in dpdk_map:
if item['pci_address'] == pci_address:
item['name'] = ifname
item['mac_address'] = mac_address
item['driver'] = driver
new_item = {}
new_item['pci_address'] = pci_address
new_item['name'] = ifname
new_item['mac_address'] = mac_address
new_item['driver'] = driver
write_yaml_config(_DPDK_MAPPING_FILE, dpdk_map)
def _get_dpdk_map():
contents = get_file_data(_DPDK_MAPPING_FILE)
dpdk_map = yaml.safe_load(contents) if contents else []
return dpdk_map
def _get_dpdk_mac_address(name):
contents = get_file_data(_DPDK_MAPPING_FILE)
dpdk_map = yaml.safe_load(contents) if contents else []
for item in dpdk_map:
if item['name'] == name:
return item['mac_address']
def update_sriov_pf_map(ifname, numvfs, noop, promisc=None,
link_mode='legacy', vdpa=False):
if not noop:
cur_numvfs = sriov_config.get_numvfs(ifname)
if cur_numvfs > 0 and cur_numvfs != numvfs:
msg = ("Can't change the numvfs for %s" % ifname)
raise sriov_config.SRIOVNumvfsException(msg)
sriov_map = _get_sriov_map()
for item in sriov_map:
if item['device_type'] == 'pf' and item['name'] == ifname:
item['numvfs'] = numvfs
item['vdpa'] = vdpa
if promisc is not None:
item['promisc'] = promisc
item['link_mode'] = link_mode
new_item = {}
new_item['device_type'] = 'pf'
new_item['name'] = ifname
new_item['numvfs'] = numvfs
new_item['vdpa'] = vdpa
if promisc is not None:
new_item['promisc'] = promisc
new_item['link_mode'] = link_mode
write_yaml_config(sriov_config._SRIOV_CONFIG_FILE, sriov_map)
def _get_sriov_map():
contents = get_file_data(sriov_config._SRIOV_CONFIG_FILE)
sriov_map = yaml.safe_load(contents) if contents else []
return sriov_map
def _set_vf_fields(vf_name, vlan_id, qos, spoofcheck, trust, state, macaddr,
promisc, pci_address, min_tx_rate, max_tx_rate):
vf_configs = {}
vf_configs['name'] = vf_name
if vlan_id != 0:
vf_configs['vlan_id'] = vlan_id
vf_configs['vlan_id'] = None
if qos != 0:
vf_configs['qos'] = qos
vf_configs['qos'] = None
vf_configs['min_tx_rate'] = min_tx_rate
vf_configs['max_tx_rate'] = max_tx_rate
vf_configs['spoofcheck'] = spoofcheck
vf_configs['trust'] = trust
vf_configs['state'] = state
vf_configs['macaddr'] = macaddr
vf_configs['promisc'] = promisc
vf_configs['pci_address'] = pci_address
return vf_configs
def _clear_empty_values(vf_config):
for (key, val) in list(vf_config.items()):
if val is None:
del vf_config[key]
def update_sriov_vf_map(pf_name, vfid, vf_name, vlan_id=0, qos=0,
spoofcheck=None, trust=None, state=None, macaddr=None,
promisc=None, pci_address=None,
min_tx_rate=0, max_tx_rate=0):
sriov_map = _get_sriov_map()
for item in sriov_map:
if (item['device_type'] == 'vf' and
item['device'].get('name') == pf_name and
item['device'].get('vfid') == vfid):
item.update(_set_vf_fields(vf_name, vlan_id, qos, spoofcheck,
trust, state, macaddr, promisc,
pci_address, min_tx_rate, max_tx_rate))
new_item = {}
new_item['device_type'] = 'vf'
new_item['device'] = {"name": pf_name, "vfid": vfid}
new_item.update(_set_vf_fields(vf_name, vlan_id, qos, spoofcheck,
trust, state, macaddr, promisc,
pci_address, min_tx_rate, max_tx_rate))
write_yaml_config(sriov_config._SRIOV_CONFIG_FILE, sriov_map)
def _get_vf_name_from_map(pf_name, vfid):
sriov_map = _get_sriov_map()
for item in sriov_map:
if (item['device_type'] == 'vf' and
item['device'].get('name') == pf_name and
item['device'].get('vfid') == vfid):
return item['name']
def nicpart_udev_rules_check():
"""Clean-up UDEV rules on initial deployment
After writing sriov_config.yaml file, clean-up
UDEV rule(s) of PF for which VFs are used by host
if not os.path.exists(sriov_config._UDEV_LEGACY_RULE_FILE):
udev = '^KERNEL=="(.*)", RUN.*'
udev_reg = re.compile(udev, 0)
with open(sriov_config._UDEV_LEGACY_RULE_FILE, "r") as fp:
rules = fp.readlines()
with open(sriov_config._UDEV_LEGACY_RULE_FILE, "w") as fp:
for line in rules:
match = udev_reg.match(line)
if match:
dev_name =
if not sriov_config.is_partitioned_pf(dev_name):
def _configure_sriov_config_service():
"""Generate the sriov_config.service
sriov_config service shall configure the numvfs for the SriovPF nics
during reboot of the nodes.
with open(_SRIOV_CONFIG_SERVICE_FILE, 'w') as f:
processutils.execute('systemctl', 'enable', 'sriov_config')
def configure_sriov_pfs(execution_from_cli=False, restart_openvswitch=False):"Configuring PFs now")
def configure_sriov_vfs():"Configuring VFs now")
def get_vf_devname(pf_name, vfid):
vf_path = os.path.join(common.SYS_CLASS_NET, pf_name,
if os.path.isdir(vf_path):
vf_nic = os.listdir(vf_path)
# if VF devices are bound with other drivers (DPDK) then the path
# doesn't exist. In such cases let us retrieve the vf name stored in
# the map
vf_name = _get_vf_name_from_map(pf_name, vfid)
if vf_name is not None:
return vf_name
msg = "NIC %s with VF id: %d could not be found" % (pf_name, vfid)
raise SriovVfNotFoundException(msg)
if len(vf_nic) != 1:
msg = "VF name could not be identified in %s" % vf_path
raise SriovVfNotFoundException(msg)
# The VF's actual device name shall be the only directory seen in the path
# /sys/class/net/<pf_name>/device/virtfn<vfid>/net
return vf_nic[0]
def restart_vpp(vpp_interfaces):
for vpp_int in vpp_interfaces:
if 'vfio-pci' in vpp_int.uio_driver:
processutils.execute('modprobe', 'vfio-pci')'Restarting VPP')
processutils.execute('systemctl', 'restart', 'vpp')
def _get_vpp_interface(pci_addr, tries=1, timeout=5):
"""Get VPP interface information from a given PCI address
From a running VPP instance, attempt to find the interface name and index
from a given PCI address of a NIC. The index is used to identify VPP bond
interface associated with the VPP interface.
:param pci_addr: PCI address to lookup, in the form of DDDD:BB:SS.F, where
- DDDD = Domain
- BB = Bus Number
- SS = Slot number
- F = Function
:param tries: Number of tries for getting vppctl output. Defaults to 1.
:param timeout: Timeout in seconds between tries. Defaults to 5.
:return: VPP interface name. None if an interface is not found.
if not pci_addr:
return None
for _ in range(tries):
timestamp = time.time()
processutils.execute('systemctl', 'is-active', 'vpp')
out, err = processutils.execute('vppctl', 'show', 'interface',
logger.debug("vppctl show interface\n%s\n%s\n" % (out, err))
m =':([0-9a-fA-F]{2}):([0-9a-fA-F]{2}).([0-9a-fA-F])',
if m:
formatted_pci = "%x/%x/%x" % (int(, 16),
int(, 16),
int(, 16))
raise VppException('Invalid PCI address format: %s' % pci_addr)
m ='^(\w+%s)\s+(\d+)' % formatted_pci, out,
if m:'VPP interface found: %s, index: %s' %
return {'name':, 'index':}
except processutils.ProcessExecutionError:
time.sleep(max(0, (timestamp + timeout) - time.time()))
else:'Interface with pci address %s not bound to vpp' %
return None
def _get_vpp_bond(member_ids):
"""Get VPP bond information from a given list of VPP interface indices
:param member_ids: list of VPP interfaces indices for the bond
:return: VPP bond name and index. None if an interface is not found.
if not member_ids:
return None
member_ids_str = ' '.join(member_ids)
out, err = processutils.execute('vppctl', 'show',
'hardware-interfaces', 'bond', 'brief',
logger.debug('vppctl show hardware-interfaces bond brief\n%s' % out)
m ='^\s*(BondEthernet\d+)\s+(\d+)\s+.+Slave-Idx:\s+%s\s*$' %
if m:'Bond found: %s, index: %s' % (,
return {'name':, 'index':}
else:'Bond with member indices "%s" not found in VPP'
% member_ids_str)
return None
def generate_vpp_config(vpp_config_path, vpp_interfaces, vpp_bonds):
"""Generate configuration content for VPP
Generate interface related configuration content for VPP. Current
configuration will be preserved, with interface related configurations
updated or inserted. The config only affects 'dpdk' section of VPP config
file, and only those lines affecting interfaces, specifically, lines
containing the following:
dpdk {
dev <pci_dev> {<options>}
uio-driver <uio_driver_name>
:param vpp_config_path: VPP Configuration file path
:param vpp_interfaces: List of VPP interface objects
:param vpp_bonds: List of VPP bond objects
:return: updated VPP config content.
data = get_file_data(vpp_config_path)
# Add interface config to 'dpdk' section
for vpp_interface in vpp_interfaces:
if vpp_interface.pci_dev:'vpp interface %s pci dev: %s'
% (, vpp_interface.pci_dev))
if vpp_interface.options:
int_cfg = '%s {%s}' % (vpp_interface.pci_dev,
int_cfg = vpp_interface.pci_dev
# Make sure 'dpdk' section exists in the config
if not'^\s*dpdk\s*\{', data, re.MULTILINE):
data += "\ndpdk {\n}\n"
# Find existing config line for the device we are trying to
# configure, the line should look like 'dev <pci_dev> ...'
# If such config line is found, we will replace the line with
# appropriate configuration, otherwise, add a new config line
# in 'dpdk' section of the config.
m ='^\s*dev\s+%s\s*(\{[^}]*\})?\s*$'
% vpp_interface.pci_dev, data,
if m:
data = re.sub(, ' dev %s\n' % int_cfg, data,
data = re.sub(r'(^\s*dpdk\s*\{)',
r'\1\n dev %s\n' % int_cfg,
if vpp_interface.uio_driver:
# Check if there is existing uio-driver configuration, if
# found, the line will be replaced with the appropriate
# configuration, otherwise, add a new line in 'dpdk' section.
m ='^\s*uio-driver.*$', data, re.MULTILINE)
if m:
data = re.sub(r'^\s*uio-driver.*$', ' uio-driver %s'
% vpp_interface.uio_driver, data,
data = re.sub(r'(^\s*dpdk\s*\{)',
r'\1\n uio-driver %s'
% vpp_interface.uio_driver,
raise VppException('Interface %s has no PCI address and is not'
' found in mapping file' %
# Add bond config to 'dpdk' section
for vpp_bond in vpp_bonds:
slave_str = ''
for member in vpp_bond.members:
slave_str += ",slave=%s" % member.pci_dev
if vpp_bond.bonding_options:
options_str = ',' + vpp_bond.bonding_options.strip(' ,')
options_str = ''
if slave_str:
m ='^\s*vdev\s+%s.*$' %,
data, re.MULTILINE)
if m:
data = re.sub(, r' vdev %s%s%s'
% (, slave_str, options_str),
data = re.sub(r'(^\s*dpdk\s*\{)',
r'\1\n vdev %s%s%s'
% (, slave_str, options_str),
# Add start up script for VPP to config. This script will be executed by
# VPP on service start.
if not'^\s*unix\s*\{', data, re.MULTILINE):
data += "\nunix {\n}\n"
m ='^\s*(exec|startup-config).*$',
if m:
data = re.sub(, ' exec %s' % _VPP_EXEC_FILE, data)
data = re.sub(r'(^\s*unix\s*\{)',
r'\1\n exec %s' % _VPP_EXEC_FILE,
# Make sure startup script exists to avoid VPP startup failure.
open(_VPP_EXEC_FILE, 'a').close()
return data
def update_vpp_mapping(vpp_interfaces, vpp_bonds):
"""Verify VPP interface binding and update mapping file
VppException will be raised if interfaces are not properly bound.
:param vpp_interfaces: List of VPP interface objects
:param vpp_bonds: List of VPP bond objects
cli_list = []
for vpp_int in vpp_interfaces:
# Try to get VPP interface name. In case VPP service is down
# for some reason, we will restart VPP and try again. Currently
# only trying one more time, can turn into a retry_counter if needed
# in the future.
for i in range(2):
int_info = _get_vpp_interface(vpp_int.pci_dev,
tries=12, timeout=5)
if not int_info:
vpp_int.vpp_name = int_info['name']
vpp_int.vpp_idx = int_info['index']
raise VppException('Interface %s with pci address %s not '
'bound to vpp'
% (, vpp_int.pci_dev))
# Generate content of startup script for VPP
if not vpp_bonds:
cli_list.append('set interface state %s up'
% int_info['name'])
for address in vpp_int.addresses:
cli_list.append('set interface ip address %s %s/%s\n'
% (int_info['name'], address.ip,
address.prefixlen))'Updating mapping for vpp interface %s:'
'pci_dev: %s mac address: %s uio driver: %s'
% (, vpp_int.pci_dev, vpp_int.hwaddr,
_update_dpdk_map(, vpp_int.pci_dev, vpp_int.hwaddr,
for vpp_bond in vpp_bonds:
bond_ids = [member.vpp_idx for member in vpp_bond.members]
bond_info = _get_vpp_bond(bond_ids)
if bond_info:
cli_list.append('set interface state %s up'
% bond_info['name'])
for address in vpp_bond.addresses:
cli_list.append('set interface ip address %s %s/%s'
% (bond_info['name'], address.ip,
raise VppException('Bond %s not found in VPP.' %
vpp_start_cli = get_file_data(_VPP_EXEC_FILE)
for cli_line in cli_list:
if not'^\s*%s\s*$' % cli_line,
vpp_start_cli, re.MULTILINE):
vpp_start_cli += cli_line + '\n'
if diff(_VPP_EXEC_FILE, vpp_start_cli):
write_config(_VPP_EXEC_FILE, vpp_start_cli)
# Enable VPP service to make the VPP interface configuration
# persistent.
processutils.execute('systemctl', 'enable', 'vpp')
def is_ovs_installed():
"""Check if OpenVswitch is installed
Verify that OpenVswitch is installed by checking if
ovs-appctl is on the system. If OVS is not installed
it will limit os-net-config's ability to set up ovs-bonds,
ovs-bridges etc.
return os.path.exists("/usr/bin/ovs-appctl")
def iproute2_path():
"""Find 'ip' executable."""
if os.access('/sbin/ip', os.X_OK):
ipcmd = '/sbin/ip'
elif os.access('/usr/sbin/ip', os.X_OK):
ipcmd = '/usr/sbin/ip'
logger.warning("Could not execute /sbin/ip or /usr/sbin/ip")
return False
return ipcmd