neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronFloatingToFixedIpMappingChangeListener.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.netvirt.neutronvpn;
   9
  10 import static org.opendaylight.netvirt.neutronvpn.NeutronvpnUtils.buildfloatingIpIdToPortMappingIdentifier;
  11
  12 import edu.umd.cs.findbugs.annotations.CheckReturnValue;
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.Collections;
  16 import java.util.HashMap;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Objects;
  20 import java.util.Optional;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.concurrent.TimeUnit;
  23 import javax.annotation.PreDestroy;
  24 import javax.inject.Inject;
  25 import javax.inject.Singleton;
  26 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  27 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  28 import org.opendaylight.infrautils.utils.concurrent.Executors;
  29 import org.opendaylight.infrautils.utils.concurrent.NamedLocks;
  30 import org.opendaylight.infrautils.utils.concurrent.NamedSimpleReentrantLock.AcquireResult;
  31 import org.opendaylight.mdsal.binding.api.DataBroker;
  32 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  33 import org.opendaylight.serviceutils.tools.listener.AbstractAsyncDataTreeChangeListener;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpInfo;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.RouterPorts;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.RouterPortsBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.RouterPortsKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.Ports;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.PortsBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.PortsKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.ports.InternalToExternalPortMap;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.ports.InternalToExternalPortMapBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.ports.InternalToExternalPortMapKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.floatingips.attributes.Floatingips;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.floatingips.attributes.floatingips.Floatingip;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 @Singleton
  56 public class NeutronFloatingToFixedIpMappingChangeListener extends AbstractAsyncDataTreeChangeListener<Floatingip> {
  57     private static final Logger LOG = LoggerFactory.getLogger(NeutronFloatingToFixedIpMappingChangeListener.class);
  58     private static final long LOCK_WAIT_TIME = 10L;
  59
  60     private final DataBroker dataBroker;
  61     private final NamedLocks<String> routerLock = new NamedLocks<>();
  62
  63     @Inject
  64     public NeutronFloatingToFixedIpMappingChangeListener(final DataBroker dataBroker) {
  65         super(dataBroker, LogicalDatastoreType.CONFIGURATION, InstanceIdentifier.create(Neutron.class)
  66                         .child(Floatingips.class).child(Floatingip.class),
  67                 Executors.newSingleThreadExecutor("NeutronFloatingToFixedIpMappingChangeListener", LOG));
  68         this.dataBroker = dataBroker;
  69     }
  70
  71     public void init() {
  72         LOG.info("{} init", getClass().getSimpleName());
  73     }
  74
  75     @Override
  76     @PreDestroy
  77     public void close() {
  78         super.close();
  79         Executors.shutdownAndAwaitTermination(getExecutorService());
  80     }
  81
  82     @Override
  83     public void add(InstanceIdentifier<Floatingip> identifier, Floatingip input) {
  84         LOG.trace("Neutron Floating IP created: key: {}, value={}", identifier, input);
  85         IpAddress fixedIp = input.getFixedIpAddress();
  86         String floatingIp = input.getFloatingIpAddress().getIpv4Address().getValue();
  87         if (fixedIp != null) {
  88             addToFloatingIpInfo(input.getRouterId().getValue(), input.getFloatingNetworkId(), input.getPortId()
  89                     .getValue(), fixedIp.getIpv4Address().getValue(), floatingIp, input.getUuid());
  90         }
  91     }
  92
  93     @Override
  94     public void remove(InstanceIdentifier<Floatingip> identifier, Floatingip input) {
  95         LOG.trace("Neutron Floating IP deleted : key: {}, value={}", identifier, input);
  96         IpAddress fixedIp = input.getFixedIpAddress();
  97         if (fixedIp != null) {
  98             // update FloatingIpPortInfo to set isFloatingIpDeleted as true to enable deletion of FloatingIpPortInfo
  99             // map once it is used for processing in the NAT removal path
 100             updateFloatingIpPortInfo(input.getUuid(), input.getPortId());
 101             clearFromFloatingIpInfo(input.getRouterId().getValue(), input.getPortId().getValue(), fixedIp
 102                     .getIpv4Address().getValue());
 103         } else {
 104             // delete FloatingIpPortInfo mapping since floating IP is deleted and no fixed IP is associated to it
 105             removeFromFloatingIpPortInfo(input.getUuid());
 106         }
 107     }
 108
 109     // populate the floating to fixed ip map upon association/dissociation from fixed ip
 110     @Override
 111     public void update(InstanceIdentifier<Floatingip> identifier, Floatingip original, Floatingip update) {
 112         LOG.trace("Handling FloatingIptoFixedIp mapping : key: {}, original value={}, update value={}", identifier,
 113                 original, update);
 114         IpAddress oldFixedIp = original.getFixedIpAddress();
 115         IpAddress newFixedIp = update.getFixedIpAddress();
 116         String floatingIp = update.getFloatingIpAddress().getIpv4Address().getValue();
 117
 118         if (oldFixedIp != null && !oldFixedIp.equals(newFixedIp)) {
 119             clearFromFloatingIpInfo(original.getRouterId().getValue(), original.getPortId().getValue(), oldFixedIp
 120                     .getIpv4Address().getValue());
 121         }
 122         if (newFixedIp != null && !newFixedIp.equals(oldFixedIp)) {
 123             addToFloatingIpInfo(update.getRouterId().getValue(), update.getFloatingNetworkId(), update.getPortId()
 124                     .getValue(), newFixedIp.getIpv4Address().getValue(), floatingIp, update.getUuid());
 125         }
 126     }
 127
 128     // TODO Clean up the exception handling
 129     @SuppressWarnings("checkstyle:IllegalCatch")
 130     private void addToFloatingIpInfo(String routerName, Uuid extNetworkId, String fixedNeutronPortName, String
 131             fixedIpAddress, String floatingIpAddress, Uuid floatingIpId) {
 132         RouterPortsBuilder routerPortsBuilder;
 133         InstanceIdentifier<RouterPorts> routerPortsIdentifier = InstanceIdentifier.builder(FloatingIpInfo.class)
 134                 .child(RouterPorts.class, new RouterPortsKey(routerName)).build();
 135         try {
 136             Optional<RouterPorts> optionalRouterPorts =
 137                     SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.CONFIGURATION,
 138                             routerPortsIdentifier);
 139             if (optionalRouterPorts.isPresent()) {
 140                 LOG.debug("Updating routerPorts node {} in floatingIpInfo DS for floating IP {} on fixed "
 141                     + "neutron port {} : ", routerName, floatingIpAddress, fixedNeutronPortName);
 142                 routerPortsBuilder = new RouterPortsBuilder(optionalRouterPorts.get());
 143             } else {
 144                 LOG.debug("Creating new routerPorts node {} in floatingIpInfo DS for floating IP {} on fixed "
 145                     + "neutron port {} : ", routerName, floatingIpAddress, fixedNeutronPortName);
 146                 routerPortsBuilder =
 147                     new RouterPortsBuilder().withKey(new RouterPortsKey(routerName)).setRouterId(routerName);
 148             }
 149             if (extNetworkId != null) {
 150                 routerPortsBuilder.setExternalNetworkId(extNetworkId);
 151             }
 152             if (fixedNeutronPortName != null) {
 153                 List<Ports> portsList = routerPortsBuilder.getPorts() != null
 154                         ? new ArrayList<Ports>(routerPortsBuilder.getPorts().values()) : new ArrayList<Ports>();
 155                 PortsBuilder fixedNeutronPortBuilder = null;
 156                 for (Ports neutronPort : portsList) {
 157                     if (neutronPort.getPortName().equals(fixedNeutronPortName)) {
 158                         fixedNeutronPortBuilder = new PortsBuilder(neutronPort);
 159                         break;
 160                     }
 161                 }
 162                 if (fixedNeutronPortBuilder == null) {
 163                     fixedNeutronPortBuilder = new PortsBuilder().withKey(new PortsKey(fixedNeutronPortName))
 164                             .setPortName(fixedNeutronPortName);
 165                 }
 166                 if (fixedIpAddress != null) {
 167                     Collection<InternalToExternalPortMap> intExtPortMapCollection = fixedNeutronPortBuilder
 168                         .getInternalToExternalPortMap() != null ? fixedNeutronPortBuilder
 169                         .getInternalToExternalPortMap().values() : null;
 170                     List<InternalToExternalPortMap> intExtPortMapList =
 171                         new ArrayList<InternalToExternalPortMap>(intExtPortMapCollection != null
 172                             ? intExtPortMapCollection : Collections.emptyList());
 173                     InternalToExternalPortMap intExtPortMap = new InternalToExternalPortMapBuilder().withKey(new
 174                             InternalToExternalPortMapKey(fixedIpAddress)).setInternalIp(fixedIpAddress)
 175                             .setExternalIp(floatingIpAddress).setExternalId(floatingIpId).build();
 176                     intExtPortMapList.add(intExtPortMap);
 177                     fixedNeutronPortBuilder.setInternalToExternalPortMap(intExtPortMapList);
 178                 }
 179                 portsList.add(fixedNeutronPortBuilder.build());
 180                 routerPortsBuilder.setPorts(portsList);
 181             }
 182
 183             try (AcquireResult lock = tryRouterLock(routerName)) {
 184                 if (!lock.wasAcquired()) {
 185                     // FIXME: why do we even bother with locking if we do not honor it?!
 186                     logTryLockFailure(routerName);
 187                 }
 188
 189                 LOG.debug("Creating/Updating routerPorts node {} in floatingIpInfo DS for floating IP {} on fixed "
 190                         + "neutron port {} : ", routerName, floatingIpAddress, fixedNeutronPortName);
 191                 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, routerPortsIdentifier,
 192                     routerPortsBuilder.build());
 193                 LOG.debug("FloatingIpInfo DS updated for floating IP {} ", floatingIpAddress);
 194             }
 195         } catch (RuntimeException | ExecutionException | InterruptedException e) {
 196             LOG.error("addToFloatingIpInfo failed for floating IP: {} ", floatingIpAddress, e);
 197         }
 198     }
 199
 200     // TODO Clean up the exception handling
 201     @SuppressWarnings("checkstyle:IllegalCatch")
 202     private void clearFromFloatingIpInfo(String routerName, String fixedNeutronPortName, String fixedIpAddress) {
 203         InstanceIdentifier.InstanceIdentifierBuilder<RouterPorts> routerPortsIdentifierBuilder = InstanceIdentifier
 204                 .builder(FloatingIpInfo.class).child(RouterPorts.class, new RouterPortsKey(routerName));
 205         try {
 206             Optional<RouterPorts> optionalRouterPorts =
 207                     SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.CONFIGURATION,
 208                             routerPortsIdentifierBuilder.build());
 209             if (optionalRouterPorts.isPresent()) {
 210                 RouterPorts routerPorts = optionalRouterPorts.get();
 211                 Map<PortsKey, Ports> keyPortsMap = routerPorts.nonnullPorts();
 212                 Map<InternalToExternalPortMapKey, InternalToExternalPortMap> keyInternalToExternalPortMapMap
 213                         = new HashMap<InternalToExternalPortMapKey, InternalToExternalPortMap>();
 214                 for (Ports ports : keyPortsMap.values()) {
 215                     if (Objects.equals(ports.getPortName(), fixedNeutronPortName)) {
 216                         keyInternalToExternalPortMapMap = ports.nonnullInternalToExternalPortMap();
 217                         break;
 218                     }
 219                 }
 220                 if (keyInternalToExternalPortMapMap.size() == 1) {
 221                     removeRouterPortsOrPortsNode(routerName, routerPortsIdentifierBuilder,
 222                             new ArrayList<Ports>(keyPortsMap.values()), fixedNeutronPortName);
 223                 } else {
 224                     for (InternalToExternalPortMap intToExtMap : keyInternalToExternalPortMapMap.values()) {
 225                         if (Objects.equals(intToExtMap.getInternalIp(), fixedIpAddress)) {
 226                             InstanceIdentifier<InternalToExternalPortMap> intExtPortMapIdentifier =
 227                                     routerPortsIdentifierBuilder.child(Ports
 228                                     .class, new PortsKey(fixedNeutronPortName)).child(InternalToExternalPortMap.class,
 229                                             new InternalToExternalPortMapKey(fixedIpAddress)).build();
 230                             try (AcquireResult lock = tryRouterLock(fixedIpAddress)) {
 231                                 if (!lock.wasAcquired()) {
 232                                     // FIXME: why do we even bother with locking if we do not honor it?!
 233                                     logTryLockFailure(fixedIpAddress);
 234                                 }
 235
 236                                 // remove particular internal-to-external-port-map
 237                                 LOG.debug("removing particular internal-to-external-port-map {}",
 238                                         keyInternalToExternalPortMapMap);
 239                                 try {
 240                                     MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
 241                                         intExtPortMapIdentifier);
 242                                 } catch (Exception e) {
 243                                     LOG.error("Failure in deletion of internal-to-external-port-map {}",
 244                                             keyInternalToExternalPortMapMap, e);
 245                                 }
 246                             }
 247                         }
 248                     }
 249                 }
 250                 LOG.debug("Deletion from FloatingIpInfo DS successful for fixedIp {} ", fixedIpAddress);
 251             } else {
 252                 LOG.warn("routerPorts for router {} - fixedIp {} not found", routerName, fixedIpAddress);
 253             }
 254         } catch (RuntimeException | ExecutionException | InterruptedException e) {
 255             LOG.error("Failed to delete internal-to-external-port-map from FloatingIpInfo DS for fixed Ip {}",
 256                     fixedIpAddress, e);
 257         }
 258     }
 259
 260     protected void dissociatefixedIPFromFloatingIP(String fixedNeutronPortName) {
 261         InstanceIdentifier.InstanceIdentifierBuilder<FloatingIpInfo> floatingIpInfoIdentifierBuilder =
 262                 InstanceIdentifier.builder(FloatingIpInfo.class);
 263         try {
 264             Optional<FloatingIpInfo> optionalFloatingIPInfo =
 265                     SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.CONFIGURATION,
 266                             floatingIpInfoIdentifierBuilder.build());
 267             if (optionalFloatingIPInfo.isPresent()) {
 268                 Map<RouterPortsKey, RouterPorts> keyRouterPortsMap = optionalFloatingIPInfo.get().getRouterPorts();
 269                 if (keyRouterPortsMap != null && !keyRouterPortsMap.isEmpty()) {
 270                     for (RouterPorts routerPorts : keyRouterPortsMap.values()) {
 271                         Map<PortsKey, Ports> keyPortsMap = routerPorts.getPorts();
 272                         if (keyPortsMap != null && !keyPortsMap.isEmpty()) {
 273                             for (Ports ports : keyPortsMap.values()) {
 274                                 if (Objects.equals(ports.getPortName(), fixedNeutronPortName)) {
 275                                     String routerName = routerPorts.getRouterId();
 276                                     InstanceIdentifier.InstanceIdentifierBuilder<RouterPorts>
 277                                         routerPortsIdentifierBuilder = floatingIpInfoIdentifierBuilder
 278                                         .child(RouterPorts.class, new RouterPortsKey(routerName));
 279                                     removeRouterPortsOrPortsNode(routerName, routerPortsIdentifierBuilder,
 280                                             new ArrayList<Ports>(keyPortsMap.values()), fixedNeutronPortName);
 281                                     LOG.debug("Deletion from FloatingIpInfo DS successful for fixedIP neutron port {} ",
 282                                             fixedNeutronPortName);
 283                                     break;
 284                                 }
 285                             }
 286                         }
 287                     }
 288                 } else {
 289                     LOG.debug("No router present containing fixed to floating IP association(s)");
 290                 }
 291             } else {
 292                 LOG.debug("FloatingIPInfo DS empty. Hence, no router present containing fixed to floating IP "
 293                     + "association(s)");
 294             }
 295         } catch (ExecutionException | InterruptedException e) {
 296             LOG.error("Failed to dissociate fixedIP from FloatingIpInfo DS for neutron port {}",
 297                     fixedNeutronPortName, e);
 298         }
 299     }
 300
 301     private void removeRouterPortsOrPortsNode(String routerName,
 302             InstanceIdentifier.InstanceIdentifierBuilder<RouterPorts> routerPortsIdentifierBuilder,
 303             List<Ports> portsList, String fixedNeutronPortName) {
 304         if (portsList.size() == 1) {
 305             // remove entire routerPorts node
 306             try (AcquireResult lock = tryRouterLock(routerName)) {
 307                 if (!lock.wasAcquired()) {
 308                     // FIXME: why do we even bother with locking if we do not honor it?!
 309                     logTryLockFailure(routerName);
 310                 }
 311
 312                 LOG.debug("removing routerPorts node: {} ", routerName);
 313                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, routerPortsIdentifierBuilder
 314                     .build());
 315             }
 316         } else {
 317             // remove entire ports node under this routerPorts node
 318             try (AcquireResult lock = tryRouterLock(fixedNeutronPortName)) {
 319                 if (!lock.wasAcquired()) {
 320                     // FIXME: why do we even bother with locking if we do not honor it?!
 321                     logTryLockFailure(fixedNeutronPortName);
 322                 }
 323
 324                 LOG.debug("removing ports node {} under routerPorts node {}", fixedNeutronPortName, routerName);
 325                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
 326                     routerPortsIdentifierBuilder.child(Ports.class, new PortsKey(fixedNeutronPortName)).build());
 327             }
 328         }
 329     }
 330
 331     // TODO Clean up the exception handling
 332     @SuppressWarnings("checkstyle:IllegalCatch")
 333     // updates FloatingIPPortInfo to have isFloatingIPDeleted set to true on a floating IP delete
 334     private void updateFloatingIpPortInfo(Uuid floatingIpId, Uuid floatingIpPortId) {
 335         InstanceIdentifier<FloatingIpIdToPortMapping>  id = buildfloatingIpIdToPortMappingIdentifier(floatingIpId);
 336         try {
 337             FloatingIpIdToPortMappingBuilder floatingIpIdToPortMappingBuilder = new
 338                     FloatingIpIdToPortMappingBuilder().setFloatingIpId(floatingIpId).setFloatingIpDeleted(true);
 339             LOG.debug("Updating floating IP UUID {} to Floating IP neutron port {} mapping in Floating IP"
 340                     + " Port Info Config DS to set isFloatingIpDeleted flag as true",
 341                 floatingIpId.getValue(), floatingIpPortId.getValue());
 342             MDSALUtil.syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION, id,
 343                     floatingIpIdToPortMappingBuilder.build());
 344         } catch (Exception e) {
 345             LOG.error("Updating floating IP UUID {} to Floating IP neutron port {} mapping in Floating IP"
 346                     + " Port Info Config DS to set isFloatingIpDeleted flag as true failed", floatingIpId.getValue(),
 347                     floatingIpPortId.getValue(), e);
 348         }
 349     }
 350
 351     // TODO Clean up the exception handling
 352     @SuppressWarnings("checkstyle:IllegalCatch")
 353     private void removeFromFloatingIpPortInfo(Uuid floatingIpId) {
 354         InstanceIdentifier<FloatingIpIdToPortMapping>  id = buildfloatingIpIdToPortMappingIdentifier(floatingIpId);
 355         try {
 356             LOG.debug("Deleting floating IP UUID {} to Floating IP neutron port mapping from Floating "
 357                 + "IP Port Info Config DS", floatingIpId.getValue());
 358             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 359         } catch (Exception e) {
 360             LOG.error("Deleting floating IP UUID {} to Floating IP neutron port mapping from Floating "
 361                 + "IP Port Info Config DS failed", floatingIpId.getValue(), e);
 362         }
 363     }
 364
 365     @CheckReturnValue
 366     private AcquireResult tryRouterLock(final String lockName) {
 367         return routerLock.tryAcquire(lockName, LOCK_WAIT_TIME, TimeUnit.SECONDS);
 368     }
 369
 370     private static void logTryLockFailure(String lockName) {
 371         LOG.warn("Lock for {} was not acquired, continuing anyway", lockName, new Throwable());
 372     }
 373 }