net.onrc.openvirtex.elements.network

Class OVXNetwork

java.lang.Object

net.onrc.openvirtex.elements.network.Network<OVXSwitch,OVXPort,OVXLink>

net.onrc.openvirtex.elements.network.OVXNetwork

All Implemented Interfaces:

OVXSendMsg, Persistable, LLDPEventHandler

public class OVXNetwork
extends Network<OVXSwitch,OVXPort,OVXLink>
implements Persistable

Virtual networks contain tenantId, controller info, subnet and gateway information. Handles registration of virtual switches and links. Responds to LLDP discovery probes from the controller.

Field Summary

Fields inherited from class net.onrc.openvirtex.elements.network.Network

dpidMap, linkSet, neighborMap, neighborPortMap, switchSet

Constructor Summary

Constructors

Constructor and Description
OVXNetwork(ArrayList<String> controllerUrls, IPAddress network, short mask) Instantiates a virtual network, and assigns a unique tenant ID.
OVXNetwork(int tenantId, ArrayList<String> controllerUrls, IPAddress network, short mask) Instantiates a virtual network.

Method Summary

Methods

Modifier and Type	Method and Description
void	addControllers(ArrayList<String> ctrlUrls)
boolean	boot() Boots the virtual network by booting each virtual switch.
Host	connectHost(long ovxDpid, short ovxPort, MACAddress mac) Connects the host identified by unique MAC address host ID to the given virtual switch port, and returns the host instance.
Host	connectHost(long ovxDpid, short ovxPort, MACAddress mac, int hostId) Connects the host identified by unique MAC address and unique host ID to the given virtual switch port, and returns the host instance.
OVXLink	connectLink(long ovxSrcDpid, short ovxSrcPort, long ovxDstDpid, short ovxDstPort, String alg, byte numBackups) Creates virtual link between given virtual source port and virtual destination port, creates a unique link ID, creates its mapping to the physical topology, and adds it to the topology.
OVXLink	connectLink(long ovxSrcDpid, short ovxSrcPort, long ovxDstDpid, short ovxDstPort, String alg, byte numBackups, int linkId) Creates virtual link, adds it to the topology, and returns the link instance.
SwitchRoute	connectRoute(long ovxDpid, short ovxSrcPort, short ovxDstPort, List<PhysicalLink> physicalLinks, byte priority, int... routeId)
OVXPort	createPort(long physicalDpid, short portNumber, short... vportNumber) Creates a virtual port that is mapped to the given physical switch DPID and port number, and set its virtual port number if present.
OVXSwitch	createSwitch(List<Long> dpids) Creates a virtual switch that is mapped to the given list of physical switch DPIDs.
OVXSwitch	createSwitch(List<Long> dpids, long switchId) Creates a virtual switch that is mapped to the given list of physical switch DPIDs and sets the virtual switch DPID.
void	disconnectHost(int hostId)
void	disconnectLink(int linkId)
void	disconnectRoute(long ovxDpid, int routeId)
Set<String>	getControllerUrls() Gets the list of controller URLs.
Map<String,Object>	getDBIndex()
String	getDBKey()
String	getDBName()
Map<String,Object>	getDBObject()
OVXFlowManager	getFlowManager()
Host	getHost(Integer hostId)
Host	getHost(OVXPort port)
BitSetIndex	getHostCounter() Gets the current value of the host ID.
Collection<Host>	getHosts()
BitSetIndex	getLinkCounter() Gets the current value of the link ID.
List<OVXLink>	getLinksById(Integer linkId)
Set<OVXLink>	getLinkSet()
short	getMask()
String	getName()
IPAddress	getNetwork() Gets the network address space.
Integer	getTenantId() Gets the tenant ID.
void	handleLLDP(OFMessage msg, Switch sw) Handles LLDP received from controller.
boolean	isBooted()
Integer	nextIP()
void	register()
void	removeHost(Host host)
boolean	removeLink(OVXLink virtualLink) Removes link to topology.
void	removePort(long ovxDpid, short ovxPort)
void	removeSwitch(long ovxDpid)
boolean	removeSwitch(OVXSwitch ovxSwitch) Removes switch from topology.
static void	reserveTenantId(Integer tenantId) Reserves a unique tenant ID so it is guaranteed to be unique.
static void	reset()
void	sendMsg(OFMessage msg, OVXSendMsg from)
OVXLink	setLinkPath(int linkId, List<PhysicalLink> physicalLinks, byte priority) Creates virtual link mapping to the physical topology.
RoutingAlgorithms	setOVXBigSwitchRouting(long dpid, String alg, byte numBackups) Sets the algorithm and number of backups for the big switch routing.
void	startPort(long ovxDpid, short ovxPort)
void	startSwitch(long ovxDpid)
void	stop()
void	stopPort(long ovxDpid, short ovxPort)
void	stopSwitch(long ovxDpid)
void	unregister()

