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