net.onrc.openvirtex.elements.datapath

Class OVXSwitch

java.lang.Object

net.onrc.openvirtex.elements.datapath.Switch<OVXPort>

net.onrc.openvirtex.elements.datapath.OVXSwitch

All Implemented Interfaces:

OVXEventHandler, OVXSendMsg, Persistable

Direct Known Subclasses:

OVXBigSwitch, OVXSingleSwitch

public abstract class OVXSwitch
extends Switch<OVXPort>
implements Persistable

The base virtual switch.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	bufferDimension
protected LRULinkedHashMap<Integer,OVXPacketIn>	bufferMap
protected OVXSwitchCapabilities	capabilities
static String	DPDESCSTRING Datapath description string.
protected FlowTable	flowTable
protected boolean	isActive
protected Short	missSendLen
protected static int	supportedActions
protected Integer	tenantId

Fields inherited from class net.onrc.openvirtex.elements.datapath.Switch

channel, DB_KEY, desc, featuresReply, isConnected, map, portMap, switchId, switchName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OVXSwitch(Long switchId, Integer tenantId) Instantiates a new OVX switch.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDefaultPort(LinkedList<OFPhysicalPort> ports) Adds a default OpenFlow port to the give list of physical ports.
int	addToBufferMap(OVXPacketIn pktIn) Adds a packet_in to the buffer map and returns a unique buffer ID.
boolean	boot() Boots virtual switch by connecting it to the controller.
OVXFlowMod	deleteFlowMod(Long cookie) Removes an entry in the mapping.
boolean	equals(Object obj)
void	generateFeaturesReply() Generate features reply.
Map<String,Object>	getDBIndex()
String	getDBKey()
String	getDBName()
Map<String,Object>	getDBObject()
OVXFlowMod	getFlowMod(Long cookie) Gets a OVXFlowMod out of the map based on the given cookie.
FlowTable	getFlowTable() Gets the flow table.
OVXPacketIn	getFromBufferMap(Integer bufId) Gets a packet_in from a given buffer ID.
short	getMissSendLen() Gets the miss send len.
short	getNextPortNumber() Gets the next available port number.
Short	getPhysicalPortNumber(Short ovxPortNumber) Gets the physical port number.
Integer	getTenantId() Gets the tenant id.
void	handleIO(OFMessage msg, org.jboss.netty.channel.Channel channel)
void	handleRoleIO(OFVendor msg, org.jboss.netty.channel.Channel channel)
int	hashCode()
int	incrementBackOff() Increments the backoff counter.
boolean	isActive() Checks if is active.
void	register(List<PhysicalSwitch> physicalSwitches) Registers switch in the mapping and adds it to persistent storage.
void	relesePortNumber(short portNumber) Releases the given port number so it can be reused.
void	removeChannel(org.jboss.netty.channel.Channel channel) Removes the given channel.
void	resetBackOff() Resets the backoff counter.
void	sendMsg(OFMessage msg, OVXSendMsg from)
abstract void	sendSouth(OFMessage msg, OVXPort inPort) Sends a message towards the physical network, via the PhysicalSwitch mapped to this OVXSwitch.
void	setActive(boolean isActive) Sets the active.
void	setChannel(org.jboss.netty.channel.Channel channel) Sets the channel.
boolean	setMissSendLen(Short missSendLen) Sets the miss send len.
void	tearDown() Tear down.
String	toString()
abstract int	translate(OFMessage msg, OVXPort inPort) Generates a new XID for messages destined for the physical network.
void	unregister() Unregisters switch from persistent storage, from the mapping, and removes all virtual elements that rely on this switch.

Methods inherited from class net.onrc.openvirtex.elements.datapath.Switch

addPort, getFeaturesReply, getMap, getName, getPort, getPorts, getSwitchId, getSwitchName, removePort, setConnected, setDescriptionStats, setFeaturesReply

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DPDESCSTRING

public static final String DPDESCSTRING

Datapath description string. TODO: should this be made specific per type of virtual switch?

See Also:

Constant Field Values

supportedActions

protected static int supportedActions

bufferDimension

protected static int bufferDimension

tenantId

protected Integer tenantId

missSendLen

protected Short missSendLen

isActive

protected boolean isActive

capabilities

protected OVXSwitchCapabilities capabilities

bufferMap

protected LRULinkedHashMap<Integer,OVXPacketIn> bufferMap

flowTable

protected FlowTable flowTable

Constructor Detail

OVXSwitch

protected OVXSwitch(Long switchId,
         Integer tenantId)

Instantiates a new OVX switch.

Parameters:

switchId - the switch id

tenantId - the tenant id

Method Detail

getTenantId

public Integer getTenantId()

Gets the tenant id.

Returns:

the tenant id

getMissSendLen

public short getMissSendLen()

Gets the miss send len.

Returns:

the miss send len

setMissSendLen

public boolean setMissSendLen(Short missSendLen)

