2 * Copyright (c) 2017 HPE 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.elan.utils;
10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
12 import com.google.common.base.Optional;
13 import com.google.common.collect.MapDifference;
14 import com.google.common.collect.MapDifference.ValueDifference;
15 import com.google.common.collect.Maps;
16 import java.math.BigInteger;
17 import java.util.Collections;
18 import java.util.HashSet;
19 import java.util.List;
21 import java.util.Map.Entry;
22 import java.util.Objects;
24 import java.util.concurrent.ExecutionException;
25 import java.util.stream.Collectors;
26 import javax.inject.Inject;
27 import javax.inject.Singleton;
28 import org.eclipse.jdt.annotation.NonNull;
29 import org.eclipse.jdt.annotation.Nullable;
30 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
32 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
33 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
34 import org.opendaylight.genius.infra.Datastore.Configuration;
35 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
36 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
37 import org.opendaylight.genius.infra.TypedReadTransaction;
38 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
39 import org.opendaylight.genius.infra.TypedWriteTransaction;
40 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
41 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
42 import org.opendaylight.netvirt.elan.internal.ElanBridgeManager;
43 import org.opendaylight.netvirt.elanmanager.api.IElanService;
44 import org.opendaylight.ovsdb.utils.mdsal.utils.ControllerMdsalUtils;
45 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.BridgeRefInfo;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntry;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryKey;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembership;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Vteps;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsKey;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.config.rev150710.ElanConfig;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces;
67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
73 public class TransportZoneNotificationUtil {
74 private static final Logger LOG = LoggerFactory.getLogger(TransportZoneNotificationUtil.class);
75 private static final String TUNNEL_PORT = "tunnel_port";
76 private static final String LOCAL_IP = "local_ip";
77 private static final String LOCAL_IPS = "local_ips";
78 private static final char IP_NETWORK_ZONE_NAME_DELIMITER = '-';
79 private static final String ALL_SUBNETS_GW = "0.0.0.0";
80 private static final String ALL_SUBNETS = "0.0.0.0/0";
81 private final ManagedNewTransactionRunner txRunner;
82 private final SingleTransactionDataBroker singleTxBroker;
83 private final SouthboundUtils southBoundUtils;
84 private final IElanService elanService;
85 private final ElanConfig elanConfig;
86 private final ElanBridgeManager elanBridgeManager;
87 private final ElanInstanceCache elanInstanceCache;
90 public TransportZoneNotificationUtil(final DataBroker dbx,
91 final IElanService elanService, final ElanConfig elanConfig, final ElanBridgeManager elanBridgeManager,
92 final ElanInstanceCache elanInstanceCache) {
93 this.txRunner = new ManagedNewTransactionRunnerImpl(dbx);
94 this.singleTxBroker = new SingleTransactionDataBroker(dbx);
95 this.elanService = elanService;
96 this.elanConfig = elanConfig;
97 this.elanBridgeManager = elanBridgeManager;
98 this.elanInstanceCache = elanInstanceCache;
99 southBoundUtils = new SouthboundUtils(new ControllerMdsalUtils(dbx));
102 public boolean shouldCreateVtep(List<VpnInterfaces> vpnInterfaces) {
103 if (vpnInterfaces == null || vpnInterfaces.isEmpty()) {
107 for (VpnInterfaces vpnInterface : vpnInterfaces) {
108 String interfaceName = vpnInterface.getInterfaceName();
110 ElanInterface elanInt = elanService.getElanInterfaceByElanInterfaceName(interfaceName);
111 if (elanInt == null) {
115 if (ElanUtils.isVxlanNetworkOrVxlanSegment(
116 elanInstanceCache.get(elanInt.getElanInstanceName()).orNull())) {
119 LOG.debug("Non-VXLAN elanInstance: {}", elanInt.getElanInstanceName());
126 private static TransportZone createZone(String subnetIp, String zoneName) {
127 TransportZoneBuilder tzb = new TransportZoneBuilder().withKey(new TransportZoneKey(zoneName))
128 .setTunnelType(TunnelTypeVxlan.class).setZoneName(zoneName);
132 private static void updateTransportZone(TransportZone zone, BigInteger dpnId,
133 @NonNull TypedWriteTransaction<Configuration> tx) {
134 InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
135 .child(TransportZone.class, new TransportZoneKey(zone.getZoneName())).build();
137 tx.merge(path, zone);
138 LOG.info("Transport zone {} updated due to dpn {} handling.", zone.getZoneName(), dpnId);
141 public void updateTransportZone(String zoneNamePrefix, BigInteger dpnId) {
142 LoggingFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
143 Map<String, String> localIps = getDpnLocalIps(dpnId);
144 if (!localIps.isEmpty()) {
145 LOG.debug("Will use local_ips for transport zone update for dpn {} and zone name prefix {}", dpnId,
147 for (Entry<String, String> entry : localIps.entrySet()) {
148 String localIp = entry.getKey();
149 String underlayNetworkName = entry.getValue();
150 String zoneName = getTzNameForUnderlayNetwork(zoneNamePrefix, underlayNetworkName);
151 updateTransportZone(zoneName, dpnId, localIp, tx);
154 updateTransportZone(zoneNamePrefix, dpnId, getDpnLocalIp(dpnId), tx);
156 }), LOG, "Error updating transport zone");
159 @SuppressWarnings("checkstyle:IllegalCatch")
160 private void updateTransportZone(String zoneName, BigInteger dpnId, @Nullable String localIp,
161 @NonNull TypedReadWriteTransaction<Configuration> tx)
162 throws ExecutionException, InterruptedException {
163 InstanceIdentifier<TransportZone> inst = InstanceIdentifier.create(TransportZones.class)
164 .child(TransportZone.class, new TransportZoneKey(zoneName));
166 // FIXME: Read this through a cache
167 TransportZone zone = tx.read(inst).get().orNull();
170 zone = createZone(ALL_SUBNETS, zoneName);
174 if (addVtep(zone, ALL_SUBNETS, dpnId, localIp)) {
175 updateTransportZone(zone, dpnId, tx);
177 } catch (Exception e) {
178 LOG.error("Failed to add tunnels for dpn {} in zone {}", dpnId, zoneName, e);
182 private static void deleteTransportZone(TransportZone zone, BigInteger dpnId,
183 @NonNull TypedWriteTransaction<Configuration> tx) {
184 InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
185 .child(TransportZone.class, new TransportZoneKey(zone.getZoneName())).build();
187 LOG.info("Transport zone {} deleted due to dpn {} handling.", zone.getZoneName(), dpnId);
190 public void deleteTransportZone(String zoneNamePrefix, BigInteger dpnId) {
191 LoggingFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
192 Map<String, String> localIps = getDpnLocalIps(dpnId);
193 if (!localIps.isEmpty()) {
194 LOG.debug("Will use local_ips for transport zone delete for dpn {} and zone name prefix {}", dpnId,
196 for (String underlayNetworkName : localIps.values()) {
197 String zoneName = getTzNameForUnderlayNetwork(zoneNamePrefix, underlayNetworkName);
198 deleteTransportZone(zoneName, dpnId, tx);
201 deleteTransportZone(zoneNamePrefix, dpnId, tx);
203 }), LOG, "Error deleting transport zone");
206 @SuppressWarnings("checkstyle:IllegalCatch")
207 private static void deleteTransportZone(String zoneName, BigInteger dpnId,
208 @NonNull TypedReadWriteTransaction<Configuration> tx) throws ExecutionException, InterruptedException {
209 InstanceIdentifier<TransportZone> inst = InstanceIdentifier.create(TransportZones.class)
210 .child(TransportZone.class, new TransportZoneKey(zoneName));
212 // FIXME: Read this through a cache
213 TransportZone zone = tx.read(inst).get().orNull();
216 deleteTransportZone(zone, dpnId, tx);
217 } catch (Exception e) {
218 LOG.error("Failed to remove tunnels for dpn {} in zone {}", dpnId, zoneName, e);
225 * Update transport zones based on local_ips TEP ips mapping to underlay
227 * Deleted local_ips will be removed from the VTEP list of the corresponding
228 * transport zones.<br>
229 * Added local_ips will be added to all transport zones currently associated
231 * local_ips for whom the underlay network mapping has been changed will be
232 * updated in the VTEP lists of the corresponding transport zones.
238 * @param managerNodeId
239 * uuid of the OVS manager node
241 public void handleOvsdbNodeUpdate(Node origNode, Node updatedNode, String managerNodeId) {
243 String> origLocalIpMap = java.util.Optional
244 .ofNullable(elanBridgeManager.getOpenvswitchOtherConfigMap(origNode, LOCAL_IPS))
245 .orElse(Collections.emptyMap());
247 String> updatedLocalIpMap = java.util.Optional
248 .ofNullable(elanBridgeManager.getOpenvswitchOtherConfigMap(updatedNode, LOCAL_IPS))
249 .orElse(Collections.emptyMap());
250 MapDifference<String, String> mapDiff = Maps.difference(origLocalIpMap, updatedLocalIpMap);
251 if (mapDiff.areEqual()) {
255 java.util.Optional<BigInteger> dpIdOpt = elanBridgeManager.getDpIdFromManagerNodeId(managerNodeId);
256 if (!dpIdOpt.isPresent()) {
257 LOG.debug("No DPN id found for node {}", managerNodeId);
261 LoggingFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
262 BigInteger dpId = dpIdOpt.get();
263 Optional<DPNTEPsInfo> dpnTepsInfoOpt = getDpnTepsInfo(dpId, tx);
264 if (!dpnTepsInfoOpt.isPresent()) {
265 LOG.debug("No DPNTEPsInfo found for DPN id {}", dpId);
269 List<TunnelEndPoints> tunnelEndPoints = dpnTepsInfoOpt.get().getTunnelEndPoints();
270 if (tunnelEndPoints == null || tunnelEndPoints.isEmpty()) {
271 LOG.debug("No tunnel endpoints defined for DPN id {}", dpId);
275 Set<String> zonePrefixes = new HashSet<>();
276 Map<String, List<String>> tepTzMap = tunnelEndPoints.stream().collect(Collectors
277 .toMap(tep -> tep.getIpAddress().stringValue(), this::getTepTransportZoneNames));
278 LOG.trace("Transport zone prefixes {}", tepTzMap);
280 handleRemovedLocalIps(mapDiff.entriesOnlyOnLeft(), dpId, zonePrefixes, tepTzMap, tx);
281 handleChangedLocalIps(mapDiff.entriesDiffering(), dpId, zonePrefixes, tepTzMap, tx);
282 handleAddedLocalIps(mapDiff.entriesOnlyOnRight(), dpId, zonePrefixes, tx);
283 }), LOG, "Error handling OVSDB node update");
286 private void handleAddedLocalIps(Map<String, String> addedEntries, BigInteger dpId, Set<String> zonePrefixes,
287 TypedReadWriteTransaction<Configuration> tx) throws ExecutionException, InterruptedException {
288 if (addedEntries == null || addedEntries.isEmpty()) {
289 LOG.trace("No added local_ips found for DPN {}", dpId);
293 LOG.debug("Added local_ips {} on DPN {}", addedEntries.keySet(), dpId);
294 for (Map.Entry<String, String> addedEntry : addedEntries.entrySet()) {
295 String ipAddress = addedEntry.getKey();
296 String underlayNetworkName = addedEntry.getValue();
297 for (String zonePrefix : zonePrefixes) {
298 String zoneName = getTzNameForUnderlayNetwork(zonePrefix, underlayNetworkName);
299 updateTransportZone(zoneName, dpId, ipAddress, tx);
304 private void handleChangedLocalIps(Map<String, ValueDifference<String>> changedEntries, BigInteger dpId,
305 Set<String> zonePrefixes, Map<String, List<String>> tepTzMap,
306 @NonNull TypedReadWriteTransaction<Configuration> tx) throws ExecutionException, InterruptedException {
307 if (changedEntries == null || changedEntries.isEmpty()) {
308 LOG.trace("No changed local_ips found for DPN {}", dpId);
312 LOG.debug("Changing underlay network mapping for local_ips {} on DPN {}", changedEntries.keySet(), dpId);
313 for (Map.Entry<String, ValueDifference<String>> changedEntry : changedEntries.entrySet()) {
314 String ipAddress = changedEntry.getKey();
315 ValueDifference<String> underlayNetworkDiff = changedEntry.getValue();
316 List<String> zoneNames = tepTzMap.get(ipAddress);
317 if (zoneNames != null) {
318 for (String zoneName : zoneNames) {
319 String removedUnderlayNetwork = underlayNetworkDiff.leftValue();
320 String addedUnderlayNetwork = underlayNetworkDiff.rightValue();
321 Optional<String> zonePrefixOpt = getZonePrefixForUnderlayNetwork(zoneName, removedUnderlayNetwork);
322 if (zonePrefixOpt.isPresent()) {
323 String zonePrefix = zonePrefixOpt.get();
324 removeVtep(zoneName, dpId, tx);
325 zonePrefixes.add(zonePrefix);
326 String newZoneName = getTzNameForUnderlayNetwork(zonePrefix, addedUnderlayNetwork);
327 updateTransportZone(newZoneName, dpId, ipAddress, tx);
334 private static void handleRemovedLocalIps(Map<String, String> removedEntries, BigInteger dpId,
335 Set<String> zonePrefixes, Map<String, List<String>> tepTzMap,
336 @NonNull TypedWriteTransaction<Configuration> tx) {
337 if (removedEntries == null || removedEntries.isEmpty()) {
338 LOG.trace("No removed local_ips found on DPN {}", dpId);
342 LOG.debug("Removed local_ips {} for DPN {}", removedEntries.keySet(), dpId);
343 removedEntries.forEach((ipAddress, underlayNetworkName) -> {
344 List<String> zoneNames = tepTzMap.get(ipAddress);
345 if (zoneNames != null) {
346 for (String zoneName : zoneNames) {
347 Optional<String> zonePrefix = getZonePrefixForUnderlayNetwork(zoneName, underlayNetworkName);
348 if (zonePrefix.isPresent()) {
349 removeVtep(zoneName, dpId, tx);
350 zonePrefixes.add(zonePrefix.get());
357 private List<String> getTepTransportZoneNames(TunnelEndPoints tep) {
358 List<TzMembership> tzMembershipList = tep.getTzMembership();
359 if (tzMembershipList == null) {
360 LOG.debug("No TZ membership exist for TEP ip {}", tep.getIpAddress().stringValue());
361 return Collections.emptyList();
364 return tzMembershipList.stream().map(TzMembership::getZoneName).distinct()
365 .collect(Collectors.toList());
368 private static Optional<DPNTEPsInfo> getDpnTepsInfo(BigInteger dpId, TypedReadTransaction<Configuration> tx) {
369 InstanceIdentifier<DPNTEPsInfo> identifier = InstanceIdentifier.builder(DpnEndpoints.class)
370 .child(DPNTEPsInfo.class, new DPNTEPsInfoKey(dpId)).build();
372 return tx.read(identifier).get();
373 } catch (InterruptedException | ExecutionException e) {
374 LOG.warn("Failed to read DPNTEPsInfo for DPN id {}", dpId);
375 return Optional.absent();
380 * Tries to add a vtep for a transport zone.
382 * @return Whether a vtep was added or not.
384 private boolean addVtep(TransportZone zone, String subnetIp, BigInteger dpnId, @Nullable String localIp) {
385 for (Vteps existingVtep : zone.nonnullVteps()) {
386 if (Objects.equals(existingVtep.getDpnId(), dpnId)) {
391 if (localIp != null) {
392 IpAddress nodeIp = IpAddressBuilder.getDefaultInstance(localIp);
393 VtepsBuilder vtepsBuilder = new VtepsBuilder().setDpnId(dpnId).setIpAddress(nodeIp)
394 .setOptionOfTunnel(elanConfig.isUseOfTunnels());
395 zone.getVteps().add(vtepsBuilder.build());
402 private static void removeVtep(String zoneName, BigInteger dpId, @NonNull TypedWriteTransaction<Configuration> tx) {
403 InstanceIdentifier<Vteps> path = InstanceIdentifier.builder(TransportZones.class)
404 .child(TransportZone.class, new TransportZoneKey(zoneName))
405 .child(Vteps.class, new VtepsKey(dpId)).build();
410 private String getDpnLocalIp(BigInteger dpId) throws ReadFailedException {
411 Optional<Node> node = getPortsNode(dpId);
413 if (node.isPresent()) {
414 String localIp = southBoundUtils.getOpenvswitchOtherConfig(node.get(), LOCAL_IP);
415 if (localIp == null) {
416 LOG.error("missing local_ip key in ovsdb:openvswitch-other-configs in operational"
417 + " network-topology for node: {}", node.get().getNodeId().getValue());
427 private Map<String, String> getDpnLocalIps(BigInteger dpId) throws ReadFailedException {
428 // Example of local IPs from other_config:
429 // local_ips="10.0.43.159:MPLS,11.11.11.11:DSL,ip:underlay-network"
430 return getPortsNode(dpId).toJavaUtil().map(
431 node -> elanBridgeManager.getOpenvswitchOtherConfigMap(node, LOCAL_IPS)).orElse(Collections.emptyMap());
434 @SuppressWarnings("unchecked")
435 private Optional<Node> getPortsNode(BigInteger dpnId) throws ReadFailedException {
436 InstanceIdentifier<BridgeRefEntry> bridgeRefInfoPath = InstanceIdentifier.create(BridgeRefInfo.class)
437 .child(BridgeRefEntry.class, new BridgeRefEntryKey(dpnId));
439 // FIXME: Read this through a cache
440 Optional<BridgeRefEntry> optionalBridgeRefEntry =
441 singleTxBroker.syncReadOptional(LogicalDatastoreType.OPERATIONAL, bridgeRefInfoPath);
442 if (!optionalBridgeRefEntry.isPresent()) {
443 LOG.error("no bridge ref entry found for dpnId {}", dpnId);
444 return Optional.absent();
447 InstanceIdentifier<Node> nodeId =
448 optionalBridgeRefEntry.get().getBridgeReference().getValue().firstIdentifierOf(Node.class);
450 // FIXME: Read this through a cache
451 Optional<Node> optionalNode = singleTxBroker.syncReadOptional(LogicalDatastoreType.OPERATIONAL, nodeId);
452 if (!optionalNode.isPresent()) {
453 LOG.error("missing node for dpnId {}", dpnId);
458 private static String getTzNameForUnderlayNetwork(String zoneNamePrefix, String underlayNetworkName) {
459 return zoneNamePrefix + IP_NETWORK_ZONE_NAME_DELIMITER + underlayNetworkName;
462 private static Optional<String> getZonePrefixForUnderlayNetwork(String zoneName, String underlayNetworkName) {
463 String[] zoneParts = zoneName.split(IP_NETWORK_ZONE_NAME_DELIMITER + underlayNetworkName);
464 return zoneParts.length == 2 ? Optional.of(zoneParts[0]) : Optional.absent();