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.util.concurrent.ExecutionException;
  13 import java.util.concurrent.Future;
  14 import java.util.List;
  15
  16 import com.google.common.base.Optional;
  17 import com.google.common.util.concurrent.CheckedFuture;
  18 import com.google.common.util.concurrent.FutureCallback;
  19 import com.google.common.util.concurrent.Futures;
  20
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  26 import org.opendaylight.vpnservice.mdsalutil.NwConstants;
  27 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  28 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  29 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  30 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  31 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  32 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  33 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.PrefixToInterface;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.VpnInstanceOpData;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.VpnInstanceToVpnId;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.adjacency.list.Adjacency;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.Adjacencies;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.AdjacenciesBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIds;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
  62 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  63 import org.opendaylight.yangtools.yang.common.RpcResult;
  64 import org.opendaylight.yangtools.yang.binding.DataObject;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 public class VpnUtil {
  69     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
  70     private static final int DEFAULT_PREFIX_LENGTH = 32;
  71     private static final String PREFIX_SEPARATOR = "/";
  72
  73     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
  74         return InstanceIdentifier.builder(VpnInterfaces.class)
  75                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
  76     }
  77
  78     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
  79         return InstanceIdentifier.builder(VpnInstances.class)
  80                 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
  81     }
  82
  83     static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug) {
  84         return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(
  85             vpnName)
  86                 .addAugmentation(Adjacencies.class, aug).build();
  87     }
  88
  89     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
  90         return InstanceIdentifier.builder(PrefixToInterface.class)
  91             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
  92                                                              new PrefixesKey(ipPrefix)).build();
  93     }
  94
  95     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix) {
  96         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
  97             vpnInterfaceName).setIpAddress(ipPrefix).build();
  98     }
  99
 100     static Adjacencies
 101     getVpnInterfaceAugmentation(List<Adjacency> nextHops) {
 102         return new AdjacenciesBuilder().setAdjacency(nextHops).build();
 103     }
 104
 105     public static InstanceIdentifier<IdPool> getPoolId(String poolName){
 106         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 107                         InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 108         InstanceIdentifier<IdPool> id = idBuilder.build();
 109         return id;
 110     }
 111
 112     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
 113         return InstanceIdentifier.builder(VpnInterfaces.class).build();
 114     }
 115
 116     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 117         return InstanceIdentifier.builder(Interfaces.class)
 118                 .child(Interface.class, new InterfaceKey(interfaceName)).build();
 119     }
 120
 121     static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
 122         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 123             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
 124             .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
 125     }
 126
 127     public static BigInteger getCookieArpFlow(int interfaceTag) {
 128         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
 129             BigInteger.valueOf(interfaceTag));
 130     }
 131
 132     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lPortTag, int arpType) {
 133             return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 134                     .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lPortTag)
 135                     .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
 136     }
 137
 138     public static int getUniqueId(IdManagerService idManager, String poolName,String idKey) {
 139         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 140                                            .setPoolName(poolName)
 141                                            .setIdKey(idKey).build();
 142
 143         try {
 144             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 145             RpcResult<AllocateIdOutput> rpcResult = result.get();
 146             if(rpcResult.isSuccessful()) {
 147                 return rpcResult.getResult().getIdValue().intValue();
 148             } else {
 149                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 150             }
 151         } catch (InterruptedException | ExecutionException e) {
 152             LOG.warn("Exception when getting Unique Id",e);
 153         }
 154         return 0;
 155     }
 156
 157     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 158         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 159         try {
 160             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 161             RpcResult<Void> rpcResult = result.get();
 162             if(!rpcResult.isSuccessful()) {
 163                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 164             }
 165         } catch (InterruptedException | ExecutionException e) {
 166             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 167         }
 168     }
 169
 170     public static String getNextHopLabelKey(String rd, String prefix){
 171         String key = rd + VpnConstants.SEPARATOR + prefix;
 172         return key;
 173     }
 174
 175     public static long getVpnId(DataBroker broker, String vpnName) {
 176
 177         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
 178             = getVpnInstanceToVpnIdIdentifier(vpnName);
 179         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
 180             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 181
 182         long vpnId = VpnConstants.INVALID_ID;
 183         if(vpnInstance.isPresent()) {
 184             vpnId = vpnInstance.get().getVpnId();
 185         }
 186         return vpnId;
 187     }
 188
 189     public static String getVpnRd(DataBroker broker, String vpnName) {
 190
 191         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> id
 192                 = getVpnInstanceToVpnIdIdentifier(vpnName);
 193         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance> vpnInstance
 194                 = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 195
 196         String rd = null;
 197         if(vpnInstance.isPresent()) {
 198             rd = vpnInstance.get().getVrfId();
 199         }
 200         return rd;
 201     }
 202
 203     static org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 204            getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 205         return new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder()
 206             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 207
 208     }
 209
 210     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance>
 211            getVpnInstanceToVpnIdIdentifier(String vpnName) {
 212         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
 213             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance.class,
 214                    new org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
 215     }
 216
 217     static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 218         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 219             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 220     }
 221
 222     static VpnInstanceOpDataEntry getVpnInstanceOpData(String rd, long vpnId) {
 223         return new VpnInstanceOpDataEntryBuilder().setVrfId(rd).setVpnId(vpnId).build();
 224     }
 225
 226     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
 227         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 228         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 229
 230         if (configuredVpnInterface.isPresent()) {
 231             return configuredVpnInterface.get();
 232         }
 233         return null;
 234     }
 235
 236     static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
 237         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 238         Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 239
 240         if (operationalVpnInterface.isPresent()) {
 241             return operationalVpnInterface.get();
 242         }
 243         return null;
 244     }
 245
 246     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName)
 247     {
 248         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 249         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 250
 251         if (configuredVpnInterface.isPresent()) {
 252             return true;
 253         }
 254         return false;
 255     }
 256
 257     static String getIpPrefix(String prefix) {
 258         String prefixValues[] = prefix.split("/");
 259         if (prefixValues.length == 1) {
 260             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH ;
 261         }
 262         return prefix;
 263     }
 264
 265     static final FutureCallback<Void> DEFAULT_CALLBACK =
 266             new FutureCallback<Void>() {
 267                 public void onSuccess(Void result) {
 268                     LOG.debug("Success in Datastore operation");
 269                 }
 270
 271                 public void onFailure(Throwable error) {
 272                     LOG.error("Error in Datastore operation", error);
 273                 };
 274             };
 275
 276     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 277                                                     InstanceIdentifier<T> path) {
 278
 279         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 280
 281         Optional<T> result = Optional.absent();
 282         try {
 283             result = tx.read(datastoreType, path).get();
 284         } catch (Exception e) {
 285             throw new RuntimeException(e);
 286         }
 287
 288         return result;
 289     }
 290
 291     static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 292                                                       InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 293         WriteTransaction tx = broker.newWriteOnlyTransaction();
 294         tx.merge(datastoreType, path, data, true);
 295         Futures.addCallback(tx.submit(), callback);
 296     }
 297
 298     static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 299                                                    InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 300         WriteTransaction tx = broker.newWriteOnlyTransaction();
 301         tx.put(datastoreType, path, data, true);
 302         Futures.addCallback(tx.submit(), callback);
 303     }
 304
 305     static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 306                                                InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 307         WriteTransaction tx = broker.newWriteOnlyTransaction();
 308         tx.delete(datastoreType, path);
 309         Futures.addCallback(tx.submit(), callback);
 310     }
 311
 312     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 313                     InstanceIdentifier<T> path, T data) {
 314         WriteTransaction tx = broker.newWriteOnlyTransaction();
 315         tx.put(datastoreType, path, data, true);
 316         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 317         try {
 318             futures.get();
 319         } catch (InterruptedException | ExecutionException e) {
 320             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 321             throw new RuntimeException(e.getMessage());
 322         }
 323     }
 324
 325     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 326                     InstanceIdentifier<T> path, T data) {
 327         WriteTransaction tx = broker.newWriteOnlyTransaction();
 328         tx.merge(datastoreType, path, data, true);
 329         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 330         try {
 331             futures.get();
 332         } catch (InterruptedException | ExecutionException e) {
 333             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 334             throw new RuntimeException(e.getMessage());
 335         }
 336     }
 337
 338 }