etri.sdn.controller.module.forwarding

Class ForwardingBase

java.lang.Object

etri.sdn.controller.OFModule

etri.sdn.controller.module.forwarding.ForwardingBase

All Implemented Interfaces:

IDeviceListener

Direct Known Subclasses:

Forwarding

public abstract class ForwardingBase
extends OFModule
implements IDeviceListener

Abstract base class for implementing a forwarding module. Forwarding is responsible for programming flows to a switch in response to a policy decision.

Author:

jshin

Field Summary

Fields

Modifier and Type	Field and Description
long	appCookie
TimedCache<java.lang.Long>	broadcastCache
protected boolean	broadcastCacheFeature
java.util.Comparator<SwitchPort>	clusterIdComparator
protected IDeviceService	deviceManager
static short	FLOWMOD_DEFAULT_HARD_TIMEOUT
static short	FLOWMOD_DEFAULT_IDLE_TIMEOUT
static int	FORWARDING_APP_ID
protected OFMessageDamper	messageDamper
protected static int	OFMESSAGE_DAMPER_CAPACITY
protected static int	OFMESSAGE_DAMPER_TIMEOUT
int	prime1
static int	prime2
(package private) OFProtocol	protocol
protected IRoutingService	routingEngine
protected ITopologyService	topology

Fields inherited from class etri.sdn.controller.OFModule

controller

Constructor Summary

Constructors

Constructor and Description
ForwardingBase()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	blockHost(SwitchPort sw_tup, long host_mac, short hardTimeout, long cookie) Creates a flow mod to block the packet based on the given MAC address and the source switch.
void	deviceAdded(IDevice device) Called when a new Device is found.
void	deviceIPV4AddrChanged(IDevice device) Called when a network address has been added or remove from a device.
void	deviceMoved(IDevice device) Called when a Device has moved to a new location on the network.
void	deviceRemoved(IDevice device) Called when a Device is removed, this typically occurs when the port the Device is attached to goes down, or the switch it is attached to is removed.
void	deviceVlanChanged(IDevice device) Called when a VLAN tag for the device has been added or removed.
protected int	getInputPort(org.openflow.protocol.interfaces.OFPacketIn pi)
protected boolean	handleDisconnect(Connection conn) Process the disconnection event from a switch.
protected boolean	handleHandshakedEvent(Connection sw, MessageContext context) An abstract method that all subclasses should implement.
protected boolean	handleMessage(Connection conn, MessageContext cntx, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> outgoing) Initializes this module.
void	initialize() Adds a listener for device manager and registers for PacketIns and initializes data structure.
protected boolean	isInBroadcastCache(Connection conn, org.openflow.protocol.interfaces.OFPacketIn pi, MessageContext cntx) Updates the broadcast cache of the switch.
protected boolean	isInSwitchBroadcastCache(Connection conn, org.openflow.protocol.interfaces.OFPacketIn pi, MessageContext cntx) Updates the broadcast cache of the switch.
void	packetOutMultiPort(byte[] packetData, Connection conn, short inPort, java.util.Set<java.lang.Integer> outPorts, MessageContext cntx) Writes packet-out message to switch with output actions to one or more output ports with inPort/outPorts passed in.
void	packetOutMultiPort(IPacket packet, Connection conn, short inPort, java.util.Set<java.lang.Integer> outPorts, MessageContext cntx) Accepts an IPacket instead of raw packet data.
void	packetOutMultiPort(org.openflow.protocol.interfaces.OFPacketIn pi, Connection conn, short inPort, java.util.Set<java.lang.Integer> outPorts, MessageContext cntx) Accepts a PacketIn instead of raw packet data.
abstract boolean	processPacketInMessage(Connection conn, org.openflow.protocol.interfaces.OFPacketIn pi, IRoutingDecision decision, MessageContext cntx) All subclasses must define this function if they want any specific forwarding action.
void	pushPacket(Connection conn, IPacket packet, IOFSwitch sw, int bufferId, short inPort, short outPort, MessageContext cntx) Pushes a packet-out to a switch.
protected void	pushPacket(Connection conn, org.openflow.protocol.interfaces.OFMatch match, org.openflow.protocol.interfaces.OFPacketIn pi, int outport, MessageContext cntx) Pushes a packet-out to a switch.
boolean	pushRoute(Connection conn, Route route, org.openflow.protocol.interfaces.OFMatch match, java.lang.Integer wildcard_hints, org.openflow.protocol.interfaces.OFPacketIn pi, long pinSwitch, long cookie, MessageContext cntx, boolean reqeustFlowRemovedNotifn, boolean doFlush, org.openflow.protocol.interfaces.OFFlowModCommand flowModCommand) Pushes routes from back to front.
protected org.openflow.protocol.interfaces.OFMatch	wildcard(org.openflow.protocol.interfaces.OFMatch match, IOFSwitch sw, java.lang.Integer wildcard_hints) Sets wildcards if wildcard_hints is null.

