itm/itm-impl/src/main/java/org/opendaylight/genius/itm/impl/ItmUtils.java

   1 /*
   2  * Copyright © 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.genius.itm.impl;
   9
  10 import static java.util.Collections.emptyMap;
  11
  12 import com.google.common.collect.BiMap;
  13 import com.google.common.collect.ImmutableBiMap;
  14 import com.google.common.collect.ImmutableMap;
  15 import com.google.common.net.InetAddresses;
  16 import com.google.common.util.concurrent.FutureCallback;
  17 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  18 import java.net.InetAddress;
  19 import java.nio.charset.StandardCharsets;
  20 import java.util.ArrayList;
  21 import java.util.Collection;
  22 import java.util.Collections;
  23 import java.util.HashMap;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Objects;
  27 import java.util.Optional;
  28 import java.util.UUID;
  29 import java.util.concurrent.ExecutionException;
  30 import org.eclipse.jdt.annotation.NonNull;
  31 import org.eclipse.jdt.annotation.Nullable;
  32 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  33 import org.opendaylight.genius.infra.Datastore.Configuration;
  34 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
  35 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  36 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  37 import org.opendaylight.genius.itm.cache.DPNTEPsInfoCache;
  38 import org.opendaylight.genius.itm.confighelpers.HwVtep;
  39 import org.opendaylight.genius.itm.confighelpers.ItmTunnelAggregationHelper;
  40 import org.opendaylight.genius.itm.globals.ITMConstants;
  41 import org.opendaylight.genius.mdsalutil.ActionInfo;
  42 import org.opendaylight.genius.mdsalutil.FlowEntity;
  43 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  44 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  45 import org.opendaylight.genius.mdsalutil.MatchInfo;
  46 import org.opendaylight.genius.mdsalutil.NwConstants;
  47 import org.opendaylight.genius.mdsalutil.actions.ActionPuntToController;
  48 import org.opendaylight.genius.mdsalutil.instructions.InstructionApplyActions;
  49 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  50 import org.opendaylight.genius.mdsalutil.matches.MatchTunnelId;
  51 import org.opendaylight.mdsal.binding.api.DataBroker;
  52 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  53 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  54 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  55 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev170119.Tunnel;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefixBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnelBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefsBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBase;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeLogicalGroup;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifier;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifierBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifierKey;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.tunnel.optional.params.TunnelOptions;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.tunnel.optional.params.TunnelOptionsBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.tunnel.optional.params.TunnelOptionsKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.ItmConfig;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.ExternalTunnelList;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TepTypeBase;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TepTypeExternal;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TepTypeHwvtep;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TepTypeInternal;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelList;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelOperStatus;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelsState;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoBuilder;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsBuilder;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsKey;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembership;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembershipBuilder;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembershipKey;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelBuilder;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelKey;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnel;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelBuilder;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelKey;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelList;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelListBuilder;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelListKey;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.state.tunnel.list.DstInfoBuilder;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.state.tunnel.list.SrcInfoBuilder;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.NotHostedTransportZones;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.TepsInNotHostedTransportZone;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.TepsInNotHostedTransportZoneKey;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Vteps;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsKey;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
 123 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
 124 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
 125 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
 126 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
 127 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
 128 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
 129 import org.opendaylight.yangtools.yang.binding.DataObject;
 130 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 131 import org.opendaylight.yangtools.yang.common.Uint64;
 132 import org.slf4j.Logger;
 133 import org.slf4j.LoggerFactory;
 134
 135 public final class ItmUtils {
 136
 137     private static final Logger LOG = LoggerFactory.getLogger(ItmUtils.class);
 138     private static final String ITM_LLDP_FLOW_ENTRY = "ITM Flow Entry ::" + ITMConstants.LLDP_SERVICE_ID;
 139     private static final String TUNNEL = "tun";
 140     private static final IpPrefix DUMMY_IP_PREFIX = IpPrefixBuilder.getDefaultInstance(ITMConstants.DUMMY_PREFIX);
 141     private static final long DEFAULT_MONITORING_INTERVAL = 100L;
 142     public static final ItmCache ITM_CACHE = new ItmCache();
 143
 144     public static final ImmutableMap<String, Class<? extends TunnelTypeBase>>
 145             TUNNEL_TYPE_MAP =
 146             new ImmutableMap.Builder<String, Class<? extends TunnelTypeBase>>()
 147                     .put(ITMConstants.TUNNEL_TYPE_GRE, TunnelTypeGre.class)
 148                     .put(ITMConstants.TUNNEL_TYPE_MPLSoGRE, TunnelTypeMplsOverGre.class)
 149                     .put(ITMConstants.TUNNEL_TYPE_VXLAN, TunnelTypeVxlan.class)
 150                     .build();
 151
 152     private static final BiMap<String, Class<? extends TunnelTypeBase>> STRING_CLASS_IMMUTABLE_BI_MAP =
 153             ImmutableBiMap.copyOf(TUNNEL_TYPE_MAP);
 154     private static final Uint64 COOKIE_ITM_LLD = Uint64.fromLongBits(
 155             ITMConstants.COOKIE_ITM.longValue() + ITMConstants.LLDP_SERVICE_ID).intern();
 156
 157     private ItmUtils() {
 158     }
 159
 160     public static final FutureCallback<Void> DEFAULT_WRITE_CALLBACK = new FutureCallback<>() {
 161         @Override
 162         public void onSuccess(Void result) {
 163             LOG.debug("Success in Datastore write operation");
 164         }
 165
 166         @Override
 167         public void onFailure(Throwable error) {
 168             LOG.error("Error in Datastore write operation", error);
 169         }
 170     };
 171
 172     /**
 173      * Synchronous blocking read from data store.
 174      *
 175      * @deprecated Use
 176      * {@link SingleTransactionDataBroker#syncReadOptional(DataBroker, LogicalDatastoreType, InstanceIdentifier)}
 177      */
 178     @Deprecated
 179     @SuppressWarnings("checkstyle:IllegalCatch")
 180     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 181                                                           InstanceIdentifier<T> path, DataBroker broker) {
 182         try (ReadTransaction tx = broker.newReadOnlyTransaction()) {
 183             return tx.read(datastoreType, path).get();
 184         } catch (InterruptedException | ExecutionException e) {
 185             LOG.error("Read failed ", e);
 186             return Optional.empty();
 187         }
 188     }
 189
 190     //ITM cleanup:portname and vlanId are removed, causes change in generated
 191     //interface name: This has upgrade impact
 192     public static String getInterfaceName(final Uint64 datapathid, final String portName, final Integer vlanId) {
 193         return datapathid + ":" + portName + ":" + vlanId;
 194     }
 195
 196     public static String getTrunkInterfaceName(String parentInterfaceName,
 197                                                String localHostName, String remoteHostName, String tunnelType) {
 198         String tunnelTypeStr;
 199         if (tunnelType.contains("TunnelTypeGre")) {
 200             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_GRE;
 201         } else if (tunnelType.contains("TunnelTypeLogicalGroup")) {
 202             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_LOGICAL_GROUP_VXLAN;
 203         } else {
 204             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_VXLAN;
 205         }
 206         String trunkInterfaceName = trunkInterfaceName(parentInterfaceName, localHostName, remoteHostName,
 207                 tunnelTypeStr);
 208         LOG.trace("trunk interface name is {}", trunkInterfaceName);
 209         return TUNNEL + getUniqueIdString(trunkInterfaceName);
 210     }
 211
 212     public static void releaseIdForTrunkInterfaceName(String parentInterfaceName,
 213                                                       String localHostName, String remoteHostName, String tunnelType) {
 214         String tunnelTypeStr;
 215         if (tunnelType.contains("TunnelTypeGre")) {
 216             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_GRE;
 217         } else {
 218             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_VXLAN;
 219         }
 220         if (LOG.isTraceEnabled()) {
 221             LOG.trace("Releasing Id for trunkInterface - {}", trunkInterfaceName(parentInterfaceName, localHostName,
 222                     remoteHostName, tunnelTypeStr));
 223         }
 224     }
 225
 226     private static String trunkInterfaceName(String parentInterfaceName, String localHostName, String remoteHostName,
 227                                              String tunnelType) {
 228         return parentInterfaceName + ":" + localHostName + ":" + remoteHostName + ":" + tunnelType;
 229     }
 230
 231     public static String getLogicalTunnelGroupName(Uint64 srcDpnId, Uint64 destDpnId) {
 232         String groupName = srcDpnId + ":" + destDpnId + ":" + ITMConstants.TUNNEL_TYPE_LOGICAL_GROUP_VXLAN;
 233         LOG.trace("logical tunnel group name is {}", groupName);
 234         return TUNNEL + getUniqueIdString(groupName);
 235     }
 236
 237     public static InetAddress getInetAddressFromIpAddress(IpAddress ip) {
 238         return IetfInetUtil.INSTANCE.inetAddressFor(ip);
 239     }
 240
 241     public static InstanceIdentifier<DPNTEPsInfo> getDpnTepInstance(Uint64 dpIdKey) {
 242         return InstanceIdentifier.builder(DpnEndpoints.class).child(DPNTEPsInfo.class, new DPNTEPsInfoKey(dpIdKey))
 243                 .build();
 244     }
 245
 246     public static DPNTEPsInfo createDPNTepInfo(Uint64 dpId, List<TunnelEndPoints> endpoints) {
 247         return new DPNTEPsInfoBuilder().withKey(new DPNTEPsInfoKey(dpId)).setTunnelEndPoints(endpoints).build();
 248     }
 249
 250     public static TunnelEndPoints createTunnelEndPoints(Uint64 dpnId, IpAddress ipAddress, String portName,
 251                                                         boolean isOfTunnel, int vlanId, List<TzMembership> zones,
 252                                                         Class<? extends TunnelTypeBase> tunnelType,
 253                                                         String tos) {
 254         // when Interface Mgr provides support to take in Dpn Id
 255         return new TunnelEndPointsBuilder().withKey(new TunnelEndPointsKey(ipAddress, tunnelType))
 256                 .setTzMembership(zones)
 257                 .setOptionOfTunnel(isOfTunnel).setInterfaceName(ItmUtils.getInterfaceName(dpnId, portName, vlanId))
 258                 .setTunnelType(tunnelType)
 259                 .setOptionTunnelTos(tos)
 260                 .build();
 261     }
 262
 263     public static TunnelEndPoints createDummyTunnelEndPoints(Uint64 dpnID, IpAddress ipAddress, boolean ofTunnel,
 264                                                              String tos, List<TzMembership> zones,
 265                                                              Class<? extends TunnelTypeBase> tunnelType,
 266                                                              String port, int vlanID) {
 267
 268         return ItmUtils.createTunnelEndPoints(dpnID, ipAddress, port, ofTunnel, vlanID, zones,
 269                 tunnelType, tos);
 270     }
 271
 272     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 273         return InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName))
 274                 .build();
 275     }
 276
 277     public static InstanceIdentifier<IfTunnel> buildTunnelId(String ifName) {
 278         return InstanceIdentifier.builder(Interfaces.class)
 279                 .child(Interface.class, new InterfaceKey(ifName)).augmentation(IfTunnel.class).build();
 280     }
 281
 282     public static Interface buildLogicalTunnelInterface(Uint64 dpn, String ifName, String desc, boolean enabled) {
 283         InterfaceBuilder builder = new InterfaceBuilder().withKey(new InterfaceKey(ifName)).setName(ifName)
 284                 .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 285         ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 286         builder.addAugmentation(ParentRefs.class, parentRefs);
 287
 288         IfTunnel tunnel = new IfTunnelBuilder()
 289                 .setTunnelDestination(IpAddressBuilder.getDefaultInstance(ITMConstants.DUMMY_IP_ADDRESS))
 290                 .setTunnelSource(IpAddressBuilder.getDefaultInstance(ITMConstants.DUMMY_IP_ADDRESS)).setInternal(true)
 291                 .setMonitorEnabled(false).setTunnelInterfaceType(TunnelTypeLogicalGroup.class)
 292                 .setTunnelRemoteIpFlow(false).build();
 293         builder.addAugmentation(IfTunnel.class, tunnel);
 294         return builder.build();
 295     }
 296
 297     public static Interface buildTunnelInterface(Uint64 dpn, String ifName, String desc, boolean enabled,
 298                                                  Class<? extends TunnelTypeBase> tunType, IpAddress localIp,
 299                                                  IpAddress remoteIp, boolean internal,
 300                                                  Boolean monitorEnabled,
 301                                                  Class<? extends TunnelMonitoringTypeBase> monitorProtocol,
 302                                                  Integer monitorInterval, boolean useOfTunnel,
 303                                                  List<TunnelOptions> tunOptions) {
 304
 305         return buildTunnelInterface(dpn, ifName, desc, enabled, tunType, localIp, remoteIp, internal,
 306                 monitorEnabled, monitorProtocol, monitorInterval, useOfTunnel, null,
 307                 tunOptions);
 308     }
 309
 310     public static Interface buildTunnelInterface(Uint64 dpn, String ifName, String desc, boolean enabled,
 311                                                  Class<? extends TunnelTypeBase> tunType, IpAddress localIp,
 312                                                  IpAddress remoteIp, boolean internal,
 313                                                  Boolean monitorEnabled,
 314                                                  Class<? extends TunnelMonitoringTypeBase> monitorProtocol,
 315                                                  Integer monitorInterval, boolean useOfTunnel, String parentIfaceName,
 316                                                  List<TunnelOptions> tunnelOptions) {
 317         InterfaceBuilder builder = new InterfaceBuilder().withKey(new InterfaceKey(ifName)).setName(ifName)
 318                 .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 319         ParentRefs parentRefs =
 320                 new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).setParentInterface(parentIfaceName).build();
 321         builder.addAugmentation(ParentRefs.class, parentRefs);
 322         Long monitoringInterval = null;
 323         LOG.debug("buildTunnelInterface: monitorProtocol = {} and monitorInterval = {}",
 324                 monitorProtocol.getName(), monitorInterval);
 325
 326         if (monitorInterval != null) {
 327             monitoringInterval = monitorInterval.longValue();
 328         }
 329
 330         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(remoteIp)
 331                 .setTunnelSource(localIp).setTunnelInterfaceType(tunType)
 332                 .setMonitorEnabled(monitorEnabled).setMonitorProtocol(monitorProtocol)
 333                 .setMonitorInterval(monitoringInterval).setTunnelRemoteIpFlow(useOfTunnel)
 334                 .setTunnelOptions(tunnelOptions).setInternal(internal)
 335                 .build();
 336         builder.addAugmentation(IfTunnel.class, tunnel);
 337         return builder.build();
 338     }
 339
 340     public static Interface buildHwTunnelInterface(String tunnelIfName, String desc, boolean enabled, String topoId,
 341                                                    String nodeId, Class<? extends TunnelTypeBase> tunType,
 342                                                    IpAddress srcIp, IpAddress destIp, IpAddress gwIp,
 343                                                    Boolean monitorEnabled,
 344                                                    Class<? extends TunnelMonitoringTypeBase> monitorProtocol,
 345                                                    Integer monitorInterval) {
 346         InterfaceBuilder builder = new InterfaceBuilder().withKey(new InterfaceKey(tunnelIfName))
 347                 .setName(tunnelIfName).setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 348         List<NodeIdentifier> nodeIds = new ArrayList<>();
 349         NodeIdentifier hwNode = new NodeIdentifierBuilder().withKey(new NodeIdentifierKey(topoId))
 350                 .setTopologyId(topoId).setNodeId(nodeId).build();
 351         nodeIds.add(hwNode);
 352         ParentRefs parent = new ParentRefsBuilder().setNodeIdentifier(nodeIds).build();
 353         builder.addAugmentation(ParentRefs.class, parent);
 354         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(destIp).setTunnelGateway(gwIp)
 355                 .setTunnelSource(srcIp).setMonitorEnabled(monitorEnabled == null || monitorEnabled)
 356                 .setMonitorProtocol(monitorProtocol == null ? ITMConstants.DEFAULT_MONITOR_PROTOCOL : monitorProtocol)
 357                 .setMonitorInterval(DEFAULT_MONITORING_INTERVAL).setTunnelInterfaceType(tunType).setInternal(false)
 358                 .build();
 359         builder.addAugmentation(IfTunnel.class, tunnel);
 360         LOG.trace("iftunnel {} built from hwvtep {} ", tunnel, nodeId);
 361         return builder.build();
 362     }
 363
 364     public static InternalTunnel buildInternalTunnel(Uint64 srcDpnId, Uint64 dstDpnId,
 365                                                      Class<? extends TunnelTypeBase> tunType,
 366                                                      String trunkInterfaceName) {
 367         return new InternalTunnelBuilder().withKey(new InternalTunnelKey(dstDpnId, srcDpnId, tunType))
 368                 .setDestinationDPN(dstDpnId)
 369                 .setSourceDPN(srcDpnId).setTransportType(tunType)
 370                 .setTunnelInterfaceNames(Collections.singletonList(trunkInterfaceName)).build();
 371     }
 372
 373     public static ExternalTunnel buildExternalTunnel(String srcNode, String dstNode,
 374                                                      Class<? extends TunnelTypeBase> tunType,
 375                                                      String trunkInterfaceName) {
 376         return new ExternalTunnelBuilder().withKey(
 377                 new ExternalTunnelKey(dstNode, srcNode, tunType))
 378                 .setSourceDevice(srcNode).setDestinationDevice(dstNode)
 379                 .setTunnelInterfaceName(trunkInterfaceName)
 380                 .setTransportType(tunType).build();
 381     }
 382
 383     private static String getUniqueIdString(String idKey) {
 384         return UUID.nameUUIDFromBytes(idKey.getBytes(StandardCharsets.UTF_8)).toString().substring(0, 12)
 385                 .replace("-", "");
 386     }
 387
 388     public static List<DPNTEPsInfo> getDpnTepListFromDpnId(DPNTEPsInfoCache dpnTEPsInfoCache, List<Uint64> dpnIds) {
 389         Collection<DPNTEPsInfo> meshedDpnList = dpnTEPsInfoCache.getAllPresent();
 390         List<DPNTEPsInfo> cfgDpnList = new ArrayList<>();
 391         for (Uint64 dpnId : dpnIds) {
 392             for (DPNTEPsInfo teps : meshedDpnList) {
 393                 if (dpnId.equals(teps.getDPNID())) {
 394                     cfgDpnList.add(teps);
 395                 }
 396             }
 397         }
 398
 399         return cfgDpnList;
 400     }
 401
 402     @SuppressWarnings("checkstyle:IllegalCatch")
 403     public static void addTerminatingServiceTable(TypedReadWriteTransaction<Configuration> tx,
 404                                                   Uint64 dpnId, IMdsalApiManager mdsalManager) {
 405         LOG.trace("Installing PUNT to Controller flow in DPN {} ", dpnId);
 406         List<ActionInfo> listActionInfo = new ArrayList<>();
 407         listActionInfo.add(new ActionPuntToController());
 408
 409         try {
 410             List<MatchInfo> mkMatches = new ArrayList<>();
 411
 412             mkMatches.add(new MatchTunnelId(Uint64.valueOf(ITMConstants.LLDP_SERVICE_ID)));
 413
 414             List<InstructionInfo> mkInstructions = new ArrayList<>();
 415             mkInstructions.add(new InstructionApplyActions(listActionInfo));
 416
 417             FlowEntity terminatingServiceTableFlowEntity = MDSALUtil
 418                     .buildFlowEntity(dpnId, NwConstants.INTERNAL_TUNNEL_TABLE,
 419                             getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE, ITMConstants.LLDP_SERVICE_ID),
 420                             5, ITM_LLDP_FLOW_ENTRY, 0, 0,
 421                             COOKIE_ITM_LLD, mkMatches, mkInstructions);
 422             mdsalManager.addFlow(tx, terminatingServiceTableFlowEntity);
 423         } catch (Exception e) {
 424             LOG.error("Error while setting up Table 36 for {}", dpnId, e);
 425         }
 426     }
 427
 428     @SuppressWarnings("checkstyle:IllegalCatch")
 429     public static void removeTerminatingServiceTable(TypedReadWriteTransaction<Configuration> tx,
 430                                                      Uint64 dpnId, IMdsalApiManager mdsalManager) {
 431         LOG.trace("Removing PUNT to Controller flow in DPN {} ", dpnId);
 432
 433         try {
 434             mdsalManager.removeFlow(tx, dpnId,
 435                     getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE, ITMConstants.LLDP_SERVICE_ID),
 436                     NwConstants.INTERNAL_TUNNEL_TABLE);
 437         } catch (Exception e) {
 438             LOG.error("Error while setting up Table 36 for {}", dpnId, e);
 439         }
 440     }
 441
 442     private static String getFlowRef(long termSvcTable, int svcId) {
 443         return String.valueOf(termSvcTable) + svcId;
 444     }
 445
 446     public static <T> boolean isEmpty(Collection<T> collection) {
 447         return collection == null || collection.isEmpty();
 448     }
 449
 450     public static @NonNull HwVtep createHwVtepObject(String topoId, String nodeId, IpAddress ipAddress,
 451                                                      Class<? extends TunnelTypeBase> tunneltype,
 452                                                      TransportZone transportZone) {
 453         HwVtep hwVtep = new HwVtep();
 454         hwVtep.setHwIp(ipAddress);
 455         hwVtep.setNodeId(nodeId);
 456         hwVtep.setTopoId(topoId);
 457         hwVtep.setTransportZone(transportZone.getZoneName());
 458         hwVtep.setTunnelType(tunneltype);
 459         return hwVtep;
 460     }
 461
 462     public static String getHwParentIf(String topoId, String srcNodeid) {
 463         return topoId + ":" + srcNodeid;
 464     }
 465
 466     /**
 467      * Synchronous blocking write to data store.
 468      *
 469      * @deprecated Use
 470      * {@link SingleTransactionDataBroker#syncWrite(DataBroker, LogicalDatastoreType, InstanceIdentifier, DataObject)}
 471      */
 472     @Deprecated
 473     public static <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType,
 474                                                         InstanceIdentifier<T> path, T data, DataBroker broker) {
 475         WriteTransaction tx = broker.newWriteOnlyTransaction();
 476         tx.mergeParentStructurePut(datastoreType, path, data);
 477         try {
 478             tx.commit().get();
 479         } catch (InterruptedException | ExecutionException e) {
 480             LOG.error("ITMUtils:SyncWrite , Error writing to datastore (path, data) : ({}, {})", path, data);
 481             throw new RuntimeException(e.getMessage(), e);
 482         }
 483     }
 484
 485     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 486             .rev140508.interfaces.state.Interface> buildStateInterfaceId(
 487             String interfaceName) {
 488         return InstanceIdentifier.builder(InterfacesState.class)
 489                 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 490                                 .state.Interface.class,
 491                         new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 492                                 .rev140508.interfaces.state.InterfaceKey(
 493                                 interfaceName)).build();
 494     }
 495
 496     @NonNull
 497     public static List<String> getInternalTunnelInterfaces(DataBroker dataBroker) {
 498         Collection<String> internalInterfaces = ITM_CACHE.getAllInternalInterfaces();
 499         List<String> tunnelList = new ArrayList<>();
 500         if (internalInterfaces.isEmpty()) {
 501             tunnelList = getAllInternalTunnlInterfacesFromDS(dataBroker);
 502         } else {
 503             LOG.debug("Internal Interfaces from Cache size: {}", internalInterfaces.size());
 504             tunnelList.addAll(internalInterfaces);
 505         }
 506         LOG.trace("ItmUtils Internal TunnelList: {}", tunnelList);
 507         return tunnelList;
 508     }
 509
 510     public static Map<InternalTunnelKey, InternalTunnel> getInternalTunnelsFromCache(DataBroker dataBroker) {
 511         Collection<InternalTunnel> internalInterfaces = ITM_CACHE.getAllInternalTunnel();
 512         LOG.trace("getInternalTunnelsFromCache - List of InternalTunnels in the Cache: {} ", internalInterfaces);
 513         Map<InternalTunnelKey, InternalTunnel> tunnelMap = new HashMap<>();
 514         if (internalInterfaces.isEmpty()) {
 515             LOG.trace("ItmUtils.getInternalTunnelsFromCache invoking getAllInternalTunnlInterfacesFromDS");
 516             tunnelMap = getAllInternalTunnels(dataBroker);
 517         } else {
 518             LOG.debug("No. of Internal Tunnel Interfaces in cache: {} ", internalInterfaces.size());
 519             for (InternalTunnel internalTunnel : internalInterfaces) {
 520                 tunnelMap.put(internalTunnel.key(), internalTunnel);
 521             }
 522         }
 523         LOG.trace("List of Internal Tunnels: {}", tunnelMap);
 524         return tunnelMap;
 525     }
 526
 527     @SuppressFBWarnings("RV_CHECK_FOR_POSITIVE_INDEXOF")
 528     public static ExternalTunnelKey getExternalTunnelKey(String dst, String src,
 529                                                          Class<? extends TunnelTypeBase> tunType) {
 530         final int srcIndex = src.indexOf("physicalswitch");
 531         if (srcIndex > 0) {
 532             src = src.substring(0, srcIndex - 1);
 533         }
 534         final int dstIndex = dst.indexOf("physicalswitch");
 535         if (dstIndex > 0) {
 536             dst = dst.substring(0, dstIndex - 1);
 537         }
 538         return new ExternalTunnelKey(dst, src, tunType);
 539     }
 540
 541     public static List<TunnelEndPoints> getTEPsForDpn(Uint64 srcDpn, Collection<DPNTEPsInfo> dpnList) {
 542         for (DPNTEPsInfo dpn : dpnList) {
 543             if (Objects.equals(dpn.getDPNID(), srcDpn)) {
 544                 return new ArrayList<>(dpn.nonnullTunnelEndPoints());
 545             }
 546         }
 547         return null;
 548     }
 549
 550     public static Map<InternalTunnelKey, InternalTunnel> getAllInternalTunnels(DataBroker dataBroker) {
 551         Map<InternalTunnelKey, InternalTunnel> result = null;
 552         InstanceIdentifier<TunnelList> iid = InstanceIdentifier.builder(TunnelList.class).build();
 553         Optional<TunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
 554
 555         if (tunnelList.isPresent()) {
 556             result = tunnelList.get().getInternalTunnel();
 557         }
 558         if (result == null) {
 559             result = emptyMap();
 560         }
 561         return result;
 562     }
 563
 564     public static InternalTunnel getInternalTunnel(String interfaceName, DataBroker broker) {
 565         InternalTunnel internalTunnel = ITM_CACHE.getInternalTunnel(interfaceName);
 566         LOG.trace("ItmUtils getInternalTunnel List of InternalTunnels in the Cache {} ", internalTunnel);
 567         if (internalTunnel == null) {
 568             internalTunnel = getInternalTunnelFromDS(interfaceName, broker);
 569         }
 570         return internalTunnel;
 571     }
 572
 573     private static List<String> getAllInternalTunnlInterfacesFromDS(DataBroker broker) {
 574         List<String> tunnelList = new ArrayList<>();
 575         Map<InternalTunnelKey, InternalTunnel> internalTunnels = getAllInternalTunnels(broker);
 576         if (internalTunnels != null) {
 577             for (InternalTunnel tunnel : internalTunnels.values()) {
 578                 List<String> tunnelInterfaceNames = tunnel.getTunnelInterfaceNames();
 579                 if (tunnelInterfaceNames != null) {
 580                     for (String tunnelInterfaceName : tunnelInterfaceNames) {
 581                         tunnelList.add(tunnelInterfaceName);
 582                     }
 583                 }
 584             }
 585         }
 586         LOG.debug("Internal Tunnel Interfaces list: {} ", tunnelList);
 587         return tunnelList;
 588     }
 589
 590     private static ExternalTunnel getExternalTunnelFromDS(String interfaceName, DataBroker broker) {
 591         Map<ExternalTunnelKey, ExternalTunnel> externalTunnels = getAllExternalTunnels(broker);
 592         if (externalTunnels != null) {
 593             for (ExternalTunnel tunnel : externalTunnels.values()) {
 594                 String tunnelInterfaceName = tunnel.getTunnelInterfaceName();
 595                 if (tunnelInterfaceName != null && tunnelInterfaceName.equalsIgnoreCase(interfaceName)) {
 596                     LOG.trace("getExternalTunnelFromDS tunnelInterfaceName: {} ", tunnelInterfaceName);
 597                     return tunnel;
 598                 }
 599             }
 600         }
 601         return null;
 602     }
 603
 604     public static ExternalTunnel getExternalTunnel(String interfaceName, DataBroker broker) {
 605         ExternalTunnel externalTunnel = ITM_CACHE.getExternalTunnel(interfaceName);
 606         if (externalTunnel == null) {
 607             externalTunnel = getExternalTunnelFromDS(interfaceName, broker);
 608         }
 609         LOG.trace("getExternalTunnel externalTunnel: {} ", externalTunnel);
 610         return externalTunnel;
 611     }
 612
 613     private static Map<ExternalTunnelKey, ExternalTunnel> getAllExternalTunnels(DataBroker dataBroker) {
 614         Map<ExternalTunnelKey, ExternalTunnel> result = null;
 615         InstanceIdentifier<ExternalTunnelList> iid = InstanceIdentifier.builder(ExternalTunnelList.class).build();
 616         Optional<ExternalTunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
 617         if (tunnelList.isPresent()) {
 618             result = tunnelList.get().getExternalTunnel();
 619         }
 620         if (result == null) {
 621             result = emptyMap();
 622         }
 623         return result;
 624     }
 625
 626     public static String convertTunnelTypetoString(Class<? extends TunnelTypeBase> tunType) {
 627         String tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 628         if (tunType.equals(TunnelTypeVxlan.class)) {
 629             tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 630         } else if (tunType.equals(TunnelTypeGre.class)) {
 631             tunnelType = ITMConstants.TUNNEL_TYPE_GRE;
 632         } else if (tunType.equals(TunnelTypeMplsOverGre.class)) {
 633             tunnelType = ITMConstants.TUNNEL_TYPE_MPLSoGRE;
 634         } else if (tunType.equals(TunnelTypeLogicalGroup.class)) {
 635             tunnelType = ITMConstants.TUNNEL_TYPE_LOGICAL_GROUP_VXLAN;
 636         }
 637         return tunnelType;
 638     }
 639
 640
 641     public static boolean isItmIfType(Class<? extends InterfaceType> ifType) {
 642         return ifType != null && ifType.isAssignableFrom(Tunnel.class);
 643     }
 644
 645     public static StateTunnelListKey getTunnelStateKey(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 646                                                                .interfaces.rev140508.interfaces.state.Interface iface) {
 647         StateTunnelListKey key = null;
 648         if (isItmIfType(iface.getType())) {
 649             key = new StateTunnelListKey(iface.getName());
 650         }
 651         return key;
 652     }
 653
 654     public static Interface getInterface(
 655             String name, IInterfaceManager ifaceManager) {
 656         Interface result = ITM_CACHE.getInterface(name);
 657         if (result == null) {
 658             result = ifaceManager.getInterfaceInfoFromConfigDataStore(name);
 659             if (result != null) {
 660                 ITM_CACHE.addInterface(result);
 661             }
 662         }
 663         return result;
 664     }
 665
 666     public static boolean falseIfNull(Boolean value) {
 667         return value == null ? false : value;
 668     }
 669
 670     public static List<TzMembership> getIntersection(Map<TzMembershipKey, TzMembership> list1,
 671                                                      Map<TzMembershipKey, TzMembership> list2) {
 672         List<TzMembership> list = new ArrayList<>();
 673         for (TzMembership iter : list1.values()) {
 674             if (list2.values().contains(iter)) {
 675                 list.add(iter);
 676             }
 677         }
 678         LOG.debug(" getIntersection - L1 {}, L2 - {}, Intersection - {}", list1, list2, list);
 679         return list;
 680     }
 681
 682     public static void addTransportZoneMembership(List<TzMembership> zones, String zoneName) {
 683         zones.add(new TzMembershipBuilder().setZoneName(zoneName).build());
 684     }
 685
 686     public static List<TzMembership> createTransportZoneMembership(String zoneName) {
 687         List<TzMembership> zones = new ArrayList<>();
 688         zones.add(new TzMembershipBuilder().setZoneName(zoneName).build());
 689         return zones;
 690     }
 691
 692     /**
 693      * Gets the transport zone in TepsNotHosted list in the Operational Datastore, based on transport zone name.
 694      *
 695      * @param unknownTz  transport zone name
 696      * @param dataBroker data broker handle to perform read operations on Oper datastore
 697      * @return the TepsInNotHostedTransportZone object in the TepsNotHosted list in Oper DS
 698      */
 699     public static TepsInNotHostedTransportZone getUnknownTransportZoneFromITMOperDS(
 700             String unknownTz, DataBroker dataBroker) {
 701         InstanceIdentifier<TepsInNotHostedTransportZone> unknownTzPath =
 702                 InstanceIdentifier.builder(NotHostedTransportZones.class)
 703                         .child(TepsInNotHostedTransportZone.class,
 704                                 new TepsInNotHostedTransportZoneKey(unknownTz)).build();
 705         Optional<TepsInNotHostedTransportZone> unknownTzOptional =
 706                 ItmUtils.read(LogicalDatastoreType.OPERATIONAL, unknownTzPath, dataBroker);
 707         if (unknownTzOptional.isPresent()) {
 708             return unknownTzOptional.get();
 709         }
 710         return null;
 711     }
 712
 713     /**
 714      * Gets the bridge datapath ID from Network topology Node's OvsdbBridgeAugmentation, in the Operational DS.
 715      *
 716      * @param node       Network Topology Node
 717      * @param bridge     bridge name
 718      * @param dataBroker data broker handle to perform operations on datastore
 719      * @return the datapath ID of bridge in string form
 720      */
 721     public static String getBridgeDpid(Node node, String bridge, DataBroker dataBroker) {
 722         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = null;
 723         Node bridgeNode = null;
 724         String datapathId = null;
 725
 726         NodeId ovsdbNodeId = node.key().getNodeId();
 727
 728         NodeId brNodeId = new NodeId(ovsdbNodeId.getValue()
 729                 + "/" + ITMConstants.BRIDGE_URI_PREFIX + "/" + bridge);
 730
 731         InstanceIdentifier<Node> bridgeIid =
 732                 InstanceIdentifier
 733                         .create(NetworkTopology.class)
 734                         .child(Topology.class, new TopologyKey(IfmConstants.OVSDB_TOPOLOGY_ID))
 735                         .child(Node.class, new NodeKey(brNodeId));
 736
 737         Optional<Node> opBridgeNode = ItmUtils.read(LogicalDatastoreType.OPERATIONAL, bridgeIid, dataBroker);
 738
 739         if (opBridgeNode.isPresent()) {
 740             bridgeNode = opBridgeNode.get();
 741         }
 742         if (bridgeNode != null) {
 743             ovsdbBridgeAugmentation = bridgeNode.augmentation(OvsdbBridgeAugmentation.class);
 744         }
 745
 746         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
 747             datapathId = ovsdbBridgeAugmentation.getDatapathId().getValue();
 748         }
 749         return datapathId;
 750     }
 751
 752     /**
 753      * Gets the Network topology Node from Operational Datastore
 754      * based on Bridge Augmentation.
 755      *
 756      * @param bridgeAugmentation bridge augmentation of OVSDB node
 757      * @param dataBroker         data broker handle to perform operations on datastore
 758      * @return the Network Topology Node i.e. OVSDB node which is managing the specified bridge
 759      */
 760     public static Node getOvsdbNode(OvsdbBridgeAugmentation bridgeAugmentation,
 761                                     DataBroker dataBroker) {
 762         Node ovsdbNode = null;
 763         Optional<Node> opOvsdbNode = Optional.empty();
 764         if (bridgeAugmentation != null) {
 765             InstanceIdentifier<Node> ovsdbNodeIid =
 766                     (InstanceIdentifier<Node>) bridgeAugmentation.getManagedBy().getValue();
 767             opOvsdbNode = ItmUtils.read(LogicalDatastoreType.OPERATIONAL, ovsdbNodeIid, dataBroker);
 768         }
 769         if (opOvsdbNode.isPresent()) {
 770             ovsdbNode = opOvsdbNode.get();
 771         }
 772         return ovsdbNode;
 773     }
 774
 775     /**
 776      * Gets the bridge datapath ID in string form from
 777      * Network topology Node's OvsdbBridgeAugmentation in the Operational DS.
 778      *
 779      * @param augmentedNode Ovsdb Augmented Network Topology Node
 780      * @return the datapath ID of bridge in string form
 781      */
 782     public static String getStrDatapathId(OvsdbBridgeAugmentation augmentedNode) {
 783         String datapathId = null;
 784         if (augmentedNode != null && augmentedNode.getDatapathId() != null) {
 785             datapathId = augmentedNode.getDatapathId().getValue();
 786         }
 787         return datapathId;
 788     }
 789
 790     /**
 791      * Returns the dummy subnet (255.255.255.255/32) as IpPrefix object.
 792      *
 793      * @return the dummy subnet (255.255.255.255/32) in IpPrefix object
 794      */
 795     public static IpPrefix getDummySubnet() {
 796         return DUMMY_IP_PREFIX;
 797     }
 798
 799     /**
 800      * Deletes the transport zone from Configuration datastore.
 801      *
 802      * @param tzName     transport zone name
 803      * @param dataBroker data broker handle to perform operations on datastore
 804      */
 805     public static void deleteTransportZoneFromConfigDS(String tzName, DataBroker dataBroker) {
 806         // check whether transport-zone exists in config DS.
 807         TransportZone transportZoneFromConfigDS = ItmUtils.getTransportZoneFromConfigDS(tzName, dataBroker);
 808         if (transportZoneFromConfigDS != null) {
 809             // it exists, delete default-TZ now
 810             InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
 811                     .child(TransportZone.class, new TransportZoneKey(tzName)).build();
 812             LOG.debug("Removing {} transport-zone from config DS.", tzName);
 813             try {
 814                 SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, path);
 815             } catch (TransactionCommitFailedException e) {
 816                 LOG.error("deleteTransportZoneFromConfigDS failed. {} could not be deleted.", tzName, e);
 817             }
 818         }
 819     }
 820
 821     /**
 822      * Validates the tunnelType argument and returnsTunnelTypeBase class object
 823      * corresponding to tunnelType obtained in String format.
 824      *
 825      * @param tunnelType type of tunnel in string form
 826      * @return tunnel-type in TunnelTypeBase object
 827      */
 828     public static Class<? extends TunnelTypeBase> getTunnelType(String tunnelType) {
 829         // validate tunnelType string, in case it is NULL or empty, then
 830         // take VXLAN tunnel type by default
 831         if (tunnelType == null || tunnelType.isEmpty()) {
 832             return TUNNEL_TYPE_MAP.get(ITMConstants.TUNNEL_TYPE_VXLAN);
 833         } else if (!tunnelType.equals(ITMConstants.TUNNEL_TYPE_VXLAN)
 834                 && !tunnelType.equals(ITMConstants.TUNNEL_TYPE_GRE)) {
 835             // if tunnel type is some incorrect value, then
 836             // take VXLAN tunnel type by default
 837             return TUNNEL_TYPE_MAP.get(ITMConstants.TUNNEL_TYPE_VXLAN);
 838         }
 839
 840         // return TunnelTypeBase object corresponding to tunnel-type
 841         return TUNNEL_TYPE_MAP.get(tunnelType);
 842     }
 843
 844     public static List<TzMembership> removeTransportZoneMembership(TunnelEndPoints endPts, Map<TzMembershipKey,
 845             TzMembership> zones) {
 846         LOG.trace(" RemoveTransportZoneMembership TEPs {}, Membership to be removed {} ", endPts, zones);
 847         List<TzMembership> existingTzList = new ArrayList<>(endPts.nonnullTzMembership().values());
 848         for (TzMembership membership : zones.values()) {
 849             existingTzList.remove(new TzMembershipBuilder().setZoneName(membership.getZoneName()).build());
 850         }
 851         LOG.debug("Modified Membership List {}", existingTzList);
 852         return existingTzList;
 853     }
 854
 855     @NonNull
 856     public static  Map<TzMembershipKey, TzMembership> getOriginalTzMembership(TunnelEndPoints srcTep, Uint64 dpnId,
 857                                                              Collection<DPNTEPsInfo> meshedDpnList) {
 858         LOG.trace("Original Membership for source DPN {}, source TEP {}", dpnId, srcTep);
 859         for (DPNTEPsInfo dstDpn : meshedDpnList) {
 860             if (dpnId.equals(dstDpn.getDPNID())) {
 861                 for (TunnelEndPoints tep : dstDpn.nonnullTunnelEndPoints()) {
 862                     if (Objects.equals(tep.getIpAddress(), srcTep.getIpAddress())) {
 863                         @NonNull Map<TzMembershipKey, TzMembership> tzMemberships = tep.nonnullTzMembership();
 864                         LOG.debug("Original Membership size {}", tzMemberships.size());
 865                         return tzMemberships;
 866                     }
 867                 }
 868             }
 869         }
 870         return emptyMap();
 871     }
 872
 873     public static StateTunnelList buildStateTunnelList(StateTunnelListKey tlKey, String name, boolean state,
 874                                                        TunnelOperStatus tunOpStatus, IInterfaceManager ifaceManager,
 875                                                        DataBroker broker) {
 876         StateTunnelListBuilder stlBuilder = new StateTunnelListBuilder();
 877         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
 878                 ItmUtils.getInterface(name, ifaceManager);
 879         IfTunnel ifTunnel = iface.augmentation(IfTunnel.class);
 880         ParentRefs parentRefs = iface.augmentation(ParentRefs.class);
 881         if (ifTunnel == null || parentRefs == null) {
 882             return null;
 883         }
 884         DstInfoBuilder dstInfoBuilder = new DstInfoBuilder();
 885         SrcInfoBuilder srcInfoBuilder = new SrcInfoBuilder();
 886         dstInfoBuilder.setTepIp(ifTunnel.getTunnelDestination());
 887         srcInfoBuilder.setTepIp(ifTunnel.getTunnelSource());
 888         // TODO: Add/Improve logic for device type
 889         InternalTunnel internalTunnel = ItmUtils.ITM_CACHE.getInternalTunnel(name);
 890         ExternalTunnel externalTunnel = ItmUtils.ITM_CACHE.getExternalTunnel(name);
 891         if (internalTunnel == null && externalTunnel == null) {
 892             // both not present in cache. let us update and try again.
 893             internalTunnel = getInternalTunnel(name, broker);
 894             externalTunnel = getExternalTunnel(name, broker);
 895         }
 896         if (internalTunnel != null) {
 897             srcInfoBuilder.setTepDeviceId(internalTunnel.getSourceDPN().toString())
 898                     .setTepDeviceType(TepTypeInternal.class);
 899             dstInfoBuilder.setTepDeviceId(internalTunnel.getDestinationDPN().toString())
 900                     .setTepDeviceType(TepTypeInternal.class);
 901             stlBuilder.setTransportType(internalTunnel.getTransportType());
 902         } else if (externalTunnel != null) {
 903             ExternalTunnel tunnel = ItmUtils.ITM_CACHE.getExternalTunnel(name);
 904             srcInfoBuilder.setTepDeviceId(tunnel.getSourceDevice())
 905                     .setTepDeviceType(getDeviceType(tunnel.getSourceDevice()));
 906             dstInfoBuilder.setTepDeviceId(tunnel.getDestinationDevice())
 907                     .setTepDeviceType(getDeviceType(tunnel.getDestinationDevice()))
 908                     .setTepIp(ifTunnel.getTunnelDestination());
 909             stlBuilder.setTransportType(tunnel.getTransportType());
 910         }
 911         stlBuilder.withKey(tlKey).setTunnelInterfaceName(name).setOperState(tunOpStatus).setTunnelState(state)
 912                 .setDstInfo(dstInfoBuilder.build()).setSrcInfo(srcInfoBuilder.build());
 913         return stlBuilder.build();
 914     }
 915
 916     private static Class<? extends TepTypeBase> getDeviceType(String device) {
 917         if (device.startsWith("hwvtep")) {
 918             return TepTypeHwvtep.class;
 919         } else if (InetAddresses.isInetAddress(device)) {
 920             // In case of external tunnel, destination-device will be of IP address type.
 921             return TepTypeExternal.class;
 922         } else {
 923             return TepTypeInternal.class;
 924         }
 925     }
 926
 927     public static InstanceIdentifier<StateTunnelList> buildStateTunnelListId(StateTunnelListKey tlKey) {
 928         return InstanceIdentifier.builder(TunnelsState.class).child(StateTunnelList.class, tlKey).build();
 929     }
 930
 931     @NonNull
 932     public static Optional<InternalTunnel> getInternalTunnelFromDS(Uint64 srcDpn, Uint64 destDpn,
 933                                                                    Class<? extends TunnelTypeBase> type,
 934                                                                    DataBroker dataBroker) {
 935         InstanceIdentifier<InternalTunnel> pathLogicTunnel = InstanceIdentifier.create(TunnelList.class)
 936                 .child(InternalTunnel.class,
 937                         new InternalTunnelKey(destDpn, srcDpn, type));
 938         //TODO: need to be replaced by cached copy
 939         return ItmUtils.read(LogicalDatastoreType.CONFIGURATION, pathLogicTunnel, dataBroker);
 940     }
 941
 942     private static InternalTunnel getInternalTunnelFromDS(String interfaceName, DataBroker broker) {
 943         Map<InternalTunnelKey, InternalTunnel> internalTunnels = getAllInternalTunnels(broker);
 944         if (internalTunnels != null) {
 945             for (InternalTunnel tunnel : internalTunnels.values()) {
 946                 List<String> tunnelInterfaceNames = tunnel.getTunnelInterfaceNames();
 947                 if (tunnelInterfaceNames != null) {
 948                     for (String tunnelInterfaceName : tunnelInterfaceNames) {
 949                         if (tunnelInterfaceName.equalsIgnoreCase(interfaceName)) {
 950                             LOG.trace("ItmUtils getInternalTunnelFromDS {} ", tunnelInterfaceName);
 951                             return tunnel;
 952                         }
 953                     }
 954                 }
 955             }
 956         }
 957         return null;
 958     }
 959
 960     public static boolean isTunnelAggregationUsed(Class<? extends TunnelTypeBase> tunType) {
 961         return ItmTunnelAggregationHelper.isTunnelAggregationEnabled()
 962                 && (tunType.isAssignableFrom(TunnelTypeVxlan.class)
 963                 || tunType.isAssignableFrom(TunnelTypeLogicalGroup.class));
 964     }
 965
 966     public static List<TunnelOptions> buildTunnelOptions(TunnelEndPoints tep, ItmConfig itmConfig) {
 967         List<TunnelOptions> tunOptions = new ArrayList<>();
 968
 969         String tos = tep.getOptionTunnelTos();
 970         if (tos == null) {
 971             tos = itmConfig.getDefaultTunnelTos();
 972         }
 973         /* populate tos option only if its not default value of 0 */
 974         if (tos != null && !tos.equals("0")) {
 975             TunnelOptionsBuilder optionsBuilder = new TunnelOptionsBuilder();
 976             optionsBuilder.withKey(new TunnelOptionsKey("tos"));
 977             optionsBuilder.setTunnelOption("tos");
 978             optionsBuilder.setValue(tos);
 979             tunOptions.add(optionsBuilder.build());
 980         }
 981
 982         if (tep.getTunnelType() == TunnelTypeVxlan.class && itmConfig.isGpeExtensionEnabled()) {
 983             TunnelOptionsBuilder optionsBuilder = new TunnelOptionsBuilder();
 984             optionsBuilder.withKey(new TunnelOptionsKey("exts"));
 985             optionsBuilder.setTunnelOption("exts");
 986             optionsBuilder.setValue("gpe");
 987             tunOptions.add(optionsBuilder.build());
 988         }
 989         return tunOptions.isEmpty() ? null : tunOptions;
 990     }
 991
 992     public static ExternalTunnel getExternalTunnelbyExternalTunnelKey(ExternalTunnelKey externalTunnelKey,
 993                                                                       InstanceIdentifier<ExternalTunnel> path,
 994                                                                       DataBroker dataBroker) {
 995         ExternalTunnel exTunnel = ITM_CACHE.getExternalTunnelKeyToExternalTunnels().get(externalTunnelKey);
 996         if (exTunnel == null) {
 997             Optional<ExternalTunnel> ext = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 998             if (ext.isPresent()) {
 999                 exTunnel = ext.get();
1000             }
1001         }
1002         return exTunnel;
1003     }
1004
1005     public static List<DPNTEPsInfo> getDpnTEPsInfos(DataBroker dataBroker) {
1006         InstanceIdentifier<DpnEndpoints> iid = InstanceIdentifier.builder(DpnEndpoints.class).build();
1007         Optional<DpnEndpoints> dpnEndpoints = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
1008         if (dpnEndpoints.isPresent()) {
1009             return new ArrayList<>(dpnEndpoints.get().getDPNTEPsInfo().values());
1010         } else {
1011             return new ArrayList<>();
1012         }
1013     }
1014
1015     public static InstanceIdentifier<TransportZone> getTZInstanceIdentifier(String tzName) {
1016         return InstanceIdentifier.builder(TransportZones.class).child(TransportZone.class,
1017                 new TransportZoneKey(tzName)).build();
1018     }
1019
1020     /**
1021      * Returns the transport zone from Configuration datastore.
1022      *
1023      * @param tzName     transport zone name
1024      * @param dataBroker data broker handle to perform operations on datastore
1025      * @return the TransportZone object in Config DS
1026      */
1027     // FIXME: Better is to implement cache to avoid datastore read.
1028     public static TransportZone getTransportZoneFromConfigDS(String tzName, DataBroker dataBroker) {
1029         InstanceIdentifier<TransportZone> tzonePath = getTZInstanceIdentifier(tzName);
1030         Optional<TransportZone> transportZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, tzonePath,
1031                 dataBroker);
1032         if (transportZoneOptional.isPresent()) {
1033             return transportZoneOptional.get();
1034         }
1035         return null;
1036     }
1037
1038     /**
1039      * Returns the transport zone of vtep from Configuration datastore.
1040      *
1041      * @param dpid datapath id of vtep
1042      * @param dataBroker data broker handle to perform operations on datastore
1043      * @return the TransportZone object in Config DS
1044      */
1045     public static TransportZone getTransportZoneOfVtep(Uint64 dpid, DataBroker dataBroker) {
1046         InstanceIdentifier<TransportZones> path = InstanceIdentifier.builder(TransportZones.class).build();
1047         Optional<TransportZones> transportZonesOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION,
1048                 path, dataBroker);
1049         if (transportZonesOptional.isPresent()) {
1050             TransportZones tzones = transportZonesOptional.get();
1051             for (TransportZone tzone : tzones.getTransportZone()) {
1052                 List<Vteps> vtepList = new ArrayList<Vteps>(tzone.nonnullVteps().values());
1053                 if (vtepList != null && !vtepList.isEmpty()) {
1054                     for (Vteps vtep : vtepList) {
1055                         if (vtep.getDpnId().equals(dpid)) {
1056                             return tzone;
1057                         }
1058                     }
1059                 }
1060             }
1061         }
1062         return null;
1063     }
1064
1065     public static Class<? extends TunnelTypeBase> convertStringToTunnelType(String tunnelType) {
1066         Class<? extends TunnelTypeBase> tunType = TunnelTypeVxlan.class;
1067         if (STRING_CLASS_IMMUTABLE_BI_MAP.containsKey(tunnelType)) {
1068             tunType = STRING_CLASS_IMMUTABLE_BI_MAP.get(tunnelType);
1069         }
1070         return tunType;
1071     }
1072
1073     public static List<Uint64> getDpIdFromTransportzone(DataBroker dataBroker, String tzone) {
1074         List<Uint64> listOfDpId = new ArrayList<>();
1075         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
1076                 .child(TransportZone.class, new TransportZoneKey(tzone)).build();
1077         Optional<TransportZone> transportZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION,
1078                 path, dataBroker);
1079         if (transportZoneOptional.isPresent()) {
1080             TransportZone transportZone = transportZoneOptional.get();
1081             if (transportZone.getVteps() != null && !transportZone.getVteps().isEmpty()) {
1082                 @Nullable Map<VtepsKey, Vteps> vtepsList = transportZone.getVteps();
1083                 if (vtepsList != null && !vtepsList.isEmpty()) {
1084                     for (Vteps vtep : vtepsList.values()) {
1085                         listOfDpId.add(vtep.getDpnId());
1086                     }
1087                 }
1088             }
1089         }
1090         return listOfDpId;
1091     }
1092 }