net.onrc.openvirtex.elements

Class OVXMap

java.lang.Object

net.onrc.openvirtex.elements.OVXMap

All Implemented Interfaces:

Mappable

public final class OVXMap
extends Object
implements Mappable

This singleton class maintains all the virtual-to-physical and reverse mappings. These encompass switch mappings, link mappings, switch route mappings, the IP address mappings, the tenant ID to virtual network mapping, and the list of MAC addresses.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIP(PhysicalIPAddress physicalIP, OVXIPAddress virtualIP) This is the generic function which takes as arguments the PhysicalIPAddress and the OVXIPAddress.
void	addLinks(List<PhysicalLink> physicalLinks, OVXLink virtualLink) Creates the mapping between PhysicalLinks and a VirtualLink.
void	addMAC(MACAddress mac, Integer tenantId) Creates the maping between the MAC address and tenant ID.
void	addNetwork(OVXNetwork virtualNetwork) Maintain a list of all the virtualNetworks in the system indexed by the tenant id mapping to OVXNetworks.
void	addRoute(SwitchRoute route, List<PhysicalLink> physicalLinks) Adds a mapping between a SwitchRoute and the PhysicalLinks making it up.
void	addSwitches(List<PhysicalSwitch> physicalSwitches, OVXSwitch virtualSwitch) Creates the mapping between PhysicalSwithes and a VirtualSwitch.
Iterable<CharSequence>	getAllKeys()
static OVXMap	getInstance() Gets the instance of the class and if this already exists then the existing object will be returned.
Integer	getMAC(MACAddress mac) Gets the tenant ID associated with the given MAC address.
PhysicalIPAddress	getPhysicalIP(OVXIPAddress ip, Integer tenantId)
List<PhysicalLink>	getPhysicalLinks(OVXLink virtualLink) Gets the physicalLinks that all make up a specified OVXLink.
List<PhysicalSwitch>	getPhysicalSwitches(OVXSwitch virtualSwitch) Gets the physical switches that are contained in the OVXSwitch.
List<PhysicalLink>	getRoute(SwitchRoute route) Gets the current path as a list of physical links for the given route.
Set<SwitchRoute>	getSwitchRoutes(PhysicalLink physicalLink, Integer tenantId) Gets the switch routes that use the given physical link in the specified virtual network.
OVXIPAddress	getVirtualIP(PhysicalIPAddress ip)
List<OVXLink>	getVirtualLinks(PhysicalLink physicalLink, Integer tenantId) Gets the list of OVXLinks that are part of virtual network identified by tenantId and which include the specified physicalLink.
OVXNetwork	getVirtualNetwork(Integer tenantId) Gets the virtual network instance based on the tenant ID.
OVXSwitch	getVirtualSwitch(PhysicalSwitch physicalSwitch, Integer tenantId) Gets the OVXSwitch which has been specified by the physicalSwitch and tenantId.
boolean	hasMAC(MACAddress mac) Checks if the given MAC address is registered in the map.
boolean	hasOVXLinks(PhysicalLink physicalLink, Integer tenantId) Checks if the given physical link is part of a virtual link in the virtual network identified by the tenant ID.
boolean	hasPhysicalIP(OVXIPAddress vip, Integer tenantId) Checks if the given virtual IP address is mapped to a physical IP in the virtual network identified by the tenant ID.
boolean	hasSwitchRoutes(PhysicalLink physicalLink, Integer tenantId) Checks if the given physical link is part of a virtual switch route in the virtual network identified by the tenant ID.
boolean	hasVirtualIP(PhysicalIPAddress ip)
boolean	hasVirtualSwitch(PhysicalSwitch physicalSwitch, int tenantId)
void	knownLink(PhysicalLink that) Sets the linkid back to the original linkid for a physical link that previously existed and has gone away and come back.
Map<Integer,OVXNetwork>	listVirtualNetworks() Obtains an immutable copy of the list of virtual networks.
void	removeMAC(MACAddress mac) Removes MAC address from the map.
void	removeNetwork(OVXNetwork network) Removes the virtual network from the map.
void	removePhysicalLink(PhysicalLink physicalLink) Removes a PhysicalLink from a Mappable, including mappings to OVXLinks and SwitchRoutes.
void	removePhysicalSwitch(PhysicalSwitch physicalSwitch) Removes a PhysicalSwitch from Mappable mappings.
void	removeRoute(SwitchRoute route) Removes a SwitchRoute from the map.
void	removeVirtualIPs(int tenantId) Delete all the IPs associated to a single virtual network.
void	removeVirtualLink(OVXLink virtualLink) Removes the virtual link from the map.
void	removeVirtualSwitch(OVXSwitch virtualSwitch) Delete the OVXSwitch object.
static void	reset() Resets the map instance.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OVXMap getInstance()