Methods inherited from class etri.sdn.controller.OFModule

getController, getModels, getModule, init, processDisconnect, processHandshakeFinished, processMessage, registerFilter, registerModule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFMESSAGE_DAMPER_CAPACITY

protected static int OFMESSAGE_DAMPER_CAPACITY

OFMESSAGE_DAMPER_TIMEOUT

protected static int OFMESSAGE_DAMPER_TIMEOUT

FLOWMOD_DEFAULT_IDLE_TIMEOUT

public static short FLOWMOD_DEFAULT_IDLE_TIMEOUT

FLOWMOD_DEFAULT_HARD_TIMEOUT

public static short FLOWMOD_DEFAULT_HARD_TIMEOUT

deviceManager

protected IDeviceService deviceManager

routingEngine

protected IRoutingService routingEngine

topology

protected ITopologyService topology

messageDamper

protected OFMessageDamper messageDamper

protocol

OFProtocol protocol

broadcastCacheFeature

protected boolean broadcastCacheFeature

prime1

public final int prime1

See Also:

Constant Field Values

prime2

public static final int prime2

See Also:

Constant Field Values

broadcastCache

public TimedCache<java.lang.Long> broadcastCache

FORWARDING_APP_ID

public static final int FORWARDING_APP_ID

See Also:

Constant Field Values

appCookie

public long appCookie

clusterIdComparator

public java.util.Comparator<SwitchPort> clusterIdComparator

Constructor Detail

ForwardingBase

public ForwardingBase()

Method Detail

initialize

public void initialize()

Adds a listener for device manager and registers for PacketIns and initializes data structure.

Specified by:

initialize in class OFModule

handleHandshakedEvent

protected boolean handleHandshakedEvent(Connection sw,
                            MessageContext context)

Description copied from class: OFModule

An abstract method that all subclasses should implement. This method is called after FEATURE-REQUEST and FEATURE-REPLY is correct exchanged, by OFModule.processHandshakeFinished(Connection, MessageContext). Normally, most of modules have very simple implementation for this method, only returning true.

Specified by:

handleHandshakedEvent in class OFModule

Parameters:

sw - connection that the event has occurred

context - message context for the handshaking messages

Returns:

true is returned when the event has been correctly processed. false otherwise.

getInputPort

protected int getInputPort(org.openflow.protocol.interfaces.OFPacketIn pi)

handleMessage

protected boolean handleMessage(Connection conn,
                    MessageContext cntx,
                    org.openflow.protocol.OFMessage msg,
                    java.util.List<org.openflow.protocol.OFMessage> outgoing)

Initializes this module.

Specified by:

handleMessage in class OFModule

Parameters:

conn - the connection to switch

cntx - the MessageContext

msg - the OFMessage to handle

outgoing -

Returns:

true

processPacketInMessage

