1 package org.opendaylight.openflowplugin.openflow.md.util;
3 import com.google.common.collect.ImmutableBiMap;
4 import org.opendaylight.openflowjava.protocol.api.util.BinContent;
5 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
6 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortNumberUni;
7 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.OutputPortValues;
8 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumberValues;
9 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumberValuesV10;
12 * Class which integrates the port constants defined and used by MDSAL and the ports defined in openflow java
14 * This class is responsible for converting MDSAL given logical names to port numbers and back.
16 * Any newer version of openflow can have a similar mapping or can/should be extended.
18 * @author Kamal Rameshan on 5/2/14.
20 public class OpenflowPortsUtil {
22 static ImmutableBiMap<OpenflowVersion, ImmutableBiMap<String, Long>> versionPortMap;
24 static final String MAX = "MAX";
26 // the init gets called from MDController at the start
27 public static void init() {
30 final ImmutableBiMap<String, Long> OFv10 = new ImmutableBiMap.Builder<String, Long>()
31 .put(OutputPortValues.MAX.toString(), Long.valueOf(PortNumberValuesV10.MAX.getIntValue())) //0xff00
32 .put(OutputPortValues.INPORT.toString(), Long.valueOf(PortNumberValuesV10.INPORT.getIntValue())) //0xfff8
33 .put(OutputPortValues.TABLE.toString(), Long.valueOf(PortNumberValuesV10.TABLE.getIntValue())) //0xfff9
34 .put(OutputPortValues.NORMAL.toString(), Long.valueOf(PortNumberValuesV10.NORMAL.getIntValue())) //0xfffa
35 .put(OutputPortValues.FLOOD.toString(), Long.valueOf(PortNumberValuesV10.FLOOD.getIntValue())) //0xfffb
36 .put(OutputPortValues.ALL.toString(), Long.valueOf(PortNumberValuesV10.ALL.getIntValue())) //0xfffc
37 .put(OutputPortValues.CONTROLLER.toString(), Long.valueOf(PortNumberValuesV10.CONTROLLER.getIntValue())) //0xfffd
38 .put(OutputPortValues.LOCAL.toString(), Long.valueOf(PortNumberValuesV10.LOCAL.getIntValue())) //0xfffe
39 .put(OutputPortValues.NONE.toString(), Long.valueOf(PortNumberValuesV10.NONE.getIntValue())) //0xfffe
42 // openflow 1.3 reserved ports.
43 // PortNumberValues are defined in OFJava yang. And yang maps an int to all enums. Hence we need to create longs from (-ve) ints
44 // TODO: do we need to define these ports in yang?
45 final ImmutableBiMap<String, Long> OFv13 = new ImmutableBiMap.Builder<String, Long>()
46 .put(OutputPortValues.MAX.toString(), BinContent.intToUnsignedLong(PortNumberValues.MAX.getIntValue())) //0xffffff00
47 .put(OutputPortValues.INPORT.toString(), BinContent.intToUnsignedLong(PortNumberValues.INPORT.getIntValue())) //0xfffffff8
48 .put(OutputPortValues.TABLE.toString(), BinContent.intToUnsignedLong(PortNumberValues.TABLE.getIntValue())) //0xfffffff9
49 .put(OutputPortValues.NORMAL.toString(), BinContent.intToUnsignedLong(PortNumberValues.NORMAL.getIntValue())) //0xfffffffa
50 .put(OutputPortValues.FLOOD.toString(), BinContent.intToUnsignedLong(PortNumberValues.FLOOD.getIntValue())) //0xfffffffb
51 .put(OutputPortValues.ALL.toString(), BinContent.intToUnsignedLong(PortNumberValues.ALL.getIntValue())) //0xfffffffc
52 .put(OutputPortValues.CONTROLLER.toString(), BinContent.intToUnsignedLong(PortNumberValues.CONTROLLER.getIntValue())) //0xfffffffd
53 .put(OutputPortValues.LOCAL.toString(), BinContent.intToUnsignedLong(PortNumberValues.LOCAL.getIntValue())) //0xfffffffe
54 .put(OutputPortValues.ANY.toString(), BinContent.intToUnsignedLong(PortNumberValues.ANY.getIntValue())) //0xffffffff
57 versionPortMap = new ImmutableBiMap.Builder<OpenflowVersion, ImmutableBiMap<String, Long>>()
58 .put(OpenflowVersion.OF10, OFv10)
59 .put(OpenflowVersion.OF13, OFv13)
64 public static void close() {
65 versionPortMap = null;
68 public static String getPortLogicalName(final short ofVersion, final long portNumber) {
69 return versionPortMap.get(OpenflowVersion.get(ofVersion)).inverse().get(portNumber);
72 public static String getPortLogicalName(final OpenflowVersion ofVersion, final Long portNumber) {
73 if (ofVersion.equals(OpenflowVersion.UNSUPPORTED)){
76 return versionPortMap.get(ofVersion).inverse().get(portNumber);
79 public static Long getPortFromLogicalName(final OpenflowVersion ofVersion, final String logicalNameOrPort) {
80 Long port = versionPortMap.get(ofVersion).get(logicalNameOrPort);
83 port = Long.decode(logicalNameOrPort);
84 } catch(final NumberFormatException ne) {
85 //ignore, sent null back.
91 public static PortNumberUni getProtocolAgnosticPort(final OpenflowVersion ofVersion, final Long portNumber) {
92 final String reservedPortLogicalName = getPortLogicalName(ofVersion, portNumber);
93 return (reservedPortLogicalName == null ? new PortNumberUni(portNumber) :
94 new PortNumberUni(reservedPortLogicalName));
97 public static Long getProtocolPortNumber(final OpenflowVersion ofVersion, final PortNumberUni port) {
98 final String portLogicalName = port.getString();
100 if (portLogicalName != null) {
101 return versionPortMap.get(ofVersion).get(portLogicalName);
103 return port.getUint32();
107 public static Long getMaxPortForVersion(final OpenflowVersion ofVersion) {
108 return getPortFromLogicalName (ofVersion, MAX);
111 public static boolean isPortReserved(final OpenflowVersion ofVersion, final Long portNumber) {
112 return versionPortMap.get(ofVersion).inverse().containsKey(portNumber);
118 * @return true if port number is valid for given protocol version
120 public static boolean checkPortValidity(final OpenflowVersion ofVersion, final Long portNumber) {
121 boolean portIsValid = true;
122 if (portNumber == null) {
124 } else if (portNumber < 0) {
126 } else if (portNumber > OpenflowPortsUtil.getMaxPortForVersion(ofVersion)) {
127 if (!OpenflowPortsUtil.isPortReserved(ofVersion, portNumber)) {
136 * @return string containing number or logical name
138 public static String portNumberToString(final PortNumberUni portNumber) {
139 String result = null;
140 if (portNumber.getUint32() != null) {
141 result = String.valueOf(portNumber.getUint32());
142 } else if (portNumber.getString() != null) {
143 result = portNumber.getString();