Gets the instance of the class and if this already exists then the existing object will be returned. This is a singleton class.

Returns:

mapInstance Return the OVXMap object instance

reset

public static void reset()

Resets the map instance. Do not use!

addSwitches

public void addSwitches(List<PhysicalSwitch> physicalSwitches,
               OVXSwitch virtualSwitch)

Creates the mapping between PhysicalSwithes and a VirtualSwitch. This function takes in a list of physicalSwitches and adds to the OVXMap indexed by the virtualSwitch.

Specified by:

addSwitches in interface Mappable

Parameters:

physicalSwitches - the list of physical switches

virtualSwitch - the virtual switch

addLinks

public void addLinks(List<PhysicalLink> physicalLinks,
            OVXLink virtualLink)

Creates the mapping between PhysicalLinks and a VirtualLink. This function takes in a list of physicalLinks rather than an individual physicalLink and adds the list to the OVXmap.

Specified by:

addLinks in interface Mappable

Parameters:

physicalLinks - the list of physical links

virtualLink - the virtual link

getAllKeys

public Iterable<CharSequence> getAllKeys()

addIP

public void addIP(PhysicalIPAddress physicalIP,
         OVXIPAddress virtualIP)

This is the generic function which takes as arguments the PhysicalIPAddress and the OVXIPAddress. This will add the value into both the physical to virtual map and in the other direction.

Specified by:

addIP in interface Mappable

Parameters:

physicalIP - Refers to the PhysicalIPAddress which is created using the tenant id and virtualIP

virtualIP - The IP address used within the VirtualNetwork

addNetwork

public void addNetwork(OVXNetwork virtualNetwork)

Maintain a list of all the virtualNetworks in the system indexed by the tenant id mapping to OVXNetworks.

Specified by:

addNetwork in interface Mappable

Parameters:

virtualNetwork - An OVXNetwork object which keeps track of all the elements in the Virtual network

addMAC

public void addMAC(MACAddress mac,
          Integer tenantId)

Description copied from interface: Mappable

Creates the maping between the MAC address and tenant ID.

Specified by:

addMAC in interface Mappable

Parameters:

mac - the MAC address

tenantId - the tenant ID.

addRoute

public void addRoute(SwitchRoute route,
            List<PhysicalLink> physicalLinks)

Description copied from interface: Mappable

Adds a mapping between a SwitchRoute and the PhysicalLinks making it up.

Specified by:

addRoute in interface Mappable

Parameters:

route - the switch route

physicalLinks - the physical path

getPhysicalIP

public PhysicalIPAddress getPhysicalIP(OVXIPAddress ip,
                              Integer tenantId)
                                throws AddressMappingException

Specified by:

getPhysicalIP in interface Mappable

Returns:

Physical IP address associated with virtual IP and tenant ID

Throws:

AddressMappingException

getVirtualIP

public OVXIPAddress getVirtualIP(PhysicalIPAddress ip)
                          throws AddressMappingException

Specified by:

getVirtualIP in interface Mappable

Returns:

Virtual IP address associated with physical IP

Throws:

AddressMappingException

getVirtualSwitch

public OVXSwitch getVirtualSwitch(PhysicalSwitch physicalSwitch,
                         Integer tenantId)
                           throws SwitchMappingException

Gets the OVXSwitch which has been specified by the physicalSwitch and tenantId.

Specified by:

getVirtualSwitch in interface Mappable

Parameters:

