org.opendaylight.netvirt.elan.internal

Class ElanInterfaceManager

java.lang.Object

org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

org.opendaylight.netvirt.elan.internal.ElanInterfaceManager

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener<ElanInterface>, org.opendaylight.genius.datastoreutils.ChainableDataTreeChangeListener<ElanInterface>

@Singleton
public class ElanInterfaceManager
extends org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>
implements AutoCloseable

Class in charge of handling creations, modifications and removals of ElanInterfaces.

See Also:

ElanInterface

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase

org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase.DataTreeChangeHandler

Field Summary

Fields inherited from class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase

clazz

Constructor Summary

Constructors

Constructor and Description

ElanInterfaceManager(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService managerService, org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalApiManager, org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager interfaceManager, ElanForwardingEntriesHandler elanForwardingEntriesHandler, INeutronVpnManager neutronVpnManager, ElanItmUtils elanItmUtils, ElanEtreeUtils elanEtreeUtils, ElanL2GatewayUtils elanL2GatewayUtils)

Method Summary

Modifier and Type	Method and Description
protected void	add(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> identifier, ElanInterface elanInterfaceAdded)
protected ElanInterfaceManager	getDataTreeChangeListener()
List<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket>	getRemoteBCGroupBuckets(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId, int bucketId, long elanTag)
List<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket>	getRemoteBCGroupBucketsOfElanExternalTeps(ElanInstance elanInfo, BigInteger dpnId, int bucketId)
List<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket>	getRemoteBCGroupBucketsOfElanL2GwDevices(ElanInstance elanInfo, BigInteger dpnId, int bucketId)
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface>	getWildCardPath()
void	handleExternalInterfaceEvent(ElanInstance elanInstance, DpnInterfaces dpnInterfaces, BigInteger dpId)
void	handleExternalTunnelStateEvent(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel externalTunnel, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface intrf) Handle external tunnel state event.
void	handleInternalTunnelStateEvent(BigInteger srcDpId, BigInteger dstDpId)
void	init()
List<com.google.common.util.concurrent.ListenableFuture<Void>>	installDMacAddressTables(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, BigInteger dstDpId)
void	installEntriesForFirstInterfaceonDpn(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, DpnInterfaces dpnInterfaces, boolean isFirstInterfaceInDpn, org.opendaylight.controller.md.sal.binding.api.WriteTransaction tx)
protected void	remove(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> identifier, ElanInterface del)
void	removeElanBroadcastGroup(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, org.opendaylight.controller.md.sal.binding.api.WriteTransaction deleteFlowGroupTx)
List<com.google.common.util.concurrent.ListenableFuture<Void>>	removeElanInterface(ElanInstance elanInfo, String interfaceName, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo)
void	removeFilterEqualsTable(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, org.opendaylight.controller.md.sal.binding.api.WriteTransaction deleteFlowGroupTx)
protected void	removeInterfaceStaticMacEntries(String elanInstanceName, String interfaceName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
void	removeLocalBroadcastGroup(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, org.opendaylight.controller.md.sal.binding.api.WriteTransaction deleteFlowGroupTx)
void	setElanUtils(ElanUtils elanUtils) This method is used instead of "regular" standard constructor dependency injection in, only, ElanServiceProvider's constructor to wire things together.
void	setExternalTunnelTable(BigInteger dpnId, ElanInstance elanInfo) Installs a flow in the External Tunnel table consisting in translating the VNI retrieved from the packet that came over a tunnel with a TOR into elanTag that will be used later in the ELANs pipeline.
void	setupElanBroadcastGroups(ElanInstance elanInfo, BigInteger dpnId)
void	setupElanBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId)
void	setupFilterEqualsTable(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)
void	setupLeavesEtreeBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId)
void	setupLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo)
void	setupStandardElanBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId)
void	setupStandardLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo)
void	setupTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId, long elanTag, org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)
void	setupTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId, org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)
void	setupUnknownDMacTable(ElanInstance elanInfo, BigInteger dpId, org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)
protected void	unbindService(String interfaceName, org.opendaylight.controller.md.sal.binding.api.WriteTransaction tx)
void	unsetExternalTunnelTable(BigInteger dpnId, ElanInstance elanInfo) Removes, from External Tunnel table, the flow that translates from VNI to elanTag.
protected void	update(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> identifier, ElanInterface original, ElanInterface update)
void	updateRemoteBroadcastGroupForAllElanDpns(ElanInstance elanInfo)

