net.onrc.openvirtex.routing

Class SwitchRoute

java.lang.Object

net.onrc.openvirtex.elements.link.Link<OVXPort,PhysicalSwitch>

net.onrc.openvirtex.routing.SwitchRoute

All Implemented Interfaces:

Persistable

public class SwitchRoute
extends Link<OVXPort,PhysicalSwitch>
implements Persistable

This class presents an abstraction for a route within a big switch. A route consists of a virtual switch, the ingress and egress ports on that switch, a priority value, and it has a unique route ID. It stores the mapping to one or more physical paths, each of which have a priority. Several methods are available to create physical paths It also exposes the methods needed to generate and install the flow mods on the physical plane, based on a virtual (controller-generated) flow mod.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DB_KEY Database keyword for switch routes.

Fields inherited from class net.onrc.openvirtex.elements.link.Link

dstPort, srcPort

Constructor Summary

Constructors

Constructor and Description
SwitchRoute(OVXSwitch sw, OVXPort in, OVXPort out, int routeid, byte priority) Instantiates a new switch route for the given switch between two ports, and assigns a route ID and priority value.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBackupRoute(Byte priority, List<PhysicalLink> physicalLinks) Adds a backup route with given priority value and path given as list of physical links.
void	generateRouteFMs(OVXFlowMod fm) Generates and installs all flow mods needed to bring up switch route, base an a given controller-generated flow mod.
Map<String,Object>	getDBIndex()
String	getDBKey()
String	getDBName()
Map<String,Object>	getDBObject()
PhysicalSwitch	getDstSwitch() Gets the destination switch of the link.
Set<PhysicalLink>	getLinks() Gets the set of physical links that make up both primary and backup paths for the switch route.
PhysicalPort	getPathDstPort()
PhysicalPort	getPathSrcPort()
byte	getPriority() Gets the priority value.
int	getRouteId()
PhysicalSwitch	getSrcSwitch() Gets the source switch of the link.
long	getSwitchId()
Integer	getTenantId() Returns unique the tenant ID of the switch route.
void	register() Registers switch route in persistent storage.
void	replacePrimaryRoute(Byte priority, List<PhysicalLink> physicalLinks) Replaces the current primary route by the new route given as a list of physical links and priority value.
void	setPathDstPort(PhysicalPort end) Sets the egress port of the switch route to the given physical port.
void	setPathSrcPort(PhysicalPort start) Sets the ingress port of the switch route to the given physical port.
void	setPriority(byte priority) Sets the priority value of the switch route.
void	setRouteId(int routeid) Sets the switch-unique identifier of this route.
void	switchPath(List<PhysicalLink> physicalLinks, byte priority) Switches over to the next backup path given as a list of physical links with the given priority.
String	toString()
boolean	tryRecovery(PhysicalLink plink) Tries to switch this route to a backup path, and updates mappings to "correct" string of PhysicalLinks to use for this SwitchRoute.
boolean	tryRevert(PhysicalLink plink) Attempts to switch this route back to the original path.
void	unregister() Removes mappings and dependencies related to this link.

Methods inherited from class net.onrc.openvirtex.elements.link.Link

equals, getDstPort, getMetric, getSrcPort, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

DB_KEY

public static final String DB_KEY

Database keyword for switch routes.

See Also:

Constant Field Values

Constructor Detail

SwitchRoute

public SwitchRoute(OVXSwitch sw,
           OVXPort in,
           OVXPort out,
           int routeid,
           byte priority)

Instantiates a new switch route for the given switch between two ports, and assigns a route ID and priority value.

Parameters:

sw - the virtual switch

in - the ingress port

out - the egress port

routeid - the route ID

priority - the priority value

Method Detail

setRouteId

public void setRouteId(int routeid)

Sets the switch-unique identifier of this route.

Parameters:

routeid - the route ID

getRouteId

public int getRouteId()

Returns:

the ID of this route

getPriority

public byte getPriority()

Gets the priority value.

Returns:

