org.opendaylight.netvirt.elan.utils

Class ElanUtils

java.lang.Object

org.opendaylight.netvirt.elan.utils.ElanUtils

@Singleton
public class ElanUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.util.concurrent.FutureCallback<Void>	DEFAULT_CALLBACK

Constructor Summary

Constructors

Constructor and Description

ElanUtils(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService interfaceManagerRpcService, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService, ElanConfig elanConfig, org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager interfaceManager, ElanEtreeUtils elanEtreeUtils, ElanItmUtils elanItmUtils, ElanInterfaceCache elanInterfaceCache, org.opendaylight.genius.itm.api.IITMProvider iitmProvider)

Method Summary

Modifier and Type	Method and Description
void	addDmacRedirectToDispatcherFlows(Long elanTag, String displayName, String macAddress, List<BigInteger> dpnIds)
static org.opendaylight.genius.mdsalutil.FlowEntity	buildDmacRedirectToDispatcherFlow(BigInteger dpId, String dstMacAddress, String displayName, long elanTag)
org.opendaylight.genius.mdsalutil.FlowEntity	buildKnownSmacFlow(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, long macTimeout, String macAddress)
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow	buildLocalDmacFlowEntry(long elanTag, BigInteger dpId, String ifName, String macAddress, ElanInstance elanInfo, long ifTag) Builds the flow to be programmed in the DMAC table of the local DPN (that is, where the MAC is attached to).
static List<org.opendaylight.genius.mdsalutil.MatchInfo>	buildMatchesForElanTagShFlagAndDstMac(long elanTag, boolean shFlag, String macAddr)
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow	buildRemoteDmacFlowEntry(BigInteger srcDpId, BigInteger destDpId, long lportTagOrVni, long elanTag, String macAddress, String displayName, ElanInstance elanInstance) Builds a Flow to be programmed in a remote DPN's DMAC table.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices>	buildServiceId(String interfaceName, short serviceIndex)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface>	createInterfaceStateInstanceIdentifier(String interfaceName) Creates the interface state instance identifier.
static <T extends org.opendaylight.yangtools.yang.binding.DataObject> void	delete(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)
void	deleteMacFlows(@Nullable ElanInstance elanInfo, @Nullable org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, MacEntry macEntry, org.opendaylight.genius.infra.TypedReadWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> flowTx)
void	deleteMacFlows(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, String macAddress, boolean deleteSmac, org.opendaylight.genius.infra.TypedReadWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> flowTx)
static <T> List<T>	diffOf(List<T> orig, List<T> updated)
List<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel>	getAllExternalTunnels(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType) Gets the all external tunnels.
static org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices	getBoundServices(String serviceName, short servicePriority, int flowPriority, BigInteger cookie, List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> instructions)
@NonNull List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action>	getEgressActionsForInterface(String ifName, @Nullable Long tunnelKey) Returns the list of Actions to be taken when sending the packet through an Elan interface.
static @Nullable Elan	getElanByName(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String elanInstanceName)
static @Nullable Elan	getElanByName(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx, String elanInstanceName)
@NonNull List<DpnInterfaces>	getElanDPNByName(String elanInstanceName)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<DpnInterfaces>	getElanDpnInterfaceOperationalDataPath(String elanInstanceName, BigInteger dpId) Returns the InstanceIdentifier that points to the Interfaces of an Elan in a given DPN in the Operational DS.
@Nullable ElanDpnInterfaces	getElanDpnInterfacesList()
@Nullable ElanDpnInterfacesList	getElanDpnInterfacesList(String elanName)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanDpnInterfacesList>	getElanDpnOperationDataPath(String elanInstanceName)
@Nullable ElanTagName	getElanInfoByElanTag(long elanTag)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanTagName>	getElanInfoEntriesOperationalDataPath(long elanTag)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<Elan>	getElanInstanceOperationalDataPath(String elanInstanceName)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface>	getElanInterfaceConfigurationDataPathId(String interfaceName)
@Nullable DpnInterfaces	getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) Returns the list of Interfaces that belong to an Elan on an specific DPN.
static String	getElanInterfaceJobKey(String interfaceName)
static @Nullable ElanInterfaceMac	getElanInterfaceMacByInterfaceName(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, String interfaceName)
ElanInterfaceMac	getElanInterfaceMacByInterfaceName(String interfaceName)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterfaceMac>	getElanInterfaceMacEntriesOperationalDataPath(String interfaceName)
static long	getElanLocalBCGId(long elanTag)
List<MacEntry>	getElanMacEntries(String elanName)
static @Nullable MacTable	getElanMacTable(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, String elanName)
@Nullable MacTable	getElanMacTable(String elanName) Gets the elan mac table.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacTable>	getElanMacTableOperationalDataPath(String elanName)
static BigInteger	getElanMetadataLabel(long elanTag, boolean isSHFlagSet)
static long	getElanRemoteBCGId(long elanTag)
static long	getElanRemoteBroadCastGroupID(long elanTag)
static String	getElanServiceName(String elanName, String interfaceName)
static long	getEtreeLeafLocalBCGId(long etreeLeafTag)
static long	getEtreeLeafRemoteBCGId(long etreeLeafTag)
@Nullable String	getExternalElanInterface(String elanInstanceName, BigInteger dpnId)
@Nullable org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel	getExternalTunnel(String interfaceName, org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType) Gets the external tunnel.
@Nullable org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel	getExternalTunnel(String sourceDevice, String destinationDevice, org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType) Gets the external tunnel.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow>	getFlowIid(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flow, BigInteger dpnId)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group>	getGroupInstanceid(BigInteger dpnId, long groupId)
List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction>	getInstructionsInPortForOutGroup(String ifName) Constructs the Instructions that take the packet over a given interface.
com.google.common.base.Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface>	getInterfaceInfoByInterfaceTag(long interfaceTag)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface>	getInterfaceInfoEntriesOperationalDataPath(long interfaceTag)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry>	getInterfaceMacEntriesIdentifierOperationalDataPath(String interfaceName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
@Nullable MacEntry	getInterfaceMacEntriesOperationalDataPath(String interfaceName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
@Nullable MacEntry	getInterfaceMacEntriesOperationalDataPathFromId(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry> identifier)
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface	getInterfaceStateFromOperDS(String interfaceName, org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker) Gets the interface state from operational ds.
static String	getIntTunnelTableFlowRef(short tableId, int elanTag) Constructs the FlowName for flows installed in the Internal Tunnel Table, consisting in tableId + elanTag.
@NonNull List<DpnInterfaces>	getInvolvedDpnsInElan(String elanName)
static String	getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, BigInteger remoteDpId, String macAddress, long elanTag)
static String	getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, long lporTag, String macAddress, long elanTag)
static String	getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, String macAddress, long elanTag)
static String	getKnownDynamicmacFlowRef(short elanDmacTable, BigInteger dpId, String extDeviceNodeId, String dstMacAddress, long elanTag, boolean shFlag)
com.google.common.base.Optional<MacEntry>	getMacEntryForElanInstance(String elanName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
com.google.common.base.Optional<MacEntry>	getMacEntryForElanInstance(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx, String elanName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
@Nullable MacEntry	getMacEntryFromElanMacId(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry> identifier)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry>	getMacEntryOperationalDataPath(String elanName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
@NonNull List<BigInteger>	getParticipatingDpnsInElanInstance(String elanInstanceName) This method is useful get all ELAN participating CSS dpIds to install program remote dmac entries and updating remote bc groups for tor integration.
static List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress>	getPhysAddress(List<String> macAddress)
static @Nullable String	getRouterPordIdFromElanInstance(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, String elanInstanceName)
com.google.common.base.Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress>	getSourceIpAddress(org.opendaylight.genius.mdsalutil.packet.Ethernet ethernet)
static List<StaticMacEntries>	getStaticMacEntries(List<String> staticMacAddresses)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<StaticMacEntries>	getStaticMacEntriesCfgDataPathIdentifier(String interfaceName, String macAddress)
static List<org.opendaylight.genius.mdsalutil.MatchInfo>	getTunnelIdMatchForFilterEqualsLPortTag(int lportTag) Constructs the Matches that checks that the tunnel_id field contains a specific lportTag.
static List<org.opendaylight.genius.mdsalutil.MatchInfo>	getTunnelMatchesForServiceId(int elanTag)
static Long	getVxlanSegmentationId(ElanInstance elanInstance)
boolean	isDpnPresent(BigInteger dpnId)
static boolean	isEmpty(Collection collection)
static boolean	isFlat(ElanInstance elanInstance)
static boolean	isInterfaceOperational(String interfaceName, org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker) Checks if is interface operational.
static boolean	isNotEmpty(Collection collection)
Boolean	isOpenstackVniSemanticsEnforced()
boolean	isTunnelInLogicalGroup(String interfaceName)
static boolean	isVlan(ElanInstance elanInstance)
static boolean	isVxlan(@Nullable ElanInstance elanInstance)
static boolean	isVxlanNetworkOrVxlanSegment(@Nullable ElanInstance elanInstance)
static org.opendaylight.infrautils.utils.concurrent.NamedSimpleReentrantLock.Acquired	lockElanMacDPN(long elanTag, String macAddress, BigInteger dpnId)
static <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Optional<T>	read(@NonNull org.opendaylight.controller.md.sal.binding.api.DataBroker broker, org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path) Deprecated. Consider using read2(LogicalDatastoreType, InstanceIdentifier) with proper exception handling instead
<T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Optional<T>	read2(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)
static void	releaseId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager, String poolName, String idKey)
void	removeArpResponderFlow(BigInteger dpnId, String ingressInterfaceName, String ipAddress, int lportTag)
void	removeDmacRedirectToDispatcherFlows(Long elanTag, String macAddress, List<BigInteger> dpnIds)
void	removeTerminatingServiceAction(BigInteger destDpId, int serviceId)
static Long	retrieveNewElanTag(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager, String idKey) Uses the IdManager to retrieve a brand new ElanTag.
static List<com.google.common.util.concurrent.ListenableFuture<Void>>	returnFailedListenableFutureIfTransactionCommitFailedExceptionCauseOrElseThrow(RuntimeException exception)
void	setupDMacFlowOnRemoteDpn(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, BigInteger dstDpId, String macAddress, org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowTx)
void	setupMacFlows(ElanInstance elanInfo, org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, long macTimeout, String macAddress, boolean configureRemoteFlows, org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowGroupTx) Setting SMAC, DMAC, UDMAC in this DPN and optionally in other DPNs.
void	setupRemoteDmacFlow(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag, String macAddress, String displayName, org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowGroupTx, String interfaceName, ElanInstance elanInstance)
void	setupTermDmacFlows(org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo, org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalApiManager, org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowGroupTx) Installs a Flow in INTERNAL_TUNNEL_TABLE of the affected DPN that sends the packet through the specified interface if the tunnel_id matches the interface's lportTag.
static ElanInstance	updateOperationalDataStore(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager, ElanInstance elanInstanceAdded, List<String> elanInterfaces, org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> confTx, org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Operational> operTx) Updates the Elan information in the Operational DS.
static com.google.common.util.concurrent.ListenableFuture<Void>	waitForTransactionToComplete(com.google.common.util.concurrent.ListenableFuture<Void> future)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CALLBACK

public static final com.google.common.util.concurrent.FutureCallback<Void> DEFAULT_CALLBACK

Constructor Detail

ElanUtils

@Inject
public ElanUtils(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                         org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager,
                         org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService interfaceManagerRpcService,
                         org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService,
                         ElanConfig elanConfig,
                         org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager interfaceManager,
                         ElanEtreeUtils elanEtreeUtils,
                         ElanItmUtils elanItmUtils,
                         ElanInterfaceCache elanInterfaceCache,
                         org.opendaylight.genius.itm.api.IITMProvider iitmProvider)

Method Detail

isOpenstackVniSemanticsEnforced

public final Boolean isOpenstackVniSemanticsEnforced()

retrieveNewElanTag

public static Long retrieveNewElanTag(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager,
                                      String idKey)

Uses the IdManager to retrieve a brand new ElanTag.

Parameters:

idManager - the id manager

idKey - the id key

Returns:

the integer

releaseId

public static void releaseId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager,
                             String poolName,
                             String idKey)

read

@Deprecated
public static <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Optional<T> read(@NonNull org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                                                                 org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType,
                                                                                                                                 org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)

Deprecated. Consider using read2(LogicalDatastoreType, InstanceIdentifier) with proper exception handling instead

Read utility.

Type Parameters:

T - T extends DataObject

Parameters:

broker - dataBroker

datastoreType - Logical DataStore type

path - IID to read

Returns:

the read value T

read2

public <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Optional<T> read2(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType,
                                                                                                               org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)
                                                                                                        throws org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

Throws:

org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

delete

public static <T extends org.opendaylight.yangtools.yang.binding.DataObject> void delete(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                         org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType,
                                                                                         org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)

getElanInterfaceConfigurationDataPathId

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName)

