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