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
  16 import org.apache.commons.lang3.StringUtils;
  17 import org.apache.commons.net.util.SubnetUtils;
  18 import org.apache.commons.net.util.SubnetUtils.SubnetInfo;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.*;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.DpnEndpoints;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.DpnEndpointsBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.DPNTEPsInfo;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.DPNTEPsInfoBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.DPNTEPsInfoKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.dpn.teps.info.TunnelEndPointsBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.dpn.endpoints.dpn.teps.info.TunnelEndPointsKey;
  35 import org.opendaylight.vpnservice.itm.globals.ITMConstants;
  36 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  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.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  42 //import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice._interface.service.rev150602._interface.service.info.ServiceInfo;
  43 import org.opendaylight.yangtools.yang.binding.DataObject;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 import com.google.common.base.Optional;
  51 import com.google.common.base.Preconditions;
  52 import com.google.common.net.InetAddresses;
  53 import com.google.common.util.concurrent.FutureCallback;
  54 import com.google.common.util.concurrent.Futures;
  55
  56 public class ItmUtils {
  57
  58     public static final String DUMMY_IP_ADDRESS = "0.0.0.0";
  59     public static final String TUNNEL_TYPE_VXLAN = "VXLAN";
  60     public static final String TUNNEL_TYPE_GRE = "GRE";
  61
  62     private static final Logger LOG = LoggerFactory.getLogger(ItmUtils.class);
  63
  64     public static final FutureCallback<Void> DEFAULT_CALLBACK = new FutureCallback<Void>() {
  65         public void onSuccess(Void result) {
  66             LOG.debug("Success in Datastore write operation");
  67         }
  68
  69         public void onFailure(Throwable error) {
  70             LOG.error("Error in Datastore write operation", error);
  71         }
  72     };
  73
  74     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
  75                     InstanceIdentifier<T> path, DataBroker broker) {
  76
  77         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
  78
  79         Optional<T> result = Optional.absent();
  80         try {
  81             result = tx.read(datastoreType, path).get();
  82         } catch (Exception e) {
  83             throw new RuntimeException(e);
  84         }
  85
  86         return result;
  87     }
  88
  89     public static <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
  90                     InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
  91         WriteTransaction tx = broker.newWriteOnlyTransaction();
  92         tx.put(datastoreType, path, data, true);
  93         Futures.addCallback(tx.submit(), callback);
  94     }
  95
  96     public static <T extends DataObject> void asyncUpdate(LogicalDatastoreType datastoreType,
  97                     InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
  98         WriteTransaction tx = broker.newWriteOnlyTransaction();
  99         tx.merge(datastoreType, path, data, true);
 100         Futures.addCallback(tx.submit(), callback);
 101     }
 102
 103     public static <T extends DataObject> void asyncDelete(LogicalDatastoreType datastoreType,
 104                     InstanceIdentifier<T> path, DataBroker broker, FutureCallback<Void> callback) {
 105         WriteTransaction tx = broker.newWriteOnlyTransaction();
 106         tx.delete(datastoreType, path);
 107         Futures.addCallback(tx.submit(), callback);
 108     }
 109
 110     public static String getInterfaceName(final BigInteger datapathid, final String portName, final Integer vlanId) {
 111         return String.format("%s:%s:%s", datapathid, portName, vlanId);
 112     }
 113
 114     public static BigInteger getDpnIdFromInterfaceName(String interfaceName) {
 115         String[] dpnStr = interfaceName.split(":");
 116         BigInteger dpnId = new BigInteger(dpnStr[0]);
 117         return dpnId;
 118     }
 119
 120     public static String getTrunkInterfaceName(String parentInterfaceName, String localHostName, String remoteHostName) {
 121         String trunkInterfaceName = String.format("%s:%s:%s", parentInterfaceName, localHostName, remoteHostName);
 122         return trunkInterfaceName;
 123     }
 124
 125     public static InetAddress getInetAddressFromIpAddress(IpAddress ip) {
 126         return InetAddresses.forString(ip.getIpv4Address().getValue());
 127     }
 128
 129     public static InstanceIdentifier<DPNTEPsInfo> getDPNTEPInstance(BigInteger dpIdKey) {
 130         InstanceIdentifier.InstanceIdentifierBuilder<DPNTEPsInfo> dpnTepInfoBuilder =
 131                         InstanceIdentifier.builder(DpnEndpoints.class).child(DPNTEPsInfo.class, new DPNTEPsInfoKey(dpIdKey));
 132         InstanceIdentifier<DPNTEPsInfo> dpnInfo = dpnTepInfoBuilder.build();
 133         return dpnInfo;
 134     }
 135
 136     public static DPNTEPsInfo createDPNTepInfo(BigInteger dpId, List<TunnelEndPoints> endpoints) {
 137
 138         return new DPNTEPsInfoBuilder().setKey(new DPNTEPsInfoKey(dpId)).setTunnelEndPoints(endpoints).build();
 139     }
 140
 141     public static TunnelEndPoints createTunnelEndPoints(BigInteger dpnId, IpAddress ipAddress, String portName, int vlanId,
 142                     IpPrefix prefix, IpAddress gwAddress, String zoneName, Class<? extends TunnelTypeBase>  tunnel_type) {
 143         // when Interface Mgr provides support to take in Dpn Id
 144         return new TunnelEndPointsBuilder().setKey(new TunnelEndPointsKey(ipAddress, portName, vlanId))
 145                         .setSubnetMask(prefix).setGwIpAddress(gwAddress).setTransportZone(zoneName)
 146                         .setInterfaceName(ItmUtils.getInterfaceName(dpnId, portName, vlanId)).setTunnelType(tunnel_type).build();
 147     }
 148
 149     public static DpnEndpoints createDpnEndpoints(List<DPNTEPsInfo> dpnTepInfo) {
 150         return new DpnEndpointsBuilder().setDPNTEPsInfo(dpnTepInfo).build();
 151     }
 152
 153     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 154         InstanceIdentifierBuilder<Interface> idBuilder =
 155                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 156         InstanceIdentifier<Interface> id = idBuilder.build();
 157         return id;
 158     }
 159
 160     public static Interface buildTunnelInterface(BigInteger dpn, String ifName, String desc, boolean enabled, Class<? extends TunnelTypeBase> tunType,
 161        IpAddress localIp, IpAddress remoteIp, IpAddress gatewayIp) {
 162        InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(ifName)).setName(ifName)
 163        .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 164        ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 165        builder.addAugmentation(ParentRefs.class, parentRefs);
 166        IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(remoteIp).setTunnelGateway(gatewayIp).setTunnelSource(localIp)
 167        .setTunnelInterfaceType( tunType).build();
 168        builder.addAugmentation(IfTunnel.class, tunnel);
 169        return builder.build();
 170     }
 171
 172     public static List<DPNTEPsInfo> getTunnelMeshInfo(DataBroker dataBroker) {
 173         List<DPNTEPsInfo> dpnTEPs= null ;
 174
 175         // Read the EndPoint Info from the operational database
 176         InstanceIdentifierBuilder<DpnEndpoints> depBuilder = InstanceIdentifier.builder( DpnEndpoints.class) ;
 177         InstanceIdentifier<DpnEndpoints> deps = depBuilder.build() ;
 178         Optional<DpnEndpoints> dpnEps = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, deps, dataBroker);
 179         if( dpnEps.isPresent()) {
 180            DpnEndpoints tn= dpnEps.get() ;
 181            dpnTEPs = tn.getDPNTEPsInfo() ;
 182            LOG.debug( "Read from CONFIGURATION datastore - No. of Dpns " , dpnTEPs.size() );
 183         }else
 184             LOG.debug( "No Dpn information in CONFIGURATION datastore "  );
 185          return dpnTEPs ;
 186     }
 187 }