getElanByName

public static @Nullable Elan getElanByName(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                           String elanInstanceName)

getElanByName

public static @Nullable Elan getElanByName(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx,
                                           String elanInstanceName)
                                    throws ExecutionException,
                                           InterruptedException

Throws:

ExecutionException

InterruptedException

getElanInstanceOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<Elan> getElanInstanceOperationalDataPath(String elanInstanceName)

getInterfaceMacEntriesOperationalDataPath

public @Nullable MacEntry getInterfaceMacEntriesOperationalDataPath(String interfaceName,
                                                                    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)

getInterfaceMacEntriesOperationalDataPathFromId

public @Nullable MacEntry getInterfaceMacEntriesOperationalDataPathFromId(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx,
                                                                          org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry> identifier)
                                                                   throws ExecutionException,
                                                                          InterruptedException

Throws:

ExecutionException

InterruptedException

getInterfaceMacEntriesIdentifierOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry> getInterfaceMacEntriesIdentifierOperationalDataPath(String interfaceName,
                                                                                                                                       org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)

getMacEntryForElanInstance

public com.google.common.base.Optional<MacEntry> getMacEntryForElanInstance(String elanName,
                                                                            org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)

getMacEntryForElanInstance

public com.google.common.base.Optional<MacEntry> getMacEntryForElanInstance(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx,
                                                                            String elanName,
                                                                            org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)
                                                                     throws ExecutionException,
                                                                            InterruptedException

