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