etri.sdn.controller.protocol.io

Class OFSwitchImpl

java.lang.Object

etri.sdn.controller.protocol.io.OFSwitchImpl

All Implemented Interfaces:

IOFSwitch

public final class OFSwitchImpl
extends java.lang.Object
implements IOFSwitch

This is the internal representation of an openflow switch. This is a slight modification of OFSwitchImpl of Floodlight.

Author:

bjlee

Nested Class Summary

Nested classes/interfaces inherited from interface etri.sdn.controller.protocol.io.IOFSwitch

IOFSwitch.SwitchType

Field Summary

Fields

Modifier and Type	Field and Description
private int	actions
private java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object>	attributes
private int	buffers
private int	capabilities
private Connection	conn
private java.util.Date	connectedSince
private long	datapathId
private org.openflow.protocol.statistics.OFDescriptionStatistics	description
private static java.lang.String	HA_CHECK_SWITCH
private java.util.concurrent.ConcurrentMap<java.lang.Short,java.lang.Long>	portBroadcastCacheHitMap
private java.lang.Object	portLock
private java.util.concurrent.ConcurrentHashMap<java.lang.String,org.openflow.protocol.OFPhysicalPort>	portsByName
private java.util.concurrent.ConcurrentHashMap<java.lang.Short,org.openflow.protocol.OFPhysicalPort>	portsByNumber
private java.util.concurrent.ConcurrentHashMap<java.lang.Integer,java.lang.Object>	responsesCache This field is used to exchange information with switch.
private IOFHandler.Role	role
private java.lang.String	stringId
private byte	tables
private TimedCache<java.lang.Long>	timedCache
private java.util.concurrent.atomic.AtomicInteger	transactionIdSource

Fields inherited from interface etri.sdn.controller.protocol.io.IOFSwitch

PROP_FASTWILDCARDS, PROP_REQUIRES_L3_MATCH, PROP_SUPPORTS_NETMASK_TBL, PROP_SUPPORTS_OFPP_FLOOD, PROP_SUPPORTS_OFPP_TABLE, SWITCH_DESCRIPTION_DATA, SWITCH_DESCRIPTION_FUTURE, SWITCH_IS_CORE_SWITCH, SWITCH_SUPPORTS_NX_ROLE

Constructor Summary

Constructors

Constructor and Description
OFSwitchImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearAllFlowMods() Clear all flowmods on this switch
void	deletePort(short portNumber) Delete a port for the switch.
void	deletePort(java.lang.String portName) Delete a port for the switch.
void	deliverFeaturesReply(int xid, org.openflow.protocol.OFFeaturesReply reply) Deliver a feature reply from switch to IOFSwitch object.
void	deliverSwitchStatistics(int xid, java.util.List<org.openflow.protocol.statistics.OFStatistics> m) deliver an switch statistics from switch to IOFSwitch object.
int	getActions() Returns switch features from features Reply
java.lang.Object	getAttribute(java.lang.String name) Set properties for switch specific behavior
java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object>	getAttributes() Retrieves attributes of this switch
int	getBuffers() Returns switch features from features Reply
int	getCapabilities() Returns switch features from features Reply
java.util.Date	getConnectedSince() Retrieves the date the switch connected to this controller
Connection	getConnection()
org.openflow.protocol.statistics.OFDescriptionStatistics	getDescription() Get the OFDescriptionStatistics object.
java.util.Collection<java.lang.Short>	getEnabledPortNumbers() Get list of the port numbers of all enabled ports.
java.util.Collection<org.openflow.protocol.OFPhysicalPort>	getEnabledPorts() Get list of all enabled ports.
org.openflow.protocol.OFFeaturesReply	getFeaturesReply() query FEATURE_REPLY to the switch.
long	getId() Get the datapathId of the switch
java.net.SocketAddress	getInetAddress()
int	getNextTransactionId() Returns the next available transaction id
org.openflow.protocol.OFPhysicalPort	getPort(short portNumber) Retrieve the port object by the port number.
org.openflow.protocol.OFPhysicalPort	getPort(java.lang.String portName) Retrieve the port object by the port name.
java.util.Map<java.lang.Short,java.lang.Long>	getPortBroadcastHits() Get the portBroadcastCacheHits
java.util.Collection<org.openflow.protocol.OFPhysicalPort>	getPorts() Get list of all ports.
IOFHandler.Role	getRole() Get the current role of the controller for the switch
java.lang.String	getStringId() Get a string version of the ID for this switch
java.util.List<org.openflow.protocol.statistics.OFStatistics>	getSwitchStatistics(org.openflow.protocol.OFStatisticsRequest req) Modules that use IOFSwitch objects use this method to request statistics to the switch.
byte	getTables() Returns switch features from features Reply
boolean	hasAttribute(java.lang.String name) Checks if a specific switch property exists for this switch
boolean	isActive() Check if the controller is an active controller for the switch.
boolean	isConnected() Check if the switch is still connected; Only call while holding processMessageLock
boolean	portEnabled(org.openflow.protocol.OFPhysicalPort port)
boolean	portEnabled(short portNumber)
boolean	portEnabled(java.lang.String portName)
java.lang.Object	removeAttribute(java.lang.String name) Set properties for switch specific behavior
void	setAttribute(java.lang.String name, java.lang.Object value) Set properties for switch specific behavior
void	setConnection(Connection conn)
void	setFeaturesReply(org.openflow.protocol.OFFeaturesReply featuresReply) Set the OFFeaturesReply message returned by the switch during initial handshake.
void	setPort(org.openflow.protocol.OFPhysicalPort port) Add or modify a switch port.
void	setSwitchProperties(org.openflow.protocol.statistics.OFDescriptionStatistics description) Set the SwitchProperties based on it's description
java.lang.String	toString()
boolean	updateBroadcastCache(java.lang.Long entry, java.lang.Short port) Update broadcast cache