public abstract boolean processPacketInMessage(Connection conn,
                             org.openflow.protocol.interfaces.OFPacketIn pi,
                             IRoutingDecision decision,
                             MessageContext cntx)

All subclasses must define this function if they want any specific forwarding action.

Parameters:

conn - the connection that the packet came in from

pi - the packet that came in

decision - any decision made by a policy engine

cntx - the MessageContext

handleDisconnect

protected boolean handleDisconnect(Connection conn)

Description copied from class: OFModule

Process the disconnection event from a switch. This callback method is called by OFModule.processDisconnect(Connection). All subclasses of OFModule should implement this method.

Specified by:

handleDisconnect in class OFModule

Parameters:

conn - connection that the event has occurred

Returns:

true if the event has been correctly processed. false otherwise.

pushRoute

public boolean pushRoute(Connection conn,
                Route route,
                org.openflow.protocol.interfaces.OFMatch match,
                java.lang.Integer wildcard_hints,
                org.openflow.protocol.interfaces.OFPacketIn pi,
                long pinSwitch,
                long cookie,
                MessageContext cntx,
                boolean reqeustFlowRemovedNotifn,
                boolean doFlush,
                org.openflow.protocol.interfaces.OFFlowModCommand flowModCommand)

Pushes routes from back to front.

Parameters:

conn - the connection to switch

route - a route to push

match - openFlow fields to match on

wildcard_hints - wildcard information as integer

pi - packetin

pinSwitch - the switch of packetin

cookie - the cookie to set in each flow_mod

cntx - the MessageContext

reqeustFlowRemovedNotifn - true when the switch would send a flow mod removal notification when the flow mod expires

doFlush - true when the flow mod would be immediately written to the switch

flowModCommand - flow mod. command to use, e.g. OFFlowMod.OFPFC_ADD, OFFlowMod.OFPFC_MODIFY etc.

Returns:

true if the source switch is included in this route

wildcard

protected org.openflow.protocol.interfaces.OFMatch wildcard(org.openflow.protocol.interfaces.OFMatch match,
                                                IOFSwitch sw,
                                                java.lang.Integer wildcard_hints)

Sets wildcards if wildcard_hints is null.

Parameters:

match - the OFMatch

sw - the switch instance

wildcard_hints - wildcard information as integer

Returns:

a clone of OFMatch instance

pushPacket

protected void pushPacket(Connection conn,
              org.openflow.protocol.interfaces.OFMatch match,
              org.openflow.protocol.interfaces.OFPacketIn pi,
              int outport,
              MessageContext cntx)

Pushes a packet-out to a switch. The assumption here is that the packet-in was also generated from the same switch. Thus, if the input port of the packet-in and the outport are the same, the function will not push the packet-out.

Parameters:

conn - the connection to the switch that generated the packet-in, and from which packet-out is sent

match - the OFMatch

pi - packetin

outport - the output port

cntx - the MessageContext

pushPacket

public void pushPacket(Connection conn,
              IPacket packet,
              IOFSwitch sw,
              int bufferId,
              short inPort,
              short outPort,
              MessageContext cntx)

Pushes a packet-out to a switch. If bufferId != OFP_NO_BUFFER we assume that the packetOut switch is the same as the packetIn switch and we will use the bufferId. Caller needs to make sure that inPort and outPort differs.

Parameters:

conn - the connection to switch

packet - a packet data to send

sw - the switch from which packet-out is sent

bufferId - the bufferId

inPort - the input port

outPort - the output port

cntx - the MessageContext

packetOutMultiPort

public void packetOutMultiPort(byte[] packetData,
                      Connection conn,
                      short inPort,
                      java.util.Set<java.lang.Integer> outPorts,
                      MessageContext cntx)

Writes packet-out message to switch with output actions to one or more output ports with inPort/outPorts passed in.

Parameters:

packetData - the packet to write

conn - the connection to switch

