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