Methods inherited from class java.lang.Object

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

Field Detail

HA_CHECK_SWITCH

private static final java.lang.String HA_CHECK_SWITCH

See Also:

Constant Field Values

attributes

private java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> attributes

connectedSince

private java.util.Date connectedSince

conn

private Connection conn

stringId

private java.lang.String stringId

description

private org.openflow.protocol.statistics.OFDescriptionStatistics description

transactionIdSource

private java.util.concurrent.atomic.AtomicInteger transactionIdSource

portLock

private java.lang.Object portLock

portsByNumber

private java.util.concurrent.ConcurrentHashMap<java.lang.Short,org.openflow.protocol.OFPhysicalPort> portsByNumber

portsByName

private java.util.concurrent.ConcurrentHashMap<java.lang.String,org.openflow.protocol.OFPhysicalPort> portsByName

responsesCache

private java.util.concurrent.ConcurrentHashMap<java.lang.Integer,java.lang.Object> responsesCache

This field is used to exchange information with switch.

role

private IOFHandler.Role role

timedCache

private TimedCache<java.lang.Long> timedCache

portBroadcastCacheHitMap

private java.util.concurrent.ConcurrentMap<java.lang.Short,java.lang.Long> portBroadcastCacheHitMap

capabilities

private int capabilities

buffers

private int buffers

actions

private int actions

tables

private byte tables

datapathId

private long datapathId

Constructor Detail

OFSwitchImpl

public OFSwitchImpl()

Method Detail

setConnection

public void setConnection(Connection conn)

Specified by:

setConnection in interface IOFSwitch

getConnection

public Connection getConnection()

Specified by:

getConnection in interface IOFSwitch

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Description copied from interface: IOFSwitch

Set properties for switch specific behavior

Specified by:

getAttribute in interface IOFSwitch

Parameters:

name - name of property

Returns:

value for name

setAttribute

public void setAttribute(java.lang.String name,
                java.lang.Object value)

Description copied from interface: IOFSwitch

Set properties for switch specific behavior

Specified by:

setAttribute in interface IOFSwitch

Parameters:

name - name of property

value - value for name

removeAttribute

public java.lang.Object removeAttribute(java.lang.String name)

Description copied from interface: IOFSwitch

Set properties for switch specific behavior

Specified by:

removeAttribute in interface IOFSwitch

Parameters:

name - name of property

Returns:

current value for name or null (if not present)

hasAttribute

public boolean hasAttribute(java.lang.String name)

Description copied from interface: IOFSwitch

Checks if a specific switch property exists for this switch

Specified by:

hasAttribute in interface IOFSwitch

Parameters:

name - name of property

Returns:

value for name

setFeaturesReply

public void setFeaturesReply(org.openflow.protocol.OFFeaturesReply featuresReply)

Description copied from interface: IOFSwitch