physicalSwitch - A PhysicalSwitch object is a single switch in the PhysicalNetwork

tenantId - the tenant ID

Returns:

virtualSwitch the virtual switch

Throws:

SwitchMappingException - if the physical switch is invalid

getVirtualLinks

public List<OVXLink> getVirtualLinks(PhysicalLink physicalLink,
                            Integer tenantId)
                              throws LinkMappingException

Gets the list of OVXLinks that are part of virtual network identified by tenantId and which include the specified physicalLink.

Specified by:

getVirtualLinks in interface Mappable

Parameters:

physicalLink - A PhysicalLink object which represent a single source and destination PhysicalPort and PhysicalSwitch

tenantId - the tenant ID

Returns:

virtualLink A OVXLink object which represents a single link in the OVXNetwork

Throws:

LinkMappingException - if the physical link is invalid

getPhysicalLinks

public List<PhysicalLink> getPhysicalLinks(OVXLink virtualLink)
                                    throws LinkMappingException

Gets the physicalLinks that all make up a specified OVXLink. Return a list of all the physicalLinks that make up the OVXLink.

Specified by:

getPhysicalLinks in interface Mappable

Parameters:

virtualLink - An OVXLink object which represents a single link in the OVXNetwork

Returns:

physicalLinks A List of PhysicalLink objects which represent a single source and destination PhysicalPort and PhysicalSwitch

Throws:

LinkMappingException - if the virtual link is invalid

getPhysicalSwitches

public List<PhysicalSwitch> getPhysicalSwitches(OVXSwitch virtualSwitch)
                                         throws SwitchMappingException

Gets the physical switches that are contained in the OVXSwitch. For a big switch this will be multiple physical switches.

Specified by:

getPhysicalSwitches in interface Mappable

Parameters:

virtualSwitch - A OVXSwitch object representing a single switch in the virtual network

Returns:

physicalSwitches A List of PhysicalSwitch objects that are each part of the OVXSwitch specified

Throws:

SwitchMappingException - if the virtual switch is invalid

getVirtualNetwork

public OVXNetwork getVirtualNetwork(Integer tenantId)
                             throws NetworkMappingException

Gets the virtual network instance based on the tenant ID.

Specified by:

getVirtualNetwork in interface Mappable

Parameters:

tenantId - This is an Integer that represents a unique number for each virtualNetwork

Returns:

virtualNetwork A OVXNetwork object that represents all the information related to a virtual network

Throws:

NetworkMappingException - if the tenant ID is invalid

getMAC

public Integer getMAC(MACAddress mac)
               throws AddressMappingException

Description copied from interface: Mappable

Gets the tenant ID associated with the given MAC address.

Specified by:

getMAC in interface Mappable

Parameters:

mac - the MAC address

Returns:

tenant ID associated with MAC address

Throws:

AddressMappingException

listVirtualNetworks

public Map<Integer,OVXNetwork> listVirtualNetworks()

Description copied from interface: Mappable

Obtains an immutable copy of the list of virtual networks.

Specified by:

listVirtualNetworks in interface Mappable

Returns:

- immutable list of virtual networks

removeNetwork

public void removeNetwork(OVXNetwork network)

Removes the virtual network from the map.

Specified by:

removeNetwork in interface Mappable

Parameters:

network - the virtual network instance

removeVirtualLink

public void removeVirtualLink(OVXLink virtualLink)

Removes the virtual link from the map.

Specified by:

removeVirtualLink in interface Mappable

Parameters:

virtualLink - the virtual link

removePhysicalLink

public void removePhysicalLink(PhysicalLink physicalLink)

Description copied from interface: Mappable

Removes a PhysicalLink from a Mappable, including mappings to OVXLinks and SwitchRoutes.

Specified by:

removePhysicalLink in interface Mappable

Parameters:

physicalLink - the physical link

removeVirtualSwitch

public void removeVirtualSwitch(OVXSwitch virtualSwitch)

Description copied from interface: Mappable

Delete the OVXSwitch object.

Specified by:

removeVirtualSwitch in interface Mappable

removeVirtualIPs

public void removeVirtualIPs(int tenantId)

