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 com.google.common.collect.ImmutableMap;
  12 import java.math.BigInteger;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.Future;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import org.apache.commons.lang3.BooleanUtils;
  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.genius.datastoreutils.DataStoreJobCoordinator;
  24 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  25 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  26 import org.opendaylight.genius.interfacemanager.globals.VlanInterfaceInfo;
  27 import org.opendaylight.genius.interfacemanager.servicebindings.flowbased.utilities.FlowBasedServicesUtils;
  28 import org.opendaylight.genius.mdsalutil.ActionInfo;
  29 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  30 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  31 import org.opendaylight.genius.mdsalutil.NwConstants;
  32 import org.opendaylight.genius.mdsalutil.actions.ActionNxResubmit;
  33 import org.opendaylight.genius.mdsalutil.actions.ActionOutput;
  34 import org.opendaylight.genius.mdsalutil.actions.ActionPushVlan;
  35 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
  36 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldTunnelId;
  37 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldVlanVid;
  38 import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelDestinationIp;
  39 import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelSourceIp;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan.L2vlanMode;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg6;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
  86 import org.opendaylight.yangtools.yang.binding.DataObject;
  87 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  88 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  89 import org.opendaylight.yangtools.yang.common.RpcResult;
  90 import org.slf4j.Logger;
  91 import org.slf4j.LoggerFactory;
  92
  93 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE;
  94 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.MPLS_OVER_GRE;
  95 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
  96 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE;
  97
  98 public class IfmUtil {
  99     private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
 100     private static final int INVALID_ID = 0;
 101
 102     private static final ImmutableMap<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType> TUNNEL_TYPE_MAP =
 103             new ImmutableMap.Builder<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType>()
 104                     .put(TunnelTypeGre.class, GRE_TRUNK_INTERFACE)
 105                     .put(TunnelTypeMplsOverGre.class, MPLS_OVER_GRE)
 106                     .put(TunnelTypeVxlan.class, VXLAN_TRUNK_INTERFACE)
 107                     .put(TunnelTypeVxlanGpe.class, VXLAN_TRUNK_INTERFACE)
 108                     .build();
 109
 110     public static BigInteger getDpnFromNodeConnectorId(NodeConnectorId portId) {
 111         /*
 112          * NodeConnectorId is of form 'openflow:dpnid:portnum'
 113          */
 114         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
 115         return new BigInteger(split[1]);
 116     }
 117
 118     public static BigInteger getDpnFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
 119         NodeConnectorId ncId = getNodeConnectorIdFromInterface(ifState);
 120         if(ncId != null){
 121             return getDpnFromNodeConnectorId(ncId);
 122         }
 123         return null;
 124     }
 125     public static String getPortNoFromInterfaceName(String ifaceName, DataBroker broker) {
 126         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
 127                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(ifaceName, broker);
 128
 129         if(ifState == null){
 130             throw new NullPointerException("Interface information not present in oper DS for " +ifaceName);
 131         }
 132         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
 133         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
 134         String portNo = IfmUtil.getPortNoFromNodeConnectorId(nodeConnectorId);
 135
 136         return portNo;
 137     }
 138
 139     public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
 140         /*
 141          * NodeConnectorId is of form 'openflow:dpnid:portnum'
 142          */
 143         String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
 144         return split[2];
 145     }
 146
 147     public static Long getPortNumberFromNodeConnectorId(NodeConnectorId portId) {
 148         String portNo = getPortNoFromNodeConnectorId(portId);
 149         try{
 150             return Long.valueOf(portNo);
 151         }catch(NumberFormatException ex){
 152             LOG.trace("Unable to retrieve port number from nodeconnector id for {}", portId);
 153         }
 154         return IfmConstants.INVALID_PORT_NO;
 155     }
 156
 157     public static NodeId buildDpnNodeId(BigInteger dpnId) {
 158         return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
 159     }
 160
 161     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 162         //TODO Make this generic and move to AbstractDataChangeListener or Utils.
 163         InstanceIdentifierBuilder<Interface> idBuilder =
 164                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 165         InstanceIdentifier<Interface> id = idBuilder.build();
 166         return id;
 167     }
 168
 169     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
 170         InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
 171                 InstanceIdentifier.builder(InterfacesState.class)
 172                         .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
 173                                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(interfaceName));
 174         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
 175         return id;
 176     }
 177
 178     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
 179             String name) {
 180         return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(name);
 181     }
 182
 183     public static InstanceIdentifier<IdPool> getPoolId(String poolName){
 184         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 185                 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 186         InstanceIdentifier<IdPool> id = idBuilder.build();
 187         return id;
 188     }
 189
 190     public static List<String> getPortNameAndSuffixFromInterfaceName(String intfName) {
 191         List<String> strList = new ArrayList<>(2);
 192         int index = intfName.indexOf(":");
 193         if (index != -1) {
 194             strList.add(0, intfName.substring(0, index));
 195             strList.add(1, intfName.substring(index));
 196         }
 197         return strList;
 198     }
 199
 200     public static long getGroupId(long ifIndex, InterfaceInfo.InterfaceType infType) {
 201         if (infType == InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE) {
 202             return ifIndex + IfmConstants.LOGICAL_GROUP_START;
 203         }
 204         else if (infType == VLAN_INTERFACE) {
 205             return ifIndex + IfmConstants.VLAN_GROUP_START;
 206         } else {
 207             return ifIndex + IfmConstants.TRUNK_GROUP_START;
 208         }
 209     }
 210
 211     public static List<String> getDpIdPortNameAndSuffixFromInterfaceName(String intfName) {
 212         List<String> strList = new ArrayList<>(3);
 213         int index1 = intfName.indexOf(":");
 214         if (index1 != -1) {
 215             int index2 = intfName.indexOf(":", index1 + 1 );
 216             strList.add(0, intfName.substring(0, index1));
 217             if (index2 != -1) {
 218                 strList.add(1, intfName.substring(index1, index2));
 219                 strList.add(2, intfName.substring(index2));
 220             } else {
 221                 strList.add(1, intfName.substring(index1));
 222                 strList.add(2, "");
 223             }
 224         }
 225         return strList;
 226     }
 227
 228     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 229                                                           InstanceIdentifier<T> path, DataBroker broker) {
 230         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 231             return tx.read(datastoreType, path).get();
 232         } catch (Exception e) {
 233             throw new RuntimeException(e);
 234         }
 235     }
 236
 237     public static List<Action> getEgressActionsForInterface(String interfaceName, Long tunnelKey, Integer actionKey,
 238                                                             DataBroker dataBroker, Boolean isDefaultEgress) {
 239         List<ActionInfo> listActionInfo = getEgressActionInfosForInterface(interfaceName, tunnelKey, actionKey==null?0:actionKey, dataBroker, isDefaultEgress);
 240         List<Action> actionsList = new ArrayList<>();
 241         for (ActionInfo actionInfo : listActionInfo) {
 242             actionsList.add(actionInfo.buildAction());
 243         }
 244         return actionsList;
 245     }
 246
 247     public static List<Instruction> getEgressInstructionsForInterface(String interfaceName, Long tunnelKey,
 248                                                                       DataBroker dataBroker, Boolean isDefaultEgress) {
 249         List<Instruction> instructions = new ArrayList<>();
 250         List<Action> actionList = MDSALUtil.buildActions(getEgressActionInfosForInterface(
 251                 interfaceName, tunnelKey, 0, dataBroker, isDefaultEgress));
 252         instructions.add(MDSALUtil.buildApplyActionsInstruction(actionList));
 253         return  instructions;
 254     }
 255
 256     public static List<Instruction> getEgressInstructionsForInterface(Interface interfaceInfo, String portNo,
 257                                                                       Long tunnelKey, boolean isDefaultEgress, int ifIndex) {
 258         List<Instruction> instructions = new ArrayList<>();
 259         InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
 260         List<Action> actionList = MDSALUtil.buildActions(
 261                 getEgressActionInfosForInterface(interfaceInfo, portNo, ifaceType, tunnelKey, 0, isDefaultEgress, ifIndex));
 262         instructions.add(MDSALUtil.buildApplyActionsInstruction(actionList));
 263         return  instructions;
 264     }
 265
 266
 267     public static List<ActionInfo> getEgressActionInfosForInterface(String     interfaceName,
 268                                                                     int        actionKeyStart,
 269                                                                     DataBroker dataBroker,
 270                                                                     Boolean isDefaultEgress) {
 271         return getEgressActionInfosForInterface(interfaceName, null, actionKeyStart, dataBroker, isDefaultEgress);
 272     }
 273
 274     /**
 275      * Returns a list of Actions to be taken when sending a packet over an interface
 276      *
 277      * @param interfaceName
 278      * @param tunnelKey Optional.
 279      * @param actionKeyStart
 280      * @param dataBroker
 281      * @return
 282      */
 283     public static List<ActionInfo> getEgressActionInfosForInterface(String     interfaceName,
 284                                                                     Long       tunnelKey,
 285                                                                     int        actionKeyStart,
 286                                                                     DataBroker dataBroker,
 287                                                                     Boolean isDefaultEgress) {
 288         Interface interfaceInfo = InterfaceManagerCommonUtils.getInterfaceFromConfigDS(new InterfaceKey(interfaceName),
 289                 dataBroker);
 290         if(interfaceInfo == null){
 291             throw new NullPointerException("Interface information not present in config DS for " +interfaceName);
 292         }
 293         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState =
 294                 InterfaceManagerCommonUtils.getInterfaceStateFromOperDS(interfaceName, dataBroker);
 295         if(ifState == null){
 296             throw new NullPointerException("Interface information not present in oper DS for " +interfaceName);
 297         }
 298         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
 299         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
 300         String portNo = IfmUtil.getPortNoFromNodeConnectorId(nodeConnectorId);
 301
 302         InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
 303         return getEgressActionInfosForInterface(interfaceInfo, portNo, ifaceType, tunnelKey, actionKeyStart,
 304                 isDefaultEgress, ifState.getIfIndex());
 305     }
 306
 307
 308     public static List<ActionInfo> getEgressActionInfosForInterface(Interface interfaceInfo,
 309                                                                     String portNo,
 310                                                                     InterfaceInfo.InterfaceType ifaceType,
 311                                                                     Long       tunnelKey,
 312                                                                     int        actionKeyStart,
 313                                                                     boolean isDefaultEgress,
 314                                                                     int ifIndex) {
 315         List<ActionInfo> result = new ArrayList<>();
 316         switch (ifaceType) {
 317             case VLAN_INTERFACE:
 318                 if(isDefaultEgress) {
 319                     IfL2vlan vlanIface = interfaceInfo.getAugmentation(IfL2vlan.class);
 320                     LOG.trace("L2Vlan: {}", vlanIface);
 321                     boolean isVlanTransparent = false;
 322                     int vlanVid = 0;
 323                     if (vlanIface != null) {
 324                         vlanVid = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue();
 325                         isVlanTransparent = vlanIface.getL2vlanMode() == IfL2vlan.L2vlanMode.Transparent;
 326                     }
 327                     if (vlanVid != 0 && !isVlanTransparent) {
 328                         result.add(new ActionPushVlan(actionKeyStart++));
 329                         result.add(new ActionSetFieldVlanVid(actionKeyStart++, vlanVid));
 330                     }
 331                     result.add(new ActionOutput(actionKeyStart++, new Uri(portNo)));
 332                 }else{
 333                     long regValue = MetaDataUtil.getReg6ValueForLPortDispatcher(ifIndex, NwConstants.DEFAULT_SERVICE_INDEX);
 334                     result.add(new ActionRegLoad(actionKeyStart++, NxmNxReg6.class, IfmConstants.REG6_START_INDEX,
 335                             IfmConstants.REG6_END_INDEX, regValue));
 336                     result.add(new ActionNxResubmit(actionKeyStart++, NwConstants.EGRESS_LPORT_DISPATCHER_TABLE));
 337                 }
 338                 break;
 339             case MPLS_OVER_GRE:
 340             case VXLAN_TRUNK_INTERFACE:
 341             case GRE_TRUNK_INTERFACE:
 342                 //TODO tunnel_id to encode GRE key, once it is supported
 343                 // Until then, tunnel_id should be "cleaned", otherwise it stores the value coming from a VXLAN tunnel
 344                 if (tunnelKey == null) {
 345                     tunnelKey = 0L;
 346                 }
 347                 result.add(new ActionSetFieldTunnelId(actionKeyStart++, BigInteger.valueOf(tunnelKey)));
 348
 349                 IfTunnel ifTunnel = interfaceInfo.getAugmentation(IfTunnel.class);
 350                 if(BooleanUtils.isTrue(ifTunnel.isTunnelRemoteIpFlow())) {
 351                     result.add(new ActionSetTunnelDestinationIp(actionKeyStart++, ifTunnel.getTunnelDestination()));
 352                 }
 353                 if(BooleanUtils.isTrue(ifTunnel.isTunnelSourceIpFlow())) {
 354                     result.add(new ActionSetTunnelSourceIp(actionKeyStart++, ifTunnel.getTunnelSource()));
 355                 }
 356                 result.add(new ActionOutput(actionKeyStart++, new Uri(portNo)));
 357                 break;
 358
 359             default:
 360                 LOG.warn("Interface Type {} not handled yet", ifaceType);
 361                 break;
 362         }
 363         return result;
 364     }
 365
 366     public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
 367         return new NodeId(ncId.getValue().substring(0,ncId.getValue().lastIndexOf(":")));
 368     }
 369
 370     public static BigInteger[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
 371         BigInteger metadata = new BigInteger("0", 16);
 372         BigInteger metadataMask = new BigInteger("0", 16);
 373         if (instructions != null && !instructions.isEmpty()) {
 374             // check if metadata write instruction is present
 375             for (Instruction instruction : instructions) {
 376                 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction actualInstruction = instruction.getInstruction();
 377                 if (actualInstruction instanceof WriteMetadataCase) {
 378                     WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction ;
 379                     WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
 380                     metadata = metadata.or(availableMetaData.getMetadata());
 381                     metadataMask = metadataMask.or(availableMetaData.getMetadataMask());
 382                 }
 383             }
 384         }
 385         return new BigInteger[] { metadata, metadataMask };
 386     }
 387
 388     public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
 389         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 390                 .setPoolName(poolName)
 391                 .setIdKey(idKey).build();
 392         try {
 393             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 394             RpcResult<AllocateIdOutput> rpcResult = result.get();
 395             if(rpcResult.isSuccessful()) {
 396                 return rpcResult.getResult().getIdValue().intValue();
 397             } else {
 398                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 399             }
 400         } catch (InterruptedException | ExecutionException e) {
 401             LOG.warn("Exception when getting Unique Id",e);
 402         }
 403         return INVALID_ID;
 404     }
 405
 406     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 407         ReleaseIdInput idInput = new ReleaseIdInputBuilder()
 408                 .setPoolName(poolName)
 409                 .setIdKey(idKey).build();
 410         try {
 411             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 412             RpcResult<Void> rpcResult = result.get();
 413             if(!rpcResult.isSuccessful()) {
 414                 LOG.warn("RPC Call to release Id {} with Key {} returned with Errors {}",
 415                         idKey, rpcResult.getErrors());
 416             }
 417         } catch (InterruptedException | ExecutionException e) {
 418             LOG.warn("Exception when releasing Id for key {}", idKey, e);
 419         }
 420     }
 421
 422     public static BigInteger getDpnId(DatapathId datapathId){
 423         if (datapathId != null) {
 424             // Adding logs for a random issue spotted during datapath id conversion
 425             String dpIdStr = datapathId.getValue().replace(":", "");
 426             BigInteger dpnId =  new BigInteger(dpIdStr, 16);
 427             return dpnId;
 428         }
 429         return null;
 430     }
 431
 432     public static NodeConnectorId getNodeConnectorIdFromInterface(String interfaceName, DataBroker dataBroker) {
 433         return FlowBasedServicesUtils.getNodeConnectorIdFromInterface(interfaceName, dataBroker);
 434     }
 435
 436     public static String getPortName(DataBroker dataBroker, NodeConnectorId ncId){
 437         InstanceIdentifier<NodeConnector> ncIdentifier =
 438                 InstanceIdentifier.builder(Nodes.class)
 439                         .child(Node.class, new NodeKey(getNodeIdFromNodeConnectorId(ncId)))
 440                         .child(NodeConnector.class, new NodeConnectorKey(ncId)).build();
 441         return read(LogicalDatastoreType.OPERATIONAL, ncIdentifier, dataBroker).transform(
 442                 nc -> nc.getAugmentation(FlowCapableNodeConnector.class).getName()).orNull();
 443     }
 444
 445     public static NodeConnectorId getNodeConnectorIdFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface ifState){
 446         if(ifState != null) {
 447             List<String> ofportIds = ifState.getLowerLayerIf();
 448             return new NodeConnectorId(ofportIds.get(0));
 449         }
 450         return null;
 451     }
 452
 453     public static InterfaceInfo.InterfaceType getInterfaceType(Interface iface) {
 454         InterfaceInfo.InterfaceType interfaceType = org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.UNKNOWN_INTERFACE;
 455         Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> ifType = iface
 456                 .getType();
 457
 458         if (ifType.isAssignableFrom(L2vlan.class)) {
 459             interfaceType = VLAN_INTERFACE;
 460         } else if (ifType.isAssignableFrom(Tunnel.class)) {
 461             IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
 462             Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase> tunnelType = ifTunnel
 463                     .getTunnelInterfaceType();
 464             interfaceType = TUNNEL_TYPE_MAP.get(tunnelType);
 465         }
 466         return interfaceType;
 467     }
 468
 469     public static VlanInterfaceInfo getVlanInterfaceInfo(String interfaceName, Interface iface, BigInteger dpId) {
 470
 471         short vlanId = 0;
 472         String portName = null;
 473         IfL2vlan vlanIface = iface.getAugmentation(IfL2vlan.class);
 474         ParentRefs parentRefs = iface.getAugmentation(ParentRefs.class);
 475         if (parentRefs != null && parentRefs.getParentInterface() != null) {
 476             portName = parentRefs.getParentInterface();
 477         }else {
 478             LOG.warn("Portname set to null since parentRef is Null");
 479         }
 480         VlanInterfaceInfo vlanInterfaceInfo = new VlanInterfaceInfo(dpId, portName, vlanId);
 481
 482         if (vlanIface != null) {
 483             vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
 484             L2vlanMode l2VlanMode = vlanIface.getL2vlanMode();
 485
 486             if (l2VlanMode == L2vlanMode.Transparent) {
 487                 vlanInterfaceInfo.setVlanTransparent(true);
 488             }
 489             if (l2VlanMode == L2vlanMode.NativeUntagged) {
 490                 vlanInterfaceInfo.setUntaggedVlan(true);
 491             }
 492             vlanInterfaceInfo.setVlanId(vlanId);
 493
 494         }
 495         return vlanInterfaceInfo;
 496     }
 497
 498     public static BigInteger getDeadBeefBytesForMac() {
 499         return new BigInteger("FFFFFFFF", 16).and(new BigInteger(IfmConstants.DEAD_BEEF_MAC_PREFIX, 16)).shiftLeft(16);
 500     }
 501
 502     public static BigInteger fillPortNumberToMac(long portNumber) {
 503         return new BigInteger("FFFF", 16).and(BigInteger.valueOf(portNumber));
 504     }
 505
 506     public static String generateMacAddress(long portNo){
 507         String unformattedMAC = getDeadBeefBytesForMac().or(fillPortNumberToMac(portNo)).toString(16);
 508         return unformattedMAC.replaceAll("(.{2})", "$1"+IfmConstants.MAC_SEPARATOR).
 509                 substring(0, IfmConstants.MAC_STRING_LENGTH);
 510     }
 511
 512     public static PhysAddress getPhyAddress(long portNo, FlowCapableNodeConnector flowCapableNodeConnector){
 513         String southboundMacAddress = flowCapableNodeConnector.getHardwareAddress().getValue();
 514         if(IfmConstants.INVALID_MAC.equals(southboundMacAddress)){
 515             LOG.debug("Invalid MAC Address received for {}, generating MAC Address", flowCapableNodeConnector.getName());
 516             southboundMacAddress = generateMacAddress(portNo);
 517         }
 518         return new PhysAddress(southboundMacAddress);
 519     }
 520
 521     public static void bindService(WriteTransaction t, String interfaceName, BoundServices serviceInfo,
 522                                    Class<? extends ServiceModeBase> serviceMode){
 523         LOG.info("Binding Service {} for : {}", serviceInfo.getServiceName(), interfaceName);
 524         InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier = InstanceIdentifier.builder(ServiceBindings.class)
 525                 .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, serviceMode))
 526                 .child(BoundServices.class, new BoundServicesKey(serviceInfo.getServicePriority())).build();
 527         t.put(LogicalDatastoreType.CONFIGURATION, boundServicesInstanceIdentifier, serviceInfo, true);
 528     }
 529
 530     public static void unbindService(DataBroker dataBroker, String interfaceName, InstanceIdentifier<BoundServices>
 531             boundServicesInstanceIdentifier){
 532         LOG.info("Unbinding Service from : {}", interfaceName);
 533         DataStoreJobCoordinator dataStoreJobCoordinator = DataStoreJobCoordinator.getInstance();
 534         dataStoreJobCoordinator.enqueueJob(interfaceName,
 535                 () -> {
 536                     WriteTransaction t = dataBroker.newWriteOnlyTransaction();
 537                     t.delete(LogicalDatastoreType.CONFIGURATION, boundServicesInstanceIdentifier);
 538                     List<ListenableFuture<Void>> futures = new ArrayList<>();
 539                     futures.add(t.submit());
 540                     return futures;
 541                 }
 542         );
 543     }
 544 }