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