Throws:

ExecutionException

InterruptedException

getMacEntryFromElanMacId

public @Nullable MacEntry getMacEntryFromElanMacId(org.opendaylight.genius.infra.TypedReadTransaction<org.opendaylight.genius.infra.Datastore.Operational> tx,
                                                   org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry> identifier)
                                            throws ExecutionException,
                                                   InterruptedException

Throws:

ExecutionException

InterruptedException

getMacEntryOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacEntry> getMacEntryOperationalDataPath(String elanName,
                                                                                                                  org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress)

getElanMacTableOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MacTable> getElanMacTableOperationalDataPath(String elanName)

getElanInterfaceMacByInterfaceName

public ElanInterfaceMac getElanInterfaceMacByInterfaceName(String interfaceName)

getElanInterfaceMacByInterfaceName

public static @Nullable ElanInterfaceMac getElanInterfaceMacByInterfaceName(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                                                            String interfaceName)

getElanInterfaceMacEntriesOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterfaceMac> getElanInterfaceMacEntriesOperationalDataPath(String interfaceName)

getElanInterfaceInfoByElanDpn

public @Nullable DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName,
                                                             BigInteger dpId)

Returns the list of Interfaces that belong to an Elan on an specific DPN. Data retrieved from Elan's operational DS: elan-dpn-interfaces container.

