elanmanager/elanmanager-impl/src/main/java/org/opendaylight/vpnservice/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 package org.opendaylight.vpnservice.elan.internal;
   9
  10 import com.google.common.base.Optional;
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  15 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  16 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  17 import org.opendaylight.elanmanager.api.IElanService;
  18 import org.opendaylight.vpnservice.elan.statisitcs.ElanStatisticsImpl;
  19 import org.opendaylight.vpnservice.elan.utils.ElanConstants;
  20 import org.opendaylight.vpnservice.elan.utils.ElanUtils;
  21 import org.opendaylight.vpnservice.interfacemgr.interfaces.IInterfaceManager;
  22 import org.opendaylight.vpnservice.itm.api.IITMProvider;
  23 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
  24 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanInstances;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanInterfaces;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstance;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceKey;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterface;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterfaceBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterfaceKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.Elan;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntry;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.statistics.rev150824.ElanStatisticsService;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.CreateIdPoolInput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.CreateIdPoolInputBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.OdlInterfaceRpcService;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.ItmRpcService;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.common.RpcResult;
  46 import org.opendaylight.elanmanager.exceptions.MacNotFoundException;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 import java.util.ArrayList;
  51 import java.util.Collection;
  52 import java.util.List;
  53 import java.util.concurrent.Future;
  54
  55 public class ElanServiceProvider implements BindingAwareProvider, IElanService, AutoCloseable {
  56
  57     private IdManagerService idManager;
  58     private IMdsalApiManager mdsalManager;
  59     private IInterfaceManager interfaceManager;
  60     private OdlInterfaceRpcService interfaceManagerRpcService;
  61     private ElanInstanceManager elanInstanceManager;
  62     private ElanForwardingEntriesHandler elanForwardingEntriesHandler;
  63     private ElanInterfaceManager elanInterfaceManager;
  64     private ElanPacketInHandler elanPacketInHandler;
  65     private ElanSmacFlowEventListener elanSmacFlowEventListener;
  66     private ElanNodeListener elanNodeListener;
  67     private NotificationService notificationService;
  68     private RpcProviderRegistry rpcProviderRegistry;
  69
  70     public ElanServiceProvider(RpcProviderRegistry rpcRegistry) {
  71         rpcProviderRegistry = rpcRegistry;
  72     }
  73
  74     //private ElanInterfaceEventListener elanInterfaceEventListener;
  75     private ElanItmEventListener elanItmEventListener;
  76
  77     public void setItmRpcService(ItmRpcService itmRpcService) {
  78         this.itmRpcService = itmRpcService;
  79     }
  80
  81     public ItmRpcService getItmRpcService() {
  82         return itmRpcService;
  83     }
  84
  85     private ItmRpcService itmRpcService;
  86     private DataBroker broker;
  87
  88     private static final Logger logger = LoggerFactory.getLogger(ElanServiceProvider.class);
  89
  90     @Override
  91     public void onSessionInitiated(ProviderContext session) {
  92         createIdPool();
  93         broker = session.getSALService(DataBroker.class);
  94
  95         elanForwardingEntriesHandler = new ElanForwardingEntriesHandler(broker);
  96
  97         elanInterfaceManager = ElanInterfaceManager.getElanInterfaceManager();
  98         elanInterfaceManager.setInterfaceManager(interfaceManager);
  99         elanInterfaceManager.setIdManager(idManager);
 100         elanInterfaceManager.setMdSalApiManager(mdsalManager);
 101         elanInterfaceManager.setDataBroker(broker);
 102         elanInterfaceManager.registerListener();
 103         elanInterfaceManager.setInterfaceManagerRpcService(interfaceManagerRpcService);
 104         elanInterfaceManager.setElanForwardingEntriesHandler(elanForwardingEntriesHandler);
 105
 106         elanInstanceManager = ElanInstanceManager.getElanInstanceManager();
 107         elanInstanceManager.setDataBroker(broker);
 108         elanInstanceManager.setIdManager(idManager);
 109         elanInstanceManager.setElanInterfaceManager(elanInterfaceManager);
 110         elanInstanceManager.registerListener();
 111
 112         elanNodeListener = new ElanNodeListener(broker, mdsalManager);
 113
 114         elanPacketInHandler = new ElanPacketInHandler(broker);
 115         elanPacketInHandler.setInterfaceManager(interfaceManager);
 116         notificationService.registerNotificationListener(elanPacketInHandler);
 117
 118         elanSmacFlowEventListener = new ElanSmacFlowEventListener(broker);
 119         elanSmacFlowEventListener.setMdSalApiManager(mdsalManager);
 120         elanSmacFlowEventListener.setInterfaceManager(interfaceManager);
 121         elanSmacFlowEventListener.setSalFlowService(session.getRpcService(SalFlowService.class));
 122         notificationService.registerNotificationListener(elanSmacFlowEventListener);
 123
 124         // Initialize statistics rpc provider for elan
 125         ElanStatisticsService interfaceStatsService = new ElanStatisticsImpl(broker, interfaceManager, mdsalManager);
 126         rpcProviderRegistry.addRpcImplementation(ElanStatisticsService.class, interfaceStatsService);
 127
 128         ElanUtils.setElanServiceProvider(this);
 129     }
 130
 131     public void setIdManager(IdManagerService idManager) {
 132         this.idManager = idManager;
 133     }
 134
 135     public void setMdsalManager(IMdsalApiManager mdsalManager) {
 136         this.mdsalManager = mdsalManager;
 137     }
 138
 139     public void setInterfaceManager(IInterfaceManager interfaceManager) {
 140         this.interfaceManager = interfaceManager;
 141     }
 142
 143     public IMdsalApiManager getMdsalManager() {
 144         return mdsalManager;
 145     }
 146
 147      public DataBroker getBroker() {
 148         return broker;
 149     }
 150
 151     public void setNotificationService(NotificationService notificationService) {
 152         this.notificationService = notificationService;
 153     }
 154
 155     public void setInterfaceManagerRpcService(OdlInterfaceRpcService interfaceManager) {
 156         this.interfaceManagerRpcService = interfaceManager;
 157     }
 158
 159     public OdlInterfaceRpcService getInterfaceManagerRpcService() {
 160         return interfaceManagerRpcService;
 161     }
 162
 163     private void createIdPool() {
 164         CreateIdPoolInput createPool = new CreateIdPoolInputBuilder()
 165             .setPoolName(ElanConstants.ELAN_ID_POOL_NAME).setLow(ElanConstants.ELAN_ID_LOW_VALUE).setHigh(ElanConstants.ELAN_ID_HIGH_VALUE)
 166             .build();
 167         try {
 168            Future<RpcResult<Void>> result = idManager.createIdPool(createPool);
 169            if ((result != null) && (result.get().isSuccessful())) {
 170                logger.debug("ELAN Id Pool is created successfully");
 171             }
 172         } catch (Exception e) {
 173             logger.error("Failed to create ELAN Id pool {}", e);
 174         }
 175     }
 176
 177     @Override
 178     public boolean createElanInstance(String elanInstanceName, long macTimeout, String description) {
 179         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 180         boolean isSuccess = true;
 181         if(existingElanInstance != null) {
 182            if(compareWithExistingElanInstance(existingElanInstance, macTimeout, description)) {
 183                logger.debug("Elan Instance is already present in the Operational DS {}", existingElanInstance);
 184                return true;
 185            } else {
 186                ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName).setDescription(description).setMacTimeout(macTimeout).setKey(new ElanInstanceKey(elanInstanceName)).build();
 187                MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 188                logger.debug("Updating the Elan Instance {} with MAC TIME-OUT %l and Description %s ", updateElanInstance, macTimeout, description);
 189            }
 190         } else {
 191             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName).setMacTimeout(macTimeout).setDescription(description).setKey(new ElanInstanceKey(elanInstanceName)).build();
 192             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInstanceIdentifier(elanInstanceName), elanInstance);
 193             logger.debug("Creating the new Elan Instance {}", elanInstance);
 194         }
 195         return isSuccess;
 196     }
 197
 198     public static boolean compareWithExistingElanInstance(ElanInstance existingElanInstance, long macTimeOut, String description) {
 199         boolean isEqual = false;
 200         if(existingElanInstance.getMacTimeout() == macTimeOut && existingElanInstance.getDescription().equals(description)) {
 201             isEqual = true;
 202         }
 203         return isEqual;
 204     }
 205     @Override
 206     public void updateElanInstance(String elanInstanceName, long newMacTimout, String newDescription) {
 207         createElanInstance(elanInstanceName, newMacTimout, newDescription);
 208     }
 209
 210     @Override
 211     public boolean deleteElanInstance(String elanInstanceName) {
 212         boolean isSuccess = false;
 213         ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 214         if(existingElanInstance == null) {
 215             logger.debug("Elan Instance is not present {}" , existingElanInstance);
 216             return isSuccess;
 217         }
 218         logger.debug("Deletion of the existing Elan Instance {}", existingElanInstance);
 219         ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInstanceIdentifier(elanInstanceName));
 220         isSuccess = true;
 221         return isSuccess;
 222     }
 223
 224     @Override
 225     public void addElanInterface(String elanInstanceName, String interfaceName, List<String> staticMacAddresses, String description) {
 226           ElanInstance existingElanInstance = elanInstanceManager.getElanInstanceByName(elanInstanceName);
 227           if(existingElanInstance != null) {
 228               ElanInterface elanInterface;
 229               if(staticMacAddresses == null) {
 230                   elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName).setDescription(description).setName(interfaceName).setKey(new ElanInterfaceKey(interfaceName)).build();
 231               } else {
 232                   elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName).setDescription(description).setName(interfaceName).setStaticMacEntries(getPhysAddress(staticMacAddresses)).setKey(new ElanInterfaceKey(interfaceName)).build();
 233               }
 234               MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 235               logger.debug("Creating the new ELan Interface {}", elanInterface);
 236           }
 237
 238     }
 239
 240     @Override
 241     public void updateElanInterface(String elanInstanceName, String interfaceName, List<String> updatedStaticMacAddresses, String newDescription) {
 242         ElanInterface existingElanInterface = ElanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 243         if (existingElanInterface == null) {
 244             return;
 245         }
 246         List<PhysAddress> existingMacAddress = existingElanInterface.getStaticMacEntries();
 247         List<PhysAddress> updatedMacAddresses = getPhysAddress(updatedStaticMacAddresses);
 248         List<PhysAddress> updatedPhysAddress = getUpdatedPhyAddress(existingMacAddress, updatedMacAddresses);
 249         if(updatedPhysAddress.size() > 0) {
 250             logger.debug("updating the ElanInterface with new Mac Entries {}", updatedStaticMacAddresses);
 251             ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName).setName(interfaceName).setDescription(newDescription).setStaticMacEntries(updatedPhysAddress).setKey(new ElanInterfaceKey(interfaceName)).build();
 252             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 253         }
 254     }
 255
 256     @Override
 257     public void deleteElanInterface(String elanInstanceName, String interfaceName) {
 258         ElanInterface existingElanInterface = ElanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 259         if(existingElanInterface != null) {
 260             ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName));
 261             logger.debug("deleting the Elan Interface {}", existingElanInterface);
 262         }
 263     }
 264
 265     @Override
 266     public void addStaticMacAddress(String elanInstanceName, String interfaceName, String macAddress) {
 267         ElanInterface existingElanInterface = ElanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 268         PhysAddress updateStaticMacAddress = new PhysAddress(macAddress);
 269         if (existingElanInterface != null) {
 270             List<PhysAddress> existingMacAddress = existingElanInterface.getStaticMacEntries();
 271             if(existingMacAddress.contains(updateStaticMacAddress)) {
 272                 return;
 273             }
 274             existingMacAddress.add(updateStaticMacAddress);
 275             ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName).setName(interfaceName).setStaticMacEntries(existingMacAddress).setDescription(existingElanInterface.getDescription()).setKey(new ElanInterfaceKey(interfaceName)).build();
 276             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 277         }
 278     }
 279
 280     @Override
 281     public void deleteStaticMacAddress(String elanInstanceName, String interfaceName, String macAddress) throws MacNotFoundException {
 282            ElanInterface existingElanInterface = ElanUtils.getElanInterfaceByElanInterfaceName(interfaceName);
 283         PhysAddress physAddress = new PhysAddress(macAddress);
 284         if(existingElanInterface == null) {
 285             return;
 286         }
 287         List<PhysAddress> existingMacAddress = existingElanInterface.getStaticMacEntries();
 288         if(existingMacAddress.contains(physAddress)) {
 289             existingMacAddress.remove(physAddress);
 290             ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName).setName(interfaceName).setStaticMacEntries(existingMacAddress).setDescription(existingElanInterface.getDescription()).setKey(new ElanInterfaceKey(interfaceName)).build();
 291             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 292         } else {
 293             throw new MacNotFoundException("Mac Not Found Exception");
 294         }
 295     }
 296
 297     @Override
 298     public Collection<MacEntry> getElanMacTable(String elanInstanceName) {
 299         Elan elanInfo = ElanUtils.getElanByName(elanInstanceName);
 300         List<MacEntry> macAddress = new ArrayList<>();
 301         if(elanInfo == null) {
 302             return macAddress;
 303         }
 304        List<String> elanInterfaces =  elanInfo.getElanInterfaces();
 305         if(elanInterfaces != null && elanInterfaces.size() > 0) {
 306             for(String elanInterface : elanInterfaces) {
 307                 ElanInterfaceMac elanInterfaceMac = ElanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 308                 if(elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null && elanInterfaceMac.getMacEntry().size() > 0){
 309                     macAddress.addAll(elanInterfaceMac.getMacEntry());
 310                 }
 311             }
 312         }
 313        return macAddress;
 314     }
 315
 316     @Override
 317     public void flushMACTable(String elanInstanceName) {
 318         Elan elanInfo = ElanUtils.getElanByName(elanInstanceName);
 319         if(elanInfo == null) {
 320             return;
 321         }
 322         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 323         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 324             return;
 325         }
 326         for (String elanInterface : elanInterfaces) {
 327             ElanInterfaceMac elanInterfaceMac = ElanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 328             if (elanInterfaceMac.getMacEntry() != null && elanInterfaceMac.getMacEntry().size() > 0) {
 329                 List<MacEntry> macEntries =  elanInterfaceMac.getMacEntry();
 330                 for(MacEntry macEntry : macEntries) {
 331                     try {
 332                         deleteStaticMacAddress(elanInstanceName, elanInterface, macEntry.getMacAddress().getValue());
 333                     } catch (MacNotFoundException e) {
 334                         logger.error("Mac Not Found Exception {}", e);
 335                         e.printStackTrace();
 336                     }
 337                 }
 338             }
 339         }
 340
 341     }
 342
 343     @Override
 344     public void close() throws Exception {
 345         elanInstanceManager.close();
 346     }
 347
 348     public static List<PhysAddress> getPhysAddress(List<String> macAddress) {
 349         List<PhysAddress> physAddresses = new ArrayList<>();
 350         for(String mac : macAddress) {
 351             physAddresses.add(new PhysAddress(mac));
 352         }
 353         return physAddresses;
 354     }
 355
 356
 357     public List<PhysAddress> getUpdatedPhyAddress(List<PhysAddress> originalAddresses, List<PhysAddress> updatePhyAddresses) {
 358         if(updatePhyAddresses != null && !updatePhyAddresses.isEmpty()) {
 359             List<PhysAddress> existingClonedPhyAddress = new ArrayList<>();
 360             if (originalAddresses != null && !originalAddresses.isEmpty()) {
 361                 existingClonedPhyAddress.addAll(0, originalAddresses);
 362                 originalAddresses.removeAll(updatePhyAddresses);
 363                 updatePhyAddresses.removeAll(existingClonedPhyAddress);
 364             }
 365         }
 366         return updatePhyAddresses;
 367     }
 368
 369     @Override
 370     public ElanInstance getElanInstance(String elanName) {
 371         return ElanUtils.getElanInstanceByName(elanName);
 372     }
 373
 374     @Override
 375     public List<ElanInstance> getElanInstances() {
 376         List<ElanInstance> elanList = new ArrayList<ElanInstance>();
 377         InstanceIdentifier<ElanInstances> elanInstancesIdentifier =  InstanceIdentifier.builder(ElanInstances.class).build();
 378         Optional<ElanInstances> elansOptional  = ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION, elanInstancesIdentifier);
 379         if(elansOptional.isPresent()) {
 380             elanList.addAll(elansOptional.get().getElanInstance());
 381         }
 382         return elanList;
 383     }
 384
 385     @Override
 386     public List<String> getElanInterfaces(String elanInstanceName) {
 387         List<String> elanInterfaces = new ArrayList<>();
 388         InstanceIdentifier<ElanInterfaces> elanInterfacesIdentifier =  InstanceIdentifier.builder(ElanInterfaces.class).build();
 389         Optional<ElanInterfaces> elanInterfacesOptional  = ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION, elanInterfacesIdentifier);
 390         if(!elanInterfacesOptional.isPresent()) {
 391              return elanInterfaces;
 392         }
 393         List<ElanInterface> elanInterfaceList = elanInterfacesOptional.get().getElanInterface();
 394         for(ElanInterface elanInterface : elanInterfaceList) {
 395             if(elanInterface.getElanInstanceName().equals(elanInstanceName)) {
 396                 elanInterfaces.add(elanInterface.getName());
 397             }
 398         }
 399         return elanInterfaces;
 400     }
 401 }