vpnservice/elanmanager/elanmanager-impl/src/main/java/org/opendaylight/netvirt/elan/internal/ElanInstanceManager.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 static java.util.Collections.emptyList;
  12
  13 import com.google.common.base.Optional;
  14 import java.util.ArrayList;
  15 import java.util.Collections;
  16 import java.util.List;
  17 import javax.annotation.Nonnull;
  18 import javax.annotation.PostConstruct;
  19 import javax.inject.Inject;
  20 import javax.inject.Singleton;
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  24 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  25 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  26 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  27 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  28 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  29 import org.opendaylight.netvirt.elan.ElanException;
  30 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  31 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 @Singleton
  48 public class ElanInstanceManager extends AsyncDataTreeChangeListenerBase<ElanInstance, ElanInstanceManager> {
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(ElanInstanceManager.class);
  51
  52     private final DataBroker broker;
  53     private final IdManagerService idManager;
  54     private final IInterfaceManager interfaceManager;
  55     private final ElanInterfaceManager elanInterfaceManager;
  56     private final JobCoordinator jobCoordinator;
  57
  58     @Inject
  59     public ElanInstanceManager(final DataBroker dataBroker, final IdManagerService managerService,
  60                                final ElanInterfaceManager elanInterfaceManager,
  61                                final IInterfaceManager interfaceManager, final JobCoordinator jobCoordinator) {
  62         super(ElanInstance.class, ElanInstanceManager.class);
  63         this.broker = dataBroker;
  64         this.idManager = managerService;
  65         this.elanInterfaceManager = elanInterfaceManager;
  66         this.interfaceManager = interfaceManager;
  67         this.jobCoordinator = jobCoordinator;
  68     }
  69
  70     @Override
  71     @PostConstruct
  72     public void init() {
  73         registerListener(LogicalDatastoreType.CONFIGURATION, broker);
  74     }
  75
  76     @Override
  77     protected void remove(InstanceIdentifier<ElanInstance> identifier, ElanInstance deletedElan) {
  78         LOG.trace("Remove ElanInstance - Key: {}, value: {}", identifier, deletedElan);
  79         String elanName = deletedElan.getElanInstanceName();
  80         // check the elan Instance present in the Operational DataStore
  81         Elan existingElan = ElanUtils.getElanByName(broker, elanName);
  82         long elanTag = deletedElan.getElanTag();
  83         // Cleaning up the existing Elan Instance
  84         if (existingElan != null) {
  85             List<String> elanInterfaces = existingElan.getElanInterfaces();
  86             if (elanInterfaces != null && !elanInterfaces.isEmpty()) {
  87                 for (String elanInterfaceName : elanInterfaces) {
  88                     InstanceIdentifier<ElanInterface> elanInterfaceId = ElanUtils
  89                             .getElanInterfaceConfigurationDataPathId(elanInterfaceName);
  90                     InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(elanInterfaceName);
  91                     elanInterfaceManager.removeElanInterface(deletedElan, elanInterfaceName, interfaceInfo);
  92                     ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
  93                             elanInterfaceId);
  94                 }
  95             }
  96             ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
  97                     ElanUtils.getElanInstanceOperationalDataPath(elanName));
  98             Optional<ElanDpnInterfacesList> elanDpnInterfaceList = MDSALUtil.read(broker,
  99                     LogicalDatastoreType.OPERATIONAL,
 100                     ElanUtils.getElanDpnOperationDataPath(elanName));
 101             if (elanDpnInterfaceList.isPresent()) {
 102                 ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
 103                     getElanDpnOperationDataPath(elanName));
 104             }
 105             ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
 106                     ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag));
 107         }
 108         ElanUtils.removeAndGetElanInterfaces(elanName).forEach(elanInterfaceName -> {
 109             jobCoordinator.enqueueJob(ElanUtils.getElanInterfaceJobKey(elanInterfaceName), () -> {
 110                 WriteTransaction writeConfigTxn = broker.newWriteOnlyTransaction();
 111                 LOG.info("Deleting the elanInterface present under ConfigDS:{}", elanInterfaceName);
 112                 ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 113                         ElanUtils.getElanInterfaceConfigurationDataPathId(elanInterfaceName));
 114                 elanInterfaceManager.unbindService(elanInterfaceName, writeConfigTxn);
 115                 ElanUtils.removeElanInterfaceToElanInstanceCache(elanName, elanInterfaceName);
 116                 LOG.info("unbind the Interface:{} service bounded to Elan:{}", elanInterfaceName, elanName);
 117                 return Collections.singletonList(writeConfigTxn.submit());
 118             }, ElanConstants.JOB_MAX_RETRIES);
 119         });
 120         // Release tag
 121         ElanUtils.releaseId(idManager, ElanConstants.ELAN_ID_POOL_NAME, elanName);
 122         if (deletedElan.getAugmentation(EtreeInstance.class) != null) {
 123             removeEtreeInstance(deletedElan);
 124         }
 125     }
 126
 127     private void removeEtreeInstance(ElanInstance deletedElan) {
 128         // Release leaves tag
 129         ElanUtils.releaseId(idManager, ElanConstants.ELAN_ID_POOL_NAME,
 130                 deletedElan.getElanInstanceName() + ElanConstants.LEAVES_POSTFIX);
 131
 132         ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
 133                 ElanUtils.getElanInfoEntriesOperationalDataPath(
 134                 deletedElan.getAugmentation(EtreeInstance.class).getEtreeLeafTagVal().getValue()));
 135     }
 136
 137     @Override
 138     protected void update(InstanceIdentifier<ElanInstance> identifier, ElanInstance original, ElanInstance update) {
 139         Long existingElanTag = original.getElanTag();
 140         String elanName = update.getElanInstanceName();
 141         if (existingElanTag != null && existingElanTag.equals(update.getElanTag())) {
 142             return;
 143         } else if (update.getElanTag() == null) {
 144             // update the elan-Instance with new properties
 145             WriteTransaction tx = broker.newWriteOnlyTransaction();
 146             ElanUtils.updateOperationalDataStore(broker, idManager,
 147                     update, new ArrayList<>(), tx);
 148             ElanUtils.waitForTransactionToComplete(tx);
 149             return;
 150         }
 151
 152         jobCoordinator.enqueueJob(elanName, () -> {
 153             try {
 154                 return elanInterfaceManager.handleunprocessedElanInterfaces(update);
 155             } catch (ElanException e) {
 156                 LOG.error("update() failed for ElanInstance: " + identifier.toString(), e);
 157                 return emptyList();
 158             }
 159         }, ElanConstants.JOB_MAX_RETRIES);
 160
 161     }
 162
 163     @Override
 164     protected void add(InstanceIdentifier<ElanInstance> identifier, ElanInstance elanInstanceAdded) {
 165         String elanInstanceName  = elanInstanceAdded.getElanInstanceName();
 166         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 167         if (elanInfo == null) {
 168             WriteTransaction tx = broker.newWriteOnlyTransaction();
 169             ElanUtils.updateOperationalDataStore(broker, idManager,
 170                 elanInstanceAdded, new ArrayList<>(), tx);
 171             ElanUtils.waitForTransactionToComplete(tx);
 172         }
 173     }
 174
 175     public ElanInstance getElanInstanceByName(String elanInstanceName) {
 176         InstanceIdentifier<ElanInstance> elanIdentifierId = getElanInstanceConfigurationDataPath(elanInstanceName);
 177         return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
 178     }
 179
 180     @Nonnull
 181     public List<DpnInterfaces> getElanDPNByName(String elanInstanceName) {
 182         return getElanDPNByName(broker, elanInstanceName);
 183     }
 184
 185     @Nonnull
 186     public static List<DpnInterfaces> getElanDPNByName(DataBroker dataBroker, String elanInstanceName) {
 187         InstanceIdentifier<ElanDpnInterfacesList> elanIdentifier = getElanDpnOperationDataPath(elanInstanceName);
 188         return MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, elanIdentifier).toJavaUtil().map(
 189                 ElanDpnInterfacesList::getDpnInterfaces).orElse(Collections.emptyList());
 190     }
 191
 192     private static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName) {
 193         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
 194                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
 195     }
 196
 197     private InstanceIdentifier<ElanInstance> getElanInstanceConfigurationDataPath(String elanInstanceName) {
 198         return InstanceIdentifier.builder(ElanInstances.class)
 199                 .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 200     }
 201
 202     @Override
 203     protected InstanceIdentifier<ElanInstance> getWildCardPath() {
 204         return InstanceIdentifier.create(ElanInstances.class).child(ElanInstance.class);
 205     }
 206
 207     @Override
 208     protected ElanInstanceManager getDataTreeChangeListener() {
 209         return this;
 210     }
 211 }