elanmanager/impl/src/main/java/org/opendaylight/netvirt/elan/internal/ElanServiceProvider.java

   1 /*
   2  * Copyright (c) 2016, 2017 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
   9 package org.opendaylight.netvirt.elan.internal;
  10
  11 import static java.util.Collections.emptyList;
  12 import static org.opendaylight.netvirt.elan.utils.ElanUtils.requireNonNullElse;
  13
  14 import com.google.common.base.Optional;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.math.BigInteger;
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.Collections;
  20 import java.util.HashSet;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Objects;
  24 import java.util.Set;
  25 import java.util.concurrent.Future;
  26 import java.util.function.BiFunction;
  27 import javax.annotation.Nonnull;
  28 import javax.annotation.Nullable;
  29 import javax.inject.Inject;
  30 import javax.inject.Singleton;
  31 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.genius.infra.Datastore;
  34 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  35 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  36 import org.opendaylight.genius.interfacemanager.exceptions.InterfaceAlreadyExistsException;
  37 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  38 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  39 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  40 import org.opendaylight.genius.mdsalutil.MatchInfoBase;
  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.mdsalutil.nxmatches.NxMatchRegister;
  45 import org.opendaylight.genius.utils.ServiceIndex;
  46 import org.opendaylight.genius.utils.hwvtep.HwvtepSouthboundConstants;
  47 import org.opendaylight.infrautils.inject.AbstractLifecycle;
  48 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  49 import org.opendaylight.mdsal.eos.binding.api.Entity;
  50 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipCandidateRegistration;
  51 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
  52 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  53 import org.opendaylight.netvirt.elan.arp.responder.ArpResponderInput;
  54 import org.opendaylight.netvirt.elan.arp.responder.ArpResponderUtil;
  55 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
  56 import org.opendaylight.netvirt.elan.cache.ElanInterfaceCache;
  57 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  58 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  59 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
  60 import org.opendaylight.netvirt.elanmanager.api.IElanService;
  61 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInput;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInputBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolOutput;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstanceBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterfaceBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
  91 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  92 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  93 import org.opendaylight.yangtools.yang.common.RpcResult;
  94 import org.slf4j.Logger;
  95 import org.slf4j.LoggerFactory;
  96
  97 @Singleton
  98 public class ElanServiceProvider extends AbstractLifecycle implements IElanService {
  99
 100     private static final Logger LOG = LoggerFactory.getLogger(ElanServiceProvider.class);
 101
 102     private final IdManagerService idManager;
 103     private final IInterfaceManager interfaceManager;
 104     private final ElanBridgeManager bridgeMgr;
 105     private final DataBroker broker;
 106     private final ManagedNewTransactionRunner txRunner;
 107     private final ElanUtils elanUtils;
 108     private final SouthboundUtils southboundUtils;
 109     private final IMdsalApiManager mdsalManager;
 110     private final ElanInstanceCache elanInstanceCache;
 111     private final ElanInterfaceCache elanInterfaceCache;
 112     private boolean isL2BeforeL3;
 113
 114     private final EntityOwnershipCandidateRegistration candidateRegistration;
 115
 116     @Inject
 117     public ElanServiceProvider(IdManagerService idManager, IInterfaceManager interfaceManager,
 118                                ElanBridgeManager bridgeMgr,
 119                                DataBroker dataBroker,
 120                                ElanUtils elanUtils,
 121                                EntityOwnershipService entityOwnershipService,
 122                                SouthboundUtils southboundUtils, ElanInstanceCache elanInstanceCache,
 123                                ElanInterfaceCache elanInterfaceCache, IMdsalApiManager mdsalManager) {
 124         this.idManager = idManager;
 125         this.interfaceManager = interfaceManager;
 126         this.bridgeMgr = bridgeMgr;
 127         this.broker = dataBroker;
 128         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 129         this.elanUtils = elanUtils;
 130         this.southboundUtils = southboundUtils;
 131         this.elanInstanceCache = elanInstanceCache;
 132         this.elanInterfaceCache = elanInterfaceCache;
 133         this.mdsalManager = mdsalManager;
 134
 135         candidateRegistration = registerCandidate(entityOwnershipService);
 136     }
 137
 138     @Nullable
 139     private static EntityOwnershipCandidateRegistration registerCandidate(
 140             EntityOwnershipService entityOwnershipService) {
 141         try {
 142             return entityOwnershipService.registerCandidate(
 143                     new Entity(HwvtepSouthboundConstants.ELAN_ENTITY_TYPE, HwvtepSouthboundConstants.ELAN_ENTITY_TYPE));
 144         } catch (CandidateAlreadyRegisteredException e) {
 145             LOG.error("failed to register the entity");
 146             return null;
 147         }
 148     }
 149
 150     @Override
 151     @SuppressWarnings("checkstyle:IllegalCatch")
 152     protected void start() throws Exception {
 153         LOG.info("Starting ElanServiceProvider");
 154         setIsL2BeforeL3();
 155         createIdPool();
 156     }
 157
 158     @Override
 159     protected void stop() {
 160         if (candidateRegistration != null) {
 161             candidateRegistration.close();
 162         }
 163
 164         LOG.info("ElanServiceProvider stopped");
 165     }
 166
 167     @Override
 168     // Confusing with isOpenstackVniSemanticsEnforced but this is an interface method so can't change it.
 169     @SuppressFBWarnings("NM_CONFUSING")
 170     public Boolean isOpenStackVniSemanticsEnforced() {
 171         return elanUtils.isOpenstackVniSemanticsEnforced();
 172     }
 173
 174     private void createIdPool() throws Exception {
 175         CreateIdPoolInput createPool = new CreateIdPoolInputBuilder().setPoolName(ElanConstants.ELAN_ID_POOL_NAME)
 176                 .setLow(ElanConstants.ELAN_ID_LOW_VALUE).setHigh(ElanConstants.ELAN_ID_HIGH_VALUE).build();
 177         Future<RpcResult<CreateIdPoolOutput>> result = idManager.createIdPool(createPool);
 178         if (result != null && result.get().isSuccessful()) {
 179             LOG.debug("ELAN Id Pool is created successfully");
 180         }
 181     }
 182
 183     @Override
 184     public boolean createElanInstance(String elanInstanceName, long macTimeout, String description) {
 185         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 186         boolean isSuccess = true;
 187         if (existingElanInstance.isPresent()) {
 188             if (compareWithExistingElanInstance(existingElanInstance.get(), macTimeout, description)) {
 189                 LOG.debug("Elan Instance is already present in the Operational DS {}", existingElanInstance);
 190                 return true;
 191             } else {
 192                 ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 193                         .setDescription(description).setMacTimeout(macTimeout)
 194                         .withKey(new ElanInstanceKey(elanInstanceName)).build();
 195                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 196                         ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 197                 LOG.debug("Updating the Elan Instance {} with MAC TIME-OUT {} and Description {}",
 198                         updateElanInstance, macTimeout, description);
 199             }
 200         } else {
 201             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 202                     .setMacTimeout(macTimeout).setDescription(description)
 203                     .withKey(new ElanInstanceKey(elanInstanceName)).build();
 204             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 205                     ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 206             LOG.debug("Creating the new Elan Instance {}", elanInstance);
 207         }
 208         return isSuccess;
 209     }
 210
 211     @Override
 212     public boolean createEtreeInstance(String elanInstanceName, long macTimeout, String description) {
 213         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 214         boolean isSuccess = true;
 215         if (existingElanInstance.isPresent()) {
 216             if (compareWithExistingElanInstance(existingElanInstance.get(), macTimeout, description)) {
 217                 LOG.warn("Etree Instance is already present in the Operational DS {}", existingElanInstance);
 218                 return true;
 219             } else {
 220                 EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
 221                 ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 222                         .setDescription(description).setMacTimeout(macTimeout)
 223                         .withKey(new ElanInstanceKey(elanInstanceName))
 224                         .addAugmentation(EtreeInstance.class, etreeInstance).build();
 225                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 226                         ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 227                 LOG.debug("Updating the Etree Instance {} with MAC TIME-OUT {} and Description {} ",
 228                         updateElanInstance, macTimeout, description);
 229             }
 230         } else {
 231             EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
 232             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 233                     .setMacTimeout(macTimeout).setDescription(description)
 234                     .withKey(new ElanInstanceKey(elanInstanceName))
 235                     .addAugmentation(EtreeInstance.class, etreeInstance).build();
 236             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 237                     ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 238             LOG.debug("Creating the new Etree Instance {}", elanInstance);
 239         }
 240         return isSuccess;
 241     }
 242
 243     @Override
 244     @Nullable
 245     public EtreeInterface getEtreeInterfaceByElanInterfaceName(String elanInterface) {
 246         return elanInterfaceCache.getEtreeInterface(elanInterface).orNull();
 247     }
 248
 249     public static boolean compareWithExistingElanInstance(ElanInstance existingElanInstance, long macTimeOut,
 250             String description) {
 251         boolean isEqual = false;
 252         if (existingElanInstance.getMacTimeout() == macTimeOut
 253                 && Objects.equals(existingElanInstance.getDescription(), description)) {
 254             isEqual = true;
 255         }
 256         return isEqual;
 257     }
 258
 259     @Override
 260     public void updateElanInstance(String elanInstanceName, long newMacTimout, String newDescription) {
 261         createElanInstance(elanInstanceName, newMacTimout, newDescription);
 262     }
 263
 264     @Override
 265     public boolean deleteEtreeInstance(String etreeInstanceName) {
 266         return deleteElanInstance(etreeInstanceName);
 267     }
 268
 269     @Override
 270     public boolean deleteElanInstance(String elanInstanceName) {
 271         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 272         if (!existingElanInstance.isPresent()) {
 273             LOG.debug("Elan Instance is not present for {}", elanInstanceName);
 274             return false;
 275         }
 276         LOG.debug("Deletion of the existing Elan Instance {}", existingElanInstance);
 277         ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 278                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName));
 279         return true;
 280     }
 281
 282     @Override
 283     public void addEtreeInterface(String etreeInstanceName, String interfaceName, EtreeInterfaceType interfaceType,
 284             List<String> staticMacAddresses, String description) {
 285         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(etreeInstanceName);
 286         if (existingElanInstance.isPresent()
 287                 && existingElanInstance.get().augmentation(EtreeInstance.class) != null) {
 288             EtreeInterface etreeInterface = new EtreeInterfaceBuilder().setEtreeInterfaceType(interfaceType).build();
 289             ElanInterface elanInterface;
 290             if (staticMacAddresses == null) {
 291                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 292                         .setDescription(description).setName(interfaceName).withKey(new ElanInterfaceKey(interfaceName))
 293                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 294             } else {
 295                 List<StaticMacEntries> staticMacEntries = ElanUtils.getStaticMacEntries(staticMacAddresses);
 296                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 297                         .setDescription(description).setName(interfaceName)
 298                         .setStaticMacEntries(staticMacEntries)
 299                         .withKey(new ElanInterfaceKey(interfaceName))
 300                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 301             }
 302             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 303                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 304             LOG.debug("Creating the new Etree Interface {}", elanInterface);
 305         }
 306     }
 307
 308     @Override
 309     public void addElanInterface(String elanInstanceName, String interfaceName,
 310             @Nullable List<String> staticMacAddresses, @Nullable String description) {
 311         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 312         if (existingElanInstance.isPresent()) {
 313             ElanInterfaceBuilder elanInterfaceBuilder = new ElanInterfaceBuilder()
 314                     .setElanInstanceName(elanInstanceName)
 315                     .setDescription(description).setName(interfaceName)
 316                     .withKey(new ElanInterfaceKey(interfaceName));
 317             if (staticMacAddresses != null) {
 318                 List<StaticMacEntries> staticMacEntries = ElanUtils.getStaticMacEntries(staticMacAddresses);
 319                 elanInterfaceBuilder.setStaticMacEntries(staticMacEntries);
 320             }
 321             ElanInterface elanInterface = elanInterfaceBuilder.build();
 322             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 323                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 324             LOG.debug("Created the new ELan Interface {}", elanInterface);
 325         }
 326     }
 327
 328     @Override
 329     public void updateElanInterface(String elanInstanceName, String interfaceName,
 330             List<String> updatedStaticMacAddresses, String newDescription) {
 331         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 332         if (!existingElanInterface.isPresent()) {
 333             return;
 334         }
 335
 336         List<StaticMacEntries> updatedStaticMacEntries = ElanUtils.getStaticMacEntries(updatedStaticMacAddresses);
 337         LOG.debug("updating the ElanInterface with new Mac Entries {}", updatedStaticMacAddresses);
 338         ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 339                 .setName(interfaceName).setDescription(newDescription).setStaticMacEntries(updatedStaticMacEntries)
 340                 .withKey(new ElanInterfaceKey(interfaceName)).build();
 341         MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 342                 ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 343     }
 344
 345     @Override
 346     public void deleteEtreeInterface(String interfaceName) {
 347         deleteElanInterface(interfaceName);
 348         LOG.debug("deleting the Etree Interface {}", interfaceName);
 349     }
 350
 351     @Override
 352     public void deleteElanInterface(String interfaceName) {
 353         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 354         if (existingElanInterface.isPresent()) {
 355             ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 356                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName));
 357             LOG.debug("deleting the Elan Interface {}", existingElanInterface);
 358         }
 359     }
 360
 361     @Override
 362     public void addStaticMacAddress(String interfaceName, String macAddress) {
 363         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 364         if (existingElanInterface.isPresent()) {
 365             StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
 366             StaticMacEntries staticMacEntry = staticMacEntriesBuilder.setMacAddress(
 367                     new PhysAddress(macAddress)).build();
 368             InstanceIdentifier<StaticMacEntries> staticMacEntriesIdentifier =
 369                     ElanUtils.getStaticMacEntriesCfgDataPathIdentifier(interfaceName, macAddress);
 370             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, staticMacEntriesIdentifier, staticMacEntry);
 371         }
 372     }
 373
 374     @Override
 375     public void deleteStaticMacAddress(String interfaceName, String macAddress) {
 376         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 377         if (existingElanInterface.isPresent()) {
 378             InstanceIdentifier<StaticMacEntries> staticMacEntriesIdentifier =
 379                     ElanUtils.getStaticMacEntriesCfgDataPathIdentifier(interfaceName,
 380                     macAddress);
 381             MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, staticMacEntriesIdentifier);
 382         }
 383     }
 384
 385     @Override
 386     public Collection<MacEntry> getElanMacTable(String elanInstanceName) {
 387         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 388         List<MacEntry> macAddress = new ArrayList<>();
 389         if (elanInfo == null) {
 390             return macAddress;
 391         }
 392         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 393         if (elanInterfaces != null && elanInterfaces.size() > 0) {
 394             for (String elanInterface : elanInterfaces) {
 395                 ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 396                 if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null
 397                         && elanInterfaceMac.getMacEntry().size() > 0) {
 398                     macAddress.addAll(elanInterfaceMac.getMacEntry());
 399                 }
 400             }
 401         }
 402         return macAddress;
 403     }
 404
 405     @Override
 406     public void flushMACTable(String elanInstanceName) {
 407         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 408         if (elanInfo == null) {
 409             return;
 410         }
 411         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 412         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 413             return;
 414         }
 415         for (String elanInterface : elanInterfaces) {
 416             ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 417             if (elanInterfaceMac.getMacEntry() != null && elanInterfaceMac.getMacEntry().size() > 0) {
 418                 List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 419                 for (MacEntry macEntry : macEntries) {
 420                     deleteStaticMacAddress(elanInterface, macEntry.getMacAddress().getValue());
 421                 }
 422             }
 423         }
 424
 425     }
 426
 427     @Override
 428     @Nullable
 429     public ElanInstance getElanInstance(String elanName) {
 430         return elanInstanceCache.get(elanName).orNull();
 431     }
 432
 433     @Override
 434     public List<ElanInstance> getElanInstances() {
 435         InstanceIdentifier<ElanInstances> elanInstancesIdentifier = InstanceIdentifier.builder(ElanInstances.class)
 436                 .build();
 437         return ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION, elanInstancesIdentifier).toJavaUtil().map(
 438                 ElanInstances::getElanInstance).orElse(emptyList());
 439     }
 440
 441     @Override
 442     @Nonnull
 443     public List<String> getElanInterfaces(String elanInstanceName) {
 444         List<String> elanInterfaces = new ArrayList<>();
 445         InstanceIdentifier<ElanInterfaces> elanInterfacesIdentifier = InstanceIdentifier.builder(ElanInterfaces.class)
 446                 .build();
 447         Optional<ElanInterfaces> elanInterfacesOptional = ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION,
 448                 elanInterfacesIdentifier);
 449         if (!elanInterfacesOptional.isPresent()) {
 450             return elanInterfaces;
 451         }
 452         List<ElanInterface> elanInterfaceList =
 453             requireNonNullElse(elanInterfacesOptional.get().getElanInterface(), emptyList());
 454         for (ElanInterface elanInterface : elanInterfaceList) {
 455             if (Objects.equals(elanInterface.getElanInstanceName(), elanInstanceName)) {
 456                 elanInterfaces.add(elanInterface.getName());
 457             }
 458         }
 459         return elanInterfaces;
 460     }
 461
 462     @Override
 463     public void createExternalElanNetworks(Node node) {
 464         handleExternalElanNetworks(node, true, (elanInstance, interfaceName) -> {
 465             createExternalElanNetwork(elanInstance, interfaceName);
 466             return null;
 467         });
 468     }
 469
 470     @Override
 471     public void createExternalElanNetwork(ElanInstance elanInstance) {
 472         handleExternalElanNetwork(elanInstance, false, (elanInstance1, interfaceName) -> {
 473             createExternalElanNetwork(elanInstance1, interfaceName);
 474             return null;
 475         });
 476     }
 477
 478     protected void createExternalElanNetwork(ElanInstance elanInstance, BigInteger dpId) {
 479         String providerIntfName = bridgeMgr.getProviderInterfaceName(dpId, elanInstance.getPhysicalNetworkName());
 480         String intfName = providerIntfName + IfmConstants.OF_URI_SEPARATOR + elanInstance.getSegmentationId();
 481         Interface memberIntf = interfaceManager.getInterfaceInfoFromConfigDataStore(intfName);
 482         if (memberIntf == null) {
 483             LOG.debug("creating vlan prv intf in elan {}, dpn {}", elanInstance.getElanInstanceName(),
 484                     dpId);
 485             createExternalElanNetwork(elanInstance, providerIntfName);
 486         }
 487     }
 488
 489     private void createExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 490         if (interfaceName == null) {
 491             LOG.trace("No physical interface is attached to {}", elanInstance.getPhysicalNetworkName());
 492             return;
 493         }
 494
 495         String elanInterfaceName = createIetfInterfaces(elanInstance, interfaceName);
 496         addElanInterface(elanInstance.getElanInstanceName(), elanInterfaceName, null, null);
 497     }
 498
 499     @Override
 500     public void updateExternalElanNetwork(ElanInstance elanInstance) {
 501         handleExternalElanNetwork(elanInstance, true, (elanInstance1, interfaceName) -> {
 502             createExternalElanNetwork(elanInstance1, interfaceName);
 503             return null;
 504         });
 505     }
 506
 507     @Override
 508     public void deleteExternalElanNetworks(Node node) {
 509         handleExternalElanNetworks(node, false, (elanInstance, interfaceName) -> {
 510             deleteExternalElanNetwork(elanInstance, interfaceName);
 511             return null;
 512         });
 513     }
 514
 515     @Override
 516     public void deleteExternalElanNetwork(ElanInstance elanInstance) {
 517         handleExternalElanNetwork(elanInstance, false, (elanInstance1, interfaceName) -> {
 518             deleteExternalElanNetwork(elanInstance1, interfaceName);
 519             return null;
 520         });
 521     }
 522
 523     protected void deleteExternalElanNetwork(ElanInstance elanInstance, BigInteger dpnId) {
 524         String providerIntfName = bridgeMgr.getProviderInterfaceName(dpnId, elanInstance.getPhysicalNetworkName());
 525         String intfName = providerIntfName + IfmConstants.OF_URI_SEPARATOR + elanInstance.getSegmentationId();
 526         Interface memberIntf = interfaceManager.getInterfaceInfoFromConfigDataStore(intfName);
 527         if (memberIntf != null) {
 528             deleteElanInterface(intfName);
 529             deleteIetfInterface(intfName);
 530             LOG.debug("delete vlan prv intf {} in elan {}, dpID {}", intfName,
 531                     elanInstance.getElanInstanceName(), dpnId);
 532         } else {
 533             LOG.debug("vlan prv intf {} not found in interfacemgr config DS", intfName);
 534         }
 535     }
 536
 537     private void deleteExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 538         if (interfaceName == null) {
 539             LOG.trace("No physial interface is attached to {}", elanInstance.getPhysicalNetworkName());
 540             return;
 541         }
 542
 543         String elanInstanceName = elanInstance.getElanInstanceName();
 544         for (String elanInterface : getExternalElanInterfaces(elanInstanceName)) {
 545             if (elanInterface.startsWith(interfaceName)) {
 546                 if (ElanUtils.isVlan(elanInstance)) {
 547                     deleteIetfInterface(elanInterface);
 548                 }
 549                 String trunkInterfaceName = getTrunkInterfaceName(interfaceName);
 550                 if (shouldDeleteTrunk(trunkInterfaceName, elanInterface)) {
 551                     deleteIetfInterface(trunkInterfaceName);
 552                 }
 553                 deleteElanInterface(elanInterface);
 554             }
 555         }
 556     }
 557
 558     private boolean shouldDeleteTrunk(String trunkInterfaceName, String elanInterfaceName) {
 559         List<Interface> childInterfaces = interfaceManager.getChildInterfaces(trunkInterfaceName);
 560         if (childInterfaces == null || childInterfaces.isEmpty()
 561                 || childInterfaces.size() == 1 && elanInterfaceName.equals(childInterfaces.get(0).getName())) {
 562             LOG.debug("No more VLAN member interfaces left for trunk {}", trunkInterfaceName);
 563             return true;
 564         }
 565
 566         LOG.debug("Trunk interface {} has {} VLAN member interfaces left", trunkInterfaceName, childInterfaces.size());
 567         return false;
 568     }
 569
 570     @Override
 571     public void updateExternalElanNetworks(Node origNode, Node updatedNode) {
 572         if (!bridgeMgr.isIntegrationBridge(updatedNode)) {
 573             return;
 574         }
 575
 576         List<ElanInstance> elanInstances = getElanInstances();
 577         if (elanInstances == null || elanInstances.isEmpty()) {
 578             LOG.trace("No ELAN instances found");
 579             return;
 580         }
 581
 582         LOG.debug("updateExternalElanNetworks, orig bridge {} . updated bridge {}", origNode, updatedNode);
 583
 584         Map<String, String> origProviderMappping = getMapFromOtherConfig(origNode,
 585                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 586         Map<String, String> updatedProviderMappping = getMapFromOtherConfig(updatedNode,
 587                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 588
 589         boolean hasDatapathIdOnOrigNode = bridgeMgr.hasDatapathID(origNode);
 590         boolean hasDatapathIdOnUpdatedNode = bridgeMgr.hasDatapathID(updatedNode);
 591         BigInteger origDpnID = bridgeMgr.getDatapathId(origNode);
 592
 593         for (ElanInstance elanInstance : elanInstances) {
 594             String physicalNetworkName = elanInstance.getPhysicalNetworkName();
 595             boolean createExternalElanNw = true;
 596             if (physicalNetworkName != null) {
 597                 String origPortName = origProviderMappping.get(physicalNetworkName);
 598                 String updatedPortName = updatedProviderMappping.get(physicalNetworkName);
 599                 /**
 600                  * for internal vlan network, vlan provider interface creation should be
 601                  * triggered only if there is existing vlan provider intf indicating presence
 602                  * of VM ports on the DPN
 603                  */
 604                 if (hasDatapathIdOnOrigNode && !elanInstance.isExternal()
 605                         && ElanUtils.isVlan(elanInstance)) {
 606                     String externalIntf = getExternalElanInterface(elanInstance.getElanInstanceName(),
 607                             origDpnID);
 608                     if (externalIntf == null) {
 609                         createExternalElanNw = false;
 610                     }
 611                 }
 612                 if (hasPortNameRemoved(origPortName, updatedPortName)) {
 613                     deleteExternalElanNetwork(elanInstance,
 614                             bridgeMgr.getProviderInterfaceName(origNode, physicalNetworkName));
 615                 }
 616
 617                 if (createExternalElanNw && (hasPortNameUpdated(origPortName, updatedPortName)
 618                         || hasDatapathIdAdded(hasDatapathIdOnOrigNode, hasDatapathIdOnUpdatedNode))) {
 619                     createExternalElanNetwork(elanInstance,
 620                             bridgeMgr.getProviderInterfaceName(updatedNode, physicalNetworkName));
 621                 }
 622             }
 623         }
 624     }
 625
 626     private boolean hasDatapathIdAdded(boolean hasDatapathIdOnOrigNode, boolean hasDatapathIdOnUpdatedNode) {
 627         return !hasDatapathIdOnOrigNode && hasDatapathIdOnUpdatedNode;
 628     }
 629
 630     private boolean hasPortNameUpdated(String origPortName, String updatedPortName) {
 631         return updatedPortName != null && !updatedPortName.equals(origPortName);
 632     }
 633
 634     private boolean hasPortNameRemoved(String origPortName, String updatedPortName) {
 635         return origPortName != null && !origPortName.equals(updatedPortName);
 636     }
 637
 638     private Map<String, String> getMapFromOtherConfig(Node node, String otherConfigColumn) {
 639         return bridgeMgr.getOpenvswitchOtherConfigMap(node, otherConfigColumn);
 640     }
 641
 642     @Override
 643     public Collection<String> getExternalElanInterfaces(String elanInstanceName) {
 644         List<String> elanInterfaces = getElanInterfaces(elanInstanceName);
 645         if (elanInterfaces.isEmpty()) {
 646             LOG.trace("No ELAN interfaces defined for {}", elanInstanceName);
 647             return Collections.emptySet();
 648         }
 649
 650         Set<String> externalElanInterfaces = new HashSet<>();
 651         for (String elanInterface : elanInterfaces) {
 652             if (interfaceManager.isExternalInterface(elanInterface)) {
 653                 externalElanInterfaces.add(elanInterface);
 654             }
 655         }
 656
 657         return externalElanInterfaces;
 658     }
 659
 660     @Override
 661     public String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
 662         return elanUtils.getExternalElanInterface(elanInstanceName, dpnId);
 663     }
 664
 665     @Override
 666     public boolean isExternalInterface(String interfaceName) {
 667         return interfaceManager.isExternalInterface(interfaceName);
 668     }
 669
 670     @Override
 671     @Nullable
 672     public ElanInterface getElanInterfaceByElanInterfaceName(String interfaceName) {
 673         return elanInterfaceCache.get(interfaceName).orNull();
 674     }
 675
 676     @Override
 677     public void handleKnownL3DmacAddress(String macAddress, String elanInstanceName, int addOrRemove) {
 678         if (addOrRemove == NwConstants.ADD_FLOW) {
 679             addKnownL3DmacAddress(macAddress, elanInstanceName);
 680         } else {
 681             removeKnownL3DmacAddress(macAddress, elanInstanceName);
 682         }
 683     }
 684
 685     @Override
 686     public void addKnownL3DmacAddress(String macAddress, String elanInstanceName) {
 687         if (!isL2BeforeL3) {
 688             LOG.trace("ELAN service is after L3VPN in the Netvirt pipeline skip known L3DMAC flows installation");
 689             return;
 690         }
 691         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 692         if (elanInstance == null) {
 693             LOG.warn("Null elan instance {}", elanInstanceName);
 694             return;
 695         }
 696
 697         List<BigInteger> dpnsIdsForElanInstance = elanUtils.getParticipatingDpnsInElanInstance(elanInstanceName);
 698         if (dpnsIdsForElanInstance.isEmpty()) {
 699             LOG.warn("No DPNs for elan instance {}", elanInstance);
 700             return;
 701         }
 702
 703         elanUtils.addDmacRedirectToDispatcherFlows(elanInstance.getElanTag(), elanInstanceName, macAddress,
 704                 dpnsIdsForElanInstance);
 705     }
 706
 707     @Override
 708     public void removeKnownL3DmacAddress(String macAddress, String elanInstanceName) {
 709         if (!isL2BeforeL3) {
 710             LOG.trace("ELAN service is after L3VPN in the Netvirt pipeline skip known L3DMAC flows installation");
 711             return;
 712         }
 713         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 714         if (elanInstance == null) {
 715             LOG.warn("Null elan instance {}", elanInstanceName);
 716             return;
 717         }
 718
 719         List<BigInteger> dpnsIdsForElanInstance = elanUtils.getParticipatingDpnsInElanInstance(elanInstanceName);
 720         if (dpnsIdsForElanInstance.isEmpty()) {
 721             LOG.warn("No DPNs for elan instance {}", elanInstance);
 722             return;
 723         }
 724
 725         elanUtils.removeDmacRedirectToDispatcherFlows(elanInstance.getElanTag(), macAddress, dpnsIdsForElanInstance);
 726     }
 727
 728     @Override
 729     public List<MatchInfoBase> getEgressMatchesForElanInstance(String elanInstanceName) {
 730         ElanInstance elanInstance = getElanInstance(elanInstanceName);
 731         if (elanInstance == null) {
 732             LOG.debug("No ELAN instance found for {}", elanInstanceName);
 733             return emptyList();
 734         }
 735
 736         Long elanTag = elanInstance.getElanTag();
 737         if (elanTag == null) {
 738             LOG.debug("No ELAN tag found for {}", elanInstanceName);
 739             return emptyList();
 740         }
 741         return Collections.singletonList(
 742                 new NxMatchRegister(ElanConstants.ELAN_REG_ID, elanTag, MetaDataUtil.getElanMaskForReg()));
 743     }
 744
 745     /**
 746      * Create ietf-interfaces based on the ELAN segment type.<br>
 747      * For segment type flat - create transparent interface pointing to the
 748      * patch-port attached to the physnet port.<br>
 749      * For segment type vlan - create trunk interface pointing to the patch-port
 750      * attached to the physnet port + trunk-member interface pointing to the
 751      * trunk interface.
 752      *
 753      * @param elanInstance
 754      *            ELAN instance
 755      * @param parentRef
 756      *            parent interface name
 757      * @return the name of the interface to be added to the ELAN instance i.e.
 758      *         trunk-member name for vlan network and transparent for flat
 759      *         network or null otherwise
 760      */
 761     private String createIetfInterfaces(ElanInstance elanInstance, String parentRef) {
 762         String interfaceName = null;
 763
 764         try {
 765             String trunkName = getTrunkInterfaceName(parentRef);
 766             // trunk interface may have been created by other vlan network
 767             Interface trunkInterface = interfaceManager.getInterfaceInfoFromConfigDataStore(trunkName);
 768             if (trunkInterface == null) {
 769                 interfaceManager.createVLANInterface(trunkName, parentRef, null, null,
 770                         IfL2vlan.L2vlanMode.Trunk, true);
 771             }
 772             if (ElanUtils.isFlat(elanInstance)) {
 773                 interfaceName = trunkName;
 774             } else if (ElanUtils.isVlan(elanInstance)) {
 775                 Long segmentationId = elanInstance.getSegmentationId();
 776                 interfaceName = parentRef + IfmConstants.OF_URI_SEPARATOR + segmentationId;
 777                 interfaceManager.createVLANInterface(interfaceName, trunkName, segmentationId.intValue(), null,
 778                         IfL2vlan.L2vlanMode.TrunkMember, true);
 779             }
 780         } catch (InterfaceAlreadyExistsException e) {
 781             LOG.trace("Interface {} was already created", interfaceName);
 782         }
 783
 784         return interfaceName;
 785     }
 786
 787     private void deleteIetfInterface(String interfaceName) {
 788         InterfaceKey interfaceKey = new InterfaceKey(interfaceName);
 789         InstanceIdentifier<Interface> interfaceInstanceIdentifier = InstanceIdentifier.builder(Interfaces.class)
 790                 .child(Interface.class, interfaceKey).build();
 791         MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 792         LOG.debug("Deleting IETF interface {}", interfaceName);
 793     }
 794
 795     private void handleExternalElanNetworks(Node node, boolean skipIntVlanNw,
 796                                             BiFunction<ElanInstance, String, Void> function) {
 797         if (!bridgeMgr.isIntegrationBridge(node)) {
 798             return;
 799         }
 800
 801         List<ElanInstance> elanInstances = getElanInstances();
 802         if (elanInstances == null || elanInstances.isEmpty()) {
 803             LOG.trace("No ELAN instances found");
 804             return;
 805         }
 806
 807         for (ElanInstance elanInstance : elanInstances) {
 808             if (skipIntVlanNw && !elanInstance.isExternal() && ElanUtils.isVlan(elanInstance)) {
 809                 continue;
 810             }
 811             String interfaceName = bridgeMgr.getProviderInterfaceName(node, elanInstance.getPhysicalNetworkName());
 812             if (interfaceName != null) {
 813                 function.apply(elanInstance, interfaceName);
 814             }
 815         }
 816     }
 817
 818     private void handleExternalElanNetwork(ElanInstance elanInstance, boolean update,
 819                                            BiFunction<ElanInstance, String, Void> function) {
 820         String elanInstanceName = elanInstance.getElanInstanceName();
 821         if (elanInstance.getPhysicalNetworkName() == null) {
 822             LOG.trace("No physical network attached to {}", elanInstanceName);
 823             return;
 824         }
 825
 826         List<Node> nodes = southboundUtils.getOvsdbNodes();
 827         if (nodes == null || nodes.isEmpty()) {
 828             LOG.trace("No OVS nodes found while creating external network for ELAN {}",
 829                     elanInstance.getElanInstanceName());
 830             return;
 831         }
 832
 833         for (Node node : nodes) {
 834             if (bridgeMgr.isIntegrationBridge(node)) {
 835                 if (update && !elanInstance.isExternal()) {
 836                     DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName,
 837                             bridgeMgr.getDatapathId(node));
 838                     if (dpnInterfaces == null || dpnInterfaces.getInterfaces().isEmpty()) {
 839                         continue;
 840                     }
 841                 }
 842                 String interfaceName = bridgeMgr.getProviderInterfaceName(node, elanInstance.getPhysicalNetworkName());
 843                 function.apply(elanInstance, interfaceName);
 844             }
 845         }
 846     }
 847
 848     private String getTrunkInterfaceName(String parentRef) {
 849         return parentRef + IfmConstants.OF_URI_SEPARATOR + "trunk";
 850     }
 851
 852     private void setIsL2BeforeL3() {
 853         short elanServiceRealIndex = ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME,
 854                 NwConstants.ELAN_SERVICE_INDEX);
 855         short l3vpnServiceRealIndex = ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
 856                 NwConstants.L3VPN_SERVICE_INDEX);
 857         if (elanServiceRealIndex < l3vpnServiceRealIndex) {
 858             LOG.info("ELAN service is set before L3VPN service in the Netvirt pipeline");
 859             isL2BeforeL3 = true;
 860         } else {
 861             LOG.info("ELAN service is set after L3VPN service in the Netvirt pipeline");
 862             isL2BeforeL3 = false;
 863         }
 864     }
 865
 866     @Override
 867     public void addArpResponderFlow(ArpResponderInput arpResponderInput) {
 868         String ingressInterfaceName = arpResponderInput.getInterfaceName();
 869         String macAddress = arpResponderInput.getSha();
 870         String ipAddress = arpResponderInput.getSpa();
 871         int lportTag = arpResponderInput.getLportTag();
 872         BigInteger dpnId = arpResponderInput.getDpId();
 873
 874         LOG.info("Installing the ARP responder flow on DPN {} for Interface {} with MAC {} & IP {}", dpnId,
 875                 ingressInterfaceName, macAddress, ipAddress);
 876         Optional<ElanInterface> elanIface = elanInterfaceCache.get(ingressInterfaceName);
 877         ElanInstance elanInstance = elanIface.isPresent()
 878                 ? elanInstanceCache.get(elanIface.get().getElanInstanceName()).orNull() : null;
 879         if (elanInstance == null) {
 880             LOG.debug("addArpResponderFlow: elanInstance is null, Failed to install arp responder flow for dpnId {}"
 881                     + "for Interface {} with MAC {} & IP {}", dpnId, ingressInterfaceName, macAddress, ipAddress);
 882             return;
 883         }
 884         String flowId = ArpResponderUtil.getFlowId(lportTag, ipAddress);
 885         Flow flowEntity =
 886             MDSALUtil.buildFlowNew(NwConstants.ARP_RESPONDER_TABLE, flowId, NwConstants.DEFAULT_ARP_FLOW_PRIORITY,
 887                 flowId, 0, 0,
 888                 ArpResponderUtil.generateCookie(lportTag, ipAddress),
 889                 ArpResponderUtil.getMatchCriteria(lportTag, elanInstance, ipAddress),
 890                 arpResponderInput.getInstructions());
 891         ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
 892             tx -> mdsalManager.addFlow(tx, dpnId, flowEntity)), LOG, "Error adding flow {}", flowEntity);
 893         LOG.info("Installed the ARP Responder flow for Interface {}", ingressInterfaceName);
 894     }
 895
 896     @Override
 897     public void addExternalTunnelArpResponderFlow(ArpResponderInput arpResponderInput, String elanInstanceName) {
 898         BigInteger dpnId = arpResponderInput.getDpId();
 899         String ipAddress = arpResponderInput.getSpa();
 900         String macAddress = arpResponderInput.getSha();
 901
 902         LOG.trace("Installing the ExternalTunnel ARP responder flow on DPN {} for ElanInstance {} with MAC {} & IP {}",
 903                 dpnId, elanInstanceName, macAddress, ipAddress);
 904
 905         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 906         if (elanInstance == null) {
 907             LOG.warn("Null elan instance {}", elanInstanceName);
 908             return;
 909         }
 910
 911         int lportTag = arpResponderInput.getLportTag();
 912         String flowId = ArpResponderUtil.getFlowId(lportTag, ipAddress);
 913         Flow flowEntity =
 914             MDSALUtil.buildFlowNew(NwConstants.ARP_RESPONDER_TABLE, flowId, NwConstants.DEFAULT_ARP_FLOW_PRIORITY,
 915                 flowId, 0, 0,
 916                 ArpResponderUtil.generateCookie(lportTag, ipAddress),
 917                 ArpResponderUtil.getMatchCriteria(lportTag, elanInstance, ipAddress),
 918                 arpResponderInput.getInstructions());
 919         ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
 920             tx -> mdsalManager.addFlow(tx, dpnId, flowEntity)), LOG, "Error adding flow {}", flowEntity);
 921         LOG.trace("Installed the ExternalTunnel ARP Responder flow for ElanInstance {}", elanInstanceName);
 922     }
 923
 924     @Override
 925     public void removeArpResponderFlow(ArpResponderInput arpResponderInput) {
 926         elanUtils.removeArpResponderFlow(arpResponderInput.getDpId(), arpResponderInput.getInterfaceName(),
 927                 arpResponderInput.getSpa(), arpResponderInput.getLportTag());
 928     }
 929
 930     /**
 931      * Uses the IdManager to retrieve a brand new ElanTag.
 932      *
 933      * @param idKey
 934      *            the id key
 935      * @return the integer
 936      */
 937     @Override
 938     public Long retrieveNewElanTag(String idKey) {
 939         return elanUtils.retrieveNewElanTag(idManager, idKey);
 940     }
 941
 942     @Override
 943     public InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(
 944                                                                 String elanInstanceName, BigInteger dpnId) {
 945         return ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpnId);
 946     }
 947
 948     @Override
 949     public DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
 950         return elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName, dpId);
 951     }
 952
 953 }