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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
# Copyright (C) 2017 Nippon Telegraph and Telephone Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from sqlalchemy import Column
from sqlalchemy import Integer
from sqlalchemy import String
from os_ken.lib import netdevice
from os_ken.lib import ip
from os_ken.lib.packet import zebra
from . import base
LOG = logging.getLogger(__name__)
# Default value for ethernet interface
DEFAULT_ETH_FLAGS = (
netdevice.IFF_UP
| netdevice.IFF_BROADCAST
| netdevice.IFF_RUNNING
| netdevice.IFF_MULTICAST)
DEFAULT_ETH_MTU = 1500
class Interface(base.Base):
"""
Interface table for Zebra protocol service.
The default value for each fields suppose "Loopback" interface.
``ifindex``: Number of index.
``ifname``: Name of this interface.
``status``: A combination of flags
"os_ken.lib.packet.zebra.ZEBRA_INTERFACE_*".
The default value shows "active" and "link-detect".
``flags``: A combination of flags "os_ken.lib.netdevice.IFF_*".
The default value show "up", "loopback" and "running".
``metric``: Metric of this interface.
``ifmtu``: IPv4 MTU of this interface.
``ifmtu6``: IPv6 MTU of this interface.
``bandwidth``: Bandwidth of this interface.
``ll_type``: Link Layer Type.
One of "os_ken.lib.packet.zebra.ZEBRA_LLT_*" types.
``hw_addr``: Hardware address of this interface (mostly, MAC address).
``inet``: List of IPv4 addresses separated by a comma.
(e.g., "192.168.1.100/24,192.168.2.100/24)".
``inet6``: List of IPv6 addresses separated by a comma.
"""
__tablename__ = 'interface'
ifindex = Column(Integer, primary_key=True)
ifname = Column(String, default="lo")
status = Column(
Integer,
default=(
zebra.ZEBRA_INTERFACE_ACTIVE
| zebra.ZEBRA_INTERFACE_LINKDETECTION))
flags = Column(
Integer,
default=(
netdevice.IFF_UP
| netdevice.IFF_LOOPBACK
| netdevice.IFF_RUNNING))
metric = Column(Integer, default=1)
ifmtu = Column(Integer, default=0x10000)
ifmtu6 = Column(Integer, default=0x10000)
bandwidth = Column(Integer, default=0)
ll_type = Column(Integer, default=zebra.ZEBRA_LLT_ETHER)
hw_addr = Column(String, default='00:00:00:00:00:00')
# Note: Only the PostgreSQL backend has support sqlalchemy.ARRAY,
# we use the comma separated string as array instead.
inet = Column(String, default='')
inet6 = Column(String, default='')
@base.sql_function
def ip_link_show(session, **kwargs):
"""
Returns a first interface record matching the given filtering rules.
The arguments for "kwargs" is the same with Interface class.
:param session: Session instance connecting to database.
:param kwargs: Filtering rules to query.
:return: An instance of Interface record.
"""
return session.query(Interface).filter_by(**kwargs).first()
@base.sql_function
def ip_link_show_all(session, **kwargs):
"""
Returns all interface records matching the given filtering rules.
The arguments for "kwargs" is the same with Interface class.
:param session: Session instance connecting to database.
:param kwargs: Filtering rules to query.
:return: A list of Interface records.
"""
return session.query(Interface).filter_by(**kwargs).all()
@base.sql_function
def ip_link_add(session, name, type_='loopback', lladdr='00:00:00:00:00:00'):
"""
Adds an interface record into Zebra protocol service database.
The arguments are similar to "ip link add" command of iproute2.
:param session: Session instance connecting to database.
:param name: Name of interface.
:param type_: Type of interface. 'loopback' or 'ethernet'.
:param lladdr: Link layer address. Mostly MAC address.
:return: Instance of added record or already existing record.
"""
intf = ip_link_show(session, ifname=name)
if intf:
LOG.debug('Interface "%s" already exists: %s', intf.ifname, intf)
return intf
if type_ == 'ethernet':
intf = Interface(
ifname=name,
flags=DEFAULT_ETH_FLAGS,
ifmtu=DEFAULT_ETH_MTU,
ifmtu6=DEFAULT_ETH_MTU,
hw_addr=lladdr)
else: # type_ == 'loopback':
intf = Interface(
ifname=name,
inet='127.0.0.1/8',
inet6='::1/128')
session.add(intf)
return intf
@base.sql_function
def ip_link_delete(session, name):
"""
Deletes an interface record from Zebra protocol service database.
The arguments are similar to "ip link delete" command of iproute2.
:param session: Session instance connecting to database.
:param name: Name of interface.
:return: Name of interface which was deleted. None if failed.
"""
intf = ip_link_show(session, ifname=name)
if not intf:
LOG.debug('Interface "%s" does not exist', name)
return None
session.delete(intf)
return name
# Currently, functions corresponding to "ip link show" and "ip address show"
# have the same implementation.
ip_address_show = ip_link_show
ip_address_show_all = ip_link_show_all
@base.sql_function
def ip_address_add(session, ifname, ifaddr):
"""
Adds an IP address to interface record identified with the given "ifname".
The arguments are similar to "ip address add" command of iproute2.
:param session: Session instance connecting to database.
:param ifname: Name of interface.
:param ifaddr: IPv4 or IPv6 address.
:return: Instance of record or "None" if failed.
"""
def _append_inet_addr(intf_inet, addr):
addr_list = intf_inet.split(',')
if addr in addr_list:
LOG.debug(
'Interface "%s" has already "ifaddr": %s',
intf.ifname, addr)
return intf_inet
else:
addr_list.append(addr)
return ','.join(addr_list)
intf = ip_link_show(session, ifname=ifname)
if not intf:
LOG.debug('Interface "%s" does not exist', ifname)
return None
if ip.valid_ipv4(ifaddr):
intf.inet = _append_inet_addr(intf.inet, ifaddr)
elif ip.valid_ipv6(ifaddr):
intf.inet6 = _append_inet_addr(intf.inet6, ifaddr)
else:
LOG.debug('Invalid IP address for "ifaddr": %s', ifaddr)
return None
return intf
@base.sql_function
def ip_address_delete(session, ifname, ifaddr):
"""
Deletes an IP address from interface record identified with the given
"ifname".
The arguments are similar to "ip address delete" command of iproute2.
:param session: Session instance connecting to database.
:param ifname: Name of interface.
:param ifaddr: IPv4 or IPv6 address.
:return: Instance of record or "None" if failed.
"""
def _remove_inet_addr(intf_inet, addr):
addr_list = intf_inet.split(',')
if addr not in addr_list:
LOG.debug(
'Interface "%s" does not have "ifaddr": %s',
intf.ifname, addr)
return intf_inet
else:
addr_list.remove(addr)
return ','.join(addr_list)
intf = ip_link_show(session, ifname=ifname)
if not intf:
LOG.debug('Interface "%s" does not exist', ifname)
return None
if ip.valid_ipv4(ifaddr):
intf.inet = _remove_inet_addr(intf.inet, ifaddr)
elif ip.valid_ipv6(ifaddr):
intf.inet6 = _remove_inet_addr(intf.inet6, ifaddr)
else:
LOG.debug('Invalid IP address for "ifaddr": %s', ifaddr)
return None
return intf
|
