interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/IfmUtil.java

   1 /*
   2  * Copyright (c) 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 package org.opendaylight.genius.interfacemanager;
   9
  10 import com.google.common.base.Optional;
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  15 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  16 import org.opendaylight.genius.interfacemanager.globals.VlanInterfaceInfo;
  17 import org.opendaylight.genius.interfacemanager.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
  18 import org.opendaylight.genius.mdsalutil.ActionInfo;
  19 import org.opendaylight.genius.mdsalutil.ActionType;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  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.opendaylight.action.types.rev131112.action.list.Action;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.*;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.*;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan.L2vlanMode;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  47 import org.opendaylight.yangtools.yang.binding.DataObject;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  50 import org.opendaylight.yangtools.yang.common.RpcResult;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 import java.math.BigInteger;
  55 import java.util.ArrayList;
  56 import java.util.List;
  57 import java.util.concurrent.ExecutionException;
  58 import java.util.concurrent.Future;
  59
  60 public class IfmUtil {
  61     private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
  62     private static final int INVALID_ID = 0;
  63
  64
  65
  66     public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
  67         /*
  68          * NodeConnectorId is of form 'openflow:dpnid:portnum'
  69          */
  70         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
  71         return split[1];
  72     }
  73
  74     public static BigInteger getDpnFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
  75         NodeConnectorId ncId = getNodeConnectorIdFromInterface(ifState);
  76         if(ncId != null){
  77             return new BigInteger(getDpnFromNodeConnectorId(ncId));
  78         }
  79         return null;
  80     }
  81     public static String getPortNoFromInterfaceName(String ifaceName, DataBroker broker) {
  82         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
  83                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(ifaceName, broker);
  84
  85         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
  86         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
  87         String portNo = IfmUtil.getPortNoFromNodeConnectorId(nodeConnectorId);
  88
  89         return portNo;
  90     }
  91
  92     public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
  93         /*
  94          * NodeConnectorId is of form 'openflow:dpnid:portnum'
  95          */
  96         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
  97         return split[2];
  98     }
  99
 100     public static NodeId buildDpnNodeId(BigInteger dpnId) {
 101         return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
 102     }
 103
 104     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 105         //TODO Make this generic and move to AbstractDataChangeListener or Utils.
 106         InstanceIdentifierBuilder<Interface> idBuilder =
 107                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 108         InstanceIdentifier<Interface> id = idBuilder.build();
 109         return id;
 110     }
 111
 112     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
 113         InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
 114                 InstanceIdentifier.builder(InterfacesState.class)
 115                 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
 116                         new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
 117         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
 118         return id;
 119     }
 120
 121     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
 122                     String name) {
 123         return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
 124     }
 125
 126     public static InstanceIdentifier<IdPool> getPoolId(String poolName){
 127         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 128                         InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 129         InstanceIdentifier<IdPool> id = idBuilder.build();
 130         return id;
 131     }
 132
 133     public static List<String> getPortNameAndSuffixFromInterfaceName(String intfName) {
 134         List<String> strList = new ArrayList<>(2);
 135         int index = intfName.indexOf(":");
 136         if (index != -1) {
 137             strList.add(0, intfName.substring(0, index));
 138             strList.add(1, intfName.substring(index));
 139         }
 140         return strList;
 141     }
 142
 143     public static long getGroupId(long ifIndex, InterfaceInfo.InterfaceType infType) {
 144         if (infType == InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE) {
 145             return ifIndex + IfmConstants.LOGICAL_GROUP_START;
 146         }
 147         else if (infType == InterfaceInfo.InterfaceType.VLAN_INTERFACE) {
 148             return ifIndex + IfmConstants.VLAN_GROUP_START;
 149         } else {
 150             return ifIndex + IfmConstants.TRUNK_GROUP_START;
 151         }
 152     }
 153
 154     public static List<String> getDpIdPortNameAndSuffixFromInterfaceName(String intfName) {
 155         List<String> strList = new ArrayList<>(3);
 156         int index1 = intfName.indexOf(":");
 157         if (index1 != -1) {
 158             int index2 = intfName.indexOf(":", index1 + 1 );
 159             strList.add(0, intfName.substring(0, index1));
 160             if (index2 != -1) {
 161                 strList.add(1, intfName.substring(index1, index2));
 162                 strList.add(2, intfName.substring(index2));
 163             } else {
 164                 strList.add(1, intfName.substring(index1));
 165                 strList.add(2, "");
 166             }
 167         }
 168         return strList;
 169     }
 170
 171     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 172                                                           InstanceIdentifier<T> path, DataBroker broker) {
 173
 174         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 175
 176         Optional<T> result = Optional.absent();
 177         try {
 178             result = tx.read(datastoreType, path).get();
 179         } catch (Exception e) {
 180             throw new RuntimeException(e);
 181         }
 182
 183         return result;
 184     }
 185
 186     public static List<Action> getEgressActionsForInterface(String interfaceName, Long tunnelKey, DataBroker dataBroker) {
 187         List<ActionInfo> listActionInfo = getEgressActionInfosForInterface(interfaceName, tunnelKey, 0, dataBroker);
 188         List<Action> actionsList = new ArrayList<>();
 189         for (ActionInfo actionInfo : listActionInfo) {
 190             actionsList.add(actionInfo.buildAction());
 191         }
 192         return actionsList;
 193     }
 194
 195     public static List<ActionInfo> getEgressActionInfosForInterface(String interfaceName,
 196                                                                     int        actionKeyStart,
 197                                                                     DataBroker dataBroker) {
 198         return getEgressActionInfosForInterface(interfaceName, null, actionKeyStart, dataBroker);
 199     }
 200
 201     /**
 202      * Returns a list of Actions to be taken when sending a packet over an interface
 203      *
 204      * @param interfaceName
 205      * @param tunnelKey Optional.
 206      * @param actionKeyStart
 207      * @param dataBroker
 208      * @return
 209      */
 210     public static List<ActionInfo> getEgressActionInfosForInterface(String interfaceName,
 211                                                                     Long tunnelKey,
 212                                                                     int        actionKeyStart,
 213                                                                     DataBroker dataBroker) {
 214         List<ActionInfo> result = new ArrayList<ActionInfo>();
 215         Interface interfaceInfo = InterfaceManagerCommonUtils.getInterfaceFromConfigDS(new InterfaceKey(interfaceName),
 216                 dataBroker);
 217         String portNo = IfmUtil.getPortNoFromInterfaceName(interfaceName, dataBroker);
 218
 219         InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
 220
 221         switch (ifaceType ) {
 222             case VLAN_INTERFACE:
 223                 IfL2vlan vlanIface = interfaceInfo.getAugmentation(IfL2vlan.class);
 224                 LOG.trace("L2Vlan: {}",vlanIface);
 225                 boolean isVlanTransparent = false;
 226                 long vlanVid = 0;
 227                 if (vlanIface != null) {
 228                     vlanVid = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue();
 229                     isVlanTransparent = vlanIface.getL2vlanMode() == IfL2vlan.L2vlanMode.Transparent;
 230                 }
 231                 if (vlanVid != 0 && !isVlanTransparent) {
 232                     result.add(new ActionInfo(ActionType.push_vlan, new String[] {}, actionKeyStart));
 233                     actionKeyStart++;
 234                     result.add(new ActionInfo(ActionType.set_field_vlan_vid,
 235                                new String[] { Long.toString(vlanVid) }, actionKeyStart));
 236                     actionKeyStart++;
 237                 }
 238                 result.add(new ActionInfo(ActionType.output, new String[] {portNo}, actionKeyStart));
 239                 actionKeyStart++;
 240                 break;
 241             case MPLS_OVER_GRE:
 242             case VXLAN_TRUNK_INTERFACE:
 243             case GRE_TRUNK_INTERFACE:
 244                 if(tunnelKey != null) {
 245                     result.add(new ActionInfo(ActionType.set_field_tunnel_id,
 246                                                   new BigInteger[] { BigInteger.valueOf(tunnelKey.longValue()) },
 247                                                   actionKeyStart) );
 248                     actionKeyStart++;
 249                 }
 250
 251                 result.add(new ActionInfo(ActionType.output, new String[] { portNo}, actionKeyStart));
 252                 actionKeyStart++;
 253                 break;
 254
 255             default:
 256                 LOG.warn("Interface Type {} not handled yet", ifaceType);
 257                 break;
 258         }
 259
 260         return result;
 261     }
 262
 263
 264     public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
 265         return new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
 266     }
 267
 268     public static BigInteger[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
 269         BigInteger metadata = new BigInteger("0", 16);
 270         BigInteger metadataMask = new BigInteger("0", 16);
 271         if (instructions != null && !instructions.isEmpty()) {
 272             // check if metadata write instruction is present
 273             for (Instruction instruction : instructions) {
 274                 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction actualInstruction = instruction.getInstruction();
 275                 if (actualInstruction instanceof WriteMetadataCase) {
 276                     WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction ;
 277                     WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
 278                     metadata = metadata.or(availableMetaData.getMetadata());
 279                     metadataMask = metadataMask.or(availableMetaData.getMetadataMask());
 280                 }
 281             }
 282         }
 283         return new BigInteger[] { metadata, metadataMask };
 284     }
 285
 286     public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
 287         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 288                 .setPoolName(poolName)
 289                 .setIdKey(idKey).build();
 290         try {
 291             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 292             RpcResult<AllocateIdOutput> rpcResult = result.get();
 293             if(rpcResult.isSuccessful()) {
 294                 return rpcResult.getResult().getIdValue().intValue();
 295             } else {
 296                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 297             }
 298         } catch (InterruptedException | ExecutionException e) {
 299             LOG.warn("Exception when getting Unique Id",e);
 300         }
 301         return INVALID_ID;
 302     }
 303
 304     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 305         ReleaseIdInput idInput = new ReleaseIdInputBuilder()
 306                 .setPoolName(poolName)
 307                 .setIdKey(idKey).build();
 308         try {
 309             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 310             RpcResult<Void> rpcResult = result.get();
 311             if(!rpcResult.isSuccessful()) {
 312                 LOG.warn("RPC Call to release Id {} with Key {} returned with Errors {}",
 313                         idKey, rpcResult.getErrors());
 314             }
 315         } catch (InterruptedException | ExecutionException e) {
 316             LOG.warn("Exception when releasing Id for key {}", idKey, e);
 317         }
 318     }
 319
 320     public static BigInteger getDpnId(DatapathId datapathId){
 321         if (datapathId != null) {
 322             // Adding logs for a random issue spotted during datapath id conversion
 323             LOG.info("Received datapathId {}",datapathId.getValue());
 324             String dpIdStr = datapathId.getValue().replace(":", "");
 325             LOG.info("Received datapathId {}",dpIdStr);
 326             BigInteger dpnId =  new BigInteger(dpIdStr, 16);
 327             LOG.info("After conversion datapathId {}",dpnId);
 328             return dpnId;
 329         }
 330         return null;
 331     }
 332
 333     public static NodeConnectorId getNodeConnectorIdFromInterface(Interface iface, DataBroker dataBroker) {
 334         return FlowBasedServicesUtils.getNodeConnectorIdFromInterface(iface, dataBroker);
 335     }
 336
 337     public static String getPortName(DataBroker dataBroker, NodeConnectorId ncId){
 338         InstanceIdentifier<NodeConnector> ncIdentifier =
 339                 InstanceIdentifier.builder(Nodes.class)
 340                         .child(Node.class, new NodeKey(getNodeIdFromNodeConnectorId(ncId)))
 341                         .child(NodeConnector.class, new NodeConnectorKey(ncId)).build();
 342         Optional<NodeConnector> optNc = read(LogicalDatastoreType.OPERATIONAL, ncIdentifier, dataBroker);
 343         if(optNc.isPresent()) {
 344             NodeConnector nc = optNc.get();
 345             FlowCapableNodeConnector fcnc = nc.getAugmentation(FlowCapableNodeConnector.class);
 346             return fcnc.getName();
 347         }
 348         return null;
 349     }
 350
 351     public static NodeConnectorId getNodeConnectorIdFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
 352         if(ifState != null) {
 353             List<String> ofportIds = ifState.getLowerLayerIf();
 354             return new NodeConnectorId(ofportIds.get(0));
 355         }
 356         return null;
 357     }
 358
 359     public static InterfaceInfo.InterfaceType getInterfaceType(Interface iface) {
 360         InterfaceInfo.InterfaceType interfaceType =
 361                 org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.UNKNOWN_INTERFACE;
 362         Class<? extends InterfaceType> ifType = iface.getType();
 363
 364         if (ifType.isAssignableFrom(L2vlan.class)) {
 365             interfaceType =  org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
 366         } else if (ifType.isAssignableFrom(Tunnel.class)) {
 367             IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
 368             Class<? extends  org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase> tunnelType = ifTunnel.getTunnelInterfaceType();
 369             if (tunnelType.isAssignableFrom(TunnelTypeVxlan.class)) {
 370                 interfaceType = InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE;
 371             } else if (tunnelType.isAssignableFrom(TunnelTypeGre.class)) {
 372                 interfaceType = InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE;
 373             } else if(tunnelType.isAssignableFrom(TunnelTypeMplsOverGre.class)){
 374                 interfaceType = InterfaceInfo.InterfaceType.MPLS_OVER_GRE;
 375             }
 376         }
 377         // TODO: Check if the below condition is still needed/valid
 378         //else if (ifType.isAssignableFrom(InterfaceGroup.class)) {
 379         //    interfaceType =  org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE;
 380         //}
 381         return interfaceType;
 382     }
 383
 384     public static VlanInterfaceInfo getVlanInterfaceInfo(String interfaceName, Interface iface, BigInteger dpId){
 385         IfL2vlan vlanIface = iface.getAugmentation(IfL2vlan.class);
 386
 387         short vlanId = 0;
 388         //FIXME :Use this below thing properly
 389         VlanInterfaceInfo vlanInterfaceInfo = new VlanInterfaceInfo(dpId, "someString", vlanId);
 390
 391         if (vlanIface != null) {
 392             vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
 393             L2vlanMode l2VlanMode = vlanIface.getL2vlanMode();
 394
 395             if (l2VlanMode == L2vlanMode.Transparent) {
 396                 vlanInterfaceInfo.setVlanTransparent(true);
 397             }
 398             if (l2VlanMode == L2vlanMode.NativeUntagged) {
 399                 vlanInterfaceInfo.setUntaggedVlan(true);
 400             }
 401             vlanInterfaceInfo.setVlanId(vlanId);
 402
 403         }
 404         return vlanInterfaceInfo;
 405     }
 406 }