Methods inherited from class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase

addAfterListener, addBeforeListener, close, onDataTreeChanged, registerListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

ElanInterfaceManager

@Inject
public ElanInterfaceManager(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                    org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService managerService,
                                    org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalApiManager,
                                    org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager interfaceManager,
                                    ElanForwardingEntriesHandler elanForwardingEntriesHandler,
                                    INeutronVpnManager neutronVpnManager,
                                    ElanItmUtils elanItmUtils,
                                    ElanEtreeUtils elanEtreeUtils,
                                    ElanL2GatewayUtils elanL2GatewayUtils)

Method Detail

setElanUtils

public void setElanUtils(ElanUtils elanUtils)

This method is used instead of "regular" standard constructor dependency injection in, only, ElanServiceProvider's constructor to wire things together. It was done like this because of the unholy triumvirate of unhealthy love triangle between (at least) ElanUtils, ElanInterfaceManager and ElanL2GatewayMulticastUtils. The proper solution to be able to get rid of this would be to split up some of these relatively big classes into smaller classes, and then inject more fine grained among them.

init

@PostConstruct
public void init()

Overrides:

init in class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

getWildCardPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> getWildCardPath()

Specified by:

getWildCardPath in class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

remove

protected void remove(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> identifier,
                      ElanInterface del)

Specified by:

remove in class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

removeElanInterface

public List<com.google.common.util.concurrent.ListenableFuture<Void>> removeElanInterface(ElanInstance elanInfo,
                                                                                          String interfaceName,
                                                                                          org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo)

update

protected void update(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> identifier,
                      ElanInterface original,
                      ElanInterface update)

Specified by:

update in class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

add

protected void add(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> identifier,
                   ElanInterface elanInterfaceAdded)

Specified by:

add in class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

removeInterfaceStaticMacEntries

protected void removeInterfaceStaticMacEntries(String elanInstanceName,
                                               String interfaceName,
                                               org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)

installEntriesForFirstInterfaceonDpn

public void installEntriesForFirstInterfaceonDpn(ElanInstance elanInfo,
                                                 org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                                 DpnInterfaces dpnInterfaces,
                                                 boolean isFirstInterfaceInDpn,
                                                 org.opendaylight.controller.md.sal.binding.api.WriteTransaction tx)

setupFilterEqualsTable

public void setupFilterEqualsTable(ElanInstance elanInfo,
                                   org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                   org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)

removeFilterEqualsTable

public void removeFilterEqualsTable(ElanInstance elanInfo,
                                    org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                    org.opendaylight.controller.md.sal.binding.api.WriteTransaction deleteFlowGroupTx)

getRemoteBCGroupBuckets

public List<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket> getRemoteBCGroupBuckets(ElanInstance elanInfo,
                                                                                                                              DpnInterfaces dpnInterfaces,
                                                                                                                              BigInteger dpnId,
                                                                                                                              int bucketId,
                                                                                                                              long elanTag)

installDMacAddressTables

public List<com.google.common.util.concurrent.ListenableFuture<Void>> installDMacAddressTables(ElanInstance elanInfo,
                                                                                               org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                                                                               BigInteger dstDpId)
                                                                                        throws ElanException

Throws:

ElanException

setupElanBroadcastGroups

public void setupElanBroadcastGroups(ElanInstance elanInfo,
                                     BigInteger dpnId)

setupElanBroadcastGroups

public void setupElanBroadcastGroups(ElanInstance elanInfo,
                                     DpnInterfaces dpnInterfaces,
                                     BigInteger dpnId)

setupStandardElanBroadcastGroups

public void setupStandardElanBroadcastGroups(ElanInstance elanInfo,
                                             DpnInterfaces dpnInterfaces,
                                             BigInteger dpnId)

setupLeavesEtreeBroadcastGroups