the priority value

setPriority

public void setPriority(byte priority)

Sets the priority value of the switch route.

Parameters:

priority - the priority value

getSwitchId

public long getSwitchId()

Returns:

The DPID of the virtual switch

getTenantId

public Integer getTenantId()

Returns unique the tenant ID of the switch route.

Returns:

the tenant ID

setPathSrcPort

public void setPathSrcPort(PhysicalPort start)

Sets the ingress port of the switch route to the given physical port.

Parameters:

start - the source physical port

getPathSrcPort

public PhysicalPort getPathSrcPort()

Returns:

the PhysicalPort at start of the route.

setPathDstPort

public void setPathDstPort(PhysicalPort end)

Sets the egress port of the switch route to the given physical port.

Parameters:

end - the destination physical port

getPathDstPort

public PhysicalPort getPathDstPort()

Returns:

the PhysicalPort at end of the route.

addBackupRoute

public void addBackupRoute(Byte priority,
                  List<PhysicalLink> physicalLinks)

Adds a backup route with given priority value and path given as list of physical links.

Parameters:

priority - the priority value

physicalLinks - the backup route

replacePrimaryRoute

public void replacePrimaryRoute(Byte priority,
                       List<PhysicalLink> physicalLinks)

Replaces the current primary route by the new route given as a list of physical links and priority value.

Parameters:

priority - the priority value

physicalLinks - the new route

toString

public String toString()

Overrides:

toString in class Link<OVXPort,PhysicalSwitch>

getSrcSwitch

public PhysicalSwitch getSrcSwitch()

Description copied from class: Link

Gets the source switch of the link.

Overrides:

getSrcSwitch in class Link<OVXPort,PhysicalSwitch>

Returns:

the source switch

getDstSwitch

public PhysicalSwitch getDstSwitch()

Description copied from class: Link

Gets the destination switch of the link.

Overrides:

getDstSwitch in class Link<OVXPort,PhysicalSwitch>

Returns:

the destination switch

switchPath

public void switchPath(List<PhysicalLink> physicalLinks,
              byte priority)

Switches over to the next backup path given as a list of physical links with the given priority.

Parameters:

physicalLinks - the new path

priority - the priority of the new path

generateRouteFMs

public void generateRouteFMs(OVXFlowMod fm)

Generates and installs all flow mods needed to bring up switch route, base an a given controller-generated flow mod.

Parameters:

fm - the virtual flow mod

register

public void register()

Registers switch route in persistent storage.

unregister

public void unregister()

Description copied from class: Link

Removes mappings and dependencies related to this link.

Specified by:

unregister in class Link<OVXPort,PhysicalSwitch>

getDBIndex

public Map<String,Object> getDBIndex()

Specified by:

getDBIndex in interface Persistable

Overrides:

getDBIndex in class Link<OVXPort,PhysicalSwitch>

getDBKey

public String getDBKey()

Specified by:

getDBKey in interface Persistable

Overrides:

getDBKey in class Link<OVXPort,PhysicalSwitch>

getDBName

public String getDBName()

Specified by:

getDBName in interface Persistable

Overrides:

getDBName in class Link<OVXPort,PhysicalSwitch>

getDBObject

public Map<String,Object> getDBObject()

Specified by:

getDBObject in interface Persistable

Overrides:

getDBObject in class Link<OVXPort,PhysicalSwitch>

tryRecovery

public boolean tryRecovery(PhysicalLink plink)

Tries to switch this route to a backup path, and updates mappings to "correct" string of PhysicalLinks to use for this SwitchRoute.

Parameters:

plink - the failed PhysicalLink

Returns:

true if successful

getLinks

public Set<PhysicalLink> getLinks()

Gets the set of physical links that make up both primary and backup paths for the switch route.

Returns:

set of physical links

tryRevert

public boolean tryRevert(PhysicalLink plink)

Attempts to switch this route back to the original path.

Parameters:

plink - physical link that was restored

Returns:

true for success, false otherwise