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