Sets the miss send len.

Parameters:

missSendLen - the miss send len

Returns:

true, if successful

isActive

public boolean isActive()

Checks if is active.

Returns:

true, if is active

setActive

public void setActive(boolean isActive)

Sets the active.

Parameters:

isActive - the new active

getPhysicalPortNumber

public Short getPhysicalPortNumber(Short ovxPortNumber)

Gets the physical port number.

Parameters:

ovxPortNumber - the ovx port number

Returns:

the physical port number

resetBackOff

public void resetBackOff()

Resets the backoff counter.

incrementBackOff

public int incrementBackOff()

Increments the backoff counter.

Returns:

the backoff counter

getNextPortNumber

public short getNextPortNumber()
                        throws IndexOutOfBoundException

Gets the next available port number.

Returns:

the port number

Throws:

IndexOutOfBoundException - if no more port numbers are available

relesePortNumber

public void relesePortNumber(short portNumber)

Releases the given port number so it can be reused.

Parameters:

portNumber - the port number

addDefaultPort

protected void addDefaultPort(LinkedList<OFPhysicalPort> ports)

Adds a default OpenFlow port to the give list of physical ports.

Parameters:

ports - the list of ports

register

public void register(List<PhysicalSwitch> physicalSwitches)

Registers switch in the mapping and adds it to persistent storage.

Parameters:

physicalSwitches -

unregister

public void unregister()

Unregisters switch from persistent storage, from the mapping, and removes all virtual elements that rely on this switch.

Specified by:

unregister in class Switch<OVXPort>

getDBIndex

public Map<String,Object> getDBIndex()

Specified by:

getDBIndex in interface Persistable

getDBKey

public String getDBKey()

Specified by:

getDBKey in interface Persistable

getDBName

public String getDBName()

Specified by:

getDBName in interface Persistable

getDBObject

public Map<String,Object> getDBObject()

Specified by:

getDBObject in interface Persistable

tearDown

public void tearDown()

Description copied from class: Switch

Tear down.

Specified by:

tearDown in class Switch<OVXPort>

generateFeaturesReply

public void generateFeaturesReply()

Generate features reply.

boot

public boolean boot()

Boots virtual switch by connecting it to the controller.

Specified by:

boot in class Switch<OVXPort>

Returns:

true if successful, false otherwise

toString

public String toString()

Overrides:

toString in class Switch<OVXPort>

addToBufferMap

public int addToBufferMap(OVXPacketIn pktIn)

Adds a packet_in to the buffer map and returns a unique buffer ID.

Parameters:

pktIn - the packet_in

Returns:

the buffer ID

getFromBufferMap

public OVXPacketIn getFromBufferMap(Integer bufId)

Gets a packet_in from a given buffer ID.

Parameters:

bufId - the buffer ID

Returns:

packet_in packet

getFlowTable

public FlowTable getFlowTable()

Gets the flow table.

Returns:

the flow table

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

sendMsg

public void sendMsg(OFMessage msg,
           OVXSendMsg from)

Specified by:

sendMsg in interface OVXSendMsg

handleIO

public void handleIO(OFMessage msg,
            org.jboss.netty.channel.Channel channel)

Specified by:

handleIO in interface OVXEventHandler

Specified by:

handleIO in class Switch<OVXPort>

handleRoleIO

public void handleRoleIO(OFVendor msg,
                org.jboss.netty.channel.Channel channel)

Specified by:

handleRoleIO in class Switch<OVXPort>

getFlowMod

public OVXFlowMod getFlowMod(Long cookie)
                      throws MappingException

Gets a OVXFlowMod out of the map based on the given cookie.

Parameters:

cookie - the physical cookie

Returns:

the virtual flow mod

Throws:

MappingException - if the cookie is not found

setChannel

public void setChannel(org.jboss.netty.channel.Channel channel)

Sets the channel.

Overrides:

setChannel in class Switch<OVXPort>

Parameters:

channel - the channel

removeChannel

public void removeChannel(org.jboss.netty.channel.Channel channel)

Removes the given channel.

Specified by:

removeChannel in class Switch<OVXPort>

Parameters:

channel - the channel

deleteFlowMod

public OVXFlowMod deleteFlowMod(Long cookie)

Removes an entry in the mapping.

Parameters:

cookie -

Returns:

The deleted FlowMod

translate

public abstract int translate(OFMessage msg,
            OVXPort inPort)

Generates a new XID for messages destined for the physical network.

Parameters:

msg - The OFMessage being translated

inPort - The ingress port

Returns:

the new transaction ID

sendSouth

public abstract void sendSouth(OFMessage msg,
             OVXPort inPort)

Sends a message towards the physical network, via the PhysicalSwitch mapped to this OVXSwitch.

Parameters:

msg - The OFMessage being translated

inPort - The ingress port, used to identify the PhysicalSwitch underlying an OVXBigSwitch. May be null. Sends a message towards the physical network