Set the OFFeaturesReply message returned by the switch during initial handshake.

Specified by:

setFeaturesReply in interface IOFSwitch

getEnabledPorts

public java.util.Collection<org.openflow.protocol.OFPhysicalPort> getEnabledPorts()

Description copied from interface: IOFSwitch

Get list of all enabled ports. This will typically be different from the list of ports in the OFFeaturesReply, since that one is a static snapshot of the ports at the time the switch connected to the controller whereas this port list also reflects the port status messages that have been received.

Specified by:

getEnabledPorts in interface IOFSwitch

Returns:

Unmodifiable list of ports not backed by the underlying collection

getEnabledPortNumbers

public java.util.Collection<java.lang.Short> getEnabledPortNumbers()

Description copied from interface: IOFSwitch

Get list of the port numbers of all enabled ports. This will typically be different from the list of ports in the OFFeaturesReply, since that one is a static snapshot of the ports at the time the switch connected to the controller whereas this port list also reflects the port status messages that have been received.

Specified by:

getEnabledPortNumbers in interface IOFSwitch

Returns:

Unmodifiable list of ports not backed by the underlying collection

getPort

public org.openflow.protocol.OFPhysicalPort getPort(short portNumber)

Description copied from interface: IOFSwitch

Retrieve the port object by the port number. The port object is the one that reflects the port status updates that have been received, not the one from the features reply.

Specified by:

getPort in interface IOFSwitch

Returns:

port object

getPort

public org.openflow.protocol.OFPhysicalPort getPort(java.lang.String portName)

Description copied from interface: IOFSwitch

Retrieve the port object by the port name. The port object is the one that reflects the port status updates that have been received, not the one from the features reply.

Specified by:

getPort in interface IOFSwitch

Returns:

port object

setPort

public void setPort(org.openflow.protocol.OFPhysicalPort port)

Description copied from interface: IOFSwitch

Add or modify a switch port. This is called by the core controller code in response to a OFPortStatus message. It should not typically be called by other floodlight applications.

Specified by:

setPort in interface IOFSwitch

getPorts

public java.util.Collection<org.openflow.protocol.OFPhysicalPort> getPorts()

Description copied from interface: IOFSwitch

Get list of all ports. This will typically be different from the list of ports in the OFFeaturesReply, since that one is a static snapshot of the ports at the time the switch connected to the controller whereas this port list also reflects the port status messages that have been received.

Specified by:

getPorts in interface IOFSwitch

Returns:

Unmodifiable list of ports

deletePort

public void deletePort(short portNumber)

Description copied from interface: IOFSwitch

Delete a port for the switch. This is called by the core controller code in response to a OFPortStatus message. It should not typically be called by other floodlight applications.

Specified by:

deletePort in interface IOFSwitch

deletePort

public void deletePort(java.lang.String portName)

Description copied from interface: IOFSwitch

Delete a port for the switch. This is called by the core controller code in response to a OFPortStatus message. It should not typically be called by other floodlight applications.

Specified by:

deletePort in interface IOFSwitch

portEnabled

public boolean portEnabled(short portNumber)

Specified by:

portEnabled in interface IOFSwitch

Returns:

Whether a port is enabled per latest port status message (not configured down nor link down nor in spanning tree blocking state)

portEnabled

public boolean portEnabled(java.lang.String portName)

Specified by:

portEnabled in interface IOFSwitch

Returns:

Whether a port is enabled per latest port status message (not configured down nor link down nor in spanning tree blocking state)

portEnabled

public boolean portEnabled(org.openflow.protocol.OFPhysicalPort port)

Specified by:

portEnabled in interface IOFSwitch

Returns:

Whether a port is enabled per latest port status message (not configured down nor link down nor in spanning tree blocking state)

getId

public long getId()

Description copied from interface: IOFSwitch

Get the datapathId of the switch

Specified by:

getId in interface IOFSwitch

Returns:

getStringId

public java.lang.String getStringId()

Description copied from interface: IOFSwitch

Get a string version of the ID for this switch

Specified by:

getStringId in interface IOFSwitch

Returns:

getDescription

public org.openflow.protocol.statistics.OFDescriptionStatistics getDescription()

Description copied from interface: IOFSwitch

Get the OFDescriptionStatistics object.

Specified by:

getDescription in interface IOFSwitch

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAttributes

public java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> getAttributes()

