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.l2gw.utils.ElanL2GatewayUtils;
  46 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  47 import org.opendaylight.netvirt.elan.utils.ElanForwardingEntriesHandler;
  48 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  49 import org.opendaylight.netvirt.elanmanager.utils.ElanL2GwCacheUtils;
  50 import org.opendaylight.netvirt.neutronvpn.api.l2gw.L2GatewayDevice;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeLeafTagName;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanForwardingTables;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacKey;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.forwarding.tables.MacTable;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.forwarding.tables.MacTableKey;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.ElanBuilder;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.ElanKey;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryBuilder;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntryKey;
  89 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  90 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  91 import org.slf4j.Logger;
  92 import org.slf4j.LoggerFactory;
  93
  94 /**
  95  * Class in charge of handling creations, modifications and removals of
  96  * ElanInterfaces.
  97  *
  98  * @see org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface
  99  *
 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) {
 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) {
 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) {
 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         String elanInstanceName = elanInstance.getElanInstanceName();
 620         String interfaceName = elanInterface.getName();
 621         WriteTransaction tx = broker.newWriteOnlyTransaction();
 622         BigInteger dpId = interfaceInfo.getDpId();
 623         WriteTransaction writeFlowGroupTx = broker.newWriteOnlyTransaction();
 624         installEntriesForElanInterface(elanInstance, interfaceInfo, isFirstInterfaceInDpn, tx, writeFlowGroupTx);
 625         List<PhysAddress> staticMacAddresses = elanInterface.getStaticMacEntries();
 626         if (staticMacAddresses != null) {
 627             boolean isInterfaceOperational = isOperational(interfaceInfo);
 628             for (PhysAddress physAddress : staticMacAddresses) {
 629                 InstanceIdentifier<MacEntry> macId = getMacEntryOperationalDataPath(elanInstanceName, physAddress);
 630                 Optional<MacEntry> existingMacEntry = elanUtils.read(broker,
 631                         LogicalDatastoreType.OPERATIONAL, macId);
 632                 if (existingMacEntry.isPresent()) {
 633                     elanForwardingEntriesHandler.updateElanInterfaceForwardingTablesList(
 634                             elanInstanceName, interfaceName, existingMacEntry.get().getInterface(),
 635                             existingMacEntry.get(), tx);
 636                 } else {
 637                     elanForwardingEntriesHandler
 638                             .addElanInterfaceForwardingTableList(elanInstance, interfaceName, physAddress, tx);
 639                 }
 640
 641                 if (isInterfaceOperational) {
 642                     // Setting SMAC, DMAC, UDMAC in this DPN and also in other
 643                     // DPNs
 644                     elanUtils.setupMacFlows(elanInstance, interfaceInfo, ElanConstants.STATIC_MAC_TIMEOUT,
 645                             physAddress.getValue(), writeFlowGroupTx);
 646                 }
 647             }
 648
 649             if (isInterfaceOperational) {
 650                 // Add MAC in TOR's remote MACs via OVSDB. Outside of the loop
 651                 // on purpose.
 652                 elanL2GatewayUtils.scheduleAddDpnMacInExtDevices(elanInstance.getElanInstanceName(), dpId,
 653                         staticMacAddresses);
 654             }
 655         }
 656         futures.add(ElanUtils.waitForTransactionToComplete(tx));
 657         futures.add(ElanUtils.waitForTransactionToComplete(writeFlowGroupTx));
 658     }
 659
 660     protected void removeInterfaceStaticMacEntires(String elanInstanceName, String interfaceName,
 661             PhysAddress physAddress) {
 662         InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(interfaceName);
 663         InstanceIdentifier<MacEntry> macId = getMacEntryOperationalDataPath(elanInstanceName, physAddress);
 664         Optional<MacEntry> existingMacEntry = elanUtils.read(broker,
 665                 LogicalDatastoreType.OPERATIONAL, macId);
 666
 667         if (!existingMacEntry.isPresent()) {
 668             return;
 669         }
 670
 671         MacEntry macEntry = new MacEntryBuilder().setMacAddress(physAddress).setInterface(interfaceName)
 672                 .setKey(new MacEntryKey(physAddress)).build();
 673         WriteTransaction tx = broker.newWriteOnlyTransaction();
 674         elanForwardingEntriesHandler.deleteElanInterfaceForwardingEntries(
 675                 ElanUtils.getElanInstanceByName(broker, elanInstanceName), interfaceInfo, macEntry, tx);
 676         elanForwardingEntriesHandler.deleteElanInterfaceMacForwardingEntries(interfaceName,
 677                 physAddress, tx);
 678         ElanUtils.waitForTransactionToComplete(tx);
 679     }
 680
 681     private InstanceIdentifier<MacEntry> getMacEntryOperationalDataPath(String elanName, PhysAddress physAddress) {
 682         return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class, new MacTableKey(elanName))
 683                 .child(MacEntry.class, new MacEntryKey(physAddress)).build();
 684     }
 685
 686     private void installEntriesForElanInterface(ElanInstance elanInstance, InterfaceInfo interfaceInfo,
 687             boolean isFirstInterfaceInDpn, WriteTransaction tx, WriteTransaction writeFlowGroupTx) {
 688         if (!isOperational(interfaceInfo)) {
 689             return;
 690         }
 691         BigInteger dpId = interfaceInfo.getDpId();
 692         elanUtils.setupTermDmacFlows(interfaceInfo, mdsalManager, writeFlowGroupTx);
 693         setupFilterEqualsTable(elanInstance, interfaceInfo, writeFlowGroupTx);
 694         if (isFirstInterfaceInDpn) {
 695             // Terminating Service , UnknownDMAC Table.
 696             setupTerminateServiceTable(elanInstance, dpId, writeFlowGroupTx);
 697             setupUnknownDMacTable(elanInstance, dpId, writeFlowGroupTx);
 698             // update the remote-DPNs remoteBC group entry with Tunnels
 699             setElanBCGrouponOtherDpns(elanInstance, elanInstance.getElanTag().longValue(), dpId, writeFlowGroupTx);
 700             /*
 701              * Install remote DMAC flow. This is required since this DPN is
 702              * added later to the elan instance and remote DMACs of other
 703              * interfaces in this elan instance are not present in the current
 704              * dpn.
 705              */
 706             programRemoteDmacFlow(elanInstance, interfaceInfo, writeFlowGroupTx);
 707         }
 708         // bind the Elan service to the Interface
 709         bindService(elanInstance, ElanUtils.getElanInterfaceByElanInterfaceName(broker, interfaceInfo.getInterfaceName()), tx);
 710     }
 711
 712     public void installEntriesForFirstInterfaceonDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 713             DpnInterfaces dpnInterfaces, boolean isFirstInterfaceInDpn, WriteTransaction tx) {
 714         if (!isOperational(interfaceInfo)) {
 715             return;
 716         }
 717         // LocalBroadcast Group creation with elan-Interfaces
 718         setupLocalBroadcastGroups(elanInfo, dpnInterfaces, interfaceInfo);
 719         if (isFirstInterfaceInDpn) {
 720             LOG.trace("waitTimeForSyncInstall is {}", WAIT_TIME_FOR_SYNC_INSTALL);
 721             BigInteger dpId = interfaceInfo.getDpId();
 722             // RemoteBroadcast Group creation
 723             try {
 724                 Thread.sleep(WAIT_TIME_FOR_SYNC_INSTALL);
 725             } catch (InterruptedException e1) {
 726                 LOG.warn("Error while waiting for local BC group for ELAN {} to install", elanInfo);
 727             }
 728             setupElanBroadcastGroups(elanInfo, dpnInterfaces, dpId);
 729             try {
 730                 Thread.sleep(WAIT_TIME_FOR_SYNC_INSTALL);
 731             } catch (InterruptedException e1) {
 732                 LOG.warn("Error while waiting for local BC group for ELAN {} to install", elanInfo);
 733             }
 734         }
 735     }
 736
 737     public void setupFilterEqualsTable(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 738             WriteTransaction writeFlowGroupTx) {
 739         int ifTag = interfaceInfo.getInterfaceTag();
 740         Flow flow = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 741                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, ifTag), 9, elanInfo.getElanInstanceName(), 0, 0,
 742                 ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 743                 getTunnelIdMatchForFilterEqualsLPortTag(ifTag),
 744                 elanUtils.getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName()));
 745
 746         mdsalManager.addFlowToTx(interfaceInfo.getDpId(), flow, writeFlowGroupTx);
 747
 748         Flow flowEntry = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 749                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, 1000 + ifTag), 10, elanInfo.getElanInstanceName(), 0,
 750                 0, ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 751                 getMatchesForFilterEqualsLPortTag(ifTag), MDSALUtil.buildInstructionsDrop());
 752
 753         mdsalManager.addFlowToTx(interfaceInfo.getDpId(), flowEntry, writeFlowGroupTx);
 754     }
 755
 756     public void removeFilterEqualsTable(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
 757             WriteTransaction deleteFlowGroupTx) {
 758         int ifTag = interfaceInfo.getInterfaceTag();
 759         Flow flow = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 760                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, ifTag), 9, elanInfo.getElanInstanceName(), 0, 0,
 761                 ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 762                 getTunnelIdMatchForFilterEqualsLPortTag(ifTag),
 763                 elanUtils.getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName()));
 764
 765         mdsalManager.removeFlowToTx(interfaceInfo.getDpId(), flow, deleteFlowGroupTx);
 766
 767         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.ELAN_FILTER_EQUALS_TABLE,
 768                 getFlowRef(NwConstants.ELAN_FILTER_EQUALS_TABLE, 1000 + ifTag), 10, elanInfo.getElanInstanceName(), 0,
 769                 0, ElanConstants.COOKIE_ELAN_FILTER_EQUALS.add(BigInteger.valueOf(ifTag)),
 770                 getMatchesForFilterEqualsLPortTag(ifTag), MDSALUtil.buildInstructionsDrop());
 771
 772         mdsalManager.removeFlowToTx(interfaceInfo.getDpId(), flowEntity, deleteFlowGroupTx);
 773     }
 774
 775     private List<Bucket> getRemoteBCGroupBucketInfos(ElanInstance elanInfo, int bucketKeyStart,
 776             InterfaceInfo interfaceInfo, long elanTag) {
 777         return getRemoteBCGroupBuckets(elanInfo, null, interfaceInfo.getDpId(), bucketKeyStart, elanTag);
 778     }
 779
 780     private List<Bucket> getRemoteBCGroupBuckets(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId,
 781             int bucketId, long elanTag) {
 782         List<Bucket> listBucketInfo = new ArrayList<>();
 783         ElanDpnInterfacesList elanDpns = elanUtils.getElanDpnInterfacesList(elanInfo.getElanInstanceName());
 784         listBucketInfo.addAll(getRemoteBCGroupTunnelBuckets(elanDpns, dpnId, bucketId, elanTag));
 785         listBucketInfo.addAll(getRemoteBCGroupExternalPortBuckets(elanDpns, dpnInterfaces, dpnId, bucketId));
 786         listBucketInfo.addAll(getRemoteBCGroupBucketsOfElanL2GwDevices(elanInfo, dpnId, bucketId));
 787         return listBucketInfo;
 788     }
 789
 790     private List<Bucket> getRemoteBCGroupTunnelBuckets(ElanDpnInterfacesList elanDpns, BigInteger dpnId, int bucketId,
 791             long elanTag) {
 792         List<Bucket> listBucketInfo = new ArrayList<>();
 793         if (elanDpns != null) {
 794             for (DpnInterfaces dpnInterface : elanDpns.getDpnInterfaces()) {
 795                 if (elanUtils.isDpnPresent(dpnInterface.getDpId()) && dpnInterface.getDpId() != dpnId
 796                         && dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty()) {
 797                     try {
 798                         List<Action> listActionInfo = elanUtils.getInternalTunnelItmEgressAction(dpnId,
 799                                 dpnInterface.getDpId(), elanTag);
 800                         if (listActionInfo.isEmpty()) {
 801                             continue;
 802                         }
 803                         listBucketInfo.add(MDSALUtil.buildBucket(listActionInfo, MDSALUtil.GROUP_WEIGHT, bucketId,
 804                                 MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 805                         bucketId++;
 806                     } catch (Exception ex) {
 807                         LOG.error("Logical Group Interface not found between source Dpn - {}, destination Dpn - {} ",
 808                                 dpnId, dpnInterface.getDpId());
 809                     }
 810                 }
 811             }
 812         }
 813         return listBucketInfo;
 814     }
 815
 816     private List<Bucket> getRemoteBCGroupExternalPortBuckets(ElanDpnInterfacesList elanDpns,
 817             DpnInterfaces dpnInterfaces, BigInteger dpnId, int bucketId) {
 818         DpnInterfaces currDpnInterfaces = dpnInterfaces != null ? dpnInterfaces : getDpnInterfaces(elanDpns, dpnId);
 819         if (currDpnInterfaces == null || !elanUtils.isDpnPresent(currDpnInterfaces.getDpId())
 820                 || currDpnInterfaces.getInterfaces() == null || currDpnInterfaces.getInterfaces().isEmpty()) {
 821             return Collections.emptyList();
 822         }
 823
 824         List<Bucket> listBucketInfo = new ArrayList<>();
 825         for (String interfaceName : currDpnInterfaces.getInterfaces()) {
 826             if (elanUtils.isExternal(interfaceName)) {
 827                 List<Action> listActionInfo = elanUtils.getExternalPortItmEgressAction(interfaceName);
 828                 if (!listActionInfo.isEmpty()) {
 829                     listBucketInfo.add(MDSALUtil.buildBucket(listActionInfo, MDSALUtil.GROUP_WEIGHT, bucketId,
 830                             MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 831                     bucketId++;
 832                 }
 833             }
 834         }
 835         return listBucketInfo;
 836     }
 837
 838     private DpnInterfaces getDpnInterfaces(ElanDpnInterfacesList elanDpns, BigInteger dpnId) {
 839         if (elanDpns != null) {
 840             for (DpnInterfaces dpnInterface : elanDpns.getDpnInterfaces()) {
 841                 if (dpnInterface.getDpId() == dpnId) {
 842                     return dpnInterface;
 843                 }
 844             }
 845         }
 846         return null;
 847     }
 848
 849     private void setElanBCGrouponOtherDpns(ElanInstance elanInfo, long elanTag, BigInteger dpId, WriteTransaction tx) {
 850         long groupId = ElanUtils.getElanRemoteBCGId(elanTag);
 851         List<Bucket> listBucket = new ArrayList<>();
 852         int bucketId = 0;
 853         ElanDpnInterfacesList elanDpns = elanUtils.getElanDpnInterfacesList(elanInfo.getElanInstanceName());
 854         if (elanDpns != null) {
 855             List<DpnInterfaces> dpnInterfaceses = elanDpns.getDpnInterfaces();
 856             for (DpnInterfaces dpnInterface : dpnInterfaceses) {
 857                 List<Bucket> remoteListBucketInfo = new ArrayList<>();
 858                 if (elanUtils.isDpnPresent(dpnInterface.getDpId()) && !dpnInterface.getDpId().equals(dpId)
 859                         && dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty()) {
 860                     List<Action> listAction = new ArrayList<>();
 861                     int actionKey = 0;
 862                     listAction.add(new ActionInfo(ActionType.group,
 863                             new String[] { String.valueOf(ElanUtils.getElanLocalBCGId(elanTag)) }, ++actionKey)
 864                                     .buildAction());
 865                     listBucket.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId,
 866                             MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 867                     bucketId++;
 868                     remoteListBucketInfo.addAll(listBucket);
 869                     for (DpnInterfaces otherFes : dpnInterfaceses) {
 870                         if (elanUtils.isDpnPresent(otherFes.getDpId()) && otherFes.getDpId() != dpnInterface.getDpId()
 871                                 && otherFes.getInterfaces() != null && !otherFes.getInterfaces().isEmpty()) {
 872                             try {
 873                                 List<Action> remoteListActionInfo = elanUtils.getInternalTunnelItmEgressAction(
 874                                         dpnInterface.getDpId(), otherFes.getDpId(), elanTag);
 875                                 if (!remoteListActionInfo.isEmpty()) {
 876                                     remoteListBucketInfo
 877                                             .add(MDSALUtil.buildBucket(remoteListActionInfo, MDSALUtil.GROUP_WEIGHT,
 878                                                     bucketId, MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
 879                                     bucketId++;
 880                                 }
 881                             } catch (Exception ex) {
 882                                 LOG.error(
 883                                         "Logical Group Interface not found between source Dpn - {}, destination Dpn - {} ",
 884                                         dpnInterface.getDpId(), otherFes.getDpId());
 885                                 return;
 886                             }
 887                         }
 888                     }
 889                     List<Bucket> elanL2GwDevicesBuckets = getRemoteBCGroupBucketsOfElanL2GwDevices(elanInfo, dpId,
 890                             bucketId);
 891                     remoteListBucketInfo.addAll(elanL2GwDevicesBuckets);
 892
 893                     if (remoteListBucketInfo.size() == 0) {
 894                         LOG.debug("No ITM is present on Dpn - {} ", dpnInterface.getDpId());
 895                         continue;
 896                     }
 897                     Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
 898                             MDSALUtil.buildBucketLists(remoteListBucketInfo));
 899                     mdsalManager.addGroupToTx(dpnInterface.getDpId(), group, tx);
 900                 }
 901             }
 902         }
 903     }
 904
 905     /**
 906      * Returns the bucket info with the given interface as the only bucket.
 907      */
 908     private Bucket getLocalBCGroupBucketInfo(InterfaceInfo interfaceInfo, int bucketIdStart) {
 909         return MDSALUtil.buildBucket(getInterfacePortActions(interfaceInfo), MDSALUtil.GROUP_WEIGHT, bucketIdStart,
 910                 MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP);
 911     }
 912
 913     private List<MatchInfo> buildMatchesForVni(Long vni) {
 914         List<MatchInfo> mkMatches = new ArrayList<>();
 915         MatchInfo match = new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(vni) });
 916         mkMatches.add(match);
 917         return mkMatches;
 918     }
 919
 920     private List<Instruction> getInstructionsForOutGroup(long groupId) {
 921         List<Instruction> mkInstructions = new ArrayList<>();
 922         List<Action> actions = new ArrayList<>();
 923         actions.add(new ActionInfo(ActionType.group, new String[] { Long.toString(groupId) }).buildAction());
 924         mkInstructions.add(MDSALUtil.getWriteActionsInstruction(actions, 0));
 925         return mkInstructions;
 926     }
 927
 928     private List<MatchInfo> getMatchesForElanTag(long elanTag, boolean isSHFlagSet) {
 929         List<MatchInfo> mkMatches = new ArrayList<>();
 930         // Matching metadata
 931         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 932                 ElanUtils.getElanMetadataLabel(elanTag, isSHFlagSet), MetaDataUtil.METADATA_MASK_SERVICE_SH_FLAG }));
 933         return mkMatches;
 934     }
 935
 936     /**
 937      * Builds the list of instructions to be installed in the External Tunnel
 938      * table (38), which so far consists in writing the elanTag in metadata and
 939      * send packet to the new DHCP table.
 940      *
 941      * @param elanTag
 942      *            elanTag to be written in metadata when flow is selected
 943      * @return the instructions ready to be installed in a flow
 944      */
 945     private List<InstructionInfo> getInstructionsExtTunnelTable(Long elanTag) {
 946         List<InstructionInfo> mkInstructions = new ArrayList<>();
 947         mkInstructions.add(new InstructionInfo(InstructionType.write_metadata,
 948                 new BigInteger[] { ElanUtils.getElanMetadataLabel(elanTag), ElanUtils.getElanMetadataMask() }));
 949         // TODO: We should point to SMAC or DMAC depending on a configuration
 950         // property to enable
 951         // mac learning
 952         mkInstructions.add(new InstructionInfo(InstructionType.goto_table, new long[] { NwConstants.ELAN_DMAC_TABLE }));
 953
 954         return mkInstructions;
 955     }
 956
 957     // Install DMAC entry on dst DPN
 958     public void installDMacAddressTables(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId) {
 959         String interfaceName = interfaceInfo.getInterfaceName();
 960         ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(interfaceName);
 961         if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null) {
 962             WriteTransaction writeFlowTx = broker.newWriteOnlyTransaction();
 963             List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 964             for (MacEntry macEntry : macEntries) {
 965                 PhysAddress physAddress = macEntry.getMacAddress();
 966                 elanUtils.setupDMacFlowonRemoteDpn(elanInfo, interfaceInfo, dstDpId, physAddress.getValue(),
 967                         writeFlowTx);
 968             }
 969             writeFlowTx.submit();
 970         }
 971     }
 972
 973     public void setupElanBroadcastGroups(ElanInstance elanInfo, BigInteger dpnId) {
 974         setupElanBroadcastGroups(elanInfo, null, dpnId);
 975     }
 976
 977     public void setupElanBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId) {
 978         setupStandardElanBroadcastGroups(elanInfo, dpnInterfaces, dpnId);
 979         setupLeavesEtreeBroadcastGroups(elanInfo, dpnInterfaces, dpnId);
 980     }
 981
 982     public void setupStandardElanBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId) {
 983         List<Bucket> listBucket = new ArrayList<>();
 984         int bucketId = 0;
 985         int actionKey = 0;
 986         Long elanTag = elanInfo.getElanTag();
 987         List<Action> listAction = new ArrayList<>();
 988         listAction.add(new ActionInfo(ActionType.group,
 989                 new String[] { String.valueOf(ElanUtils.getElanLocalBCGId(elanTag)) }, ++actionKey).buildAction());
 990         listBucket.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
 991                 MDSALUtil.WATCH_GROUP));
 992         bucketId++;
 993         List<Bucket> listBucketInfoRemote = getRemoteBCGroupBuckets(elanInfo, dpnInterfaces, dpnId, bucketId,
 994                 elanInfo.getElanTag());
 995         listBucket.addAll(listBucketInfoRemote);
 996         long groupId = ElanUtils.getElanRemoteBCGId(elanTag);
 997         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
 998                 MDSALUtil.buildBucketLists(listBucket));
 999         LOG.trace("Installing the remote BroadCast Group:{}", group);