Methods inherited from class net.onrc.openvirtex.elements.network.Network

addLink, addSwitch, getLink, getLinks, getNeighborPort, getNeighbors, getSwitch, getSwitches

Methods inherited from class java.lang.Object

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

Constructor Detail

OVXNetwork

public OVXNetwork(int tenantId,
          ArrayList<String> controllerUrls,
          IPAddress network,
          short mask)
           throws IndexOutOfBoundException

Instantiates a virtual network. Only use if you have reserved the tenantId beforehand!

Parameters:

tenantId - the unique tenant ID

controllerUrls - the list of controller URLs

network - the virtual network address space

mask - the virtual network address space mask

Throws:

IndexOutOfBoundException

OVXNetwork

public OVXNetwork(ArrayList<String> controllerUrls,
          IPAddress network,
          short mask)
           throws IndexOutOfBoundException

Instantiates a virtual network, and assigns a unique tenant ID.

Parameters:

controllerUrls - the list of controller URLs

network - the virtual network address space

mask - the virtual network address space mask

Throws:

IndexOutOfBoundException

Method Detail

getControllerUrls

public Set<String> getControllerUrls()

Gets the list of controller URLs.

Returns:

the list of controller URLs

getTenantId

public Integer getTenantId()

Gets the tenant ID.

Returns:

the tenant ID

getNetwork

public IPAddress getNetwork()

Gets the network address space.

Returns:

the network address space

reserveTenantId

public static void reserveTenantId(Integer tenantId)
                            throws IndexOutOfBoundException,
                                   DuplicateIndexException

Reserves a unique tenant ID so it is guaranteed to be unique.

Parameters:

tenantId - the tenant ID

Throws:

IndexOutOfBoundException

DuplicateIndexException

getLinkCounter

public BitSetIndex getLinkCounter()

Gets the current value of the link ID.

Returns:

the current link ID

getHostCounter

public BitSetIndex getHostCounter()

Gets the current value of the host ID.

Returns:

the current host ID

getMask

public short getMask()

getFlowManager

public OVXFlowManager getFlowManager()

register

public void register()

isBooted

public boolean isBooted()

getHosts

public Collection<Host> getHosts()

getHost

public Host getHost(OVXPort port)

getHost

public Host getHost(Integer hostId)

unregister

public void unregister()

stop

public void stop()

createSwitch

public OVXSwitch createSwitch(List<Long> dpids,
                     long switchId)
                       throws IndexOutOfBoundException

Creates a virtual switch that is mapped to the given list of physical switch DPIDs and sets the virtual switch DPID.

Parameters:

dpids - the list of physical switch DPIDs

switchId - the virtual switch DPID

Returns:

the virtual switch instance

Throws:

IndexOutOfBoundException

createSwitch

public OVXSwitch createSwitch(List<Long> dpids)
                       throws IndexOutOfBoundException

Creates a virtual switch that is mapped to the given list of physical switch DPIDs.

Parameters:

dpids - the list of physical switch DPID

Returns:

the virtual switch instance

Throws:

IndexOutOfBoundException

createPort

public OVXPort createPort(long physicalDpid,
                 short portNumber,
                 short... vportNumber)
                   throws IndexOutOfBoundException

Creates a virtual port that is mapped to the given physical switch DPID and port number, and set its virtual port number if present.

Parameters:

physicalDpid - the physical DPID

portNumber - the physical port number

vportNumber - the virtual port number

Returns:

the virtual port instance

Throws:

IndexOutOfBoundException

setOVXBigSwitchRouting

public RoutingAlgorithms setOVXBigSwitchRouting(long dpid,
                                       String alg,
                                       byte numBackups)
                                         throws RoutingAlgorithmException

Sets the algorithm and number of backups for the big switch routing.

Parameters:

dpid - the virtual dpid

alg - the algorithm

numBackups - the number of backups

Returns:

the routing algorithm instance

Throws:

RoutingAlgorithmException

connectHost

public Host connectHost(long ovxDpid,
               short ovxPort,
               MACAddress mac,
               int hostId)
                 throws IndexOutOfBoundException

Connects the host identified by unique MAC address and unique host ID to the given virtual switch port, and returns the host instance.

Parameters:

ovxDpid - the virtual switch ID

ovxPort - the virtual port number

mac - the MAC address

hostId - the host ID

Returns:

the host instance

Throws:

IndexOutOfBoundException

connectHost

public Host connectHost(long ovxDpid,
               short ovxPort,
               MACAddress mac)
                 throws IndexOutOfBoundException

Connects the host identified by unique MAC address host ID to the given virtual switch port, and returns the host instance. This method will generate a unique host ID.

Parameters:

