vpnservice/elanmanager/elanmanager-impl/src/main/java/org/opendaylight/netvirt/elan/internal/ElanInterfaceManager.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netvirt.elan.internal;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.math.BigInteger;
  14 import java.util.ArrayList;
  15 import java.util.Collections;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Queue;
  20 import java.util.Set;
  21 import java.util.concurrent.ConcurrentHashMap;
  22 import java.util.concurrent.ConcurrentLinkedQueue;
  23 import java.util.concurrent.ConcurrentMap;
  24 import org.apache.commons.lang3.StringUtils;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  29 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  30 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  31 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  32 import org.opendaylight.genius.itm.globals.ITMConstants;
  33 import org.opendaylight.genius.mdsalutil.ActionInfo;
  34 import org.opendaylight.genius.mdsalutil.ActionType;
  35 import org.opendaylight.genius.mdsalutil.FlowEntity;
  36 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  37 import org.opendaylight.genius.mdsalutil.InstructionType;
  38 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  39 import org.opendaylight.genius.mdsalutil.MatchFieldType;
  40 import org.opendaylight.genius.mdsalutil.MatchInfo;
  41 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  42 import org.opendaylight.genius.mdsalutil.NwConstants;
  43 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  44 import org.opendaylight.genius.utils.ServiceIndex;
  45 import org.opendaylight.netvirt.elan.ElanException;
  46 import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayUtils;
  47 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  48 import org.opendaylight.netvirt.elan.utils.ElanForwardingEntriesHandler;
  49 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  50 import org.opendaylight.netvirt.elanmanager.utils.ElanL2GwCacheUtils;
  51 import org.opendaylight.netvirt.neutronvpn.api.l2gw.L2GatewayDevice;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeLeafTagName;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanForwardingTables;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacKey;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.forwarding.tables.MacTable;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.forwarding.tables.MacTableKey;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.ElanBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.ElanKey;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryBuilder;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryKey;
  90 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  91 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  92 import org.slf4j.Logger;
  93 import org.slf4j.LoggerFactory;
  94
  95 /**
  96  * Class in charge of handling creations, modifications and removals of
  97  * ElanInterfaces.
  98  *
  99  * @see org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface
 100  */
 101 @SuppressWarnings("deprecation")
 102 public class ElanInterfaceManager extends AsyncDataTreeChangeListenerBase<ElanInterface, ElanInterfaceManager>
 103         implements AutoCloseable {
 104
 105     private final DataBroker broker;
 106     private final IMdsalApiManager mdsalManager;
 107     private final IInterfaceManager interfaceManager;
 108     private final IdManagerService idManager;
 109     private final ElanForwardingEntriesHandler elanForwardingEntriesHandler;
 110     private ElanL2GatewayUtils elanL2GatewayUtils;
 111     private ElanUtils elanUtils;
 112
 113     private static final long WAIT_TIME_FOR_SYNC_INSTALL = Long.getLong("wait.time.sync.install", 300L);
 114
 115     private Map<String, ConcurrentLinkedQueue<ElanInterface>> unProcessedElanInterfaces = new ConcurrentHashMap<>();
 116
 117     private static final Logger LOG = LoggerFactory.getLogger(ElanInterfaceManager.class);
 118
 119     public ElanInterfaceManager(final DataBroker dataBroker,
 120                                 final IdManagerService managerService,
 121                                 final IMdsalApiManager mdsalApiManager,
 122                                 IInterfaceManager interfaceManager,
 123                                 final ElanForwardingEntriesHandler elanForwardingEntriesHandler) {
 124         super(ElanInterface.class, ElanInterfaceManager.class);
 125         this.broker = dataBroker;
 126         this.idManager = managerService;
 127         this.mdsalManager = mdsalApiManager;
 128         this.interfaceManager = interfaceManager;
 129         this.elanForwardingEntriesHandler = elanForwardingEntriesHandler;
 130     }
 131
 132     public void setElanUtils(ElanUtils elanUtils) {
 133         this.elanUtils = elanUtils;
 134         this.elanL2GatewayUtils = elanUtils.getElanL2GatewayUtils();
 135         this.elanForwardingEntriesHandler.setElanUtils(elanUtils);
 136     }
 137
 138     public void init() {
 139         registerListener(LogicalDatastoreType.CONFIGURATION, broker);
 140     }
 141
 142     @Override
 143     protected InstanceIdentifier<ElanInterface> getWildCardPath() {
 144         return InstanceIdentifier.create(ElanInterfaces.class).child(ElanInterface.class);
 145     }
 146
 147     @Override
 148     protected void remove(InstanceIdentifier<ElanInterface> identifier, ElanInterface del) {
 149         String interfaceName = del.getName();
 150         ElanInstance elanInfo = ElanUtils.getElanInstanceByName(broker, del.getElanInstanceName());
 151         /*
 152          * Handling in case the elan instance is deleted.If the Elan instance is
 153          * deleted, there is no need to explicitly delete the elan interfaces
 154          */
 155         if (elanInfo == null) {
 156             return;
 157         }
 158         InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 159         String elanInstanceName = elanInfo.getElanInstanceName();
 160         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 161         InterfaceRemoveWorkerOnElan configWorker = new InterfaceRemoveWorkerOnElan(elanInstanceName, elanInfo,
 162                 interfaceName, interfaceInfo, false, this);
 163         coordinator.enqueueJob(elanInstanceName, configWorker, ElanConstants.JOB_MAX_RETRIES);
 164     }
 165
 166     public void removeElanInterface(List<ListenableFuture<Void>> futures, ElanInstance elanInfo, String interfaceName,
 167             InterfaceInfo interfaceInfo, boolean isInterfaceStateRemoved) {
 168         String elanName = elanInfo.getElanInstanceName();
 169         boolean isLastElanInterface = false;
 170         long elanTag = elanInfo.getElanTag();
 171         WriteTransaction tx = broker.newWriteOnlyTransaction();
 172         WriteTransaction deleteFlowGroupTx = broker.newWriteOnlyTransaction();
 173         Elan elanState = removeElanStateForInterface(elanInfo, interfaceName, tx);
 174         if (elanState == null) {
 175             return;
 176         }
 177         List<String> elanInterfaces = elanState.getElanInterfaces();
 178         if (elanInterfaces.size() == 0) {
 179             isLastElanInterface = true;
 180         }
 181         if (interfaceInfo != null) {
 182             BigInteger dpId = interfaceInfo.getDpId();
 183             DpnInterfaces dpnInterfaces = removeElanDpnInterfaceFromOperationalDataStore(elanName, dpId, interfaceName,
 184                     elanTag, tx);
 185             /*
 186              * If there are not elan ports, remove the unknown dmac, terminating
 187              * service table flows, remote/local bc group
 188              */
 189             if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null
 190                     || dpnInterfaces.getInterfaces().isEmpty()) {
 191                 // No more Elan Interfaces in this DPN
 192                 LOG.debug("deleting the elan: {} present on dpId: {}", elanInfo.getElanInstanceName(), dpId);
 193                 removeDefaultTermFlow(dpId, elanInfo.getElanTag());
 194                 removeUnknownDmacFlow(dpId, elanInfo, deleteFlowGroupTx, elanInfo.getElanTag());
 195                 removeEtreeUnknownDmacFlow(dpId, elanInfo, deleteFlowGroupTx);
 196                 removeElanBroadcastGroup(elanInfo, interfaceInfo, deleteFlowGroupTx);
 197                 removeLocalBroadcastGroup(elanInfo, interfaceInfo, deleteFlowGroupTx);
 198                 removeEtreeBroadcastGrups(elanInfo, interfaceInfo, deleteFlowGroupTx);
 199                 if (ElanUtils.isVxlan(elanInfo)) {
 200                     unsetExternalTunnelTable(dpId, elanInfo);
 201                 }
 202             } else {
 203                 setupLocalBroadcastGroups(elanInfo, dpnInterfaces, interfaceInfo);
 204             }
 205         }
 206         futures.add(ElanUtils.waitForTransactionToComplete(tx));
 207         futures.add(ElanUtils.waitForTransactionToComplete(deleteFlowGroupTx));
 208         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 209         InterfaceRemoveWorkerOnElanInterface removeInterfaceWorker = new InterfaceRemoveWorkerOnElanInterface(
 210                 interfaceName, elanInfo, interfaceInfo, isInterfaceStateRemoved, this, isLastElanInterface);
 211         coordinator.enqueueJob(interfaceName, removeInterfaceWorker, ElanConstants.JOB_MAX_RETRIES);
 212     }
 213
 214     private void removeEtreeUnknownDmacFlow(BigInteger dpId, ElanInstance elanInfo,
 215             WriteTransaction deleteFlowGroupTx) {
 216         EtreeLeafTagName etreeLeafTag = elanUtils.getEtreeLeafTagByElanTag(elanInfo.getElanTag());
 217         if (etreeLeafTag != null) {
 218             long leafTag = etreeLeafTag.getEtreeLeafTag().getValue();
 219             removeUnknownDmacFlow(dpId, elanInfo, deleteFlowGroupTx, leafTag);
 220         }
 221     }
 222
 223     private void removeEtreeBroadcastGrups(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 224             WriteTransaction deleteFlowGroupTx) {
 225         removeLeavesEtreeBroadcastGroup(elanInfo, interfaceInfo, deleteFlowGroupTx);
 226         removeLeavesLocalBroadcastGroup(elanInfo, interfaceInfo, deleteFlowGroupTx);
 227     }
 228
 229     private void removeLeavesLocalBroadcastGroup(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 230             WriteTransaction deleteFlowGroupTx) {
 231         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
 232         if (etreeInstance != null) {
 233             BigInteger dpnId = interfaceInfo.getDpId();
 234             long groupId = ElanUtils.getEtreeLeafLocalBCGId(etreeInstance.getEtreeLeafTagVal().getValue());
 235             List<Bucket> listBuckets = new ArrayList<>();
 236             int bucketId = 0;
 237             listBuckets.add(getLocalBCGroupBucketInfo(interfaceInfo, bucketId));
 238             Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
 239                     MDSALUtil.buildBucketLists(listBuckets));
 240             LOG.trace("deleted the localBroadCast Group:{}", group);
 241             mdsalManager.removeGroupToTx(dpnId, group, deleteFlowGroupTx);
 242         }
 243     }
 244
 245     private void removeLeavesEtreeBroadcastGroup(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 246             WriteTransaction deleteFlowGroupTx) {
 247         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
 248         if (etreeInstance != null) {
 249             long etreeTag = etreeInstance.getEtreeLeafTagVal().getValue();
 250             int bucketId = 0;
 251             int actionKey = 0;
 252             List<Bucket> listBuckets = new ArrayList<>();
 253             List<Action> listAction = new ArrayList<>();
 254             listAction.add(new ActionInfo(ActionType.group,
 255                     new String[] { String.valueOf(ElanUtils.getEtreeLeafLocalBCGId(etreeTag)) }, ++actionKey)
 256                             .buildAction());
 257             listBuckets.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
 258                     MDSALUtil.WATCH_GROUP));
 259             bucketId++;
 260             listBuckets.addAll(getRemoteBCGroupBucketInfos(elanInfo, bucketId, interfaceInfo, etreeTag));
 261             BigInteger dpnId = interfaceInfo.getDpId();
 262             long groupId = ElanUtils.getEtreeLeafRemoteBCGId(etreeTag);
 263             Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
 264                     MDSALUtil.buildBucketLists(listBuckets));
 265             LOG.trace("deleting the remoteBroadCast group:{}", group);
 266             mdsalManager.removeGroupToTx(dpnId, group, deleteFlowGroupTx);
 267         }
 268     }
 269
 270     private Elan removeElanStateForInterface(ElanInstance elanInfo, String interfaceName, WriteTransaction tx) {
 271         String elanName = elanInfo.getElanInstanceName();
 272         Elan elanState = ElanUtils.getElanByName(broker, elanName);
 273         if (elanState == null) {
 274             return elanState;
 275         }
 276         List<String> elanInterfaces = elanState.getElanInterfaces();
 277         elanInterfaces.remove(interfaceName);
 278         if (elanInterfaces.isEmpty()) {
 279             tx.delete(LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanName));
 280             tx.delete(LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanMacTableOperationalDataPath(elanName));
 281             tx.delete(LogicalDatastoreType.OPERATIONAL,
 282                     ElanUtils.getElanInfoEntriesOperationalDataPath(elanInfo.getElanTag()));
 283         } else {
 284             Elan updateElanState = new ElanBuilder().setElanInterfaces(elanInterfaces).setName(elanName)
 285                     .setKey(new ElanKey(elanName)).build();
 286             tx.put(LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanName),
 287                     updateElanState);
 288         }
 289         return elanState;
 290     }
 291
 292     private void deleteElanInterfaceFromConfigDS(String interfaceName, WriteTransaction tx) {
 293         // removing the ElanInterface from the config data_store if interface is
 294         // not present in Interface config DS
 295         if (interfaceManager.getInterfaceInfoFromConfigDataStore(interfaceName) == null) {
 296             tx.delete(LogicalDatastoreType.CONFIGURATION,
 297                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName));
 298         }
 299     }
 300
 301     void removeEntriesForElanInterface(List<ListenableFuture<Void>> futures, ElanInstance elanInfo,
 302             InterfaceInfo interfaceInfo, String interfaceName, boolean isInterfaceStateRemoved,
 303             boolean isLastElanInterface) {
 304         String elanName = elanInfo.getElanInstanceName();
 305         WriteTransaction tx = broker.newWriteOnlyTransaction();
 306         WriteTransaction deleteFlowGroupTx = broker.newWriteOnlyTransaction();
 307         InstanceIdentifier<ElanInterfaceMac> elanInterfaceId = ElanUtils
 308                 .getElanInterfaceMacEntriesOperationalDataPath(interfaceName);
 309         LOG.debug("Removing the Interface:{} from elan:{}", interfaceName, elanName);
 310         if (interfaceInfo != null) {
 311             Optional<ElanInterfaceMac> existingElanInterfaceMac = elanUtils.read(broker,
 312                     LogicalDatastoreType.OPERATIONAL, elanInterfaceId);
 313             if (existingElanInterfaceMac.isPresent()) {
 314                 List<PhysAddress> macAddresses = new ArrayList<>();
 315                 List<MacEntry> existingMacEntries = existingElanInterfaceMac.get().getMacEntry();
 316                 List<MacEntry> macEntries = new ArrayList<>();
 317                 if (existingMacEntries != null && !existingMacEntries.isEmpty()) {
 318                     macEntries.addAll(existingMacEntries);
 319                 }
 320                 if (!macEntries.isEmpty()) {
 321                     for (MacEntry macEntry : macEntries) {
 322                         LOG.debug("removing the  mac-entry:{} present on elanInterface:{}",
 323                                 macEntry.getMacAddress().getValue(), interfaceName);
 324                         if (!isLastElanInterface) {
 325                             tx.delete(LogicalDatastoreType.OPERATIONAL,
 326                                     ElanUtils.getMacEntryOperationalDataPath(elanName, macEntry.getMacAddress()));
 327                         }
 328                         elanUtils.deleteMacFlows(elanInfo, interfaceInfo, macEntry, deleteFlowGroupTx);
 329                         macAddresses.add(macEntry.getMacAddress());
 330                     }
 331
 332                     // Removing all those MACs from External Devices belonging
 333                     // to this ELAN
 334                     if (ElanUtils.isVxlan(elanInfo)) {
 335                         elanL2GatewayUtils.removeMacsFromElanExternalDevices(elanInfo, macAddresses);
 336                     }
 337                 }
 338             }
 339             removeDefaultTermFlow(interfaceInfo.getDpId(), interfaceInfo.getInterfaceTag());
 340             removeFilterEqualsTable(elanInfo, interfaceInfo, deleteFlowGroupTx);
 341         } else {
 342             // Interface does not exist in ConfigDS, so lets remove everything
 343             // about that interface related to Elan
 344             ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(interfaceName);
 345             if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null) {
 346                 List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 347                 for (MacEntry macEntry : macEntries) {
 348                     tx.delete(LogicalDatastoreType.OPERATIONAL,
 349                             ElanUtils.getMacEntryOperationalDataPath(elanName, macEntry.getMacAddress()));
 350                 }
 351             }
 352         }
 353         tx.delete(LogicalDatastoreType.OPERATIONAL, elanInterfaceId);
 354         if (!isInterfaceStateRemoved) {
 355             unbindService(elanInfo, interfaceName, tx);
 356         }
 357         deleteElanInterfaceFromConfigDS(interfaceName, tx);
 358         futures.add(ElanUtils.waitForTransactionToComplete(tx));
 359         futures.add(ElanUtils.waitForTransactionToComplete(deleteFlowGroupTx));
 360     }
 361
 362     private DpnInterfaces removeElanDpnInterfaceFromOperationalDataStore(String elanName, BigInteger dpId,
 363             String interfaceName, long elanTag, WriteTransaction tx) {
 364         DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanName, dpId);
 365         if (dpnInterfaces != null) {
 366             List<String> interfaceLists = dpnInterfaces.getInterfaces();
 367             interfaceLists.remove(interfaceName);
 368
 369             if (interfaceLists == null || interfaceLists.isEmpty()) {
 370                 deleteAllRemoteMacsInADpn(elanName, dpId, elanTag);
 371                 deleteElanDpnInterface(elanName, dpId, tx);
 372             } else {
 373                 dpnInterfaces = updateElanDpnInterfacesList(elanName, dpId, interfaceLists, tx);
 374             }
 375         }
 376         return dpnInterfaces;
 377     }
 378
 379     private void deleteAllRemoteMacsInADpn(String elanName, BigInteger dpId, long elanTag) {
 380         List<DpnInterfaces> dpnInterfaces = elanUtils.getInvolvedDpnsInElan(elanName);
 381         for (DpnInterfaces dpnInterface : dpnInterfaces) {
 382             BigInteger currentDpId = dpnInterface.getDpId();
 383             if (!currentDpId.equals(dpId)) {
 384                 for (String elanInterface : dpnInterface.getInterfaces()) {
 385                     ElanInterfaceMac macs = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 386                     if (macs == null || macs.getMacEntry() == null) {
 387                         continue;
 388                     }
 389                     for (MacEntry mac : macs.getMacEntry()) {
 390                         removeTheMacFlowInTheDPN(dpId, elanTag, currentDpId, mac);
 391                         removeEtreeMacFlowInTheDPN(dpId, elanTag, currentDpId, mac);
 392                     }
 393                 }
 394             }
 395         }
 396     }
 397
 398     private void removeEtreeMacFlowInTheDPN(BigInteger dpId, long elanTag, BigInteger currentDpId, MacEntry mac) {
 399         EtreeLeafTagName etreeLeafTag = elanUtils.getEtreeLeafTagByElanTag(elanTag);
 400         if (etreeLeafTag != null) {
 401             removeTheMacFlowInTheDPN(dpId, etreeLeafTag.getEtreeLeafTag().getValue(), currentDpId, mac);
 402         }
 403     }
 404
 405     private void removeTheMacFlowInTheDPN(BigInteger dpId, long elanTag, BigInteger currentDpId, MacEntry mac) {
 406         mdsalManager
 407                 .removeFlow(dpId,
 408                         MDSALUtil.buildFlow(NwConstants.ELAN_DMAC_TABLE,
 409                                 ElanUtils.getKnownDynamicmacFlowRef(NwConstants.ELAN_DMAC_TABLE, dpId, currentDpId,
 410                                         mac.getMacAddress().getValue(), elanTag)));
 411     }
 412
 413     @Override
 414     protected void update(InstanceIdentifier<ElanInterface> identifier, ElanInterface original, ElanInterface update) {
 415         // updating the static-Mac Entries for the existing elanInterface
 416         String elanName = update.getElanInstanceName();
 417         String interfaceName = update.getName();
 418         List<PhysAddress> existingPhysAddress = original.getStaticMacEntries();
 419         List<PhysAddress> updatedPhysAddress = update.getStaticMacEntries();
 420         if (updatedPhysAddress != null && !updatedPhysAddress.isEmpty()) {
 421             List<PhysAddress> existingClonedPhyAddress = new ArrayList<>();
 422             if (existingPhysAddress != null && !existingPhysAddress.isEmpty()) {
 423                 existingClonedPhyAddress.addAll(0, existingPhysAddress);
 424                 existingPhysAddress.removeAll(updatedPhysAddress);
 425                 updatedPhysAddress.removeAll(existingClonedPhyAddress);
 426                 // removing the PhyAddress which are not presented in the
 427                 // updated List
 428                 for (PhysAddress physAddress : existingPhysAddress) {
 429                     removeInterfaceStaticMacEntires(elanName, interfaceName, physAddress);
 430                 }
 431             }
 432             // Adding the new PhysAddress which are presented in the updated
 433             // List
 434             if (updatedPhysAddress.size() > 0) {
 435                 for (PhysAddress physAddress : updatedPhysAddress) {
 436                     InstanceIdentifier<MacEntry> macId = getMacEntryOperationalDataPath(elanName, physAddress);
 437                     Optional<MacEntry> existingMacEntry = elanUtils.read(broker,
 438                             LogicalDatastoreType.OPERATIONAL, macId);
 439                     WriteTransaction tx = broker.newWriteOnlyTransaction();
 440                     if (existingMacEntry.isPresent()) {
 441                         elanForwardingEntriesHandler.updateElanInterfaceForwardingTablesList(
 442                                 elanName, interfaceName, existingMacEntry.get().getInterface(), existingMacEntry.get(),
 443                                 tx);
 444                     } else {
 445                         elanForwardingEntriesHandler.addElanInterfaceForwardingTableList(
 446                                 ElanUtils.getElanInstanceByName(broker, elanName), interfaceName, physAddress, tx);
 447                     }
 448                     ElanUtils.waitForTransactionToComplete(tx);
 449                 }
 450             }
 451         } else if (existingPhysAddress != null && !existingPhysAddress.isEmpty()) {
 452             for (PhysAddress physAddress : existingPhysAddress) {
 453                 removeInterfaceStaticMacEntires(elanName, interfaceName, physAddress);
 454             }
 455         }
 456     }
 457
 458     @Override
 459     protected void add(InstanceIdentifier<ElanInterface> identifier, ElanInterface elanInterfaceAdded) {
 460         String elanInstanceName = elanInterfaceAdded.getElanInstanceName();
 461         String interfaceName = elanInterfaceAdded.getName();
 462         InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 463         if (interfaceInfo == null) {
 464             LOG.warn("Interface {} is removed from Interface Oper DS due to port down ", interfaceName);
 465             return;
 466         }
 467         ElanInstance elanInstance = ElanUtils.getElanInstanceByName(broker, elanInstanceName);
 468
 469         if (elanInstance == null) {
 470             elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 471                     .setDescription(elanInterfaceAdded.getDescription()).build();
 472             // Add the ElanInstance in the Configuration data-store
 473             WriteTransaction tx = broker.newWriteOnlyTransaction();
 474             List<String> elanInterfaces = new ArrayList<>();
 475             elanInterfaces.add(interfaceName);
 476             ElanUtils.updateOperationalDataStore(broker, idManager,
 477                     elanInstance, elanInterfaces, tx);
 478             ElanUtils.waitForTransactionToComplete(tx);
 479             elanInstance = ElanUtils.getElanInstanceByName(broker, elanInstanceName);
 480         }
 481
 482         Long elanTag = elanInstance.getElanTag();
 483         // If elan tag is not updated, then put the elan interface into
 484         // unprocessed entry map and entry. Let entries
 485         // in this map get processed during ELAN update DCN.
 486         if (elanTag == null) {
 487             ConcurrentLinkedQueue<ElanInterface> elanInterfaces = unProcessedElanInterfaces.get(elanInstanceName);
 488             if (elanInterfaces == null) {
 489                 elanInterfaces = new ConcurrentLinkedQueue<>();
 490             }
 491             elanInterfaces.add(elanInterfaceAdded);
 492             unProcessedElanInterfaces.put(elanInstanceName, elanInterfaces);
 493             return;
 494         }
 495         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 496         InterfaceAddWorkerOnElan addWorker = new InterfaceAddWorkerOnElan(elanInstanceName, elanInterfaceAdded,
 497                 interfaceInfo, elanInstance, this);
 498         coordinator.enqueueJob(elanInstanceName, addWorker, ElanConstants.JOB_MAX_RETRIES);
 499     }
 500
 501     void handleunprocessedElanInterfaces(ElanInstance elanInstance) throws ElanException {
 502         List<ListenableFuture<Void>> futures = new ArrayList<>();
 503         Queue<ElanInterface> elanInterfaces = unProcessedElanInterfaces.get(elanInstance.getElanInstanceName());
 504         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 505             return;
 506         }
 507         for (ElanInterface elanInterface : elanInterfaces) {
 508             String interfaceName = elanInterface.getName();
 509             InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 510             addElanInterface(futures, elanInterface, interfaceInfo, elanInstance);
 511         }
 512     }
 513
 514     void programRemoteDmacFlow(ElanInstance elanInstance, InterfaceInfo interfaceInfo,
 515             WriteTransaction writeFlowGroupTx) throws ElanException {
 516         ElanDpnInterfacesList elanDpnInterfacesList = elanUtils
 517                 .getElanDpnInterfacesList(elanInstance.getElanInstanceName());
 518         List<DpnInterfaces> dpnInterfaceLists = null;
 519         if (elanDpnInterfacesList != null) {
 520             dpnInterfaceLists = elanDpnInterfacesList.getDpnInterfaces();
 521         }
 522         if (dpnInterfaceLists == null) {
 523             dpnInterfaceLists = new ArrayList<>();
 524         }
 525         for (DpnInterfaces dpnInterfaces : dpnInterfaceLists) {
 526             if (dpnInterfaces.getDpId().equals(interfaceInfo.getDpId())) {
 527                 continue;
 528             }
 529             List<String> remoteElanInterfaces = dpnInterfaces.getInterfaces();
 530             for (String remoteIf : remoteElanInterfaces) {
 531                 ElanInterfaceMac elanIfMac = elanUtils.getElanInterfaceMacByInterfaceName(remoteIf);
 532                 InterfaceInfo remoteInterface = interfaceManager.getInterfaceInfo(remoteIf);
 533                 if (elanIfMac == null) {
 534                     continue;
 535                 }
 536                 List<MacEntry> remoteMacEntries = elanIfMac.getMacEntry();
 537                 if (remoteMacEntries != null) {
 538                     for (MacEntry macEntry : remoteMacEntries) {
 539                         PhysAddress physAddress = macEntry.getMacAddress();
 540                         elanUtils.setupRemoteDmacFlow(interfaceInfo.getDpId(), remoteInterface.getDpId(),
 541                                 remoteInterface.getInterfaceTag(), elanInstance.getElanTag(), physAddress.getValue(),
 542                                 elanInstance.getElanInstanceName(), writeFlowGroupTx, remoteIf);
 543                     }
 544                 }
 545             }
 546         }
 547     }
 548
 549     void addElanInterface(List<ListenableFuture<Void>> futures, ElanInterface elanInterface,
 550             InterfaceInfo interfaceInfo, ElanInstance elanInstance) throws ElanException {
 551         Preconditions.checkNotNull(elanInstance, "elanInstance cannot be null");
 552         Preconditions.checkNotNull(interfaceInfo, "interfaceInfo cannot be null");
 553         Preconditions.checkNotNull(elanInterface, "elanInterface cannot be null");
 554
 555         String interfaceName = elanInterface.getName();
 556         String elanInstanceName = elanInterface.getElanInstanceName();
 557
 558         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 559         WriteTransaction tx = broker.newWriteOnlyTransaction();
 560         if (elanInfo == null) {
 561             List<String> elanInterfaces = new ArrayList<>();
 562             elanInterfaces.add(interfaceName);
 563             ElanUtils.updateOperationalDataStore(broker, idManager,
 564                     elanInstance, elanInterfaces, tx);
 565         } else {
 566             createElanStateList(elanInstanceName, interfaceName, tx);
 567         }
 568         boolean isFirstInterfaceInDpn = false;
 569         // Specific actions to the DPN where the ElanInterface has been added,
 570         // for example, programming the
 571         // External tunnel table if needed or adding the ElanInterface to the
 572         // DpnInterfaces in the operational DS.
 573         BigInteger dpId = interfaceInfo != null ? dpId = interfaceInfo.getDpId() : null;
 574         DpnInterfaces dpnInterfaces = null;
 575         if (dpId != null && !dpId.equals(ElanConstants.INVALID_DPN)) {
 576             InstanceIdentifier<DpnInterfaces> elanDpnInterfaces = ElanUtils
 577                     .getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId);
 578             Optional<DpnInterfaces> existingElanDpnInterfaces = elanUtils.read(broker,
 579                     LogicalDatastoreType.OPERATIONAL, elanDpnInterfaces);
 580             if (!existingElanDpnInterfaces.isPresent()) {
 581                 isFirstInterfaceInDpn = true;
 582                 // ELAN's 1st ElanInterface added to this DPN
 583                 dpnInterfaces = createElanInterfacesList(elanInstanceName, interfaceName, dpId, tx);
 584                 // The 1st ElanInterface in a DPN must program the Ext Tunnel
 585                 // table, but only if Elan has VNI
 586                 if (ElanUtils.isVxlan(elanInstance)) {
 587                     setExternalTunnelTable(dpId, elanInstance);
 588                 }
 589                 elanL2GatewayUtils.installElanL2gwDevicesLocalMacsInDpn(dpId, elanInstance, interfaceName);
 590             } else {
 591                 List<String> elanInterfaces = existingElanDpnInterfaces.get().getInterfaces();
 592                 elanInterfaces.add(interfaceName);
 593                 if (elanInterfaces.size() == 1) { // 1st dpn interface
 594                     elanL2GatewayUtils.installElanL2gwDevicesLocalMacsInDpn(dpId, elanInstance, interfaceName);
 595                 }
 596                 dpnInterfaces = updateElanDpnInterfacesList(elanInstanceName, dpId, elanInterfaces, tx);
 597             }
 598         }
 599
 600         // add code to install Local/Remote BC group, unknow DMAC entry,
 601         // terminating service table flow entry
 602         // call bindservice of interfacemanager to create ingress table flow
 603         // enty.
 604         // Add interface to the ElanInterfaceForwardingEntires Container
 605         createElanInterfaceTablesList(interfaceName, tx);
 606         if (interfaceInfo != null) {
 607             installEntriesForFirstInterfaceonDpn(elanInstance, interfaceInfo, dpnInterfaces, isFirstInterfaceInDpn, tx);
 608         }
 609         futures.add(ElanUtils.waitForTransactionToComplete(tx));
 610
 611         DataStoreJobCoordinator coordinator = DataStoreJobCoordinator.getInstance();
 612         InterfaceAddWorkerOnElanInterface addWorker = new InterfaceAddWorkerOnElanInterface(interfaceName,
 613                 elanInterface, interfaceInfo, elanInstance, isFirstInterfaceInDpn, this);
 614         coordinator.enqueueJob(interfaceName, addWorker, ElanConstants.JOB_MAX_RETRIES);
 615     }
 616
 617     void setupEntriesForElanInterface(List<ListenableFuture<Void>> futures, ElanInstance elanInstance,
 618             ElanInterface elanInterface, InterfaceInfo interfaceInfo, boolean isFirstInterfaceInDpn)
 619             throws ElanException {
 620         String elanInstanceName = elanInstance.getElanInstanceName();
 621         String interfaceName = elanInterface.getName();
 622         WriteTransaction tx = broker.newWriteOnlyTransaction();
 623         BigInteger dpId = interfaceInfo.getDpId();
 624         WriteTransaction writeFlowGroupTx = broker.newWriteOnlyTransaction();
 625         installEntriesForElanInterface(elanInstance, interfaceInfo, isFirstInterfaceInDpn, tx, writeFlowGroupTx);
 626         List<PhysAddress> staticMacAddresses = elanInterface.getStaticMacEntries();
 627         if (staticMacAddresses != null) {
 628             boolean isInterfaceOperational = isOperational(interfaceInfo);
 629             for (PhysAddress physAddress : staticMacAddresses) {
 630                 InstanceIdentifier<MacEntry> macId = getMacEntryOperationalDataPath(elanInstanceName, physAddress);
 631                 Optional<MacEntry> existingMacEntry = elanUtils.read(broker,
 632                         LogicalDatastoreType.OPERATIONAL, macId);
 633                 if (existingMacEntry.isPresent()) {
 634                     elanForwardingEntriesHandler.updateElanInterfaceForwardingTablesList(
 635                             elanInstanceName, interfaceName, existingMacEntry.get().getInterface(),
 636                             existingMacEntry.get(), tx);
 637                 } else {
 638                     elanForwardingEntriesHandler
 639                             .addElanInterfaceForwardingTableList(elanInstance, interfaceName, physAddress, tx);
 640                 }
 641
 642                 if (isInterfaceOperational) {
 643                     // Setting SMAC, DMAC, UDMAC in this DPN and also in other
 644                     // DPNs
 645                     elanUtils.setupMacFlows(elanInstance, interfaceInfo, ElanConstants.STATIC_MAC_TIMEOUT,
 646                             physAddress.getValue(), writeFlowGroupTx);
 647                 }
 648             }
 649
 650             if (isInterfaceOperational) {
 651                 // Add MAC in TOR's remote MACs via OVSDB. Outside of the loop
 652                 // on purpose.
 653                 elanL2GatewayUtils.scheduleAddDpnMacInExtDevices(elanInstance.getElanInstanceName(), dpId,
 654                         staticMacAddresses);
 655             }
 656         }
 657         futures.add(ElanUtils.waitForTransactionToComplete(tx));
 658         futures.add(ElanUtils.waitForTransactionToComplete(writeFlowGroupTx));
 659     }
 660
 661     protected void removeInterfaceStaticMacEntires(String elanInstanceName, String interfaceName,
 662             PhysAddress physAddress) {
 663         InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 664         InstanceIdentifier<MacEntry> macId = getMacEntryOperationalDataPath(elanInstanceName, physAddress);
 665         Optional<MacEntry> existingMacEntry = elanUtils.read(broker,
 666                 LogicalDatastoreType.OPERATIONAL, macId);
 667
 668         if (!existingMacEntry.isPresent()) {
 669             return;
 670         }
 671
 672         MacEntry macEntry = new MacEntryBuilder().setMacAddress(physAddress).setInterface(interfaceName)
 673                 .setKey(new MacEntryKey(physAddress)).build();
 674         WriteTransaction tx = broker.newWriteOnlyTransaction();
 675         elanForwardingEntriesHandler.deleteElanInterfaceForwardingEntries(
 676                 ElanUtils.getElanInstanceByName(broker, elanInstanceName), interfaceInfo, macEntry, tx);
 677         elanForwardingEntriesHandler.deleteElanInterfaceMacForwardingEntries(interfaceName,
 678                 physAddress, tx);
 679         ElanUtils.waitForTransactionToComplete(tx);
 680     }
 681
 682     private InstanceIdentifier<MacEntry> getMacEntryOperationalDataPath(String elanName, PhysAddress physAddress) {
 683         return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class, new MacTableKey(elanName))
 684                 .child(MacEntry.class, new MacEntryKey(physAddress)).build();
 685     }
 686
 687     private void installEntriesForElanInterface(ElanInstance elanInstance, InterfaceInfo interfaceInfo,
 688             boolean isFirstInterfaceInDpn, WriteTransaction tx, WriteTransaction writeFlowGroupTx)
 689             throws ElanException {
 690         if (!isOperational(interfaceInfo)) {
 691             return;
 692         }
 693         BigInteger dpId = interfaceInfo.getDpId();
 694         elanUtils.setupTermDmacFlows(interfaceInfo, mdsalManager, writeFlowGroupTx);
 695         setupFilterEqualsTable(elanInstance, interfaceInfo, writeFlowGroupTx);
 696         if (isFirstInterfaceInDpn) {
 697             // Terminating Service , UnknownDMAC Table.
 698             setupTerminateServiceTable(elanInstance, dpId, writeFlowGroupTx);
 699             setupUnknownDMacTable(elanInstance, dpId, writeFlowGroupTx);
 700             // update the remote-DPNs remoteBC group entry with Tunnels
 701             if (ElanUtils.isVxlan(elanInstance)) {
 702                 setElanBCGrouponOtherDpns(elanInstance, elanInstance.getElanTag().longValue(), dpId, writeFlowGroupTx);
 703             }
 704             /*
 705              * Install remote DMAC flow. This is required since this DPN is
 706              * added later to the elan instance and remote DMACs of other
 707              * interfaces in this elan instance are not present in the current
 708              * dpn.
 709              */
 710             programRemoteDmacFlow(elanInstance, interfaceInfo, writeFlowGroupTx);
 711         }
 712         // bind the Elan service to the Interface
 713         bindService(elanInstance,
 714                 ElanUtils.getElanInterfaceByElanInterfaceName(broker, interfaceInfo.getInterfaceName()), tx);
 715     }
 716
 717     public void installEntriesForFirstInterfaceonDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 718             DpnInterfaces dpnInterfaces, boolean isFirstInterfaceInDpn, WriteTransaction tx) {
 719         if (!isOperational(interfaceInfo)) {
 720             return;
 721         }
 722         // LocalBroadcast Group creation with elan-Interfaces
 723         setupLocalBroadcastGroups(elanInfo, dpnInterfaces, interfaceInfo);
 724         if (isFirstInterfaceInDpn) {
 725             LOG.trace("waitTimeForSyncInstall is {}", WAIT_TIME_FOR_SYNC_INSTALL);
 726             BigInteger dpId = interfaceInfo.getDpId();
 727             // RemoteBroadcast Group creation
 728             try {
 729                 Thread.sleep(WAIT_TIME_FOR_SYNC_INSTALL);
 730             } catch (InterruptedException e1) {
 731                 LOG.warn("Error while waiting for local BC group for ELAN {} to install", elanInfo);
 732             }
 733             setupElanBroadcastGroups(elanInfo, dpnInterfaces, dpId);
 734             try {
 735                 Thread.sleep(WAIT_TIME_FOR_SYNC_INSTALL);
 736             } catch (InterruptedException e1) {
 737                 LOG.warn("Error while waiting for local BC group for ELAN {} to install", elanInfo);
 738             }
 739         }
 740     }
 741
 742     public void setupFilterEqualsTable(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 743             WriteTransaction writeFlowGroupTx) {
 744         int ifTag = interfaceInfo.getInterfaceTag();
 745         Flow flow = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 746                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, ifTag), 9, elanInfo.getElanInstanceName(), 0, 0,
 747                 ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 748                 getTunnelIdMatchForFilterEqualsLPortTag(ifTag),
 749                 elanUtils.getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName()));
 750
 751         mdsalManager.addFlowToTx(interfaceInfo.getDpId(), flow, writeFlowGroupTx);
 752
 753         Flow flowEntry = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 754                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, 1000 + ifTag), 10, elanInfo.getElanInstanceName(), 0,
 755                 0, ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 756                 getMatchesForFilterEqualsLPortTag(ifTag), MDSALUtil.buildInstructionsDrop());
 757
 758         mdsalManager.addFlowToTx(interfaceInfo.getDpId(), flowEntry, writeFlowGroupTx);
 759     }
 760
 761     public void removeFilterEqualsTable(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 762             WriteTransaction deleteFlowGroupTx) {
 763         int ifTag = interfaceInfo.getInterfaceTag();
 764         Flow flow = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 765                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, ifTag), 9, elanInfo.getElanInstanceName(), 0, 0,
 766                 ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 767                 getTunnelIdMatchForFilterEqualsLPortTag(ifTag),
 768                 elanUtils.getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName()));
 769
 770         mdsalManager.removeFlowToTx(interfaceInfo.getDpId(), flow, deleteFlowGroupTx);
 771
 772         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 773                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, 1000 + ifTag), 10, elanInfo.getElanInstanceName(), 0,
 774                 0, ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 775                 getMatchesForFilterEqualsLPortTag(ifTag), MDSALUtil.buildInstructionsDrop());
 776
 777         mdsalManager.removeFlowToTx(interfaceInfo.getDpId(), flowEntity, deleteFlowGroupTx);
 778     }
 779
 780     private List<Bucket> getRemoteBCGroupBucketInfos(ElanInstance elanInfo, int bucketKeyStart,
 781             InterfaceInfo interfaceInfo, long elanTag) {
 782         return getRemoteBCGroupBuckets(elanInfo, null, interfaceInfo.getDpId(), bucketKeyStart, elanTag);
 783     }
 784
 785     private List<Bucket> getRemoteBCGroupBuckets(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId,
 786             int bucketId, long elanTag) {
 787         List<Bucket> listBucketInfo = new ArrayList<>();
 788         ElanDpnInterfacesList elanDpns = elanUtils.getElanDpnInterfacesList(elanInfo.getElanInstanceName());
 789         listBucketInfo.addAll(getRemoteBCGroupTunnelBuckets(elanDpns, dpnId, bucketId, elanTag));
 790         listBucketInfo.addAll(getRemoteBCGroupExternalPortBuckets(elanDpns, dpnInterfaces, dpnId, bucketId));
 791         listBucketInfo.addAll(getRemoteBCGroupBucketsOfElanL2GwDevices(elanInfo, dpnId, bucketId));
 792         return listBucketInfo;
 793     }
 794
 795     @SuppressWarnings("checkstyle:IllegalCatch")
 796     private List<Bucket> getRemoteBCGroupTunnelBuckets(ElanDpnInterfacesList elanDpns, BigInteger dpnId, int bucketId,
 797             long elanTag) {
 798         List<Bucket> listBucketInfo = new ArrayList<>();
 799         if (elanDpns != null) {
 800             for (DpnInterfaces dpnInterface : elanDpns.getDpnInterfaces()) {
 801                 if (elanUtils.isDpnPresent(dpnInterface.getDpId()) && dpnInterface.getDpId() != dpnId
 802                         && dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty()) {
 803                     try {
 804                         List<Action> listActionInfo = elanUtils.getInternalTunnelItmEgressAction(dpnId,
 805                                 dpnInterface.getDpId(), elanTag);
 806                         if (listActionInfo.isEmpty()) {
 807                             continue;
 808                         }
 809                         listBucketInfo.add(MDSALUtil.buildBucket(listActionInfo, MDSALUtil.GROUP_WEIGHT, bucketId,
 810                                 MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 811                         bucketId++;
 812                     } catch (Exception ex) {
 813                         LOG.error("Logical Group Interface not found between source Dpn - {}, destination Dpn - {} ",
 814                                 dpnId, dpnInterface.getDpId(), ex);
 815                     }
 816                 }
 817             }
 818         }
 819         return listBucketInfo;
 820     }
 821
 822     private List<Bucket> getRemoteBCGroupExternalPortBuckets(ElanDpnInterfacesList elanDpns,
 823             DpnInterfaces dpnInterfaces, BigInteger dpnId, int bucketId) {
 824         DpnInterfaces currDpnInterfaces = dpnInterfaces != null ? dpnInterfaces : getDpnInterfaces(elanDpns, dpnId);
 825         if (currDpnInterfaces == null || !elanUtils.isDpnPresent(currDpnInterfaces.getDpId())
 826                 || currDpnInterfaces.getInterfaces() == null || currDpnInterfaces.getInterfaces().isEmpty()) {
 827             return Collections.emptyList();
 828         }
 829
 830         List<Bucket> listBucketInfo = new ArrayList<>();
 831         for (String interfaceName : currDpnInterfaces.getInterfaces()) {
 832             if (elanUtils.isExternal(interfaceName)) {
 833                 List<Action> listActionInfo = elanUtils.getExternalPortItmEgressAction(interfaceName);
 834                 if (!listActionInfo.isEmpty()) {
 835                     listBucketInfo.add(MDSALUtil.buildBucket(listActionInfo, MDSALUtil.GROUP_WEIGHT, bucketId,
 836                             MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 837                     bucketId++;
 838                 }
 839             }
 840         }
 841         return listBucketInfo;
 842     }
 843
 844     private DpnInterfaces getDpnInterfaces(ElanDpnInterfacesList elanDpns, BigInteger dpnId) {
 845         if (elanDpns != null) {
 846             for (DpnInterfaces dpnInterface : elanDpns.getDpnInterfaces()) {
 847                 if (dpnInterface.getDpId() == dpnId) {
 848                     return dpnInterface;
 849                 }
 850             }
 851         }
 852         return null;
 853     }
 854
 855     @SuppressWarnings("checkstyle:IllegalCatch")
 856     private void setElanBCGrouponOtherDpns(ElanInstance elanInfo, long elanTag, BigInteger dpId, WriteTransaction tx) {
 857         long groupId = ElanUtils.getElanRemoteBCGId(elanTag);
 858         List<Bucket> listBucket = new ArrayList<>();
 859         int bucketId = 0;
 860         ElanDpnInterfacesList elanDpns = elanUtils.getElanDpnInterfacesList(elanInfo.getElanInstanceName());
 861         if (elanDpns != null) {
 862             List<DpnInterfaces> dpnInterfaceses = elanDpns.getDpnInterfaces();
 863             for (DpnInterfaces dpnInterface : dpnInterfaceses) {
 864                 List<Bucket> remoteListBucketInfo = new ArrayList<>();
 865                 if (elanUtils.isDpnPresent(dpnInterface.getDpId()) && !dpnInterface.getDpId().equals(dpId)
 866                         && dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty()) {
 867                     List<Action> listAction = new ArrayList<>();
 868                     int actionKey = 0;
 869                     listAction.add(new ActionInfo(ActionType.group,
 870                             new String[] { String.valueOf(ElanUtils.getElanLocalBCGId(elanTag)) }, ++actionKey)
 871                                     .buildAction());
 872                     listBucket.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId,
 873                             MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 874                     bucketId++;
 875                     remoteListBucketInfo.addAll(listBucket);
 876                     for (DpnInterfaces otherFes : dpnInterfaceses) {
 877                         if (elanUtils.isDpnPresent(otherFes.getDpId()) && otherFes.getDpId() != dpnInterface.getDpId()
 878                                 && otherFes.getInterfaces() != null && !otherFes.getInterfaces().isEmpty()) {
 879                             try {
 880                                 List<Action> remoteListActionInfo = elanUtils.getInternalTunnelItmEgressAction(
 881                                         dpnInterface.getDpId(), otherFes.getDpId(), elanTag);
 882                                 if (!remoteListActionInfo.isEmpty()) {
 883                                     remoteListBucketInfo
 884                                             .add(MDSALUtil.buildBucket(remoteListActionInfo, MDSALUtil.GROUP_WEIGHT,
 885                                                     bucketId, MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 886                                     bucketId++;
 887                                 }
 888                             } catch (Exception ex) {
 889                                 LOG.error("setElanBCGrouponOtherDpns failed due to Exception caught; "
 890                                         + "Logical Group Interface not found between source Dpn - {}, "
 891                                         + "destination Dpn - {} ", dpnInterface.getDpId(), otherFes.getDpId(), ex);
 892                                 return;
 893                             }
 894                         }
 895                     }
 896                     List<Bucket> elanL2GwDevicesBuckets = getRemoteBCGroupBucketsOfElanL2GwDevices(elanInfo, dpId,
 897                             bucketId);
 898                     remoteListBucketInfo.addAll(elanL2GwDevicesBuckets);
 899
 900                     if (remoteListBucketInfo.size() == 0) {
 901                         LOG.debug("No ITM is present on Dpn - {} ", dpnInterface.getDpId());
 902                         continue;
 903                     }
 904                     Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
 905                             MDSALUtil.buildBucketLists(remoteListBucketInfo));
 906                     mdsalManager.addGroupToTx(dpnInterface.getDpId(), group, tx);
 907                 }
 908             }
 909         }
 910     }
 911
 912     /**
 913      * Returns the bucket info with the given interface as the only bucket.
 914      */
 915     private Bucket getLocalBCGroupBucketInfo(InterfaceInfo interfaceInfo, int bucketIdStart) {
 916         return MDSALUtil.buildBucket(getInterfacePortActions(interfaceInfo), MDSALUtil.GROUP_WEIGHT, bucketIdStart,
 917                 MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP);
 918     }
 919
 920     private List<MatchInfo> buildMatchesForVni(Long vni) {
 921         List<MatchInfo> mkMatches = new ArrayList<>();
 922         MatchInfo match = new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(vni) });
 923         mkMatches.add(match);
 924         return mkMatches;
 925     }
 926
 927     private List<Instruction> getInstructionsForOutGroup(long groupId) {
 928         List<Instruction> mkInstructions = new ArrayList<>();
 929         List<Action> actions = new ArrayList<>();
 930         actions.add(new ActionInfo(ActionType.group, new String[] { Long.toString(groupId) }).buildAction());
 931         mkInstructions.add(MDSALUtil.getWriteActionsInstruction(actions, 0));
 932         return mkInstructions;
 933     }
 934
 935     private List<MatchInfo> getMatchesForElanTag(long elanTag, boolean isSHFlagSet) {
 936         List<MatchInfo> mkMatches = new ArrayList<>();
 937         // Matching metadata
 938         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 939                 ElanUtils.getElanMetadataLabel(elanTag, isSHFlagSet), MetaDataUtil.METADATA_MASK_SERVICE_SH_FLAG }));
 940         return mkMatches;
 941     }
 942
 943     /**
 944      * Builds the list of instructions to be installed in the External Tunnel
 945      * table (38), which so far consists in writing the elanTag in metadata and
 946      * send packet to the new DHCP table.
 947      *
 948      * @param elanTag
 949      *            elanTag to be written in metadata when flow is selected
 950      * @return the instructions ready to be installed in a flow
 951      */
 952     private List<InstructionInfo> getInstructionsExtTunnelTable(Long elanTag) {
 953         List<InstructionInfo> mkInstructions = new ArrayList<>();
 954         mkInstructions.add(new InstructionInfo(InstructionType.write_metadata,
 955                 new BigInteger[] { ElanUtils.getElanMetadataLabel(elanTag), ElanUtils.getElanMetadataMask() }));
 956         // TODO: We should point to SMAC or DMAC depending on a configuration
 957         // property to enable
 958         // mac learning
 959         mkInstructions.add(new InstructionInfo(InstructionType.goto_table, new long[] { NwConstants.ELAN_DMAC_TABLE }));
 960
 961         return mkInstructions;
 962     }
 963
 964     // Install DMAC entry on dst DPN
 965     public void installDMacAddressTables(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId)
 966             throws ElanException {
 967         String interfaceName = interfaceInfo.getInterfaceName();
 968         ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(interfaceName);
 969         if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null) {
 970             WriteTransaction writeFlowTx = broker.newWriteOnlyTransaction();
 971             List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 972             for (MacEntry macEntry : macEntries) {
 973                 PhysAddress physAddress = macEntry.getMacAddress();
 974                 elanUtils.setupDMacFlowonRemoteDpn(elanInfo, interfaceInfo, dstDpId, physAddress.getValue(),
 975                         writeFlowTx);
 976             }
 977             writeFlowTx.submit();
 978         }
 979     }
 980
 981     public void setupElanBroadcastGroups(ElanInstance elanInfo, BigInteger dpnId) {
 982         setupElanBroadcastGroups(elanInfo, null, dpnId);
 983     }
 984
 985     public void setupElanBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId) {
 986         setupStandardElanBroadcastGroups(elanInfo, dpnInterfaces, dpnId);
 987         setupLeavesEtreeBroadcastGroups(elanInfo, dpnInterfaces, dpnId);
 988     }
 989
 990     public void setupStandardElanBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId) {
 991         List<Bucket> listBucket = new ArrayList<>();
 992         int bucketId = 0;
 993         int actionKey = 0;
 994         Long elanTag = elanInfo.getElanTag();
 995         List<Action> listAction = new ArrayList<>();
 996         listAction.add(new ActionInfo(ActionType.group,
 997                 new String[] { String.valueOf(ElanUtils.getElanLocalBCGId(elanTag)) }, ++actionKey).buildAction());
 998         listBucket.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
 999                 MDSALUtil.WATCH_GROUP));
