2 * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.netvirt.neutronvpn;
10 import java.util.Collections;
11 import java.util.List;
12 import java.util.Objects;
13 import java.util.Optional;
14 import java.util.concurrent.ExecutionException;
15 import java.util.stream.Collectors;
16 import javax.annotation.PreDestroy;
17 import javax.inject.Inject;
18 import javax.inject.Singleton;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.eclipse.jdt.annotation.Nullable;
21 import org.opendaylight.genius.mdsalutil.MDSALUtil;
22 import org.opendaylight.infrautils.utils.concurrent.Executors;
23 import org.opendaylight.mdsal.binding.api.DataBroker;
24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
25 import org.opendaylight.netvirt.elanmanager.api.IElanService;
26 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
27 import org.opendaylight.serviceutils.tools.listener.AbstractAsyncDataTreeChangeListener;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ElanSegments;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ElanSegmentsBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.neutron.networks.network.Segments;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
49 import org.opendaylight.yangtools.yang.common.Uint32;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
54 public class NeutronNetworkChangeListener extends AbstractAsyncDataTreeChangeListener<Network> {
55 private static final Logger LOG = LoggerFactory.getLogger(NeutronNetworkChangeListener.class);
56 private final DataBroker dataBroker;
57 private final NeutronvpnManager nvpnManager;
58 private final NeutronvpnNatManager nvpnNatManager;
59 private final IElanService elanService;
60 private final NeutronvpnUtils neutronvpnUtils;
63 public NeutronNetworkChangeListener(final DataBroker dataBroker, final NeutronvpnManager neutronvpnManager,
64 final NeutronvpnNatManager neutronvpnNatManager,
65 final IElanService elanService, final NeutronvpnUtils neutronvpnUtils) {
66 super(dataBroker, LogicalDatastoreType.CONFIGURATION, InstanceIdentifier.create(Neutron.class)
67 .child(Networks.class).child(Network.class), Executors.newSingleThreadExecutor(
68 "NeutronNetworkChangeListener", LOG));
69 this.dataBroker = dataBroker;
70 nvpnManager = neutronvpnManager;
71 nvpnNatManager = neutronvpnNatManager;
72 this.elanService = elanService;
73 this.neutronvpnUtils = neutronvpnUtils;
77 LOG.info("{} init", getClass().getSimpleName());
84 Executors.shutdownAndAwaitTermination(getExecutorService());
88 public void add(InstanceIdentifier<Network> identifier, Network input) {
89 LOG.trace("Adding Network : key: {}, value={}", identifier, input);
90 String networkId = input.getUuid().getValue();
91 if (!NeutronvpnUtils.isNetworkTypeSupported(input)) {
92 LOG.error("Neutronvpn doesn't support the provider type for given network {}", networkId);
95 Class<? extends NetworkTypeBase> networkType = input.augmentation(NetworkProviderExtension.class)
97 if (NeutronvpnUtils.isVlanOrVxlanNetwork(networkType)
98 && NeutronUtils.getSegmentationIdFromNeutronNetwork(input, networkType) == null) {
99 LOG.error("Segmentation ID is null for configured provider network {} of type {}. Abandoning any further "
100 + "processing for the network", input.getUuid().getValue(), networkType);
104 neutronvpnUtils.addToNetworkCache(input);
105 // Create ELAN instance for this network
106 ElanInstance elanInstance = createElanInstance(input);
108 if (NeutronvpnUtils.getIsExternal(input)) {
109 // Create ELAN interface and IETF interfaces for the physical network
110 elanService.createExternalElanNetwork(elanInstance);
111 ProviderTypes providerNwType = NeutronvpnUtils.getProviderNetworkType(input);
112 if (providerNwType == null) {
113 LOG.error("Unable to get Network Provider Type for network {}", networkId);
116 LOG.trace("External Network Provider Type for network {} is {}", networkId, providerNwType.getName());
117 nvpnNatManager.addExternalNetwork(input);
118 if (NeutronvpnUtils.isFlatOrVlanNetwork(input)) {
119 nvpnManager.createL3InternalVpn(input.getUuid(), null, null, null, null, null, null, null);
120 nvpnManager.createExternalVpnInterfaces(input.getUuid());
126 public void remove(InstanceIdentifier<Network> identifier, Network input) {
127 LOG.trace("Removing Network : key: {}, value={}", identifier, input);
128 if (NeutronvpnUtils.getIsExternal(input)) {
129 if (NeutronvpnUtils.isFlatOrVlanNetwork(input)) {
130 nvpnManager.removeExternalVpnInterfaces(input.getUuid());
131 nvpnManager.removeVpn(input.getUuid());
133 nvpnNatManager.removeExternalNetwork(input);
135 //Delete ELAN instance for this network
136 String elanInstanceName = input.getUuid().getValue();
137 ElanInstance elanInstance = elanService.getElanInstance(elanInstanceName);
138 if (elanInstance != null) {
139 elanService.deleteExternalElanNetwork(elanInstance);
140 deleteElanInstance(elanInstanceName);
142 neutronvpnUtils.removeFromNetworkCache(input);
146 public void update(InstanceIdentifier<Network> identifier, Network original, Network update) {
147 LOG.trace("Updating Network : key: {}, original value={}, update value={}", identifier, original, update);
148 if (Objects.equals(original, update)) {
151 neutronvpnUtils.addToNetworkCache(update);
152 String elanInstanceName = original.getUuid().getValue();
153 Class<? extends SegmentTypeBase> origSegmentType = NeutronvpnUtils.getSegmentTypeFromNeutronNetwork(original);
154 String origSegmentationId = NeutronvpnUtils.getSegmentationIdFromNeutronNetwork(original);
155 String origPhysicalNetwork = NeutronvpnUtils.getPhysicalNetworkName(original);
156 Class<? extends SegmentTypeBase> updateSegmentType = NeutronvpnUtils.getSegmentTypeFromNeutronNetwork(update);
157 String updateSegmentationId = NeutronvpnUtils.getSegmentationIdFromNeutronNetwork(update);
158 String updatePhysicalNetwork = NeutronvpnUtils.getPhysicalNetworkName(update);
159 Boolean origExternal = NeutronvpnUtils.getIsExternal(original);
160 Boolean updateExternal = NeutronvpnUtils.getIsExternal(update);
161 Boolean origIsFlatOrVlanNetwork = NeutronvpnUtils.isFlatOrVlanNetwork(original);
162 Boolean updateIsFlatOrVlanNetwork = NeutronvpnUtils.isFlatOrVlanNetwork(update);
164 if (!Objects.equals(origSegmentType, updateSegmentType)
165 || !Objects.equals(origSegmentationId, updateSegmentationId)
166 || !Objects.equals(origPhysicalNetwork, updatePhysicalNetwork)
167 || !Objects.equals(origExternal, updateExternal)) {
168 if (origExternal && origIsFlatOrVlanNetwork && (!updateExternal || !updateIsFlatOrVlanNetwork)) {
169 nvpnManager.removeExternalVpnInterfaces(original.getUuid());
170 nvpnManager.removeVpn(original.getUuid());
171 nvpnNatManager.removeExternalNetwork(original);
174 ElanInstance elanInstance = elanService.getElanInstance(elanInstanceName);
175 if (elanInstance != null) {
176 elanService.deleteExternalElanNetwork(elanInstance);
177 elanInstance = updateElanInstance(elanInstanceName, updateSegmentType, updateSegmentationId,
178 updatePhysicalNetwork, update);
179 if (updateExternal) {
180 elanService.updateExternalElanNetwork(elanInstance);
184 if (updateExternal && updateIsFlatOrVlanNetwork && !origExternal) {
185 nvpnNatManager.addExternalNetwork(update);
186 nvpnManager.createL3InternalVpn(update.getUuid(), null, null, null, null, null, null, null);
187 nvpnManager.createExternalVpnInterfaces(update.getUuid());
193 private List<ElanSegments> buildSegments(Network input) {
194 NetworkProviderExtension providerExtension = input.augmentation(NetworkProviderExtension.class);
195 if (providerExtension == null || providerExtension.getSegments() == null) {
196 return Collections.emptyList();
198 return providerExtension.getSegments().values().stream()
199 .map(segment -> new ElanSegmentsBuilder()
200 .setSegmentationIndex(segment.getSegmentationIndex())
201 .setSegmentationId(getSegmentationId(input, segment))
202 .setSegmentType(elanSegmentTypeFromNetworkType(segment.getNetworkType()))
204 .collect(Collectors.toList());
207 private Long getSegmentationId(Network network, Segments segment) {
209 if (segment.getSegmentationId() != null) {
210 return Long.valueOf(segment.getSegmentationId());
212 } catch (NumberFormatException error) {
213 LOG.error("Failed to get the segment id for network {}", network);
219 private Class<? extends SegmentTypeBase> elanSegmentTypeFromNetworkType(
220 @Nullable Class<? extends NetworkTypeBase> networkType) {
221 if (networkType == null) {
224 if (networkType.isAssignableFrom(NetworkTypeVxlan.class)) {
225 return SegmentTypeVxlan.class;
226 } else if (networkType.isAssignableFrom(NetworkTypeVlan.class)) {
227 return SegmentTypeVlan.class;
228 } else if (networkType.isAssignableFrom(NetworkTypeFlat.class)) {
229 return SegmentTypeFlat.class;
234 private ElanInstance createElanInstance(Network input) {
235 String elanInstanceName = input.getUuid().getValue();
236 InstanceIdentifier<ElanInstance> id = createElanInstanceIdentifier(elanInstanceName);
237 Optional<ElanInstance> existingElanInstance = null;
239 existingElanInstance = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
241 if (existingElanInstance.isPresent()) {
242 return existingElanInstance.get();
244 } catch (ExecutionException | InterruptedException e) {
245 LOG.error("createElanInstance: failed to read elanInstance {} due to exception ", elanInstanceName, e);
247 Class<? extends SegmentTypeBase> segmentType = NeutronvpnUtils.getSegmentTypeFromNeutronNetwork(input);
248 String segmentationId = NeutronvpnUtils.getSegmentationIdFromNeutronNetwork(input);
249 String physicalNetworkName = NeutronvpnUtils.getPhysicalNetworkName(input);
250 Uint32 elanTag = elanService.retrieveNewElanTag(elanInstanceName);
251 ElanInstance elanInstance = createElanInstanceBuilder(elanInstanceName, segmentType, segmentationId,
252 physicalNetworkName, input).setElanTag(elanTag).build();
253 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, elanInstance);
254 LOG.debug("ELANInstance {} created with elan tag {} and segmentation ID {}", elanInstanceName, elanTag,
259 private ElanInstanceBuilder createElanInstanceBuilder(String elanInstanceName, Class<? extends SegmentTypeBase>
260 segmentType, String segmentationId, String physicalNetworkName, Network network) {
261 Boolean isExternal = NeutronvpnUtils.getIsExternal(network);
262 List<ElanSegments> segments = buildSegments(network);
263 ElanInstanceBuilder elanInstanceBuilder = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName);
264 if (segmentType != null) {
265 elanInstanceBuilder.setSegmentType(segmentType);
266 if (segmentationId != null) {
267 elanInstanceBuilder.setSegmentationId(Long.valueOf(segmentationId));
269 if (physicalNetworkName != null) {
270 elanInstanceBuilder.setPhysicalNetworkName(physicalNetworkName);
274 elanInstanceBuilder.setElanSegments(segments);
275 elanInstanceBuilder.setExternal(isExternal);
276 elanInstanceBuilder.withKey(new ElanInstanceKey(elanInstanceName));
277 return elanInstanceBuilder;
280 private void deleteElanInstance(String elanInstanceName) {
281 InstanceIdentifier<ElanInstance> id = createElanInstanceIdentifier(elanInstanceName);
282 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
283 LOG.debug("ELANInstance {} deleted", elanInstanceName);
286 private ElanInstance updateElanInstance(String elanInstanceName, Class<? extends SegmentTypeBase> segmentType,
287 String segmentationId, String physicalNetworkName, Network network) {
289 ElanInstance elanInstance = createElanInstanceBuilder(elanInstanceName, segmentType, segmentationId,
290 physicalNetworkName, network).build();
291 InstanceIdentifier<ElanInstance> id = createElanInstanceIdentifier(elanInstanceName);
292 MDSALUtil.syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION, id, elanInstance);
296 private InstanceIdentifier<ElanInstance> createElanInstanceIdentifier(String elanInstanceName) {
297 InstanceIdentifier<ElanInstance> id = InstanceIdentifier.builder(ElanInstances.class)
298 .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();