elanmanager/impl/src/main/java/org/opendaylight/netvirt/elan/utils/TransportZoneNotificationUtil.java

   1 /*
   2  * Copyright (c) 2017 HPE 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.elan.utils;
   9
  10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
  11
  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.ArrayList;
  18 import java.util.Collections;
  19 import java.util.HashSet;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23 import java.util.Objects;
  24 import java.util.Set;
  25 import java.util.concurrent.ExecutionException;
  26 import java.util.stream.Collectors;
  27 import javax.annotation.Nonnull;
  28 import javax.annotation.Nullable;
  29 import javax.inject.Inject;
  30 import javax.inject.Singleton;
  31 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  34 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  35 import org.opendaylight.genius.infra.Datastore.Configuration;
  36 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  37 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  38 import org.opendaylight.genius.infra.TypedReadTransaction;
  39 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
  40 import org.opendaylight.genius.infra.TypedWriteTransaction;
  41 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  42 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
  43 import org.opendaylight.netvirt.elan.internal.ElanBridgeManager;
  44 import org.opendaylight.netvirt.elanmanager.api.IElanService;
  45 import org.opendaylight.ovsdb.utils.mdsal.utils.ControllerMdsalUtils;
  46 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefixBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.BridgeRefInfo;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntry;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembership;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Subnets;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.SubnetsBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.SubnetsKey;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.Vteps;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.VtepsBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.VtepsKey;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.config.rev150710.ElanConfig;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  72 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;
  73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  74 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77
  78 @Singleton
  79 public class TransportZoneNotificationUtil {
  80     private static final Logger LOG = LoggerFactory.getLogger(TransportZoneNotificationUtil.class);
  81     private static final String TUNNEL_PORT = "tunnel_port";
  82     private static final String LOCAL_IP = "local_ip";
  83     private static final String LOCAL_IPS = "local_ips";
  84     private static final char IP_NETWORK_ZONE_NAME_DELIMITER = '-';
  85     private static final String ALL_SUBNETS_GW = "0.0.0.0";
  86     private static final String ALL_SUBNETS = "0.0.0.0/0";
  87     private final ManagedNewTransactionRunner txRunner;
  88     private final SingleTransactionDataBroker singleTxBroker;
  89     private final SouthboundUtils southBoundUtils;
  90     private final IElanService elanService;
  91     private final ElanConfig elanConfig;
  92     private final ElanBridgeManager elanBridgeManager;
  93     private final ElanInstanceCache elanInstanceCache;
  94
  95     @Inject
  96     public TransportZoneNotificationUtil(final DataBroker dbx,
  97             final IElanService elanService, final ElanConfig elanConfig, final ElanBridgeManager elanBridgeManager,
  98             final ElanInstanceCache elanInstanceCache) {
  99         this.txRunner = new ManagedNewTransactionRunnerImpl(dbx);
 100         this.singleTxBroker = new SingleTransactionDataBroker(dbx);
 101         this.elanService = elanService;
 102         this.elanConfig = elanConfig;
 103         this.elanBridgeManager = elanBridgeManager;
 104         this.elanInstanceCache = elanInstanceCache;
 105         southBoundUtils = new SouthboundUtils(new ControllerMdsalUtils(dbx));
 106     }
 107
 108     public boolean shouldCreateVtep(List<VpnInterfaces> vpnInterfaces) {
 109         if (vpnInterfaces == null || vpnInterfaces.isEmpty()) {
 110             return false;
 111         }
 112
 113         for (VpnInterfaces vpnInterface : vpnInterfaces) {
 114             String interfaceName = vpnInterface.getInterfaceName();
 115
 116             ElanInterface elanInt = elanService.getElanInterfaceByElanInterfaceName(interfaceName);
 117             if (elanInt == null) {
 118                 continue;
 119             }
 120
 121             if (ElanUtils.isVxlanNetworkOrVxlanSegment(
 122                     elanInstanceCache.get(elanInt.getElanInstanceName()).orNull())) {
 123                 return true;
 124             } else {
 125                 LOG.debug("Non-VXLAN elanInstance: {}", elanInt.getElanInstanceName());
 126             }
 127         }
 128
 129         return false;
 130     }
 131
 132     private TransportZone createZone(String subnetIp, String zoneName) {
 133         List<Subnets> subnets = new ArrayList<>();
 134         subnets.add(buildSubnets(subnetIp));
 135         TransportZoneBuilder tzb = new TransportZoneBuilder().withKey(new TransportZoneKey(zoneName))
 136                 .setTunnelType(TunnelTypeVxlan.class).setZoneName(zoneName).setSubnets(subnets);
 137         return tzb.build();
 138     }
 139
 140     private void updateTransportZone(TransportZone zone, BigInteger dpnId,
 141             @Nonnull TypedWriteTransaction<Configuration> tx) {
 142         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
 143                 .child(TransportZone.class, new TransportZoneKey(zone.getZoneName())).build();
 144
 145         tx.merge(path, zone);
 146         LOG.info("Transport zone {} updated due to dpn {} handling.", zone.getZoneName(), dpnId);
 147     }
 148
 149     public void updateTransportZone(String zoneNamePrefix, BigInteger dpnId) {
 150         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
 151             Map<String, String> localIps = getDpnLocalIps(dpnId);
 152             if (!localIps.isEmpty()) {
 153                 LOG.debug("Will use local_ips for transport zone update for dpn {} and zone name prefix {}", dpnId,
 154                         zoneNamePrefix);
 155                 for (Entry<String, String> entry : localIps.entrySet()) {
 156                     String localIp = entry.getKey();
 157                     String underlayNetworkName = entry.getValue();
 158                     String zoneName = getTzNameForUnderlayNetwork(zoneNamePrefix, underlayNetworkName);
 159                     updateTransportZone(zoneName, dpnId, localIp, tx);
 160                 }
 161             } else {
 162                 updateTransportZone(zoneNamePrefix, dpnId, getDpnLocalIp(dpnId), tx);
 163             }
 164         }), LOG, "Error updating transport zone");
 165     }
 166
 167     @SuppressWarnings("checkstyle:IllegalCatch")
 168     private void updateTransportZone(String zoneName, BigInteger dpnId, @Nullable String localIp,
 169             @Nonnull TypedReadWriteTransaction<Configuration> tx)
 170             throws ExecutionException, InterruptedException {
 171         InstanceIdentifier<TransportZone> inst = InstanceIdentifier.create(TransportZones.class)
 172                 .child(TransportZone.class, new TransportZoneKey(zoneName));
 173
 174         // FIXME: Read this through a cache
 175         TransportZone zone = tx.read(inst).get().orNull();
 176
 177         if (zone == null) {
 178             zone = createZone(ALL_SUBNETS, zoneName);
 179         }
 180
 181         try {
 182             if (addVtep(zone, ALL_SUBNETS, dpnId, localIp)) {
 183                 updateTransportZone(zone, dpnId, tx);
 184             }
 185         } catch (Exception e) {
 186             LOG.error("Failed to add tunnels for dpn {} in zone {}", dpnId, zoneName, e);
 187         }
 188     }
 189
 190     private void deleteTransportZone(TransportZone zone, BigInteger dpnId,
 191             @Nonnull TypedWriteTransaction<Configuration> tx) {
 192         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
 193                 .child(TransportZone.class, new TransportZoneKey(zone.getZoneName())).build();
 194         tx.delete(path);
 195         LOG.info("Transport zone {} deleted due to dpn {} handling.", zone.getZoneName(), dpnId);
 196     }
 197
 198     public void deleteTransportZone(String zoneNamePrefix, BigInteger dpnId) {
 199         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
 200             Map<String, String> localIps = getDpnLocalIps(dpnId);
 201             if (!localIps.isEmpty()) {
 202                 LOG.debug("Will use local_ips for transport zone delete for dpn {} and zone name prefix {}", dpnId,
 203                         zoneNamePrefix);
 204                 for (String underlayNetworkName : localIps.values()) {
 205                     String zoneName = getTzNameForUnderlayNetwork(zoneNamePrefix, underlayNetworkName);
 206                     deleteTransportZone(zoneName, dpnId, tx);
 207                 }
 208             } else {
 209                 deleteTransportZone(zoneNamePrefix, dpnId, tx);
 210             }
 211         }), LOG, "Error deleting transport zone");
 212     }
 213
 214     @SuppressWarnings("checkstyle:IllegalCatch")
 215     private void deleteTransportZone(String zoneName, BigInteger dpnId,
 216             @Nonnull TypedReadWriteTransaction<Configuration> tx) throws ExecutionException, InterruptedException {
 217         InstanceIdentifier<TransportZone> inst = InstanceIdentifier.create(TransportZones.class)
 218                 .child(TransportZone.class, new TransportZoneKey(zoneName));
 219
 220         // FIXME: Read this through a cache
 221         TransportZone zone = tx.read(inst).get().orNull();
 222         if (zone != null) {
 223             try {
 224                 deleteTransportZone(zone, dpnId, tx);
 225             } catch (Exception e) {
 226                 LOG.error("Failed to remove tunnels for dpn {} in zone {}", dpnId, zoneName, e);
 227             }
 228         }
 229     }
 230
 231
 232     /**
 233      * Update transport zones based on local_ips TEP ips mapping to underlay
 234      * networks.<br>
 235      * Deleted local_ips will be removed from the VTEP list of the corresponding
 236      * transport zones.<br>
 237      * Added local_ips will be added to all transport zones currently associated
 238      * with the TEP<br>
 239      * local_ips for whom the underlay network mapping has been changed will be
 240      * updated in the VTEP lists of the corresponding transport zones.
 241      *
 242      * @param origNode
 243      *            original OVS node
 244      * @param updatedNode
 245      *            updated OVS node
 246      * @param managerNodeId
 247      *            uuid of the OVS manager node
 248      */
 249     public void handleOvsdbNodeUpdate(Node origNode, Node updatedNode, String managerNodeId) {
 250         Map<String,
 251                 String> origLocalIpMap = java.util.Optional
 252                         .ofNullable(elanBridgeManager.getOpenvswitchOtherConfigMap(origNode, LOCAL_IPS))
 253                         .orElse(Collections.emptyMap());
 254         Map<String,
 255                 String> updatedLocalIpMap = java.util.Optional
 256                         .ofNullable(elanBridgeManager.getOpenvswitchOtherConfigMap(updatedNode, LOCAL_IPS))
 257                         .orElse(Collections.emptyMap());
 258         MapDifference<String, String> mapDiff = Maps.difference(origLocalIpMap, updatedLocalIpMap);
 259         if (mapDiff.areEqual()) {
 260             return;
 261         }
 262
 263         java.util.Optional<BigInteger> dpIdOpt = elanBridgeManager.getDpIdFromManagerNodeId(managerNodeId);
 264         if (!dpIdOpt.isPresent()) {
 265             LOG.debug("No DPN id found for node {}", managerNodeId);
 266             return;
 267         }
 268
 269         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
 270             BigInteger dpId = dpIdOpt.get();
 271             Optional<DPNTEPsInfo> dpnTepsInfoOpt = getDpnTepsInfo(dpId, tx);
 272             if (!dpnTepsInfoOpt.isPresent()) {
 273                 LOG.debug("No DPNTEPsInfo found for DPN id {}", dpId);
 274                 return;
 275             }
 276
 277             List<TunnelEndPoints> tunnelEndPoints = dpnTepsInfoOpt.get().getTunnelEndPoints();
 278             if (tunnelEndPoints == null || tunnelEndPoints.isEmpty()) {
 279                 LOG.debug("No tunnel endpoints defined for DPN id {}", dpId);
 280                 return;
 281             }
 282
 283             Set<String> zonePrefixes = new HashSet<>();
 284             Map<String, List<String>> tepTzMap = tunnelEndPoints.stream().collect(Collectors
 285                     .toMap(tep -> tep.getIpAddress().stringValue(), this::getTepTransportZoneNames));
 286             LOG.trace("Transport zone prefixes {}", tepTzMap);
 287
 288             handleRemovedLocalIps(mapDiff.entriesOnlyOnLeft(), dpId, zonePrefixes, tepTzMap, tx);
 289             handleChangedLocalIps(mapDiff.entriesDiffering(), dpId, zonePrefixes, tepTzMap, tx);
 290             handleAddedLocalIps(mapDiff.entriesOnlyOnRight(), dpId, zonePrefixes, tx);
 291         }), LOG, "Error handling OVSDB node update");
 292     }
 293
 294     private void handleAddedLocalIps(Map<String, String> addedEntries, BigInteger dpId, Set<String> zonePrefixes,
 295             TypedReadWriteTransaction<Configuration> tx) throws ExecutionException, InterruptedException {
 296         if (addedEntries == null || addedEntries.isEmpty()) {
 297             LOG.trace("No added local_ips found for DPN {}", dpId);
 298             return;
 299         }
 300
 301         LOG.debug("Added local_ips {} on DPN {}", addedEntries.keySet(), dpId);
 302         for (Map.Entry<String, String> addedEntry : addedEntries.entrySet()) {
 303             String ipAddress = addedEntry.getKey();
 304             String underlayNetworkName = addedEntry.getValue();
 305             for (String zonePrefix : zonePrefixes) {
 306                 String zoneName = getTzNameForUnderlayNetwork(zonePrefix, underlayNetworkName);
 307                 updateTransportZone(zoneName, dpId, ipAddress, tx);
 308             }
 309         }
 310     }
 311
 312     private void handleChangedLocalIps(Map<String, ValueDifference<String>> changedEntries, BigInteger dpId,
 313             Set<String> zonePrefixes, Map<String, List<String>> tepTzMap,
 314             @Nonnull TypedReadWriteTransaction<Configuration> tx) throws ExecutionException, InterruptedException {
 315         if (changedEntries == null || changedEntries.isEmpty()) {
 316             LOG.trace("No changed local_ips found for DPN {}", dpId);
 317             return;
 318         }
 319
 320         LOG.debug("Changing underlay network mapping for local_ips {} on DPN {}", changedEntries.keySet(), dpId);
 321         for (Map.Entry<String, ValueDifference<String>> changedEntry : changedEntries.entrySet()) {
 322             String ipAddress = changedEntry.getKey();
 323             ValueDifference<String> underlayNetworkDiff = changedEntry.getValue();
 324             List<String> zoneNames = tepTzMap.get(ipAddress);
 325             if (zoneNames != null) {
 326                 for (String zoneName : zoneNames) {
 327                     String removedUnderlayNetwork = underlayNetworkDiff.leftValue();
 328                     String addedUnderlayNetwork = underlayNetworkDiff.rightValue();
 329                     Optional<String> zonePrefixOpt = getZonePrefixForUnderlayNetwork(zoneName, removedUnderlayNetwork);
 330                     if (zonePrefixOpt.isPresent()) {
 331                         String zonePrefix = zonePrefixOpt.get();
 332                         removeVtep(zoneName, dpId, tx);
 333                         zonePrefixes.add(zonePrefix);
 334                         String newZoneName = getTzNameForUnderlayNetwork(zonePrefix, addedUnderlayNetwork);
 335                         updateTransportZone(newZoneName, dpId, ipAddress, tx);
 336                     }
 337                 }
 338             }
 339         }
 340     }
 341
 342     private void handleRemovedLocalIps(Map<String, String> removedEntries, BigInteger dpId, Set<String> zonePrefixes,
 343             Map<String, List<String>> tepTzMap, @Nonnull TypedWriteTransaction<Configuration> tx) {
 344         if (removedEntries == null || removedEntries.isEmpty()) {
 345             LOG.trace("No removed local_ips found on DPN {}", dpId);
 346             return;
 347         }
 348
 349         LOG.debug("Removed local_ips {} for DPN {}", removedEntries.keySet(), dpId);
 350         removedEntries.forEach((ipAddress, underlayNetworkName) -> {
 351             List<String> zoneNames = tepTzMap.get(ipAddress);
 352             if (zoneNames != null) {
 353                 for (String zoneName : zoneNames) {
 354                     Optional<String> zonePrefix = getZonePrefixForUnderlayNetwork(zoneName, underlayNetworkName);
 355                     if (zonePrefix.isPresent()) {
 356                         removeVtep(zoneName, dpId, tx);
 357                         zonePrefixes.add(zonePrefix.get());
 358                     }
 359                 }
 360             }
 361         });
 362     }
 363
 364     private List<String> getTepTransportZoneNames(TunnelEndPoints tep) {
 365         List<TzMembership> tzMembershipList = tep.getTzMembership();
 366         if (tzMembershipList == null) {
 367             LOG.debug("No TZ membership exist for TEP ip {}", tep.getIpAddress().stringValue());
 368             return Collections.emptyList();
 369         }
 370
 371         return tzMembershipList.stream().map(TzMembership::getZoneName).distinct()
 372                 .collect(Collectors.toList());
 373     }
 374
 375     private Optional<DPNTEPsInfo> getDpnTepsInfo(BigInteger dpId, TypedReadTransaction<Configuration> tx) {
 376         InstanceIdentifier<DPNTEPsInfo> identifier = InstanceIdentifier.builder(DpnEndpoints.class)
 377                 .child(DPNTEPsInfo.class, new DPNTEPsInfoKey(dpId)).build();
 378         try {
 379             return tx.read(identifier).get();
 380         } catch (InterruptedException | ExecutionException e) {
 381             LOG.warn("Failed to read DPNTEPsInfo for DPN id {}", dpId);
 382             return Optional.absent();
 383         }
 384     }
 385
 386     /**
 387      * Tries to add a vtep for a transport zone.
 388      *
 389      * @return Whether a vtep was added or not.
 390      */
 391     private boolean addVtep(TransportZone zone, String subnetIp, BigInteger dpnId, @Nullable String localIp) {
 392         List<Subnets> zoneSubnets = zone.getSubnets();
 393         if (zoneSubnets == null) {
 394             return false;
 395         }
 396
 397         Subnets subnets = getOrAddSubnet(zoneSubnets, subnetIp);
 398         for (Vteps existingVtep : subnets.nonnullVteps()) {
 399             if (Objects.equals(existingVtep.getDpnId(), dpnId)) {
 400                 return false;
 401             }
 402         }
 403
 404         if (localIp != null) {
 405             IpAddress nodeIp = IpAddressBuilder.getDefaultInstance(localIp);
 406             VtepsBuilder vtepsBuilder = new VtepsBuilder().setDpnId(dpnId).setIpAddress(nodeIp)
 407                     .setPortname(TUNNEL_PORT).setOptionOfTunnel(elanConfig.isUseOfTunnels());
 408             subnets.getVteps().add(vtepsBuilder.build());
 409             return true;
 410         }
 411
 412         return false;
 413     }
 414
 415     private void removeVtep(String zoneName, BigInteger dpId, @Nonnull TypedWriteTransaction<Configuration> tx) {
 416         InstanceIdentifier<Vteps> path = InstanceIdentifier.builder(TransportZones.class)
 417                 .child(TransportZone.class, new TransportZoneKey(zoneName))
 418                 .child(Subnets.class, new SubnetsKey(IpPrefixBuilder.getDefaultInstance(ALL_SUBNETS)))
 419                 .child(Vteps.class, new VtepsKey(dpId, TUNNEL_PORT)).build();
 420         tx.delete(path);
 421     }
 422
 423     // search for relevant subnets for the given subnetIP, add one if it is
 424     // necessary
 425     private Subnets getOrAddSubnet(@Nonnull List<Subnets> subnets, @Nonnull String subnetIp) {
 426         IpPrefix subnetPrefix = IpPrefixBuilder.getDefaultInstance(subnetIp);
 427
 428         for (Subnets subnet : subnets) {
 429             if (Objects.equals(subnet.getPrefix(), subnetPrefix)) {
 430                 return subnet;
 431             }
 432         }
 433
 434         Subnets retSubnet = buildSubnets(subnetIp);
 435         subnets.add(retSubnet);
 436
 437         return retSubnet;
 438     }
 439
 440     private Subnets buildSubnets(String subnetIp) {
 441         SubnetsBuilder subnetsBuilder = new SubnetsBuilder().setDeviceVteps(new ArrayList<>())
 442                 .setGatewayIp(IpAddressBuilder.getDefaultInstance(ALL_SUBNETS_GW))
 443                 .withKey(new SubnetsKey(IpPrefixBuilder.getDefaultInstance(subnetIp))).setVlanId(0)
 444                 .setVteps(new ArrayList<>());
 445         return subnetsBuilder.build();
 446     }
 447
 448     @Nullable
 449     private String getDpnLocalIp(BigInteger dpId) throws ReadFailedException {
 450         Optional<Node> node = getPortsNode(dpId);
 451
 452         if (node.isPresent()) {
 453             String localIp = southBoundUtils.getOpenvswitchOtherConfig(node.get(), LOCAL_IP);
 454             if (localIp == null) {
 455                 LOG.error("missing local_ip key in ovsdb:openvswitch-other-configs in operational"
 456                         + " network-topology for node: {}", node.get().getNodeId().getValue());
 457             } else {
 458                 return localIp;
 459             }
 460         }
 461
 462         return null;
 463     }
 464
 465     @Nonnull
 466     private Map<String, String> getDpnLocalIps(BigInteger dpId) throws ReadFailedException {
 467         // Example of local IPs from other_config:
 468         // local_ips="10.0.43.159:MPLS,11.11.11.11:DSL,ip:underlay-network"
 469         return getPortsNode(dpId).toJavaUtil().map(
 470             node -> elanBridgeManager.getOpenvswitchOtherConfigMap(node, LOCAL_IPS)).orElse(Collections.emptyMap());
 471     }
 472
 473     @SuppressWarnings("unchecked")
 474     private Optional<Node> getPortsNode(BigInteger dpnId) throws ReadFailedException {
 475         InstanceIdentifier<BridgeRefEntry> bridgeRefInfoPath = InstanceIdentifier.create(BridgeRefInfo.class)
 476                 .child(BridgeRefEntry.class, new BridgeRefEntryKey(dpnId));
 477
 478         // FIXME: Read this through a cache
 479         Optional<BridgeRefEntry> optionalBridgeRefEntry =
 480             singleTxBroker.syncReadOptional(LogicalDatastoreType.OPERATIONAL, bridgeRefInfoPath);
 481         if (!optionalBridgeRefEntry.isPresent()) {
 482             LOG.error("no bridge ref entry found for dpnId {}", dpnId);
 483             return Optional.absent();
 484         }
 485
 486         InstanceIdentifier<Node> nodeId =
 487                 optionalBridgeRefEntry.get().getBridgeReference().getValue().firstIdentifierOf(Node.class);
 488
 489         // FIXME: Read this through a cache
 490         Optional<Node> optionalNode = singleTxBroker.syncReadOptional(LogicalDatastoreType.OPERATIONAL, nodeId);
 491         if (!optionalNode.isPresent()) {
 492             LOG.error("missing node for dpnId {}", dpnId);
 493         }
 494         return optionalNode;
 495     }
 496
 497     private String getTzNameForUnderlayNetwork(String zoneNamePrefix, String underlayNetworkName) {
 498         return zoneNamePrefix + IP_NETWORK_ZONE_NAME_DELIMITER + underlayNetworkName;
 499     }
 500
 501     private Optional<String> getZonePrefixForUnderlayNetwork(String zoneName, String underlayNetworkName) {
 502         String[] zoneParts = zoneName.split(IP_NETWORK_ZONE_NAME_DELIMITER + underlayNetworkName);
 503         return zoneParts.length == 2 ? Optional.of(zoneParts[0]) : Optional.absent();
 504     }
 505 }