-
Notifications
You must be signed in to change notification settings - Fork 2
/
valve.py
510 lines (428 loc) · 20.4 KB
/
valve.py
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# Copyright (C) 2013 Nippon Telegraph and Telephone Corporation.
# Copyright (C) 2015 Brad Cowie, Christopher Lorier and Joe Stringer.
#
# 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 sys, struct, yaml, copy, logging, socket, os, signal
import util
from acl import ACL
from dp import DP
from port import Port
from ryu.base import app_manager
from ryu.controller import ofp_event
from ryu.controller import dpset
from ryu.controller.handler import MAIN_DISPATCHER
from ryu.controller.handler import set_ev_cls
from ryu.ofproto import ofproto_v1_3, ether
from ryu.lib import ofctl_v1_3
from ryu.lib.packet import packet
from ryu.lib.packet import ethernet
from ryu.lib.packet import vlan
from ryu.lib.dpid import str_to_dpid
from ryu.lib import hub
from operator import attrgetter
class Valve(app_manager.RyuApp):
OFP_VERSIONS = [ofproto_v1_3.OFP_VERSION]
_CONTEXTS = {'dpset': dpset.DPSet}
def __init__(self, *args, **kwargs):
super(Valve, self).__init__(*args, **kwargs)
# Setup logging
self.logger_handler = logging.StreamHandler()
log_fmt = '%(asctime)s %(name)-6s %(levelname)-8s %(message)s'
self.default_formatter = logging.Formatter(log_fmt, '%b %d %H:%M:%S')
self.set_default_log_formatter()
self.logger.addHandler(self.logger_handler)
self.logger.propagate = 0
# Set the signal handler for reloading config file
signal.signal(signal.SIGHUP, self.signal_handler)
# Create dpset object for querying Ryu's DPSet application
self.dpset = kwargs['dpset']
# Initialise datastructures to store state
self.mac_to_port = {}
self.dps = {}
# Parse config file
self.parse_config()
# Start a thread for stats gathering
if self.conf['default']['stats_enable']:
self.stats_event = hub.Event()
self.threads.append(hub.spawn(self.stats_loop))
def signal_handler(self, sigid, frame):
if sigid == signal.SIGHUP:
self.logger.info("Caught SIGHUP, reloading configuration")
# Take a copy of old datapaths
olddps = self.dps
# Reinitialise datastructures
self.mac_to_port = {}
self.dps = {}
self.parse_config()
for dpid, dp in self.dps.items():
if dpid in olddps:
# If we're reconfiguring a pre-existing dp then copy over
# some useful attributes
dp.running = olddps[dpid].running
del olddps[dpid]
ryudp = self.dpset.get(dpid)
if ryudp:
self.logger.info("Trigger reconfiguration of %s", dp)
ev = dpset.EventDP(ryudp, True)
self.handler_datapath(ev)
for dpid, dp in olddps.items():
# Remove our configuration from the datapath that has
# been removed from the configuration
ryudp = self.dpset.get(dpid)
if ryudp:
self.logger.info("Removing configuration from %s", dp)
self.clear_flows(ryudp, dp.config_default['cookie'])
del olddps[dpid]
def parse_config(self):
with open('valve.yaml', 'r') as stream:
self.conf = yaml.load(stream)
# Set defaults
self.conf.setdefault('default', {})
defaults = self.conf['default']
defaults.setdefault('learning', True) # Shall we learn MACs?
defaults.setdefault('table_miss', True) # Shall we install a table-miss rule?
defaults.setdefault('smart_broadcast', True) # Shall we install a broadcast/multicast rules?
defaults.setdefault('lowest_priority', 0) # Table-miss priority
defaults.setdefault('priority_offset', 0) # How much to offset default priority by
defaults.setdefault('low_priority', defaults['priority_offset'] + 9000)
defaults.setdefault('high_priority', defaults['low_priority'] + 1)
defaults.setdefault('highest_priority', defaults['high_priority'] + 98)
defaults.setdefault('cookie', 3134985664) # Identification cookie value
defaults.setdefault('stats_enable', False) # Shall we enable stats?
defaults.setdefault('stats_interval', 30) # Stats reporting interval
# Convert all acls to ACL objects
self.fix_acls(self.conf)
for dpid, dpconfig in self.conf.items():
if dpid in ('all', 'default', 'acls'):
continue
conf_all = [ copy.deepcopy(self.conf['all']) ] if 'all' in self.conf else [{}]
conf_def = copy.deepcopy(self.conf['default']) if 'default' in self.conf else {}
conf_acls = copy.deepcopy(self.conf['acls']) if 'acls' in self.conf else {}
# Merge dpconfig['all'] into conf_all
if 'all' in dpconfig:
conf_all.append(dpconfig['all'])
del dpconfig['all']
# Merge dpconfig['default'] into conf_def
if 'default' in dpconfig:
for key, value in dpconfig['default'].items():
conf_def[key] = value
if key == 'priority_offset':
# apply priority offset
conf_def['low_priority'] = value + 9000
conf_def['high_priority'] = conf_def['low_priority'] + 1
conf_def['highest_priority'] = conf_def['high_priority'] + 98
del dpconfig['default']
# Merge dpconfig['acls'] into conf_acls
if 'acls' in dpconfig:
for ip, acls in dpconfig['acls'].items():
conf_acls.setdefault(ip, [])
conf_acls[ip].extend(x for x in acls if x not in conf_acls[ip])
del dpconfig['acls']
# Add datapath
newdp = DP(dpid, dpconfig, conf_all, conf_def, conf_acls)
self.dps[dpid] = newdp
def fix_acls(self, conf):
# Recursively walk config replacing all acls with ACL objects
for k, v in conf.items():
if k == 'acls':
if isinstance(v, dict):
for ip, acls in v.items():
conf[k][ip] = [ACL(x['match'], x['action']) for x in acls]
else:
conf[k] = [ACL(x['match'], x['action']) for x in v]
elif isinstance(v, dict):
self.fix_acls(v)
def set_default_log_formatter(self):
self.logger_handler.setFormatter(self.default_formatter)
def set_dpid_log_formatter(self, dpid):
dp_str = 'dpid:%-16x' % dpid
log_fmt = '%(asctime)s %(name)-6s %(levelname)-8s '+dp_str+' %(message)s'
formatter = logging.Formatter(log_fmt, '%b %d %H:%M:%S')
self.logger_handler.setFormatter(formatter)
def clear_flows(self, datapath, cookie):
ofproto = datapath.ofproto
parser = datapath.ofproto_parser
match = parser.OFPMatch()
mod = parser.OFPFlowMod(
datapath=datapath, cookie=cookie, cookie_mask=0xFFFFFFFFFFFFFFFF,
command=ofproto.OFPFC_DELETE, out_port=ofproto.OFPP_ANY,
out_group=ofproto.OFPG_ANY, match=match, instructions=[])
datapath.send_msg(mod)
def add_flow(self, datapath, match, actions, priority, cookie):
ofproto = datapath.ofproto
parser = datapath.ofproto_parser
inst = [parser.OFPInstructionActions(ofproto.OFPIT_APPLY_ACTIONS,
actions)]
mod = parser.OFPFlowMod(
datapath=datapath, cookie=cookie, priority=priority,
command=ofproto.OFPFC_ADD, match=match, instructions=inst)
datapath.send_msg(mod)
def tagged_output_action(self, parser, tagged_ports):
act = []
for port in tagged_ports:
act.append(parser.OFPActionOutput(port.number))
return act
def untagged_output_action(self, parser, untagged_ports):
act = []
for port in untagged_ports:
act.append(parser.OFPActionOutput(port.number))
return act
def send_port_stats_request(self, dp):
ofp = dp.ofproto
ofp_parser = dp.ofproto_parser
req = ofp_parser.OFPPortStatsRequest(dp, 0, ofp.OFPP_ANY)
dp.send_msg(req)
def stats_loop(self):
while self.is_active:
self.stats_event.clear()
for dpid, dp in self.dps.items():
if dp.running:
ryudp = self.dpset.get(dpid)
self.send_port_stats_request(ryudp)
self.stats_event.wait(timeout=self.conf['default']['stats_interval'])
@set_ev_cls(ofp_event.EventOFPPortStatsReply, MAIN_DISPATCHER)
def port_stats_reply_handler(self, ev):
body = ev.msg.body
self.logger.info('port '
'rx-pkts rx-bytes rx-error '
'tx-pkts tx-bytes tx-error')
self.logger.info('-------- '
'-------- -------- -------- '
'-------- -------- --------')
for stat in sorted(body, key=attrgetter('port_no')):
self.logger.info('%8x %8d %8d %8d %8d %8d %8d',
stat.port_no,
stat.rx_packets, stat.rx_bytes, stat.rx_errors,
stat.tx_packets, stat.tx_bytes, stat.tx_errors)
@set_ev_cls(ofp_event.EventOFPPacketIn, MAIN_DISPATCHER)
def _packet_in_handler(self, ev):
msg = ev.msg
dp = msg.datapath
ofproto = dp.ofproto
parser = dp.ofproto_parser
pkt = packet.Packet(msg.data)
ethernet_proto = pkt.get_protocols(ethernet.ethernet)[0]
src = ethernet_proto.src
dst = ethernet_proto.dst
eth_type = ethernet_proto.ethertype
in_port = msg.match['in_port']
self.mac_to_port.setdefault(dp.id, {})
# Configure logging to include datapath id
self.set_dpid_log_formatter(dp.id)
if dp.id not in self.dps:
self.logger.error("Packet_in on unknown datapath")
self.set_default_log_formatter()
return
else:
datapath = self.dps[dp.id]
if not datapath.running:
self.logger.error("Packet_in on unconfigured datapath")
if in_port not in datapath.ports:
self.set_default_log_formatter()
return
if eth_type == ether.ETH_TYPE_8021Q:
# tagged packet
vlan_proto = pkt.get_protocols(vlan.vlan)[0]
vid = vlan_proto.vid
if Port(in_port, 'tagged') not in datapath.vlans[vid].tagged:
self.logger.warn("HAXX:RZ in_port:%d isn't tagged on vid:%s" % \
(in_port, vid))
self.set_default_log_formatter()
return
else:
# untagged packet
vid = datapath.get_native_vlan(in_port).vid
if not vid:
self.logger.warn("Untagged packet_in on port:%d without native vlan" % \
(in_port))
self.set_default_log_formatter()
return
self.mac_to_port[dp.id].setdefault(vid, {})
self.logger.info("Packet_in src:%s dst:%s in_port:%d vid:%s",
src, dst, in_port, vid)
# learn a mac address to avoid FLOOD next time.
self.mac_to_port[dp.id][vid][src] = in_port
# generate the output actions for broadcast traffic
tagged_act = self.tagged_output_action(parser, datapath.vlans[vid].tagged)
untagged_act = self.untagged_output_action(parser, datapath.vlans[vid].untagged)
matches = []
action = []
if datapath.ports[in_port].is_tagged():
# send rule for matching packets arriving on tagged ports
strip_act = [parser.OFPActionPopVlan()]
if tagged_act:
action += tagged_act
if untagged_act:
action += strip_act + untagged_act
# match multicast/broadcast
matches.append(parser.OFPMatch(vlan_vid=vid|ofproto_v1_3.OFPVID_PRESENT,
in_port=in_port,
eth_src=src,
eth_dst=('01:00:00:00:00:00',
'01:00:00:00:00:00')))
elif datapath.ports[in_port].is_untagged():
# send rule for each untagged port
push_act = [
parser.OFPActionPushVlan(ether.ETH_TYPE_8021Q),
parser.OFPActionSetField(vlan_vid=vid|ofproto_v1_3.OFPVID_PRESENT)
]
if untagged_act:
action += untagged_act
if tagged_act:
action += push_act + tagged_act
# match multicast/broadcast
matches.append(parser.OFPMatch(in_port=in_port,
eth_src=src,
eth_dst=('01:00:00:00:00:00',
'01:00:00:00:00:00')))
# install broadcast/multicast rules onto datapath
if datapath.config_default['smart_broadcast']:
for match in matches:
priority = datapath.config_default['high_priority'] + 10
cookie = datapath.config_default['cookie']
self.add_flow(dp, match, action, priority, cookie)
# install unicast flows onto datapath
if dst in self.mac_to_port[dp.id][vid]:
# install a flow to avoid packet_in next time
out_port = self.mac_to_port[dp.id][vid][dst]
if out_port == in_port:
self.logger.info("in_port is the same as out_port, skipping unicast flow " \
"dl_dst:%s dl_src:%s vid:%d", dst, src, vid)
self.set_default_log_formatter()
return
self.logger.info("Adding unicast flow dl_dst:%s vid:%d", dst, vid)
actions = []
if datapath.ports[in_port].is_tagged():
match = parser.OFPMatch(
in_port=in_port,
eth_src=src,
eth_dst=dst,
vlan_vid=vid|ofproto_v1_3.OFPVID_PRESENT)
if datapath.ports[out_port].is_untagged():
actions.append(parser.OFPActionPopVlan())
if datapath.ports[in_port].is_untagged():
match = parser.OFPMatch(
in_port=in_port,
eth_src=src,
eth_dst=dst)
if datapath.ports[out_port].is_tagged():
actions.append(parser.OFPActionPushVlan())
actions.append(parser.OFPActionSetField(vlan_vid=vid|ofproto_v1_3.OFPVID_PRESENT))
actions.append(parser.OFPActionOutput(out_port))
priority = datapath.config_default['high_priority']
cookie = datapath.config_default['cookie']
self.add_flow(dp, match, actions, priority, cookie)
# Reset log formatter
self.set_default_log_formatter()
@set_ev_cls(dpset.EventDP, dpset.DPSET_EV_DISPATCHER)
def handler_datapath(self, ev):
dp = ev.dp
ofproto = dp.ofproto
parser = dp.ofproto_parser
# Configure logging to include datapath id
self.set_dpid_log_formatter(dp.id)
if not ev.enter:
# Datapath down message
self.logger.info("Datapath gone away")
self.set_default_log_formatter()
return
if dp.id not in self.dps:
self.logger.error("Unknown dpid:%s", dp.id)
self.set_default_log_formatter()
return
else:
datapath = self.dps[dp.id]
for k, port in dp.ports.items():
# These are special port numbers
if k > 0xF0000000:
continue
elif k not in datapath.ports:
# Autoconfigure port
self.logger.info("Autoconfiguring port:%s based on default config",
k)
datapath.add_port(k)
self.logger.info("Configuring datapath")
# clear flow table on datapath
self.clear_flows(dp, datapath.config_default['cookie'])
# add catchall drop rule to datapath
drop_act = []
if datapath.config_default['table_miss']:
match_all = parser.OFPMatch()
priority = datapath.config_default['lowest_priority']
cookie = datapath.config_default['cookie']
self.add_flow(dp, match_all, drop_act, priority, cookie)
for vid, v in datapath.vlans.items():
self.logger.info("Configuring %s", v)
if datapath.config_default['learning']:
controller_act = [parser.OFPActionOutput(ofproto.OFPP_CONTROLLER)]
else:
controller_act = []
# generate the output actions for each port
tagged_act = self.tagged_output_action(parser, v.tagged)
untagged_act = self.untagged_output_action(parser, v.untagged)
# send rule for matching packets arriving on tagged ports
for port in v.tagged:
strip_act = [parser.OFPActionPopVlan()]
action = copy.copy(controller_act)
if tagged_act:
action += tagged_act
if untagged_act:
action += strip_act + untagged_act
match = parser.OFPMatch(in_port=port.number,
vlan_vid=v.vid|ofproto_v1_3.OFPVID_PRESENT)
priority = datapath.config_default['low_priority']
cookie = datapath.config_default['cookie']
self.add_flow(dp, match, action, priority, cookie)
# send rule for each untagged port
push_act = [
parser.OFPActionPushVlan(ether.ETH_TYPE_8021Q),
parser.OFPActionSetField(vlan_vid=v.vid|ofproto_v1_3.OFPVID_PRESENT)
]
for port in v.untagged:
match = parser.OFPMatch(in_port=port.number)
action = copy.copy(controller_act)
if untagged_act:
action += untagged_act
if tagged_act:
action += push_act + tagged_act
priority = datapath.config_default['low_priority']
cookie = datapath.config_default['cookie']
self.add_flow(dp, match, action, priority, cookie)
for nw_address, acls in datapath.acls.items():
for acl in acls:
if acl.action.lower() == "drop":
self.logger.info("Adding ACL:{%s} for nw_address:%s",
acl, nw_address)
# Hacky method of detecting IPv4/IPv6
try:
socket.inet_aton(nw_address.split('/')[0])
acl.match['nw_dst'] = nw_address
except socket.error:
acl.match['ipv6_dst'] = nw_address
match = ofctl_v1_3.to_match(dp, acl.match)
priority = datapath.config_default['highest_priority']
cookie = datapath.config_default['cookie']
self.add_flow(dp, match, drop_act, priority, cookie)
for k, port in datapath.ports.items():
for acl in port.acls:
if acl.action.lower() == "drop":
self.logger.info("Adding ACL:{%s} to port:%s", acl, port)
acl.match['in_port'] = port.number
match = ofctl_v1_3.to_match(dp, acl.match)
priority = datapath.config_default['highest_priority']
cookie = datapath.config_default['cookie']
self.add_flow(dp, match, drop_act, priority, cookie)
# Mark datapath as fully configured
datapath.running = True
self.logger.info("Datapath configured")
self.set_default_log_formatter()