Parameters:

elanInstanceName - name of the Elan to which the interfaces must belong to

dpId - Id of the DPN where the interfaces are located

Returns:

the elan interface Info

getElanDpnInterfaceOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
                                                                                                                               BigInteger dpId)

Returns the InstanceIdentifier that points to the Interfaces of an Elan in a given DPN in the Operational DS. Data retrieved from Elans's operational DS: dpn-interfaces list

Parameters:

elanInstanceName - name of the Elan to which the interfaces must belong to

dpId - Id of the DPN where the interfaces are located

Returns:

the elan dpn interface

getElanInfoByElanTag

public @Nullable ElanTagName getElanInfoByElanTag(long elanTag)

getElanInfoEntriesOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag)

getInterfaceInfoByInterfaceTag

public com.google.common.base.Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface> getInterfaceInfoByInterfaceTag(long interfaceTag)

getInterfaceInfoEntriesOperationalDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag)

getElanDpnOperationDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName)

getElanDpnInterfacesList

public @Nullable ElanDpnInterfacesList getElanDpnInterfacesList(String elanName)

getElanDpnInterfacesList

public @Nullable ElanDpnInterfaces getElanDpnInterfacesList()

getParticipatingDpnsInElanInstance

public @NonNull List<BigInteger> getParticipatingDpnsInElanInstance(String elanInstanceName)