1000         bucketId++;
1001         List<Bucket> listBucketInfoRemote = getRemoteBCGroupBuckets(elanInfo, dpnInterfaces, dpnId, bucketId,
1002                 elanInfo.getElanTag());
1003         listBucket.addAll(listBucketInfoRemote);
1004         long groupId = ElanUtils.getElanRemoteBCGId(elanTag);
1005         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1006                 MDSALUtil.buildBucketLists(listBucket));
1007         LOG.trace("Installing the remote BroadCast Group:{}", group);
1008         mdsalManager.syncInstallGroup(dpnId, group, ElanConstants.DELAY_TIME_IN_MILLISECOND);
1009     }
1010
1011     public void setupLeavesEtreeBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId) {
1012         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1013         if (etreeInstance != null) {
1014             long etreeLeafTag = etreeInstance.getEtreeLeafTagVal().getValue();
1015             List<Bucket> listBucket = new ArrayList<>();
1016             int bucketId = 0;
1017             int actionKey = 0;
1018             List<Action> listAction = new ArrayList<>();
1019             listAction.add(new ActionInfo(ActionType.group,
1020                     new String[] { String.valueOf(ElanUtils.getEtreeLeafLocalBCGId(etreeLeafTag)) }, ++actionKey)
1021                             .buildAction());
1022             listBucket.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
1023                     MDSALUtil.WATCH_GROUP));
1024             bucketId++;
1025             List<Bucket> listBucketInfoRemote = getRemoteBCGroupBuckets(elanInfo, dpnInterfaces, dpnId, bucketId,
1026                     etreeLeafTag);
1027             listBucket.addAll(listBucketInfoRemote);
1028             long groupId = ElanUtils.getEtreeLeafRemoteBCGId(etreeLeafTag);
1029             Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1030                     MDSALUtil.buildBucketLists(listBucket));
1031             LOG.trace("Installing the remote BroadCast Group:{}", group);
1032             mdsalManager.syncInstallGroup(dpnId, group,
1033                     ElanConstants.DELAY_TIME_IN_MILLISECOND);
1034         }
1035     }
1036
1037     private void createDropBucket(List<Bucket> listBucket) {
1038         List<Action> actionsInfos = new ArrayList<>();
1039         actionsInfos.add(new ActionInfo(ActionType.drop_action, new String[] {}).buildAction());
1040         Bucket dropBucket = MDSALUtil.buildBucket(actionsInfos, MDSALUtil.GROUP_WEIGHT, 0, MDSALUtil.WATCH_PORT,
1041                 MDSALUtil.WATCH_GROUP);
1042         listBucket.add(dropBucket);
1043     }
1044
1045     public void setupLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface,
1046             InterfaceInfo interfaceInfo) {
1047         setupStandardLocalBroadcastGroups(elanInfo, newDpnInterface, interfaceInfo);
1048         setupLeavesLocalBroadcastGroups(elanInfo, newDpnInterface, interfaceInfo);
1049     }
1050
1051     public void setupStandardLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface,
1052             InterfaceInfo interfaceInfo) {
1053         List<Bucket> listBucket = new ArrayList<>();
1054         int bucketId = 0;
1055         long groupId = ElanUtils.getElanLocalBCGId(elanInfo.getElanTag());
1056
1057         List<String> interfaces = new ArrayList<>();
1058         if (newDpnInterface != null) {
1059             interfaces = newDpnInterface.getInterfaces();
1060         }
1061         for (String ifName : interfaces) {
1062             // In case if there is a InterfacePort in the cache which is not in
1063             // operational state, skip processing it
1064             InterfaceInfo ifInfo = interfaceManager
1065                     .getInterfaceInfoFromOperationalDataStore(ifName, interfaceInfo.getInterfaceType());
1066             if (!isOperational(ifInfo)) {
1067                 continue;
1068             }
1069
1070             if (!elanUtils.isExternal(ifName)) {
1071                 listBucket.add(MDSALUtil.buildBucket(getInterfacePortActions(ifInfo), MDSALUtil.GROUP_WEIGHT, bucketId,
1072                         MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
1073                 bucketId++;
1074             }
1075         }
1076
1077         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1078                 MDSALUtil.buildBucketLists(listBucket));
1079         LOG.trace("installing the localBroadCast Group:{}", group);
1080         mdsalManager.syncInstallGroup(interfaceInfo.getDpId(), group,
1081                 ElanConstants.DELAY_TIME_IN_MILLISECOND);
1082     }
1083
1084     private void setupLeavesLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface,
1085             InterfaceInfo interfaceInfo) {
1086         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1087         if (etreeInstance != null) {
1088             List<Bucket> listBucket = new ArrayList<>();
1089             int bucketId = 0;
1090
1091             List<String> interfaces = new ArrayList<>();
1092             if (newDpnInterface != null) {
1093                 interfaces = newDpnInterface.getInterfaces();
1094             }
1095             for (String ifName : interfaces) {
1096                 // In case if there is a InterfacePort in the cache which is not
1097                 // in
1098                 // operational state, skip processing it
1099                 InterfaceInfo ifInfo = interfaceManager
1100                         .getInterfaceInfoFromOperationalDataStore(ifName, interfaceInfo.getInterfaceType());
1101                 if (!isOperational(ifInfo)) {
1102                     continue;
1103                 }
1104
1105                 if (!elanUtils.isExternal(ifName)) {
1106                     // only add root interfaces
1107                     bucketId = addInterfaceIfRootInterface(bucketId, ifName, listBucket, ifInfo);
1108                 }
1109             }
1110
1111             if (listBucket.size() == 0) { // No Buckets
1112                 createDropBucket(listBucket);
1113             }
1114
1115             long etreeLeafTag = etreeInstance.getEtreeLeafTagVal().getValue();
1116             long groupId = ElanUtils.getEtreeLeafLocalBCGId(etreeLeafTag);
1117             Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1118                     MDSALUtil.buildBucketLists(listBucket));
1119             LOG.trace("installing the localBroadCast Group:{}", group);
1120             mdsalManager.syncInstallGroup(interfaceInfo.getDpId(), group,
1121                     ElanConstants.DELAY_TIME_IN_MILLISECOND);
1122         }
1123     }
1124
1125     private int addInterfaceIfRootInterface(int bucketId, String ifName, List<Bucket> listBucket,
1126             InterfaceInfo ifInfo) {
1127         EtreeInterface etreeInterface = ElanUtils.getEtreeInterfaceByElanInterfaceName(broker, ifName);
1128         if (etreeInterface != null && etreeInterface.getEtreeInterfaceType() == EtreeInterfaceType.Root) {
1129             listBucket.add(MDSALUtil.buildBucket(getInterfacePortActions(ifInfo), MDSALUtil.GROUP_WEIGHT, bucketId,
1130                     MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
1131             bucketId++;
1132         }
1133         return bucketId;
1134     }
1135
1136     public void removeLocalBroadcastGroup(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
1137             WriteTransaction deleteFlowGroupTx) {
1138         BigInteger dpnId = interfaceInfo.getDpId();
1139         long groupId = ElanUtils.getElanLocalBCGId(elanInfo.getElanTag());
1140         List<Bucket> listBuckets = new ArrayList<>();
1141         int bucketId = 0;
1142         listBuckets.add(getLocalBCGroupBucketInfo(interfaceInfo, bucketId));
1143         // listBuckets.addAll(getRemoteBCGroupBucketInfos(elanInfo, 1,
1144         // interfaceInfo));
1145         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1146                 MDSALUtil.buildBucketLists(listBuckets));
1147         LOG.trace("deleted the localBroadCast Group:{}", group);
1148         mdsalManager.removeGroupToTx(dpnId, group, deleteFlowGroupTx);
1149     }
1150
1151     public void removeElanBroadcastGroup(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
1152             WriteTransaction deleteFlowGroupTx) {
1153         int bucketId = 0;
1154         int actionKey = 0;
1155         Long elanTag = elanInfo.getElanTag();
1156         List<Bucket> listBuckets = new ArrayList<>();
1157         List<Action> listAction = new ArrayList<>();
1158         listAction.add(new ActionInfo(ActionType.group,
1159                 new String[] { String.valueOf(ElanUtils.getElanLocalBCGId(elanTag)) }, ++actionKey).buildAction());
1160         listBuckets.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
1161                 MDSALUtil.WATCH_GROUP));
1162         bucketId++;
1163         listBuckets.addAll(getRemoteBCGroupBucketInfos(elanInfo, bucketId, interfaceInfo, elanInfo.getElanTag()));
1164         BigInteger dpnId = interfaceInfo.getDpId();
1165         long groupId = ElanUtils.getElanRemoteBCGId(elanInfo.getElanTag());
1166         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1167                 MDSALUtil.buildBucketLists(listBuckets));
1168         LOG.trace("deleting the remoteBroadCast group:{}", group);
1169         mdsalManager.removeGroupToTx(dpnId, group, deleteFlowGroupTx);
1170     }
1171
1172     /**
1173      * Installs a flow in the External Tunnel table consisting in translating
1174      * the VNI retrieved from the packet that came over a tunnel with a TOR into
1175      * elanTag that will be used later in the ELANs pipeline.
1176      *
1177      * @param dpnId
1178      *            the dpn id
1179      * @param elanInfo
1180      *            the elan info
1181      */
1182     public void setExternalTunnelTable(BigInteger dpnId, ElanInstance elanInfo) {
1183         long elanTag = elanInfo.getElanTag();
1184         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId, NwConstants.EXTERNAL_TUNNEL_TABLE,
1185                 getFlowRef(NwConstants.EXTERNAL_TUNNEL_TABLE, elanTag), 5, // prio
1186                 elanInfo.getElanInstanceName(), // flowName
1187                 0, // idleTimeout
1188                 0, // hardTimeout
1189                 ITMConstants.COOKIE_ITM_EXTERNAL.add(BigInteger.valueOf(elanTag)),
1190                 buildMatchesForVni(elanInfo.getSegmentationId()), getInstructionsExtTunnelTable(elanTag));
1191
1192         mdsalManager.installFlow(flowEntity);
1193     }
1194
1195     /**
1196      * Removes, from External Tunnel table, the flow that translates from VNI to
1197      * elanTag. Important: ensure this method is only called whenever there is
1198      * no other ElanInterface in the specified DPN
1199      *
1200      * @param dpnId
1201      *            DPN whose Ext Tunnel table is going to be modified
1202      * @param elanInfo
1203      *            holds the elanTag needed for selecting the flow to be removed
1204      */
1205     public void unsetExternalTunnelTable(BigInteger dpnId, ElanInstance elanInfo) {
1206         // TODO: Use DataStoreJobCoordinator in order to avoid that removing the
1207         // last ElanInstance plus
1208         // adding a new one does (almost at the same time) are executed in that
1209         // exact order
1210
1211         String flowId = getFlowRef(NwConstants.EXTERNAL_TUNNEL_TABLE, elanInfo.getElanTag());
1212         FlowEntity flowEntity = new FlowEntity(dpnId);
1213         flowEntity.setTableId(NwConstants.EXTERNAL_TUNNEL_TABLE);
1214         flowEntity.setFlowId(flowId);
1215         mdsalManager.removeFlow(flowEntity);
1216     }
1217
1218     public void setupTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId, WriteTransaction writeFlowGroupTx) {
1219         setupTerminateServiceTable(elanInfo, dpId, elanInfo.getElanTag(), writeFlowGroupTx);
1220         setupEtreeTerminateServiceTable(elanInfo, dpId, writeFlowGroupTx);
1221     }
1222
1223     public void setupTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1224             WriteTransaction writeFlowGroupTx) {
1225         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.INTERNAL_TUNNEL_TABLE,
1226                 getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE, elanTag), 5,
1227                 String.format("%s:%d", "ITM Flow Entry ", elanTag), 0, 0,
1228                 ITMConstants.COOKIE_ITM.add(BigInteger.valueOf(elanTag)),
1229                 ElanUtils.getTunnelMatchesForServiceId((int) elanTag),
1230                 getInstructionsForOutGroup(ElanUtils.getElanLocalBCGId(elanTag)));
1231
1232         mdsalManager.addFlowToTx(dpId, flowEntity, writeFlowGroupTx);
1233     }
1234
1235     private void setupEtreeTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId,
1236             WriteTransaction writeFlowGroupTx) {
1237         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1238         if (etreeInstance != null) {
1239             setupTerminateServiceTable(elanInfo, dpId, etreeInstance.getEtreeLeafTagVal().getValue(), writeFlowGroupTx);
1240         }
1241     }
1242
1243     public void setupUnknownDMacTable(ElanInstance elanInfo, BigInteger dpId, WriteTransaction writeFlowGroupTx) {
1244         long elanTag = elanInfo.getElanTag();
1245         installLocalUnknownFlow(elanInfo, dpId, elanTag, writeFlowGroupTx);
1246         installRemoteUnknownFlow(elanInfo, dpId, elanTag, writeFlowGroupTx);
1247         setupEtreeUnknownDMacTable(elanInfo, dpId, elanTag, writeFlowGroupTx);
1248     }
1249
1250     private void setupEtreeUnknownDMacTable(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1251             WriteTransaction writeFlowGroupTx) {
1252         EtreeLeafTagName etreeLeafTag = elanUtils.getEtreeLeafTagByElanTag(elanTag);
1253         if (etreeLeafTag != null) {
1254             long leafTag = etreeLeafTag.getEtreeLeafTag().getValue();
1255             installRemoteUnknownFlow(elanInfo, dpId, leafTag, writeFlowGroupTx);
1256             installLocalUnknownFlow(elanInfo, dpId, leafTag, writeFlowGroupTx);
1257         }
1258     }
1259
1260     private void installLocalUnknownFlow(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1261             WriteTransaction writeFlowGroupTx) {
1262         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1263                 getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE, elanTag,
1264                         /* SH flag */false),
1265                 5, elanInfo.getElanInstanceName(), 0, 0,
1266                 ElanConstants.COOKIE_ELAN_UNKNOWN_DMAC.add(BigInteger.valueOf(elanTag)),
1267                 getMatchesForElanTag(elanTag, /* SH flag */false),
1268                 getInstructionsForOutGroup(ElanUtils.getElanRemoteBCGId(elanTag)));
1269
1270         mdsalManager.addFlowToTx(dpId, flowEntity, writeFlowGroupTx);
1271     }
1272
1273     private void installRemoteUnknownFlow(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1274             WriteTransaction writeFlowGroupTx) {
1275         // only if ELAN can connect to external network, perform the following
1276         if (ElanUtils.isVxlan(elanInfo) || ElanUtils.isVlan(elanInfo) || ElanUtils.isFlat(elanInfo)) {
1277             Flow flowEntity2 = MDSALUtil.buildFlowNew(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1278                     getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE, elanTag,
1279                             /* SH flag */true),
1280                     5, elanInfo.getElanInstanceName(), 0, 0,
1281                     ElanConstants.COOKIE_ELAN_UNKNOWN_DMAC.add(BigInteger.valueOf(elanTag)),
1282                     getMatchesForElanTag(elanTag, /* SH flag */true),
1283                     getInstructionsForOutGroup(ElanUtils.getElanLocalBCGId(elanTag)));
1284             mdsalManager.addFlowToTx(dpId, flowEntity2, writeFlowGroupTx);
1285         }
1286     }
1287
1288
1289     private void removeUnknownDmacFlow(BigInteger dpId, ElanInstance elanInfo, WriteTransaction deleteFlowGroupTx,
1290             long elanTag) {
1291         Flow flow = new FlowBuilder().setId(new FlowId(getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1292                 elanTag, /* SH flag */ false))).setTableId(NwConstants.ELAN_UNKNOWN_DMAC_TABLE).build();
1293         mdsalManager.removeFlowToTx(dpId, flow, deleteFlowGroupTx);
1294
1295         if (ElanUtils.isVxlan(elanInfo)) {
1296             Flow flow2 = new FlowBuilder().setId(new FlowId(getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1297                     elanTag, /* SH flag */ true))).setTableId(NwConstants.ELAN_UNKNOWN_DMAC_TABLE)
1298                     .build();
1299             mdsalManager.removeFlowToTx(dpId, flow2, deleteFlowGroupTx);
1300         }
1301     }
1302
1303     private void removeDefaultTermFlow(BigInteger dpId, long elanTag) {
1304         elanUtils.removeTerminatingServiceAction(dpId, (int) elanTag);
1305     }
1306
1307     private void bindService(ElanInstance elanInfo, ElanInterface elanInterface, WriteTransaction tx) {
1308         if (isStandardElanService(elanInterface)) {
1309             bindElanService(elanInfo.getElanTag(), elanInfo.getElanInstanceName(), elanInterface.getName(), tx);
1310         } else { // Etree service
1311             bindEtreeService(elanInfo, elanInterface, tx);
1312         }
1313     }
1314
1315     private void bindElanService(long elanTag, String elanInstanceName, String interfaceName, WriteTransaction tx) {
1316         int priority = ElanConstants.ELAN_SERVICE_PRIORITY;
1317         int instructionKey = 0;
1318         List<Instruction> instructions = new ArrayList<>();
1319         instructions.add(MDSALUtil.buildAndGetWriteMetadaInstruction(ElanUtils.getElanMetadataLabel(elanTag),
1320                 MetaDataUtil.METADATA_MASK_SERVICE, ++instructionKey));
1321         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.ELAN_SMAC_TABLE, ++instructionKey));
1322         short elanServiceIndex = ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME, NwConstants.ELAN_SERVICE_INDEX);
1323         BoundServices serviceInfo = ElanUtils.getBoundServices(
1324                 String.format("%s.%s.%s", "vpn", elanInstanceName, interfaceName), elanServiceIndex,
1325                 priority, NwConstants.COOKIE_ELAN_INGRESS_TABLE, instructions);
1326         tx.put(LogicalDatastoreType.CONFIGURATION,
1327                 ElanUtils.buildServiceId(interfaceName, elanServiceIndex), serviceInfo, true);
1328     }
1329
1330     private void bindEtreeService(ElanInstance elanInfo, ElanInterface elanInterface, WriteTransaction tx) {
1331         if (elanInterface.getAugmentation(EtreeInterface.class).getEtreeInterfaceType() == EtreeInterfaceType.Root) {
1332             bindElanService(elanInfo.getElanTag(), elanInfo.getElanInstanceName(), elanInterface.getName(), tx);
1333         } else {
1334             EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1335             if (etreeInstance == null) {
1336                 LOG.error("EtreeInterface " + elanInterface.getName() + " is associated with a non EtreeInstance: "
1337                         + elanInfo.getElanInstanceName());
1338             } else {
1339                 bindElanService(etreeInstance.getEtreeLeafTagVal().getValue(), elanInfo.getElanInstanceName(),
1340                         elanInterface.getName(), tx);
1341             }
1342         }
1343     }
1344
1345     private boolean isStandardElanService(ElanInterface elanInterface) {
1346         return elanInterface.getAugmentation(EtreeInterface.class) == null;
1347     }
1348
1349     private boolean isStandardElanService(ElanInstance elanInstance) {
1350         return elanInstance.getAugmentation(EtreeInstance.class) == null;
1351     }
1352
1353     private void unbindService(ElanInstance elanInfo, String interfaceName, WriteTransaction tx) {
1354         tx.delete(LogicalDatastoreType.CONFIGURATION, ElanUtils.buildServiceId(interfaceName,
1355                 ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME, NwConstants.ELAN_SERVICE_INDEX)));
1356     }
1357
1358     private String getFlowRef(long tableId, long elanTag) {
1359         return new StringBuffer().append(tableId).append(elanTag).toString();
1360     }
1361
1362     private String getUnknownDmacFlowRef(long tableId, long elanTag, boolean shFlag) {
1363         return new StringBuffer().append(tableId).append(elanTag).append(shFlag).toString();
1364     }
1365
1366     private List<Action> getInterfacePortActions(InterfaceInfo interfaceInfo) {
1367         List<Action> listAction = new ArrayList<>();
1368         int actionKey = 0;
1369         listAction.add(new ActionInfo(ActionType.set_field_tunnel_id,
1370                 new BigInteger[] { BigInteger.valueOf(interfaceInfo.getInterfaceTag()) }, actionKey).buildAction());
1371         actionKey++;
1372         listAction.add(new ActionInfo(ActionType.nx_resubmit,
1373                 new String[] { String.valueOf(NwConstants.ELAN_FILTER_EQUALS_TABLE) }, actionKey).buildAction());
1374         return listAction;
1375     }
1376
1377     private DpnInterfaces updateElanDpnInterfacesList(String elanInstanceName, BigInteger dpId,
1378             List<String> interfaceNames, WriteTransaction tx) {
1379         DpnInterfaces dpnInterface = new DpnInterfacesBuilder().setDpId(dpId).setInterfaces(interfaceNames)
1380                 .setKey(new DpnInterfacesKey(dpId)).build();
1381         tx.put(LogicalDatastoreType.OPERATIONAL,
1382                 ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId), dpnInterface, true);
1383         return dpnInterface;
1384     }
1385
1386     /**
1387      * Delete elan dpn interface from operational DS.
1388      *
1389      * @param elanInstanceName
1390      *            the elan instance name
1391      * @param dpId
1392      *            the dp id
1393      */
1394     private void deleteElanDpnInterface(String elanInstanceName, BigInteger dpId, WriteTransaction tx) {
1395         tx.delete(LogicalDatastoreType.OPERATIONAL,
1396                 ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId));
1397     }
1398
1399     private DpnInterfaces createElanInterfacesList(String elanInstanceName, String interfaceName, BigInteger dpId,
1400             WriteTransaction tx) {
1401         List<String> interfaceNames = new ArrayList<>();
1402         interfaceNames.add(interfaceName);
1403         DpnInterfaces dpnInterface = new DpnInterfacesBuilder().setDpId(dpId).setInterfaces(interfaceNames)
1404                 .setKey(new DpnInterfacesKey(dpId)).build();
1405         tx.put(LogicalDatastoreType.OPERATIONAL,
1406                 ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId), dpnInterface, true);
1407         return dpnInterface;
1408     }
1409
1410     private void createElanInterfaceTablesList(String interfaceName, WriteTransaction tx) {
1411         InstanceIdentifier<ElanInterfaceMac> elanInterfaceMacTables = ElanUtils
1412                 .getElanInterfaceMacEntriesOperationalDataPath(interfaceName);
1413         Optional<ElanInterfaceMac> interfaceMacTables = elanUtils.read(broker,
1414                 LogicalDatastoreType.OPERATIONAL, elanInterfaceMacTables);
1415         // Adding new Elan Interface Port to the operational DataStore without
1416         // Static-Mac Entries..
1417         if (!interfaceMacTables.isPresent()) {
1418             ElanInterfaceMac elanInterfaceMacTable = new ElanInterfaceMacBuilder().setElanInterface(interfaceName)
1419                     .setKey(new ElanInterfaceMacKey(interfaceName)).build();
1420             tx.put(LogicalDatastoreType.OPERATIONAL,
1421                     ElanUtils.getElanInterfaceMacEntriesOperationalDataPath(interfaceName), elanInterfaceMacTable,
1422                     true);
1423         }
1424     }
1425
1426     private void createElanStateList(String elanInstanceName, String interfaceName, WriteTransaction tx) {
1427         InstanceIdentifier<Elan> elanInstance = ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName);
1428         Optional<Elan> elanInterfaceLists = elanUtils.read(broker,
1429                 LogicalDatastoreType.OPERATIONAL, elanInstance);
1430         // Adding new Elan Interface Port to the operational DataStore without
1431         // Static-Mac Entries..
1432         if (elanInterfaceLists.isPresent()) {
1433             List<String> interfaceLists = elanInterfaceLists.get().getElanInterfaces();
1434             if (interfaceLists == null) {
1435                 interfaceLists = new ArrayList<>();
1436             }
1437             interfaceLists.add(interfaceName);
1438             Elan elanState = new ElanBuilder().setName(elanInstanceName).setElanInterfaces(interfaceLists)
1439                     .setKey(new ElanKey(elanInstanceName)).build();
1440             tx.put(LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName),
1441                     elanState, true);
1442         }
1443     }
1444
1445     private boolean isOperational(InterfaceInfo interfaceInfo) {
1446         if (interfaceInfo == null) {
1447             return false;
1448         }
1449         return interfaceInfo.getAdminState() == InterfaceInfo.InterfaceAdminState.ENABLED;
1450     }
1451
1452     public void handleInternalTunnelStateEvent(BigInteger srcDpId, BigInteger dstDpId) throws ElanException {
1453         ElanDpnInterfaces dpnInterfaceLists = elanUtils.getElanDpnInterfacesList();
1454         if (dpnInterfaceLists == null) {
1455             return;
1456         }
1457         List<ElanDpnInterfacesList> elanDpnIf = dpnInterfaceLists.getElanDpnInterfacesList();
1458         for (ElanDpnInterfacesList elanDpns : elanDpnIf) {
1459             int cnt = 0;
1460             String elanName = elanDpns.getElanInstanceName();
1461             List<DpnInterfaces> dpnInterfaces = elanDpns.getDpnInterfaces();
1462             if (dpnInterfaces == null) {
1463                 continue;
1464             }
1465             for (DpnInterfaces dpnIf : dpnInterfaces) {
1466                 if (dpnIf.getDpId().equals(srcDpId) || dpnIf.getDpId().equals(dstDpId)) {
1467                     cnt++;
1468                 }
1469             }
1470             if (cnt == 2) {
1471                 LOG.debug("Elan instance:{} is present b/w srcDpn:{} and dstDpn:{}", elanName, srcDpId, dstDpId);
1472                 ElanInstance elanInfo = ElanUtils.getElanInstanceByName(broker, elanName);
1473                 // update Remote BC Group
1474                 setupElanBroadcastGroups(elanInfo, srcDpId);
1475
1476                 DpnInterfaces dpnInterface = elanUtils.getElanInterfaceInfoByElanDpn(elanName, dstDpId);
1477                 Set<String> interfaceLists = new HashSet<>();
1478                 interfaceLists.addAll(dpnInterface.getInterfaces());
1479                 for (String ifName : interfaceLists) {
1480                     InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(ifName);
1481                     if (isOperational(interfaceInfo)) {
1482                         installDMacAddressTables(elanInfo, interfaceInfo, srcDpId);
1483                     }
1484                 }
1485             }
1486
1487         }
1488     }
1489
1490     /**
1491      * Handle external tunnel state event.
1492      *
1493      * @param externalTunnel
1494      *            the external tunnel
1495      * @param intrf
1496      *            the interface
1497      * @throws ElanException in case of issues creating the flow objects
1498      */
1499     public void handleExternalTunnelStateEvent(ExternalTunnel externalTunnel, Interface intrf) throws ElanException {
1500         if (!validateExternalTunnelStateEvent(externalTunnel, intrf)) {
1501             return;
1502         }
1503         // dpId/externalNodeId will be available either in source or destination
1504         // based on the tunnel end point
1505         BigInteger dpId = null;
1506         NodeId externalNodeId = null;
1507         if (StringUtils.isNumeric(externalTunnel.getSourceDevice())) {
1508             dpId = new BigInteger(externalTunnel.getSourceDevice());
1509             externalNodeId = new NodeId(externalTunnel.getDestinationDevice());
1510         } else if (StringUtils.isNumeric(externalTunnel.getDestinationDevice())) {
1511             dpId = new BigInteger(externalTunnel.getDestinationDevice());
1512             externalNodeId = new NodeId(externalTunnel.getSourceDevice());
1513         }
1514         if (dpId == null || externalNodeId == null) {
1515             LOG.error("Dp ID / externalNodeId not found in external tunnel {}", externalTunnel);
1516             return;
1517         }
1518
1519         ElanDpnInterfaces dpnInterfaceLists = elanUtils.getElanDpnInterfacesList();
1520         if (dpnInterfaceLists == null) {
1521             return;
1522         }
1523         List<ElanDpnInterfacesList> elanDpnIf = dpnInterfaceLists.getElanDpnInterfacesList();
1524         for (ElanDpnInterfacesList elanDpns : elanDpnIf) {
1525             String elanName = elanDpns.getElanInstanceName();
1526             ElanInstance elanInfo = ElanUtils.getElanInstanceByName(broker, elanName);
1527
1528             DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanName, dpId);
1529             if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null
1530                     || dpnInterfaces.getInterfaces().isEmpty()) {
1531                 continue;
1532             }
1533             LOG.debug("Elan instance:{} is present in Dpn:{} ", elanName, dpId);
1534
1535             setupElanBroadcastGroups(elanInfo, dpId);
1536             // install L2gwDevices local macs in dpn.
1537             elanL2GatewayUtils.installL2gwDeviceMacsInDpn(dpId, externalNodeId, elanInfo, intrf.getName());
1538             // Install dpn macs on external device
1539             elanL2GatewayUtils.installDpnMacsInL2gwDevice(elanName, new HashSet<>(dpnInterfaces.getInterfaces()), dpId,
1540                     externalNodeId);
1541         }
1542         LOG.info("Handled ExternalTunnelStateEvent for {}", externalTunnel);
1543     }
1544
1545     /**
1546      * Validate external tunnel state event.
1547      *
1548      * @param externalTunnel
1549      *            the external tunnel
1550      * @param intrf
1551      *            the intrf
1552      * @return true, if successful
1553      */
1554     private boolean validateExternalTunnelStateEvent(ExternalTunnel externalTunnel, Interface intrf) {
1555         if (intrf.getOperStatus() == Interface.OperStatus.Up) {
1556             String srcDevice = externalTunnel.getDestinationDevice();
1557             String destDevice = externalTunnel.getSourceDevice();
1558             ExternalTunnel otherEndPointExtTunnel = elanUtils.getExternalTunnel(srcDevice, destDevice,
1559                     LogicalDatastoreType.CONFIGURATION);
1560             if (LOG.isTraceEnabled()) {
1561                 LOG.trace("Validating external tunnel state: src tunnel {}, dest tunnel {}", externalTunnel,
1562                         otherEndPointExtTunnel);
1563             }
1564             if (otherEndPointExtTunnel != null) {
1565                 boolean otherEndPointInterfaceOperational = ElanUtils.isInterfaceOperational(
1566                         otherEndPointExtTunnel.getTunnelInterfaceName(), broker);
1567                 if (otherEndPointInterfaceOperational) {
1568                     return true;
1569                 } else {
1570                     LOG.debug("Other end [{}] of the external tunnel is not yet UP for {}",
1571                             otherEndPointExtTunnel.getTunnelInterfaceName(), externalTunnel);
1572                 }
1573             }
1574         }
1575         return false;
1576     }
1577
1578     private List<MatchInfo> getMatchesForFilterEqualsLPortTag(int lportTag) {
1579         List<MatchInfo> mkMatches = new ArrayList<>();
1580         // Matching metadata
1581         mkMatches.add(new MatchInfo(MatchFieldType.metadata,
1582                 new BigInteger[] { MetaDataUtil.getLportTagMetaData(lportTag), MetaDataUtil.METADATA_MASK_LPORT_TAG }));
1583         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(lportTag) }));
1584         return mkMatches;
1585     }
1586
1587     private List<MatchInfo> getTunnelIdMatchForFilterEqualsLPortTag(int lportTag) {
1588         List<MatchInfo> mkMatches = new ArrayList<>();
1589         // Matching metadata
1590         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(lportTag) }));
1591         return mkMatches;
1592     }
1593
1594     public void updateRemoteBroadcastGroupForAllElanDpns(ElanInstance elanInfo) {
1595         List<DpnInterfaces> dpns = elanUtils.getInvolvedDpnsInElan(elanInfo.getElanInstanceName());
1596         if (dpns == null) {
1597             return;
1598         }
1599         for (DpnInterfaces dpn : dpns) {
1600             setupElanBroadcastGroups(elanInfo, dpn.getDpId());
1601         }
1602     }
1603
1604     public List<Bucket> getRemoteBCGroupBucketsOfElanL2GwDevices(ElanInstance elanInfo, BigInteger dpnId,
1605             int bucketId) {
1606         List<Bucket> listBucketInfo = new ArrayList<>();
1607         ConcurrentMap<String, L2GatewayDevice> map = ElanL2GwCacheUtils
1608                 .getInvolvedL2GwDevices(elanInfo.getElanInstanceName());
1609         for (L2GatewayDevice device : map.values()) {
1610             String interfaceName = elanL2GatewayUtils.getExternalTunnelInterfaceName(String.valueOf(dpnId),
1611                     device.getHwvtepNodeId());
1612             if (interfaceName == null) {
1613                 continue;
1614             }
1615             List<Action> listActionInfo = elanUtils.buildTunnelItmEgressActions(interfaceName,
1616                     elanInfo.getSegmentationId());
1617             listBucketInfo.add(MDSALUtil.buildBucket(listActionInfo, MDSALUtil.GROUP_WEIGHT, bucketId,
1618                     MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
1619             bucketId++;
1620         }
1621         return listBucketInfo;
1622     }
1623
1624     @Override
1625     protected ElanInterfaceManager getDataTreeChangeListener() {
1626         return this;
1627     }
1628 }