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