Description copied from interface: Mappable

Delete all the IPs associated to a single virtual network.

Specified by:

removeVirtualIPs in interface Mappable

Parameters:

tenantId - This is an Integer that represents a unique number for each virtualNetwork

removeMAC

public void removeMAC(MACAddress mac)

Removes MAC address from the map.

Specified by:

removeMAC in interface Mappable

Parameters:

mac - the MAC address

getRoute

public List<PhysicalLink> getRoute(SwitchRoute route)
                            throws LinkMappingException

Description copied from interface: Mappable

Gets the current path as a list of physical links for the given route.

Specified by:

getRoute in interface Mappable

Parameters:

route - the switch route

Returns:

the path

Throws:

LinkMappingException

getSwitchRoutes

public Set<SwitchRoute> getSwitchRoutes(PhysicalLink physicalLink,
                               Integer tenantId)
                                 throws LinkMappingException

Description copied from interface: Mappable

Gets the switch routes that use the given physical link in the specified virtual network.

Specified by:

getSwitchRoutes in interface Mappable

Parameters:

physicalLink - the physical link

tenantId - the tenant ID

Returns:

The routes associated with the supplied PhysicalLink

Throws:

LinkMappingException

removeRoute

public void removeRoute(SwitchRoute route)

Description copied from interface: Mappable

Removes a SwitchRoute from the map.

Specified by:

removeRoute in interface Mappable

Parameters:

route - the switch route

removePhysicalSwitch

public void removePhysicalSwitch(PhysicalSwitch physicalSwitch)

Description copied from interface: Mappable

Removes a PhysicalSwitch from Mappable mappings.

Specified by:

removePhysicalSwitch in interface Mappable

Parameters:

physicalSwitch - the physical switch

hasPhysicalIP

public boolean hasPhysicalIP(OVXIPAddress vip,
                    Integer tenantId)

Checks if the given virtual IP address is mapped to a physical IP in the virtual network identified by the tenant ID.

Specified by:

hasPhysicalIP in interface Mappable

Parameters:

vip - the virtual IP address

tenantId - the tenant ID

Returns:

true if the mapping exists, false otherwise

hasVirtualIP

public boolean hasVirtualIP(PhysicalIPAddress ip)

Specified by:

hasVirtualIP in interface Mappable

Parameters:

ip - The physical IP address

Returns:

true if a mapping exists

hasMAC

public boolean hasMAC(MACAddress mac)

Checks if the given MAC address is registered in the map.

Specified by:

hasMAC in interface Mappable

Parameters:

mac - the MAC address

Returns:

true if the MAC is registered, false otherwise

hasSwitchRoutes

public boolean hasSwitchRoutes(PhysicalLink physicalLink,
                      Integer tenantId)

Checks if the given physical link is part of a virtual switch route in the virtual network identified by the tenant ID.

Specified by:

hasSwitchRoutes in interface Mappable

Parameters:

physicalLink - the physical link

tenantId - the tenant Id

Returns:

true if the physical link is part of a virtual switch route, false otherwise

hasOVXLinks

public boolean hasOVXLinks(PhysicalLink physicalLink,
                  Integer tenantId)

Checks if the given physical link is part of a virtual link in the virtual network identified by the tenant ID.

Specified by:

hasOVXLinks in interface Mappable

Parameters:

physicalLink - the physical link

tenantId - the tenant ID

Returns:

true if the physical link is part of a virtual link, false otherwise

hasVirtualSwitch

public boolean hasVirtualSwitch(PhysicalSwitch physicalSwitch,
                       int tenantId)

Specified by:

hasVirtualSwitch in interface Mappable

Parameters:

physicalSwitch - the PhysicalSwitch mapped to the OVXSwitch we want to check for

tenantId - TenantID of OVXSwitch

Returns:

true if the OVXSwitch exists

knownLink

public void knownLink(PhysicalLink that)

Description copied from interface: Mappable

Sets the linkid back to the original linkid for a physical link that previously existed and has gone away and come back.

Specified by:

knownLink in interface Mappable

Parameters:

that - - the new link that has just been detected,