faucet.valve module

Implementation of Valve learning layer 2/3 switch.

class faucet.valve.AlliedTelesis(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.OVSValve

Valve implementation for AT.

DEC_TTL = False

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.ArubaValve(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.TfmValve

Valve implementation for Aruba.

DEC_TTL = False

FILL_REQ = False

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.CiscoC9KValve(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.TfmValve

Valve implementation for C9K.

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.NoviFlowValve(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.Valve

Valve implementation for NoviFlow with static pipeline.

STATIC_TABLE_IDS = True

USE_BARRIERS = True

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.OVSTfmValve(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.TfmValve

Valve implementation for OVS.

MAX_TABLE_ID = 253

MIN_MAX_FLOWS = 1000000

USE_BARRIERS = False

USE_OXM_IDS = False

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.OVSValve(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.Valve

Valve implementation for OVS.

USE_BARRIERS = False

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.TfmValve(dp, logname, metrics, notifier, dot1x)

Bases: faucet.valve.Valve

Valve implementation that uses OpenFlow send table features messages.

FILL_REQ = True

MAX_TABLE_ID = 0

MIN_MAX_FLOWS = 0

USE_OXM_IDS = True

acl_manager

dot1x

dp

flood_manager

host_manager

logger

logname

metrics

notifier

ofchannel_logger

pipeline

recent_ofmsgs

class faucet.valve.Valve(dp, logname, metrics, notifier, dot1x)

Bases: object

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.

DEC_TTL = True

GROUPS = True

STATIC_TABLE_IDS = False

USE_BARRIERS = True

acl_manager

add_dot1x_native_vlan(port_num, vlan_name)

add_route(vlan, ip_gw, ip_dst)

Add route to VLAN routing table.

add_vlan(vlan)

Configure a VLAN.

add_vlans(vlans)

advertise(now, _other_values)

Called periodically to advertise services (eg. IPv6 RAs).

close_logs()

Explicitly close any active loggers.

datapath_connect(now, discovered_up_ports)

Handle Ryu datapath connection event and provision pipeline.

Parameters

• now (float) – current epoch time.

• discovered_up_ports (set) – datapath port numbers that are up.

Returns

OpenFlow messages to send to datapath.

Return type

list

datapath_disconnect()

Handle Ryu datapath disconnection event.

del_dot1x_native_vlan(port_num)

del_route(vlan, ip_dst)

Delete route from VLAN routing table.

del_vlan(vlan)

Delete a configured VLAN.

del_vlans(vlans)

dot1x

dot1x_event(event_dict)

dp

dp_init(new_dp=None)

Initialize datapath state at connection/re/config time.

fast_advertise(now, _other_valves)

Called periodically to send LLDP/LACP packets.

fast_state_expire(now, other_valves)

Called periodically to verify the state of stack ports.

flood_manager

floods_to_root()

Return True if our dp floods (only) to root switch

flow_timeout(now, table_id, match)

Call flow timeout message handler:

Parameters

• now (float) – current epoch time.

• table_id (int) – ID of table where flow was installed.

• match (dict) – match conditions for expired flow.

Returns

OpenFlow messages, if any.

Return type

list

get_config_dict()

Return datapath config as a dict for experimental API.

get_tunnel_flowmods()

Returns flowmods for the tunnels

host_manager

lacp_down(port, cold_start=False, lacp_pkt=None)

Return OpenFlow messages when LACP is down on a port.

lacp_handler(now, pkt_meta)

Handle a LACP packet.

We are a currently a passive, non-aggregateable LACP partner.

Parameters

• now (float) – current epoch time.

• pkt_meta (PacketMeta) – packet for control plane.

Returns

OpenFlow messages, if any by Valve.

Return type

dict

lacp_up(port, now, lacp_pkt)

Return OpenFlow messages when LACP is up on a port.

learn_host(now, pkt_meta, other_valves)

Possibly learn a host on a port.

Parameters

• now (float) – current epoch time.

• pkt_meta (PacketMeta) – PacketMeta instance for packet received.

• other_valves (list) – all Valves other than this one.

Returns

OpenFlow messages, if any.

Return type

list

lldp_handler(now, pkt_meta, other_valves)

Handle an LLDP packet.

Parameters

pkt_meta (PacketMeta) – packet for control plane.

logger

logname

metrics

notifier

notify(event_dict)

Send an event notification.

ofchannel_log(ofmsgs)

Log OpenFlow messages in text format to debugging log.

ofchannel_logger

ofdescstats_handler(body)

Handle OF DP description.

oferror(msg)

Correlate OFError message with flow we sent, if any.

Parameters

msg (ryu.controller.ofp_event.EventOFPMsgBase) – message from datapath.

parse_pkt_meta(msg)

Parse OF packet-in message to PacketMeta.

parse_rcv_packet(in_port, vlan_vid, eth_type, data, orig_len, pkt, eth_pkt, vlan_pkt)

Parse a received packet into a PacketMeta instance.

Parameters

• 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.

pipeline

port_add(port_num)

Handle addition of a single port.

Parameters

port_num (list) – list of port numbers.

Returns

OpenFlow messages, if any.

Return type

list

port_delete(port_num)

Return flow messages that delete port from pipeline.

port_status_handler(port_no, reason, state, _other_valves)

Return OpenFlow messages responding to port operational status change.

ports_add(port_nums, cold_start=False, log_msg='up')

Handle the addition of ports.

Parameters

• port_num (list) – list of port numbers.

• cold_start (bool) – True if configuring datapath from scratch.

Returns

OpenFlow messages, if any.

Return type

list

ports_delete(port_nums, log_msg='down')

Handle the deletion of ports.

Parameters

port_nums (list) – list of port numbers.

Returns

OpenFlow messages, if any.

Return type

list

prepare_send_flows(flow_msgs)

Prepare to send flows to datapath.

Parameters

flow_msgs (list) – OpenFlow messages to send.

rate_limit_packet_ins(now)

Return True if too many packet ins this second.

rcv_packet(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.

Parameters

• other_valves (list) – all Valves other than this one.

• pkt_meta (PacketMeta) – packet for control plane.

Returns

OpenFlow messages, if any by Valve.

Return type

dict

recent_ofmsgs

reload_config(_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…

Parameters

• now (float) – current epoch time.

• new_dp (DP) – new dataplane configuration.

Returns

OpenFlow messages.

Return type

ofmsgs (list)

resolve_gateways(now, _other_valves)

Call route managers to re/resolve gateways.

Returns

OpenFlow messages, if any by Valve.

Return type

dict

router_learn_host(pkt_meta)

Add L3 forwarding rule.

Parameters

pkt_meta (PacketMeta) – PacketMeta instance for packet received.

Returns

OpenFlow messages, if any.

Return type

list

router_rcv_packet(now, pkt_meta)

Process packets destined for router or run resolver.

Parameters

• now (float) – current epoch time.

• pkt_meta (PacketMeta) – packet for control plane.

Returns

OpenFlow messages.

Return type

list

router_vlan_for_ip_gw(vlan, ip_gw)

send_flows(ryu_dp, flow_msgs)

Send flows to datapath (or disconnect an OF session).

Parameters

• ryu_dp (ryu.controller.controller.Datapath) – datapath.

• flow_msgs (list) – OpenFlow messages to send.

state_expire(now, other_valves)

Expire controller caches/state (e.g. hosts learned).

Parameters

• now (float) – current epoch time.

• other_valves (list) – all Valves other than this one.

Returns

OpenFlow messages, if any by Valve.

Return type

dict

switch_features(_msg)

Send configuration flows necessary for the switch implementation.

Parameters

msg (OFPSwitchFeatures) – msg sent from switch.

Vendor specific configuration should be implemented here.

update_config_metrics()

Update table names for configuration.

update_metrics(now, updated_port=None, rate_limited=False)

Update Gauge/metrics.

update_tunnel_flowrules()

Update tunnel ACL rules because the stack topology has changed

class faucet.valve.ValveLogger(logger, dp_id, dp_name)

Bases: object

Logger for a Valve that adds DP ID.

debug(log_msg)

Log debug level message.

error(log_msg)

Log error level message.

info(log_msg)

Log info level message.

warning(log_msg)

Log warning level message.

faucet.valve.valve_factory(dp)

Return a Valve object based dp’s hardware configuration field.

Parameters

dp (DP) – DP instance with the configuration for this Valve.