inPort - input port

outPorts - output port

cntx - the MessageContext

packetOutMultiPort

public void packetOutMultiPort(org.openflow.protocol.interfaces.OFPacketIn pi,
                      Connection conn,
                      short inPort,
                      java.util.Set<java.lang.Integer> outPorts,
                      MessageContext cntx)

Accepts a PacketIn instead of raw packet data. Note that the inPort and switch can be different than the packet in switch/port.

Parameters:

pi - packetin

conn - the connection to switch

inPort - the input port

outPorts - a set of output port

cntx - the MessageContext

See Also:

packetOutMultiPort(byte[], etri.sdn.controller.protocol.io.Connection, short, java.util.Set<java.lang.Integer>, etri.sdn.controller.MessageContext)

packetOutMultiPort

public void packetOutMultiPort(IPacket packet,
                      Connection conn,
                      short inPort,
                      java.util.Set<java.lang.Integer> outPorts,
                      MessageContext cntx)

Accepts an IPacket instead of raw packet data. Note that the inPort and switch can be different than the packet in switch/port.

Parameters:

packet - a packet data to send

conn - the connection to switch

inPort - the input port

outPorts - a set of output port

cntx - the MessageContext

See Also:

packetOutMultiPort(byte[], etri.sdn.controller.protocol.io.Connection, short, java.util.Set<java.lang.Integer>, etri.sdn.controller.MessageContext)

isInBroadcastCache

protected boolean isInBroadcastCache(Connection conn,
                         org.openflow.protocol.interfaces.OFPacketIn pi,
                         MessageContext cntx)

Updates the broadcast cache of the switch.

Parameters:

conn - the connection to switch

pi - packetin

cntx - the MessageContext

Returns:

true if successfully updated, false otherwise

isInSwitchBroadcastCache

protected boolean isInSwitchBroadcastCache(Connection conn,
                               org.openflow.protocol.interfaces.OFPacketIn pi,
                               MessageContext cntx)

Updates the broadcast cache of the switch.

Parameters:

conn - the connection to switch

pi - packetin

cntx - the MessageContext

Returns:

true if successfully updated, false otherwise

blockHost

public boolean blockHost(SwitchPort sw_tup,
                long host_mac,
                short hardTimeout,
                long cookie)

Creates a flow mod to block the packet based on the given MAC address and the source switch.

Parameters:

sw_tup - the input port number

host_mac - the MAC address to block

hardTimeout - a timeout value

cookie - the cookie to set in each flow_mod

Returns:

true if successfully created, false otherwise

deviceAdded

public void deviceAdded(IDevice device)

Description copied from interface: IDeviceListener

Called when a new Device is found.

Specified by:

deviceAdded in interface IDeviceListener

Parameters:

device - the device that changed

deviceRemoved

public void deviceRemoved(IDevice device)

Description copied from interface: IDeviceListener

Called when a Device is removed, this typically occurs when the port the Device is attached to goes down, or the switch it is attached to is removed.

Specified by:

deviceRemoved in interface IDeviceListener

Parameters:

device - the device that changed

deviceMoved

public void deviceMoved(IDevice device)

Description copied from interface: IDeviceListener

Called when a Device has moved to a new location on the network. Note that either the switch or the port or both has changed.

Specified by:

deviceMoved in interface IDeviceListener

Parameters:

device - the device that changed

deviceIPV4AddrChanged

public void deviceIPV4AddrChanged(IDevice device)

Description copied from interface: IDeviceListener

Called when a network address has been added or remove from a device.

Specified by:

deviceIPV4AddrChanged in interface IDeviceListener

Parameters:

device - the device that changed

deviceVlanChanged

public void deviceVlanChanged(IDevice device)

Description copied from interface: IDeviceListener

Called when a VLAN tag for the device has been added or removed.

Specified by:

deviceVlanChanged in interface IDeviceListener

Parameters:

device - the device that changed