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

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netvirt.elan.internal;
  10
  11 import com.google.common.base.Optional;
  12 import java.math.BigInteger;
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.Collections;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Set;
  20 import java.util.concurrent.Future;
  21 import java.util.function.BiFunction;
  22 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  23 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.genius.interfacemanager.exceptions.InterfaceAlreadyExistsException;
  26 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  27 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  28 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  29 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  30 import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayMulticastUtils;
  31 import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayUtils;
  32 import org.opendaylight.netvirt.elan.l2gw.utils.L2GatewayConnectionUtils;
  33 import org.opendaylight.netvirt.elan.statusanddiag.ElanStatusMonitor;
  34 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  35 import org.opendaylight.netvirt.elan.utils.ElanForwardingEntriesHandler;
  36 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  37 import org.opendaylight.netvirt.elanmanager.api.IElanService;
  38 import org.opendaylight.netvirt.elanmanager.exceptions.MacNotFoundException;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInputBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstanceBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterfaceBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
  66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.common.RpcResult;
  69 import org.slf4j.Logger;
  70 import org.slf4j.LoggerFactory;
  71
  72 public class ElanServiceProvider implements IElanService {
  73
  74     private static final Logger logger = LoggerFactory.getLogger(ElanServiceProvider.class);
  75
  76     private final IdManagerService idManager;
  77     private final IInterfaceManager interfaceManager;
  78     private final ElanInstanceManager elanInstanceManager;
  79     private final ElanBridgeManager bridgeMgr;
  80     private final DataBroker broker;
  81     private final ElanStatusMonitor elanStatusMonitor;
  82     private static ElanUtils elanUtils;
  83
  84     private boolean generateIntBridgeMac = true;
  85
  86     public ElanServiceProvider(IdManagerService idManager, IInterfaceManager interfaceManager,
  87                                ElanInstanceManager elanInstanceManager, ElanBridgeManager bridgeMgr,
  88                                DataBroker dataBroker,
  89                                ElanInterfaceManager elanInterfaceManager,
  90                                ElanStatusMonitor elanStatusMonitor, ElanUtils elanUtils) {
  91         this.idManager = idManager;
  92         this.interfaceManager = interfaceManager;
  93         this.elanInstanceManager = elanInstanceManager;
  94         this.bridgeMgr = bridgeMgr;
  95         this.broker = dataBroker;
  96         this.elanStatusMonitor = elanStatusMonitor;
  97         this.elanUtils = elanUtils;
  98         elanInstanceManager.setElanUtils(elanUtils);
  99         elanInterfaceManager.setElanUtils(elanUtils);
 100     }
 101
 102     public static ElanUtils getElanutils() {
 103         return ElanServiceProvider.elanUtils;
 104     }
 105
 106     public void init() {
 107         logger.info("Starting ElnaServiceProvider");
 108         elanStatusMonitor.reportStatus("STARTING");
 109         try {
 110             createIdPool();
 111
 112             elanStatusMonitor.reportStatus("OPERATIONAL");
 113         } catch (Exception e) {
 114             logger.error("Error initializing services", e);
 115             elanStatusMonitor.reportStatus("ERROR");
 116         }
 117     }
 118
 119     private void createIdPool() {
 120         CreateIdPoolInput createPool = new CreateIdPoolInputBuilder().setPoolName(ElanConstants.ELAN_ID_POOL_NAME)
 121                 .setLow(ElanConstants.ELAN_ID_LOW_VALUE).setHigh(ElanConstants.ELAN_ID_HIGH_VALUE).build();
 122         try {
 123             Future<RpcResult<Void>> result = idManager.createIdPool(createPool);
 124             if ((result != null) && (result.get().isSuccessful())) {
 125                 logger.debug("ELAN Id Pool is created successfully");
 126             }
 127         } catch (Exception e) {
 128             logger.error("Failed to create ELAN Id pool {}", e);
 129         }
 130     }
 131
 132     @Override
 133     public boolean createElanInstance(String elanInstanceName, long macTimeout, String description) {
 134         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 135         boolean isSuccess = true;
 136         if (existingElanInstance != null) {
 137             if (compareWithExistingElanInstance(existingElanInstance, macTimeout, description)) {
 138                 logger.debug("Elan Instance is already present in the Operational DS {}", existingElanInstance);
 139                 return true;
 140             } else {
 141                 ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 142                         .setDescription(description).setMacTimeout(macTimeout)
 143                         .setKey(new ElanInstanceKey(elanInstanceName)).build();
 144                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 145                         ElanUtils.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 146                 logger.debug("Updating the Elan Instance {} with MAC TIME-OUT %l and Description %s ",
 147                         updateElanInstance, macTimeout, description);
 148             }
 149         } else {
 150             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 151                     .setMacTimeout(macTimeout).setDescription(description).setKey(new ElanInstanceKey(elanInstanceName))
 152                     .build();
 153             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 154                     ElanUtils.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 155             logger.debug("Creating the new Elan Instance {}", elanInstance);
 156         }
 157         return isSuccess;
 158     }
 159
 160     @Override
 161     public boolean createEtreeInstance(String elanInstanceName, long macTimeout, String description) {
 162         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 163         boolean isSuccess = true;
 164         if (existingElanInstance != null) {
 165             if (compareWithExistingElanInstance(existingElanInstance, macTimeout, description)) {
 166                 logger.warn("Etree Instance is already present in the Operational DS {}", existingElanInstance);
 167                 return true;
 168             } else {
 169                 EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
 170                 ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 171                         .setDescription(description).setMacTimeout(macTimeout)
 172                         .setKey(new ElanInstanceKey(elanInstanceName))
 173                         .addAugmentation(EtreeInstance.class, etreeInstance).build();
 174                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 175                         ElanUtils.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 176                 logger.debug("Updating the Etree Instance {} with MAC TIME-OUT %l and Description %s ",
 177                         updateElanInstance, macTimeout, description);
 178             }
 179         } else {
 180             EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
 181             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 182                     .setMacTimeout(macTimeout).setDescription(description).setKey(new ElanInstanceKey(elanInstanceName))
 183                     .addAugmentation(EtreeInstance.class, etreeInstance).build();
 184             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 185                     ElanUtils.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 186             logger.debug("Creating the new Etree Instance {}", elanInstance);
 187         }
 188         return isSuccess;
 189     }
 190
 191     public static boolean compareWithExistingElanInstance(ElanInstance existingElanInstance, long macTimeOut,
 192             String description) {
 193         boolean isEqual = false;
 194         if (existingElanInstance.getMacTimeout() == macTimeOut
 195                 && existingElanInstance.getDescription().equals(description)) {
 196             isEqual = true;
 197         }
 198         return isEqual;
 199     }
 200
 201     @Override
 202     public void updateElanInstance(String elanInstanceName, long newMacTimout, String newDescription) {
 203         createElanInstance(elanInstanceName, newMacTimout, newDescription);
 204     }
 205
 206     @Override
 207     public boolean deleteEtreeInstance(String etreeInstanceName) {
 208         return deleteElanInstance(etreeInstanceName);
 209     }
 210
 211     @Override
 212     public boolean deleteElanInstance(String elanInstanceName) {
 213         boolean isSuccess = false;
 214         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 215         if (existingElanInstance == null) {
 216             logger.debug("Elan Instance is not present {}", existingElanInstance);
 217             return isSuccess;
 218         }
 219         logger.debug("Deletion of the existing Elan Instance {}", existingElanInstance);
 220         ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 221                 ElanUtils.getElanInstanceConfigurationDataPath(elanInstanceName));
 222         isSuccess = true;
 223         return isSuccess;
 224     }
 225
 226     @Override
 227     public void addEtreeInterface(String etreeInstanceName, String interfaceName, EtreeInterfaceType interfaceType,
 228             List<String> staticMacAddresses, String description) {
 229         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(etreeInstanceName);
 230         if (existingElanInstance != null && existingElanInstance.getAugmentation(EtreeInstance.class) != null) {
 231             EtreeInterface etreeInterface = new EtreeInterfaceBuilder().setEtreeInterfaceType(interfaceType).build();
 232             ElanInterface elanInterface;
 233             if (staticMacAddresses == null) {
 234                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 235                         .setDescription(description).setName(interfaceName).setKey(new ElanInterfaceKey(interfaceName))
 236                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 237             } else {
 238                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 239                         .setDescription(description).setName(interfaceName)
 240                         .setStaticMacEntries(getPhysAddress(staticMacAddresses))
 241                         .setKey(new ElanInterfaceKey(interfaceName))
 242                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 243             }
 244             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 245                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 246             logger.debug("Creating the new Etree Interface {}", elanInterface);
 247         }
 248     }
 249
 250     @Override
 251     public void addElanInterface(String elanInstanceName, String interfaceName, List<String> staticMacAddresses,
 252             String description) {
 253         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 254         if (existingElanInstance != null) {
 255             ElanInterface elanInterface;
 256             if (staticMacAddresses == null) {
 257                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 258                         .setDescription(description).setName(interfaceName).setKey(new ElanInterfaceKey(interfaceName))
 259                         .build();
 260             } else {
 261                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 262                         .setDescription(description).setName(interfaceName)
 263                         .setStaticMacEntries(getPhysAddress(staticMacAddresses))
 264                         .setKey(new ElanInterfaceKey(interfaceName)).build();
 265             }
 266             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 267                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 268             logger.debug("Creating the new ELan Interface {}", elanInterface);
 269         }
 270     }
 271
 272     @Override
 273     public void updateElanInterface(String elanInstanceName, String interfaceName,
 274             List<String> updatedStaticMacAddresses, String newDescription) {
 275         ElanInterface existingElanInterface = elanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 276         if (existingElanInterface == null) {
 277             return;
 278         }
 279         List<PhysAddress> existingMacAddress = existingElanInterface.getStaticMacEntries();
 280         List<PhysAddress> updatedMacAddresses = getPhysAddress(updatedStaticMacAddresses);
 281         List<PhysAddress> updatedPhysAddress = getUpdatedPhyAddress(existingMacAddress, updatedMacAddresses);
 282         if (updatedPhysAddress.size() > 0) {
 283             logger.debug("updating the ElanInterface with new Mac Entries {}", updatedStaticMacAddresses);
 284             ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 285                     .setName(interfaceName).setDescription(newDescription).setStaticMacEntries(updatedPhysAddress)
 286                     .setKey(new ElanInterfaceKey(interfaceName)).build();
 287             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 288                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 289         }
 290     }
 291
 292     @Override
 293     public void deleteEtreeInterface(String elanInstanceName, String interfaceName) {
 294         deleteElanInterface(elanInstanceName, interfaceName);
 295         logger.debug("deleting the Etree Interface {}", interfaceName);
 296     }
 297
 298     @Override
 299     public void deleteElanInterface(String elanInstanceName, String interfaceName) {
 300         ElanInterface existingElanInterface = elanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 301         if (existingElanInterface != null) {
 302             ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 303                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName));
 304             logger.debug("deleting the Elan Interface {}", existingElanInterface);
 305         }
 306     }
 307
 308     @Override
 309     public void addStaticMacAddress(String elanInstanceName, String interfaceName, String macAddress) {
 310         ElanInterface existingElanInterface = elanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 311         PhysAddress updateStaticMacAddress = new PhysAddress(macAddress);
 312         if (existingElanInterface != null) {
 313             List<PhysAddress> existingMacAddress = existingElanInterface.getStaticMacEntries();
 314             if (existingMacAddress.contains(updateStaticMacAddress)) {
 315                 return;
 316             }
 317             existingMacAddress.add(updateStaticMacAddress);
 318             ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 319                     .setName(interfaceName).setStaticMacEntries(existingMacAddress)
 320                     .setDescription(existingElanInterface.getDescription()).setKey(new ElanInterfaceKey(interfaceName))
 321                     .build();
 322             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 323                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 324         }
 325     }
 326
 327     @Override
 328     public void deleteStaticMacAddress(String elanInstanceName, String interfaceName, String macAddress)
 329             throws MacNotFoundException {
 330         ElanInterface existingElanInterface = elanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 331         PhysAddress physAddress = new PhysAddress(macAddress);
 332         if (existingElanInterface == null) {
 333             return;
 334         }
 335         List<PhysAddress> existingMacAddress = existingElanInterface.getStaticMacEntries();
 336         if (existingMacAddress.contains(physAddress)) {
 337             existingMacAddress.remove(physAddress);
 338             ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 339                     .setName(interfaceName).setStaticMacEntries(existingMacAddress)
 340                     .setDescription(existingElanInterface.getDescription()).setKey(new ElanInterfaceKey(interfaceName))
 341                     .build();
 342             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 343                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 344         } else {
 345             throw new MacNotFoundException("Mac Not Found Exception");
 346         }
 347     }
 348
 349     @Override
 350     public Collection<MacEntry> getElanMacTable(String elanInstanceName) {
 351         Elan elanInfo = elanUtils.getElanByName(elanInstanceName);
 352         List<MacEntry> macAddress = new ArrayList<>();
 353         if (elanInfo == null) {
 354             return macAddress;
 355         }
 356         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 357         if (elanInterfaces != null && elanInterfaces.size() > 0) {
 358             for (String elanInterface : elanInterfaces) {
 359                 ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 360                 if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null
 361                         && elanInterfaceMac.getMacEntry().size() > 0) {
 362                     macAddress.addAll(elanInterfaceMac.getMacEntry());
 363                 }
 364             }
 365         }
 366         return macAddress;
 367     }
 368
 369     @Override
 370     public void flushMACTable(String elanInstanceName) {
 371         Elan elanInfo = elanUtils.getElanByName(elanInstanceName);
 372         if (elanInfo == null) {
 373             return;
 374         }
 375         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 376         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 377             return;
 378         }
 379         for (String elanInterface : elanInterfaces) {
 380             ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 381             if (elanInterfaceMac.getMacEntry() != null && elanInterfaceMac.getMacEntry().size() > 0) {
 382                 List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 383                 for (MacEntry macEntry : macEntries) {
 384                     try {
 385                         deleteStaticMacAddress(elanInstanceName, elanInterface, macEntry.getMacAddress().getValue());
 386                     } catch (MacNotFoundException e) {
 387                         logger.error("Mac Not Found Exception {}", e);
 388                         e.printStackTrace();
 389                     }
 390                 }
 391             }
 392         }
 393
 394     }
 395
 396     public static List<PhysAddress> getPhysAddress(List<String> macAddress) {
 397         List<PhysAddress> physAddresses = new ArrayList<>();
 398         for (String mac : macAddress) {
 399             physAddresses.add(new PhysAddress(mac));
 400         }
 401         return physAddresses;
 402     }
 403
 404     public List<PhysAddress> getUpdatedPhyAddress(List<PhysAddress> originalAddresses,
 405             List<PhysAddress> updatePhyAddresses) {
 406         if (updatePhyAddresses != null && !updatePhyAddresses.isEmpty()) {
 407             List<PhysAddress> existingClonedPhyAddress = new ArrayList<>();
 408             if (originalAddresses != null && !originalAddresses.isEmpty()) {
 409                 existingClonedPhyAddress.addAll(0, originalAddresses);
 410                 originalAddresses.removeAll(updatePhyAddresses);
 411                 updatePhyAddresses.removeAll(existingClonedPhyAddress);
 412             }
 413         }
 414         return updatePhyAddresses;
 415     }
 416
 417     @Override
 418     public ElanInstance getElanInstance(String elanName) {
 419         return elanUtils.getElanInstanceByName(elanName);
 420     }
 421
 422     @Override
 423     public List<ElanInstance> getElanInstances() {
 424         List<ElanInstance> elanList = new ArrayList<>();
 425         InstanceIdentifier<ElanInstances> elanInstancesIdentifier = InstanceIdentifier.builder(ElanInstances.class)
 426                 .build();
 427         Optional<ElanInstances> elansOptional = elanUtils.read(broker, LogicalDatastoreType.CONFIGURATION,
 428                 elanInstancesIdentifier);
 429         if (elansOptional.isPresent()) {
 430             elanList.addAll(elansOptional.get().getElanInstance());
 431         }
 432         return elanList;
 433     }
 434
 435     @Override
 436     public List<String> getElanInterfaces(String elanInstanceName) {
 437         List<String> elanInterfaces = new ArrayList<>();
 438         InstanceIdentifier<ElanInterfaces> elanInterfacesIdentifier = InstanceIdentifier.builder(ElanInterfaces.class)
 439                 .build();
 440         Optional<ElanInterfaces> elanInterfacesOptional = elanUtils.read(broker, LogicalDatastoreType.CONFIGURATION,
 441                 elanInterfacesIdentifier);
 442         if (!elanInterfacesOptional.isPresent()) {
 443             return elanInterfaces;
 444         }
 445         List<ElanInterface> elanInterfaceList = elanInterfacesOptional.get().getElanInterface();
 446         for (ElanInterface elanInterface : elanInterfaceList) {
 447             if (elanInterface.getElanInstanceName().equals(elanInstanceName)) {
 448                 elanInterfaces.add(elanInterface.getName());
 449             }
 450         }
 451         return elanInterfaces;
 452     }
 453
 454     public boolean getGenerateIntBridgeMac() {
 455         return generateIntBridgeMac;
 456     }
 457
 458     public void setGenerateIntBridgeMac(boolean generateIntBridgeMac) {
 459         this.generateIntBridgeMac = generateIntBridgeMac;
 460     }
 461
 462     @Override
 463     public void createExternalElanNetworks(Node node) {
 464         handleExternalElanNetworks(node, new BiFunction<ElanInstance, String, Void>() {
 465
 466             @Override
 467             public Void apply(ElanInstance elanInstance, String interfaceName) {
 468                 createExternalElanNetwork(elanInstance, interfaceName);
 469                 return null;
 470             }
 471         });
 472     }
 473
 474     @Override
 475     public void createExternalElanNetwork(ElanInstance elanInstance) {
 476         handleExternalElanNetwork(elanInstance, new BiFunction<ElanInstance, String, Void>() {
 477
 478             @Override
 479             public Void apply(ElanInstance elanInstance, String interfaceName) {
 480                 createExternalElanNetwork(elanInstance, interfaceName);
 481                 return null;
 482             }
 483
 484         });
 485     }
 486
 487     @Override
 488     public void deleteExternalElanNetworks(Node node) {
 489         handleExternalElanNetworks(node, new BiFunction<ElanInstance, String, Void>() {
 490
 491             @Override
 492             public Void apply(ElanInstance elanInstance, String interfaceName) {
 493                 deleteExternalElanNetwork(elanInstance, interfaceName);
 494                 return null;
 495             }
 496         });
 497     }
 498
 499     @Override
 500     public void deleteExternalElanNetwork(ElanInstance elanInstance) {
 501         handleExternalElanNetwork(elanInstance, new BiFunction<ElanInstance, String, Void>() {
 502
 503             @Override
 504             public Void apply(ElanInstance elanInstance, String interfaceName) {
 505                 deleteExternalElanNetwork(elanInstance, interfaceName);
 506                 return null;
 507             }
 508
 509         });
 510     }
 511
 512     @Override
 513     public void updateExternalElanNetworks(Node origNode, Node updatedNode) {
 514         if (!bridgeMgr.isIntegrationBridge(updatedNode)) {
 515             return;
 516         }
 517
 518         List<ElanInstance> elanInstances = getElanInstances();
 519         if (elanInstances == null || elanInstances.isEmpty()) {
 520             logger.trace("No ELAN instances found");
 521             return;
 522         }
 523
 524         Optional<Map<String, String>> origProviderMapOpt = bridgeMgr.getOpenvswitchOtherConfigMap(origNode,
 525                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 526         Optional<Map<String, String>> updatedProviderMapOpt = bridgeMgr.getOpenvswitchOtherConfigMap(updatedNode,
 527                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 528         Map<String, String> origProviderMappping = origProviderMapOpt.or(Collections.emptyMap());
 529         Map<String, String> updatedProviderMappping = updatedProviderMapOpt.or(Collections.emptyMap());
 530
 531         for (ElanInstance elanInstance : elanInstances) {
 532             String physicalNetworkName = elanInstance.getPhysicalNetworkName();
 533             if (physicalNetworkName != null) {
 534                 String origPortName = origProviderMappping.get(physicalNetworkName);
 535                 String updatedPortName = updatedProviderMappping.get(physicalNetworkName);
 536                 if (origPortName != null && !origPortName.equals(updatedPortName)) {
 537                     deleteExternalElanNetwork(elanInstance, getExtInterfaceName(origNode, physicalNetworkName));
 538                 }
 539                 if (updatedPortName != null && !updatedPortName.equals(origPortName)) {
 540                     createExternalElanNetwork(elanInstance, getExtInterfaceName(updatedNode, updatedPortName));
 541                 }
 542             }
 543         }
 544     }
 545
 546     private void createExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 547         if (interfaceName == null) {
 548             logger.trace("No physial interface is attached to {}", elanInstance.getPhysicalNetworkName());
 549             return;
 550         }
 551
 552         String elanInterfaceName = createIetfInterfaces(elanInstance, interfaceName);
 553         addElanInterface(elanInstance.getElanInstanceName(), elanInterfaceName, null, null);
 554     }
 555
 556     private void deleteExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 557         if (interfaceName == null) {
 558             logger.trace("No physial interface is attached to {}", elanInstance.getPhysicalNetworkName());
 559             return;
 560         }
 561
 562         String elanInstanceName = elanInstance.getElanInstanceName();
 563         for (String elanInterface : getExternalElanInterfaces(elanInstanceName)) {
 564             if (elanInterface.startsWith(interfaceName)) {
 565                 deleteIetfInterface(elanInterface);
 566                 deleteElanInterface(elanInstanceName, elanInterface);
 567             }
 568         }
 569     }
 570
 571     @Override
 572     public String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
 573         DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
 574         if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
 575             logger.trace("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
 576             return null;
 577         }
 578
 579         for (String dpnInterface : dpnInterfaces.getInterfaces()) {
 580             if (elanUtils.isExternal(dpnInterface)) {
 581                 return dpnInterface;
 582             }
 583         }
 584
 585         logger.trace("Elan {} does not have any external interace attached to DPN {}", elanInstanceName, dpnId);
 586         return null;
 587     }
 588
 589     @Override
 590     public Collection<String> getExternalElanInterfaces(String elanInstanceName) {
 591         List<String> elanInterfaces = getElanInterfaces(elanInstanceName);
 592         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 593             logger.trace("No ELAN interfaces defined for {}", elanInstanceName);
 594             return Collections.emptySet();
 595         }
 596
 597         Set<String> externalElanInterfaces = new HashSet<>();
 598         for (String elanInterface : elanInterfaces) {
 599             if (elanUtils.isExternal(elanInterface)) {
 600                 externalElanInterfaces.add(elanInterface);
 601             }
 602         }
 603
 604         return externalElanInterfaces;
 605     }
 606
 607     @Override
 608     public boolean isExternalInterface(String interfaceName) {
 609         return elanUtils.isExternal(interfaceName);
 610     }
 611
 612     /**
 613      * Create ietf-interfaces based on the ELAN segment type.<br>
 614      * For segment type flat - create transparent interface pointing to the
 615      * patch-port attached to the physnet port.<br>
 616      * For segment type vlan - create trunk interface pointing to the patch-port
 617      * attached to the physnet port + trunk-member interface pointing to the
 618      * trunk interface.
 619      *
 620      * @param elanInstance
 621      *            ELAN instance
 622      * @param parentRef
 623      *            parent interface name
 624      * @return the name of the interface to be added to the ELAN instance i.e.
 625      *         trunk-member name for vlan network and transparent for flat
 626      *         network or null otherwise
 627      */
 628     private String createIetfInterfaces(ElanInstance elanInstance, String parentRef) {
 629         String interfaceName = null;
 630
 631         try {
 632             if (ElanUtils.isFlat(elanInstance)) {
 633                 interfaceName = parentRef + IfmConstants.OF_URI_SEPARATOR + "flat";
 634                 interfaceManager.createVLANInterface(interfaceName, parentRef, null, null, null,
 635                         IfL2vlan.L2vlanMode.Transparent, true);
 636             } else if (ElanUtils.isVlan(elanInstance)) {
 637                 Long segmentationId = elanInstance.getSegmentationId();
 638                 interfaceName = parentRef + IfmConstants.OF_URI_SEPARATOR + segmentationId;
 639                 String trunkName = parentRef + IfmConstants.OF_URI_SEPARATOR + "trunk";
 640                 interfaceManager.createVLANInterface(trunkName, parentRef, null, null, null,
 641                         IfL2vlan.L2vlanMode.Trunk, true);
 642
 643                 interfaceManager.createVLANInterface(interfaceName, trunkName, null, segmentationId.intValue(), null,
 644                         IfL2vlan.L2vlanMode.TrunkMember, true);
 645             }
 646         } catch (InterfaceAlreadyExistsException e) {
 647             logger.trace("Interface {} was already created", interfaceName);
 648         }
 649
 650         return interfaceName;
 651     }
 652
 653     private void deleteIetfInterface(String interfaceName) {
 654         InterfaceKey interfaceKey = new InterfaceKey(interfaceName);
 655         InstanceIdentifier<Interface> interfaceInstanceIdentifier = InstanceIdentifier.builder(Interfaces.class)
 656                 .child(Interface.class, interfaceKey).build();
 657         MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 658         logger.debug("Deleting IETF interface {}", interfaceName);
 659     }
 660
 661     private String getExtInterfaceName(Node node, String physicalNetworkName) {
 662         if (physicalNetworkName == null) {
 663             return null;
 664         }
 665
 666         String providerMappingValue = bridgeMgr.getProviderMappingValue(node, physicalNetworkName);
 667         if (providerMappingValue == null) {
 668             logger.trace("No provider mapping found for physicalNetworkName {} node {}", physicalNetworkName,
 669                     node.getNodeId().getValue());
 670             return null;
 671         }
 672
 673         return bridgeMgr.southboundUtils.getDataPathId(node) + IfmConstants.OF_URI_SEPARATOR
 674                 + bridgeMgr.getIntBridgePortNameFor(node, providerMappingValue);
 675     }
 676
 677     private void handleExternalElanNetworks(Node node, BiFunction<ElanInstance, String, Void> function) {
 678         if (!bridgeMgr.isIntegrationBridge(node)) {
 679             return;
 680         }
 681
 682         List<ElanInstance> elanInstances = getElanInstances();
 683         if (elanInstances == null || elanInstances.isEmpty()) {
 684             logger.trace("No ELAN instances found");
 685             return;
 686         }
 687
 688         for (ElanInstance elanInstance : elanInstances) {
 689             String interfaceName = getExtInterfaceName(node, elanInstance.getPhysicalNetworkName());
 690             if (interfaceName != null) {
 691                 function.apply(elanInstance, interfaceName);
 692             }
 693         }
 694     }
 695
 696     private void handleExternalElanNetwork(ElanInstance elanInstance, BiFunction<ElanInstance, String, Void> function) {
 697         String elanInstanceName = elanInstance.getElanInstanceName();
 698         if (elanInstance.getPhysicalNetworkName() == null) {
 699             logger.trace("No physical network attached to {}", elanInstanceName);
 700             return;
 701         }
 702
 703         List<Node> nodes = bridgeMgr.southboundUtils.getOvsdbNodes();
 704         if (nodes == null || nodes.isEmpty()) {
 705             logger.trace("No OVS nodes found while creating external network for ELAN {}",
 706                     elanInstance.getElanInstanceName());
 707             return;
 708         }
 709
 710         for (Node node : nodes) {
 711             if (bridgeMgr.isIntegrationBridge(node)) {
 712                 String interfaceName = getExtInterfaceName(node, elanInstance.getPhysicalNetworkName());
 713                 function.apply(elanInstance, interfaceName);
 714             }
 715         }
 716     }
 717
 718 }