etri.sdn.controller.module.learningmac

Class OFMLearningMac

java.lang.Object

etri.sdn.controller.OFModule

etri.sdn.controller.module.learningmac.OFMLearningMac

public final class OFMLearningMac
extends OFModule

MAC Learning Module. Modified the original LearningMac class of Floodlight.

Author:

labry

Field Summary

Fields

Modifier and Type	Field and Description
private static int	APP_ID_BITS
private static int	APP_ID_SHIFT
private static short	HARD_TIMEOUT_DEFAULT
private static short	IDLE_TIMEOUT_DEFAULT
private static int	LEARNING_SWITCH_APP_ID
private static long	LEARNING_SWITCH_COOKIE
private static boolean	LEARNING_SWITCH_REVERSE_FLOW
private java.util.Map<IOFSwitch,java.util.Map<MacVlanPair,java.lang.Short>>	macVlanToSwitchPortMap Table to save learning result.
private static int	MAX_MACS_PER_SWITCH
private static short	PRIORITY_DEFAULT
private OFProtocol	protocol

Fields inherited from class etri.sdn.controller.OFModule

controller

Constructor Summary

Constructors

Constructor and Description
OFMLearningMac() Constructor to create learning mac module instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToPortMap(IOFSwitch sw, long mac, short vlan, short portVal) Adds a host to the MAC/VLAN->SwitchPort mapping
void	clearLearnedTable() Clears the MAC/VLAN -> SwitchPort map for all switches
void	clearLearnedTable(IOFSwitch sw) Clears the MAC/VLAN -> SwitchPort map for a single switch
java.lang.Short	getFromPortMap(IOFSwitch sw, long mac, short vlan) Get the port that a MAC/VLAN pair is associated with
OFModel[]	getModels() As this module have no model, it just returns null
java.util.Map<IOFSwitch,java.util.Map<MacVlanPair,java.lang.Short>>	getTable() Get all the mappings between MAC/VLAN to switch port.
boolean	handleDisconnect(Connection conn) Handle disconnection to a switch.
protected boolean	handleHandshakedEvent(Connection sw, MessageContext context) As this module does not process handshake event, it just returns true.
boolean	handleMessage(Connection conn, MessageContext context, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> outgoing) this method is a callback called by controller to request this module to handle an incoming message.
protected void	initialize() Initialize this module.
byte[]	longToBytes(long eth)
private boolean	processPacketInMessage(Connection conn, MessageContext context, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> out) Processes a OFPacketIn message.
protected void	removeFromPortMap(IOFSwitch sw, long mac, short vlan) Removes a host from the MAC/VLAN->SwitchPort mapping
private void	swap(org.openflow.protocol.interfaces.OFOxm ethSrcOxm, org.openflow.protocol.interfaces.OFOxm ethDstOxm)
private void	writeFlowMod(IOFSwitch sw, org.openflow.protocol.interfaces.OFFlowModCommand command, int bufferId, org.openflow.protocol.interfaces.OFMatch match, short outPort, java.util.List<org.openflow.protocol.OFMessage> out) Writes a OFFlowMod to a switch.
private void	writePacketOutForPacketIn(IOFSwitch sw, org.openflow.protocol.interfaces.OFPacketIn packetInMessage, org.openflow.protocol.OFPort egressPort, short getInputPort, java.util.List<org.openflow.protocol.OFMessage> out) Writes an OFPacketOut message to a switch.

Methods inherited from class etri.sdn.controller.OFModule

getController, 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

macVlanToSwitchPortMap

private java.util.Map<IOFSwitch,java.util.Map<MacVlanPair,java.lang.Short>> macVlanToSwitchPortMap

Table to save learning result.

protocol

private OFProtocol protocol

LEARNING_SWITCH_APP_ID

private static final int LEARNING_SWITCH_APP_ID

See Also:

Constant Field Values

APP_ID_BITS

private static final int APP_ID_BITS

See Also:

Constant Field Values

APP_ID_SHIFT

private static final int APP_ID_SHIFT

See Also:

Constant Field Values

LEARNING_SWITCH_COOKIE

private static final long LEARNING_SWITCH_COOKIE

See Also:

Constant Field Values

IDLE_TIMEOUT_DEFAULT

private static final short IDLE_TIMEOUT_DEFAULT

See Also:

Constant Field Values

HARD_TIMEOUT_DEFAULT

private static final short HARD_TIMEOUT_DEFAULT

See Also:

Constant Field Values

PRIORITY_DEFAULT

private static final short PRIORITY_DEFAULT

See Also:

Constant Field Values

LEARNING_SWITCH_REVERSE_FLOW

private static final boolean LEARNING_SWITCH_REVERSE_FLOW

See Also:

Constant Field Values

MAX_MACS_PER_SWITCH

