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