public void setupLeavesEtreeBroadcastGroups(ElanInstance elanInfo,
                                            DpnInterfaces dpnInterfaces,
                                            BigInteger dpnId)

setupLocalBroadcastGroups

public void setupLocalBroadcastGroups(ElanInstance elanInfo,
                                      DpnInterfaces newDpnInterface,
                                      org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo)

setupStandardLocalBroadcastGroups

public void setupStandardLocalBroadcastGroups(ElanInstance elanInfo,
                                              DpnInterfaces newDpnInterface,
                                              org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo)

removeLocalBroadcastGroup

public void removeLocalBroadcastGroup(ElanInstance elanInfo,
                                      org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                      org.opendaylight.controller.md.sal.binding.api.WriteTransaction deleteFlowGroupTx)

removeElanBroadcastGroup

public void removeElanBroadcastGroup(ElanInstance elanInfo,
                                     org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                     org.opendaylight.controller.md.sal.binding.api.WriteTransaction deleteFlowGroupTx)

setExternalTunnelTable

public void setExternalTunnelTable(BigInteger dpnId,
                                   ElanInstance elanInfo)

Installs a flow in the External Tunnel table consisting in translating the VNI retrieved from the packet that came over a tunnel with a TOR into elanTag that will be used later in the ELANs pipeline.

Parameters:

dpnId - the dpn id

elanInfo - the elan info

unsetExternalTunnelTable

public void unsetExternalTunnelTable(BigInteger dpnId,
                                     ElanInstance elanInfo)

Removes, from External Tunnel table, the flow that translates from VNI to elanTag. Important: ensure this method is only called whenever there is no other ElanInterface in the specified DPN

Parameters:

dpnId - DPN whose Ext Tunnel table is going to be modified

elanInfo - holds the elanTag needed for selecting the flow to be removed

setupTerminateServiceTable

public void setupTerminateServiceTable(ElanInstance elanInfo,
                                       BigInteger dpId,
                                       org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)

setupTerminateServiceTable

public void setupTerminateServiceTable(ElanInstance elanInfo,
                                       BigInteger dpId,
                                       long elanTag,
                                       org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)

setupUnknownDMacTable

public void setupUnknownDMacTable(ElanInstance elanInfo,
                                  BigInteger dpId,
                                  org.opendaylight.controller.md.sal.binding.api.WriteTransaction writeFlowGroupTx)

unbindService

protected void unbindService(String interfaceName,
                             org.opendaylight.controller.md.sal.binding.api.WriteTransaction tx)

handleInternalTunnelStateEvent

public void handleInternalTunnelStateEvent(BigInteger srcDpId,
                                           BigInteger dstDpId)
                                    throws ElanException

Throws:

ElanException

handleExternalTunnelStateEvent

public void handleExternalTunnelStateEvent(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel externalTunnel,
                                           org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface intrf)
                                    throws ElanException

Handle external tunnel state event.

Parameters:

externalTunnel - the external tunnel

intrf - the interface

Throws:

ElanException - in case of issues creating the flow objects

updateRemoteBroadcastGroupForAllElanDpns

public void updateRemoteBroadcastGroupForAllElanDpns(ElanInstance elanInfo)

getRemoteBCGroupBucketsOfElanL2GwDevices

public List<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket> getRemoteBCGroupBucketsOfElanL2GwDevices(ElanInstance elanInfo,
                                                                                                                                               BigInteger dpnId,
                                                                                                                                               int bucketId)

getRemoteBCGroupBucketsOfElanExternalTeps

public List<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket> getRemoteBCGroupBucketsOfElanExternalTeps(ElanInstance elanInfo,
                                                                                                                                                BigInteger dpnId,
                                                                                                                                                int bucketId)

getDataTreeChangeListener

protected ElanInterfaceManager getDataTreeChangeListener()

Specified by:

getDataTreeChangeListener in class org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase<ElanInterface,ElanInterfaceManager>

handleExternalInterfaceEvent

public void handleExternalInterfaceEvent(ElanInstance elanInstance,
                                         DpnInterfaces dpnInterfaces,
                                         BigInteger dpId)