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