etri.sdn.controller.module.devicemanager

Class OFMDeviceManager

java.lang.Object

etri.sdn.controller.OFModule

etri.sdn.controller.module.devicemanager.OFMDeviceManager

All Implemented Interfaces:

IInfoProvider, IListener<org.openflow.protocol.OFType>, IService, IDeviceService, IEntityClassListener, IFlowReconcileListener, ITopologyListener

public class OFMDeviceManager
extends OFModule
implements IDeviceService, ITopologyListener, IEntityClassListener, IInfoProvider, IFlowReconcileListener

This class implements the device manager module.

Modified the original DeviceManagerImpl class of Floodlight.

Author:

bjlee, jshin

Nested Class Summary

Nested classes/interfaces inherited from interface etri.sdn.controller.module.devicemanager.IDeviceService

IDeviceService.DeviceField

Nested classes/interfaces inherited from interface etri.sdn.controller.IListener

IListener.Command

Field Summary

Fields

Modifier and Type	Field and Description
private Devices	devices All the devices that you want.
private static int	ENTITY_CLEANUP_INTERVAL Time in seconds between cleaning up old entities/devices
private static int	ENTITY_TIMEOUT Time in milliseconds before entities will expire
private IEntityClassifierService	entityClassifier
private static IEntityClassifierService	entityClassifierServiceCache
private static OFMDeviceManager	ofmDeviceManagerCache
private ITopologyService	topology
private static ITopologyService	topologyServiceCache

Fields inherited from class etri.sdn.controller.OFModule

controller

Constructor Summary

Constructors

