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