This method is useful get all ELAN participating CSS dpIds to install program remote dmac entries and updating remote bc groups for tor integration.

Parameters:

elanInstanceName - the elan instance name

Returns:

list of dpIds

getElanRemoteBroadCastGroupID

public static long getElanRemoteBroadCastGroupID(long elanTag)

getElanMacTable

public @Nullable MacTable getElanMacTable(String elanName)

Gets the elan mac table.

Parameters:

elanName - the elan name

Returns:

the elan mac table

getElanMacTable

public static @Nullable MacTable getElanMacTable(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                                 String elanName)

getElanLocalBCGId

public static long getElanLocalBCGId(long elanTag)

getElanRemoteBCGId

public static long getElanRemoteBCGId(long elanTag)

getEtreeLeafLocalBCGId

public static long getEtreeLeafLocalBCGId(long etreeLeafTag)

getEtreeLeafRemoteBCGId

public static long getEtreeLeafRemoteBCGId(long etreeLeafTag)

getElanMetadataLabel

public static BigInteger getElanMetadataLabel(long elanTag,
                                              boolean isSHFlagSet)

setupMacFlows

public void setupMacFlows(ElanInstance elanInfo,
                          org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                          long macTimeout,
                          String macAddress,
                          boolean configureRemoteFlows,
                          org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowGroupTx)

Setting SMAC, DMAC, UDMAC in this DPN and optionally in other DPNs.

Parameters:

elanInfo - the elan info

interfaceInfo - the interface info

macTimeout - the mac timeout

macAddress - the mac address

configureRemoteFlows - true if remote dmac flows should be configured as well

writeFlowGroupTx - the flow group tx

setupDMacFlowOnRemoteDpn

public void setupDMacFlowOnRemoteDpn(ElanInstance elanInfo,
                                     org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                     BigInteger dstDpId,
                                     String macAddress,
                                     org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowTx)

buildKnownSmacFlow

public org.opendaylight.genius.mdsalutil.FlowEntity buildKnownSmacFlow(ElanInstance elanInfo,
                                                                       org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                                                                       long macTimeout,
                                                                       String macAddress)

setupTermDmacFlows

public void setupTermDmacFlows(org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                               org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalApiManager,
                               org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowGroupTx)

Installs a Flow in INTERNAL_TUNNEL_TABLE of the affected DPN that sends the packet through the specified interface if the tunnel_id matches the interface's lportTag.

Parameters:

interfaceInfo - the interface info

mdsalApiManager - the mdsal API manager

writeFlowGroupTx - the writeFLowGroup tx

getIntTunnelTableFlowRef

public static String getIntTunnelTableFlowRef(short tableId,
                                              int elanTag)

Constructs the FlowName for flows installed in the Internal Tunnel Table, consisting in tableId + elanTag.

Parameters:

tableId - table Id

elanTag - elan Tag

Returns:

