summaryrefslogtreecommitdiff
path: root/src/conf_mode/vpp_interfaces_bonding.py
blob: 7ab1abb240b9c59dbdcd77a163c98792079476a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
#!/usr/bin/env python3
#
# Copyright (C) 2023-2025 VyOS Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

import os

from vyos.config import Config
from vyos.configdict import leaf_node_changed
from vyos.configdep import set_dependents, call_dependents
from vyos import ConfigError

from vyos.vpp.interface import BondInterface
from vyos.vpp.config_deps import deps_xconnect_dict
from vyos.vpp.config_verify import (
    verify_vpp_remove_xconnect_interface,
    verify_vpp_remove_kernel_interface,
    verify_vpp_change_kernel_interface,
    verify_vpp_exists_kernel_interface,
)
from vyos.vpp.utils import cli_ifaces_list, cli_ifaces_lcp_kernel_list


def _get_bond_mode(mode_name: str) -> int:
    """Convert VyOS CLI name bonding mode to VPP compatible"""
    mode_mapping = {
        'round-robin': 1,
        'active-backup': 2,
        'xor-hash': 3,
        'broadcast': 4,
        '802.3ad': 5,
    }

    return mode_mapping.get(mode_name, 5)


def _get_bond_lb(lb_name: str) -> int:
    """Convert VyOS CLI name bonding load balance to VPP compatible"""
    lb_mapping = {
        'layer2': 0,
        'layer2+3': 2,
        'layer3+4': 1,
    }

    return lb_mapping.get(lb_name, 5)


def get_config(config=None) -> dict:
    """Get Bonding interface configuration

    Args:
        config (vyos.config.Config, optional): The VyOS configuration dictionary
    Returns:
        dict: Bonding interface configuration
    """
    if config:
        conf = config
    else:
        conf = Config()

    base = ['vpp', 'interfaces', 'bonding']
    base_kernel_interfaces = ['vpp', 'kernel-interfaces']

    ifname = os.environ['VYOS_TAGNODE_VALUE']

    # Get config_dict with default values
    config = conf.get_config_dict(
        base + [ifname],
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
        with_defaults=True,
        with_recursive_defaults=True,
    )

    # Get effective config as we need full dicitonary per interface delete
    effective_config = conf.get_config_dict(
        base + [ifname],
        key_mangling=('-', '_'),
        effective=True,
        get_first_key=True,
        no_tag_node_value_mangle=True,
    )

    if effective_config:
        config.update({'effective': effective_config})

    if not conf.exists(base + [ifname]):
        config['remove'] = True

    if effective_config:
        config.update({'effective': effective_config})

    config['vpp_ifaces'] = cli_ifaces_list(conf, 'candidate')

    # Get global 'vpp kernel-interfaces' for verify
    config['vpp_kernel_interfaces'] = conf.get_config_dict(
        base_kernel_interfaces,
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
    )

    # list of all kernel interfaces `vpp interface xxx kernel-interface xxx`
    config['candidate_kernel_interfaces'] = cli_ifaces_lcp_kernel_list(conf)

    # convert values to VPP compatible
    if 'mode' in config:
        config['mode'] = _get_bond_mode(config['mode'])
    if 'hash_policy' in config:
        config['hash_policy'] = _get_bond_lb(config['hash_policy'])

    tmp = leaf_node_changed(conf, base + [ifname, 'kernel-interface'])
    if tmp:
        config['kernel_interface_removed'] = tmp

    # Dependency
    config['xconn_members'] = deps_xconnect_dict(conf)
    if ifname in config['xconn_members']:
        for xconn_iface in config['xconn_members'][ifname]:
            set_dependents('vpp_interfaces_xconnect', conf, xconn_iface)

    if conf.exists(base + [ifname, 'kernel-interface']):
        if effective_config.get('kernel_interface') or __name__ != '__main__':
            iface = config.get('kernel_interface')
            if conf.exists(['vpp', 'kernel-interfaces', iface]):
                set_dependents('vpp_kernel_interface', conf, iface)

    config['ifname'] = ifname

    return config


def verify(config):
    verify_vpp_remove_kernel_interface(config)
    verify_vpp_remove_xconnect_interface(config)

    # Member must belong to VPP
    for iface in config.get('member', {}).get('interface', []):
        if iface not in config['vpp_ifaces']:
            raise ConfigError(f'{iface} must be a VPP interface for bonding')

    if 'remove' in config:
        return None

    verify_vpp_change_kernel_interface(config)
    verify_vpp_exists_kernel_interface(config)


def generate(config):
    pass


def apply(config):
    ifname = config.get('ifname')
    # remove old members
    if 'effective' in config:
        members = config['effective'].get('member', {}).get('interface', [])

        kernel_interface = config['effective'].get('kernel_interface', '')
        i = BondInterface(ifname, kernel_interface=kernel_interface)
        for member in members:
            i.detach_member(interface=member)

        if 'kernel_interface' in config['effective']:
            i.kernel_delete()
        # Delete bonding interface
        i.delete()

    if 'remove' in config:
        return None

    # Create a new one
    mode = config.get('mode')
    lb = config.get('hash_policy')
    members = config.get('member', {}).get('interface', [])
    mac = config.get('mac', '')
    kernel_interface = config.get('kernel_interface', '')
    state = 'up' if 'disable' not in config else 'down'

    i = BondInterface(ifname, mode, lb, mac, kernel_interface, state)
    i.add()
    # Add members to bond
    if members:
        for member in members:
            i.add_member(interface=member)

    call_dependents()

    return None


if __name__ == '__main__':
    try:
        c = get_config()
        verify(c)
        generate(c)
        apply(c)
    except ConfigError as e:
        print(e)
        exit(1)