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