1000         mdsalManager.syncInstallGroup(dpnId, group, ElanConstants.DELAY_TIME_IN_MILLISECOND);
1001     }
1002
1003     public void setupLeavesEtreeBroadcastGroups(ElanInstance elanInfo, DpnInterfaces dpnInterfaces, BigInteger dpnId) {
1004         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1005         if (etreeInstance != null) {
1006             long etreeLeafTag = etreeInstance.getEtreeLeafTagVal().getValue();
1007             List<Bucket> listBucket = new ArrayList<>();
1008             int bucketId = 0;
1009             int actionKey = 0;
1010             List<Action> listAction = new ArrayList<>();
1011             listAction.add(new ActionInfo(ActionType.group,
1012                     new String[] { String.valueOf(ElanUtils.getEtreeLeafLocalBCGId(etreeLeafTag)) }, ++actionKey)
1013                             .buildAction());
1014             listBucket.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
1015                     MDSALUtil.WATCH_GROUP));
1016             bucketId++;
1017             List<Bucket> listBucketInfoRemote = getRemoteBCGroupBuckets(elanInfo, dpnInterfaces, dpnId, bucketId,
1018                     etreeLeafTag);
1019             listBucket.addAll(listBucketInfoRemote);
1020             long groupId = ElanUtils.getEtreeLeafRemoteBCGId(etreeLeafTag);
1021             Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1022                     MDSALUtil.buildBucketLists(listBucket));
1023             LOG.trace("Installing the remote BroadCast Group:{}", group);
1024             mdsalManager.syncInstallGroup(dpnId, group,
1025                     ElanConstants.DELAY_TIME_IN_MILLISECOND);
1026         }
1027     }
1028
1029     private void createDropBucket(List<Bucket> listBucket) {
1030         List<Action> actionsInfos = new ArrayList<>();
1031         actionsInfos.add(new ActionInfo(ActionType.drop_action, new String[] {}).buildAction());
1032         Bucket dropBucket = MDSALUtil.buildBucket(actionsInfos, MDSALUtil.GROUP_WEIGHT, 0, MDSALUtil.WATCH_PORT,
1033                 MDSALUtil.WATCH_GROUP);
1034         listBucket.add(dropBucket);
1035     }
1036
1037     public void setupLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface,
1038             InterfaceInfo interfaceInfo) {
1039         setupStandardLocalBroadcastGroups(elanInfo, newDpnInterface, interfaceInfo);
1040         setupLeavesLocalBroadcastGroups(elanInfo, newDpnInterface, interfaceInfo);
1041     }
1042
1043     public void setupStandardLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface,
1044             InterfaceInfo interfaceInfo) {
1045         List<Bucket> listBucket = new ArrayList<>();
1046         int bucketId = 0;
1047         long groupId = ElanUtils.getElanLocalBCGId(elanInfo.getElanTag());
1048
1049         List<String> interfaces = new ArrayList<>();
1050         if (newDpnInterface != null) {
1051             interfaces = newDpnInterface.getInterfaces();
1052         }
1053         for (String ifName : interfaces) {
1054             // In case if there is a InterfacePort in the cache which is not in
1055             // operational state, skip processing it
1056             InterfaceInfo ifInfo = interfaceManager
1057                     .getInterfaceInfoFromOperationalDataStore(ifName, interfaceInfo.getInterfaceType());
1058             if (!isOperational(ifInfo)) {
1059                 continue;
1060             }
1061
1062             if (!elanUtils.isExternal(ifName)) {
1063                 listBucket.add(MDSALUtil.buildBucket(getInterfacePortActions(ifInfo), MDSALUtil.GROUP_WEIGHT, bucketId,
1064                         MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
1065                 bucketId++;
1066             }
1067         }
1068
1069         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1070                 MDSALUtil.buildBucketLists(listBucket));
1071         LOG.trace("installing the localBroadCast Group:{}", group);
1072         mdsalManager.syncInstallGroup(interfaceInfo.getDpId(), group,
1073                 ElanConstants.DELAY_TIME_IN_MILLISECOND);
1074     }
1075
1076     private void setupLeavesLocalBroadcastGroups(ElanInstance elanInfo, DpnInterfaces newDpnInterface,
1077             InterfaceInfo interfaceInfo) {
1078         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1079         if (etreeInstance != null) {
1080             List<Bucket> listBucket = new ArrayList<>();
1081             int bucketId = 0;
1082
1083             List<String> interfaces = new ArrayList<>();
1084             if (newDpnInterface != null) {
1085                 interfaces = newDpnInterface.getInterfaces();
1086             }
1087             for (String ifName : interfaces) {
1088                 // In case if there is a InterfacePort in the cache which is not
1089                 // in
1090                 // operational state, skip processing it
1091                 InterfaceInfo ifInfo = interfaceManager
1092                         .getInterfaceInfoFromOperationalDataStore(ifName, interfaceInfo.getInterfaceType());
1093                 if (!isOperational(ifInfo)) {
1094                     continue;
1095                 }
1096
1097                 if (!elanUtils.isExternal(ifName)) {
1098                     // only add root interfaces
1099                     bucketId = addInterfaceIfRootInterface(bucketId, ifName, listBucket, ifInfo);
1100                 }
1101             }
1102
1103             if (listBucket.size() == 0) { // No Buckets
1104                 createDropBucket(listBucket);
1105             }
1106
1107             long etreeLeafTag = etreeInstance.getEtreeLeafTagVal().getValue();
1108             long groupId = ElanUtils.getEtreeLeafLocalBCGId(etreeLeafTag);
1109             Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1110                     MDSALUtil.buildBucketLists(listBucket));
1111             LOG.trace("installing the localBroadCast Group:{}", group);
1112             mdsalManager.syncInstallGroup(interfaceInfo.getDpId(), group,
1113                     ElanConstants.DELAY_TIME_IN_MILLISECOND);
1114         }
1115     }
1116
1117     private int addInterfaceIfRootInterface(int bucketId, String ifName, List<Bucket> listBucket,
1118             InterfaceInfo ifInfo) {
1119         EtreeInterface etreeInterface = ElanUtils.getEtreeInterfaceByElanInterfaceName(broker, ifName);
1120         if (etreeInterface != null && etreeInterface.getEtreeInterfaceType() == EtreeInterfaceType.Root) {
1121             listBucket.add(MDSALUtil.buildBucket(getInterfacePortActions(ifInfo), MDSALUtil.GROUP_WEIGHT, bucketId,
1122                     MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
1123             bucketId++;
1124         }
1125         return bucketId;
1126     }
1127
1128     public void removeLocalBroadcastGroup(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
1129             WriteTransaction deleteFlowGroupTx) {
1130         BigInteger dpnId = interfaceInfo.getDpId();
1131         long groupId = ElanUtils.getElanLocalBCGId(elanInfo.getElanTag());
1132         List<Bucket> listBuckets = new ArrayList<>();
1133         int bucketId = 0;
1134         listBuckets.add(getLocalBCGroupBucketInfo(interfaceInfo, bucketId));
1135         // listBuckets.addAll(getRemoteBCGroupBucketInfos(elanInfo, 1,
1136         // interfaceInfo));
1137         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1138                 MDSALUtil.buildBucketLists(listBuckets));
1139         LOG.trace("deleted the localBroadCast Group:{}", group);
1140         mdsalManager.removeGroupToTx(dpnId, group, deleteFlowGroupTx);
1141     }
1142
1143     public void removeElanBroadcastGroup(ElanInstance elanInfo, InterfaceInfo interfaceInfo,
1144             WriteTransaction deleteFlowGroupTx) {
1145         int bucketId = 0;
1146         int actionKey = 0;
1147         Long elanTag = elanInfo.getElanTag();
1148         List<Bucket> listBuckets = new ArrayList<>();
1149         List<Action> listAction = new ArrayList<>();
1150         listAction.add(new ActionInfo(ActionType.group,
1151                 new String[] { String.valueOf(ElanUtils.getElanLocalBCGId(elanTag)) }, ++actionKey).buildAction());
1152         listBuckets.add(MDSALUtil.buildBucket(listAction, MDSALUtil.GROUP_WEIGHT, bucketId, MDSALUtil.WATCH_PORT,
1153                 MDSALUtil.WATCH_GROUP));
1154         bucketId++;
1155         listBuckets.addAll(getRemoteBCGroupBucketInfos(elanInfo, bucketId, interfaceInfo, elanInfo.getElanTag()));
1156         BigInteger dpnId = interfaceInfo.getDpId();
1157         long groupId = ElanUtils.getElanRemoteBCGId(elanInfo.getElanTag());
1158         Group group = MDSALUtil.buildGroup(groupId, elanInfo.getElanInstanceName(), GroupTypes.GroupAll,
1159                 MDSALUtil.buildBucketLists(listBuckets));
1160         LOG.trace("deleting the remoteBroadCast group:{}", group);
1161         mdsalManager.removeGroupToTx(dpnId, group, deleteFlowGroupTx);
1162     }
1163
1164     /**
1165      * Installs a flow in the External Tunnel table consisting in translating
1166      * the VNI retrieved from the packet that came over a tunnel with a TOR into
1167      * elanTag that will be used later in the ELANs pipeline.
1168      *
1169      * @param dpnId
1170      *            the dpn id
1171      * @param elanInfo
1172      *            the elan info
1173      */
1174     public void setExternalTunnelTable(BigInteger dpnId, ElanInstance elanInfo) {
1175         long elanTag = elanInfo.getElanTag();
1176         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId, NwConstants.EXTERNAL_TUNNEL_TABLE,
1177                 getFlowRef(NwConstants.EXTERNAL_TUNNEL_TABLE, elanTag), 5, // prio
1178                 elanInfo.getElanInstanceName(), // flowName
1179                 0, // idleTimeout
1180                 0, // hardTimeout
1181                 ITMConstants.COOKIE_ITM_EXTERNAL.add(BigInteger.valueOf(elanTag)),
1182                 buildMatchesForVni(elanInfo.getSegmentationId()), getInstructionsExtTunnelTable(elanTag));
1183
1184         mdsalManager.installFlow(flowEntity);
1185     }
1186
1187     /**
1188      * Removes, from External Tunnel table, the flow that translates from VNI to
1189      * elanTag. Important: ensure this method is only called whenever there is
1190      * no other ElanInterface in the specified DPN
1191      *
1192      * @param dpnId
1193      *            DPN whose Ext Tunnel table is going to be modified
1194      * @param elanInfo
1195      *            holds the elanTag needed for selecting the flow to be removed
1196      */
1197     public void unsetExternalTunnelTable(BigInteger dpnId, ElanInstance elanInfo) {
1198         // TODO: Use DataStoreJobCoordinator in order to avoid that removing the
1199         // last ElanInstance plus
1200         // adding a new one does (almost at the same time) are executed in that
1201         // exact order
1202
1203         String flowId = getFlowRef(NwConstants.EXTERNAL_TUNNEL_TABLE, elanInfo.getElanTag());
1204         FlowEntity flowEntity = new FlowEntity(dpnId);
1205         flowEntity.setTableId(NwConstants.EXTERNAL_TUNNEL_TABLE);
1206         flowEntity.setFlowId(flowId);
1207         mdsalManager.removeFlow(flowEntity);
1208     }
1209
1210     public void setupTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId, WriteTransaction writeFlowGroupTx) {
1211         setupTerminateServiceTable(elanInfo, dpId, elanInfo.getElanTag(), writeFlowGroupTx);
1212         setupEtreeTerminateServiceTable(elanInfo, dpId, writeFlowGroupTx);
1213     }
1214
1215     public void setupTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1216             WriteTransaction writeFlowGroupTx) {
1217         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.INTERNAL_TUNNEL_TABLE,
1218                 getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE, elanTag), 5,
1219                 String.format("%s:%d", "ITM Flow Entry ", elanTag), 0, 0,
1220                 ITMConstants.COOKIE_ITM.add(BigInteger.valueOf(elanTag)),
1221                 ElanUtils.getTunnelMatchesForServiceId((int) elanTag),
1222                 getInstructionsForOutGroup(ElanUtils.getElanLocalBCGId(elanTag)));
1223
1224         mdsalManager.addFlowToTx(dpId, flowEntity, writeFlowGroupTx);
1225     }
1226
1227     private void setupEtreeTerminateServiceTable(ElanInstance elanInfo, BigInteger dpId,
1228             WriteTransaction writeFlowGroupTx) {
1229         EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1230         if (etreeInstance != null) {
1231             setupTerminateServiceTable(elanInfo, dpId, etreeInstance.getEtreeLeafTagVal().getValue(), writeFlowGroupTx);
1232         }
1233     }
1234
1235     public void setupUnknownDMacTable(ElanInstance elanInfo, BigInteger dpId, WriteTransaction writeFlowGroupTx) {
1236         long elanTag = elanInfo.getElanTag();
1237         installLocalUnknownFlow(elanInfo, dpId, elanTag, writeFlowGroupTx);
1238         installRemoteUnknownFlow(elanInfo, dpId, elanTag, writeFlowGroupTx);
1239         setupEtreeUnknownDMacTable(elanInfo, dpId, elanTag, writeFlowGroupTx);
1240     }
1241
1242     private void setupEtreeUnknownDMacTable(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1243             WriteTransaction writeFlowGroupTx) {
1244         EtreeLeafTagName etreeLeafTag = elanUtils.getEtreeLeafTagByElanTag(elanTag);
1245         if (etreeLeafTag != null) {
1246             long leafTag = etreeLeafTag.getEtreeLeafTag().getValue();
1247             installRemoteUnknownFlow(elanInfo, dpId, leafTag, writeFlowGroupTx);
1248             installLocalUnknownFlow(elanInfo, dpId, leafTag, writeFlowGroupTx);
1249         }
1250     }
1251
1252     private void installLocalUnknownFlow(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1253             WriteTransaction writeFlowGroupTx) {
1254         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1255                 getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE, elanTag,
1256                         /* SH flag */false),
1257                 5, elanInfo.getElanInstanceName(), 0, 0,
1258                 ElanConstants.COOKIE_ELAN_UNKNOWN_DMAC.add(BigInteger.valueOf(elanTag)),
1259                 getMatchesForElanTag(elanTag, /* SH flag */false),
1260                 getInstructionsForOutGroup(ElanUtils.getElanRemoteBCGId(elanTag)));
1261
1262         mdsalManager.addFlowToTx(dpId, flowEntity, writeFlowGroupTx);
1263     }
1264
1265     private void installRemoteUnknownFlow(ElanInstance elanInfo, BigInteger dpId, long elanTag,
1266             WriteTransaction writeFlowGroupTx) {
1267         // only if ELAN can connect to external network, perform the following
1268         if (ElanUtils.isVxlan(elanInfo) || ElanUtils.isVlan(elanInfo) || ElanUtils.isFlat(elanInfo)) {
1269             Flow flowEntity2 = MDSALUtil.buildFlowNew(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1270                     getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE, elanTag,
1271                             /* SH flag */true),
1272                     5, elanInfo.getElanInstanceName(), 0, 0,
1273                     ElanConstants.COOKIE_ELAN_UNKNOWN_DMAC.add(BigInteger.valueOf(elanTag)),
1274                     getMatchesForElanTag(elanTag, /* SH flag */true),
1275                     getInstructionsForOutGroup(ElanUtils.getElanLocalBCGId(elanTag)));
1276             mdsalManager.addFlowToTx(dpId, flowEntity2, writeFlowGroupTx);
1277         }
1278     }
1279
1280
1281     private void removeUnknownDmacFlow(BigInteger dpId, ElanInstance elanInfo, WriteTransaction deleteFlowGroupTx,
1282             long elanTag) {
1283         Flow flow = new FlowBuilder().setId(new FlowId(getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1284                 elanTag, /* SH flag */ false))).setTableId(NwConstants.ELAN_UNKNOWN_DMAC_TABLE).build();
1285         mdsalManager.removeFlowToTx(dpId, flow, deleteFlowGroupTx);
1286
1287         if (ElanUtils.isVxlan(elanInfo)) {
1288             Flow flow2 = new FlowBuilder().setId(new FlowId(getUnknownDmacFlowRef(NwConstants.ELAN_UNKNOWN_DMAC_TABLE,
1289                     elanTag, /* SH flag */ true))).setTableId(NwConstants.ELAN_UNKNOWN_DMAC_TABLE)
1290                     .build();
1291             mdsalManager.removeFlowToTx(dpId, flow2, deleteFlowGroupTx);
1292         }
1293     }
1294
1295     private void removeDefaultTermFlow(BigInteger dpId, long elanTag) {
1296         elanUtils.removeTerminatingServiceAction(dpId, (int) elanTag);
1297     }
1298
1299     private void bindService(ElanInstance elanInfo, ElanInterface elanInterface, WriteTransaction tx) {
1300         if (isStandardElanService(elanInterface)) {
1301             bindElanService(elanInfo.getElanTag(), elanInfo.getElanInstanceName(), elanInterface.getName(), tx);
1302         } else { // Etree service
1303             bindEtreeService(elanInfo, elanInterface, tx);
1304         }
1305     }
1306
1307     private void bindElanService(long elanTag, String elanInstanceName, String interfaceName, WriteTransaction tx) {
1308         int priority = ElanConstants.ELAN_SERVICE_PRIORITY;
1309         int instructionKey = 0;
1310         List<Instruction> instructions = new ArrayList<>();
1311         instructions.add(MDSALUtil.buildAndGetWriteMetadaInstruction(ElanUtils.getElanMetadataLabel(elanTag),
1312                 MetaDataUtil.METADATA_MASK_SERVICE, ++instructionKey));
1313         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.ELAN_SMAC_TABLE, ++instructionKey));
1314         short elanServiceIndex = ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME, NwConstants.ELAN_SERVICE_INDEX);
1315         BoundServices serviceInfo = ElanUtils.getBoundServices(
1316                 String.format("%s.%s.%s", "vpn", elanInstanceName, interfaceName), elanServiceIndex,
1317                 priority, NwConstants.COOKIE_ELAN_INGRESS_TABLE, instructions);
1318         tx.put(LogicalDatastoreType.CONFIGURATION,
1319                 ElanUtils.buildServiceId(interfaceName, elanServiceIndex), serviceInfo, true);
1320     }
1321
1322     private void bindEtreeService(ElanInstance elanInfo, ElanInterface elanInterface, WriteTransaction tx) {
1323         if (elanInterface.getAugmentation(EtreeInterface.class).getEtreeInterfaceType() == EtreeInterfaceType.Root) {
1324             bindElanService(elanInfo.getElanTag(), elanInfo.getElanInstanceName(), elanInterface.getName(), tx);
1325         } else {
1326             EtreeInstance etreeInstance = elanInfo.getAugmentation(EtreeInstance.class);
1327             if (etreeInstance == null) {
1328                 LOG.error("EtreeInterface " + elanInterface.getName() + " is associated with a non EtreeInstance: "
1329                         + elanInfo.getElanInstanceName());
1330             } else {
1331                 bindElanService(etreeInstance.getEtreeLeafTagVal().getValue(), elanInfo.getElanInstanceName(),
1332                         elanInterface.getName(), tx);
1333             }
1334         }
1335     }
1336
1337     private boolean isStandardElanService(ElanInterface elanInterface) {
1338         return elanInterface.getAugmentation(EtreeInterface.class) == null;
1339     }
1340
1341     private boolean isStandardElanService(ElanInstance elanInstance) {
1342         return elanInstance.getAugmentation(EtreeInstance.class) == null;
1343     }
1344
1345     private void unbindService(ElanInstance elanInfo, String interfaceName, WriteTransaction tx) {
1346         tx.delete(LogicalDatastoreType.CONFIGURATION, ElanUtils.buildServiceId(interfaceName,
1347                 ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME, NwConstants.ELAN_SERVICE_INDEX)));
1348     }
1349
1350     private String getFlowRef(long tableId, long elanTag) {
1351         return new StringBuffer().append(tableId).append(elanTag).toString();
1352     }
1353
1354     private String getUnknownDmacFlowRef(long tableId, long elanTag, boolean shFlag) {
1355         return new StringBuffer().append(tableId).append(elanTag).append(shFlag).toString();
1356     }
1357
1358     private List<Action> getInterfacePortActions(InterfaceInfo interfaceInfo) {
1359         List<Action> listAction = new ArrayList<>();
1360         int actionKey = 0;
1361         listAction.add(new ActionInfo(ActionType.set_field_tunnel_id,
1362                 new BigInteger[] { BigInteger.valueOf(interfaceInfo.getInterfaceTag()) }, actionKey).buildAction());
1363         actionKey++;
1364         listAction.add(new ActionInfo(ActionType.nx_resubmit,
1365                 new String[] { String.valueOf(NwConstants.ELAN_FILTER_EQUALS_TABLE) }, actionKey).buildAction());
1366         return listAction;
1367     }
1368
1369     private DpnInterfaces updateElanDpnInterfacesList(String elanInstanceName, BigInteger dpId,
1370             List<String> interfaceNames, WriteTransaction tx) {
1371         DpnInterfaces dpnInterface = new DpnInterfacesBuilder().setDpId(dpId).setInterfaces(interfaceNames)
1372                 .setKey(new DpnInterfacesKey(dpId)).build();
1373         tx.put(LogicalDatastoreType.OPERATIONAL,
1374                 ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId), dpnInterface, true);
1375         return dpnInterface;
1376     }
1377
1378     /**
1379      * Delete elan dpn interface from operational DS.
1380      *
1381      * @param elanInstanceName
1382      *            the elan instance name
1383      * @param dpId
1384      *            the dp id
1385      */
1386     private void deleteElanDpnInterface(String elanInstanceName, BigInteger dpId, WriteTransaction tx) {
1387         tx.delete(LogicalDatastoreType.OPERATIONAL,
1388                 ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId));
1389     }
1390
1391     private DpnInterfaces createElanInterfacesList(String elanInstanceName, String interfaceName, BigInteger dpId,
1392             WriteTransaction tx) {
1393         List<String> interfaceNames = new ArrayList<>();
1394         interfaceNames.add(interfaceName);
1395         DpnInterfaces dpnInterface = new DpnInterfacesBuilder().setDpId(dpId).setInterfaces(interfaceNames)
1396                 .setKey(new DpnInterfacesKey(dpId)).build();
1397         tx.put(LogicalDatastoreType.OPERATIONAL,
1398                 ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId), dpnInterface, true);
1399         return dpnInterface;
1400     }
1401
1402     private void createElanInterfaceTablesList(String interfaceName, WriteTransaction tx) {
1403         InstanceIdentifier<ElanInterfaceMac> elanInterfaceMacTables = ElanUtils
1404                 .getElanInterfaceMacEntriesOperationalDataPath(interfaceName);
1405         Optional<ElanInterfaceMac> interfaceMacTables = elanUtils.read(broker,
1406                 LogicalDatastoreType.OPERATIONAL, elanInterfaceMacTables);
1407         // Adding new Elan Interface Port to the operational DataStore without
1408         // Static-Mac Entries..
1409         if (!interfaceMacTables.isPresent()) {
1410             ElanInterfaceMac elanInterfaceMacTable = new ElanInterfaceMacBuilder().setElanInterface(interfaceName)
1411                     .setKey(new ElanInterfaceMacKey(interfaceName)).build();
1412             tx.put(LogicalDatastoreType.OPERATIONAL,
1413                     ElanUtils.getElanInterfaceMacEntriesOperationalDataPath(interfaceName), elanInterfaceMacTable,
1414                     true);
1415         }
1416     }
1417
1418     private void createElanStateList(String elanInstanceName, String interfaceName, WriteTransaction tx) {
1419         InstanceIdentifier<Elan> elanInstance = ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName);
1420         Optional<Elan> elanInterfaceLists = elanUtils.read(broker,
1421                 LogicalDatastoreType.OPERATIONAL, elanInstance);
1422         // Adding new Elan Interface Port to the operational DataStore without
1423         // Static-Mac Entries..
1424         if (elanInterfaceLists.isPresent()) {
1425             List<String> interfaceLists = elanInterfaceLists.get().getElanInterfaces();
1426             if (interfaceLists == null) {
1427                 interfaceLists = new ArrayList<>();
1428             }
1429             interfaceLists.add(interfaceName);
1430             Elan elanState = new ElanBuilder().setName(elanInstanceName).setElanInterfaces(interfaceLists)
1431                     .setKey(new ElanKey(elanInstanceName)).build();
1432             tx.put(LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName),
1433                     elanState, true);
1434         }
1435     }
1436
1437     private boolean isOperational(InterfaceInfo interfaceInfo) {
1438         if (interfaceInfo == null) {
1439             return false;
1440         }
1441         return interfaceInfo.getAdminState() == InterfaceInfo.InterfaceAdminState.ENABLED;
1442     }
1443
1444     public void handleInternalTunnelStateEvent(BigInteger srcDpId, BigInteger dstDpId) {
1445         ElanDpnInterfaces dpnInterfaceLists = elanUtils.getElanDpnInterfacesList();
1446         if (dpnInterfaceLists == null) {
1447             return;
1448         }
1449         List<ElanDpnInterfacesList> elanDpnIf = dpnInterfaceLists.getElanDpnInterfacesList();
1450         for (ElanDpnInterfacesList elanDpns : elanDpnIf) {
1451             int cnt = 0;
1452             String elanName = elanDpns.getElanInstanceName();
1453             List<DpnInterfaces> dpnInterfaces = elanDpns.getDpnInterfaces();
1454             if (dpnInterfaces == null) {
1455                 continue;
1456             }
1457             for (DpnInterfaces dpnIf : dpnInterfaces) {
1458                 if (dpnIf.getDpId().equals(srcDpId) || dpnIf.getDpId().equals(dstDpId)) {
1459                     cnt++;
1460                 }
1461             }
1462             if (cnt == 2) {
1463                 LOG.debug("Elan instance:{} is present b/w srcDpn:{} and dstDpn:{}", elanName, srcDpId, dstDpId);
1464                 ElanInstance elanInfo = ElanUtils.getElanInstanceByName(broker, elanName);
1465                 // update Remote BC Group
1466                 setupElanBroadcastGroups(elanInfo, srcDpId);
1467
1468                 DpnInterfaces dpnInterface = elanUtils.getElanInterfaceInfoByElanDpn(elanName, dstDpId);
1469                 Set<String> interfaceLists = new HashSet<>();
1470                 interfaceLists.addAll(dpnInterface.getInterfaces());
1471                 for (String ifName : interfaceLists) {
1472                     InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(ifName);
1473                     if (isOperational(interfaceInfo)) {
1474                         installDMacAddressTables(elanInfo, interfaceInfo, srcDpId);
1475                     }
1476                 }
1477             }
1478
1479         }
1480     }
1481
1482     /**
1483      * Handle external tunnel state event.
1484      *
1485      * @param externalTunnel
1486      *            the external tunnel
1487      * @param intrf
1488      *            the interface
1489      */
1490     public void handleExternalTunnelStateEvent(ExternalTunnel externalTunnel, Interface intrf) {
1491         if (!validateExternalTunnelStateEvent(externalTunnel, intrf)) {
1492             return;
1493         }
1494         // dpId/externalNodeId will be available either in source or destination
1495         // based on the tunnel end point
1496         BigInteger dpId = null;
1497         NodeId externalNodeId = null;
1498         if (StringUtils.isNumeric(externalTunnel.getSourceDevice())) {
1499             dpId = new BigInteger(externalTunnel.getSourceDevice());
1500             externalNodeId = new NodeId(externalTunnel.getDestinationDevice());
1501         } else if (StringUtils.isNumeric(externalTunnel.getDestinationDevice())) {
1502             dpId = new BigInteger(externalTunnel.getDestinationDevice());
1503             externalNodeId = new NodeId(externalTunnel.getSourceDevice());
1504         }
1505         if (dpId == null || externalNodeId == null) {
1506             LOG.error("Dp ID / externalNodeId not found in external tunnel {}", externalTunnel);
1507             return;
1508         }
1509
1510         ElanDpnInterfaces dpnInterfaceLists = elanUtils.getElanDpnInterfacesList();
1511         if (dpnInterfaceLists == null) {
1512             return;
1513         }
1514         List<ElanDpnInterfacesList> elanDpnIf = dpnInterfaceLists.getElanDpnInterfacesList();
1515         for (ElanDpnInterfacesList elanDpns : elanDpnIf) {
1516             String elanName = elanDpns.getElanInstanceName();
1517             ElanInstance elanInfo = ElanUtils.getElanInstanceByName(broker, elanName);
1518
1519             DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanName, dpId);
1520             if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null
1521                     || dpnInterfaces.getInterfaces().isEmpty()) {
1522                 continue;
1523             }
1524             LOG.debug("Elan instance:{} is present in Dpn:{} ", elanName, dpId);
1525
1526             setupElanBroadcastGroups(elanInfo, dpId);
1527             // install L2gwDevices local macs in dpn.
1528             elanL2GatewayUtils.installL2gwDeviceMacsInDpn(dpId, externalNodeId, elanInfo, intrf.getName());
1529             // Install dpn macs on external device
1530             elanL2GatewayUtils.installDpnMacsInL2gwDevice(elanName, new HashSet<>(dpnInterfaces.getInterfaces()), dpId,
1531                     externalNodeId);
1532         }
1533         LOG.info("Handled ExternalTunnelStateEvent for {}", externalTunnel);
1534     }
1535
1536     /**
1537      * Validate external tunnel state event.
1538      *
1539      * @param externalTunnel
1540      *            the external tunnel
1541      * @param intrf
1542      *            the intrf
1543      * @return true, if successful
1544      */
1545     private boolean validateExternalTunnelStateEvent(ExternalTunnel externalTunnel, Interface intrf) {
1546         if (intrf.getOperStatus() == Interface.OperStatus.Up) {
1547             String srcDevice = externalTunnel.getDestinationDevice();
1548             String destDevice = externalTunnel.getSourceDevice();
1549             ExternalTunnel otherEndPointExtTunnel = elanUtils.getExternalTunnel(srcDevice, destDevice,
1550                     LogicalDatastoreType.CONFIGURATION);
1551             if (LOG.isTraceEnabled()) {
1552                 LOG.trace("Validating external tunnel state: src tunnel {}, dest tunnel {}", externalTunnel,
1553                         otherEndPointExtTunnel);
1554             }
1555             if (otherEndPointExtTunnel != null) {
1556                 boolean otherEndPointInterfaceOperational = ElanUtils.isInterfaceOperational(
1557                         otherEndPointExtTunnel.getTunnelInterfaceName(), broker);
1558                 if (otherEndPointInterfaceOperational) {
1559                     return true;
1560                 } else {
1561                     LOG.debug("Other end [{}] of the external tunnel is not yet UP for {}",
1562                             otherEndPointExtTunnel.getTunnelInterfaceName(), externalTunnel);
1563                 }
1564             }
1565         }
1566         return false;
1567     }
1568
1569     private List<MatchInfo> getMatchesForFilterEqualsLPortTag(int lportTag) {
1570         List<MatchInfo> mkMatches = new ArrayList<>();
1571         // Matching metadata
1572         mkMatches.add(new MatchInfo(MatchFieldType.metadata,
1573                 new BigInteger[] { MetaDataUtil.getLportTagMetaData(lportTag), MetaDataUtil.METADATA_MASK_LPORT_TAG }));
1574         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(lportTag) }));
1575         return mkMatches;
1576     }
1577
1578     private List<MatchInfo> getTunnelIdMatchForFilterEqualsLPortTag(int lportTag) {
1579         List<MatchInfo> mkMatches = new ArrayList<>();
1580         // Matching metadata
1581         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] { BigInteger.valueOf(lportTag) }));
1582         return mkMatches;
1583     }
1584
1585     public void updateRemoteBroadcastGroupForAllElanDpns(ElanInstance elanInfo) {
1586         List<DpnInterfaces> dpns = elanUtils.getInvolvedDpnsInElan(elanInfo.getElanInstanceName());
1587         if (dpns == null) {
1588             return;
1589         }
1590         for (DpnInterfaces dpn : dpns) {
1591             setupElanBroadcastGroups(elanInfo, dpn.getDpId());
1592         }
1593     }
1594
1595     public List<Bucket> getRemoteBCGroupBucketsOfElanL2GwDevices(ElanInstance elanInfo, BigInteger dpnId,
1596             int bucketId) {
1597         List<Bucket> listBucketInfo = new ArrayList<>();
1598         ConcurrentMap<String, L2GatewayDevice> map = ElanL2GwCacheUtils
1599                 .getInvolvedL2GwDevices(elanInfo.getElanInstanceName());
1600         for (L2GatewayDevice device : map.values()) {
1601             String interfaceName = elanL2GatewayUtils.getExternalTunnelInterfaceName(String.valueOf(dpnId),
1602                     device.getHwvtepNodeId());
1603             if (interfaceName == null) {
1604                 continue;
1605             }
1606             List<Action> listActionInfo = elanUtils.buildTunnelItmEgressActions(interfaceName,
1607                     elanInfo.getSegmentationId());
1608             listBucketInfo.add(MDSALUtil.buildBucket(listActionInfo, MDSALUtil.GROUP_WEIGHT, bucketId,
1609                     MDSALUtil.WATCH_PORT, MDSALUtil.WATCH_GROUP));
1610             bucketId++;
1611         }
1612         return listBucketInfo;
1613     }
1614
1615     @Override
1616     protected ElanInterfaceManager getDataTreeChangeListener() {
1617         return this;
1618     }
1619 }