/* * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.vpnservice.elan.utils; import java.math.BigInteger; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import org.apache.commons.lang3.StringUtils; import org.opendaylight.controller.md.sal.binding.api.DataBroker; import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction; import org.opendaylight.controller.md.sal.binding.api.WriteTransaction; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; import org.opendaylight.vpnservice.elan.internal.ElanInstanceManager; import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo; import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceServiceUtil; import org.opendaylight.vpnservice.itm.globals.ITMConstants; import org.opendaylight.vpnservice.mdsalutil.FlowEntity; import org.opendaylight.vpnservice.mdsalutil.InstructionInfo; import org.opendaylight.vpnservice.mdsalutil.InstructionType; import org.opendaylight.vpnservice.mdsalutil.MDSALUtil; import org.opendaylight.vpnservice.mdsalutil.MDSALUtil.MdsalOp; import org.opendaylight.vpnservice.mdsalutil.MatchFieldType; import org.opendaylight.vpnservice.mdsalutil.MatchInfo; import org.opendaylight.vpnservice.mdsalutil.MetaDataUtil; import org.opendaylight.vpnservice.mdsalutil.NwConstants; import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.AdminStatus; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress; import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId; import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes; import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node; import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.ServiceBindings; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.ServiceTypeFlowBased; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.StypeOpenflow; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.StypeOpenflowBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.ServicesInfo; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.ServicesInfoKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServices; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServicesBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServicesKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanDpnInterfaces; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanForwardingTables; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanInstances; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanInterfaceForwardingEntries; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanInterfaces; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanState; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanTagNameMap; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTable; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTableBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTableKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstance; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterface; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterfaceKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.Elan; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.ElanBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.ElanKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagName; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntry; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntryKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.IfIndexesInterfaceMap; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterface; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterfaceKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.TunnelTypeBase; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.TunnelTypeGre; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.TunnelTypeVxlan; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetDpidFromInterfaceInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetDpidFromInterfaceOutput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceOutput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.OdlInterfaceRpcService; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.ExternalTunnelList; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.TunnelList; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.external.tunnel.list.ExternalTunnel; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.external.tunnel.list.ExternalTunnelKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.CreateTerminatingServiceActionsInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.CreateTerminatingServiceActionsInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetExternalTunnelInterfaceNameInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetExternalTunnelInterfaceNameInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetExternalTunnelInterfaceNameOutput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetTunnelInterfaceNameInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetTunnelInterfaceNameInputBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetTunnelInterfaceNameOutput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.ItmRpcService; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.RemoveTerminatingServiceActionsInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.RemoveTerminatingServiceActionsInputBuilder; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder; import org.opendaylight.yangtools.yang.common.RpcResult; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.google.common.base.Optional; import com.google.common.util.concurrent.CheckedFuture; import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; public class ElanUtils { private static OdlInterfaceRpcService interfaceMgrRpcService; private static ItmRpcService itmRpcService; private static IMdsalApiManager mdsalMgr; private static DataBroker dataBroker; private static final Logger logger = LoggerFactory.getLogger(ElanUtils.class); public static final FutureCallback DEFAULT_CALLBACK = new FutureCallback() { @Override public void onSuccess(Void result) { logger.debug("Success in Datastore operation"); } @Override public void onFailure(Throwable error) { logger.error("Error in Datastore operation", error); } }; /** * Uses the IdManager to retrieve a brand new ElanTag. * * @param idManager * the id manager * @param idKey * the id key * @return the integer */ public static Integer retrieveNewElanTag(IdManagerService idManager, String idKey) { AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(ElanConstants.ELAN_ID_POOL_NAME) .setIdKey(idKey).build(); try { Future> result = idManager.allocateId(getIdInput); RpcResult rpcResult = result.get(); if (rpcResult.isSuccessful()) { return rpcResult.getResult().getIdValue().intValue(); } else { logger.warn("RPC Call to Allocate Id returned with Errors {}", rpcResult.getErrors()); } } catch (InterruptedException | ExecutionException e) { logger.warn("Exception when Allocating Id",e); } return 0; } public static DataBroker getDataBroker() { return dataBroker; } public final static void setIfaceMgrRpcService(OdlInterfaceRpcService rpcService) { interfaceMgrRpcService = rpcService; } public final static void setItmRpcService(ItmRpcService itmService) { itmRpcService = itmService; } public final static void setDataBroker(DataBroker broker) { dataBroker = broker; } public final static void setMdsalManager(IMdsalApiManager mdsalApiManager) { mdsalMgr = mdsalApiManager; } public static void releaseId(IdManagerService idManager, String poolName, String idKey) { ReleaseIdInput releaseIdInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build(); Future> result = idManager.releaseId(releaseIdInput); } public static Optional read(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier path) { ReadOnlyTransaction tx = (broker != null ) ? broker.newReadOnlyTransaction() : dataBroker.newReadOnlyTransaction(); Optional result = Optional.absent(); try { CheckedFuture, ReadFailedException> checkedFuture = tx.read(datastoreType, path); result = checkedFuture.get(); } catch (Exception e) { throw new RuntimeException(e); } return result; } public static void delete(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier path) { WriteTransaction tx = broker.newWriteOnlyTransaction(); tx.delete(datastoreType, path); Futures.addCallback(tx.submit(), DEFAULT_CALLBACK); } public static InstanceIdentifier getElanInstanceIdentifier() { return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class).build(); } //elan-instances config container public static ElanInstance getElanInstanceByName(String elanInstanceName) { InstanceIdentifier elanIdentifierId = getElanInstanceConfigurationDataPath(elanInstanceName); Optional elanInstance = read(dataBroker, LogicalDatastoreType.CONFIGURATION, elanIdentifierId); if(elanInstance.isPresent()) { return elanInstance.get(); } return null; } public static InstanceIdentifier getElanInstanceConfigurationDataPath(String elanInstanceName) { return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build(); } //elan-interfaces Config Container public static ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) { InstanceIdentifier elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName); Optional existingElanInterface = read(dataBroker, LogicalDatastoreType.CONFIGURATION, elanInterfaceId); if(existingElanInterface.isPresent()) { return existingElanInterface.get(); } return null; } public static InstanceIdentifier getElanInterfaceConfigurationDataPathId(String interfaceName) { return InstanceIdentifier.builder(ElanInterfaces.class).child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build(); } //elan-state Operational container public static Elan getElanByName(String elanInstanceName) { InstanceIdentifier elanIdentifier = getElanInstanceOperationalDataPath(elanInstanceName); Optional elanInstance = read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanIdentifier); if(elanInstance.isPresent()) { return elanInstance.get(); } return null; } public static InstanceIdentifier getElanInstanceOperationalDataPath(String elanInstanceName) { return InstanceIdentifier.builder(ElanState.class).child(Elan.class, new ElanKey(elanInstanceName)).build(); } // grouping of forwarding-entries public static MacEntry getInterfaceMacEntriesOperationalDataPath(String interfaceName, PhysAddress physAddress) { InstanceIdentifier existingMacEntryId = getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress); Optional existingInterfaceMacEntry = read(dataBroker, LogicalDatastoreType.OPERATIONAL, existingMacEntryId); if(existingInterfaceMacEntry.isPresent()) { return existingInterfaceMacEntry.get(); } return null; } public static MacEntry getInterfaceMacEntriesOperationalDataPathFromId(InstanceIdentifier identifier) { Optional existingInterfaceMacEntry = read(dataBroker, LogicalDatastoreType.OPERATIONAL, identifier); if(existingInterfaceMacEntry.isPresent()) { return existingInterfaceMacEntry.get(); } return null; } public static InstanceIdentifier getInterfaceMacEntriesIdentifierOperationalDataPath(String interfaceName, PhysAddress physAddress) { return InstanceIdentifier.builder(ElanInterfaceForwardingEntries.class).child(ElanInterfaceMac.class, new ElanInterfaceMacKey(interfaceName)).child(MacEntry.class, new MacEntryKey(physAddress)).build(); } //elan-forwarding-tables Operational container public static MacEntry getMacTableByElanName(String elanName, PhysAddress physAddress) { InstanceIdentifier macId = getMacEntryOperationalDataPath(elanName, physAddress); Optional existingElanMacEntry = read(dataBroker, LogicalDatastoreType.OPERATIONAL, macId); if(existingElanMacEntry.isPresent()) { return existingElanMacEntry.get(); } return null; } public static MacEntry getMacEntryFromElanMacId(InstanceIdentifier identifier) { Optional existingInterfaceMacEntry = read(dataBroker, LogicalDatastoreType.OPERATIONAL, identifier); if(existingInterfaceMacEntry.isPresent()) { return existingInterfaceMacEntry.get(); } return null; } public static InstanceIdentifier getMacEntryOperationalDataPath(String elanName, PhysAddress physAddress) { return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class, new MacTableKey(elanName)).child(MacEntry.class, new MacEntryKey(physAddress)).build(); } public static InstanceIdentifier getElanMacTableOperationalDataPath(String elanName) { return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class, new MacTableKey(elanName)).build(); } //elan-interface-forwarding-entries Operational container public static ElanInterfaceMac getElanInterfaceMacByInterfaceName(String interfaceName) { InstanceIdentifier elanInterfaceId = getElanInterfaceMacEntriesOperationalDataPath(interfaceName); Optional existingElanInterface = read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanInterfaceId); if(existingElanInterface.isPresent()) { return existingElanInterface.get(); } return null; } /** * Gets the elan interface mac addresses. * * @param interfaceName * the interface name * @return the elan interface mac addresses */ public static List getElanInterfaceMacAddresses(String interfaceName) { List macAddresses = new ArrayList(); ElanInterfaceMac elanInterfaceMac = ElanUtils.getElanInterfaceMacByInterfaceName(interfaceName); if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null) { List macEntries = elanInterfaceMac.getMacEntry(); for (MacEntry macEntry : macEntries) { macAddresses.add(macEntry.getMacAddress()); } } return macAddresses; } public static InstanceIdentifier getElanInterfaceMacEntriesOperationalDataPath(String interfaceName) { return InstanceIdentifier.builder(ElanInterfaceForwardingEntries.class).child(ElanInterfaceMac.class, new ElanInterfaceMacKey(interfaceName)).build(); } /** * 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 * * @param elanInstanceName * name of the Elan to which the interfaces must belong to * @param dpId * Id of the DPN where the interfaces are located * @return */ public static DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) { InstanceIdentifier elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId); Optional elanDpnInterfaces = read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId); if ( elanDpnInterfaces.isPresent() ) { return elanDpnInterfaces.get(); } return null; } /** * 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 * * @param elanInstanceName * name of the Elan to which the interfaces must belong to * @param dpId * Id of the DPN where the interfaces are located * @return */ public static InstanceIdentifier getElanDpnInterfaceOperationalDataPath(String elanInstanceName, BigInteger dpId) { return InstanceIdentifier.builder(ElanDpnInterfaces.class) .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)) .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build(); } //elan-tag-name-map Operational Container public static ElanTagName getElanInfoByElanTag(long elanTag) { InstanceIdentifier elanId = getElanInfoEntriesOperationalDataPath(elanTag); Optional existingElanInfo = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanId); if(existingElanInfo.isPresent()) { return existingElanInfo.get(); } return null; } public static InstanceIdentifier getElanInfoEntriesOperationalDataPath(long elanTag) { return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class, new ElanTagNameKey(elanTag)).build(); } // interface-index-tag operational container public static Optional getInterfaceInfoByInterfaceTag(long interfaceTag) { InstanceIdentifier interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag); return ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, interfaceId); } public static InstanceIdentifier getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) { return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class, new IfIndexInterfaceKey((int) interfaceTag)).build(); } public static InstanceIdentifier getElanDpnOperationDataPath(String elanInstanceName) { return InstanceIdentifier.builder(ElanDpnInterfaces.class).child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build(); } public static ElanDpnInterfacesList getElanDpnInterfacesList(String elanName) { InstanceIdentifier elanDpnInterfaceId = getElanDpnOperationDataPath(elanName); Optional existingElanDpnInterfaces = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId); if(existingElanDpnInterfaces.isPresent()) { return existingElanDpnInterfaces.get(); } return null; } /** * This method is useful get all ELAN participating CSS dpIds to install * program remote dmac entries and updating remote bc groups for tor * integration. * * @param elanInstanceName * the elan instance name * @return list of dpIds */ public static List getParticipatingDPNsInElanInstance(String elanInstanceName) { List dpIds = new ArrayList(); InstanceIdentifier elanDpnInterfaceId = getElanDpnOperationDataPath(elanInstanceName); Optional existingElanDpnInterfaces = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId); if (!existingElanDpnInterfaces.isPresent()) { return dpIds; } List dpnInterfaces = existingElanDpnInterfaces.get().getDpnInterfaces(); for (DpnInterfaces dpnInterface: dpnInterfaces) { dpIds.add(dpnInterface.getDpId()); } return dpIds; } /** * To check given dpId is already present in Elan instance. This can be used * to program flow entry in external tunnel table when a new access port * added for first time into the ELAN instance * * @param dpId * the dp id * @param elanInstanceName * the elan instance name * @return true if dpId is already present, otherwise return false */ public static boolean isDpnAlreadyPresentInElanInstance(BigInteger dpId, String elanInstanceName) { boolean isDpIdPresent = false; InstanceIdentifier elanDpnInterfaceId = getElanDpnOperationDataPath(elanInstanceName); Optional existingElanDpnInterfaces = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId); if (!existingElanDpnInterfaces.isPresent()) { return isDpIdPresent; } List dpnInterfaces = existingElanDpnInterfaces.get().getDpnInterfaces(); for (DpnInterfaces dpnInterface: dpnInterfaces) { if (dpnInterface.getDpId().equals(dpId)) { isDpIdPresent = true; break; } } return isDpIdPresent; } public static ElanDpnInterfaces getElanDpnInterfacesList() { InstanceIdentifier elanDpnInterfaceId = InstanceIdentifier.builder(ElanDpnInterfaces.class).build(); Optional existingElanDpnInterfaces = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId); if(existingElanDpnInterfaces.isPresent()) { return existingElanDpnInterfaces.get(); } return null; } public static ElanForwardingTables getElanForwardingList() { InstanceIdentifier elanForwardingTableId = InstanceIdentifier.builder(ElanForwardingTables.class).build(); Optional existingElanForwardingList = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanForwardingTableId); if(existingElanForwardingList.isPresent()) { return existingElanForwardingList.get(); } return null; } /** * Gets the elan mac table. * * @param elanName * the elan name * @return the elan mac table */ public static MacTable getElanMacTable(String elanName) { InstanceIdentifier elanMacTableId = getElanMacTableOperationalDataPath(elanName); Optional existingElanMacTable = ElanUtils.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanMacTableId); if (existingElanMacTable.isPresent()) { return existingElanMacTable.get(); } return null; } public static long getElanLocalBCGID(long elanTag) { return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2) - 1); } public static long getElanRemoteBCGID(long elanTag) { return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2)); } public static BigInteger getElanMetadataLabel(long elanTag) { return (BigInteger.valueOf(elanTag)).shiftLeft(24); } public static BigInteger getElanMetadataLabel(long elanTag, boolean isSHFlagSet ) { int shBit = (isSHFlagSet) ? 1 : 0; return (BigInteger.valueOf(elanTag)).shiftLeft(24).or(BigInteger.valueOf(shBit)); } public static BigInteger getElanMetadataLabel(long elanTag, int lportTag) { return getElanMetadataLabel(elanTag).or(MetaDataUtil.getLportTagMetaData(lportTag)); } public static BigInteger getElanMetadataMask() { return MetaDataUtil.METADATA_MASK_SERVICE.or(MetaDataUtil.METADATA_MASK_LPORT_TAG); } /** * Setting INTERNAL_TUNNEL_TABLE, SMAC, DMAC, UDMAC in this DPN and also in * other DPNs. * * @param elanInfo * the elan info * @param interfaceInfo * the interface info * @param macTimeout * the mac timeout * @param macAddress * the mac address */ public static void setupMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout, String macAddress) { synchronized (macAddress) { logger.info("Acquired lock for mac : " + macAddress + ". Proceeding with install operation."); setupKnownSmacFlow(elanInfo, interfaceInfo, macTimeout, macAddress, mdsalMgr); setupOrigDmacFlows(elanInfo, interfaceInfo, macAddress, mdsalMgr, dataBroker); } } public static void setupDMacFlowonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId, String macAddress) { synchronized (macAddress) { logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation."); setupOrigDmacFlowsonRemoteDpn(elanInfo, interfaceInfo, dstDpId, macAddress); } } /** * Inserts a Flow in SMAC table to state that the MAC has already been learnt. * * @param elanInfo * @param interfaceInfo * @param macTimeout * @param macAddress * @param mdsalApiManager */ private static void setupKnownSmacFlow(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout, String macAddress, IMdsalApiManager mdsalApiManager) { FlowEntity flowEntity = buildKnownSmacFlow(elanInfo, interfaceInfo, macTimeout, macAddress); mdsalApiManager.installFlow(flowEntity); if (logger.isDebugEnabled()) { logger.debug("Known Smac flow entry created for elan Name:{}, logical Interface port:{} and mac address:{}", elanInfo.getElanInstanceName(), elanInfo.getDescription(), macAddress); } } public static FlowEntity buildKnownSmacFlow(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout, String macAddress) { BigInteger dpId = interfaceInfo.getDpId(); int lportTag = interfaceInfo.getInterfaceTag(); long elanTag = elanInfo.getElanTag(); // Matching metadata and eth_src fields List mkMatches = new ArrayList(); mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] { ElanUtils.getElanMetadataLabel(elanInfo.getElanTag(), lportTag), ElanUtils.getElanMetadataMask() })); mkMatches.add(new MatchInfo(MatchFieldType.eth_src, new String[] { macAddress })); List mkInstructions = new ArrayList(); mkInstructions.add(new InstructionInfo(InstructionType.goto_table, new long[] { ElanConstants.ELAN_DMAC_TABLE })); FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, ElanConstants.ELAN_SMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_SMAC_TABLE, dpId, lportTag, macAddress, elanTag), 20, elanInfo.getDescription(), (int)macTimeout, 0, ElanConstants.COOKIE_ELAN_KNOWN_SMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions); flowEntity.setStrictFlag(true); flowEntity.setSendFlowRemFlag(macTimeout != 0); //If Mac timeout is 0, the flow wont be deleted automatically, so no need to get notified return flowEntity; } /** * 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 * * @param interfaceInfo * @param mdsalApiManager */ public static void setupTermDmacFlows(InterfaceInfo interfaceInfo, IMdsalApiManager mdsalApiManager) { BigInteger dpId = interfaceInfo.getDpId(); int lportTag = interfaceInfo.getInterfaceTag(); Flow flow = MDSALUtil.buildFlowNew(NwConstants.INTERNAL_TUNNEL_TABLE, getIntTunnelTableFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE, lportTag), 5, String.format("%s:%d","ITM Flow Entry ",lportTag), 0, 0, ITMConstants.COOKIE_ITM.add(BigInteger.valueOf(lportTag)), getTunnelIdMatchForFilterEqualsLPortTag(lportTag), getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName())); mdsalApiManager.installFlow(dpId, flow); if (logger.isDebugEnabled()) { logger.debug("Terminating service table flow entry created on dpn:{} for logical Interface port:{}", dpId, interfaceInfo.getPortName()); } } /** * Constructs the FlowName for flows installed in the Internal Tunnel Table, * consisting in tableId + elanTag. * * @param tableId * @param elanTag * @return */ public static String getIntTunnelTableFlowRef(short tableId, int elanTag) { return new StringBuffer().append(tableId).append(elanTag).toString(); } /** * Constructs the Matches that checks that the tunnel_id field contains a * specific lportTag * * @param lportTag * lportTag that must be checked against the tunnel_id field * @return */ public static List getTunnelIdMatchForFilterEqualsLPortTag(int lportTag) { List mkMatches = new ArrayList(); // Matching metadata mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(lportTag)})); return mkMatches; } /** * Constructs the Instructions that take the packet over a given interface * * @param 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) * @return */ public static List getInstructionsInPortForOutGroup(String ifName) { List mkInstructions = new ArrayList(); List actions = ElanUtils.getEgressActionsForInterface(ifName, /*tunnelKey*/ null ); mkInstructions.add(MDSALUtil.buildApplyActionsInstruction(actions)); return mkInstructions; } /** * 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. * * @param ifName * the if name * @param tunnelKey * the tunnel key * @return the egress actions for interface */ public static List getEgressActionsForInterface(String ifName, Long tunnelKey) { List listAction = new ArrayList(); try { GetEgressActionsForInterfaceInput getEgressActionInput = new GetEgressActionsForInterfaceInputBuilder().setIntfName(ifName).setTunnelKey(tunnelKey).build(); Future> result = interfaceMgrRpcService.getEgressActionsForInterface(getEgressActionInput); RpcResult rpcResult = result.get(); if (!rpcResult.isSuccessful()) { logger.warn("RPC Call to Get egress actions for interface {} returned with Errors {}", ifName, rpcResult.getErrors()); } else { List actions = rpcResult.getResult().getAction(); listAction = actions; } } catch (InterruptedException | ExecutionException e) { logger.warn("Exception when egress actions for interface {}", ifName, e); } return listAction; } private static void setupOrigDmacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress, IMdsalApiManager mdsalApiManager, DataBroker broker) { BigInteger dpId = interfaceInfo.getDpId(); String ifName = interfaceInfo.getInterfaceName(); long ifTag = interfaceInfo.getInterfaceTag(); String elanInstanceName = elanInfo.getElanInstanceName(); List elanDpns = getInvolvedDpnsInElan(elanInstanceName); if (elanDpns != null) { Long elanTag = elanInfo.getElanTag(); for (DpnInterfaces elanDpn : elanDpns) { if (elanDpn.getDpId().equals(dpId)) { // On the local DPN set up a direct output flow setupLocalDmacFlow(elanTag, dpId, ifName, macAddress, elanInstanceName, mdsalApiManager, ifTag); logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpId); } else { // Check for the Remote DPN present in Inventory Manager if (isDpnPresent(elanDpn.getDpId())) { // For remote DPNs a flow is needed to indicate that packets of this ELAN going to this MAC // need to be forwarded through the appropiated ITM tunnel setupRemoteDmacFlow(elanDpn.getDpId(), // srcDpn (the remote DPN in this case) dpId, // dstDpn (the local DPN) interfaceInfo.getInterfaceTag(), // lportTag of the local interface elanTag, // identifier of the Elan macAddress, // MAC to be programmed in remote DPN elanInstanceName); logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, elanDpn.getDpId()); } } } // TODO (eperefr): Make sure that the same is performed against the ElanDevices. } } private static void setupOrigDmacFlowsonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId, String macAddress) { BigInteger dpId = interfaceInfo.getDpId(); String elanInstanceName = elanInfo.getElanInstanceName(); List remoteFEs = getInvolvedDpnsInElan(elanInstanceName); for(DpnInterfaces remoteFE: remoteFEs) { Long elanTag = elanInfo.getElanTag(); if (remoteFE.getDpId().equals(dstDpId)) { // Check for the Remote DPN present in Inventory Manager setupRemoteDmacFlow(dstDpId, dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName); if (logger.isDebugEnabled()) { logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address {} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId()); } break; } } } @SuppressWarnings("unchecked") public static List getInvolvedDpnsInElan(String elanName) { List dpns = ElanInstanceManager.getElanInstanceManager().getElanDPNByName(elanName); if (dpns == null) { return Collections.emptyList(); } return dpns; } private static void setupLocalDmacFlow(long elanTag, BigInteger dpId, String ifName, String macAddress, String displayName, IMdsalApiManager mdsalApiManager, long ifTag) { Flow flowEntity = buildLocalDmacFlowEntry(elanTag, dpId, ifName, macAddress, displayName, ifTag); mdsalApiManager.installFlow(dpId, flowEntity); } public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, long lporTag, String macAddress, long elanTag) { return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(lporTag).append(macAddress).toString(); } public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, BigInteger remoteDpId, String macAddress, long elanTag) { return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(remoteDpId).append(macAddress).toString(); } private static String getKnownDynamicmacFlowRef(short elanDmacTable, BigInteger dpId, String extDeviceNodeId, String dstMacAddress, long elanTag, boolean shFlag) { return new StringBuffer().append(elanDmacTable).append(elanTag).append(dpId) .append(extDeviceNodeId).append(dstMacAddress).append(shFlag) .toString(); } /** * 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 * * @param elanTag the elan tag * @param dpId the dp id * @param ifName the if name * @param macAddress the mac address * @param displayName the display name * @param ifTag the if tag * @return the flow */ public static Flow buildLocalDmacFlowEntry(long elanTag, BigInteger dpId, String ifName, String macAddress, String displayName, long ifTag) { List mkMatches = new ArrayList(); mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] { ElanUtils.getElanMetadataLabel(elanTag), MetaDataUtil.METADATA_MASK_SERVICE })); mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress })); List mkInstructions = new ArrayList(); List actions = getEgressActionsForInterface(ifName, /* tunnelKey */ null); mkInstructions.add(MDSALUtil.buildApplyActionsInstruction(actions)); Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, ifTag, macAddress, elanTag), 20, displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions); return flow; } public static void setupRemoteDmacFlow(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag, String macAddress, String displayName) { Flow flowEntity = buildRemoteDmacFlowEntry(srcDpId, destDpId, lportTag, elanTag, macAddress, displayName); mdsalMgr.installFlow(srcDpId, flowEntity); } /** * 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(lportTag) * + output ITM internal tunnel interface with the other DPN * * @param srcDpId * @param destDpId * @param lportTag * @param elanTag * @param macAddress * @param displayName * @return */ public static Flow buildRemoteDmacFlowEntry(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag, String macAddress, String displayName) { List mkMatches = new ArrayList(); mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[]{ ElanUtils.getElanMetadataLabel(elanTag), MetaDataUtil.METADATA_MASK_SERVICE })); mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress })); List mkInstructions = new ArrayList(); //List of Action for the provided Source and Destination DPIDs try { List actions = getInternalItmEgressAction(srcDpId, destDpId, lportTag); mkInstructions.add(MDSALUtil.buildApplyActionsInstruction(actions)); } catch (Exception e) { logger.error("Interface Not Found exception"); } Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcDpId, destDpId, macAddress, elanTag), 20, /* prio */ displayName, 0, /* idleTimeout */ 0, /* hardTimeout */ ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions); return flow; } public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, MacEntry macEntry) { if (elanInfo == null || interfaceInfo == null) { return; } String macAddress = macEntry.getMacAddress().getValue(); synchronized (macAddress) { logger.info("Acquired lock for mac : " + macAddress + "Proceeding with remove operation."); deleteMacFlows(elanInfo, interfaceInfo, macAddress, /* alsoDeleteSMAC */ true); } } public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress, boolean deleteSmac) { String elanInstanceName = elanInfo.getElanInstanceName(); long ifTag = interfaceInfo.getInterfaceTag(); List remoteFEs = getInvolvedDpnsInElan(elanInstanceName); BigInteger srcdpId = interfaceInfo.getDpId(); for (DpnInterfaces dpnInterface: remoteFEs) { Long elanTag = elanInfo.getElanTag(); BigInteger dstDpId = dpnInterface.getDpId(); if (dstDpId.equals(srcdpId)) { if(deleteSmac) { mdsalMgr.removeFlow(srcdpId, MDSALUtil.buildFlow(ElanConstants.ELAN_SMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_SMAC_TABLE, srcdpId, ifTag, macAddress, elanTag))); } mdsalMgr.removeFlow(srcdpId, MDSALUtil.buildFlow(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcdpId, ifTag, macAddress, elanTag))); if (logger.isDebugEnabled()) { logger.debug("All the required flows deleted for elan:{}, logical Interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, srcdpId); } } else if (isDpnPresent(dstDpId)) { mdsalMgr.removeFlow(dstDpId, MDSALUtil.buildFlow(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dstDpId, srcdpId, macAddress, elanTag))); if (logger.isDebugEnabled()) { logger.debug("Dmac flow entry deleted for elan:{}, logical interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dstDpId); } } } } /** * Updates the Elan information in the Operational DS. It also updates the * ElanInstance in the Config DS by setting the adquired elanTag. * * @param broker * the broker * @param idManager * the id manager * @param elanInstanceAdded * the elan instance added */ public static void updateOperationalDataStore(DataBroker broker, IdManagerService idManager, ElanInstance elanInstanceAdded) { String elanInstanceName = elanInstanceAdded.getElanInstanceName(); long elanTag = ElanUtils.retrieveNewElanTag(idManager, elanInstanceName); Elan elanInfo = new ElanBuilder().setName(elanInstanceName).setKey(new ElanKey(elanInstanceName)).build(); //Add the ElanState in the elan-state operational data-store MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName), elanInfo); //Add the ElanMacTable in the elan-mac-table operational data-store MacTable elanMacTable = new MacTableBuilder().setKey(new MacTableKey(elanInstanceName)).build(); MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanMacTableOperationalDataPath(elanInstanceName), elanMacTable); ElanTagName elanTagName = new ElanTagNameBuilder().setElanTag(elanTag).setKey(new ElanTagNameKey(elanTag)) .setName(elanInstanceName).build(); //Add the ElanTag to ElanName in the elan-tag-name Operational data-store MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag), elanTagName); // Updates the ElanInstance Config DS by setting the just adquired elanTag ElanInstance elanInstanceWithTag = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName) .setDescription(elanInstanceAdded.getDescription()) .setMacTimeout(elanInstanceAdded.getMacTimeout() == null ? ElanConstants.DEFAULT_MAC_TIME_OUT : elanInstanceAdded.getMacTimeout()) .setKey(elanInstanceAdded.getKey()).setElanTag(elanTag).build(); MDSALUtil.syncUpdate(broker, LogicalDatastoreType.CONFIGURATION, getElanInstanceConfigurationDataPath(elanInstanceName), elanInstanceWithTag); } public static boolean isDpnPresent(BigInteger dpnId) { String dpn = String.format("%s:%s", "openflow",dpnId); NodeId nodeId = new NodeId(dpn); InstanceIdentifier node = InstanceIdentifier.builder(Nodes.class).child(Node.class, new NodeKey(nodeId)) .build(); Optional nodePresent = read(dataBroker, LogicalDatastoreType.OPERATIONAL, node); return (nodePresent.isPresent()); } public static ServicesInfo getServiceInfo(String elanInstanceName, long elanTag, String interfaceName) { int priority = ElanConstants.ELAN_SERVICE_PRIORITY; int instructionKey = 0; List instructions = new ArrayList(); instructions.add(MDSALUtil.buildAndGetWriteMetadaInstruction(ElanUtils.getElanMetadataLabel(elanTag), MetaDataUtil.METADATA_MASK_SERVICE, ++instructionKey)); instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(ElanConstants.ELAN_SMAC_TABLE, ++instructionKey)); ServicesInfo serviceInfo = InterfaceServiceUtil.buildServiceInfo(String.format("%s.%s", elanInstanceName, interfaceName), ElanConstants.ELAN_SERVICE_INDEX, priority, ElanConstants.COOKIE_ELAN_INGRESS_TABLE, instructions); return serviceInfo; } public static void delete(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier path, FutureCallback callback) { WriteTransaction tx = broker.newWriteOnlyTransaction(); tx.delete(datastoreType, path); Futures.addCallback(tx.submit(), callback); } public static void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier path, T data) { WriteTransaction tx = broker.newWriteOnlyTransaction(); tx.put(datastoreType, path, data, true); CheckedFuture futures = tx.submit(); try { futures.get(); } catch (InterruptedException | ExecutionException e) { logger.error("Error writing to datastore (path, data) : ({}, {})", path, data); throw new RuntimeException(e.getMessage()); } } public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority, BigInteger cookie, List instructions) { StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority).setInstruction(instructions); return new BoundServicesBuilder().setKey(new BoundServicesKey(servicePriority)) .setServiceName(serviceName).setServicePriority(servicePriority) .setServiceType(ServiceTypeFlowBased.class).addAugmentation(StypeOpenflow.class, augBuilder.build()).build(); } public static InstanceIdentifier buildServiceId(String vpnInterfaceName, short serviceIndex) { return InstanceIdentifier.builder(ServiceBindings.class).child(ServicesInfo.class, new ServicesInfoKey(vpnInterfaceName)) .child(BoundServices.class, new BoundServicesKey(serviceIndex)).build(); } /** * Builds the list of actions to be taken when sending the packet over a * VxLan Tunnel Interface, such as setting the tunnel_id field, the vlanId * if proceeds and output the packet over the right port. * * @param tunnelIfaceName * the tunnel iface name * @param tunnelKey * the tunnel key * @return the list */ public static List buildItmEgressActions(String tunnelIfaceName, Long tunnelKey) { List result = Collections.emptyList(); if (tunnelIfaceName != null && !tunnelIfaceName.isEmpty()) { GetEgressActionsForInterfaceInput getEgressActInput = new GetEgressActionsForInterfaceInputBuilder() .setIntfName(tunnelIfaceName).setTunnelKey(tunnelKey).build(); Future> egressActionsOutputFuture = interfaceMgrRpcService.getEgressActionsForInterface(getEgressActInput); try { if (egressActionsOutputFuture.get().isSuccessful()) { GetEgressActionsForInterfaceOutput egressActionsOutput = egressActionsOutputFuture.get().getResult(); result = egressActionsOutput.getAction(); } } catch (InterruptedException | ExecutionException e) { logger.error("Error in RPC call getEgressActionsForInterface {}", e); } } if ( result == null || result.size() == 0 ) { logger.warn("Could not build Egress actions for interface {} and tunnelId {}", tunnelIfaceName, tunnelKey); } return result; } /** * Builds the list of actions to be taken when sending the packet over an * external VxLan tunnel interface, such as stamping the VNI on the VxLAN * header, setting the vlanId if it proceeds and output the packet over the * right port. * * @param srcDpnId * Dpn where the tunnelInterface is located * @param torNode * NodeId of the ExternalDevice where the packet must be sent to. * @param vni * Vni to be stamped on the VxLAN Header. * @return the external itm egress action */ public static List getExternalItmEgressAction(BigInteger srcDpnId, NodeId torNode, long vni ) { List result = Collections.emptyList(); GetExternalTunnelInterfaceNameInput input = new GetExternalTunnelInterfaceNameInputBuilder() .setDestinationNode(torNode.getValue()).setSourceNode(srcDpnId.toString()).setTunnelType(TunnelTypeVxlan.class).build(); Future> output = itmRpcService.getExternalTunnelInterfaceName(input); try { if (output.get().isSuccessful()) { GetExternalTunnelInterfaceNameOutput tunnelInterfaceNameOutput = output.get().getResult(); String tunnelIfaceName = tunnelInterfaceNameOutput.getInterfaceName(); if ( logger.isDebugEnabled() ) logger.debug("Received tunnelInterfaceName from getTunnelInterfaceName RPC {}", tunnelIfaceName); result = buildItmEgressActions(tunnelIfaceName, vni); } } catch (InterruptedException | ExecutionException e) { logger.error("Error in RPC call getTunnelInterfaceName {}", e); } return result; } /** * Builds the list of actions to be taken when sending the packet over an * internal VxLan tunnel interface, such as setting the serviceTag on the * VNI field of the VxLAN header, setting the vlanId if it proceeds and * output the packet over the right port. * * @param sourceDpnId * Dpn where the tunnelInterface is located * @param destinationDpnId * Dpn where the packet must be sent to. It is used here in order * to select the right tunnel interface. * @param serviceTag * serviceId to be sent on the VxLAN header. * @return the internal itm egress action */ public static List getInternalItmEgressAction(BigInteger sourceDpnId, BigInteger destinationDpnId, long serviceTag) { List result = Collections.emptyList(); logger.debug("In getInternalItmEgressAction Action source {}, destination {}, elanTag {}", sourceDpnId, destinationDpnId, serviceTag); Class tunType = TunnelTypeVxlan.class; GetTunnelInterfaceNameInput input = new GetTunnelInterfaceNameInputBuilder() .setDestinationDpid(destinationDpnId).setSourceDpid(sourceDpnId).setTunnelType(tunType).build(); Future> output = itmRpcService.getTunnelInterfaceName(input); try { if (output.get().isSuccessful()) { GetTunnelInterfaceNameOutput tunnelInterfaceNameOutput = output.get().getResult(); String tunnelIfaceName = tunnelInterfaceNameOutput.getInterfaceName(); logger.debug("Received tunnelInterfaceName from getTunnelInterfaceName RPC {}", tunnelIfaceName); result = buildItmEgressActions(tunnelIfaceName, serviceTag); } } catch (InterruptedException | ExecutionException e) { logger.error("Error in RPC call getTunnelInterfaceName {}", e); } return result; } public static List getTunnelMatchesForServiceId(int elanTag) { List mkMatches = new ArrayList(); // Matching metadata mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[]{BigInteger.valueOf(elanTag)})); return mkMatches; } public static void removeTerminatingServiceAction(BigInteger destDpId, int serviceId) { RemoveTerminatingServiceActionsInput input = new RemoveTerminatingServiceActionsInputBuilder().setDpnId(destDpId).setServiceId(serviceId).build(); Future> futureObject = itmRpcService.removeTerminatingServiceActions(input); try { RpcResult result = futureObject.get(); if (result.isSuccessful()) { logger.debug("Successfully completed removeTerminatingServiceActions"); } else { logger.debug("Failure in removeTerminatingServiceAction RPC call"); } } catch (InterruptedException | ExecutionException e) { logger.error("Error in RPC call removeTerminatingServiceActions {}", e); } } public static void createTerminatingServiceActions(BigInteger destDpId, int serviceId, List actions) { List mkInstructions = new ArrayList(); mkInstructions.add(MDSALUtil.buildApplyActionsInstruction(actions)); CreateTerminatingServiceActionsInput input = new CreateTerminatingServiceActionsInputBuilder().setDpnId(destDpId).setServiceId(serviceId).setInstruction(mkInstructions).build(); itmRpcService.createTerminatingServiceActions(input); } public static TunnelList buildInternalTunnel(DataBroker broker) { InstanceIdentifier tunnelListInstanceIdentifier = InstanceIdentifier.builder(TunnelList.class).build(); Optional tunnelList = read(broker, LogicalDatastoreType.CONFIGURATION, tunnelListInstanceIdentifier); if (tunnelList.isPresent()) { return tunnelList.get(); } return null; } /** * Gets the external tunnel. * * @param sourceDevice * the source device * @param destinationDevice * the destination device * @param datastoreType * the datastore type * @return the external tunnel */ public static ExternalTunnel getExternalTunnel(String sourceDevice, String destinationDevice, LogicalDatastoreType datastoreType) { ExternalTunnel externalTunnel = null; Class tunType = TunnelTypeVxlan.class ; InstanceIdentifier iid = InstanceIdentifier.builder(ExternalTunnelList.class) .child(ExternalTunnel.class, new ExternalTunnelKey(destinationDevice, sourceDevice, tunType)).build(); Optional tunnelList = read(dataBroker, datastoreType, iid); if (tunnelList.isPresent()) { externalTunnel = tunnelList.get(); } return externalTunnel; } /** * Gets the external tunnel. * * @param interfaceName * the interface name * @param datastoreType * the datastore type * @return the external tunnel */ public static ExternalTunnel getExternalTunnel(String interfaceName, LogicalDatastoreType datastoreType) { ExternalTunnel externalTunnel = null; List externalTunnels = getAllExternalTunnels(datastoreType); for (ExternalTunnel tunnel : externalTunnels) { if (StringUtils.equalsIgnoreCase(interfaceName, tunnel.getTunnelInterfaceName())) { externalTunnel = tunnel; break; } } return externalTunnel; } /** * Gets the all external tunnels. * * @return the all external tunnels */ public static List getAllExternalTunnels(LogicalDatastoreType datastoreType) { List result = null; InstanceIdentifier iid = InstanceIdentifier.builder(ExternalTunnelList.class).build(); Optional tunnelList = read(dataBroker, datastoreType, iid); if (tunnelList.isPresent()) { result = tunnelList.get().getExternalTunnel(); } if (result == null) { result = Collections.emptyList(); } return result; } /** * Installs a Flow in a DPN's DMAC table. The Flow is for a MAC that is * connected remotely in another CSS and accessible through an internal * tunnel. It also installs the flow for dropping the packet if it came over * an ITM tunnel (that is, if the Split-Horizon flag is set) * * @param localDpId * Id of the DPN where the MAC Addr is accessible locally * @param remoteDpId * Id of the DPN where the flow must be installed * @param lportTag * lportTag of the interface where the mac is connected to. * @param elanTag * Identifier of the ELAN * @param macAddress * MAC to be installed in remoteDpId's DMAC table * @param displayName * the display name */ public static void installDmacFlowsToInternalRemoteMac(BigInteger localDpId, BigInteger remoteDpId, long lportTag, long elanTag, String macAddress, String displayName) { Flow flow = buildDmacFlowForInternalRemoteMac(localDpId, remoteDpId, lportTag, elanTag, macAddress, displayName); mdsalMgr.installFlow(remoteDpId, flow); } /** * Installs a Flow in the specified DPN's DMAC table. The flow is for a MAC * that is connected remotely in an External Device (TOR) and that is * accessible through an external tunnel. It also installs the flow for * dropping the packet if it came over an ITM tunnel (that is, if the * Split-Horizon flag is set) * * @param dpnId * Id of the DPN where the flow must be installed * @param extDeviceNodeId * the ext device node id * @param elanTag * the elan tag * @param vni * the vni * @param macAddress * the mac address * @param displayName * the display name */ public static List> installDmacFlowsToExternalRemoteMac(BigInteger dpnId, String extDeviceNodeId, Long elanTag, Long vni, String macAddress, String displayName) { List> futures = new ArrayList<>(); synchronized (macAddress) { Flow flow = buildDmacFlowForExternalRemoteMac(dpnId, extDeviceNodeId, elanTag, vni, macAddress, displayName); futures.add(mdsalMgr.installFlow(dpnId, flow)); Flow dropFlow = buildDmacFlowDropIfPacketComingFromTunnel(dpnId, extDeviceNodeId, elanTag, macAddress); futures.add(mdsalMgr.installFlow(dpnId, dropFlow)); } return futures; } public static List buildMatchesForElanTagShFlagAndDstMac(long elanTag, boolean shFlag, String macAddr) { List mkMatches = new ArrayList(); mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] { ElanUtils.getElanMetadataLabel(elanTag, shFlag), MetaDataUtil.METADATA_MASK_SERVICE_SH_FLAG })); mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddr })); return mkMatches; } /** * Builds a Flow to be programmed in a DPN's DMAC table. This method must be used when the MAC is located in an * External Device (TOR). * The flow matches on the specified MAC and * 1) sends the packet over the CSS-TOR tunnel if SHFlag is not set, or * 2) drops it if SHFlag is set (what means the packet came from an external tunnel) * * @param dpId DPN whose DMAC table is going to be modified * @param extDeviceNodeId Hwvtep node where the mac is attached to * @param elanTag ElanId to which the MAC is being added to * @param vni the vni * @param dstMacAddress The mac address to be programmed * @param displayName the display name * @return the flow */ public static Flow buildDmacFlowForExternalRemoteMac(BigInteger dpId, String extDeviceNodeId, long elanTag, Long vni, String dstMacAddress, String displayName ) { List mkMatches = buildMatchesForElanTagShFlagAndDstMac(elanTag, /*shFlag*/ false, dstMacAddress); List mkInstructions = new ArrayList(); try { List actions = getExternalItmEgressAction(dpId, new NodeId(extDeviceNodeId), vni); mkInstructions.add( MDSALUtil.buildApplyActionsInstruction(actions) ); } catch (Exception e) { logger.error("Could not get Egress Actions for DpId={} externalNode={}", dpId, extDeviceNodeId ); } Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, extDeviceNodeId, dstMacAddress, elanTag, false), 20, /* prio */ displayName, 0, /* idleTimeout */ 0, /* hardTimeout */ ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions); return flow; } /** * Builds the flow that drops the packet if it came through an external tunnel, that is, if the Split-Horizon * flag is set. * * @param dpnId DPN whose DMAC table is going to be modified * @param extDeviceNodeId Hwvtep node where the mac is attached to * @param elanTag ElanId to which the MAC is being added to * @param dstMacAddress The mac address to be programmed * @param displayName * @return */ private static Flow buildDmacFlowDropIfPacketComingFromTunnel(BigInteger dpnId, String extDeviceNodeId, Long elanTag, String dstMacAddress) { List mkMatches = buildMatchesForElanTagShFlagAndDstMac(elanTag, /*shFlag*/ true, dstMacAddress); List mkInstructions = MDSALUtil.buildInstructionsDrop(); String flowId = getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpnId, extDeviceNodeId, dstMacAddress, elanTag, true); Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, flowId, 20, /* prio */ "Drop", 0, /* idleTimeout */ 0, /* hardTimeout */ ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions); return flow; } private static String getDmacDropFlowId(Long elanTag, String dstMacAddress) { return new StringBuilder(ElanConstants.ELAN_DMAC_TABLE).append(elanTag).append(dstMacAddress).append("Drop") .toString(); } /** * Builds a Flow to be programmed in a remote DPN's DMAC table. This method must be used when the MAC is located * in another CSS. * * 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(lportTag) * + output on ITM internal tunnel interface with the other DPN * * @param localDpId the local dp id * @param remoteDpId the remote dp id * @param lportTag the lport tag * @param elanTag the elan tag * @param macAddress the mac address * @param displayName the display name * @return the flow */ public static Flow buildDmacFlowForInternalRemoteMac(BigInteger localDpId, BigInteger remoteDpId, long lportTag, long elanTag, String macAddress, String displayName) { List mkMatches = buildMatchesForElanTagShFlagAndDstMac(elanTag, /*shFlag*/ false, macAddress); List mkInstructions = new ArrayList(); try { //List of Action for the provided Source and Destination DPIDs List actions = getInternalItmEgressAction(localDpId, remoteDpId, lportTag); mkInstructions.add( MDSALUtil.buildApplyActionsInstruction(actions) ); } catch (Exception e) { logger.error("Could not get Egress Actions for localDpId={} remoteDpId={} lportTag={}", localDpId, remoteDpId, lportTag); } Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, localDpId, remoteDpId, macAddress, elanTag), 20, /* prio */ displayName, 0, /* idleTimeout */ 0, /* hardTimeout */ ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions); return flow; } /** * Installs or removes flows in DMAC table for MACs that are/were located in * an external Elan Device. * * @param dpId * Id of the DPN where the DMAC table is going to be modified * @param extNodeId * Id of the External Device where the MAC is located * @param elanTag * Id of the ELAN * @param vni * VNI of the LogicalSwitch to which the MAC belongs to, and that * is associated with the ELAN * @param macAddress * the mac address * @param elanInstanceName * the elan instance name * @param addOrRemove * Indicates if flows must be installed or removed. * @see org.opendaylight.vpnservice.mdsalutil.MDSALUtil.MdsalOp */ public static void setupDmacFlowsToExternalRemoteMac(BigInteger dpId, String extNodeId, Long elanTag, Long vni, String macAddress, String elanInstanceName, MdsalOp addOrRemove) { if ( addOrRemove == MdsalOp.CREATION_OP ) { ElanUtils.installDmacFlowsToExternalRemoteMac(dpId, extNodeId, elanTag, vni, macAddress, elanInstanceName); } else if ( addOrRemove == MdsalOp.REMOVAL_OP ) { ElanUtils.deleteDmacFlowsToExternalMac(elanTag, dpId, extNodeId, macAddress ); } } /** * Delete dmac flows to external mac. * * @param elanTag * the elan tag * @param dpId * the dp id * @param extDeviceNodeId * the ext device node id * @param macToRemove * the mac to remove */ public static List> deleteDmacFlowsToExternalMac(long elanTag, BigInteger dpId, String extDeviceNodeId, String macToRemove ) { List> futures = new ArrayList<>(); synchronized (macToRemove) { // Removing the flows that sends the packet on an external tunnel String flowId = getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, extDeviceNodeId, macToRemove, elanTag, false); Flow flowToRemove = new FlowBuilder().setId(new FlowId(flowId)).setTableId(ElanConstants.ELAN_DMAC_TABLE) .build(); futures.add(mdsalMgr.removeFlow(dpId, flowToRemove)); // And now removing the drop flow flowId = getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, extDeviceNodeId, macToRemove, elanTag, true); flowToRemove = new FlowBuilder().setId(new FlowId(flowId)).setTableId(ElanConstants.ELAN_DMAC_TABLE) .build(); futures.add(mdsalMgr.removeFlow(dpId, flowToRemove)); } return futures; } /** * Gets the dpid from interface. * * @param interfaceName * the interface name * @return the dpid from interface */ public static BigInteger getDpidFromInterface(String interfaceName) { BigInteger dpId = null; Future> output = interfaceMgrRpcService .getDpidFromInterface(new GetDpidFromInterfaceInputBuilder().setIntfName(interfaceName).build()); try { RpcResult rpcResult = output.get(); if (rpcResult.isSuccessful()) { dpId = rpcResult.getResult().getDpid(); } } catch (NullPointerException | InterruptedException | ExecutionException e) { logger.error("Failed to get the DPN ID: {} for interface {}: {} ", dpId, interfaceName, e); } return dpId; } /** * Checks if is interface operational. * * @param interfaceName * the interface name * @param dataBroker * the data broker * @return true, if is interface operational */ public static boolean isInterfaceOperational(String interfaceName, DataBroker dataBroker) { if (StringUtils.isBlank(interfaceName)) { return false; } Interface ifState = getInterfaceStateFromOperDS(interfaceName, dataBroker); if (ifState == null) { return false; } return ((ifState.getOperStatus() == OperStatus.Up) && (ifState.getAdminStatus() == AdminStatus.Up)); } /** * Gets the interface state from operational ds. * * @param interfaceName * the interface name * @param dataBroker * the data broker * @return the interface state from oper ds */ public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface getInterfaceStateFromOperDS( String interfaceName, DataBroker dataBroker) { InstanceIdentifier ifStateId = createInterfaceStateInstanceIdentifier( interfaceName); Optional ifStateOptional = MDSALUtil .read(dataBroker, LogicalDatastoreType.OPERATIONAL, ifStateId); if (ifStateOptional.isPresent()) { return ifStateOptional.get(); } return null; } /** * Creates the interface state instance identifier. * * @param interfaceName * the interface name * @return the instance identifier */ public static InstanceIdentifier createInterfaceStateInstanceIdentifier( String interfaceName) { InstanceIdentifierBuilder idBuilder = InstanceIdentifier .builder(InterfacesState.class) .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class, new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey( interfaceName)); return idBuilder.build(); } }