private static final int MAX_MACS_PER_SWITCH

See Also:

Constant Field Values

Constructor Detail

OFMLearningMac

public OFMLearningMac()

Constructor to create learning mac module instance. It does nothing internally.

Method Detail

addToPortMap

protected void addToPortMap(IOFSwitch sw,
                long mac,
                short vlan,
                short portVal)

Adds a host to the MAC/VLAN->SwitchPort mapping

Parameters:

sw - The switch to add the mapping to

mac - The MAC address of the host to add

vlan - The VLAN that the host is on

portVal - The switchport that the host is on

removeFromPortMap

protected void removeFromPortMap(IOFSwitch sw,
                     long mac,
                     short vlan)

Removes a host from the MAC/VLAN->SwitchPort mapping

Parameters:

sw - The switch to remove the mapping from

mac - The MAC address of the host to remove

vlan - The VLAN that the host is on

getFromPortMap

public java.lang.Short getFromPortMap(IOFSwitch sw,
                             long mac,
                             short vlan)

Get the port that a MAC/VLAN pair is associated with

Parameters:

sw - The switch to get the mapping from

mac - The MAC address to get

vlan - The VLAN number to get

Returns:

The port the host is on

clearLearnedTable

public void clearLearnedTable()

Clears the MAC/VLAN -> SwitchPort map for all switches

clearLearnedTable

public void clearLearnedTable(IOFSwitch sw)

Clears the MAC/VLAN -> SwitchPort map for a single switch

Parameters:

sw - The switch to clear the mapping for

getTable

public java.util.Map<IOFSwitch,java.util.Map<MacVlanPair,java.lang.Short>> getTable()

Get all the mappings between MAC/VLAN to switch port.

Returns:

Map> object

writeFlowMod

private void writeFlowMod(IOFSwitch sw,
                org.openflow.protocol.interfaces.OFFlowModCommand command,
                int bufferId,
                org.openflow.protocol.interfaces.OFMatch match,
                short outPort,
                java.util.List<org.openflow.protocol.OFMessage> out)

Writes a OFFlowMod to a switch.

Parameters:

sw - The switch tow rite the flowmod to.

command - The FlowMod actions (add, delete, etc).

bufferId - The buffer ID if the switch has buffered the packet.

match - The OFMatch structure to write.

outPort - The switch port to output it to.

writePacketOutForPacketIn

private void writePacketOutForPacketIn(IOFSwitch sw,
                             org.openflow.protocol.interfaces.OFPacketIn packetInMessage,
                             org.openflow.protocol.OFPort egressPort,
                             short getInputPort,
                             java.util.List<org.openflow.protocol.OFMessage> out)

Writes an OFPacketOut message to a switch.

Parameters:

sw - The switch to write the PacketOut to.

packetInMessage - The corresponding PacketIn.

egressPort - The switchport to output the PacketOut.

handleMessage

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

this method is a callback called by controller to request this module to handle an incoming message.

Specified by:

handleMessage in class OFModule

Parameters:

conn - connection that the message was received

context - MessageContext object for the message.

msg - the received message

outgoing - list to put some outgoing messages to switch.

Returns:

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

handleDisconnect

public boolean handleDisconnect(Connection conn)

Handle disconnection to a switch. As this module does not handle the event, this method just return true.

Specified by:

handleDisconnect in class OFModule

Parameters:

conn - connection to a switch (just disconnected)

Returns:

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

processPacketInMessage

private boolean processPacketInMessage(Connection conn,
                             MessageContext context,
                             org.openflow.protocol.OFMessage msg,
                             java.util.List<org.openflow.protocol.OFMessage> out)

Processes a OFPacketIn message. If the switch has learned the MAC/VLAN to port mapping for the pair it will write a FlowMod for. If the mapping has not been learned the we will flood the packet.

Parameters:

conn - Connection object

context - MessageContext object

msg - OFMessage object (packet-in)

out - List of outgoing messages to switch

Returns:

true of correctly processed, false otherwise

swap

private void swap(org.openflow.protocol.interfaces.OFOxm ethSrcOxm,
        org.openflow.protocol.interfaces.OFOxm ethDstOxm)

longToBytes

public final byte[] longToBytes(long eth)

initialize

protected void initialize()

Initialize this module. As this module processes all PACKET_IN messages, it registers filter to receive those messages.

Specified by:

initialize in class OFModule

handleHandshakedEvent

protected boolean handleHandshakedEvent(Connection sw,
                            MessageContext context)

As this module does not process handshake event, it just returns true.

Specified by:

handleHandshakedEvent in class OFModule

Parameters:

sw - connection that the event has occurred

context - message context for the handshaking messages

Returns:

true

getModels

public OFModel[] getModels()

As this module have no model, it just returns null

Specified by:

getModels in class OFModule

Returns:

null