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