diff options
author | zsdc <taras@vyos.io> | 2023-06-27 18:00:02 +0300 |
---|---|---|
committer | zsdc <taras@vyos.io> | 2023-06-27 18:36:11 +0300 |
commit | e30c7fe6a42cd76427432b70a5b629c32be22c47 (patch) | |
tree | b7af4c21d570651db6881014bf41c8dea3c02412 /python | |
parent | 8f402c2ba47ed3ccbf94f9f037ec6e18d6b975ea (diff) | |
download | vyos-1x-e30c7fe6a42cd76427432b70a5b629c32be22c47.tar.gz vyos-1x-e30c7fe6a42cd76427432b70a5b629c32be22c47.zip |
VPP: T1797: Replaced CLI with API
Replaced CLI commands with API calls.
CLI commands still can be used via:
```
vpp_control = VPPControl()
vpp_control.cli_cmd('command_here')
```
Diffstat (limited to 'python')
-rw-r--r-- | python/vyos/vpp.py | 102 |
1 files changed, 94 insertions, 8 deletions
diff --git a/python/vyos/vpp.py b/python/vyos/vpp.py index decc6c087..9e9471879 100644 --- a/python/vyos/vpp.py +++ b/python/vyos/vpp.py @@ -13,16 +13,102 @@ # You should have received a copy of the GNU Lesser General Public # License along with this library. If not, see <http://www.gnu.org/licenses/>. -from vyos.util import call +from vpp_papi import VPPApiClient -def lcp_create_host_interface(ifname): - """LCP reprepsents a connection point between VPP dataplane - and the host stack +class VPPControl: + """Control VPP network stack """ - return call(f'vppctl lcp create {ifname} host-if {ifname}') + def __init__(self) -> None: + """Create VPP API connection + """ + self.vpp_api_client = VPPApiClient() + self.vpp_api_client.connect('vpp-vyos') -def set_interface_rx_mode(ifname, mode): - """Rx mode""" - return call(f'sudo vppctl set interface rx-mode {ifname} {mode}') + def __del__(self) -> None: + """Disconnect from VPP API + """ + self.vpp_api_client.disconnect() + + def cli_cmd(self, command: str) -> None: + """Send raw CLI command + + Args: + command (str): command to send + """ + self.vpp_api_client.api.cli_inband(cmd=command) + + def get_mac(self, ifname: str) -> str: + """Find MAC address by interface name in VPP + + Args: + ifname (str): interface name inside VPP + + Returns: + str: MAC address + """ + for iface in self.vpp_api_client.api.sw_interface_dump(): + if iface.interface_name == ifname: + return iface.l2_address.mac_string + return '' + + def get_sw_if_index(self, ifname: str) -> int | None: + """Find interface index by interface name in VPP + + Args: + ifname (str): interface name inside VPP + + Returns: + int | None: Interface index or None (if was not fount) + """ + for iface in self.vpp_api_client.api.sw_interface_dump(): + if iface.interface_name == ifname: + return iface.sw_if_index + return None + + def lcp_pair_add(self, iface_name_vpp: str, iface_name_kernel: str) -> None: + """Create LCP interface pair between VPP and kernel + + Args: + iface_name_vpp (str): interface name in VPP + iface_name_kernel (str): interface name in kernel + """ + iface_index = self.get_sw_if_index(iface_name_vpp) + if iface_index: + self.vpp_api_client.api.lcp_itf_pair_add_del( + is_add=True, + sw_if_index=iface_index, + host_if_name=iface_name_kernel) + + def lcp_pair_del(self, iface_name_vpp: str, iface_name_kernel: str) -> None: + """Delete LCP interface pair between VPP and kernel + + Args: + iface_name_vpp (str): interface name in VPP + iface_name_kernel (str): interface name in kernel + """ + iface_index = self.get_sw_if_index(iface_name_vpp) + if iface_index: + self.vpp_api_client.api.lcp_itf_pair_add_del( + is_add=False, + sw_if_index=iface_index, + host_if_name=iface_name_kernel) + + def iface_rxmode(self, iface_name: str, rx_mode: str) -> None: + """Set interface rx-mode in VPP + + Args: + iface_name (str): interface name in VPP + rx_mode (str): mode (polling, interrupt, adaptive) + """ + modes_dict: dict[str, int] = { + 'polling': 1, + 'interrupt': 2, + 'adaptive': 3 + } + if rx_mode not in modes_dict: + return + iface_index = self.get_sw_if_index(iface_name) + self.vpp_api_client.api.sw_interface_set_rx_mode( + sw_if_index=iface_index, mode=modes_dict[rx_mode]) |