mdsalutil/mdsalutil-api/src/main/java/org/opendaylight/genius/mdsalutil/MDSALUtil.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
   9 package org.opendaylight.genius.mdsalutil;
  10
  11 import java.math.BigInteger;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.concurrent.ExecutionException;
  17
  18 import org.opendaylight.controller.liblldp.HexEncode;
  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.controller.md.sal.common.api.data.TransactionCommitFailedException;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.PopVlanActionCaseBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetFieldCaseBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.pop.vlan.action._case.PopVlanActionBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.field._case.SetFieldBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Instructions;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCase;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.GoToTableCaseBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteActionsCase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteActionsCaseBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCaseBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActions;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.go.to.table._case.GoToTableBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.actions._case.WriteActions;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.actions._case.WriteActionsBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadataBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.BucketId;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.BucketsBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketKey;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TunnelBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg6;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice.DstNxRegCaseBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nodes.node.table.flow.instructions.instruction.instruction.apply.actions._case.apply.actions.action.action.NxActionRegLoadNodesNodeTableFlowApplyActionsCaseBuilder;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.NxRegLoadBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load.Dst;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load.DstBuilder;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInput;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInputBuilder;
  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.slf4j.Logger;
  90 import org.slf4j.LoggerFactory;
  91
  92 import com.google.common.base.Joiner;
  93 import com.google.common.base.Optional;
  94 import com.google.common.primitives.Bytes;
  95 import com.google.common.primitives.Ints;
  96 import com.google.common.util.concurrent.CheckedFuture;
  97
  98 public class MDSALUtil {
  99
 100     public enum MdsalOp {  CREATION_OP, UPDATE_OP, REMOVAL_OP };
 101
 102     public static final String NODE_PREFIX = "openflow";
 103     public static final int GROUP_WEIGHT = 0;
 104     public static final long WATCH_PORT = 0xffffffffL;
 105     public static final long WATCH_GROUP = 0xffffffffL;
 106     public static final String SEPARATOR = ":";
 107     private static final Buckets EMPTY_Buckets = new BucketsBuilder().build();
 108     private static final Instructions EMPTY_Instructions = new InstructionsBuilder().setInstruction(
 109             new ArrayList<Instruction>()).build();
 110     private static final Match EMPTY_Matches = new MatchBuilder().build();
 111     private static final Logger logger = LoggerFactory.getLogger(MDSALUtil.class);
 112
 113     public static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId, int priority, String flowName,
 114             int idleTimeOut, int hardTimeOut, BigInteger cookie, List<? extends MatchInfoBase>  listMatchInfoBase,
 115             List<InstructionInfo> listInstructionInfo) {
 116
 117         FlowEntity flowEntity = new FlowEntity(dpnId);
 118
 119         flowEntity.setTableId(tableId);
 120         flowEntity.setFlowId(flowId);
 121         flowEntity.setPriority(priority);
 122         flowEntity.setFlowName(flowName);
 123         flowEntity.setIdleTimeOut(idleTimeOut);
 124         flowEntity.setHardTimeOut(hardTimeOut);
 125         flowEntity.setCookie(cookie);
 126         flowEntity.setMatchInfoList(listMatchInfoBase);
 127         flowEntity.setInstructionInfoList(listInstructionInfo);
 128
 129         return flowEntity;
 130     }
 131
 132     // TODO: CHECK IF THIS IS USED
 133     public static Flow buildFlow(short tableId, String flowId, int priority, String flowName, int idleTimeOut,
 134             int hardTimeOut, BigInteger cookie, List<? extends MatchInfoBase> listMatchInfoBase, List<InstructionInfo> listInstructionInfo) {
 135         return MDSALUtil.buildFlow(tableId, flowId, priority, flowName, idleTimeOut, hardTimeOut, cookie,
 136                 listMatchInfoBase, listInstructionInfo, true);
 137     }
 138
 139     public static Flow buildFlow(short tableId, String flowId, int priority, String flowName, int idleTimeOut,
 140             int hardTimeOut, BigInteger cookie, List<? extends MatchInfoBase>  listMatchInfoBase,
 141             List<InstructionInfo> listInstructionInfo, boolean isStrict) {
 142         FlowKey key = new FlowKey(new FlowId(flowId));
 143         return new FlowBuilder().setMatch(buildMatches(listMatchInfoBase)).setKey(key)
 144                 .setPriority(Integer.valueOf(priority)).setInstructions(buildInstructions(listInstructionInfo))
 145                 .setBarrier(false).setInstallHw(true).setHardTimeout(hardTimeOut).setIdleTimeout(idleTimeOut)
 146                 .setFlowName(flowName).setTableId(Short.valueOf(tableId)).setStrict(isStrict)
 147                 .setCookie(new FlowCookie(cookie)).build();
 148     }
 149
 150     public static Flow buildFlow(short tableId, String flowId) {
 151         return new FlowBuilder().setTableId(tableId).setId(new FlowId(flowId)).build();
 152     }
 153
 154     public static Flow buildFlowNew(short tableId, String flowId, int priority, String flowName, int idleTimeOut,
 155                                  int hardTimeOut, BigInteger cookie, List<? extends MatchInfoBase>  listMatchInfoBase, List<Instruction> listInstructionInfo) {
 156         return MDSALUtil.buildFlowNew(tableId, flowId, priority, flowName, idleTimeOut, hardTimeOut, cookie,
 157                 listMatchInfoBase, listInstructionInfo, true);
 158     }
 159
 160     private static Flow buildFlowNew(short tableId, String flowId, int priority, String flowName, int idleTimeOut,
 161                                   int hardTimeOut, BigInteger cookie, List<? extends MatchInfoBase>  listMatchInfoBase,
 162                                   List<Instruction> listInstructionInfo, boolean isStrict) {
 163         FlowKey key = new FlowKey(new FlowId(flowId));
 164         return new FlowBuilder().setMatch(buildMatches(listMatchInfoBase)).setKey(key)
 165                 .setPriority(Integer.valueOf(priority)).setInstructions(new InstructionsBuilder().setInstruction(listInstructionInfo).build())
 166                 .setBarrier(false).setInstallHw(true).setHardTimeout(hardTimeOut).setIdleTimeout(idleTimeOut)
 167                 .setFlowName(flowName).setTableId(Short.valueOf(tableId)).setStrict(isStrict)
 168                 .setCookie(new FlowCookie(cookie)).build();
 169     }
 170
 171     public static GroupEntity buildGroupEntity(BigInteger dpnId, long groupId, String groupName, GroupTypes groupType,
 172             List<BucketInfo> listBucketInfo) {
 173
 174         GroupEntity groupEntity = new GroupEntity(dpnId);
 175
 176         groupEntity.setGroupId(groupId);
 177         groupEntity.setGroupName(groupName);
 178         groupEntity.setGroupType(groupType);
 179         groupEntity.setBucketInfoList(listBucketInfo);
 180
 181         return groupEntity;
 182     }
 183
 184     public static Group buildGroup(long groupId, String groupName, GroupTypes groupType, Buckets buckets) {
 185         GroupId groupIdentifier = new GroupId(groupId);
 186         return new GroupBuilder().setGroupId(groupIdentifier).setKey(new GroupKey(groupIdentifier)).setGroupName(groupName)
 187                 .setGroupType(groupType).setBuckets(buckets).build();
 188     }
 189
 190     public static TransmitPacketInput getPacketOutDefault(List<ActionInfo> actionInfos, byte[] payload, BigInteger dpnId) {
 191         return new TransmitPacketInputBuilder()
 192                 .setAction(buildActions(actionInfos))
 193                 .setPayload(payload)
 194                 .setNode(
 195                         new NodeRef(InstanceIdentifier.builder(Nodes.class)
 196                                 .child(Node.class, new NodeKey(new NodeId("openflow:" + dpnId))).toInstance()))
 197                 .setIngress(getDefaultNodeConnRef(dpnId)).setEgress(getDefaultNodeConnRef(dpnId)).build();
 198     }
 199
 200     public static TransmitPacketInput getPacketOut(List<ActionInfo> actionInfos, byte[] payload, long dpnId,
 201             NodeConnectorRef ingress) {
 202         return new TransmitPacketInputBuilder()
 203                 .setAction(buildActions(actionInfos))
 204                 .setPayload(payload)
 205                 .setNode(
 206                         new NodeRef(InstanceIdentifier.builder(Nodes.class)
 207                                 .child(Node.class, new NodeKey(new NodeId("openflow:" + dpnId))).toInstance()))
 208                 .setIngress(ingress).setEgress(ingress).build();
 209     }
 210
 211     public static Action retrieveSetTunnelIdAction(BigInteger tunnelId, int actionKey) {
 212         return new ActionBuilder().setAction(
 213                 new SetFieldCaseBuilder().setSetField(new SetFieldBuilder().setTunnel(new TunnelBuilder()
 214                 .setTunnelId(tunnelId).build()).build())
 215                 .build()).setKey(new ActionKey(actionKey)).build();
 216     }
 217
 218     public static List<Action> buildActions(List<ActionInfo> actions) {
 219         List<Action> actionsList = new ArrayList<>();
 220         for (ActionInfo actionInfo : actions) {
 221             actionsList.add(actionInfo.buildAction());
 222         }
 223         return actionsList;
 224     }
 225
 226     public static String longToIp(long ip, long mask) {
 227         StringBuilder sb = new StringBuilder(15);
 228         Joiner joiner = Joiner.on('.');
 229
 230         joiner.appendTo(sb, Bytes.asList(Ints.toByteArray((int) ip)));
 231
 232         sb.append("/" + mask);
 233
 234         return sb.toString();
 235     }
 236
 237
 238     public static Bucket buildBucket(List<Action> actionsList, int weight, int bucketId, long watchPort, long watchGroup) {
 239         return  new BucketBuilder().setAction(actionsList).setWeight(weight)
 240                 .setWatchGroup(watchGroup).setWatchPort(watchPort).setBucketId(new BucketId(Long.valueOf(bucketId))).setKey(new BucketKey(new BucketId(Long.valueOf(bucketId)))).build();
 241
 242     }
 243
 244     public static Buckets buildBucketLists(List<Bucket> bucketList) {
 245         return new BucketsBuilder().setBucket(bucketList).build();
 246     }
 247
 248     protected static Buckets buildBuckets(List<BucketInfo> listBucketInfo) {
 249         long i = 0;
 250         if (listBucketInfo != null) {
 251             BucketsBuilder bucketsBuilder = new BucketsBuilder();
 252             List<Bucket> bucketList = new ArrayList<>();
 253
 254             for (BucketInfo bucketInfo : listBucketInfo) {
 255                 BucketBuilder bucketBuilder = new BucketBuilder();
 256                 bucketBuilder.setAction(bucketInfo.buildActions());
 257                 bucketBuilder.setWeight(bucketInfo.getWeight());
 258                 bucketBuilder.setBucketId(new BucketId(i++));
 259                 bucketBuilder.setWeight(bucketInfo.getWeight()).setWatchPort(bucketInfo.getWatchPort())
 260                         .setWatchGroup(bucketInfo.getWatchGroup());
 261                 bucketList.add(bucketBuilder.build());
 262             }
 263
 264             bucketsBuilder.setBucket(bucketList);
 265             return bucketsBuilder.build();
 266         }
 267
 268         return EMPTY_Buckets;
 269     }
 270
 271     public static Instructions buildInstructions(List<InstructionInfo> listInstructionInfo) {
 272         if (listInstructionInfo != null) {
 273             List<Instruction> instructions = new ArrayList<>();
 274             int instructionKey = 0;
 275
 276             for (InstructionInfo instructionInfo : listInstructionInfo) {
 277                 instructions.add(instructionInfo.buildInstruction(instructionKey));
 278                 instructionKey++;
 279             }
 280
 281             return new InstructionsBuilder().setInstruction(instructions).build();
 282         }
 283
 284         return EMPTY_Instructions;
 285     }
 286
 287     public static Match buildMatches(List<? extends MatchInfoBase> listMatchInfoBase) {
 288         if (listMatchInfoBase != null) {
 289             MatchBuilder matchBuilder = new MatchBuilder();
 290             Map<Class<?>, Object> mapMatchBuilder = new HashMap<>();
 291
 292             for (MatchInfoBase MatchInfoBase : listMatchInfoBase) {
 293                 MatchInfoBase.createInnerMatchBuilder(mapMatchBuilder);
 294             }
 295
 296             for (MatchInfoBase MatchInfoBase : listMatchInfoBase) {
 297                 MatchInfoBase.setMatch(matchBuilder, mapMatchBuilder);
 298             }
 299
 300             return matchBuilder.build();
 301         }
 302
 303         return EMPTY_Matches;
 304     }
 305
 306     // TODO: Check the port const
 307     public static NodeConnectorRef getDefaultNodeConnRef(BigInteger nDpId) {
 308         return getNodeConnRef(NODE_PREFIX + SEPARATOR + nDpId, "0xfffffffd");
 309     }
 310
 311     public static NodeConnectorRef getNodeConnRef(BigInteger nDpId, String port) {
 312         return getNodeConnRef(NODE_PREFIX + SEPARATOR + nDpId, port);
 313     }
 314
 315     public static NodeConnectorRef getNodeConnRef(String sNodeId, String port) {
 316         String sNodeConnectorKey;
 317         StringBuilder sbTmp;
 318         NodeId nodeId;
 319         NodeKey nodeKey;
 320         NodeConnectorId nodeConnectorId;
 321         NodeConnectorKey nodeConnectorKey;
 322         InstanceIdentifierBuilder<Nodes> nodesInstanceIdentifierBuilder;
 323         InstanceIdentifierBuilder<Node> nodeInstanceIdentifierBuilder;
 324         InstanceIdentifierBuilder<NodeConnector> nodeConnectorInstanceIdentifierBuilder;
 325         InstanceIdentifier<NodeConnector> nodeConnectorInstanceIdentifier;
 326         NodeConnectorRef nodeConnectorRef;
 327
 328         sbTmp = new StringBuilder();
 329
 330         sbTmp.append(sNodeId);
 331         sbTmp.append(SEPARATOR);
 332         sbTmp.append(port);
 333
 334         sNodeConnectorKey = sbTmp.toString();
 335         nodeConnectorId = new NodeConnectorId(sNodeConnectorKey);
 336         nodeConnectorKey = new NodeConnectorKey(nodeConnectorId);
 337
 338         nodeId = new NodeId(sNodeId);
 339         nodeKey = new NodeKey(nodeId);
 340
 341         nodesInstanceIdentifierBuilder = InstanceIdentifier.<Nodes> builder(Nodes.class);
 342         nodeInstanceIdentifierBuilder = nodesInstanceIdentifierBuilder.<Node, NodeKey> child(Node.class, nodeKey);
 343         nodeConnectorInstanceIdentifierBuilder = nodeInstanceIdentifierBuilder.<NodeConnector, NodeConnectorKey> child(
 344                 NodeConnector.class, nodeConnectorKey);
 345         nodeConnectorInstanceIdentifier = nodeConnectorInstanceIdentifierBuilder.toInstance();
 346         nodeConnectorRef = new NodeConnectorRef(nodeConnectorInstanceIdentifier);
 347         return nodeConnectorRef;
 348     }
 349
 350     public static BigInteger getDpnIdFromNodeName(NodeId nodeId) {
 351         return getDpnIdFromNodeName(nodeId.getValue());
 352     }
 353
 354     public static BigInteger getDpnIdFromNodeName(String sMdsalNodeName) {
 355         String sDpId = sMdsalNodeName.substring(sMdsalNodeName.lastIndexOf(":") + 1);
 356         return new BigInteger(sDpId);
 357     }
 358
 359     public static long getOfPortNumberFromPortName(NodeConnectorId nodeConnectorId) {
 360         return getOfPortNumberFromPortName(nodeConnectorId.getValue());
 361     }
 362
 363     public static long getDpnIdFromPortName(NodeConnectorId nodeConnectorId) {
 364         try {
 365             String ofPortName = nodeConnectorId.getValue();
 366             return Long.parseLong(ofPortName.substring(ofPortName.indexOf(":")+1,
 367                     ofPortName.lastIndexOf(":")));
 368         } catch (Exception e) {
 369             logger.error("NodeConnectorId not of expected format openflow:dpnid:portnum");
 370             return -1;
 371         }
 372     }
 373
 374     public static long getOfPortNumberFromPortName(String sMdsalPortName) {
 375         String sPortNumber = sMdsalPortName.substring(sMdsalPortName.lastIndexOf(":") + 1);
 376         return Long.parseLong(sPortNumber);
 377     }
 378
 379     public static TransmitPacketInput getPacketOut(List<ActionInfo> actionInfos, byte[] payload, BigInteger dpnId,
 380                     NodeConnectorRef nodeConnRef) {
 381         // TODO Auto-generated method stub
 382         return null;
 383     }
 384
 385     public static Instruction buildAndGetPopVlanActionInstruction(int actionKey, int instructionKey) {
 386         Action popVlanAction = new ActionBuilder().setAction(
 387                 new PopVlanActionCaseBuilder().setPopVlanAction(new PopVlanActionBuilder().build()).build())
 388                 .setKey(new ActionKey(actionKey)).build();
 389         List<Action> listAction = new ArrayList<> ();
 390         listAction.add(popVlanAction);
 391         return buildApplyActionsInstruction(listAction, instructionKey);
 392     }
 393
 394     public static Instruction buildAndGetSetReg6ActionInstruction(int actionKey, int instructionKey,
 395                                                                   int startOffSet, int endOffSet, long value) {
 396         NxRegLoadBuilder nxRegLoadBuilder = new NxRegLoadBuilder();
 397         Dst dst =  new DstBuilder()
 398                 .setDstChoice(new DstNxRegCaseBuilder().setNxReg(NxmNxReg6.class).build())
 399                 .setStart(startOffSet)
 400                 .setEnd(endOffSet)
 401                 .build();
 402         nxRegLoadBuilder.setDst(dst);
 403         nxRegLoadBuilder.setValue(new BigInteger(Long.toString(value)));
 404         ActionBuilder ab = new ActionBuilder();
 405         ab.setAction(new NxActionRegLoadNodesNodeTableFlowApplyActionsCaseBuilder().setNxRegLoad(nxRegLoadBuilder.build()).build());
 406         ab.setKey(new ActionKey(actionKey));
 407         List<Action> listAction = new ArrayList<Action> ();
 408         listAction.add(ab.build());
 409         return buildApplyActionsInstruction(listAction, instructionKey);
 410     }
 411
 412     public static Instruction buildApplyActionsInstruction(List<Action> actions) {
 413         return buildApplyActionsInstruction(actions, 0);
 414     }
 415
 416     public static Instruction buildWriteActionsInstruction(List<Action> actions) {
 417         WriteActions writeActions = new WriteActionsBuilder().setAction(actions).build();
 418         WriteActionsCase writeActionsCase = new WriteActionsCaseBuilder().setWriteActions(writeActions).build();
 419         InstructionBuilder instructionBuilder = new InstructionBuilder();
 420
 421         instructionBuilder.setInstruction(writeActionsCase);
 422         instructionBuilder.setKey(new InstructionKey(0));
 423         return instructionBuilder.build();
 424     }
 425
 426     public static Instruction buildApplyActionsInstruction(List<Action> listAction, int instructionKey) {
 427         ApplyActions applyActions = new ApplyActionsBuilder().setAction(listAction).build();
 428         ApplyActionsCase applyActionsCase = new ApplyActionsCaseBuilder().setApplyActions(applyActions).build();
 429         InstructionBuilder instructionBuilder = new InstructionBuilder();
 430
 431         instructionBuilder.setInstruction(applyActionsCase);
 432         instructionBuilder.setKey(new InstructionKey(instructionKey));
 433         return instructionBuilder.build();
 434     }
 435
 436     public static List<Instruction> buildInstructionsDrop() {
 437         return buildInstructionsDrop(0);
 438     }
 439
 440     public static List<Instruction> buildInstructionsDrop(int instructionKey) {
 441         List<Instruction> mkInstructions = new ArrayList<>();
 442         List <Action> actionsInfos = new ArrayList <> ();
 443         actionsInfos.add(new ActionInfo(ActionType.drop_action, new String[]{}).buildAction());
 444         mkInstructions.add(getWriteActionsInstruction(actionsInfos, instructionKey));
 445         return mkInstructions;
 446     }
 447
 448
 449     public static Instruction getWriteActionsInstruction(List<Action> listAction, int instructionKey) {
 450         WriteActions writeActions = new WriteActionsBuilder().setAction(listAction).build();
 451         WriteActionsCase writeActionsCase = new WriteActionsCaseBuilder().setWriteActions(writeActions).build();
 452         InstructionBuilder instructionBuilder = new InstructionBuilder();
 453
 454         instructionBuilder.setInstruction(writeActionsCase);
 455         instructionBuilder.setKey(new InstructionKey(instructionKey));
 456         return instructionBuilder.build();
 457     }
 458
 459     public static Action buildAction(int actionKey, int instruction) {
 460         return new ActionBuilder().setAction(
 461                 new PopVlanActionCaseBuilder().setPopVlanAction(new PopVlanActionBuilder().build()).build())
 462                 .setKey(new ActionKey(actionKey)).build();
 463     }
 464
 465     public static Instruction buildAndGetWriteMetadaInstruction(BigInteger metadata,
 466                                                                 BigInteger mask, int instructionKey) {
 467         return new InstructionBuilder()
 468                 .setInstruction(
 469                         new WriteMetadataCaseBuilder().setWriteMetadata(
 470                                 new WriteMetadataBuilder().setMetadata(metadata).setMetadataMask(mask).build())
 471                                 .build()).setKey(new InstructionKey(instructionKey)).build();
 472     }
 473
 474     public static Instruction buildAndGetGotoTableInstruction(short tableId, int instructionKey) {
 475         return new InstructionBuilder()
 476             .setInstruction(
 477                 new GoToTableCaseBuilder().setGoToTable(
 478                     new GoToTableBuilder().setTableId(tableId).build()).build())
 479             .setKey(new InstructionKey(instructionKey)).build();
 480     }
 481
 482     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 483                                                           InstanceIdentifier<T> path, DataBroker broker) {
 484
 485         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 486
 487         Optional<T> result = Optional.absent();
 488         try {
 489             result = tx.read(datastoreType, path).get();
 490         } catch (Exception e) {
 491             logger.error("An error occured while reading data from the path {} with the exception {}", path, e);
 492         }
 493         return result;
 494     }
 495
 496     public static <T extends DataObject> Optional<T> read(DataBroker broker,
 497                                                           LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
 498
 499         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 500
 501         Optional<T> result = Optional.absent();
 502         try {
 503             result = tx.read(datastoreType, path).get();
 504         } catch (Exception e) {
 505             throw new RuntimeException(e);
 506         }
 507         return result;
 508     }
 509
 510     public static <T extends DataObject> void syncWrite(DataBroker broker,
 511                                                         LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
 512                                                         T data) {
 513         WriteTransaction tx = broker.newWriteOnlyTransaction();
 514         tx.put(datastoreType, path, data, true);
 515         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 516         try {
 517             futures.get();
 518         } catch (InterruptedException | ExecutionException e) {
 519             logger.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 520             throw new RuntimeException(e.getMessage());
 521         }
 522     }
 523
 524     public static <T extends DataObject> void syncUpdate(DataBroker broker,
 525                                                          LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
 526                                                          T data) {
 527         WriteTransaction tx = broker.newWriteOnlyTransaction();
 528         tx.merge(datastoreType, path, data, true);
 529         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 530         try {
 531             futures.get();
 532         } catch (InterruptedException | ExecutionException e) {
 533             logger.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 534             throw new RuntimeException(e.getMessage());
 535         }
 536     }
 537
 538     public static <T extends DataObject> void syncDelete(DataBroker broker,
 539                                                          LogicalDatastoreType datastoreType, InstanceIdentifier<T> obj) {
 540         WriteTransaction tx = broker.newWriteOnlyTransaction();
 541         tx.delete(datastoreType, obj);
 542         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 543         try {
 544             futures.get();
 545         } catch (InterruptedException | ExecutionException e) {
 546             logger.error("Error deleting from datastore (path) : ({})", obj);
 547             throw new RuntimeException(e.getMessage());
 548         }
 549     }
 550
 551     public static byte[] getMacAddressForNodeConnector(DataBroker broker,
 552             InstanceIdentifier<NodeConnector> nodeConnectorId)  {
 553         Optional<NodeConnector> optNc = MDSALDataStoreUtils.read(broker,
 554                 LogicalDatastoreType.OPERATIONAL, nodeConnectorId);
 555         if(optNc.isPresent()) {
 556             NodeConnector nc = optNc.get();
 557             FlowCapableNodeConnector fcnc = nc.getAugmentation(FlowCapableNodeConnector.class);
 558             MacAddress macAddress = fcnc.getHardwareAddress();
 559             return HexEncode.bytesFromHexString(macAddress.getValue());
 560         }
 561         return null;
 562     }
 563
 564     public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
 565         return new NodeId(ncId.getValue().substring(0,
 566                 ncId.getValue().lastIndexOf(":")));
 567     }
 568
 569     public static String getInterfaceName(NodeConnectorRef ref, DataBroker dataBroker) {
 570         NodeConnectorId nodeConnectorId = getNodeConnectorId(dataBroker, ref);
 571         NodeId nodeId = getNodeIdFromNodeConnectorId(nodeConnectorId);
 572         InstanceIdentifier<NodeConnector> ncIdentifier = InstanceIdentifier
 573                 .builder(Nodes.class)
 574                 .child(Node.class, new NodeKey(nodeId))
 575                 .child(NodeConnector.class,
 576                         new NodeConnectorKey(nodeConnectorId)).build();
 577
 578         Optional<NodeConnector> nodeConnectorOptional = read(
 579                 dataBroker,
 580                 LogicalDatastoreType.OPERATIONAL, ncIdentifier);
 581         if (!nodeConnectorOptional.isPresent()) {
 582             return null;
 583         }
 584         NodeConnector nc = nodeConnectorOptional.get();
 585         FlowCapableNodeConnector fc = nc
 586                 .getAugmentation(FlowCapableNodeConnector.class);
 587         return fc.getName();
 588     }
 589
 590     public static NodeConnectorId getNodeConnectorId(DataBroker dataBroker,
 591             NodeConnectorRef ref) {
 592         Optional<NodeConnector> nc = (Optional<NodeConnector>) read(
 593                 dataBroker,
 594                 LogicalDatastoreType.OPERATIONAL, ref.getValue());
 595         if(nc.isPresent()){
 596             return nc.get().getId();
 597         }
 598         return null;
 599     }
 600
 601     public static TransmitPacketInput getPacketOut(List<Action> actions, byte[] payload, BigInteger dpnId) {
 602         NodeConnectorRef ncRef = getDefaultNodeConnRef(dpnId);
 603         return new TransmitPacketInputBuilder()
 604                 .setAction(actions)
 605                 .setPayload(payload)
 606                 .setNode(
 607                         new NodeRef(InstanceIdentifier.builder(Nodes.class)
 608                                 .child(Node.class, new NodeKey(new NodeId("openflow:" + dpnId))).toInstance()))
 609                 .setIngress(ncRef).setEgress(ncRef).build();
 610     }
 611
 612 }
 613