#!/usr/bin/env python3
#
# Copyright (C) 2023 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
from pathlib import Path
from re import search as re_search, MULTILINE as re_M
from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.configdict import node_changed
from vyos.ifconfig import Section
from vyos.ifconfig import EthernetIf
from vyos.ifconfig import interface
from vyos.util import call
from vyos.util import rc_cmd
from vyos.template import render
from vyos.xml import defaults
from vyos import ConfigError
from vyos import airbag
from vyos.vpp import VPPControl
from vyos.vpp import HostControl
airbag.enable()
service_name = 'vpp'
service_conf = Path(f'/run/vpp/{service_name}.conf')
systemd_override = '/run/systemd/system/vpp.service.d/10-override.conf'
def _get_pci_address_by_interface(iface) -> str:
from vyos.util import rc_cmd
rc, out = rc_cmd(f'ethtool -i {iface}')
# if ethtool command was successful
if rc == 0 and out:
regex_filter = r'^bus-info: (?P
\w+:\w+:\w+\.\w+)$'
re_obj = re_search(regex_filter, out, re_M)
# if bus-info with PCI address found
if re_obj:
address = re_obj.groupdict().get('address', '')
return address
# use VPP - maybe interface already attached to it
vpp_control = VPPControl()
pci_addr = vpp_control.get_pci_addr(iface)
if pci_addr:
return pci_addr
# return empty string if address was not found
return ''
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
base = ['vpp']
base_ethernet = ['interfaces', 'ethernet']
# find interfaces removed from VPP
removed_ifaces = []
tmp = node_changed(conf, base + ['interface'])
if tmp:
for removed_iface in tmp:
pci_address: str = _get_pci_address_by_interface(removed_iface)
removed_ifaces.append({
'iface_name': removed_iface,
'iface_pci_addr': pci_address
})
if not conf.exists(base):
return {'removed_ifaces': removed_ifaces}
config = conf.get_config_dict(base,
get_first_key=True,
key_mangling=('-', '_'),
no_tag_node_value_mangle=True)
# We have gathered the dict representation of the CLI, but there are default
# options which we need to update into the dictionary retrived.
default_values = defaults(base)
if 'interface' in default_values:
del default_values['interface']
config = dict_merge(default_values, config)
if 'interface' in config:
for iface, iface_config in config['interface'].items():
default_values_iface = defaults(base + ['interface'])
config['interface'][iface] = dict_merge(default_values_iface, config['interface'][iface])
# Get PCI address auto
for iface, iface_config in config['interface'].items():
if iface_config['pci'] == 'auto':
config['interface'][iface]['pci'] = _get_pci_address_by_interface(iface)
config['other_interfaces'] = conf.get_config_dict(base_ethernet, key_mangling=('-', '_'),
get_first_key=True, no_tag_node_value_mangle=True)
if removed_ifaces:
config['removed_ifaces'] = removed_ifaces
return config
def verify(config):
# bail out early - looks like removal from running config
if not config or (len(config) == 1 and 'removed_ifaces' in config):
return None
if 'interface' not in config:
raise ConfigError(f'"interface" is required but not set!')
if 'cpu' in config:
if 'corelist_workers' in config['cpu'] and 'main_core' not in config['cpu']:
raise ConfigError(f'"cpu main-core" is required but not set!')
def generate(config):
if not config or (len(config) == 1 and 'removed_ifaces' in config):
# Remove old config and return
service_conf.unlink(missing_ok=True)
return None
render(service_conf, 'vpp/startup.conf.j2', config)
render(systemd_override, 'vpp/override.conf.j2', config)
return None
def apply(config):
if not config or (len(config) == 1 and 'removed_ifaces' in config):
call(f'systemctl stop {service_name}.service')
else:
call('systemctl daemon-reload')
call(f'systemctl restart {service_name}.service')
for iface in config.get('removed_ifaces', []):
HostControl().pci_rescan(iface['iface_pci_addr'])
if 'interface' in config:
# connect to VPP
# must be performed multiple attempts because API is not available
# immediately after the service restart
vpp_control = VPPControl(attempts=20, interval=500)
for iface, _ in config['interface'].items():
# Create lcp
if iface not in Section.interfaces():
vpp_control.lcp_pair_add(iface, iface)
# update interface config
#e = EthernetIf(iface)
#e.update(config['other_interfaces'][iface])
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)