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
|
# Copyright 2020 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# 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/>.
import re
import netifaces
class Section:
# the known interface prefixes
_prefixes = {}
_classes = []
# class need to define: definition['prefixes']
# the interface prefixes declared by a class used to name interface with
# prefix[0-9]*(\.[0-9]+)?(\.[0-9]+)?, such as lo, eth0 or eth0.1.2
@classmethod
def register(cls, klass):
"""
A function to use as decorator the interfaces classes
It register the prefix for the interface (eth, dum, vxlan, ...)
with the class which can handle it (EthernetIf, DummyIf,VXLANIf, ...)
"""
if not klass.definition.get('prefixes',[]):
raise RuntimeError(f'valid interface prefixes not defined for {klass.__name__}')
cls._classes.append(klass)
for ifprefix in klass.definition['prefixes']:
if ifprefix in cls._prefixes:
raise RuntimeError(f'only one class can be registered for prefix "{ifprefix}" type')
cls._prefixes[ifprefix] = klass
return klass
@classmethod
def _basename (cls, name, vlan):
"""
remove the number at the end of interface name
name: name of the interface
vlan: if vlan is True, do not stop at the vlan number
"""
name = name.rstrip('0123456789')
name = name.rstrip('.')
if vlan:
name = name.rstrip('0123456789.')
return name
@classmethod
def section(cls, name, vlan=True):
"""
return the name of a section an interface should be under
name: name of the interface (eth0, dum1, ...)
vlan: should we try try to remove the VLAN from the number
"""
name = cls._basename(name, vlan)
if name in cls._prefixes:
return cls._prefixes[name].definition['section']
return ''
@classmethod
def sections(cls):
"""
return all the sections we found under 'set interfaces'
"""
return list(set([cls._prefixes[_].definition['section'] for _ in cls._prefixes]))
@classmethod
def klass(cls, name, vlan=True):
name = cls._basename(name, vlan)
if name in cls._prefixes:
return cls._prefixes[name]
raise ValueError(f'No type found for interface name: {name}')
@classmethod
def _intf_under_section (cls,section=''):
"""
return a generator with the name of the configured interface
which are under a section
"""
interfaces = netifaces.interfaces()
for ifname in interfaces:
ifsection = cls.section(ifname)
if not ifsection:
continue
if section and ifsection != section:
continue
yield ifname
@classmethod
def _sort_interfaces(cls, generator):
"""
return a list of the sorted interface by number, vlan, qinq
"""
def key(ifname):
value = 0
parts = re.split(r'([^0-9]+)([0-9]+)[.]?([0-9]+)?[.]?([0-9]+)?', ifname)
length = len(parts)
name = parts[1] if length >= 3 else parts[0]
# the +1 makes sure eth0.0.0 after eth0.0
number = int(parts[2]) + 1 if length >= 4 and parts[2] is not None else 0
vlan = int(parts[3]) + 1 if length >= 5 and parts[3] is not None else 0
qinq = int(parts[4]) + 1 if length >= 6 and parts[4] is not None else 0
# so that "lo" (or short names) are handled (as "loa")
for n in (name + 'aaa')[:3]:
value *= 100
value += (ord(n) - ord('a'))
value += number
# vlan are 16 bits, so this can not overflow
value = (value << 16) + vlan
value = (value << 16) + qinq
return value
l = list(generator)
l.sort(key=key)
return l
@classmethod
def interfaces(cls, section=''):
"""
return a list of the name of the configured interface which are under a section
if no section is provided, then it returns all configured interfaces
"""
return cls._sort_interfaces(cls._intf_under_section(section))
@classmethod
def _intf_with_feature(cls, feature=''):
"""
return a generator with the name of the configured interface which have
a particular feature set in their definition such as:
bondable, broadcast, bridgeable, ...
"""
for klass in cls._classes:
if klass.definition[feature]:
yield klass.definition['section']
@classmethod
def feature(cls, feature=''):
"""
return list with the name of the configured interface which have
a particular feature set in their definition such as:
bondable, broadcast, bridgeable, ...
"""
return list(cls._intf_with_feature(feature))
@classmethod
def reserved(cls):
"""
return list with the interface name prefixes
eth, lo, vxlan, dum, ...
"""
return list(cls._prefixes.keys())
@classmethod
def get_config_path(cls, name):
"""
get config path to interface with .vif or .vif-s.vif-c
example: eth0.1.2 -> 'ethernet eth0 vif-s 1 vif-c 2'
Returns False if interface name is invalid (not found in sections)
"""
sect = cls.section(name)
if sect:
splinterface = name.split('.')
intfpath = f'{sect} {splinterface[0]}'
if len(splinterface) == 2:
intfpath += f' vif {splinterface[1]}'
elif len(splinterface) == 3:
intfpath += f' vif-s {splinterface[1]} vif-c {splinterface[2]}'
return intfpath
else:
return False
|