the Internal tunnel

getTunnelIdMatchForFilterEqualsLPortTag

public static List<org.opendaylight.genius.mdsalutil.MatchInfo> getTunnelIdMatchForFilterEqualsLPortTag(int lportTag)

Constructs the Matches that checks that the tunnel_id field contains a specific lportTag.

Parameters:

lportTag - lportTag that must be checked against the tunnel_id field

Returns:

the list of match Info

getInstructionsInPortForOutGroup

public List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> getInstructionsInPortForOutGroup(String ifName)

Constructs the Instructions that take the packet over a given interface.

Parameters:

ifName - Name of the interface where the packet must be sent over. It can be a local interface or a tunnel interface (internal or external)

Returns:

the Instruction

getEgressActionsForInterface

public @NonNull List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> getEgressActionsForInterface(String ifName,
                                                                                                                                           @Nullable Long tunnelKey)

Returns the list of Actions to be taken when sending the packet through an Elan interface. Note that this interface can refer to an ElanInterface where the Elan VM is attached to a DPN or an ITM tunnel interface where Elan traffic can be sent through. In this latter case, the tunnelKey is mandatory and it can hold serviceId for internal tunnels or the VNI for external tunnels.

Parameters:

ifName - the if name

tunnelKey - the tunnel key

Returns:

the egress actions for interface

getInvolvedDpnsInElan

public @NonNull List<DpnInterfaces> getInvolvedDpnsInElan(String elanName)

getElanDPNByName

public @NonNull List<DpnInterfaces> getElanDPNByName(String elanInstanceName)

getKnownDynamicmacFlowRef

public static String getKnownDynamicmacFlowRef(short tableId,
                                               BigInteger dpId,
                                               long lporTag,
                                               String macAddress,
                                               long elanTag)

getKnownDynamicmacFlowRef

public static String getKnownDynamicmacFlowRef(short tableId,
                                               BigInteger dpId,
                                               BigInteger remoteDpId,
                                               String macAddress,
                                               long elanTag)

getKnownDynamicmacFlowRef

public static String getKnownDynamicmacFlowRef(short tableId,
                                               BigInteger dpId,
                                               String macAddress,
                                               long elanTag)

getKnownDynamicmacFlowRef

public static String getKnownDynamicmacFlowRef(short elanDmacTable,
                                               BigInteger dpId,
                                               String extDeviceNodeId,
                                               String dstMacAddress,
                                               long elanTag,
                                               boolean shFlag)

buildLocalDmacFlowEntry

public org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow buildLocalDmacFlowEntry(long elanTag,
                                                                                                                        BigInteger dpId,
                                                                                                                        String ifName,
                                                                                                                        String macAddress,
                                                                                                                        ElanInstance elanInfo,
                                                                                                                        long ifTag)

Builds the flow to be programmed in the DMAC table of the local DPN (that is, where the MAC is attached to). This flow consists in:

Match: + elanTag in metadata + packet goes to a MAC locally attached Actions: + optionally, pop-vlan + set-vlan-id + output to ifName's portNumber

Parameters:

elanTag - the elan tag

dpId - the dp id

ifName - the if name

macAddress - the mac address

elanInfo - the elan info

ifTag - the if tag

Returns:

the flow

setupRemoteDmacFlow

public void setupRemoteDmacFlow(BigInteger srcDpId,
                                BigInteger destDpId,
                                int lportTag,
                                long elanTag,
                                String macAddress,
                                String displayName,
                                org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> writeFlowGroupTx,
                                String interfaceName,
                                ElanInstance elanInstance)

buildRemoteDmacFlowEntry

public org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow buildRemoteDmacFlowEntry(BigInteger srcDpId,
                                                                                                                         BigInteger destDpId,
                                                                                                                         long lportTagOrVni,
                                                                                                                         long elanTag,
                                                                                                                         String macAddress,
                                                                                                                         String displayName,
                                                                                                                         ElanInstance elanInstance)

Builds a Flow to be programmed in a remote DPN's DMAC table. This flow consists in: Match: + elanTag in packet's metadata + packet going to a MAC known to be located in another DPN Actions: + set_tunnel_id + output ITM internal tunnel interface with the other DPN