Description copied from interface: IOFSwitch

Retrieves attributes of this switch

Specified by:

getAttributes in interface IOFSwitch

Returns:

getConnectedSince

public java.util.Date getConnectedSince()

Description copied from interface: IOFSwitch

Retrieves the date the switch connected to this controller

Specified by:

getConnectedSince in interface IOFSwitch

Returns:

the date

getNextTransactionId

public int getNextTransactionId()

Description copied from interface: IOFSwitch

Returns the next available transaction id

Specified by:

getNextTransactionId in interface IOFSwitch

Returns:

isConnected

public boolean isConnected()

Description copied from interface: IOFSwitch

Check if the switch is still connected; Only call while holding processMessageLock

Specified by:

isConnected in interface IOFSwitch

Returns:

whether the switch is still disconnected

getRole

public IOFHandler.Role getRole()

Description copied from interface: IOFSwitch

Get the current role of the controller for the switch

Specified by:

getRole in interface IOFSwitch

Returns:

the role of the controller

isActive

public boolean isActive()

Description copied from interface: IOFSwitch

Check if the controller is an active controller for the switch. The controller is active if its role is MASTER or EQUAL.

Specified by:

isActive in interface IOFSwitch

Returns:

whether the controller is active

setSwitchProperties

public void setSwitchProperties(org.openflow.protocol.statistics.OFDescriptionStatistics description)

Description copied from interface: IOFSwitch

Set the SwitchProperties based on it's description

Specified by:

setSwitchProperties in interface IOFSwitch

clearAllFlowMods

public boolean clearAllFlowMods()

Description copied from interface: IOFSwitch

Clear all flowmods on this switch

Specified by:

clearAllFlowMods in interface IOFSwitch

Returns:

getPortBroadcastHits

public java.util.Map<java.lang.Short,java.lang.Long> getPortBroadcastHits()

Description copied from interface: IOFSwitch

Get the portBroadcastCacheHits

Specified by:

getPortBroadcastHits in interface IOFSwitch

Returns:

getInetAddress

public java.net.SocketAddress getInetAddress()

getBuffers

public int getBuffers()

Description copied from interface: IOFSwitch

Returns switch features from features Reply

Specified by:

getBuffers in interface IOFSwitch

Returns:

getActions

public int getActions()

Description copied from interface: IOFSwitch

Returns switch features from features Reply

Specified by:

getActions in interface IOFSwitch

Returns:

getCapabilities

public int getCapabilities()

Description copied from interface: IOFSwitch

Returns switch features from features Reply

Specified by:

getCapabilities in interface IOFSwitch

Returns:

getTables

public byte getTables()

Description copied from interface: IOFSwitch

Returns switch features from features Reply

Specified by:

getTables in interface IOFSwitch

Returns:

updateBroadcastCache

public boolean updateBroadcastCache(java.lang.Long entry,
                           java.lang.Short port)

Description copied from interface: IOFSwitch

Update broadcast cache

Specified by:

updateBroadcastCache in interface IOFSwitch

Returns:

true if there is a cache hit false if there is no cache hit.

getSwitchStatistics

public java.util.List<org.openflow.protocol.statistics.OFStatistics> getSwitchStatistics(org.openflow.protocol.OFStatisticsRequest req)

Modules that use IOFSwitch objects use this method to request statistics to the switch.

Specified by:

getSwitchStatistics in interface IOFSwitch

Parameters:

req - OFStatisticsRequest object.

Returns:

deliverSwitchStatistics

public void deliverSwitchStatistics(int xid,
                           java.util.List<org.openflow.protocol.statistics.OFStatistics> m)

Description copied from interface: IOFSwitch

deliver an switch statistics from switch to IOFSwitch object.

Specified by:

deliverSwitchStatistics in interface IOFSwitch

m - OFStatistics objects

getFeaturesReply

public org.openflow.protocol.OFFeaturesReply getFeaturesReply()

Description copied from interface: IOFSwitch

query FEATURE_REPLY to the switch.

Specified by:

getFeaturesReply in interface IOFSwitch

Returns:

deliverFeaturesReply

public void deliverFeaturesReply(int xid,
                        org.openflow.protocol.OFFeaturesReply reply)

Description copied from interface: IOFSwitch

Deliver a feature reply from switch to IOFSwitch object.

Specified by:

deliverFeaturesReply in interface IOFSwitch