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

   1 /*
   2  * Copyright (c) 2015 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.vpnservice.itm.impl;
   9
  10 import java.math.BigInteger;
  11 import java.net.InetAddress;
  12 import java.util.ArrayList;
  13 import java.util.Arrays;
  14 import java.util.List;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.Future;
  17
  18 import org.apache.commons.lang3.StringUtils;
  19 import org.apache.commons.net.util.SubnetUtils;
  20 import org.apache.commons.net.util.SubnetUtils.SubnetInfo;
  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.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdManagerService;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.ReleaseIdInputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.*;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.DpnEndpoints;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.DpnEndpointsBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.DPNTEPsInfo;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.DPNTEPsInfoBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.DPNTEPsInfoKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.dpn.teps.info.TunnelEndPointsBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.dpn.teps.info.TunnelEndPointsKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.external.tunnel.list.ExternalTunnel;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.external.tunnel.list.ExternalTunnelBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.external.tunnel.list.ExternalTunnelKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.tunnel.list.InternalTunnel;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.tunnel.list.InternalTunnelBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.tunnel.list.InternalTunnelKey;
  49 import org.opendaylight.vpnservice.itm.globals.ITMConstants;
  50 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  56 //import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice._interface.service.rev150602._interface.service.info.ServiceInfo;
  57 import org.opendaylight.yangtools.yang.binding.DataObject;
  58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  61 import org.opendaylight.yangtools.yang.common.RpcResult;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 import com.google.common.base.Optional;
  66 import com.google.common.base.Preconditions;
  67 import com.google.common.net.InetAddresses;
  68 import com.google.common.util.concurrent.FutureCallback;
  69 import com.google.common.util.concurrent.Futures;
  70
  71 public class ItmUtils {
  72
  73     public static final String DUMMY_IP_ADDRESS = "0.0.0.0";
  74     public static final String TUNNEL_TYPE_VXLAN = "VXLAN";
  75     public static final String TUNNEL_TYPE_GRE = "GRE";
  76     public static final String TUNNEL = "TUNNEL";
  77
  78     private static final Logger LOG = LoggerFactory.getLogger(ItmUtils.class);
  79
  80     public static final FutureCallback<Void> DEFAULT_CALLBACK = new FutureCallback<Void>() {
  81         public void onSuccess(Void result) {
  82             LOG.debug("Success in Datastore write operation");
  83         }
  84
  85         public void onFailure(Throwable error) {
  86             LOG.error("Error in Datastore write operation", error);
  87         }
  88     };
  89
  90     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
  91                     InstanceIdentifier<T> path, DataBroker broker) {
  92
  93         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
  94
  95         Optional<T> result = Optional.absent();
  96         try {
  97             result = tx.read(datastoreType, path).get();
  98         } catch (Exception e) {
  99             throw new RuntimeException(e);
 100         }
 101
 102         return result;
 103     }
 104
 105     public static <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
 106                     InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
 107         WriteTransaction tx = broker.newWriteOnlyTransaction();
 108         tx.put(datastoreType, path, data, true);
 109         Futures.addCallback(tx.submit(), callback);
 110     }
 111
 112     public static <T extends DataObject> void asyncUpdate(LogicalDatastoreType datastoreType,
 113                     InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
 114         WriteTransaction tx = broker.newWriteOnlyTransaction();
 115         tx.merge(datastoreType, path, data, true);
 116         Futures.addCallback(tx.submit(), callback);
 117     }
 118
 119     public static <T extends DataObject> void asyncDelete(LogicalDatastoreType datastoreType,
 120                     InstanceIdentifier<T> path, DataBroker broker, FutureCallback<Void> callback) {
 121         WriteTransaction tx = broker.newWriteOnlyTransaction();
 122         tx.delete(datastoreType, path);
 123         Futures.addCallback(tx.submit(), callback);
 124     }
 125
 126     public static String getInterfaceName(final BigInteger datapathid, final String portName, final Integer vlanId) {
 127         return String.format("%s:%s:%s", datapathid, portName, vlanId);
 128     }
 129
 130     public static BigInteger getDpnIdFromInterfaceName(String interfaceName) {
 131         String[] dpnStr = interfaceName.split(":");
 132         BigInteger dpnId = new BigInteger(dpnStr[0]);
 133         return dpnId;
 134     }
 135
 136     public static String getTrunkInterfaceName(IdManagerService idManager, String parentInterfaceName, String localHostName, String remoteHostName) {
 137         String trunkInterfaceName = String.format("%s:%s:%s", parentInterfaceName, localHostName, remoteHostName);
 138         trunkInterfaceName = String.format("%s:%s", TUNNEL, getUniqueId(idManager, trunkInterfaceName));
 139         return trunkInterfaceName;
 140     }
 141
 142     public static InetAddress getInetAddressFromIpAddress(IpAddress ip) {
 143         return InetAddresses.forString(ip.getIpv4Address().getValue());
 144     }
 145
 146     public static InstanceIdentifier<DPNTEPsInfo> getDPNTEPInstance(BigInteger dpIdKey) {
 147         InstanceIdentifier.InstanceIdentifierBuilder<DPNTEPsInfo> dpnTepInfoBuilder =
 148                         InstanceIdentifier.builder(DpnEndpoints.class).child(DPNTEPsInfo.class, new DPNTEPsInfoKey(dpIdKey));
 149         InstanceIdentifier<DPNTEPsInfo> dpnInfo = dpnTepInfoBuilder.build();
 150         return dpnInfo;
 151     }
 152
 153     public static DPNTEPsInfo createDPNTepInfo(BigInteger dpId, List<TunnelEndPoints> endpoints) {
 154
 155         return new DPNTEPsInfoBuilder().setKey(new DPNTEPsInfoKey(dpId)).setTunnelEndPoints(endpoints).build();
 156     }
 157
 158     public static TunnelEndPoints createTunnelEndPoints(BigInteger dpnId, IpAddress ipAddress, String portName, int vlanId,
 159                     IpPrefix prefix, IpAddress gwAddress, String zoneName, Class<? extends TunnelTypeBase>  tunnel_type) {
 160         // when Interface Mgr provides support to take in Dpn Id
 161         return new TunnelEndPointsBuilder().setKey(new TunnelEndPointsKey(ipAddress, portName, vlanId))
 162                         .setSubnetMask(prefix).setGwIpAddress(gwAddress).setTransportZone(zoneName)
 163                         .setInterfaceName(ItmUtils.getInterfaceName(dpnId, portName, vlanId)).setTunnelType(tunnel_type).build();
 164     }
 165
 166     public static DpnEndpoints createDpnEndpoints(List<DPNTEPsInfo> dpnTepInfo) {
 167         return new DpnEndpointsBuilder().setDPNTEPsInfo(dpnTepInfo).build();
 168     }
 169
 170     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 171         InstanceIdentifierBuilder<Interface> idBuilder =
 172                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 173         InstanceIdentifier<Interface> id = idBuilder.build();
 174         return id;
 175     }
 176
 177     public static Interface buildTunnelInterface(BigInteger dpn, String ifName, String desc, boolean enabled, Class<? extends TunnelTypeBase> tunType,
 178        IpAddress localIp, IpAddress remoteIp, IpAddress gatewayIp, boolean internal) {
 179        InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(ifName)).setName(ifName)
 180        .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 181        ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 182        builder.addAugmentation(ParentRefs.class, parentRefs);
 183        IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(remoteIp).setTunnelGateway(gatewayIp).setTunnelSource(localIp)
 184        .setTunnelInterfaceType( tunType).setInternal(internal).build();
 185        builder.addAugmentation(IfTunnel.class, tunnel);
 186        return builder.build();
 187     }
 188
 189     public static InternalTunnel buildInternalTunnel( BigInteger srcDpnId, BigInteger dstDpnId, String trunkInterfaceName) {
 190         InternalTunnel tnl = new InternalTunnelBuilder().setKey(new InternalTunnelKey(srcDpnId, dstDpnId))
 191             .setDestinationDPN(dstDpnId)
 192             .setSourceDPN(srcDpnId)
 193             .setTunnelInterfaceName(trunkInterfaceName).build();
 194         return tnl ;
 195     }
 196
 197     public static ExternalTunnel buildExternalTunnel( BigInteger srcDpnId, IpAddress dstIp, String trunkInterfaceName) {
 198         ExternalTunnel extTnl = new ExternalTunnelBuilder().setKey(new ExternalTunnelKey(dstIp, srcDpnId)).setSourceDPN(srcDpnId).setDestinationIP(dstIp).setTunnelInterfaceName(trunkInterfaceName).build();
 199         return extTnl ;
 200     }
 201
 202     public static List<DPNTEPsInfo> getTunnelMeshInfo(DataBroker dataBroker) {
 203         List<DPNTEPsInfo> dpnTEPs= null ;
 204
 205         // Read the EndPoint Info from the operational database
 206         InstanceIdentifierBuilder<DpnEndpoints> depBuilder = InstanceIdentifier.builder( DpnEndpoints.class) ;
 207         InstanceIdentifier<DpnEndpoints> deps = depBuilder.build() ;
 208         Optional<DpnEndpoints> dpnEps = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, deps, dataBroker);
 209         if( dpnEps.isPresent()) {
 210            DpnEndpoints tn= dpnEps.get() ;
 211            dpnTEPs = tn.getDPNTEPsInfo() ;
 212            LOG.debug( "Read from CONFIGURATION datastore - No. of Dpns " , dpnTEPs.size() );
 213         }else
 214             LOG.debug( "No Dpn information in CONFIGURATION datastore "  );
 215          return dpnTEPs ;
 216     }
 217
 218     public static int getUniqueId(IdManagerService idManager, String idKey) {
 219         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 220             .setPoolName(ITMConstants.ITM_IDPOOL_NAME)
 221             .setIdKey(idKey).build();
 222
 223         try {
 224             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 225             RpcResult<AllocateIdOutput> rpcResult = result.get();
 226             if(rpcResult.isSuccessful()) {
 227                 return rpcResult.getResult().getIdValue().intValue();
 228             } else {
 229                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 230             }
 231         } catch (InterruptedException | ExecutionException e) {
 232             LOG.warn("Exception when getting Unique Id",e);
 233         }
 234         return 0;
 235     }
 236
 237     public static void releaseId(IdManagerService idManager, String idKey) {
 238         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(ITMConstants.ITM_IDPOOL_NAME).setIdKey(idKey).build();
 239         try {
 240             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 241             RpcResult<Void> rpcResult = result.get();
 242             if(!rpcResult.isSuccessful()) {
 243                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 244             }
 245         } catch (InterruptedException | ExecutionException e) {
 246             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 247         }
 248     }
 249
 250     public static List<DPNTEPsInfo> getDPNTEPListFromDPNId(DataBroker dataBroker, List<BigInteger> dpnIds) {
 251         List<DPNTEPsInfo> meshedDpnList = getTunnelMeshInfo(dataBroker) ;
 252         List<DPNTEPsInfo> cfgDpnList = new ArrayList<DPNTEPsInfo>();
 253         if( null != meshedDpnList) {
 254            for(BigInteger dpnId : dpnIds) {
 255               for( DPNTEPsInfo teps : meshedDpnList ) {
 256                  if( dpnId.equals(teps.getDPNID()))
 257                  cfgDpnList.add( teps) ;
 258               }
 259             }
 260         }
 261         return cfgDpnList;
 262     }
 263 }