summaryrefslogtreecommitdiff
path: root/src/conf_mode/vpp_interfaces_bridge.py
blob: dd5b49599f922165a04a5f91e0b602a510ff85df (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
#!/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 node_changed
from vyos import ConfigError
from vyos.vpp.interface import BridgeInterface
from vyos.vpp.utils import iftunnel_transform


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

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

    base = ['vpp', 'interfaces', 'bridge']
    vpp_interfaces = ['vpp', 'settings', 'interface']

    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

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

    # determine which members have been removed
    interfaces_removed = node_changed(conf, base + [ifname, 'member', 'interface'])
    if interfaces_removed:
        config['members_removed'] = interfaces_removed

    config['ifname'] = ifname

    return config


def verify(config):
    if 'remove' in config:
        return None

    # Check if interface exists in vpp before adding to bridge-domain

    allowed_prefixes = ('bond', 'gre', 'geneve', 'lo', 'vxlan')

    if 'member' in config:
        bvi_exists = False
        for member, member_config in (
            config.get('member', {}).get('interface', {}).items()
        ):
            # Check if the interface exists in VPP settings or starts with allowed prefixes
            if not (
                member in config.get('vpp_interfaces', {})
                or member.startswith(allowed_prefixes)
            ):
                raise ConfigError(
                    f"Interface '{member}' not found in 'vpp settings interface' or does not start with allowed prefixes {allowed_prefixes}"
                )

            # Check if BVI is already defined, only one BVI per bridge domain is allowed
            if 'bvi' in member_config:
                if bvi_exists:
                    raise ConfigError("Only one BVI per bridge domain is allowed")
                if not member.startswith('lo'):
                    raise ConfigError("BVI can only be defined on loopback interface")
                bvi_exists = True


def generate(config):
    pass


def apply(config):
    ifname = config.get('ifname')
    # vxlan10 in the vpp is vxlan_tunnel10
    interface_transform_filter = ('geneve', 'vxlan')
    # update members
    if 'members_removed' in config:
        i = BridgeInterface(ifname)
        for member in config.get('members_removed'):
            if member.startswith(interface_transform_filter):
                member = iftunnel_transform(member)
            if member.startswith('lo'):
                # interface name in VPP is loopX
                member = member.replace('lo', 'loop')
            elif member.startswith('bond'):
                # interface name in VPP is BondEthernetX
                member = member.replace('bond', 'BondEthernet')
            i.detach_member(member=member)

    # Delete bridge domain
    if 'effective' in config:
        ifname = config.get('ifname')
        i = BridgeInterface(ifname)
        i.delete()

    if 'remove' in config:
        return None

    # Add bridge domain
    members = config.get('member', {}).get('interface', '')
    i = BridgeInterface(ifname)
    i.add()
    # Add members to bridge
    if members:
        br = BridgeInterface(ifname)
        port_type = 0
        for member, member_config in members.items():
            if member.startswith(interface_transform_filter):
                member = iftunnel_transform(member)
            if member.startswith('lo'):
                # interface name in VPP is loopX
                member = member.replace('lo', 'loop')
                if 'bvi' in member_config:
                    port_type = 1
            elif member.startswith('bond'):
                # interface name in VPP is BondEthernetX
                member = member.replace('bond', 'BondEthernet')

            br.add_member(member=member, port_type=port_type)
            # set default port type 0 (not BVI)
            port_type = 0

    return None


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