neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronNetworkChangeListener.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 package org.opendaylight.netvirt.neutronvpn;
   9
  10 import com.google.common.base.Optional;
  11 import java.util.Collections;
  12 import java.util.List;
  13 import java.util.Objects;
  14 import java.util.stream.Collectors;
  15 import javax.annotation.PostConstruct;
  16 import javax.inject.Inject;
  17 import javax.inject.Singleton;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  22 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  23 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  24 import org.opendaylight.netvirt.elanmanager.api.IElanService;
  25 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ElanSegments;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ElanSegmentsBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.neutron.networks.network.Segments;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.common.Uint32;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 @Singleton
  52 public class NeutronNetworkChangeListener
  53         extends AsyncDataTreeChangeListenerBase<Network, NeutronNetworkChangeListener> {
  54     private static final Logger LOG = LoggerFactory.getLogger(NeutronNetworkChangeListener.class);
  55     private final DataBroker dataBroker;
  56     private final NeutronvpnManager nvpnManager;
  57     private final NeutronvpnNatManager nvpnNatManager;
  58     private final IElanService elanService;
  59     private final NeutronvpnUtils neutronvpnUtils;
  60
  61     @Inject
  62     public NeutronNetworkChangeListener(final DataBroker dataBroker, final NeutronvpnManager neutronvpnManager,
  63                                         final NeutronvpnNatManager neutronvpnNatManager,
  64                                         final IElanService elanService, final NeutronvpnUtils neutronvpnUtils) {
  65         super(Network.class, NeutronNetworkChangeListener.class);
  66         this.dataBroker = dataBroker;
  67         nvpnManager = neutronvpnManager;
  68         nvpnNatManager = neutronvpnNatManager;
  69         this.elanService = elanService;
  70         this.neutronvpnUtils = neutronvpnUtils;
  71     }
  72
  73     @Override
  74     @PostConstruct
  75     public void init() {
  76         LOG.info("{} init", getClass().getSimpleName());
  77         registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
  78     }
  79
  80     @Override
  81     protected InstanceIdentifier<Network> getWildCardPath() {
  82         return InstanceIdentifier.create(Neutron.class).child(Networks.class).child(Network.class);
  83     }
  84
  85     @Override
  86     protected NeutronNetworkChangeListener getDataTreeChangeListener() {
  87         return NeutronNetworkChangeListener.this;
  88     }
  89
  90
  91     @Override
  92     protected void add(InstanceIdentifier<Network> identifier, Network input) {
  93         LOG.trace("Adding Network : key: {}, value={}", identifier, input);
  94         String networkId = input.getUuid().getValue();
  95         if (!NeutronvpnUtils.isNetworkTypeSupported(input)) {
  96             LOG.error("Neutronvpn doesn't support the provider type for given network {}", networkId);
  97             return;
  98         }
  99         Class<? extends NetworkTypeBase> networkType = input.augmentation(NetworkProviderExtension.class)
 100                 .getNetworkType();
 101         if (NeutronvpnUtils.isVlanOrVxlanNetwork(networkType)
 102                 && NeutronUtils.getSegmentationIdFromNeutronNetwork(input, networkType) == null) {
 103             LOG.error("Segmentation ID is null for configured provider network {} of type {}. Abandoning any further "
 104                     + "processing for the network", input.getUuid().getValue(), networkType);
 105             return;
 106         }
 107
 108         neutronvpnUtils.addToNetworkCache(input);
 109         // Create ELAN instance for this network
 110         ElanInstance elanInstance = createElanInstance(input);
 111
 112         if (NeutronvpnUtils.getIsExternal(input)) {
 113             // Create ELAN interface and IETF interfaces for the physical network
 114             elanService.createExternalElanNetwork(elanInstance);
 115             ProviderTypes providerNwType = NeutronvpnUtils.getProviderNetworkType(input);
 116             if (providerNwType == null) {
 117                 LOG.error("Unable to get Network Provider Type for network {}", networkId);
 118                 return;
 119             }
 120             LOG.trace("External Network Provider Type for network {} is {}", networkId, providerNwType.getName());
 121             nvpnNatManager.addExternalNetwork(input);
 122             if (NeutronvpnUtils.isFlatOrVlanNetwork(input)) {
 123                 nvpnManager.createL3InternalVpn(input.getUuid(), null, null, null, null, null, null, null);
 124                 nvpnManager.createExternalVpnInterfaces(input.getUuid());
 125             }
 126         }
 127     }
 128
 129     @Override
 130     protected void remove(InstanceIdentifier<Network> identifier, Network input) {
 131         LOG.trace("Removing Network : key: {}, value={}", identifier, input);
 132         if (NeutronvpnUtils.getIsExternal(input)) {
 133             if (NeutronvpnUtils.isFlatOrVlanNetwork(input)) {
 134                 nvpnManager.removeExternalVpnInterfaces(input.getUuid());
 135                 nvpnManager.removeVpn(input.getUuid());
 136             }
 137             nvpnNatManager.removeExternalNetwork(input);
 138         }
 139         //Delete ELAN instance for this network
 140         String elanInstanceName = input.getUuid().getValue();
 141         ElanInstance elanInstance = elanService.getElanInstance(elanInstanceName);
 142         if (elanInstance != null) {
 143             elanService.deleteExternalElanNetwork(elanInstance);
 144             deleteElanInstance(elanInstanceName);
 145         }
 146         neutronvpnUtils.removeFromNetworkCache(input);
 147     }
 148
 149     @Override
 150     protected void update(InstanceIdentifier<Network> identifier, Network original, Network update) {
 151         LOG.trace("Updating Network : key: {}, original value={}, update value={}", identifier, original, update);
 152         neutronvpnUtils.addToNetworkCache(update);
 153         String elanInstanceName = original.getUuid().getValue();
 154         Class<? extends SegmentTypeBase> origSegmentType = NeutronvpnUtils.getSegmentTypeFromNeutronNetwork(original);
 155         String origSegmentationId = NeutronvpnUtils.getSegmentationIdFromNeutronNetwork(original);
 156         String origPhysicalNetwork = NeutronvpnUtils.getPhysicalNetworkName(original);
 157         Class<? extends SegmentTypeBase> updateSegmentType = NeutronvpnUtils.getSegmentTypeFromNeutronNetwork(update);
 158         String updateSegmentationId = NeutronvpnUtils.getSegmentationIdFromNeutronNetwork(update);
 159         String updatePhysicalNetwork = NeutronvpnUtils.getPhysicalNetworkName(update);
 160         Boolean origExternal = NeutronvpnUtils.getIsExternal(original);
 161         Boolean updateExternal = NeutronvpnUtils.getIsExternal(update);
 162         Boolean origIsFlatOrVlanNetwork = NeutronvpnUtils.isFlatOrVlanNetwork(original);
 163         Boolean updateIsFlatOrVlanNetwork = NeutronvpnUtils.isFlatOrVlanNetwork(update);
 164
 165         if (!Objects.equals(origSegmentType, updateSegmentType)
 166                 || !Objects.equals(origSegmentationId, updateSegmentationId)
 167                 || !Objects.equals(origPhysicalNetwork, updatePhysicalNetwork)
 168                 || !Objects.equals(origExternal, updateExternal)) {
 169             if (origExternal && origIsFlatOrVlanNetwork && (!updateExternal || !updateIsFlatOrVlanNetwork)) {
 170                 nvpnManager.removeExternalVpnInterfaces(original.getUuid());
 171                 nvpnManager.removeVpn(original.getUuid());
 172                 nvpnNatManager.removeExternalNetwork(original);
 173             }
 174
 175             ElanInstance elanInstance = elanService.getElanInstance(elanInstanceName);
 176             if (elanInstance != null) {
 177                 elanService.deleteExternalElanNetwork(elanInstance);
 178                 elanInstance = updateElanInstance(elanInstanceName, updateSegmentType, updateSegmentationId,
 179                         updatePhysicalNetwork, update);
 180                 if (updateExternal) {
 181                     elanService.updateExternalElanNetwork(elanInstance);
 182                 }
 183             }
 184
 185             if (updateExternal && updateIsFlatOrVlanNetwork && !origExternal) {
 186                 nvpnNatManager.addExternalNetwork(update);
 187                 nvpnManager.createL3InternalVpn(update.getUuid(), null, null, null, null, null, null, null);
 188                 nvpnManager.createExternalVpnInterfaces(update.getUuid());
 189             }
 190         }
 191     }
 192
 193     @NonNull
 194     private List<ElanSegments> buildSegments(Network input) {
 195         NetworkProviderExtension providerExtension = input.augmentation(NetworkProviderExtension.class);
 196         if (providerExtension == null || providerExtension.getSegments() == null) {
 197             return Collections.emptyList();
 198         }
 199         return providerExtension.getSegments().stream()
 200                 .map(segment -> new ElanSegmentsBuilder()
 201                         .setSegmentationIndex(segment.getSegmentationIndex())
 202                         .setSegmentationId(getSegmentationId(input, segment))
 203                         .setSegmentType(elanSegmentTypeFromNetworkType(segment.getNetworkType()))
 204                         .build())
 205                 .collect(Collectors.toList());
 206     }
 207
 208     private Long getSegmentationId(Network network, Segments segment) {
 209         try {
 210             if (segment.getSegmentationId() != null) {
 211                 return Long.valueOf(segment.getSegmentationId());
 212             }
 213         } catch (NumberFormatException error) {
 214             LOG.error("Failed to get the segment id for network {}", network);
 215         }
 216         return 0L;
 217     }
 218
 219     @Nullable
 220     private Class<? extends SegmentTypeBase> elanSegmentTypeFromNetworkType(
 221             @Nullable Class<? extends NetworkTypeBase> networkType) {
 222         if (networkType == null) {
 223             return null;
 224         }
 225         if (networkType.isAssignableFrom(NetworkTypeVxlan.class)) {
 226             return SegmentTypeVxlan.class;
 227         } else if (networkType.isAssignableFrom(NetworkTypeVlan.class)) {
 228             return SegmentTypeVlan.class;
 229         } else if (networkType.isAssignableFrom(NetworkTypeFlat.class)) {
 230             return SegmentTypeFlat.class;
 231         }
 232         return null;
 233     }
 234
 235     private ElanInstance createElanInstance(Network input) {
 236         String elanInstanceName = input.getUuid().getValue();
 237         InstanceIdentifier<ElanInstance> id = createElanInstanceIdentifier(elanInstanceName);
 238         Optional<ElanInstance> existingElanInstance = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
 239                 id);
 240         if (existingElanInstance.isPresent()) {
 241             return existingElanInstance.get();
 242         }
 243         Class<? extends SegmentTypeBase> segmentType = NeutronvpnUtils.getSegmentTypeFromNeutronNetwork(input);
 244         String segmentationId = NeutronvpnUtils.getSegmentationIdFromNeutronNetwork(input);
 245         String physicalNetworkName = NeutronvpnUtils.getPhysicalNetworkName(input);
 246         Uint32 elanTag = elanService.retrieveNewElanTag(elanInstanceName);
 247         ElanInstance elanInstance = createElanInstanceBuilder(elanInstanceName, segmentType, segmentationId,
 248                 physicalNetworkName, input).setElanTag(elanTag).build();
 249         MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, elanInstance);
 250         LOG.debug("ELANInstance {} created with elan tag {} and segmentation ID {}", elanInstanceName, elanTag,
 251                 segmentationId);
 252         return elanInstance;
 253     }
 254
 255     private ElanInstanceBuilder createElanInstanceBuilder(String elanInstanceName, Class<? extends SegmentTypeBase>
 256             segmentType, String segmentationId, String physicalNetworkName, Network network) {
 257         Boolean isExternal = NeutronvpnUtils.getIsExternal(network);
 258         List<ElanSegments> segments = buildSegments(network);
 259         ElanInstanceBuilder elanInstanceBuilder = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName);
 260         if (segmentType != null) {
 261             elanInstanceBuilder.setSegmentType(segmentType);
 262             if (segmentationId != null) {
 263                 elanInstanceBuilder.setSegmentationId(Long.valueOf(segmentationId));
 264             }
 265             if (physicalNetworkName != null) {
 266                 elanInstanceBuilder.setPhysicalNetworkName(physicalNetworkName);
 267             }
 268         }
 269
 270         elanInstanceBuilder.setElanSegments(segments);
 271         elanInstanceBuilder.setExternal(isExternal);
 272         elanInstanceBuilder.withKey(new ElanInstanceKey(elanInstanceName));
 273         return elanInstanceBuilder;
 274     }
 275
 276     private void deleteElanInstance(String elanInstanceName) {
 277         InstanceIdentifier<ElanInstance> id = createElanInstanceIdentifier(elanInstanceName);
 278         MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 279         LOG.debug("ELANInstance {} deleted", elanInstanceName);
 280     }
 281
 282     private ElanInstance updateElanInstance(String elanInstanceName, Class<? extends SegmentTypeBase> segmentType,
 283                                             String segmentationId, String physicalNetworkName, Network network) {
 284
 285         ElanInstance elanInstance = createElanInstanceBuilder(elanInstanceName, segmentType, segmentationId,
 286                 physicalNetworkName, network).build();
 287         InstanceIdentifier<ElanInstance> id = createElanInstanceIdentifier(elanInstanceName);
 288         MDSALUtil.syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION, id, elanInstance);
 289         return elanInstance;
 290     }
 291
 292     private InstanceIdentifier<ElanInstance> createElanInstanceIdentifier(String elanInstanceName) {
 293         InstanceIdentifier<ElanInstance> id = InstanceIdentifier.builder(ElanInstances.class)
 294                 .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 295         return id;
 296     }
 297 }