vpnmanager/impl/src/main/java/org/opendaylight/netvirt/vpnmanager/SubnetmapChangeListener.java

   1 /*
   2  * Copyright (c) 2016, 2017 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.vpnmanager;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Objects;
  14 import java.util.Set;
  15 import java.util.concurrent.locks.ReentrantLock;
  16 import javax.annotation.PreDestroy;
  17 import javax.inject.Inject;
  18 import javax.inject.Singleton;
  19 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  20 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  21 import org.opendaylight.genius.utils.JvmGlobalLocks;
  22 import org.opendaylight.infrautils.utils.concurrent.Executors;
  23 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  24 import org.opendaylight.mdsal.binding.api.DataBroker;
  25 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  26 import org.opendaylight.netvirt.vpnmanager.api.IVpnManager;
  27 import org.opendaylight.serviceutils.tools.listener.AbstractAsyncDataTreeChangeListener;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.vpntargets.VpnTarget;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 @Singleton
  42 public class SubnetmapChangeListener extends AbstractAsyncDataTreeChangeListener<Subnetmap> {
  43     private static final Logger LOG = LoggerFactory.getLogger(SubnetmapChangeListener.class);
  44     private final DataBroker dataBroker;
  45     private final VpnSubnetRouteHandler vpnSubnetRouteHandler;
  46     private final VpnUtil vpnUtil;
  47     private final IVpnManager vpnManager;
  48     private final ManagedNewTransactionRunner txRunner;
  49
  50     @Inject
  51     public SubnetmapChangeListener(final DataBroker dataBroker, final VpnSubnetRouteHandler vpnSubnetRouteHandler,
  52                                    VpnUtil vpnUtil, IVpnManager vpnManager) {
  53         super(dataBroker, LogicalDatastoreType.CONFIGURATION,
  54                 InstanceIdentifier.create(Subnetmaps.class).child(Subnetmap.class),
  55                 Executors.newListeningSingleThreadExecutor("SubnetmapChangeListener", LOG));
  56         this.dataBroker = dataBroker;
  57         this.vpnSubnetRouteHandler = vpnSubnetRouteHandler;
  58         this.vpnUtil = vpnUtil;
  59         this.vpnManager = vpnManager;
  60         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
  61         start();
  62     }
  63
  64     public void start() {
  65         LOG.info("{} start", getClass().getSimpleName());
  66     }
  67
  68     @Override
  69     @PreDestroy
  70     public void close() {
  71         super.close();
  72         Executors.shutdownAndAwaitTermination(getExecutorService());
  73     }
  74
  75
  76     @Override
  77     public void add(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmap) {
  78         LOG.debug("add: subnetmap method - key: {}, value: {}", identifier, subnetmap);
  79         Uuid subnetId = subnetmap.getId();
  80         Network network = vpnUtil.getNeutronNetwork(subnetmap.getNetworkId());
  81         if (network == null) {
  82             LOG.error("add: network was not found for subnetId {}", subnetId.getValue());
  83             return;
  84         }
  85         if (subnetmap.getVpnId() != null) {
  86             if (NetworkType.VLAN.equals(subnetmap.getNetworkType())) {
  87                 vpnUtil.addRouterPortToElanDpnListForVlaninAllDpn(subnetmap.getVpnId().getValue());
  88             }
  89         }
  90         if (VpnUtil.getIsExternal(network)) {
  91             LOG.debug("SubnetmapListener:add: provider subnetwork {} is handling in "
  92                       + "ExternalSubnetVpnInstanceListener", subnetId.getValue());
  93             return;
  94         }
  95         String elanInstanceName = subnetmap.getNetworkId().getValue();
  96         long elanTag = getElanTag(elanInstanceName);
  97         if (elanTag == 0L) {
  98             LOG.error("add: unable to fetch elantag from ElanInstance {} for subnet {}",
  99                       elanInstanceName, subnetId.getValue());
 100             return;
 101         }
 102         Uuid vpnId = subnetmap.getVpnId();
 103         if (vpnId != null) {
 104             boolean isBgpVpn = !vpnId.equals(subnetmap.getRouterId());
 105             LOG.info("add: subnetmap {} with elanTag {} to VPN {}", subnetmap, elanTag,
 106                      vpnId);
 107             vpnSubnetRouteHandler.onSubnetAddedToVpn(subnetmap, isBgpVpn, elanTag);
 108             if (isBgpVpn && subnetmap.getRouterId() == null) {
 109                 Set<VpnTarget> routeTargets = vpnManager.getRtListForVpn(vpnId.getValue());
 110                 if (!routeTargets.isEmpty()) {
 111                     // FIXME: separate this out somehow?
 112                     final ReentrantLock lock = JvmGlobalLocks.getLockForString(subnetmap.getSubnetIp());
 113                     lock.lock();
 114                     try {
 115                         vpnManager.updateRouteTargetsToSubnetAssociation(routeTargets, subnetmap.getSubnetIp(),
 116                                 vpnId.getValue());
 117                     } finally {
 118                         lock.unlock();
 119                     }
 120                 }
 121             }
 122         }
 123     }
 124
 125     @Override
 126     public void remove(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmap) {
 127         LOG.trace("remove: subnetmap method - key: {}, value: {}", identifier, subnetmap);
 128     }
 129
 130     @Override
 131     // TODO Clean up the exception handling
 132     @SuppressWarnings("checkstyle:IllegalCatch")
 133     public void update(InstanceIdentifier<Subnetmap> identifier, Subnetmap subnetmapOriginal, Subnetmap
 134             subnetmapUpdate) {
 135         LOG.debug("update: method - key {}, original {}, update {}", identifier,
 136                   subnetmapOriginal, subnetmapUpdate);
 137         Uuid subnetId = subnetmapUpdate.getId();
 138         Network network = vpnUtil.getNeutronNetwork(subnetmapUpdate.getNetworkId());
 139         if (network == null) {
 140             LOG.error("update: network was not found for subnetId {}", subnetId.getValue());
 141             return;
 142         }
 143         String elanInstanceName = subnetmapUpdate.getNetworkId().getValue();
 144         long elanTag = getElanTag(elanInstanceName);
 145         if (elanTag == 0L) {
 146             LOG.error("update: unable to fetch elantag from ElanInstance {} for subnetId {}",
 147                       elanInstanceName, subnetId);
 148             return;
 149         }
 150         updateVlanDataEntry(subnetmapOriginal.getVpnId(), subnetmapUpdate.getVpnId(), subnetmapUpdate,
 151                 subnetmapOriginal, elanInstanceName);
 152         if (VpnUtil.getIsExternal(network)) {
 153             LOG.debug("update: provider subnetwork {} is handling in "
 154                       + "ExternalSubnetVpnInstanceListener", subnetId.getValue());
 155             return;
 156         }
 157         // update on BGPVPN or InternalVPN change
 158         Uuid vpnIdOld = subnetmapOriginal.getVpnId();
 159         Uuid vpnIdNew = subnetmapUpdate.getVpnId();
 160         if (!Objects.equals(vpnIdOld, vpnIdNew)) {
 161             LOG.info("update: update subnetOpDataEntry for subnet {} imported in VPN",
 162                      subnetmapUpdate.getId().getValue());
 163             updateSubnetmapOpDataEntry(subnetmapOriginal.getVpnId(), subnetmapUpdate.getVpnId(), subnetmapUpdate,
 164                                        subnetmapOriginal, elanTag);
 165         }
 166         // update on Internet VPN Id change
 167         Uuid inetVpnIdOld = subnetmapOriginal.getInternetVpnId();
 168         Uuid inetVpnIdNew = subnetmapUpdate.getInternetVpnId();
 169         if (!Objects.equals(inetVpnIdOld, inetVpnIdNew)) {
 170             LOG.info("update: update subnetOpDataEntry for subnet {} imported in InternetVPN",
 171                      subnetmapUpdate.getId().getValue());
 172             updateSubnetmapOpDataEntry(inetVpnIdOld, inetVpnIdNew, subnetmapUpdate, subnetmapOriginal, elanTag);
 173         }
 174         // update on PortList change
 175         List<Uuid> oldPortList;
 176         List<Uuid> newPortList;
 177         newPortList = subnetmapUpdate.getPortList() != null ? subnetmapUpdate.getPortList() : new ArrayList<>();
 178         oldPortList = subnetmapOriginal.getPortList() != null ? subnetmapOriginal.getPortList() : new ArrayList<>();
 179         if (newPortList.size() == oldPortList.size()) {
 180             return;
 181         }
 182         LOG.info("update: update port list for subnet {}", subnetmapUpdate.getId().getValue());
 183         if (newPortList.size() > oldPortList.size()) {
 184             for (Uuid portId : newPortList) {
 185                 if (! oldPortList.contains(portId)) {
 186                     vpnSubnetRouteHandler.onPortAddedToSubnet(subnetmapUpdate, portId);
 187                     return;
 188                 }
 189             }
 190         } else {
 191             for (Uuid portId : oldPortList) {
 192                 if (! newPortList.contains(portId)) {
 193                     vpnSubnetRouteHandler.onPortRemovedFromSubnet(subnetmapUpdate, portId);
 194                     return;
 195                 }
 196             }
 197         }
 198     }
 199
 200     private void updateSubnetmapOpDataEntry(Uuid vpnIdOld, Uuid vpnIdNew, Subnetmap subnetmapUpdate,
 201                                     Subnetmap subnetmapOriginal, Long elanTag) {
 202
 203         // subnet added to VPN
 204         if (vpnIdNew != null && vpnIdOld == null) {
 205             if (vpnIdNew.equals(subnetmapUpdate.getRouterId())) {
 206                 return;
 207             }
 208             vpnSubnetRouteHandler.onSubnetAddedToVpn(subnetmapUpdate, true, elanTag);
 209         }
 210         // subnet removed from VPN
 211         if (vpnIdOld != null && vpnIdNew == null) {
 212             if (vpnIdOld.equals(subnetmapOriginal.getRouterId())) {
 213                 return;
 214             }
 215             vpnSubnetRouteHandler.onSubnetDeletedFromVpn(subnetmapOriginal, true);
 216         }
 217         // subnet updated in VPN
 218         if (vpnIdOld != null && vpnIdNew != null && !vpnIdNew.equals(vpnIdOld)) {
 219             vpnSubnetRouteHandler.onSubnetUpdatedInVpn(subnetmapUpdate, elanTag);
 220         }
 221     }
 222
 223     private void updateVlanDataEntry(Uuid vpnIdOld, Uuid vpnIdNew, Subnetmap subnetmapUpdate,
 224             Subnetmap subnetmapOriginal, String elanInstanceName) {
 225         if (vpnIdNew != null && vpnIdOld == null) {
 226             if (elanInstanceName != null && NetworkType.VLAN.equals(subnetmapUpdate.getNetworkType())) {
 227                 vpnUtil.addRouterPortToElanDpnListForVlaninAllDpn(vpnIdNew.getValue());
 228             }
 229         }
 230         if (vpnIdOld != null && vpnIdNew == null) {
 231             if (NetworkType.VLAN.equals(subnetmapOriginal.getNetworkType())) {
 232                 vpnUtil.removeRouterPortFromElanDpnListForVlanInAllDpn(elanInstanceName, subnetmapOriginal
 233                         .getRouterInterfacePortId().getValue(), vpnIdOld.getValue());
 234             }
 235         }
 236     }
 237
 238     @SuppressWarnings("all")
 239     protected long getElanTag(String elanInstanceName) {
 240         final long[] elanTag = {0L};
 241
 242         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(tx -> {
 243             InstanceIdentifier<ElanInstance> elanIdentifierId = InstanceIdentifier.builder(ElanInstances.class)
 244                     .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 245             ElanInstance elanInstance = tx.read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId)
 246                     .get().orElse(null);
 247             if (elanInstance != null) {
 248                 if (elanInstance.getElanTag() != null) {
 249                     elanTag[0] =elanInstance.getElanTag().longValue();
 250                 } else {
 251                     LOG.error("Notification failed because of failure in fetching elanTag for ElanInstance {}",
 252                             elanInstanceName);
 253                 }
 254             } else {
 255                 LOG.error("Notification failed because of failure in reading ELANInstance {}", elanInstanceName);
 256             }
 257         }), LOG, "Error binding an ELAN tag for elanInstance {}", elanInstanceName);
 258
 259         return elanTag[0];
 260     }
 261 }