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