"""Implementation of Valve learning layer 2/3 switch."""
# Copyright (C) 2013 Nippon Telegraph and Telephone Corporation.
# Copyright (C) 2015 Brad Cowie, Christopher Lorier and Joe Stringer.
# Copyright (C) 2015 Research and Education Advanced Network New Zealand Ltd.
# Copyright (C) 2015--2019 The Contributors
#
# 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 copy
import logging
from collections import defaultdict, deque
from faucet import tfm_pipeline
from faucet import valve_acl
from faucet import valve_of
from faucet import valve_packet
from faucet import valve_route
from faucet import valve_switch
from faucet import valve_table
from faucet import valve_util
from faucet import valve_pipeline
from faucet.valve_manager_base import ValveManagerBase
from faucet.valve_coprocessor import CoprocessorManager
from faucet.valve_lldp import ValveLLDPManager
from faucet.valve_outonly import OutputOnlyManager
from faucet.valve_switch_stack import ValveSwitchStackManagerBase
# TODO: has to be here to avoid eventlet monkey patch in faucet_dot1x.
[docs]class Dot1xManager(ValveManagerBase):
def __init__(self, dot1x, dp_id, dot1x_ports, nfv_sw_port):
self.dot1x = dot1x
self.dp_id = dp_id
self.dot1x_ports = dot1x_ports
self.nfv_sw_port = nfv_sw_port
[docs] def del_port(self, port):
ofmsgs = []
if port.dot1x:
ofmsgs.extend(self.dot1x.port_down(self.dp_id, port, self.nfv_sw_port))
return ofmsgs
[docs] def add_port(self, port):
ofmsgs = []
if port == self.nfv_sw_port:
ofmsgs.extend(self.dot1x.nfv_sw_port_up(
self.dp_id, self.dot1x_ports(), self.nfv_sw_port))
elif port.dot1x:
ofmsgs.extend(self.dot1x.port_up(
self.dp_id, port, self.nfv_sw_port))
return ofmsgs
[docs]class ValveLogger:
"""Logger for a Valve that adds DP ID."""
def __init__(self, logger, dp_id, dp_name):
self.logger = logger
self.dp_id = dp_id
self.dp_name = dp_name
def _dpid_prefix(self, log_msg):
"""Add DP ID prefix to log message."""
return ' '.join((valve_util.dpid_log(self.dp_id), self.dp_name, log_msg))
[docs] def debug(self, log_msg):
"""Log debug level message."""
self.logger.debug(self._dpid_prefix(log_msg))
[docs] def info(self, log_msg):
"""Log info level message."""
self.logger.info(self._dpid_prefix(log_msg))
[docs] def error(self, log_msg):
"""Log error level message."""
self.logger.error(self._dpid_prefix(log_msg))
[docs] def warning(self, log_msg):
"""Log warning level message."""
self.logger.warning(self._dpid_prefix(log_msg))
[docs]class Valve:
"""Generates the messages to configure a datapath as a l2 learning switch.
Vendor specific implementations may require sending configuration flows.
This can be achieved by inheriting from this class and overwriting the
function switch_features.
"""
__slots__ = [
'_coprocessor_manager',
'_dot1x_manager',
'_last_advertise_sec',
'_last_fast_advertise_sec',
'_last_packet_in_sec',
'_last_pipeline_flows',
'_lldp_manager',
'_managers',
'_output_only_manager',
'_packet_in_count_sec',
'_port_highwater',
'_route_manager_by_eth_type',
'_route_manager_by_ipv',
'acl_manager',
'dot1x',
'dp',
'logger',
'logname',
'metrics',
'notifier',
'ofchannel_logger',
'pipeline',
'recent_ofmsgs',
'switch_manager',
]
DEC_TTL = True
USE_BARRIERS = True
STATIC_TABLE_IDS = False
GROUPS = True
def __init__(self, dp, logname, metrics, notifier, dot1x):
self.dot1x = dot1x
self.dp = dp
self.logname = logname
self.metrics = metrics
self.notifier = notifier
self.ofchannel_logger = None
self.logger = None
self.recent_ofmsgs = deque(maxlen=32)
self._last_pipeline_flows = []
self._packet_in_count_sec = None
self._last_packet_in_sec = None
self._last_advertise_sec = None
self._last_fast_advertise_sec = None
self.dp_init()
def _port_vlan_labels(self, port, vlan):
return dict(self.dp.port_labels(port.number), vlan=vlan.vid)
def _inc_var(self, var, labels=None, val=1):
if labels is None:
labels = self.dp.base_prom_labels()
self.metrics.inc_var(var, labels, val)
def _set_var(self, var, val, labels=None):
if labels is None:
labels = self.dp.base_prom_labels()
metrics_var = getattr(self.metrics, var)
metrics_var.labels(**labels).set(val)
def _set_port_var(self, var, val, port):
self._set_var(var, val, labels=self.dp.port_labels(port.number))
def _remove_var(self, var, labels=None):
if labels is None:
labels = self.dp.base_prom_labels()
metrics_var = getattr(self.metrics, var)
label_values = [labels[key] for key in metrics_var._labelnames]
metrics_var.remove(*label_values)
[docs] def close_logs(self):
"""Explicitly close any active loggers."""
if self.logger is not None:
valve_util.close_logger(self.logger.logger)
valve_util.close_logger(self.ofchannel_logger)
[docs] def dp_init(self, new_dp=None):
"""Initialize datapath state at connection/re/config time."""
if new_dp:
new_dp.clone_dyn_state(self.dp)
self.dp = new_dp
self.close_logs()
self.logger = ValveLogger(
logging.getLogger(self.logname + '.valve'), self.dp.dp_id, self.dp.name)
self.ofchannel_logger = None
self._packet_in_count_sec = 0
self._last_packet_in_sec = 0
self._last_advertise_sec = 0
self._last_fast_advertise_sec = 0
self._route_manager_by_ipv = {}
self._route_manager_by_eth_type = {}
self._port_highwater = {}
self.dp.reset_refs()
for vlan_vid in self.dp.vlans.keys():
self._port_highwater[vlan_vid] = {}
for port_number in self.dp.ports.keys():
self._port_highwater[vlan_vid][port_number] = 0
self._lldp_manager = ValveLLDPManager(
self.dp.tables['vlan'], self.dp.highest_priority)
self._output_only_manager = OutputOnlyManager(
self.dp.tables['vlan'], self.dp.highest_priority)
self._dot1x_manager = None
if self.dp.dot1x and self.dp.dot1x_ports():
nfv_sw_port = self.dp.ports[self.dp.dot1x['nfv_sw_port']]
self._dot1x_manager = Dot1xManager(self.dot1x, self.dp.dp_id, self.dp.dot1x_ports, nfv_sw_port)
self.pipeline = valve_pipeline.ValvePipeline(self.dp)
self.acl_manager = None
if self.dp.has_acls:
self.acl_manager = valve_acl.ValveAclManager(
self.dp.tables.get('port_acl'), self.dp.tables.get('vlan_acl'),
self.dp.tables.get('egress_acl'), self.pipeline,
self.dp.meters, self.dp.dp_acls)
self.switch_manager = valve_switch.valve_switch_factory(
self.logger, self.dp, self.pipeline, self.acl_manager)
self._coprocessor_manager = None
copro_table = self.dp.tables.get('copro', None)
if copro_table:
self._coprocessor_manager = CoprocessorManager(
self.dp.ports, copro_table, self.dp.tables['vlan'], self.dp.tables['eth_src'],
self.switch_manager.output_table, self.dp.low_priority, self.dp.high_priority)
for ipv, route_manager_class, neighbor_timeout in (
(4, valve_route.ValveIPv4RouteManager, self.dp.arp_neighbor_timeout),
(6, valve_route.ValveIPv6RouteManager, self.dp.nd_neighbor_timeout)):
fib_table_name = 'ipv%u_fib' % ipv
if fib_table_name not in self.dp.tables:
continue
fib_table = self.dp.tables[fib_table_name]
proactive_learn = getattr(self.dp, 'proactive_learn_v%u' % ipv)
route_manager = route_manager_class(
self.logger, self.notify, self.dp.global_vlan, neighbor_timeout,
self.dp.max_hosts_per_resolve_cycle,
self.dp.max_host_fib_retry_count,
self.dp.max_resolve_backoff_time, proactive_learn,
self.DEC_TTL, self.dp.multi_out, fib_table,
self.dp.tables['vip'], self.pipeline, self.dp.routers, self.switch_manager)
self._route_manager_by_ipv[route_manager.IPV] = route_manager
for vlan in self.dp.vlans.values():
if vlan.faucet_vips_by_ipv(route_manager.IPV):
route_manager.active = True
vips_str = list(str(vip) for vip in vlan.faucet_vips_by_ipv(route_manager.IPV))
self.logger.info('IPv%u routing is active on %s with VIPs %s' % (
route_manager.IPV, vlan, vips_str))
for eth_type in route_manager.CONTROL_ETH_TYPES:
self._route_manager_by_eth_type[eth_type] = route_manager
self._managers = tuple(
manager for manager in (
self.pipeline, self.switch_manager, self.acl_manager, self._lldp_manager,
self._route_manager_by_ipv.get(4), self._route_manager_by_ipv.get(6),
self._coprocessor_manager, self._output_only_manager) if manager is not None)
table_configs = sorted([
(table.table_id, str(table.table_config)) for table in self.dp.tables.values()])
for table_id, table_config in table_configs:
self.logger.info('table ID %u %s' % (table_id, table_config))
[docs] def notify(self, event_dict):
"""Send an event notification."""
self.notifier.notify(self.dp.dp_id, self.dp.name, event_dict)
[docs] def switch_features(self, _msg):
"""Send configuration flows necessary for the switch implementation.
Args:
msg (OFPSwitchFeatures): msg sent from switch.
Vendor specific configuration should be implemented here.
"""
ofmsgs = [
valve_of.faucet_config(),
valve_of.faucet_async(
packet_in=False, notify_flow_removed=False, port_status=False),
valve_of.desc_stats_request()]
ofmsgs.extend(self._delete_all_valve_flows())
return ofmsgs
[docs] def ofchannel_log(self, ofmsgs):
"""Log OpenFlow messages in text format to debugging log."""
if self.dp is None:
return
if self.dp.ofchannel_log is None:
return
if self.ofchannel_logger is None:
self.ofchannel_logger = valve_util.get_logger(
self.dp.ofchannel_log,
self.dp.ofchannel_log,
logging.DEBUG,
0)
log_prefix = '%u %s' % (
len(ofmsgs), valve_util.dpid_log(self.dp.dp_id))
for i, ofmsg in enumerate(ofmsgs, start=1):
self.ofchannel_logger.debug(
'%u/%s %s', i, log_prefix, ofmsg)
[docs] def dot1x_event(self, event_dict):
self.notify({'DOT1X': event_dict})
[docs] def floods_to_root(self):
"""Return True if our dp floods (only) to root switch"""
return self.switch_manager.floods_to_root(self.dp)
def _delete_all_valve_flows(self):
"""Delete all flows from all FAUCET tables."""
ofmsgs = [valve_table.wildcard_table.flowdel()]
if self.dp.meters or self.dp.packetin_pps or self.dp.slowpath_pps:
ofmsgs.append(valve_of.meterdel())
if self.dp.group_table:
ofmsgs.append(self.dp.groups.delete_all())
return ofmsgs
def _delete_all_port_match_flows(self, port):
"""Delete all flows that match an input port from all FAUCET tables."""
tables = [valve_table.wildcard_table]
if self.dp.dp_acls:
# DP ACL flows live forever.
port_acl_table = self.dp.tables['port_acl']
tables = set(self.dp.in_port_tables()) - set([port_acl_table])
return [
table.flowdel(match=table.match(in_port=port.number))
for table in tables]
@staticmethod
def _pipeline_flows():
return []
def _add_default_drop_flows(self):
"""Add default drop rules on all FAUCET tables."""
ofmsgs = []
for table in self.dp.tables.values():
miss_table_name = table.table_config.miss_goto
if miss_table_name:
miss_table = self.dp.tables[miss_table_name]
ofmsgs.append(table.flowmod(
priority=self.dp.lowest_priority,
inst=[table.goto_miss(miss_table)]))
else:
ofmsgs.append(table.flowdrop(
priority=self.dp.lowest_priority))
return ofmsgs
def _add_packetin_meter(self):
"""Add rate limiting of packetin in pps (not supported by many DPs)."""
if self.dp.packetin_pps:
return [
valve_of.controller_pps_meteradd(pps=self.dp.packetin_pps)]
return []
def _add_slowpath_meter(self):
"""Add rate limiting of slowpath in pps (not supported by many DPs)."""
if self.dp.slowpath_pps:
return [
valve_of.slowpath_pps_meteradd(pps=self.dp.slowpath_pps)]
return []
def _add_default_flows(self):
"""Configure datapath with necessary default tables and rules."""
ofmsgs = []
ofmsgs.extend(self._delete_all_valve_flows())
ofmsgs.extend(self._add_packetin_meter())
ofmsgs.extend(self._add_slowpath_meter())
if self.dp.meters:
for meter in self.dp.meters.values():
ofmsgs.append(meter.entry_msg)
ofmsgs.extend(self._add_default_drop_flows())
return ofmsgs
[docs] def add_vlan(self, vlan, cold_start=False):
"""Configure a VLAN."""
self.logger.info('Configuring %s' % vlan)
ofmsgs = []
for manager in self._managers:
ofmsgs.extend(manager.add_vlan(vlan, cold_start))
return ofmsgs
[docs] def add_vlans(self, vlans, cold_start=False):
ofmsgs = []
for vlan in vlans:
ofmsgs.extend(self.add_vlan(vlan, cold_start=cold_start))
return ofmsgs
[docs] def del_vlan(self, vlan):
"""Delete a configured VLAN."""
self.logger.info('Delete VLAN %s' % vlan)
ofmsgs = []
for manager in self._managers:
ofmsgs.extend(manager.del_vlan(vlan))
return ofmsgs
[docs] def del_vlans(self, vlans):
ofmsgs = []
for vlan in vlans:
ofmsgs.extend(self.del_vlan(vlan))
return ofmsgs
def _get_all_configured_port_nos(self):
ports = set(self.dp.non_vlan_ports())
for vlan in self.dp.vlans.values():
ports.update(set(vlan.get_ports()))
ports = {port.number for port in ports}
return ports
@staticmethod
def _get_ports_status(discovered_up_port_nos, all_configured_port_nos):
port_status = {
port_no: (port_no in discovered_up_port_nos) for port_no in all_configured_port_nos}
all_up_port_nos = {port_no for port_no, status in port_status.items() if status}
return (port_status, all_up_port_nos)
def _cold_start_ports_and_vlans(self, now, discovered_up_port_nos):
"""Add all configured and discovered ports and VLANs at cold start time."""
always_up_port_nos = {
port.number for port in self.dp.ports.values() if not port.opstatus_reconf}
discovered_up_port_nos = discovered_up_port_nos.union(always_up_port_nos)
all_configured_port_nos = self._get_all_configured_port_nos()
port_status, all_up_port_nos = self._get_ports_status(
discovered_up_port_nos, all_configured_port_nos)
for port_no, status in port_status.items():
self._set_port_status(port_no, status, now)
self.notify({'PORTS_STATUS': port_status})
ofmsgs = []
ofmsgs.extend(self._add_default_flows())
for manager in self._managers:
ofmsgs.extend(manager.initialise_tables())
ofmsgs.append(
valve_of.faucet_async(
packet_in=True,
port_status=True,
notify_flow_removed=self.dp.use_idle_timeout))
ofmsgs.extend(self.ports_add(
all_up_port_nos, cold_start=True, log_msg='configured'))
ofmsgs.extend(self.add_vlans(self.dp.vlans.values(), cold_start=True))
return ofmsgs
[docs] def ofdescstats_handler(self, body):
"""Handle OF DP description."""
labels = dict(
self.dp.base_prom_labels(),
mfr_desc=valve_util.utf8_decode(body.mfr_desc),
hw_desc=valve_util.utf8_decode(body.hw_desc),
sw_desc=valve_util.utf8_decode(body.sw_desc),
serial_num=valve_util.utf8_decode(body.serial_num),
dp_desc=valve_util.utf8_decode(body.dp_desc))
self._set_var('of_dp_desc_stats', self.dp.dp_id, labels=labels)
def _set_port_status(self, port_no, port_status, now):
"""Set port operational status."""
if port_status:
self.dp.dyn_up_port_nos.add(port_no)
else:
self.dp.dyn_up_port_nos -= set([port_no])
port = self.dp.ports.get(port_no, None)
if port is None:
return
self._set_port_var('port_status', port_status, port)
port.dyn_update_time = now
[docs] def port_status_handler(self, port_no, reason, state, _other_valves, now):
"""Return OpenFlow messages responding to port operational status change."""
port_status_codes = {
valve_of.ofp.OFPPR_ADD: 'ADD',
valve_of.ofp.OFPPR_DELETE: 'DELETE',
valve_of.ofp.OFPPR_MODIFY: 'MODIFY'
}
def _decode_port_status(reason):
"""Humanize the port status reason code."""
return port_status_codes.get(reason, 'UNKNOWN')
port_status = valve_of.port_status_from_state(state)
self.notify(
{'PORT_CHANGE': {
'port_no': port_no,
'reason': _decode_port_status(reason),
'state': state,
'status': port_status}})
self._set_port_status(port_no, port_status, now)
if not self.dp.port_no_valid(port_no):
return {}
port = self.dp.ports[port_no]
if not port.opstatus_reconf:
return {}
if not reason in port_status_codes:
self.logger.warning('Unhandled port status %s/state %s for %s' % (
reason, state, port))
return {}
ofmsgs_by_valve = {self: []}
new_port_status = (
reason == valve_of.ofp.OFPPR_ADD or
(reason == valve_of.ofp.OFPPR_MODIFY and port_status))
blocked_down_state = (
(state & valve_of.ofp.OFPPS_BLOCKED) or (state & valve_of.ofp.OFPPS_LINK_DOWN))
live_state = state & valve_of.ofp.OFPPS_LIVE
decoded_reason = _decode_port_status(reason)
state_description = '%s up status %s reason %s state %s' % (
port, port_status, decoded_reason, state)
ofmsgs = []
if new_port_status != port.dyn_phys_up:
self.logger.info('status change: %s' % state_description)
if new_port_status:
ofmsgs = self.port_add(port_no)
else:
ofmsgs = self.port_delete(port_no, keep_cache=True, other_valves=_other_valves)
else:
self.logger.info('status did not change: %s' % state_description)
if new_port_status:
if blocked_down_state:
self.logger.info(
'%s state down or blocked despite status up, setting to status down' % port)
ofmsgs = self.port_delete(port_no, keep_cache=True, other_valves=_other_valves)
if not live_state:
self.logger.info(
'%s state OFPPS_LIVE reset, ignoring in expectation of port down' % port)
ofmsgs_by_valve[self].extend(ofmsgs)
return ofmsgs_by_valve
[docs] def advertise(self, now, _other_values):
"""Called periodically to advertise services (eg. IPv6 RAs)."""
if (not self.dp.advertise_interval or
now - self._last_advertise_sec < self.dp.advertise_interval):
return {}
self._last_advertise_sec = now
ofmsgs = []
for route_manager in self._route_manager_by_ipv.values():
for vlan in self.dp.vlans.values():
ofmsgs.extend(route_manager.advertise(vlan))
if ofmsgs:
return {self: ofmsgs}
return {}
def _send_lldp_beacon_on_port(self, port, now):
chassis_id = str(self.dp.faucet_dp_mac)
ttl = min(
self.dp.lldp_beacon.get('send_interval', self.dp.DEFAULT_LLDP_SEND_INTERVAL) * 3,
2**16-1)
org_tlvs = [
(tlv['oui'], tlv['subtype'], tlv['info'])
for tlv in port.lldp_beacon['org_tlvs']]
org_tlvs.extend(valve_packet.faucet_lldp_tlvs(self.dp))
org_tlvs.extend(valve_packet.faucet_lldp_stack_state_tlvs(self.dp, port))
system_name = port.lldp_beacon['system_name']
if not system_name:
system_name = self.dp.lldp_beacon.get('system_name', self.dp.name)
lldp_beacon_pkt = valve_packet.lldp_beacon(
self.dp.faucet_dp_mac,
chassis_id, port.number, ttl,
org_tlvs=org_tlvs,
system_name=system_name,
port_descr=port.lldp_beacon['port_descr'])
port.dyn_last_lldp_beacon_time = now
return valve_of.packetout(port.number, lldp_beacon_pkt.data)
[docs] def fast_advertise(self, now, _other_valves):
"""Called periodically to send LLDP/LACP packets."""
# TODO: the beacon service is specifically NOT to support conventional R/STP.
# It is intended to facilitate physical troubleshooting (e.g.
# a standard cable tester can display OF port information).
# It is used also by stacking to verify stacking links.
# TODO: in the stacking case, provide an authentication scheme for the probes
# so they cannot be forged.
if (not self.dp.fast_advertise_interval or
now - self._last_fast_advertise_sec < self.dp.fast_advertise_interval):
return {}
self._last_fast_advertise_sec = now
ofmsgs = []
for port in self.dp.lacp_active_ports:
if port.running():
ofmsgs.extend(self._lacp_actions(port.dyn_last_lacp_pkt, port))
ports = self.dp.lldp_beacon_send_ports(now)
ofmsgs.extend([self._send_lldp_beacon_on_port(port, now) for port in ports])
if ofmsgs:
return {self: ofmsgs}
return {}
def _update_stack_link_state(self, ports, now, other_valves):
stack_changes = 0
ofmsgs_by_valve = defaultdict(list)
stacked_valves = {self}.union(self._stacked_valves(other_valves))
for port in ports:
next_state = self.switch_manager.next_stack_link_state(port, now) # pytype: disable=attribute-error
if next_state is not None:
next_state()
self._set_port_var('port_stack_state', port.dyn_stack_current_state, port)
self.notify({'STACK_STATE': {
'port': port.number,
'state': port.dyn_stack_current_state
}})
stack_changes += 1
port_stack_up = False
if port.is_stack_up():
port_stack_up = True
else:
if port.is_stack_init() and port.stack['port'].is_stack_up():
port_stack_up = True
for valve in stacked_valves:
valve.switch_manager.update_stack_topo(port_stack_up, self.dp, port)
if stack_changes:
self.logger.info('%u stack ports changed state' % stack_changes)
notify_dps = {}
for valve in stacked_valves:
if not valve.dp.dyn_running:
continue
ofmsgs_by_valve[valve].extend(valve.add_vlans(valve.dp.vlans.values()))
for port in valve.dp.stack_ports:
ofmsgs_by_valve[valve].extend(valve.switch_manager.del_port(port))
ofmsgs_by_valve[valve].extend(valve.switch_manager.add_tunnel_acls())
path_port = valve.dp.shortest_path_port(valve.dp.stack_root_name)
path_port_number = path_port.number if path_port else 0.0
self._set_var(
'dp_root_hop_port', path_port_number, labels=valve.dp.base_prom_labels())
notify_dps.setdefault(valve.dp.name, {})['root_hop_port'] = path_port_number
# Find the first valve with a valid stack and trigger notification.
for valve in stacked_valves:
if valve.dp.stack_graph:
self.notify(
{'STACK_TOPO_CHANGE': {
'stack_root': valve.dp.stack_root_name,
'graph': valve.dp.get_node_link_data(),
'dps': notify_dps
}})
break
return ofmsgs_by_valve
[docs] def fast_state_expire(self, now, other_valves):
"""Called periodically to verify the state of stack ports."""
if self.dp.lldp_beacon:
for port in self.dp.ports.values():
if port.dyn_lldp_beacon_recv_state:
age = now - port.dyn_lldp_beacon_recv_time
if age > self.dp.lldp_beacon['send_interval'] * port.max_lldp_lost:
self.logger.info('LLDP for %s inactive after %us' % (port, age))
port.dyn_lldp_beacon_recv_state = None
return self._update_stack_link_state(self.dp.stack_ports, now, other_valves)
def _reset_dp_status(self):
self._set_var('dp_status', int(self.dp.dyn_running))
[docs] def datapath_connect(self, now, discovered_up_ports):
"""Handle Ryu datapath connection event and provision pipeline.
Args:
now (float): current epoch time.
discovered_up_ports (set): datapath port numbers that are up.
Returns:
list: OpenFlow messages to send to datapath.
"""
self.logger.info('Cold start configuring DP')
self.notify(
{'DP_CHANGE': {
'reason': 'cold_start'}})
ofmsgs = self._cold_start_ports_and_vlans(now, discovered_up_ports)
self.dp.cold_start(now)
self._inc_var('of_dp_connections')
self._reset_dp_status()
return ofmsgs
[docs] def datapath_disconnect(self, now):
"""Handle Ryu datapath disconnection event."""
self.logger.warning('datapath down')
self.notify(
{'DP_CHANGE': {
'reason': 'disconnect'}})
self.dp.dyn_running = False
self._inc_var('of_dp_disconnections')
self._reset_dp_status()
self.ports_delete(self.dp.ports.keys(), now=now)
def _port_delete_manager_state(self, port):
ofmsgs = []
for manager in self._managers:
ofmsgs.extend(manager.del_port(port))
return ofmsgs
def _port_delete_flows_state(self, port, keep_cache=False):
"""Delete flows/state for a port."""
ofmsgs = []
for route_manager in self._route_manager_by_ipv.values():
ofmsgs.extend(route_manager.expire_port_nexthops(port))
ofmsgs.extend(self._delete_all_port_match_flows(port))
if not keep_cache:
ofmsgs.extend(self._port_delete_manager_state(port))
return ofmsgs
[docs] def ports_add(self, port_nums, cold_start=False, log_msg='up'):
"""Handle the addition of ports.
Args:
port_num (list): list of port numbers.
cold_start (bool): True if configuring datapath from scratch.
Returns:
list: OpenFlow messages, if any.
"""
ofmsgs = []
vlans_with_ports_added = set()
for port_num in port_nums:
if not self.dp.port_no_valid(port_num):
self.logger.info(
'Ignoring port:%u not present in configuration file' % port_num)
continue
port = self.dp.ports[port_num]
port.dyn_phys_up = True
self.logger.info('%s (%s) %s' % (port, port.description, log_msg))
if not port.running():
continue
for manager in self._managers:
ofmsgs.extend(manager.add_port(port))
if self._dot1x_manager:
ofmsgs.extend(self._dot1x_manager.add_port(port))
if port.output_only:
continue
if port.lacp:
if cold_start:
self.lacp_update_actor_state(port, False, cold_start=cold_start)
self.lacp_update_port_selection_state(port, cold_start=cold_start)
ofmsgs.extend(self.lacp_update(port, False))
if port.lacp_active:
ofmsgs.extend(self._lacp_actions(port.dyn_last_lacp_pkt, port))
self._set_port_var('lacp_port_id', port.lacp_port_id, port)
if port.stack:
port_vlans = self.dp.vlans.values()
else:
port_vlans = port.vlans()
vlans_with_ports_added.update(set(port_vlans))
# Only update flooding rules if not cold starting.
if not cold_start:
ofmsgs.extend(self.add_vlans(vlans_with_ports_added))
return ofmsgs
[docs] def port_add(self, port_num):
"""Handle addition of a single port.
Args:
port_num (list): list of port numbers.
Returns:
list: OpenFlow messages, if any.
"""
return self.ports_add([port_num])
[docs] def ports_delete(self, port_nums, log_msg='down', keep_cache=False, other_valves=None, now=None):
"""Handle the deletion of ports.
Args:
port_nums (list): list of port numbers.
Returns:
list: OpenFlow messages, if any.
"""
ofmsgs = []
vlans_with_deleted_ports = set()
for port_num in port_nums:
if not self.dp.port_no_valid(port_num):
continue
port = self.dp.ports[port_num]
port.dyn_phys_up = False
self.logger.info('%s (%s) %s' % (port, port.description, log_msg))
# now is set to a time value only when ports_delete is called to flush
if now:
self._set_port_status(port_num, False, now)
if port.output_only:
continue
if self._dot1x_manager:
ofmsgs.extend(self._dot1x_manager.del_port(port))
vlans_with_deleted_ports.update(set(port.vlans()))
if port.lacp:
ofmsgs.extend(self.lacp_update(port, False, other_valves=other_valves))
else:
ofmsgs.extend(self._port_delete_flows_state(port, keep_cache=keep_cache))
for vlan in vlans_with_deleted_ports:
ofmsgs.extend(self.switch_manager.update_vlan(vlan))
return ofmsgs
[docs] def port_delete(self, port_num, keep_cache=False, other_valves=None):
"""Return flow messages that delete port from pipeline."""
return self.ports_delete([port_num], keep_cache=keep_cache, other_valves=other_valves)
def _reset_lacp_status(self, port):
lacp_state = port.actor_state()
lacp_role = port.lacp_port_state()
self._set_port_var('port_lacp_state', lacp_state, port)
self.notify(
{'LAG_CHANGE': {'port_no': port.number, 'state': lacp_state, 'role': lacp_role}})
[docs] def get_lacp_dpid_nomination(self, lacp_id, other_valves):
"""Chooses the DP for a given LAG.
The DP will be nominated by the following conditions in order:
1) Number of LAG ports
2) Root DP
3) Lowest DPID
Args:
lacp_id: The LACP LAG ID
other_valves (list): list of other valves
Returns:
nominated_dpid, reason
"""
if not other_valves:
return None, ''
stacked_other_valves = self._stacked_valves(other_valves)
all_stacked_valves = {self}.union(stacked_other_valves)
ports = {}
root_dpid = None
for valve in all_stacked_valves:
all_lags = valve.dp.lags_up()
if lacp_id in all_lags:
ports[valve.dp.dp_id] = len(all_lags[lacp_id])
if valve.dp.is_stack_root():
root_dpid = valve.dp.dp_id
# Order by number of ports
port_order = sorted(ports, key=ports.get, reverse=True)
if not port_order:
return None, ''
most_ports_dpid = port_order[0]
most_ports_dpids = [dpid for dpid, num in ports.items() if num == ports[most_ports_dpid]]
if len(most_ports_dpids) > 1:
# There are several dpids that have the same number of lags
if root_dpid in most_ports_dpids:
# root_dpid is the chosen DPID
return root_dpid, 'root dp'
# Order by lowest DPID
return sorted(most_ports_dpids), 'lowest dpid'
# Most_ports_dpid is the chosen DPID
return most_ports_dpid, 'most LAG ports'
[docs] def lacp_update_port_selection_state(self, port, other_valves=None, cold_start=False):
"""Update the LACP port selection state.
Args:
port (Port): LACP port
other_valves (list): List of other valves
cold_start (bool): Whether the port is being cold started
Returns:
bool: True if port state changed
"""
nominated_dpid = self.dp.dp_id
if self.dp.stack_graph:
nominated_dpid, _ = self.get_lacp_dpid_nomination(port.lacp, other_valves)
prev_state = port.lacp_port_state()
new_state = port.lacp_port_update(self.dp.dp_id == nominated_dpid, cold_start=cold_start)
if new_state != prev_state:
self.logger.info('LAG %u %s %s (previous state %s)' % (
port.lacp, port, port.port_role_name(new_state),
port.port_role_name(prev_state)))
self._set_port_var('port_lacp_role', new_state, port)
return new_state != prev_state
[docs] def lacp_update_actor_state(self, port, lacp_up, now=None, lacp_pkt=None, cold_start=False):
"""Updates a LAG actor state.
Args:
port: LACP port
lacp_up (bool): Whether LACP is going UP or DOWN
now (float): Current epoch time
lacp_pkt (PacketMeta): LACP packet
cold_start (bool): Whether the port is being cold started
Returns:
bool: True if LACP state changed
"""
prev_actor_state = port.actor_state()
new_actor_state = port.lacp_actor_update(
lacp_up, now=now, lacp_pkt=lacp_pkt,
cold_start=cold_start)
if prev_actor_state != new_actor_state:
self.logger.info('LAG %u %s actor state %s (previous state %s)' % (
port.lacp, port, port.actor_state_name(new_actor_state),
port.actor_state_name(prev_actor_state)))
return prev_actor_state != new_actor_state
[docs] def lacp_update(self, port, lacp_up, now=None, lacp_pkt=None, other_valves=None):
"""Update the port's LACP states and enables/disables pipeline processing.
Args:
port: The port the packet is being received on
lacp_up (bool): Whether the lacp actor is up
now (float): The current time
lacp_pkt (PacketMeta): The received LACP packet
other_valves (list): List of other valves (in the stack)
Returns:
ofmsgs
"""
ofmsgs = []
updated = self.lacp_update_actor_state(port, lacp_up, now, lacp_pkt)
select_updated = self.lacp_update_port_selection_state(port, other_valves)
if updated or select_updated:
if updated:
self._reset_lacp_status(port)
if port.is_port_selected() and port.is_actor_up():
ofmsgs = self.lacp_enable_forwarding(port)
else:
ofmsgs = self.lacp_disable_forwarding(port)
return ofmsgs
[docs] def lacp_enable_forwarding(self, port):
"""Enables packets from the LAG link to progress through the pipeline.
Also recomputes the flooding & host rules.
Should only be called when a LACP port is both ACTOR_UP & SELECTED
Return OpenFlow messages when LACP is UP and SELECTED on a port.
Args:
port: Port instance with LACP enabled.
Returns:
ofmsgs
"""
vlan_table = self.dp.tables['vlan']
ofmsgs = []
ofmsgs.append(vlan_table.flowdel(
match=vlan_table.match(in_port=port.number),
priority=self.dp.high_priority, strict=True))
ofmsgs.extend(self.add_vlans(port.vlans()))
return ofmsgs
[docs] def lacp_disable_forwarding(self, port, cold_start=False):
"""
Return OpenFlow messages for initial LACP states and
when packets from the link should not be sent through
the pipeline
"""
ofmsgs = []
if not cold_start:
ofmsgs.extend(self.switch_manager.del_port(port))
ofmsgs.extend(self.add_vlans(port.vlans()))
vlan_table = self.dp.tables['vlan']
ofmsgs.append(vlan_table.flowdrop(
match=vlan_table.match(in_port=port.number),
priority=self.dp.high_priority))
ofmsgs.append(vlan_table.flowcontroller(
vlan_table.match(
in_port=port.number,
eth_type=valve_of.ether.ETH_TYPE_SLOW,
eth_dst=valve_packet.SLOW_PROTOCOL_MULTICAST),
priority=self.dp.highest_priority,
max_len=valve_packet.LACP_SIZE))
return ofmsgs
def _lacp_actions(self, lacp_pkt, port):
"""
Constructs a LACP req-reply packet.
Args:
lacp_pkt (PacketMeta): LACP packet received
port: LACP port
other_valves (list): List of other valves
Returns:
list packetout OpenFlow msgs.
"""
if port.lacp_passthrough:
for peer_num in port.lacp_passthrough:
lacp_peer = self.dp.ports.get(peer_num, None)
if not lacp_peer.dyn_lacp_up:
self.logger.warning('Suppressing LACP LAG %s on %s, peer %s link is down' %
(port.lacp, port, lacp_peer))
return []
actor_state_activity = 0
if port.lacp_active:
actor_state_activity = 1
actor_state_sync, actor_state_col, actor_state_dist = port.get_lacp_flags()
if lacp_pkt:
pkt = valve_packet.lacp_reqreply(
self.dp.faucet_dp_mac, self.dp.faucet_dp_mac,
port.lacp, port.lacp_port_id, port.lacp_port_priority,
actor_state_sync, actor_state_activity,
actor_state_col, actor_state_dist,
lacp_pkt.actor_system, lacp_pkt.actor_key, lacp_pkt.actor_port,
lacp_pkt.actor_system_priority, lacp_pkt.actor_port_priority,
lacp_pkt.actor_state_defaulted,
lacp_pkt.actor_state_expired,
lacp_pkt.actor_state_timeout,
lacp_pkt.actor_state_collecting,
lacp_pkt.actor_state_distributing,
lacp_pkt.actor_state_aggregation,
lacp_pkt.actor_state_synchronization,
lacp_pkt.actor_state_activity)
else:
pkt = valve_packet.lacp_reqreply(
self.dp.faucet_dp_mac, self.dp.faucet_dp_mac,
port.lacp, port.lacp_port_id, port.lacp_port_priority,
actor_state_synchronization=actor_state_sync,
actor_state_activity=actor_state_activity,
actor_state_collecting=actor_state_col,
actor_state_distributing=actor_state_dist)
self.logger.debug('Sending LACP %s on %s activity %s' % (pkt, port, actor_state_activity))
return [valve_of.packetout(port.number, pkt.data)]
[docs] def lacp_handler(self, now, pkt_meta, other_valves):
"""
Handle receiving an LACP packet
Args:
now (float): current epoch time
pkt_meta (PacketMeta): packet for control plane
Returns
dict: OpenFlow messages, if any by Valve
"""
ofmsgs_by_valve = defaultdict(list)
if (pkt_meta.eth_dst == valve_packet.SLOW_PROTOCOL_MULTICAST and
pkt_meta.eth_type == valve_of.ether.ETH_TYPE_SLOW and
pkt_meta.port.lacp):
# LACP packet so reparse
pkt_meta.data = pkt_meta.data[:valve_packet.LACP_SIZE]
pkt_meta.reparse_all()
lacp_pkt = valve_packet.parse_lacp_pkt(pkt_meta.pkt)
if lacp_pkt:
self.logger.debug('receive LACP %s on %s' % (lacp_pkt, pkt_meta.port))
# Respond to new LACP packet or if we haven't sent anything in a while
age = None
if pkt_meta.port.dyn_lacp_last_resp_time:
age = now - pkt_meta.port.dyn_lacp_last_resp_time
lacp_pkt_change = (
pkt_meta.port.dyn_last_lacp_pkt is None or
str(lacp_pkt) != str(pkt_meta.port.dyn_last_lacp_pkt))
lacp_resp_interval = pkt_meta.port.lacp_resp_interval
if lacp_pkt_change or (age is not None and age > lacp_resp_interval):
ofmsgs_by_valve[self].extend(
self._lacp_actions(lacp_pkt, pkt_meta.port))
pkt_meta.port.dyn_lacp_last_resp_time = now
# Update the LACP information
actor_up = lacp_pkt.actor_state_synchronization
ofmsgs_by_valve[self].extend(self.lacp_update(
pkt_meta.port, actor_up, now=now, lacp_pkt=lacp_pkt, other_valves=other_valves))
# Determine if LACP ports with the same ID have met different actor systems
other_lag_ports = [
port for port in self.dp.ports.values()
if port.lacp == pkt_meta.port.lacp and port.dyn_last_lacp_pkt]
actor_system = lacp_pkt.actor_system
for other_lag_port in other_lag_ports:
other_actor_system = other_lag_port.dyn_last_lacp_pkt.actor_system
if actor_system != other_actor_system:
self.logger.error(
'LACP actor system mismatch %s: %s, %s %s' % (
pkt_meta.port, actor_system,
other_lag_port, other_actor_system))
return ofmsgs_by_valve
def _verify_stack_lldp(self, port, now, other_valves,
remote_dp_id, remote_dp_name,
remote_port_id, remote_port_state):
if not port.stack:
return {}
remote_dp = port.stack['dp']
remote_port = port.stack['port']
stack_correct = True
self._inc_var('stack_probes_received')
if (remote_dp_id != remote_dp.dp_id or
remote_dp_name != remote_dp.name or
remote_port_id != remote_port.number):
self.logger.error(
'Stack %s cabling incorrect, expected %s:%s:%u, actual %s:%s:%u' % (
port,
valve_util.dpid_log(remote_dp.dp_id),
remote_dp.name,
remote_port.number,
valve_util.dpid_log(remote_dp_id),
remote_dp_name,
remote_port_id))
stack_correct = False
self._inc_var('stack_cabling_errors')
port.dyn_stack_probe_info = {
'last_seen_lldp_time': now,
'stack_correct': stack_correct,
'remote_dp_id': remote_dp_id,
'remote_dp_name': remote_dp_name,
'remote_port_id': remote_port_id,
'remote_port_state': remote_port_state
}
return self._update_stack_link_state([port], now, other_valves)
[docs] def lldp_handler(self, now, pkt_meta, other_valves):
"""Handle an LLDP packet.
Args:
pkt_meta (PacketMeta): packet for control plane.
"""
if pkt_meta.eth_type != valve_of.ether.ETH_TYPE_LLDP:
return {}
pkt_meta.reparse_all()
lldp_pkt = valve_packet.parse_lldp(pkt_meta.pkt)
if not lldp_pkt:
return {}
port = pkt_meta.port
(remote_dp_id, remote_dp_name,
remote_port_id, remote_port_state) = valve_packet.parse_faucet_lldp(
lldp_pkt, self.dp.faucet_dp_mac)
port.dyn_lldp_beacon_recv_time = now
if port.dyn_lldp_beacon_recv_state != remote_port_state:
chassis_id = str(self.dp.faucet_dp_mac)
if remote_port_state:
self.logger.info('LLDP on %s, %s from %s (remote %s, port %u) state %s' % (
chassis_id, port, pkt_meta.eth_src, valve_util.dpid_log(remote_dp_id),
remote_port_id, port.stack_state_name(remote_port_state)))
port.dyn_lldp_beacon_recv_state = remote_port_state
peer_mac_src = self.dp.ports[port.number].lldp_peer_mac
if peer_mac_src and peer_mac_src != pkt_meta.eth_src:
self.logger.warning('Unexpected LLDP peer. Received pkt from %s instead of %s' % (
pkt_meta.eth_src, peer_mac_src))
ofmsgs_by_valve = {}
if remote_dp_id and remote_port_id:
self.logger.debug('FAUCET LLDP on %s from %s (remote %s, port %u)' % (
port, pkt_meta.eth_src, valve_util.dpid_log(remote_dp_id), remote_port_id))
ofmsgs_by_valve.update(self._verify_stack_lldp(
port, now, other_valves,
remote_dp_id, remote_dp_name,
remote_port_id, remote_port_state))
else:
self.logger.debug('LLDP on %s from %s: %s' % (port, pkt_meta.eth_src, str(lldp_pkt)))
return ofmsgs_by_valve
@staticmethod
def _control_plane_handler(now, pkt_meta, route_manager):
"""Handle a packet probably destined to FAUCET's route managers.
For example, next hop resolution or ICMP echo requests.
Args:
pkt_meta (PacketMeta): packet for control plane.
route_manager (ValveRouteManager): route manager for this eth_type.
Returns:
list: OpenFlow messages, if any.
"""
if (pkt_meta.eth_dst == pkt_meta.vlan.faucet_mac or
not valve_packet.mac_addr_is_unicast(pkt_meta.eth_dst)):
return route_manager.control_plane_handler(now, pkt_meta)
return []
[docs] def rate_limit_packet_ins(self, now):
"""Return True if too many packet ins this second."""
if self._last_packet_in_sec != now:
self._last_packet_in_sec = now
self._packet_in_count_sec = 0
self._packet_in_count_sec += 1
if self.dp.ignore_learn_ins:
if self._packet_in_count_sec % self.dp.ignore_learn_ins == 0:
self._inc_var('of_ignored_packet_ins')
return True
return False
[docs] def router_learn_host(self, pkt_meta):
"""Add L3 forwarding rule.
Args:
pkt_meta (PacketMeta): PacketMeta instance for packet received.
Returns:
list: OpenFlow messages, if any.
"""
if isinstance(self.switch_manager, ValveSwitchStackManagerBase):
if pkt_meta.eth_src == pkt_meta.vlan.faucet_mac:
return self.switch_manager.learn_host_intervlan_routing_flows(
pkt_meta.port, pkt_meta.vlan, pkt_meta.eth_src, pkt_meta.eth_dst)
if pkt_meta.eth_dst == pkt_meta.vlan.faucet_mac:
return self.switch_manager.learn_host_intervlan_routing_flows(
pkt_meta.port, pkt_meta.vlan, pkt_meta.eth_dst, pkt_meta.eth_src)
return []
[docs] def learn_host(self, now, pkt_meta, other_valves):
"""Possibly learn a host on a port.
Args:
now (float): current epoch time.
pkt_meta (PacketMeta): PacketMeta instance for packet received.
other_valves (list): all Valves other than this one.
Returns:
list: OpenFlow messages, if any.
"""
learn_port = self.switch_manager.edge_learn_port(
self._stacked_valves(other_valves), pkt_meta)
if learn_port is not None:
learn_flows, previous_port, update_cache = self.switch_manager.learn_host_on_vlan_ports(
now, learn_port, pkt_meta.vlan, pkt_meta.eth_src,
last_dp_coldstart_time=self.dp.dyn_last_coldstart_time)
if update_cache:
pkt_meta.vlan.add_cache_host(pkt_meta.eth_src, learn_port, now)
if pkt_meta.l3_pkt is None:
pkt_meta.reparse_ip()
learn_log = 'L2 learned on %s %s (%u hosts total)' % (
learn_port, pkt_meta.log(), pkt_meta.vlan.hosts_count())
stack_descr = None
if pkt_meta.port.stack:
stack_descr = pkt_meta.port.stack_descr()
learn_log += ' from %s' % stack_descr
previous_port_no = None
if previous_port is not None:
previous_port_no = previous_port.number
if pkt_meta.port.number != previous_port_no:
learn_log += ', moved from %s' % previous_port
if previous_port.stack:
learn_log += ' from %s' % previous_port.stack_descr()
self.logger.info(learn_log)
learn_labels = dict(self.dp.base_prom_labels(), vid=pkt_meta.vlan.vid,
eth_src=pkt_meta.eth_src)
self._set_var('learned_l2_port', learn_port.number, labels=learn_labels)
l2_learn_msg = {
'port_no': learn_port.number,
'previous_port_no': previous_port_no,
'vid': pkt_meta.vlan.vid,
'eth_src': pkt_meta.eth_src,
'eth_dst': pkt_meta.eth_dst,
'eth_type': pkt_meta.eth_type,
'l3_src_ip': str(pkt_meta.l3_src),
'l3_dst_ip': str(pkt_meta.l3_dst)}
if stack_descr:
l2_learn_msg.update({'stack_descr': stack_descr})
self.notify({'L2_LEARN': l2_learn_msg})
return learn_flows
return []
[docs] def parse_rcv_packet(self, in_port, vlan_vid, eth_type, data, orig_len, pkt, eth_pkt, vlan_pkt):
"""Parse a received packet into a PacketMeta instance.
Args:
in_port (int): port packet was received on.
vlan_vid (int): VLAN VID of port packet was received on.
eth_type (int): Ethernet type of packet.
data (bytes): Raw packet data.
orig_len (int): Original length of packet.
pkt (ryu.lib.packet.packet): parsed packet received.
ekt_pkt (ryu.lib.packet.ethernet): parsed Ethernet header.
vlan_pkt (ryu.lib.packet.vlan): parsed VLAN Ethernet header.
Returns:
PacketMeta instance.
"""
eth_src = eth_pkt.src
eth_dst = eth_pkt.dst
vlan = None
if vlan_vid in self.dp.vlans:
vlan = self.dp.vlans[vlan_vid]
port = self.dp.ports[in_port]
pkt_meta = valve_packet.PacketMeta(
data, orig_len, pkt, eth_pkt, vlan_pkt, port, vlan, eth_src, eth_dst, eth_type)
if vlan_vid == self.dp.global_vlan:
vlan_vid = valve_packet.int_from_mac(pkt_meta.eth_dst)
vlan = self.dp.vlans.get(vlan_vid, None)
pkt_meta.vlan = vlan
if vlan is not None:
pkt_meta.eth_dst = vlan.faucet_mac
return pkt_meta
[docs] def update_config_metrics(self):
"""Update table names for configuration."""
self.metrics.reset_dpid(self.dp.base_prom_labels())
self._reset_dp_status()
# Map table ids to table names
tables = self.dp.tables.values()
table_id_to_name = {table.table_id: table.name for table in tables}
for table in tables:
table_id = table.table_id
next_tables = [table_id_to_name[t] for t in table.next_tables]
# Also add table miss destination as possible next table, if set
if table.table_config.miss_goto:
miss_table = table.table_config.miss_goto
if miss_table not in next_tables:
next_tables.append(miss_table)
self._set_var(
'faucet_config_table_names',
table_id,
labels=dict(self.dp.base_prom_labels(), table_name=table.name,
next_tables=",".join(next_tables)))
[docs] def update_metrics(self, now, updated_port=None, rate_limited=False):
"""Update Gauge/metrics."""
def _update_vlan(vlan, now, rate_limited):
if vlan.dyn_last_updated_metrics_sec and rate_limited:
if now - vlan.dyn_last_updated_metrics_sec < self.dp.metrics_rate_limit_sec:
return False
vlan_labels = dict(self.dp.base_prom_labels(), vlan=vlan.vid)
self._set_var('vlan_hosts_learned', vlan.hosts_count(), labels=vlan_labels)
self._set_var('vlan_learn_bans', vlan.dyn_learn_ban_count, labels=vlan_labels)
for ipv in vlan.ipvs():
self._set_var(
'vlan_neighbors',
vlan.neigh_cache_count_by_ipv(ipv),
labels=dict(vlan_labels, ipv=ipv))
return True
def _update_port(vlan, port):
port_vlan_labels = self._port_vlan_labels(port, vlan)
port_vlan_hosts_learned = port.hosts_count(vlans=[vlan])
self._set_port_var(
'port_learn_bans', port.dyn_learn_ban_count, port)
self._set_var(
'port_vlan_hosts_learned', port_vlan_hosts_learned, labels=port_vlan_labels)
highwater = self._port_highwater[vlan.vid][port.number]
stats_stale = vlan.dyn_host_cache_stats_stale.get(port.number, True)
# No change in hosts learned on this VLAN, don't re-export MACs.
if highwater == port_vlan_hosts_learned and not stats_stale:
return
if highwater > port_vlan_hosts_learned:
for i in range(port_vlan_hosts_learned, highwater + 1):
self._set_var('learned_macs', 0, dict(port_vlan_labels, n=i))
self._port_highwater[vlan.vid][port.number] = port_vlan_hosts_learned
port_vlan_hosts = port.hosts(vlans=[vlan])
assert port_vlan_hosts_learned == len(port_vlan_hosts)
# TODO: make MAC table updates less expensive.
for i, entry in enumerate(sorted(port_vlan_hosts)):
self._set_var('learned_macs', entry.eth_src_int, dict(port_vlan_labels, n=i))
vlan.dyn_host_cache_stats_stale[port.number] = False
if updated_port:
for vlan in updated_port.vlans():
if _update_vlan(vlan, now, rate_limited):
_update_port(vlan, updated_port)
vlan.dyn_last_updated_metrics_sec = now
else:
for vlan in self.dp.vlans.values():
if _update_vlan(vlan, now, rate_limited):
for port in vlan.get_ports():
_update_port(vlan, port)
vlan.dyn_last_updated_metrics_sec = now
def _non_vlan_rcv_packet(self, now, other_valves, pkt_meta):
self._inc_var('of_non_vlan_packet_ins')
if pkt_meta.port.lacp:
lacp_ofmsgs_by_valve = self.lacp_handler(now, pkt_meta, other_valves)
if lacp_ofmsgs_by_valve:
return lacp_ofmsgs_by_valve
# TODO: verify LLDP message (e.g. org-specific authenticator TLV)
return self.lldp_handler(now, pkt_meta, other_valves)
[docs] def router_rcv_packet(self, now, pkt_meta):
"""Process packets destined for router or run resolver.
Args:
now (float): current epoch time.
pkt_meta (PacketMeta): packet for control plane.
Returns:
list: OpenFlow messages.
"""
if not pkt_meta.vlan.faucet_vips:
return []
route_manager = self._route_manager_by_eth_type.get(
pkt_meta.eth_type, None)
if not (route_manager and route_manager.active):
return []
pkt_meta.reparse_ip()
if not pkt_meta.l3_pkt:
return []
control_plane_ofmsgs = self._control_plane_handler(
now, pkt_meta, route_manager)
ofmsgs = []
if control_plane_ofmsgs:
ofmsgs.extend(control_plane_ofmsgs)
else:
ofmsgs.extend(
route_manager.add_host_fib_route_from_pkt(now, pkt_meta))
# No CPN activity, run resolver.
ofmsgs.extend(
route_manager.resolve_gateways(
pkt_meta.vlan, now, resolve_all=False))
ofmsgs.extend(
route_manager.resolve_expire_hosts(
pkt_meta.vlan, now, resolve_all=False))
return ofmsgs
@staticmethod
def _stacked_valves(valves):
return {valve for valve in valves if valve.dp.stack_root_name}
def _vlan_rcv_packet(self, now, other_valves, pkt_meta):
"""Handle packet with VLAN tag across all Valves.
Args:
now (float): current epoch time.
other_valves (list): all Valves other than this one.
pkt_meta (PacketMeta): packet for control plane.
Returns:
dict: OpenFlow messages, if any by Valve.
"""
self._inc_var('of_vlan_packet_ins')
ban_rules = self.switch_manager.ban_rules(pkt_meta)
if ban_rules:
return {self: ban_rules}
def handle_pkt(valve, now, pkt_meta, other_valves):
ofmsgs = []
ofmsgs.extend(valve.learn_host(now, pkt_meta, other_valves))
ofmsgs.extend(valve.router_rcv_packet(now, pkt_meta))
if self.dp.stack_route_learning and not self.dp.is_stack_root():
# TODO: we will repeatedly spam the DP for each packet in.
# Should use learn_host() style rate limiting.
ofmsgs.extend(valve.router_learn_host(pkt_meta))
return ofmsgs
ofmsgs_by_valve = {}
stacked_other_valves = self._stacked_valves(other_valves)
all_stacked_valves = {self}.union(stacked_other_valves)
# TODO: generalize multi DP routing
if self.dp.stack_route_learning:
# TODO: multi DP routing requires learning from directly attached switch first.
if pkt_meta.port.stack:
peer_dp = pkt_meta.port.stack['dp']
if peer_dp.dyn_running:
faucet_macs = {pkt_meta.vlan.faucet_mac}.union(
{valve.dp.faucet_dp_mac for valve in all_stacked_valves})
# Must always learn FAUCET VIP, but rely on neighbor
# to learn other hosts first.
if pkt_meta.eth_src not in faucet_macs:
return {}
for valve in stacked_other_valves:
# TODO: does not handle pruning.
stack_port = valve.dp.shortest_path_port(self.dp.name)
valve_vlan = valve.dp.vlans.get(pkt_meta.vlan.vid, None)
if stack_port and valve_vlan:
valve_pkt_meta = copy.copy(pkt_meta)
valve_pkt_meta.vlan = valve_vlan
valve_pkt_meta.port = stack_port
valve_other_valves = all_stacked_valves - {valve}
ofmsgs_by_valve[valve] = handle_pkt(
valve, now, valve_pkt_meta, valve_other_valves)
ofmsgs_by_valve[self] = handle_pkt(
self, now, pkt_meta, other_valves)
return ofmsgs_by_valve
[docs] def rcv_packet(self, now, other_valves, pkt_meta):
"""Handle a packet from the dataplane (eg to re/learn a host).
The packet may be sent to us also in response to FAUCET
initiating IPv6 neighbor discovery, or ARP, to resolve
a nexthop.
Args:
other_valves (list): all Valves other than this one.
pkt_meta (PacketMeta): packet for control plane.
Returns:
dict: OpenFlow messages, if any by Valve.
"""
# TODO: expensive, even at non-debug level.
# self.logger.debug(
# 'Packet_in src:%s in_port:%d VLAN:%s' % (
# pkt_meta.eth_src,
# pkt_meta.port.number,
# pkt_meta.vlan))
if pkt_meta.vlan is None:
return self._non_vlan_rcv_packet(now, other_valves, pkt_meta)
return self._vlan_rcv_packet(now, other_valves, pkt_meta)
def _lacp_state_expire(self, now, _other_valves):
"""Expire controller state for LACP.
Args:
now (float): current epoch time.
_other_valves (list): all Valves other than this one.
Return:
dict: OpenFlow messages, if any by Valve.
"""
ofmsgs_by_valve = defaultdict(list)
for lag, ports_up in self.dp.lags_up().items():
for port in ports_up:
lacp_age = now - port.dyn_lacp_updated_time
if lacp_age > self.dp.lacp_timeout:
self.logger.info('LAG %s %s expired (age %u)' % (lag, port, lacp_age))
ofmsgs_by_valve[self].extend(self.lacp_update(
port, False, now=now, other_valves=_other_valves))
return ofmsgs_by_valve
[docs] def state_expire(self, now, other_valves):
"""Expire controller caches/state (e.g. hosts learned).
Args:
now (float): current epoch time.
other_valves (list): all Valves other than this one.
Return:
dict: OpenFlow messages, if any by Valve.
"""
ofmsgs_by_valve = defaultdict(list)
if self.dp.dyn_running:
ofmsgs_by_valve.update(self._lacp_state_expire(now, other_valves))
for vlan in self.dp.vlans.values():
expired_hosts = self.switch_manager.expire_hosts_from_vlan(vlan, now)
if not self.dp.idle_dst:
for entry in expired_hosts:
ofmsgs_by_valve[self].extend(
self.switch_manager.delete_host_from_vlan(entry.eth_src, vlan))
for entry in expired_hosts:
learn_labels = dict(self.dp.base_prom_labels(), vid=vlan.vid,
eth_src=entry.eth_src)
self._remove_var('learned_l2_port', labels=learn_labels)
self.notify(
{'L2_EXPIRE': {
'port_no': entry.port.number,
'vid': vlan.vid,
'eth_src': entry.eth_src}})
for route_manager in self._route_manager_by_ipv.values():
ofmsgs_by_valve[self].extend(route_manager.resolve_expire_hosts(vlan, now))
return ofmsgs_by_valve
def _pipeline_change(self):
def table_msgs(tfm_flow):
return {str(x) for x in tfm_flow.body}
if self._last_pipeline_flows:
_last_pipeline_flows = table_msgs(self._last_pipeline_flows[0])
_pipeline_flows = table_msgs(self._pipeline_flows()[0])
if _last_pipeline_flows != _pipeline_flows:
self.logger.info('pipeline change: %s' % str(
_last_pipeline_flows.difference(_pipeline_flows)))
return True
return False
def _apply_config_changes(self, new_dp, changes):
"""Apply any detected configuration changes.
Args:
new_dp: (DP): new dataplane configuration.
changes (tuple) of:
deleted_ports (set): deleted port numbers.
changed_ports (set): changed port numbers.
added_ports (set): added port numbers.
changed_acl_ports (set): changed ACL only port numbers.
deleted_vids (set): deleted VLAN IDs.
changed_vids (set): changed/added VLAN IDs.
all_ports_changed (bool): True if all ports changed.
all_meters_changed (bool): True if all meters changed.
deleted_meters: (set): deleted meter numbers.
changed_meters: (set): changed meter numbers.
added_meters: (set): added meter numbers.
Returns:
tuple:
cold_start (bool): whether cold starting.
ofmsgs (list): OpenFlow messages.
"""
(deleted_ports, changed_ports, added_ports, changed_acl_ports,
deleted_vids, changed_vids, all_ports_changed,
_, deleted_meters, added_meters, changed_meters) = changes
if self._pipeline_change():
self.logger.info('pipeline change')
self.dp_init(new_dp)
return True, []
if all_ports_changed:
self.logger.info('all ports changed')
self.dp_init(new_dp)
return True, []
all_up_port_nos = [
port for port in changed_ports
if port in self.dp.dyn_up_port_nos]
ofmsgs = []
# TODO: optimize for all meters being erased
if deleted_ports:
ofmsgs.extend(self.ports_delete(deleted_ports))
if deleted_vids:
deleted_vlans = [self.dp.vlans[vid] for vid in deleted_vids]
ofmsgs.extend(self.del_vlans(deleted_vlans))
if deleted_meters:
for meter_key in self.dp.meters.keys():
if meter_key in deleted_meters:
ofmsgs.append(valve_of.meterdel(
meter_id=self.dp.meters.get(meter_key).meter_id))
if changed_ports:
ofmsgs.extend(self.ports_delete(changed_ports))
if changed_meters:
for changed_meter in changed_meters:
for dp_meter_key in self.dp.meters.keys():
if (changed_meter == dp_meter_key) and (
new_dp.meters.get(changed_meter).meter_id != self.dp.meters.get(
changed_meter).meter_id):
ofmsgs.append(valve_of.meterdel(
meter_id=self.dp.meters.get(changed_meter).meter_id))
ofmsgs.append(valve_of.meteradd(
new_dp.meters.get(changed_meter).entry, command=0))
else:
ofmsgs.append(valve_of.meteradd(
new_dp.meters.get(changed_meter).entry, command=1))
if added_meters:
for added_meter in added_meters:
ofmsgs.append(valve_of.meteradd(
new_dp.meters.get(added_meter).entry, command=0))
self.dp_init(new_dp)
if changed_vids:
changed_vlans = [self.dp.vlans[vid] for vid in changed_vids]
# TODO: handle change versus add separately so can avoid delete first.
ofmsgs.extend(self.del_vlans(changed_vlans))
for vlan in changed_vlans:
vlan.reset_caches()
# The proceeding delete operation means we don't have to generate more deletes.
ofmsgs.extend(self.add_vlans(changed_vlans, cold_start=True))
if changed_ports:
ofmsgs.extend(self.ports_add(all_up_port_nos))
if added_ports:
ofmsgs.extend(self.ports_add(added_ports))
if self.acl_manager and changed_acl_ports:
for port_num in changed_acl_ports:
port = self.dp.ports[port_num]
ofmsgs.extend(self.acl_manager.cold_start_port(port))
ofmsgs.extend(self.pipeline.add_drop_spoofed_faucet_mac_rules())
return False, ofmsgs
[docs] def reload_config(self, _now, new_dp):
"""Reload configuration new_dp.
Following config changes are currently supported:
- Port config: support all available configs
(e.g. native_vlan, acl_in) & change operations
(add, delete, modify) a port
- ACL config:support any modification, currently reload all
rules belonging to an ACL
- VLAN config: enable, disable routing, etc...
Args:
now (float): current epoch time.
new_dp (DP): new dataplane configuration.
Returns:
ofmsgs (list): OpenFlow messages.
"""
cold_start, ofmsgs = self._apply_config_changes(
new_dp, self.dp.get_config_changes(self.logger, new_dp))
restart_type = None
if cold_start:
restart_type = 'cold'
if self.dp.dyn_running:
self.logger.info('forcing DP reconnection to ensure ports are synchronized')
ofmsgs = None
elif self.dp.dyn_running and ofmsgs:
restart_type = 'warm'
else:
ofmsgs = []
if restart_type is not None:
self._inc_var('faucet_config_reload_%s' % restart_type)
self.logger.info('%s starting' % restart_type)
self.notify({'CONFIG_CHANGE': {'restart_type': restart_type}})
return ofmsgs
def _warm_reconfig_port_native_vlans(self, port, new_dyn_dot1x_native_vlan):
ofmsgs = []
old_vlan = port.dyn_dot1x_native_vlan
ofmsgs.extend(self.switch_manager.del_port(port))
port.dyn_dot1x_native_vlan = new_dyn_dot1x_native_vlan
for vlan in (old_vlan,) + (port.dyn_dot1x_native_vlan, port.native_vlan):
if vlan is not None:
vlan.reset_ports(self.dp.ports.values())
ofmsgs.extend(self.switch_manager.update_vlan(vlan))
ofmsgs.extend(self.switch_manager.add_port(port))
return ofmsgs
[docs] def add_dot1x_native_vlan(self, port_num, vlan_name):
ofmsgs = []
port = self.dp.ports[port_num]
vlans = [vlan for vlan in self.dp.vlans.values() if vlan.name == vlan_name]
if vlans:
vlan = vlans[0]
ofmsgs.extend(self._warm_reconfig_port_native_vlans(port, vlan))
return ofmsgs
[docs] def del_dot1x_native_vlan(self, port_num):
ofmsgs = []
port = self.dp.ports[port_num]
if port.dyn_dot1x_native_vlan is not None:
ofmsgs.extend(self._warm_reconfig_port_native_vlans(port, None))
return ofmsgs
[docs] def router_vlan_for_ip_gw(self, vlan, ip_gw):
route_manager = self._route_manager_by_ipv[ip_gw.version]
return route_manager.router_vlan_for_ip_gw(vlan, ip_gw)
[docs] def add_route(self, vlan, ip_gw, ip_dst):
"""Add route to VLAN routing table."""
route_manager = self._route_manager_by_ipv[ip_dst.version]
return route_manager.add_route(vlan, ip_gw, ip_dst)
[docs] def del_route(self, vlan, ip_dst):
"""Delete route from VLAN routing table."""
route_manager = self._route_manager_by_ipv[ip_dst.version]
return route_manager.del_route(vlan, ip_dst)
[docs] def resolve_gateways(self, now, _other_valves):
"""Call route managers to re/resolve gateways.
Returns:
dict: OpenFlow messages, if any by Valve.
"""
ofmsgs = []
if self.dp.dyn_running:
for route_manager in self._route_manager_by_ipv.values():
for vlan in self.dp.vlans.values():
ofmsgs.extend(route_manager.resolve_gateways(vlan, now))
if ofmsgs:
return {self: ofmsgs}
return {}
[docs] def oferror(self, msg):
"""Correlate OFError message with flow we sent, if any.
Args:
msg (ryu.controller.ofp_event.EventOFPMsgBase): message from datapath.
"""
self._inc_var('of_errors')
orig_msgs = [orig_msg for orig_msg in self.recent_ofmsgs if orig_msg.xid == msg.xid]
error_txt = msg
if orig_msgs:
error_txt = '%s caused by %s' % (error_txt, orig_msgs[0])
error_type = 'UNKNOWN'
error_code = 'UNKNOWN'
try:
error_tuple = valve_of.OFERROR_TYPE_CODE[msg.type]
error_type = error_tuple[0]
error_code = error_tuple[1][msg.code]
except KeyError:
pass
self.logger.error('OFError type: %s code: %s %s' % (error_type, error_code, error_txt))
[docs] def prepare_send_flows(self, flow_msgs):
"""Prepare to send flows to datapath.
Args:
flow_msgs (list): OpenFlow messages to send.
"""
if flow_msgs is None:
return flow_msgs
reordered_flow_msgs = valve_of.valve_flowreorder(
flow_msgs, use_barriers=self.USE_BARRIERS)
self.ofchannel_log(reordered_flow_msgs)
self._inc_var('of_flowmsgs_sent', val=len(reordered_flow_msgs))
self.recent_ofmsgs.extend(reordered_flow_msgs)
return reordered_flow_msgs
[docs] def send_flows(self, ryu_dp, flow_msgs, now):
"""Send flows to datapath (or disconnect an OF session).
Args:
ryu_dp (ryu.controller.controller.Datapath): datapath.
flow_msgs (list): OpenFlow messages to send.
"""
def ryu_send_flows(local_flow_msgs):
for flow_msg in self.prepare_send_flows(local_flow_msgs):
flow_msg.datapath = ryu_dp
ryu_dp.send_msg(flow_msg)
if flow_msgs is None:
self.datapath_disconnect(now)
ryu_dp.close()
else:
ryu_send_flows(flow_msgs)
[docs] def flow_timeout(self, now, table_id, match):
"""Call flow timeout message handler:
Args:
now (float): current epoch time.
table_id (int): ID of table where flow was installed.
match (dict): match conditions for expired flow.
Returns:
list: OpenFlow messages, if any.
"""
return self.switch_manager.flow_timeout(now, table_id, match)
[docs] def get_config_dict(self):
"""Return datapath config as a dict for experimental API."""
return self.dp.get_config_dict()
[docs]class TfmValve(Valve):
"""Valve implementation that uses OpenFlow send table features messages."""
USE_OXM_IDS = True
MAX_TABLE_ID = 0
MIN_MAX_FLOWS = 0
FILL_REQ = True
def _pipeline_flows(self):
return [valve_of.table_features(
tfm_pipeline.load_tables(
self.dp, self, self.MAX_TABLE_ID, self.MIN_MAX_FLOWS,
self.USE_OXM_IDS, self.FILL_REQ))]
def _add_default_flows(self):
ofmsgs = self._pipeline_flows()
self._last_pipeline_flows = copy.deepcopy(ofmsgs)
ofmsgs.extend(super(TfmValve, self)._add_default_flows())
return ofmsgs
[docs]class OVSValve(Valve):
"""Valve implementation for OVS."""
USE_BARRIERS = False
[docs]class OVSTfmValve(TfmValve):
"""Valve implementation for OVS."""
# TODO: use OXMIDs acceptable to OVS.
# TODO: dynamically determine tables/flows
USE_BARRIERS = False
USE_OXM_IDS = False
MAX_TABLE_ID = 253
MIN_MAX_FLOWS = 1000000
[docs]class ArubaValve(TfmValve):
"""Valve implementation for Aruba."""
DEC_TTL = False
# Aruba does not like empty miss instructions even if not used.
FILL_REQ = False
def _delete_all_valve_flows(self):
ofmsgs = super(ArubaValve, self)._delete_all_valve_flows()
# Unreferenced group(s) from a previous config that used them,
# can steal resources from regular flowmods. Unconditionally
# delete all groups even if groups are not enabled to avoid this.
ofmsgs.append(self.dp.groups.delete_all())
return ofmsgs
[docs]class CiscoC9KValve(TfmValve):
"""Valve implementation for C9K."""
[docs]class AlliedTelesis(OVSValve):
"""Valve implementation for AT."""
DEC_TTL = False
[docs]class NoviFlowValve(Valve):
"""Valve implementation for NoviFlow with static pipeline."""
STATIC_TABLE_IDS = True
USE_BARRIERS = True
SUPPORTED_HARDWARE = {
'Generic': Valve,
'GenericTFM': TfmValve,
'Allied-Telesis': AlliedTelesis,
'Aruba': ArubaValve,
'CiscoC9K': CiscoC9KValve,
'Lagopus': OVSValve,
'Netronome': OVSValve,
'NoviFlow': NoviFlowValve,
'Open vSwitch': OVSValve,
'Open vSwitch TFM': OVSTfmValve,
'ZodiacFX': OVSValve,
'ZodiacGX': OVSValve,
}
[docs]def valve_factory(dp):
"""Return a Valve object based dp's hardware configuration field.
Args:
dp (DP): DP instance with the configuration for this Valve.
"""
if dp.hardware in SUPPORTED_HARDWARE:
return SUPPORTED_HARDWARE[dp.hardware]
return None