Constructor and Description
OFMDeviceManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addIndex(boolean perClass, java.util.EnumSet<IDeviceService.DeviceField> keyFields) Creates an index over a set of fields.
void	addListener(IDeviceListener listener) Adds a listener to listen for IDeviceManagerServices notifications.
void	addSuppressAPs(long swId, short port) Specifies points in the network where attachment points are not to be learned.
private void	cleanupEntities() Cleans up expired entities/devices.
void	entityClassChanged(java.util.Set<java.lang.String> entityClassNames) Processes entity classes change event.
IDevice	findDestDevice(IDevice source, long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address) Gets a destination device using entity fields that corresponds with the given source device.
IDevice	findDevice(long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Searches for a device exactly matching the provided device fields.
java.util.Collection<? extends IDevice>	getAllDevices() Gets an unmodifiable collection view over all devices currently known.
private Entity	getDestEntityFromPacket(Ethernet eth) Gets a (partial) entity for the destination from the packet.
IDevice	getDevice(java.lang.Long deviceKey) Gets the device with the given device key.
static IEntityClassifierService	getEntityClassifierServiceRef()
java.util.Map<java.lang.String,java.lang.Object>	getInfo(java.lang.String type) Called when rest API requests information of a particular type
OFModel[]	getModels() returns the array of all OFModel objects associated with this module.
java.lang.String	getName() The name assigned to this listener
static OFMDeviceManager	getRef()
private Entity	getSourceEntityFromPacket(Ethernet eth, long swdpid, int port) Parses an entity from an Ethernet packet.
private int	getSrcNwAddr(Ethernet eth, long dlAddr) Gets IP address from packet if the packet is either an ARP a DHCP packet.
ITopologyService	getTopologyService() Returns the reference of the topology service.
static ITopologyService	getTopologyServiceRef()
protected boolean	handleDisconnect(Connection conn) Process the disconnection event from a switch.
protected boolean	handleHandshakedEvent(Connection conn, MessageContext context) An abstract method that all subclasses should implement.
protected boolean	handleMessage(Connection conn, MessageContext context, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> outgoing) Handle incoming messages that pass the test of filters.
protected void	initialize() Initializes this module.
boolean	isCallbackOrderingPostreq(org.openflow.protocol.OFType type, java.lang.String name) Check if the module called name is a callback ordering post-requisite for this module.
boolean	isCallbackOrderingPrereq(org.openflow.protocol.OFType type, java.lang.String name) Check if the module called name is a callback ordering prerequisite for this module.
private boolean	processPacketInMessage(IOFSwitch sw, org.openflow.protocol.OFPacketIn pi, MessageContext cntx)
java.util.Iterator<Device>	queryClassByEntity(IEntityClass clazz, java.util.EnumSet<IDeviceService.DeviceField> keyFields, Entity entity)
java.util.Iterator<? extends IDevice>	queryClassDevices(IDevice reference, java.lang.Long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Finds devices that match the provided query.
java.util.Iterator<? extends IDevice>	queryDevices(java.lang.Long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Finds devices that match the provided query.
IListener.Command	reconcileFlows(java.util.ArrayList<OFMatchReconcile> ofmRcList) Given an input OFMatch, this method applies the policy of the reconciler and returns a the same input OFMatch structure modified.
void	removeSuppressAPs(long swId, short port) Removes setting of points in the network where attachment points are not to be learned.
void	topologyChanged() Happens when the switch clusters are recomputed

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

ENTITY_TIMEOUT

private static final int ENTITY_TIMEOUT

Time in milliseconds before entities will expire

See Also:

Constant Field Values

ENTITY_CLEANUP_INTERVAL

private static final int ENTITY_CLEANUP_INTERVAL

Time in seconds between cleaning up old entities/devices

See Also:

Constant Field Values

topology

private ITopologyService topology

entityClassifier

private IEntityClassifierService entityClassifier

devices

private Devices devices

All the devices that you want.

See Also:

Devices

topologyServiceCache

private static ITopologyService topologyServiceCache

entityClassifierServiceCache

private static IEntityClassifierService entityClassifierServiceCache

ofmDeviceManagerCache

private static OFMDeviceManager ofmDeviceManagerCache

Constructor Detail

OFMDeviceManager

public OFMDeviceManager()

Method Detail

getTopologyServiceRef

public static ITopologyService getTopologyServiceRef()

getEntityClassifierServiceRef

public static IEntityClassifierService getEntityClassifierServiceRef()

getRef

public static OFMDeviceManager getRef()

initialize

protected void initialize()

Initializes this module.

Specified by:

initialize in class OFModule

cleanupEntities

private void cleanupEntities()

Cleans up expired entities/devices.

handleHandshakedEvent

protected boolean handleHandshakedEvent(Connection conn,
                            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:

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

handleMessage

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

Description copied from class: OFModule

Handle incoming messages that pass the test of filters. All subclasses of OFModule must implement this method. This method is called by OFModule.processMessage(Connection, MessageContext, OFMessage, List).

Specified by:

handleMessage in class OFModule

Parameters:

conn - connection that the message has arrived

context - message context for the message

msg - the actual message object

outgoing - responses for the message arrived, which is filled by the handleMessage implementation

Returns:

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

processPacketInMessage

private boolean processPacketInMessage(IOFSwitch sw,
                             org.openflow.protocol.OFPacketIn pi,
                             MessageContext cntx)

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.

getSourceEntityFromPacket

private Entity getSourceEntityFromPacket(Ethernet eth,
                               long swdpid,
                               int port)

Parses an entity from an Ethernet packet.

Parameters:

eth - the packet to parse

swdpid - the switch on which the packet arrived

port - the original packetin

Returns:

the entity from the packet

getSrcNwAddr

private int getSrcNwAddr(Ethernet eth,
               long dlAddr)

Gets IP address from packet if the packet is either an ARP a DHCP packet.

Parameters:

eth - the Ethernet packet

dlAddr - the Ethernet address

Returns:

the source IP address

getDestEntityFromPacket

private Entity getDestEntityFromPacket(Ethernet eth)

Gets a (partial) entity for the destination from the packet.

Parameters:

eth - the Ethernet packet

Returns:

the entity for the destination

getTopologyService

public ITopologyService getTopologyService()

Returns the reference of the topology service.

Returns:

the reference of the topology service

queryClassByEntity

public java.util.Iterator<Device> queryClassByEntity(IEntityClass clazz,
                                            java.util.EnumSet<IDeviceService.DeviceField> keyFields,
                                            Entity entity)

getDevice

public IDevice getDevice(java.lang.Long deviceKey)

Description copied from interface: IDeviceService

Gets the device with the given device key.

Specified by:

getDevice in interface IDeviceService

Parameters:

deviceKey - the key to search for

Returns:

the device associated with the key, or null if no such device

See Also:

IDevice.getDeviceKey()

findDevice

public IDevice findDevice(long macAddress,
                 java.lang.Short vlan,
                 java.lang.Integer ipv4Address,
                 java.lang.Long switchDPID,
                 java.lang.Integer switchPort)
                   throws java.lang.IllegalArgumentException

Description copied from interface: IDeviceService

Searches for a device exactly matching the provided device fields. This is the same lookup process that is used for packet_in processing and device learning. Thus, findDevice() can be used to match flow entries from switches to devices.

Only the key fields as defined by the IEntityClassifierService will be important in this search. All key fields MUST be supplied. IDeviceService.queryDevices(java.lang.Long, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Integer) might be more appropriate!

Specified by:

findDevice in interface IDeviceService

Parameters:

macAddress - The MAC address

vlan - the VLAN. Null means no VLAN and is valid even if VLAN is a key field.

ipv4Address - the ipv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

an IDevice or null if no device is found.

Throws:

java.lang.IllegalArgumentException - if not all key fields of the current IEntityClassifierService are specified.

findDestDevice

public IDevice findDestDevice(IDevice source,
                     long macAddress,
                     java.lang.Short vlan,
                     java.lang.Integer ipv4Address)
                       throws java.lang.IllegalArgumentException

Description copied from interface: IDeviceService

Gets a destination device using entity fields that corresponds with the given source device. The source device is important since there could be ambiguity in the destination device without the attachment point information.

Specified by:

findDestDevice in interface IDeviceService

Parameters:

source - the source device. The returned destination will be in the same entity class as the source.

macAddress - The MAC address for the destination

vlan - the VLAN if available

ipv4Address - The IP address if available.

Returns:

an IDevice or null if no device is found.

Throws:

java.lang.IllegalArgumentException - if not all key fields of the source's IEntityClass are specified.

See Also:

IDeviceService.findDevice(long, Short, Integer, Long, Integer)

getAllDevices

public java.util.Collection<? extends IDevice> getAllDevices()

Description copied from interface: IDeviceService

Gets an unmodifiable collection view over all devices currently known.

Specified by:

getAllDevices in interface IDeviceService

Returns:

the collection of all devices

addIndex

public void addIndex(boolean perClass,
            java.util.EnumSet<IDeviceService.DeviceField> keyFields)

Description copied from interface: IDeviceService

Creates an index over a set of fields. This allows efficient lookup of devices when querying using the indexed set of specified fields. The index must be registered before any device learning takes place, or it may be incomplete. It's OK if this is called multiple times with the same fields; only one index will be created for each unique set of fields.

Specified by:

addIndex in interface IDeviceService

Parameters:

perClass - set to true if the index should be maintained for each entity class separately.

keyFields - the set of fields on which to index

queryDevices

public java.util.Iterator<? extends IDevice> queryDevices(java.lang.Long macAddress,
                                                 java.lang.Short vlan,
                                                 java.lang.Integer ipv4Address,
                                                 java.lang.Long switchDPID,
                                                 java.lang.Integer switchPort)

Description copied from interface: IDeviceService

Finds devices that match the provided query. Any fields that are null will not be included in the query. If there is an index for the query, then it will be performed efficiently using the index. Otherwise, there will be a full scan of the device list.

Specified by:

queryDevices in interface IDeviceService

Parameters:

macAddress - The MAC address

vlan - the VLAN

ipv4Address - the ipv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

an iterator over a set of devices matching the query

queryClassDevices

public java.util.Iterator<? extends IDevice> queryClassDevices(IDevice reference,
                                                      java.lang.Long macAddress,
                                                      java.lang.Short vlan,
                                                      java.lang.Integer ipv4Address,
                                                      java.lang.Long switchDPID,
                                                      java.lang.Integer switchPort)

Description copied from interface: IDeviceService

Finds devices that match the provided query. Only the index for the class of the specified reference device will be searched. Any fields that are null will not be included in the query. If there is an index for the query, then it will be performed efficiently using the index. Otherwise, there will be a full scan of the device list.

Specified by:

queryClassDevices in interface IDeviceService

Parameters:

reference - The reference device to refer to when finding entity classes.

macAddress - The MAC address

vlan - the VLAN

ipv4Address - the ipv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

an iterator over a set of devices matching the query

addListener

public void addListener(IDeviceListener listener)

Description copied from interface: IDeviceService

Adds a listener to listen for IDeviceManagerServices notifications.

Specified by:

addListener in interface IDeviceService

Parameters:

listener - The listener that wants the notifications

addSuppressAPs

public void addSuppressAPs(long swId,
                  short port)

Description copied from interface: IDeviceService

Specifies points in the network where attachment points are not to be learned.

Specified by:

addSuppressAPs in interface IDeviceService

Parameters:

swId - a switchid

port - a port number

removeSuppressAPs

public void removeSuppressAPs(long swId,
                     short port)

Description copied from interface: IDeviceService

Removes setting of points in the network where attachment points are not to be learned.

Specified by:

removeSuppressAPs in interface IDeviceService

Parameters:

swId - a switchid

port - a port number

topologyChanged

public void topologyChanged()

Description copied from interface: ITopologyListener

Happens when the switch clusters are recomputed

Specified by:

topologyChanged in interface ITopologyListener

entityClassChanged

public void entityClassChanged(java.util.Set<java.lang.String> entityClassNames)

Description copied from interface: IEntityClassListener

Processes entity classes change event.

Specified by:

entityClassChanged in interface IEntityClassListener

Parameters:

entityClassNames - A set of entity classes changed

getInfo

public java.util.Map<java.lang.String,java.lang.Object> getInfo(java.lang.String type)

Description copied from interface: IInfoProvider

Called when rest API requests information of a particular type

Specified by:

getInfo in interface IInfoProvider

Returns:

getName

public java.lang.String getName()

Description copied from interface: IListener

The name assigned to this listener

Specified by:

getName in interface IListener<org.openflow.protocol.OFType>

Returns:

String object which is the name of the listener

isCallbackOrderingPrereq

public boolean isCallbackOrderingPrereq(org.openflow.protocol.OFType type,
                               java.lang.String name)

Description copied from interface: IListener

Check if the module called name is a callback ordering prerequisite for this module. In other words, if this function returns true for the given name, then this message listener will be called after that message listener.

Specified by:

isCallbackOrderingPrereq in interface IListener<org.openflow.protocol.OFType>

Parameters:

type - the message type to which this applies

name - the name of the module

Returns:

whether name is a prerequisite.

isCallbackOrderingPostreq

public boolean isCallbackOrderingPostreq(org.openflow.protocol.OFType type,
                                java.lang.String name)

Description copied from interface: IListener

Check if the module called name is a callback ordering post-requisite for this module. In other words, if this function returns true for the given name, then this message listener will be called before that message listener.

Specified by:

isCallbackOrderingPostreq in interface IListener<org.openflow.protocol.OFType>

Parameters:

type - the message type to which this applies

name - the name of the module

Returns:

whether name is a post-requisite.

reconcileFlows

public IListener.Command reconcileFlows(java.util.ArrayList<OFMatchReconcile> ofmRcList)

Description copied from interface: IFlowReconcileListener

Given an input OFMatch, this method applies the policy of the reconciler and returns a the same input OFMatch structure modified. Additional OFMatches, if needed, are returned in OFMatch-list. All the OFMatches are assumed to have "PERMIT" action.

Specified by:

reconcileFlows in interface IFlowReconcileListener

Parameters:

ofmRcList - input flow matches, to be updated to be consistent with the policies of this reconciler Additional OFMatch-es can be added to the "list" as needed. For example after a new ACL application, one flow-match may result in multiple flow-matches The method must also update the ReconcileAction member in ofmRcList entries to indicate if the flow needs to be modified, deleted or left unchanged OR of a new entry is to be added after flow reconciliation

Returns:

Command.CONTINUE if the OFMatch should be sent to the next flow reconciler. Command.STOP if the OFMatch shouldn't be processed further. In this case the no reconciled flow-mods would be programmed

getModels

public OFModel[] getModels()

Description copied from class: OFModule

returns the array of all OFModel objects associated with this module. Normally the size of the array is one, but not limited to.

Specified by:

getModels in class OFModule

Returns:

the array of OFModel objects