ovxDpid - the virtual switch dpdi

ovxPort - the virtual switch port number

mac - the MAC address

Returns:

the host instance

Throws:

IndexOutOfBoundException

connectLink

public OVXLink connectLink(long ovxSrcDpid,
                  short ovxSrcPort,
                  long ovxDstDpid,
                  short ovxDstPort,
                  String alg,
                  byte numBackups,
                  int linkId)
                    throws IndexOutOfBoundException,
                           PortMappingException

Creates virtual link, adds it to the topology, and returns the link instance.

Parameters:

ovxSrcDpid - virtual source dpid

ovxSrcPort - source port number

ovxDstDpid - virtual destination dpid

ovxDstPort - destination port number

alg - the routing algorithm

numBackups - the number of backups

linkId - the link ID

Returns:

the virtual link instance

Throws:

IndexOutOfBoundException

PortMappingException

connectLink

public OVXLink connectLink(long ovxSrcDpid,
                  short ovxSrcPort,
                  long ovxDstDpid,
                  short ovxDstPort,
                  String alg,
                  byte numBackups)
                    throws IndexOutOfBoundException,
                           PortMappingException

Creates virtual link between given virtual source port and virtual destination port, creates a unique link ID, creates its mapping to the physical topology, and adds it to the topology.

Parameters:

ovxSrcDpid - the virtual source DPID

ovxSrcPort - the virtual source port

ovxDstDpid - the virtual destination DPID

ovxDstPort - the virtual destination DPID

alg - the algorithm

numBackups - the number of backups

Returns:

the virtual link instance

Throws:

IndexOutOfBoundException

PortMappingException

setLinkPath

public OVXLink setLinkPath(int linkId,
                  List<PhysicalLink> physicalLinks,
                  byte priority)
                    throws IndexOutOfBoundException

Creates virtual link mapping to the physical topology.

Parameters:

linkId - the unique link ID

physicalLinks - the list of physical links

priority - the priority value

Returns:

the virtual link instance

Throws:

IndexOutOfBoundException

connectRoute

public SwitchRoute connectRoute(long ovxDpid,
                       short ovxSrcPort,
                       short ovxDstPort,
                       List<PhysicalLink> physicalLinks,
                       byte priority,
                       int... routeId)
                         throws IndexOutOfBoundException

Throws:

IndexOutOfBoundException

removeSwitch

public void removeSwitch(long ovxDpid)

removePort

public void removePort(long ovxDpid,
              short ovxPort)

disconnectHost

public void disconnectHost(int hostId)

disconnectLink

public void disconnectLink(int linkId)

disconnectRoute

public void disconnectRoute(long ovxDpid,
                   int routeId)

startSwitch

public void startSwitch(long ovxDpid)

startPort

public void startPort(long ovxDpid,
             short ovxPort)

stopSwitch

public void stopSwitch(long ovxDpid)

stopPort

public void stopPort(long ovxDpid,
            short ovxPort)

boot

public boolean boot()

Boots the virtual network by booting each virtual switch. TODO: we should roll-back if any switch fails to boot

Specified by:

boot in class Network<OVXSwitch,OVXPort,OVXLink>

Returns:

True if successful, false otherwise

handleLLDP

public void handleLLDP(OFMessage msg,
              Switch sw)

Handles LLDP received from controller. Receive LLDP from controller. Switch to which it is destined is passed in by the ControllerHandler, port is extracted from the packet_out. Packet_in is created based on topology info.

Specified by:

handleLLDP in interface LLDPEventHandler

Parameters:

msg - the OpenFlow message

sw - the switch

sendMsg

public void sendMsg(OFMessage msg,
           OVXSendMsg from)

Specified by:

sendMsg in interface OVXSendMsg

getName

public String getName()

Specified by:

getName in interface OVXSendMsg

nextIP

public Integer nextIP()
               throws IndexOutOfBoundException

Throws:

IndexOutOfBoundException

reset

public static void reset()

getLinksById

public List<OVXLink> getLinksById(Integer linkId)

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

getLinkSet

public Set<OVXLink> getLinkSet()

removeLink

public boolean removeLink(OVXLink virtualLink)

Description copied from class: Network

Removes link to topology.

Overrides:

removeLink in class Network<OVXSwitch,OVXPort,OVXLink>

Parameters:

virtualLink - the link

Returns:

true if successful, false otherwise

removeSwitch

public boolean removeSwitch(OVXSwitch ovxSwitch)

Description copied from class: Network

Removes switch from topology.

Overrides:

removeSwitch in class Network<OVXSwitch,OVXPort,OVXLink>

Parameters:

ovxSwitch - the switch

Returns:

true if successful, false otherwise

removeHost

public void removeHost(Host host)

addControllers

public void addControllers(ArrayList<String> ctrlUrls)