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

   1 /*
   2  * Copyright (c) 2016 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 com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.net.InetAddresses;
  13 import com.google.common.util.concurrent.CheckedFuture;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.Futures;
  16 import org.apache.commons.lang3.StringUtils;
  17 import org.apache.commons.net.util.SubnetUtils;
  18 import org.apache.commons.net.util.SubnetUtils.SubnetInfo;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  24 import org.opendaylight.genius.itm.api.IITMProvider;
  25 import org.opendaylight.genius.itm.confighelpers.HwVtep;
  26 import org.opendaylight.genius.itm.globals.ITMConstants;
  27 import org.opendaylight.genius.mdsalutil.*;
  28 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorParams;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelListKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.DcGatewayIpList;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.dc.gateway.ip.list.DcGatewayIp;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.*;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.*;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifier;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifierBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifierKey;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorInterval;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.VtepConfigSchemas;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.VtepIpPools;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.VtepConfigSchema;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.VtepConfigSchemaBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.VtepConfigSchemaKey;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.vtep.config.schema.DpnIds;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.vtep.config.schema.DpnIdsBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.vtep.config.schema.DpnIdsKey;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.ip.pools.VtepIpPool;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.ip.pools.VtepIpPoolKey;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpointsBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.ExternalTunnelList;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelList;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsKey;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelKey;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnel;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelKey;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Subnets;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.Vteps;
  81 import org.opendaylight.yangtools.yang.binding.DataObject;
  82 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  83 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  84 import org.opendaylight.yangtools.yang.common.RpcResult;
  85 import org.slf4j.Logger;
  86 import org.slf4j.LoggerFactory;
  87
  88 import java.math.BigInteger;
  89 import java.net.InetAddress;
  90 import java.util.ArrayList;
  91 import java.util.Collection;
  92 import java.util.Collections;
  93 import java.util.List;
  94 import java.util.concurrent.ExecutionException;
  95 import java.util.concurrent.Future;
  96
  97 public class ItmUtils {
  98
  99     public static final String DUMMY_IP_ADDRESS = "0.0.0.0";
 100     public static final String TUNNEL_TYPE_VXLAN = "VXLAN";
 101     public static final String TUNNEL_TYPE_GRE = "GRE";
 102     public static final String TUNNEL = "TUNNEL";
 103     public static ItmCache itmCache = new ItmCache();
 104
 105     private static final Logger LOG = LoggerFactory.getLogger(ItmUtils.class);
 106
 107     public static final FutureCallback<Void> DEFAULT_CALLBACK = new FutureCallback<Void>() {
 108         public void onSuccess(Void result) {
 109             LOG.debug("Success in Datastore write operation");
 110         }
 111
 112         public void onFailure(Throwable error) {
 113             LOG.error("Error in Datastore write operation", error);
 114         }
 115     };
 116
 117     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 118                                                           InstanceIdentifier<T> path, DataBroker broker) {
 119
 120         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 121
 122         Optional<T> result = Optional.absent();
 123         try {
 124             result = tx.read(datastoreType, path).get();
 125         } catch (Exception e) {
 126             throw new RuntimeException(e);
 127         }
 128
 129         return result;
 130     }
 131
 132     public static <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
 133                                                          InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
 134         WriteTransaction tx = broker.newWriteOnlyTransaction();
 135         tx.put(datastoreType, path, data, true);
 136         Futures.addCallback(tx.submit(), callback);
 137     }
 138
 139     public static <T extends DataObject> void asyncUpdate(LogicalDatastoreType datastoreType,
 140                                                           InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
 141         WriteTransaction tx = broker.newWriteOnlyTransaction();
 142         tx.merge(datastoreType, path, data, true);
 143         Futures.addCallback(tx.submit(), callback);
 144     }
 145
 146     public static <T extends DataObject> void asyncDelete(LogicalDatastoreType datastoreType,
 147                                                           InstanceIdentifier<T> path, DataBroker broker, FutureCallback<Void> callback) {
 148         WriteTransaction tx = broker.newWriteOnlyTransaction();
 149         tx.delete(datastoreType, path);
 150         Futures.addCallback(tx.submit(), callback);
 151     }
 152     public static <T extends DataObject> void asyncBulkRemove(final DataBroker broker,final LogicalDatastoreType datastoreType,
 153                                                               List<InstanceIdentifier<T>> pathList, FutureCallback<Void> callback) {
 154         if (!pathList.isEmpty()) {
 155             WriteTransaction tx = broker.newWriteOnlyTransaction();
 156             for (InstanceIdentifier<T> path : pathList) {
 157                 tx.delete(datastoreType, path);
 158             }
 159             Futures.addCallback(tx.submit(), callback);
 160         }
 161     }
 162
 163     public static String getInterfaceName(final BigInteger datapathid, final String portName, final Integer vlanId) {
 164         return String.format("%s:%s:%s", datapathid, portName, vlanId);
 165     }
 166
 167     public static BigInteger getDpnIdFromInterfaceName(String interfaceName) {
 168         String[] dpnStr = interfaceName.split(":");
 169         BigInteger dpnId = new BigInteger(dpnStr[0]);
 170         return dpnId;
 171     }
 172
 173     public static String getTrunkInterfaceName(IdManagerService idManager, String parentInterfaceName,
 174                                                String localHostName, String remoteHostName, String tunnelType) {
 175         String tunnelTypeStr;
 176         if(tunnelType.contains("TunnelTypeGre")) {
 177             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_GRE;
 178         } else {
 179             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_VXLAN;
 180         }
 181         String trunkInterfaceName = String.format(  "%s:%s:%s:%s", parentInterfaceName, localHostName,
 182                 remoteHostName, tunnelTypeStr);
 183         LOG.trace("trunk interface name is {}", trunkInterfaceName);
 184         trunkInterfaceName = String.format("%s:%s", TUNNEL, getUniqueId(idManager, trunkInterfaceName));
 185         return trunkInterfaceName;
 186     }
 187
 188     public static void releaseIdForTrunkInterfaceName(IdManagerService idManager, String parentInterfaceName, String localHostName, String remoteHostName, String tunnelType) {
 189         String tunnelTypeStr;
 190         if(tunnelType.contains("TunnelTypeGre")) {
 191             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_GRE;
 192         } else {
 193             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_VXLAN;
 194         }
 195         String trunkInterfaceName = String.format("%s:%s:%s:%s", parentInterfaceName, localHostName, remoteHostName, tunnelTypeStr);
 196         LOG.trace("Releasing Id for trunkInterface - {}", trunkInterfaceName );
 197         releaseId(idManager, trunkInterfaceName) ;
 198     }
 199
 200     public static InetAddress getInetAddressFromIpAddress(IpAddress ip) {
 201         return InetAddresses.forString(ip.getIpv4Address().getValue());
 202     }
 203
 204     public static InstanceIdentifier<DPNTEPsInfo> getDPNTEPInstance(BigInteger dpIdKey) {
 205         InstanceIdentifier.InstanceIdentifierBuilder<DPNTEPsInfo> dpnTepInfoBuilder =
 206                 InstanceIdentifier.builder(DpnEndpoints.class).child(DPNTEPsInfo.class,
 207                         new DPNTEPsInfoKey(dpIdKey));
 208         InstanceIdentifier<DPNTEPsInfo> dpnInfo = dpnTepInfoBuilder.build();
 209         return dpnInfo;
 210     }
 211
 212     public static DPNTEPsInfo createDPNTepInfo(BigInteger dpId, List<TunnelEndPoints> endpoints) {
 213
 214         return new DPNTEPsInfoBuilder().setKey(new DPNTEPsInfoKey(dpId)).setTunnelEndPoints(endpoints).build();
 215     }
 216
 217     public static TunnelEndPoints createTunnelEndPoints(BigInteger dpnId, IpAddress ipAddress, String portName, int vlanId,
 218                                                         IpPrefix prefix, IpAddress gwAddress, String zoneName, Class<? extends TunnelTypeBase>  tunnel_type) {
 219         // when Interface Mgr provides support to take in Dpn Id
 220         return new TunnelEndPointsBuilder().setKey(new TunnelEndPointsKey(ipAddress, portName,tunnel_type, vlanId))
 221                 .setSubnetMask(prefix).setGwIpAddress(gwAddress).setTransportZone(zoneName)
 222                 .setInterfaceName(ItmUtils.getInterfaceName(dpnId, portName, vlanId)).setTunnelType(tunnel_type).build();
 223     }
 224
 225     public static DpnEndpoints createDpnEndpoints(List<DPNTEPsInfo> dpnTepInfo) {
 226         return new DpnEndpointsBuilder().setDPNTEPsInfo(dpnTepInfo).build();
 227     }
 228
 229     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 230         InstanceIdentifierBuilder<Interface> idBuilder =
 231                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 232         InstanceIdentifier<Interface> id = idBuilder.build();
 233         return id;
 234     }
 235
 236     public static Interface buildTunnelInterface(BigInteger dpn, String ifName, String desc, boolean enabled, Class<? extends TunnelTypeBase> tunType,
 237                                                  IpAddress localIp, IpAddress remoteIp, IpAddress gatewayIp,Integer vlanId, boolean internal, Boolean monitorEnabled, Class<? extends TunnelMonitoringTypeBase> monitorProtocol, Integer monitorInterval) {
 238         InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(ifName)).setName(ifName)
 239                 .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 240         ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 241         builder.addAugmentation(ParentRefs.class, parentRefs);
 242         if( vlanId > 0) {
 243             IfL2vlan l2vlan = new IfL2vlanBuilder().setVlanId(new VlanId(vlanId)).build();
 244             builder.addAugmentation(IfL2vlan.class, l2vlan);
 245         }
 246         LOG.debug("buildTunnelInterface: monitorProtocol = {} and monitorInterval = {}",monitorProtocol.getName(),monitorInterval);
 247
 248         Long monitoringInterval = (long)ITMConstants.BFD_DEFAULT_MONITOR_INTERVAL;
 249         Boolean monitoringEnabled = true;
 250         if(monitorInterval!= null)
 251             monitoringInterval = monitorInterval.longValue();
 252         else {
 253             if (monitorProtocol.getName().contains("Bfd"))
 254                 monitoringInterval = (long) ITMConstants.BFD_DEFAULT_MONITOR_INTERVAL;
 255             else
 256                 monitoringInterval = (long) ITMConstants.DEFAULT_MONITOR_INTERVAL;
 257         }
 258         LOG.debug("buildTunnelInterface: monitorProtocol = {} and monitorInterval = {}",monitorProtocol.getName(),monitorInterval);
 259
 260         if(monitorEnabled!=null  )
 261             monitoringEnabled = monitorEnabled;
 262         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(remoteIp).setTunnelGateway(
 263                 gatewayIp).setTunnelSource(localIp)
 264                 .setTunnelInterfaceType(tunType).setInternal(internal).setMonitorEnabled(
 265                         monitoringEnabled).setMonitorProtocol(monitorProtocol).setMonitorInterval(monitoringInterval).build();
 266         builder.addAugmentation(IfTunnel.class, tunnel);
 267         return builder.build();
 268     }
 269
 270     public static Interface buildHwTunnelInterface(String tunnelIfName, String desc, boolean enabled, String topo_id,
 271                                                    String node_id, Class<? extends TunnelTypeBase> tunType, IpAddress srcIp, IpAddress destIp,
 272                                                    IpAddress gWIp, Boolean monitor_enabled, Class<? extends TunnelMonitoringTypeBase> monitorProtocol, Integer monitor_interval){
 273         InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(tunnelIfName)).setName(
 274                 tunnelIfName).setDescription(desc).
 275                 setEnabled(enabled).setType(Tunnel.class);
 276         List<NodeIdentifier> nodeIds = new ArrayList<NodeIdentifier>();
 277         NodeIdentifier hWnode = new NodeIdentifierBuilder().setKey(new NodeIdentifierKey(topo_id)).setTopologyId(
 278                 topo_id).
 279                 setNodeId(node_id).build();
 280         nodeIds.add(hWnode);
 281         ParentRefs parent = new ParentRefsBuilder().setNodeIdentifier(nodeIds).build();
 282         builder.addAugmentation(ParentRefs.class, parent);
 283         Long monitoringInterval = (long) ITMConstants.DEFAULT_MONITOR_INTERVAL;
 284         Boolean monitoringEnabled = true;
 285         Class<? extends TunnelMonitoringTypeBase> monitoringProtocol = ITMConstants.DEFAULT_MONITOR_PROTOCOL;
 286         if(monitor_interval!= null)
 287             monitoringInterval = monitor_interval.longValue();
 288         if(monitor_enabled!=null  )
 289             monitoringEnabled = monitor_enabled;
 290         if(monitorProtocol!=null)
 291             monitoringProtocol = monitorProtocol;
 292         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(destIp).setTunnelGateway(gWIp).setTunnelSource(
 293                 srcIp).setMonitorEnabled(monitoringEnabled).setMonitorProtocol(monitorProtocol).setMonitorInterval(100L).
 294                 setTunnelInterfaceType(tunType).setInternal(false).build();
 295         builder.addAugmentation(IfTunnel.class, tunnel);
 296         LOG.trace("iftunnel {} built from hwvtep {} ", tunnel, node_id);
 297         return builder.build();
 298     }
 299
 300
 301     public static InternalTunnel buildInternalTunnel( BigInteger srcDpnId, BigInteger dstDpnId,
 302                                                       Class<? extends TunnelTypeBase> tunType,
 303                                                       String trunkInterfaceName) {
 304         InternalTunnel tnl = new InternalTunnelBuilder().setKey(new InternalTunnelKey(dstDpnId, srcDpnId, tunType)).setDestinationDPN(dstDpnId)
 305                 .setSourceDPN(srcDpnId).setTransportType(tunType)
 306                 .setTunnelInterfaceName(trunkInterfaceName).build();
 307         return tnl ;
 308     }
 309
 310     public static ExternalTunnel buildExternalTunnel(String srcNode, String dstNode,
 311                                                      Class<? extends TunnelTypeBase> tunType,
 312                                                      String trunkInterfaceName) {
 313         ExternalTunnel extTnl = new ExternalTunnelBuilder().setKey(
 314                 new ExternalTunnelKey(dstNode, srcNode, tunType))
 315                 .setSourceDevice(srcNode).setDestinationDevice(dstNode)
 316                 .setTunnelInterfaceName(trunkInterfaceName)
 317                 .setTransportType(tunType).build();
 318         return extTnl ;
 319     }
 320
 321     public static List<DPNTEPsInfo> getTunnelMeshInfo(DataBroker dataBroker) {
 322         List<DPNTEPsInfo> dpnTEPs= null ;
 323
 324         // Read the EndPoint Info from the operational database
 325         InstanceIdentifierBuilder<DpnEndpoints> depBuilder = InstanceIdentifier.builder( DpnEndpoints.class);
 326         InstanceIdentifier<DpnEndpoints> deps = depBuilder.build();
 327         Optional<DpnEndpoints> dpnEps = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, deps, dataBroker);
 328         if (dpnEps.isPresent()) {
 329             DpnEndpoints tn= dpnEps.get() ;
 330             dpnTEPs = tn.getDPNTEPsInfo();
 331             LOG.debug( "Read from CONFIGURATION datastore - No. of Dpns " , dpnTEPs.size() );
 332         }else
 333             LOG.debug( "No Dpn information in CONFIGURATION datastore "  );
 334         return dpnTEPs ;
 335     }
 336
 337     public static int getUniqueId(IdManagerService idManager, String idKey) {
 338         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 339                 .setPoolName(ITMConstants.ITM_IDPOOL_NAME)
 340                 .setIdKey(idKey).build();
 341
 342         try {
 343             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 344             RpcResult<AllocateIdOutput> rpcResult = result.get();
 345             if(rpcResult.isSuccessful()) {
 346                 return rpcResult.getResult().getIdValue().intValue();
 347             } else {
 348                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 349             }
 350         } catch (InterruptedException | ExecutionException e) {
 351             LOG.warn("Exception when getting Unique Id",e);
 352         }
 353         return 0;
 354     }
 355
 356     public static void releaseId(IdManagerService idManager, String idKey) {
 357         ReleaseIdInput idInput =
 358                 new ReleaseIdInputBuilder().setPoolName(ITMConstants.ITM_IDPOOL_NAME).setIdKey(idKey).build();
 359         try {
 360             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 361             RpcResult<Void> rpcResult = result.get();
 362             if(!rpcResult.isSuccessful()) {
 363                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 364             }
 365         } catch (InterruptedException | ExecutionException e) {
 366             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 367         }
 368     }
 369
 370     public static List<DPNTEPsInfo> getDPNTEPListFromDPNId(DataBroker dataBroker, List<BigInteger> dpnIds) {
 371         List<DPNTEPsInfo> meshedDpnList = getTunnelMeshInfo(dataBroker) ;
 372         List<DPNTEPsInfo> cfgDpnList = new ArrayList<DPNTEPsInfo>();
 373         if( null != meshedDpnList) {
 374             for(BigInteger dpnId : dpnIds) {
 375                 for( DPNTEPsInfo teps : meshedDpnList ) {
 376                     if( dpnId.equals(teps.getDPNID()))
 377                         cfgDpnList.add( teps) ;
 378                 }
 379             }
 380         }
 381         return cfgDpnList;
 382     }
 383
 384     public static void setUpOrRemoveTerminatingServiceTable(BigInteger dpnId, IMdsalApiManager mdsalManager, boolean addFlag) {
 385         String logmsg = ( addFlag == true) ? "Installing" : "Removing";
 386         LOG.trace( logmsg + " PUNT to Controller flow in DPN {} ", dpnId );
 387         long dpId;
 388         List<ActionInfo> listActionInfo = new ArrayList<ActionInfo>();
 389         listActionInfo.add(new ActionInfo(ActionType.punt_to_controller,
 390                 new String[] {}));
 391
 392         try {
 393             List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 394
 395             mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] {
 396                     BigInteger.valueOf(ITMConstants.LLDP_SERVICE_ID) }));
 397
 398             List<InstructionInfo> mkInstructions = new ArrayList<InstructionInfo>();
 399             mkInstructions.add(new InstructionInfo(InstructionType.apply_actions,
 400                     listActionInfo));
 401
 402             FlowEntity terminatingServiceTableFlowEntity = MDSALUtil
 403                     .buildFlowEntity(
 404                             dpnId,
 405                             NwConstants.INTERNAL_TUNNEL_TABLE,
 406                             getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE,
 407                                     ITMConstants.LLDP_SERVICE_ID), 5, String.format("%s:%d","ITM Flow Entry ",ITMConstants.LLDP_SERVICE_ID),
 408                             0, 0, ITMConstants.COOKIE_ITM
 409                                     .add(BigInteger.valueOf(ITMConstants.LLDP_SERVICE_ID)),
 410                             mkMatches, mkInstructions);
 411             if(addFlag)
 412                 mdsalManager.installFlow(terminatingServiceTableFlowEntity);
 413             else
 414                 mdsalManager.removeFlow(terminatingServiceTableFlowEntity);
 415         } catch (Exception e) {
 416             LOG.error("Error while setting up Table 36 for {}", dpnId, e);
 417         }
 418     }
 419
 420     private static String getFlowRef(long termSvcTable, int svcId) {
 421         return new StringBuffer().append(termSvcTable).append(svcId).toString();
 422     }
 423     public static InstanceIdentifier<VtepConfigSchema> getVtepConfigSchemaIdentifier(String schemaName) {
 424         return InstanceIdentifier.builder(VtepConfigSchemas.class)
 425                 .child(VtepConfigSchema.class, new VtepConfigSchemaKey(schemaName)).build();
 426     }
 427
 428     public static InstanceIdentifier<VtepConfigSchema> getVtepConfigSchemaIdentifier() {
 429         return InstanceIdentifier.builder(VtepConfigSchemas.class).child(VtepConfigSchema.class).build();
 430     }
 431     public static InstanceIdentifier<VtepConfigSchemas> getVtepConfigSchemasIdentifier() {
 432         return InstanceIdentifier.builder(VtepConfigSchemas.class).build();
 433     }
 434     public static InstanceIdentifier<VtepIpPool> getVtepIpPoolIdentifier(String subnetCidr) {
 435         return InstanceIdentifier.builder(VtepIpPools.class).child(VtepIpPool.class, new VtepIpPoolKey(subnetCidr))
 436                 .build();
 437     }
 438     public static VtepConfigSchema validateForAddVtepConfigSchema(VtepConfigSchema schema,
 439                                                                   List<VtepConfigSchema> existingSchemas) {
 440         VtepConfigSchema validSchema = validateVtepConfigSchema(schema);
 441         for (VtepConfigSchema existingSchema : emptyIfNull(existingSchemas)) {
 442             if (!StringUtils.equalsIgnoreCase(schema.getSchemaName(), existingSchema.getSchemaName())
 443                     && schema.getSubnet().equals(existingSchema.getSubnet())) {
 444                 String subnetCidr = getSubnetCidrAsString(schema.getSubnet());
 445                 Preconditions.checkArgument(false, new StringBuilder("VTEP schema with subnet [").append(subnetCidr)
 446                         .append("] already exists. Multiple VTEP schemas with same subnet is not allowed.").toString());
 447             }
 448         }
 449         if (isNotEmpty(getDpnIdList(validSchema.getDpnIds()))) {
 450             String tzone = validSchema.getTransportZoneName();
 451             List<BigInteger> lstDpns = getConflictingDpnsAlreadyConfiguredWithTz(validSchema.getSchemaName(), tzone,
 452                     getDpnIdList(validSchema.getDpnIds()), existingSchemas);
 453             if (!lstDpns.isEmpty()) {
 454                 Preconditions.checkArgument(false,
 455                         new StringBuilder("DPN's ").append(lstDpns).append(" already configured for transport zone ")
 456                                 .append(tzone).append(". Only one end point per transport Zone per Dpn is allowed.")
 457                                 .toString());
 458             }
 459             if (schema.getTunnelType().equals(TunnelTypeGre.class)){
 460                 validateForSingleGreTep(validSchema.getSchemaName(), getDpnIdList(validSchema.getDpnIds()), existingSchemas);
 461             }
 462         }
 463         return validSchema;
 464     }
 465     private static void validateForSingleGreTep(String schemaName, List<BigInteger> lstDpnsForAdd,
 466                                                 List<VtepConfigSchema> existingSchemas) {
 467         for (VtepConfigSchema existingSchema : emptyIfNull(existingSchemas)) {
 468             if ((TunnelTypeGre.class).equals(existingSchema.getTunnelType())
 469                     && !StringUtils.equalsIgnoreCase(schemaName, existingSchema.getSchemaName())) {
 470                 List<BigInteger> lstConflictingDpns = new ArrayList<>(getDpnIdList(existingSchema.getDpnIds()));
 471                 lstConflictingDpns.retainAll(emptyIfNull(lstDpnsForAdd));
 472                 if (!lstConflictingDpns.isEmpty()) {
 473                     String errMsg = new StringBuilder("DPN's ").append(lstConflictingDpns)
 474                             .append(" already configured with GRE TEP. Mutiple GRE TEP's on a single DPN are not allowed.")
 475                             .toString();
 476                     Preconditions.checkArgument(false, errMsg);
 477                 }
 478             }
 479         }
 480     }
 481     public static VtepConfigSchema validateVtepConfigSchema(VtepConfigSchema schema) {
 482         Preconditions.checkNotNull(schema);
 483         Preconditions.checkArgument(StringUtils.isNotBlank(schema.getSchemaName()));
 484         Preconditions.checkArgument(StringUtils.isNotBlank(schema.getPortName()));
 485         Preconditions.checkArgument((schema.getVlanId() >= 0 && schema.getVlanId() < 4095),
 486                 "Invalid VLAN ID, range (0-4094)");
 487         Preconditions.checkArgument(StringUtils.isNotBlank(schema.getTransportZoneName()));
 488         Preconditions.checkNotNull(schema.getSubnet());
 489         String subnetCidr = getSubnetCidrAsString(schema.getSubnet());
 490         SubnetUtils subnetUtils = new SubnetUtils(subnetCidr);
 491         IpAddress gatewayIp = schema.getGatewayIp();
 492         if (gatewayIp != null) {
 493             String strGatewayIp = String.valueOf(gatewayIp.getValue());
 494             if (!strGatewayIp.equals(ITMConstants.DUMMY_IP_ADDRESS) && !subnetUtils.getInfo().isInRange(strGatewayIp)) {
 495                 Preconditions.checkArgument(false, new StringBuilder("Gateway IP address ").append(strGatewayIp)
 496                         .append(" is not in subnet range ").append(subnetCidr).toString());
 497             }
 498         }
 499         ItmUtils.getExcludeIpAddresses(schema.getExcludeIpFilter(), subnetUtils.getInfo());
 500         return new VtepConfigSchemaBuilder(schema).setTunnelType(schema.getTunnelType()).build();
 501     }
 502     public static String validateTunnelType(String tunnelType) {
 503         if (tunnelType == null) {
 504             tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 505         } else {
 506             tunnelType = StringUtils.upperCase(tunnelType);
 507             String error = new StringBuilder("Invalid tunnel type. Valid values: ")
 508                     .append(ITMConstants.TUNNEL_TYPE_VXLAN).append(" | ").append(ITMConstants.TUNNEL_TYPE_GRE)
 509                     .toString();
 510             Preconditions.checkArgument(ITMConstants.TUNNEL_TYPE_VXLAN.equals(tunnelType)
 511                     || ITMConstants.TUNNEL_TYPE_GRE.equals(tunnelType), error);
 512         }
 513         return tunnelType;
 514     }
 515     private static List<BigInteger> getConflictingDpnsAlreadyConfiguredWithTz(String schemaName, String tzone,
 516                                                                               List<BigInteger> lstDpns, List<VtepConfigSchema> existingSchemas) {
 517         List<BigInteger> lstConflictingDpns = new ArrayList<>();
 518         for (VtepConfigSchema schema : emptyIfNull(existingSchemas)) {
 519             if (!StringUtils.equalsIgnoreCase(schemaName, schema.getSchemaName())
 520                     && StringUtils.equals(schema.getTransportZoneName(), tzone)) {
 521                 lstConflictingDpns = new ArrayList<>(getDpnIdList(schema.getDpnIds()));
 522                 lstConflictingDpns.retainAll(lstDpns);
 523                 if (!lstConflictingDpns.isEmpty()) {
 524                     break;
 525                 }
 526             }
 527         }
 528         return lstConflictingDpns;
 529     }
 530     public static VtepConfigSchema constructVtepConfigSchema(String schemaName, String portName, Integer vlanId,
 531                                                              String subnetMask, String gatewayIp, String transportZone,String tunnelType, List<BigInteger> dpnIds,
 532                                                              String excludeIpFilter) {
 533         IpAddress gatewayIpObj = StringUtils.isBlank(gatewayIp) ? null : new IpAddress(gatewayIp.toCharArray());
 534         IpPrefix subnet = StringUtils.isBlank(subnetMask) ? null : new IpPrefix(subnetMask.toCharArray());
 535         Class<? extends TunnelTypeBase> tunType ;
 536         if( tunnelType.equals(ITMConstants.TUNNEL_TYPE_VXLAN))
 537             tunType = TunnelTypeVxlan.class ;
 538         else
 539             tunType = TunnelTypeGre.class ;
 540         VtepConfigSchemaBuilder schemaBuilder = new VtepConfigSchemaBuilder().setSchemaName(schemaName)
 541                 .setPortName(portName).setVlanId(vlanId).setSubnet(subnet).setGatewayIp(gatewayIpObj)
 542                 .setTransportZoneName(transportZone).setTunnelType(tunType).setDpnIds(getDpnIdsListFromBigInt(dpnIds))
 543                 .setExcludeIpFilter(excludeIpFilter);
 544         return schemaBuilder.build();
 545     }
 546     public static List<IpAddress> getExcludeIpAddresses(String excludeIpFilter, SubnetInfo subnetInfo) {
 547         final List<IpAddress> lstIpAddress = new ArrayList<>();
 548         if (StringUtils.isBlank(excludeIpFilter)) {
 549             return lstIpAddress;
 550         }
 551         final String[] arrIps = StringUtils.split(excludeIpFilter, ',');
 552         for (String ip : arrIps) {
 553             if (StringUtils.countMatches(ip, "-") == 1) {
 554                 final String[] arrIpRange = StringUtils.split(ip, '-');
 555                 String strStartIp = StringUtils.trim(arrIpRange[0]);
 556                 String strEndIp = StringUtils.trim(arrIpRange[1]);
 557                 Preconditions.checkArgument(InetAddresses.isInetAddress(strStartIp),
 558                         new StringBuilder("Invalid exclude IP filter: invalid IP address value ").append(strStartIp)
 559                                 .toString());
 560                 Preconditions.checkArgument(InetAddresses.isInetAddress(strEndIp),
 561                         new StringBuilder("Invalid exclude IP filter: invalid IP address value ").append(strEndIp)
 562                                 .toString());
 563                 Preconditions.checkArgument(subnetInfo.isInRange(strStartIp),
 564                         new StringBuilder("Invalid exclude IP filter: IP address [").append(strStartIp)
 565                                 .append("] not in subnet range ").append(subnetInfo.getCidrSignature()).toString());
 566                 Preconditions.checkArgument(subnetInfo.isInRange(strEndIp),
 567                         new StringBuilder("Invalid exclude IP filter: IP address [").append(strEndIp)
 568                                 .append("] not in subnet range ").append(subnetInfo.getCidrSignature()).toString());
 569                 int startIp = subnetInfo.asInteger(strStartIp);
 570                 int endIp = subnetInfo.asInteger(strEndIp);
 571
 572                 Preconditions.checkArgument(startIp < endIp,
 573                         new StringBuilder("Invalid exclude IP filter: Invalid range [").append(ip).append("] ")
 574                                 .toString());
 575                 for (int i = startIp; i <= endIp; i++) {
 576                     String ipAddress = ipFormat(toIpArray(i));
 577                     validateAndAddIpAddressToList(subnetInfo, lstIpAddress, ipAddress);
 578                 }
 579             } else {
 580                 validateAndAddIpAddressToList(subnetInfo, lstIpAddress, ip);
 581             }
 582         }
 583         return lstIpAddress;
 584     }
 585     private static void validateAndAddIpAddressToList(SubnetInfo subnetInfo, final List<IpAddress> lstIpAddress,
 586                                                       String ipAddress) {
 587         String ip = StringUtils.trim(ipAddress);
 588         Preconditions.checkArgument(InetAddresses.isInetAddress(ip),
 589                 new StringBuilder("Invalid exclude IP filter: invalid IP address value ").append(ip).toString());
 590         Preconditions.checkArgument(subnetInfo.isInRange(ip),
 591                 new StringBuilder("Invalid exclude IP filter: IP address [").append(ip).append("] not in subnet range ")
 592                         .append(subnetInfo.getCidrSignature()).toString());
 593         lstIpAddress.add(new IpAddress(ip.toCharArray()));
 594     }
 595     private static int[] toIpArray(int val) {
 596         int[] ret = new int[4];
 597         for (int j = 3; j >= 0; --j) {
 598             ret[j] |= ((val >>> 8 * (3 - j)) & (0xff));
 599         }
 600         return ret;
 601     }
 602     private static String ipFormat(int[] octets) {
 603         StringBuilder str = new StringBuilder();
 604         for (int i = 0; i < octets.length; ++i) {
 605             str.append(octets[i]);
 606             if (i != octets.length - 1) {
 607                 str.append(".");
 608             }
 609         }
 610         return str.toString();
 611     }
 612     public static VtepConfigSchema validateForUpdateVtepSchema(String schemaName, List<BigInteger> lstDpnsForAdd,
 613                                                                List<BigInteger> lstDpnsForDelete, IITMProvider itmProvider) {
 614         Preconditions.checkArgument(StringUtils.isNotBlank(schemaName));
 615         if ((lstDpnsForAdd == null || lstDpnsForAdd.isEmpty())
 616                 && (lstDpnsForDelete == null || lstDpnsForDelete.isEmpty())) {
 617             Preconditions.checkArgument(false,
 618                     new StringBuilder("DPN ID list for add | delete is null or empty in schema ").append(schemaName)
 619                             .toString());
 620         }
 621         VtepConfigSchema schema = itmProvider.getVtepConfigSchema(schemaName);
 622         if (schema == null) {
 623             Preconditions.checkArgument(false, new StringBuilder("Specified VTEP Schema [").append(schemaName)
 624                     .append("] doesn't exists!").toString());
 625         }
 626         List<BigInteger> existingDpnIds = getDpnIdList(schema.getDpnIds());
 627         if (isNotEmpty(lstDpnsForAdd)) {
 628             //  if (isNotEmpty(existingDpnIds)) {
 629             List<BigInteger> lstAlreadyExistingDpns = new ArrayList<>(existingDpnIds);
 630             lstAlreadyExistingDpns.retainAll(lstDpnsForAdd);
 631             Preconditions.checkArgument(lstAlreadyExistingDpns.isEmpty(),
 632                     new StringBuilder("DPN ID's ").append(lstAlreadyExistingDpns)
 633                             .append(" already exists in VTEP schema [").append(schemaName).append("]").toString());
 634             //    }
 635             if (schema.getTunnelType().equals(TunnelTypeGre.class)) {
 636                 validateForSingleGreTep(schema.getSchemaName(), lstDpnsForAdd, itmProvider.getAllVtepConfigSchemas());
 637             }
 638         }
 639         if (isNotEmpty(lstDpnsForDelete)) {
 640             if (existingDpnIds == null || existingDpnIds.isEmpty()) {
 641                 StringBuilder builder = new StringBuilder("DPN ID's ").append(lstDpnsForDelete)
 642                         .append(" specified for delete from VTEP schema [").append(schemaName)
 643                         .append("] are not configured in the schema.");
 644                 Preconditions.checkArgument(false, builder.toString());
 645             } else if (!existingDpnIds.containsAll(lstDpnsForDelete)) {
 646                 List<BigInteger> lstConflictingDpns = new ArrayList<>(lstDpnsForDelete);
 647                 lstConflictingDpns.removeAll(existingDpnIds);
 648                 StringBuilder builder = new StringBuilder("DPN ID's ").append(lstConflictingDpns)
 649                         .append(" specified for delete from VTEP schema [").append(schemaName)
 650                         .append("] are not configured in the schema.");
 651                 Preconditions.checkArgument(false, builder.toString());
 652             }
 653         }
 654         return schema;
 655     }
 656     public static String getSubnetCidrAsString(IpPrefix subnet) {
 657         return (subnet == null) ? StringUtils.EMPTY : String.valueOf(subnet.getValue());
 658     }
 659     public static <T> List<T> emptyIfNull(List<T> list) {
 660         return (list == null) ? Collections.<T> emptyList() : list;
 661     }
 662     public static <T> boolean isEmpty(Collection<T> collection) {
 663         return (collection == null || collection.isEmpty()) ? true : false;
 664     }
 665     public static <T> boolean isNotEmpty(Collection<T> collection) {
 666         return !isEmpty(collection);
 667     }
 668     public static HwVtep createHwVtepObject(String topo_id, String node_id, IpAddress ipAddress, IpPrefix ipPrefix, IpAddress gatewayIP, int vlanID, Class<? extends TunnelTypeBase> tunnel_type, TransportZone transportZone) {
 669         HwVtep hwVtep = new HwVtep();
 670         hwVtep.setGatewayIP(gatewayIP);
 671         hwVtep.setHwIp(ipAddress);
 672         hwVtep.setIpPrefix(ipPrefix);
 673         hwVtep.setNode_id(node_id);
 674         hwVtep.setTopo_id(topo_id);
 675         hwVtep.setTransportZone(transportZone.getZoneName());
 676         hwVtep.setTunnel_type(tunnel_type);
 677         hwVtep.setVlanID(vlanID);
 678         return hwVtep;
 679     }
 680
 681     public static String getHwParentIf(String topo_id, String srcNodeid) {
 682         return String.format("%s:%s", topo_id, srcNodeid);
 683     }
 684
 685     public static <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType,
 686                                                         InstanceIdentifier<T> path, T data, DataBroker broker) {
 687         WriteTransaction tx = broker.newWriteOnlyTransaction();
 688         tx.put(datastoreType, path, data, true);
 689         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 690         try {
 691             futures.get();
 692         } catch (InterruptedException | ExecutionException e) {
 693             LOG.error("ITMUtils:SyncWrite , Error writing to datastore (path, data) : ({}, {})", path, data);
 694             throw new RuntimeException(e.getMessage());
 695         }
 696     }
 697
 698     public static List<BigInteger> getDpnIdList( List<DpnIds> dpnIds ) {
 699         List<BigInteger> dpnList = new ArrayList<BigInteger>() ;
 700         for( DpnIds dpn : dpnIds) {
 701             dpnList.add(dpn.getDPN()) ;
 702         }
 703         return dpnList ;
 704     }
 705
 706     public static List<DpnIds> getDpnIdsListFromBigInt( List<BigInteger> dpnIds) {
 707         List<DpnIds> dpnIdList = new ArrayList<DpnIds>() ;
 708         DpnIdsBuilder builder = new DpnIdsBuilder() ;
 709         for( BigInteger dpnId : dpnIds) {
 710             dpnIdList.add(builder.setKey(new DpnIdsKey(dpnId)).setDPN(dpnId).build() );
 711         }
 712         return dpnIdList;
 713     }
 714
 715     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
 716         InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
 717                 InstanceIdentifier.builder(InterfacesState.class)
 718                         .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
 719                                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(
 720                                         interfaceName));
 721         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
 722         return id;
 723     }
 724     public static Boolean readMonitoringStateFromDS(DataBroker dataBroker) {
 725         InstanceIdentifier<TunnelMonitorParams> iid = InstanceIdentifier.create(TunnelMonitorParams.class);
 726         Optional<TunnelMonitorParams> TunnelMonitorParamsOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION,
 727                 iid, dataBroker);
 728         if(TunnelMonitorParamsOptional.isPresent())
 729             return TunnelMonitorParamsOptional.get().isEnabled();
 730         return null;
 731     }
 732
 733     public static Integer readMonitorIntervalfromDS(DataBroker dataBroker) {
 734         InstanceIdentifier<TunnelMonitorInterval> iid = InstanceIdentifier.create(TunnelMonitorInterval.class);
 735         Optional<TunnelMonitorInterval> tunnelMonitorIOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
 736         if(tunnelMonitorIOptional.isPresent())
 737             return tunnelMonitorIOptional.get().getInterval();
 738         return null;
 739
 740     }
 741
 742     public static Integer determineMonitorInterval(DataBroker dataBroker) {
 743         Integer monitorInterval = ItmUtils.readMonitorIntervalfromDS(dataBroker);
 744         LOG.debug("determineMonitorInterval: monitorInterval from DS = {}", monitorInterval);
 745         if(monitorInterval==null){
 746             Class<? extends TunnelMonitoringTypeBase> monitoringProtocol = determineMonitorProtocol(dataBroker);
 747             if(monitoringProtocol.getName().contains("Bfd"))
 748                 monitorInterval = ITMConstants.BFD_DEFAULT_MONITOR_INTERVAL;
 749             else
 750                 monitorInterval = ITMConstants.DEFAULT_MONITOR_INTERVAL;
 751         }
 752         LOG.debug("determineMonitorInterval: monitorInterval = {}", monitorInterval);
 753         return monitorInterval;
 754     }
 755
 756     public static List<String> getTunnelsofTzone(List<HwVtep> hwVteps, String tzone, DataBroker dataBroker, Boolean hwVtepsExist) {
 757
 758         List<String> tunnels = new ArrayList<String>();
 759         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class).
 760                 child(TransportZone.class, new TransportZoneKey(tzone)).build();
 761         Optional<TransportZone> tZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 762         Class<? extends TunnelTypeBase> tunType = tZoneOptional.get().getTunnelType();
 763         if (tZoneOptional.isPresent()) {
 764             if (tZoneOptional.get().getSubnets() != null && !tZoneOptional.get().getSubnets().isEmpty()) {
 765                 for (Subnets sub : tZoneOptional.get().getSubnets()) {
 766                     if (sub.getVteps() != null && !sub.getVteps().isEmpty()) {
 767                         for (Vteps vtepLocal : sub.getVteps()) {
 768                             for (Vteps vtepRemote : sub.getVteps()) {
 769                                 if (!vtepLocal.equals(vtepRemote)) {
 770                                     InternalTunnelKey key = new InternalTunnelKey(vtepRemote.getDpnId(), vtepLocal.getDpnId(), tunType);
 771                                     InstanceIdentifier<InternalTunnel> intIID =
 772                                             InstanceIdentifier.builder(TunnelList.class).
 773                                                     child(InternalTunnel.class, key).build();
 774                                     Optional<InternalTunnel> TunnelsOptional =
 775                                             ItmUtils.read(LogicalDatastoreType.CONFIGURATION, intIID, dataBroker);
 776                                     if (TunnelsOptional.isPresent()) {
 777                                         LOG.trace("Internal Tunnel added {}",TunnelsOptional.get().getTunnelInterfaceName());
 778                                         tunnels.add(TunnelsOptional.get().getTunnelInterfaceName());
 779                                     }
 780                                 }
 781                             }
 782                             if(hwVteps!= null && !hwVteps.isEmpty()) {
 783                                 for (HwVtep hwVtep : hwVteps) {
 784                                     tunnels.add(getExtTunnel(hwVtep.getNode_id(), vtepLocal.getDpnId().toString(),
 785                                             tunType, dataBroker));
 786                                     tunnels.add(getExtTunnel(vtepLocal.getDpnId().toString(), hwVtep.getNode_id(),
 787                                             tunType, dataBroker));
 788                                 }
 789                             }
 790                         }
 791                     }
 792                 }
 793             }
 794         }
 795         if (hwVtepsExist) {
 796             for (HwVtep hwVtep : hwVteps) {
 797                 for (HwVtep hwVtepOther : hwVteps) {
 798                     if (!hwVtep.getHwIp().equals(hwVtepOther.getHwIp())) {
 799                         tunnels.add(getExtTunnel(hwVtep.getNode_id(), hwVtepOther.getNode_id(), tunType, dataBroker));
 800                         tunnels.add(getExtTunnel(hwVtepOther.getNode_id(), hwVtep.getNode_id(), tunType, dataBroker));
 801                     }
 802                 }
 803             }
 804         }
 805         return tunnels;
 806     }
 807
 808     public static List<String> getInternalTunnelsofTzone(String tzone, DataBroker dataBroker) {
 809         List<String> tunnels = new ArrayList<String>();
 810         LOG.trace("Getting internal tunnels of {}",tzone);
 811         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class).
 812                 child(TransportZone.class, new TransportZoneKey(tzone)).build();
 813         Optional<TransportZone> tZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 814         if (tZoneOptional.isPresent()) {
 815             if (tZoneOptional.get().getSubnets() != null && !tZoneOptional.get().getSubnets().isEmpty()) {
 816                 for (Subnets sub : tZoneOptional.get().getSubnets()) {
 817                     if (sub.getVteps() != null && !sub.getVteps().isEmpty()) {
 818                         for (Vteps vtepLocal : sub.getVteps()) {
 819                             for (Vteps vtepRemote : sub.getVteps()) {
 820                                 if (!vtepLocal.equals(vtepRemote)) {
 821                                     InternalTunnelKey key = new InternalTunnelKey(vtepRemote.getDpnId(), vtepLocal.getDpnId(), tZoneOptional.get().getTunnelType());
 822                                     InstanceIdentifier<InternalTunnel> intIID =
 823                                             InstanceIdentifier.builder(TunnelList.class).
 824                                                     child(InternalTunnel.class, key).build();
 825                                     Optional<InternalTunnel> TunnelsOptional =
 826                                             ItmUtils.read(LogicalDatastoreType.CONFIGURATION, intIID, dataBroker);
 827                                     if (TunnelsOptional.isPresent()) {
 828                                         LOG.trace("Internal Tunnel added {}",
 829                                                 TunnelsOptional.get().getTunnelInterfaceName());
 830                                         tunnels.add(TunnelsOptional.get().getTunnelInterfaceName());
 831                                     }
 832                                 }
 833                             }
 834                         }
 835                     }
 836                 }
 837             }
 838         }
 839         return tunnels;
 840     }
 841
 842     private static String getExtTunnel(String node_id, String dpId,Class<? extends TunnelTypeBase> tunType, DataBroker dataBroker) {
 843         LOG.trace("getting ext tunnel for {} and dpId {}",node_id,dpId);
 844         ExternalTunnelKey key = getExternalTunnelKey(dpId, node_id, tunType);
 845         InstanceIdentifier<ExternalTunnel> intIID = InstanceIdentifier.builder(ExternalTunnelList.class).
 846                 child(ExternalTunnel.class, key).build();
 847         Optional<ExternalTunnel> TunnelsOptional =
 848                 ItmUtils.read(LogicalDatastoreType.CONFIGURATION, intIID, dataBroker);
 849         if (TunnelsOptional.isPresent()) {
 850             LOG.trace("ext tunnel returned {} ",TunnelsOptional.get().getTunnelInterfaceName());
 851             return TunnelsOptional.get().getTunnelInterfaceName();
 852         }
 853         return null;
 854     }
 855     public static ExternalTunnelKey getExternalTunnelKey(String dst , String src, Class<? extends TunnelTypeBase> tunType) {
 856         if (src.indexOf("physicalswitch") > 0) {
 857             src = src.substring(0, src.indexOf("physicalswitch") - 1);
 858         }
 859         if (dst.indexOf("physicalswitch") > 0) {
 860             dst = dst.substring(0, dst.indexOf("physicalswitch") - 1);
 861         }
 862         return new ExternalTunnelKey(dst, src, tunType);
 863     }
 864
 865     public static List<TunnelEndPoints> getTEPsForDpn( BigInteger srcDpn, List<DPNTEPsInfo> dpnList) {
 866         for (DPNTEPsInfo dpn : dpnList) {
 867             if( dpn.getDPNID().equals(srcDpn)) {
 868                 return dpn.getTunnelEndPoints() ;
 869             }
 870         }
 871         return null ;
 872     }
 873     public static TunnelList getAllInternalTunnels(DataBroker broker) {
 874         InstanceIdentifier<TunnelList> tunnelListInstanceIdentifier = InstanceIdentifier.builder(TunnelList.class).build();
 875         Optional<TunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, tunnelListInstanceIdentifier, broker);
 876         if (tunnelList.isPresent()) {
 877             return tunnelList.get();
 878         }
 879         return null;
 880     }
 881     public static InternalTunnel getInternalTunnel(String interfaceName, DataBroker broker) {
 882         InternalTunnel internalTunnel = null;
 883         TunnelList tunnelList = getAllInternalTunnels(broker);
 884         if (tunnelList != null && tunnelList.getInternalTunnel() != null) {
 885             List<InternalTunnel> internalTunnels = tunnelList.getInternalTunnel();
 886             for (InternalTunnel tunnel : internalTunnels) {
 887                 if (tunnel.getTunnelInterfaceName().equalsIgnoreCase(interfaceName)) {
 888                     internalTunnel = tunnel;
 889                     break;
 890                 }
 891             }
 892         }
 893         return internalTunnel;
 894     }
 895     public static ExternalTunnel getExternalTunnel(String interfaceName, DataBroker broker) {
 896         ExternalTunnel externalTunnel = null;
 897         List<ExternalTunnel> externalTunnels = getAllExternalTunnels(broker);
 898         for (ExternalTunnel tunnel : externalTunnels) {
 899             if (StringUtils.equalsIgnoreCase(interfaceName, tunnel.getTunnelInterfaceName())) {
 900                 externalTunnel = tunnel;
 901                 break;
 902             }
 903         }
 904         return externalTunnel;
 905     }
 906     public static List<ExternalTunnel> getAllExternalTunnels(DataBroker broker) {
 907         List<ExternalTunnel> result = null;
 908         InstanceIdentifier<ExternalTunnelList> id = InstanceIdentifier.builder(ExternalTunnelList.class).build();
 909         Optional<ExternalTunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, id, broker);
 910         if (tunnelList.isPresent()) {
 911             result = tunnelList.get().getExternalTunnel();
 912         }
 913         if (result == null) {
 914             result = Collections.emptyList();
 915         }
 916         return result;
 917     }
 918     public static String convertTunnelTypetoString(Class<? extends TunnelTypeBase> tunType ) {
 919         String tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 920         if( tunType.equals(TunnelTypeVxlan.class))
 921             tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN ;
 922         else if( tunType.equals(TunnelTypeGre.class) )
 923             tunnelType = ITMConstants.TUNNEL_TYPE_GRE ;
 924         else if (tunnelType.equals(TunnelTypeMplsOverGre.class))
 925             tunnelType = ITMConstants.TUNNEL_TYPE_MPLS_OVER_GRE;
 926         return tunnelType ;
 927     }
 928
 929
 930     public static boolean isItmIfType(Class<? extends InterfaceType> ifType) {
 931         if( (ifType != null) && (ifType.isAssignableFrom(Tunnel.class)) ) {
 932             return true;
 933         }
 934         return false;
 935     }
 936
 937     public static StateTunnelListKey getTunnelStateKey( org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface iface) {
 938         StateTunnelListKey key = null;
 939         if(isItmIfType(iface.getType())) {
 940             key = new StateTunnelListKey(iface.getName());
 941         }
 942         return key;
 943     }
 944
 945     public static void updateTunnelsCache(DataBroker broker) {
 946         List<InternalTunnel> internalTunnels = getAllInternalTunnels(broker, LogicalDatastoreType.CONFIGURATION);
 947         for (InternalTunnel tunnel : internalTunnels) {
 948             itmCache.addInternalTunnel(tunnel);
 949         }
 950         List<ExternalTunnel> externalTunnels = getAllExternalTunnels(broker, LogicalDatastoreType.CONFIGURATION);
 951         for (ExternalTunnel tunnel : externalTunnels) {
 952             itmCache.addExternalTunnel(tunnel);
 953         }
 954     }
 955
 956     public static List<ExternalTunnel> getAllExternalTunnels(DataBroker dataBroker, LogicalDatastoreType datastoreType) {
 957         List<ExternalTunnel> result = null;
 958         InstanceIdentifier<ExternalTunnelList> iid = InstanceIdentifier.builder(ExternalTunnelList.class).build();
 959         Optional<ExternalTunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
 960         if (tunnelList.isPresent()) {
 961             result = tunnelList.get().getExternalTunnel();
 962         }
 963         if (result == null) {
 964             result = Collections.emptyList();
 965         }
 966         return result;
 967     }
 968
 969     public static List<InternalTunnel> getAllInternalTunnels(DataBroker dataBroker, LogicalDatastoreType datastoreType) {
 970         List<InternalTunnel> result = null;
 971         InstanceIdentifier<TunnelList> iid = InstanceIdentifier.builder(TunnelList.class).build();
 972         Optional<TunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
 973         if (tunnelList.isPresent()) {
 974             result = tunnelList.get().getInternalTunnel();
 975         }
 976         if (result == null) {
 977             result = Collections.emptyList();
 978         }
 979         return result;
 980     }
 981
 982     public static Interface getInterface(
 983             String name, DataBroker broker) {
 984         Interface result = itmCache.getInterface(name);
 985         if (result == null) {
 986             InstanceIdentifier<Interface> iid =
 987                     InstanceIdentifier.builder(Interfaces.class)
 988                             .child(Interface.class, new InterfaceKey(name)).build();
 989             Optional<Interface> optInterface = read(LogicalDatastoreType.CONFIGURATION, iid, broker);
 990             if (optInterface.isPresent()) {
 991                 result = optInterface.get();
 992                 itmCache.addInterface(result);
 993             }
 994         }
 995         return result;
 996     }
 997
 998     public static Class<? extends TunnelMonitoringTypeBase> readMonitoringProtocolFromDS(DataBroker dataBroker) {
 999         InstanceIdentifier<TunnelMonitorParams> iid = InstanceIdentifier.create(TunnelMonitorParams.class);
1000         Optional<TunnelMonitorParams> TunnelMonitorParamsOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION,
1001                 iid, dataBroker);
1002         if(TunnelMonitorParamsOptional.isPresent())
1003             return TunnelMonitorParamsOptional.get().getMonitorProtocol();
1004         return null;
1005     }
1006
1007     public static Class<? extends TunnelMonitoringTypeBase> determineMonitorProtocol(DataBroker dataBroker) {
1008         Class<? extends TunnelMonitoringTypeBase> monitoringProtocol = ItmUtils.readMonitoringProtocolFromDS(dataBroker);
1009         LOG.debug("determineMonitorProtocol: monitorProtocol from DS = {}", monitoringProtocol);
1010         if(monitoringProtocol==null)
1011             monitoringProtocol = ITMConstants.DEFAULT_MONITOR_PROTOCOL;
1012         LOG.debug("determineMonitorProtocol: monitorProtocol = {}", monitoringProtocol);
1013         return monitoringProtocol;
1014     }
1015
1016
1017     public static List<DcGatewayIp> getDcGatewayIpList(DataBroker broker){
1018         InstanceIdentifier<DcGatewayIpList> dcGatewayIpListid = InstanceIdentifier.builder(DcGatewayIpList.class).build();
1019         Optional<DcGatewayIpList> dcGatewayIpListConfig = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, dcGatewayIpListid, broker);
1020         if(dcGatewayIpListConfig.isPresent()){
1021             DcGatewayIpList containerList = dcGatewayIpListConfig.get();
1022             if(containerList != null){
1023                 return (containerList.getDcGatewayIp());
1024             }
1025         }
1026         return null;
1027     }
1028 }