Parameters:

srcDpId - the src Dpn Id

destDpId - dest Dp Id

lportTagOrVni - lportTag or network VNI

elanTag - elan Tag

macAddress - macAddress

displayName - display Name

elanInstance - elanInstance

Returns:

the flow remote Dmac

deleteMacFlows

public void deleteMacFlows(@Nullable ElanInstance elanInfo,
                           @Nullable org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                           MacEntry macEntry,
                           org.opendaylight.genius.infra.TypedReadWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> flowTx)
                    throws ExecutionException,
                           InterruptedException

Throws:

ExecutionException

InterruptedException

deleteMacFlows

public void deleteMacFlows(ElanInstance elanInfo,
                           org.opendaylight.genius.interfacemanager.globals.InterfaceInfo interfaceInfo,
                           String macAddress,
                           boolean deleteSmac,
                           org.opendaylight.genius.infra.TypedReadWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> flowTx)
                    throws ExecutionException,
                           InterruptedException

Throws:

ExecutionException

InterruptedException

updateOperationalDataStore

public static ElanInstance updateOperationalDataStore(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager,
                                                      ElanInstance elanInstanceAdded,
                                                      List<String> elanInterfaces,
                                                      org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Configuration> confTx,
                                                      org.opendaylight.genius.infra.TypedWriteTransaction<org.opendaylight.genius.infra.Datastore.Operational> operTx)

Updates the Elan information in the Operational DS. It also updates the ElanInstance in the Config DS by setting the adquired elanTag.

Parameters:

idManager - the id manager

elanInstanceAdded - the elan instance added

elanInterfaces - the elan interfaces

operTx - transaction

Returns:

the updated ELAN instance.

isDpnPresent

public boolean isDpnPresent(BigInteger dpnId)

getElanServiceName

public static String getElanServiceName(String elanName,
                                        String interfaceName)

getBoundServices

public static org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices getBoundServices(String serviceName,
                                                                                                                                                                           short servicePriority,
                                                                                                                                                                           int flowPriority,
                                                                                                                                                                           BigInteger cookie,
                                                                                                                                                                           List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> instructions)

buildServiceId

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices> buildServiceId(String interfaceName,
                                                                                                                                                                                                                                     short serviceIndex)

getTunnelMatchesForServiceId

public static List<org.opendaylight.genius.mdsalutil.MatchInfo> getTunnelMatchesForServiceId(int elanTag)

removeTerminatingServiceAction

public void removeTerminatingServiceAction(BigInteger destDpId,
                                           int serviceId)

getExternalTunnel

public @Nullable org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel getExternalTunnel(String sourceDevice,
                                                                                                                                             String destinationDevice,
                                                                                                                                             org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType)

Gets the external tunnel.

Parameters:

sourceDevice - the source device

destinationDevice - the destination device

datastoreType - the datastore type

Returns:

the external tunnel

getExternalTunnel

public @Nullable org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel getExternalTunnel(String interfaceName,
                                                                                                                                             org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType)

Gets the external tunnel.

Parameters:

interfaceName - the interface name

datastoreType - the datastore type

Returns:

the external tunnel

getAllExternalTunnels

public List<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel> getAllExternalTunnels(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType)

Gets the all external tunnels.

Parameters:

datastoreType - the data store type

Returns:

the all external tunnels

buildMatchesForElanTagShFlagAndDstMac

public static List<org.opendaylight.genius.mdsalutil.MatchInfo> buildMatchesForElanTagShFlagAndDstMac(long elanTag,
                                                                                                      boolean shFlag,
                                                                                                      String macAddr)

isInterfaceOperational

public static boolean isInterfaceOperational(String interfaceName,
                                             org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)

Checks if is interface operational.

Parameters:

interfaceName - the interface name

dataBroker - the data broker

Returns:

true, if is interface operational

getInterfaceStateFromOperDS

public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface getInterfaceStateFromOperDS(String interfaceName,
                                                                                                                                                        org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)

