vpnmanager/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnUtil.java

   1 /*
   2  * Copyright (c) 2015 - 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
   9 package org.opendaylight.vpnservice;
  10
  11 import java.math.BigInteger;
  12 import java.net.InetAddress;
  13 import java.util.concurrent.ExecutionException;
  14 import java.util.concurrent.Future;
  15 import java.util.List;
  16
  17 import com.google.common.base.Optional;
  18 import com.google.common.primitives.Ints;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import com.google.common.util.concurrent.FutureCallback;
  21 import com.google.common.util.concurrent.Futures;
  22
  23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  24 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  28 import org.opendaylight.vpnservice.mdsalutil.NwConstants;
  29 import org.opendaylight.vpnservice.mdsalutil.packet.ARP;
  30 import org.opendaylight.vpnservice.mdsalutil.packet.Ethernet;
  31 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  32 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  33 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  34 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  35 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  36 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  37 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  38 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.*;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.adjacency.list.Adjacency;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.Adjacencies;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.AdjacenciesBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIds;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.router.interfaces.RouterInterfaceBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.router.interfaces.RouterInterface;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.router.interfaces.RouterInterfaceKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.Vpn;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.VpnKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.Extraroute;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.ExtrarouteBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.to.extraroute.vpn.ExtrarouteKey;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanDpnInterfaces;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.FibEntries;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.fibentries.VrfTables;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.fibentries.VrfTablesKey;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.IfIndexesInterfaceMap;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterface;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterfaceKey;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.L3nexthop;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.VpnNexthops;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.NeutronPortData;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data.PortFixedipToPortName;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.neutronvpn.rev150602.neutron.port.data.PortFixedipToPortNameKey;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagName;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.ElanTagNameMap;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
  92 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  93 import org.opendaylight.yangtools.yang.common.RpcResult;
  94 import org.opendaylight.yangtools.yang.binding.DataObject;
  95 import org.slf4j.Logger;
  96 import org.slf4j.LoggerFactory;
  97
  98 public class VpnUtil {
  99     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
 100     private static final int DEFAULT_PREFIX_LENGTH = 32;
 101     private static final String PREFIX_SEPARATOR = "/";
 102
 103     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
 104         return InstanceIdentifier.builder(VpnInterfaces.class)
 105                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
 106     }
 107
 108     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
 109         return InstanceIdentifier.builder(VpnInstances.class)
 110                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 111     }
 112
 113     static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug) {
 114         return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(vpnName)
 115                 .addAugmentation(Adjacencies.class, aug)
 116                 .build();
 117     }
 118
 119     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
 120         return InstanceIdentifier.builder(PrefixToInterface.class)
 121             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
 122                                                              new PrefixesKey(ipPrefix)).build();
 123     }
 124
 125     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix) {
 126         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
 127             vpnInterfaceName).setIpAddress(ipPrefix).build();
 128     }
 129
 130     static InstanceIdentifier<Extraroute> getVpnToExtrarouteIdentifier(String vrfId, String ipPrefix) {
 131         return InstanceIdentifier.builder(VpnToExtraroute.class)
 132                 .child(Vpn.class, new VpnKey(vrfId)).child(Extraroute.class,
 133                  new ExtrarouteKey(ipPrefix)).build();
 134     }
 135
 136     static Extraroute getVpnToExtraroute(String ipPrefix, String nextHop) {
 137         return new ExtrarouteBuilder().setPrefix(ipPrefix).setNexthopIp(nextHop).build();
 138     }
 139
 140     static Adjacencies
 141     getVpnInterfaceAugmentation(List<Adjacency> nextHops) {
 142         return new AdjacenciesBuilder().setAdjacency(nextHops).build();
 143     }
 144
 145     public static InstanceIdentifier<IdPool> getPoolId(String poolName){
 146         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 147                         InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 148         InstanceIdentifier<IdPool> id = idBuilder.build();
 149         return id;
 150     }
 151
 152     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
 153         return InstanceIdentifier.builder(VpnInterfaces.class).build();
 154     }
 155
 156     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 157         return InstanceIdentifier.builder(Interfaces.class)
 158                 .child(Interface.class, new InterfaceKey(interfaceName)).build();
 159     }
 160
 161     static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
 162         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 163             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
 164             .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
 165     }
 166
 167     public static BigInteger getCookieArpFlow(int interfaceTag) {
 168         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
 169             BigInteger.valueOf(interfaceTag));
 170     }
 171
 172     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lPortTag, int arpType) {
 173             return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 174                     .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lPortTag)
 175                     .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
 176     }
 177
 178     public static int getUniqueId(IdManagerService idManager, String poolName,String idKey) {
 179         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 180                                            .setPoolName(poolName)
 181                                            .setIdKey(idKey).build();
 182
 183         try {
 184             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 185             RpcResult<AllocateIdOutput> rpcResult = result.get();
 186             if(rpcResult.isSuccessful()) {
 187                 return rpcResult.getResult().getIdValue().intValue();
 188             } else {
 189                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 190             }
 191         } catch (InterruptedException | ExecutionException e) {
 192             LOG.warn("Exception when getting Unique Id",e);
 193         }
 194         return 0;
 195     }
 196
 197     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 198         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 199         try {
 200             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 201             RpcResult<Void> rpcResult = result.get();
 202             if(!rpcResult.isSuccessful()) {
 203                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 204             }
 205         } catch (InterruptedException | ExecutionException e) {
 206             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 207         }
 208     }
 209
 210     public static String getNextHopLabelKey(String rd, String prefix){
 211         String key = rd + VpnConstants.SEPARATOR + prefix;
 212         return key;
 213     }
 214
 215     public static long getVpnId(DataBroker broker, String vpnName) {
 216
 217         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
 218             = getVpnInstanceToVpnIdIdentifier(vpnName);
 219         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
 220             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 221
 222         long vpnId = VpnConstants.INVALID_ID;
 223         if(vpnInstance.isPresent()) {
 224             vpnId = vpnInstance.get().getVpnId();
 225         }
 226         return vpnId;
 227     }
 228
 229     public static String getVpnRd(DataBroker broker, String vpnName) {
 230
 231         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
 232                 = getVpnInstanceToVpnIdIdentifier(vpnName);
 233         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
 234                 = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 235
 236         String rd = null;
 237         if(vpnInstance.isPresent()) {
 238             rd = vpnInstance.get().getVrfId();
 239         }
 240         return rd;
 241     }
 242
 243     static String getVpnRdFromVpnInstanceConfig(DataBroker broker, String vpnName) {
 244         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
 245                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 246         Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 247         String rd = null;
 248         if(vpnInstance.isPresent()) {
 249             VpnInstance instance = vpnInstance.get();
 250             VpnAfConfig config = instance.getIpv4Family();
 251             rd = config.getRouteDistinguisher();
 252         }
 253         return rd;
 254     }
 255
 256     static org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 257            getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 258         return new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder()
 259             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 260
 261     }
 262
 263     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance>
 264            getVpnInstanceToVpnIdIdentifier(String vpnName) {
 265         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
 266             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance.class,
 267                    new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
 268     }
 269
 270     static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 271         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 272             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 273     }
 274
 275     static VpnInstanceOpDataEntry getVpnInstanceOpDataBuilder(String rd, long vpnId) {
 276         return new VpnInstanceOpDataEntryBuilder().setVrfId(rd).setVpnId(vpnId).build();
 277     }
 278
 279     static VpnInstanceOpDataEntry updateIntfCntInVpnInstOpData(Long count, String vrfId) {
 280         return new VpnInstanceOpDataEntryBuilder().setVpnInterfaceCount(count).setVrfId(vrfId).build();
 281     }
 282
 283         static InstanceIdentifier<RouterInterface> getRouterInterfaceId(String interfaceName) {
 284         return InstanceIdentifier.builder(RouterInterfaces.class)
 285                 .child(RouterInterface.class, new RouterInterfaceKey(interfaceName)).build();
 286     }
 287
 288     static RouterInterface getRouterInterface(String interfaceName, String routerName) {
 289         return new RouterInterfaceBuilder().setKey(new RouterInterfaceKey(interfaceName))
 290                 .setInterfaceName(interfaceName).setRouterName(routerName).build();
 291     }
 292
 293     static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
 294         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 295         Optional<VpnInstanceOpDataEntry> vpnInstanceOpData = read(broker, LogicalDatastoreType.OPERATIONAL, id);
 296         if(vpnInstanceOpData.isPresent()) {
 297             return vpnInstanceOpData.get();
 298         }
 299         return null;
 300     }
 301
 302     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
 303         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 304         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 305
 306         if (configuredVpnInterface.isPresent()) {
 307             return configuredVpnInterface.get();
 308         }
 309         return null;
 310     }
 311
 312     static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
 313         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 314         Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 315
 316         if (operationalVpnInterface.isPresent()) {
 317             return operationalVpnInterface.get();
 318         }
 319         return null;
 320     }
 321
 322     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName)
 323     {
 324         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 325         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 326
 327         if (configuredVpnInterface.isPresent()) {
 328             return true;
 329         }
 330         return false;
 331     }
 332
 333     static String getIpPrefix(String prefix) {
 334         String prefixValues[] = prefix.split("/");
 335         if (prefixValues.length == 1) {
 336             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH ;
 337         }
 338         return prefix;
 339     }
 340
 341     static final FutureCallback<Void> DEFAULT_CALLBACK =
 342             new FutureCallback<Void>() {
 343                 public void onSuccess(Void result) {
 344                     LOG.debug("Success in Datastore operation");
 345                 }
 346
 347                 public void onFailure(Throwable error) {
 348                     LOG.error("Error in Datastore operation", error);
 349                 };
 350             };
 351
 352     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 353                                                     InstanceIdentifier<T> path) {
 354
 355         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 356
 357         Optional<T> result = Optional.absent();
 358         try {
 359             result = tx.read(datastoreType, path).get();
 360         } catch (Exception e) {
 361             throw new RuntimeException(e);
 362         } finally {
 363             tx.close();
 364         }
 365
 366         return result;
 367     }
 368
 369     static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 370                                                       InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 371         WriteTransaction tx = broker.newWriteOnlyTransaction();
 372         tx.merge(datastoreType, path, data, true);
 373         Futures.addCallback(tx.submit(), callback);
 374     }
 375
 376     static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 377                                                    InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 378         WriteTransaction tx = broker.newWriteOnlyTransaction();
 379         tx.put(datastoreType, path, data, true);
 380         Futures.addCallback(tx.submit(), callback);
 381     }
 382
 383     static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 384                                                InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 385         WriteTransaction tx = broker.newWriteOnlyTransaction();
 386         tx.delete(datastoreType, path);
 387         Futures.addCallback(tx.submit(), callback);
 388     }
 389
 390     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 391                     InstanceIdentifier<T> path, T data) {
 392         WriteTransaction tx = broker.newWriteOnlyTransaction();
 393         tx.put(datastoreType, path, data, true);
 394         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 395         try {
 396             futures.get();
 397         } catch (InterruptedException | ExecutionException e) {
 398             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 399             throw new RuntimeException(e.getMessage());
 400         }
 401     }
 402
 403     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 404                     InstanceIdentifier<T> path, T data) {
 405         WriteTransaction tx = broker.newWriteOnlyTransaction();
 406         tx.merge(datastoreType, path, data, true);
 407         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 408         try {
 409             futures.get();
 410         } catch (InterruptedException | ExecutionException e) {
 411             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 412             throw new RuntimeException(e.getMessage());
 413         }
 414     }
 415
 416     public static long getRemoteBCGroup(long elanTag) {
 417         return VpnConstants.ELAN_GID_MIN + ((elanTag % VpnConstants.ELAN_GID_MIN) *2);
 418     }
 419
 420     // interface-index-tag operational container
 421     public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
 422         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 423         Optional<IfIndexInterface> existingInterfaceInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 424         if(existingInterfaceInfo.isPresent()) {
 425             return existingInterfaceInfo.get();
 426         }
 427         return null;
 428     }
 429
 430     private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 431         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 432                 new IfIndexInterfaceKey((int) interfaceTag)).build();
 433     }
 434
 435     public static String getNeutronPortNamefromPortFixedIp(DataBroker broker, String fixedIp) {
 436         InstanceIdentifier id = buildFixedIpToPortNameIdentifier(fixedIp);
 437         Optional<PortFixedipToPortName> portFixedipToPortNameData = read(broker, LogicalDatastoreType.CONFIGURATION,
 438                 id);
 439         if (portFixedipToPortNameData.isPresent()) {
 440             return portFixedipToPortNameData.get().getPortName();
 441         }
 442         return null;
 443     }
 444
 445     private static InstanceIdentifier<PortFixedipToPortName> buildFixedIpToPortNameIdentifier(String fixedIp) {
 446         InstanceIdentifier<PortFixedipToPortName> id = InstanceIdentifier.builder(NeutronPortData.class).child
 447                 (PortFixedipToPortName.class, new PortFixedipToPortNameKey(fixedIp)).build();
 448         return id;
 449     }
 450
 451     public static ElanTagName getElanInfoByElanTag(DataBroker broker,long elanTag) {
 452         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 453         Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
 454         if(existingElanInfo.isPresent()) {
 455             return existingElanInfo.get();
 456         }
 457         return null;
 458     }
 459
 460     private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 461         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 462                 new ElanTagNameKey(elanTag)).build();
 463     }
 464
 465
 466     public static boolean isIpInSubnet(int ipAddress, String subnetCidr) {
 467         String[] subSplit = subnetCidr.split("/");
 468         if (subSplit.length < 2) {
 469             return false;
 470         }
 471
 472         String subnetStr = subSplit[0];
 473         int subnet = 0;
 474         try {
 475             InetAddress subnetAddress = InetAddress.getByName(subnetStr);
 476             subnet = Ints.fromByteArray(subnetAddress.getAddress());
 477         } catch (Exception ex) {
 478             LOG.error("Passed in Subnet IP string not convertible to InetAdddress " + subnetStr);
 479             return false;
 480         }
 481         int prefixLength = Integer.valueOf(subSplit[1]);
 482         int mask = -1 << (32 - prefixLength);
 483         if ((subnet & mask) == (ipAddress & mask)) {
 484             return true;
 485         }
 486         return false;
 487     }
 488
 489     public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId) {
 490         try {
 491             // Clean up PrefixToInterface Operational DS
 492             delete(broker, LogicalDatastoreType.OPERATIONAL,
 493                     InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build(),
 494                     DEFAULT_CALLBACK);
 495         } catch (Exception e) {
 496             LOG.error("Exception during cleanup of PrefixToInterface for VPN ID {}", vpnId, e);
 497         }
 498     }
 499
 500     public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName) {
 501         try {
 502             // Clean up VPNExtraRoutes Operational DS
 503             delete(broker, LogicalDatastoreType.OPERATIONAL,
 504                     InstanceIdentifier.builder(VpnToExtraroute.class).child(Vpn.class, new VpnKey(vpnName)).build(),
 505                     DEFAULT_CALLBACK);
 506         } catch (Exception e) {
 507             LOG.error("Exception during cleanup of VPNToExtraRoute for VPN {}", vpnName, e);
 508         }
 509     }
 510
 511     public static void removeVpnOpInstance(DataBroker broker, String vpnName) {
 512         try {
 513             // Clean up VPNInstanceOpDataEntry
 514             delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
 515                     DEFAULT_CALLBACK);
 516         } catch (Exception e) {
 517             LOG.error("Exception during cleanup of VPNInstanceOpDataEntry for VPN {}", vpnName, e);
 518         }
 519     }
 520
 521     public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName) {
 522         try {
 523             delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnInstanceToVpnIdIdentifier(vpnName),
 524                     DEFAULT_CALLBACK);
 525         } catch (Exception e) {
 526             LOG.error("Exception during clean up of VpnInstanceToVpnId for VPN {}", vpnName, e);
 527         }
 528     }
 529
 530     public static void removeVrfTableForVpn(DataBroker broker, String vpnName) {
 531         // Clean up FIB Entries Config DS
 532         try {
 533             delete(broker, LogicalDatastoreType.CONFIGURATION,
 534                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(vpnName)).build(),
 535                     DEFAULT_CALLBACK);
 536         } catch (Exception e) {
 537             LOG.error("Exception during clean up of VrfTable from FIB for VPN {}", vpnName, e);
 538         }
 539     }
 540
 541     public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId) {
 542         try {
 543             // Clean up L3NextHop Operational DS
 544             delete(broker, LogicalDatastoreType.OPERATIONAL,
 545                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class, new VpnNexthopsKey(vpnId)).build(),
 546                     DEFAULT_CALLBACK);
 547         } catch (Exception e) {
 548             LOG.error("Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
 549         }
 550     }
 551 }