Gets the interface state from operational ds.

Parameters:

interfaceName - the interface name

dataBroker - the data broker

Returns:

the interface state from oper ds

createInterfaceStateInstanceIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> createInterfaceStateInstanceIdentifier(String interfaceName)

Creates the interface state instance identifier.

Parameters:

interfaceName - the interface name

Returns:

the instance identifier

waitForTransactionToComplete

@CheckReturnValue
public static com.google.common.util.concurrent.ListenableFuture<Void> waitForTransactionToComplete(com.google.common.util.concurrent.ListenableFuture<Void> future)

isVxlan

public static boolean isVxlan(@Nullable ElanInstance elanInstance)

isVxlanNetworkOrVxlanSegment

public static boolean isVxlanNetworkOrVxlanSegment(@Nullable ElanInstance elanInstance)

getVxlanSegmentationId

public static Long getVxlanSegmentationId(ElanInstance elanInstance)

isVlan

public static boolean isVlan(ElanInstance elanInstance)

isFlat

public static boolean isFlat(ElanInstance elanInstance)

addDmacRedirectToDispatcherFlows

public void addDmacRedirectToDispatcherFlows(Long elanTag,
                                             String displayName,
                                             String macAddress,
                                             List<BigInteger> dpnIds)

removeDmacRedirectToDispatcherFlows

public void removeDmacRedirectToDispatcherFlows(Long elanTag,
                                                String macAddress,
                                                List<BigInteger> dpnIds)

buildDmacRedirectToDispatcherFlow

public static org.opendaylight.genius.mdsalutil.FlowEntity buildDmacRedirectToDispatcherFlow(BigInteger dpId,
                                                                                             String dstMacAddress,
                                                                                             String displayName,
                                                                                             long elanTag)

getExternalElanInterface

public @Nullable String getExternalElanInterface(String elanInstanceName,
                                                 BigInteger dpnId)

lockElanMacDPN

public static org.opendaylight.infrautils.utils.concurrent.NamedSimpleReentrantLock.Acquired lockElanMacDPN(long elanTag,
                                                                                                            String macAddress,
                                                                                                            BigInteger dpnId)

returnFailedListenableFutureIfTransactionCommitFailedExceptionCauseOrElseThrow

public static List<com.google.common.util.concurrent.ListenableFuture<Void>> returnFailedListenableFutureIfTransactionCommitFailedExceptionCauseOrElseThrow(RuntimeException exception)

getPhysAddress

public static List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress> getPhysAddress(List<String> macAddress)

getStaticMacEntries

public static List<StaticMacEntries> getStaticMacEntries(List<String> staticMacAddresses)

getStaticMacEntriesCfgDataPathIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<StaticMacEntries> getStaticMacEntriesCfgDataPathIdentifier(String interfaceName,
                                                                                                                                    String macAddress)

diffOf

public static <T> List<T> diffOf(List<T> orig,
                                 List<T> updated)

isEmpty

public static boolean isEmpty(Collection collection)

isNotEmpty

public static boolean isNotEmpty(Collection collection)

getSourceIpAddress

public com.google.common.base.Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getSourceIpAddress(org.opendaylight.genius.mdsalutil.packet.Ethernet ethernet)

getElanMacEntries

public List<MacEntry> getElanMacEntries(String elanName)

isTunnelInLogicalGroup

public boolean isTunnelInLogicalGroup(String interfaceName)

getFlowIid

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> getFlowIid(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow flow,
                                                                                                                                                                              BigInteger dpnId)

getElanInterfaceJobKey

public static String getElanInterfaceJobKey(String interfaceName)

removeArpResponderFlow

public void removeArpResponderFlow(BigInteger dpnId,
                                   String ingressInterfaceName,
                                   String ipAddress,
                                   int lportTag)

getRouterPordIdFromElanInstance

public static @Nullable String getRouterPordIdFromElanInstance(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                                               String elanInstanceName)

getGroupInstanceid

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group> getGroupInstanceid(BigInteger dpnId,
                                                                                                                                                                              long groupId)