2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.sal.match;
11 import java.net.Inet6Address;
12 import java.net.InetAddress;
13 import java.util.Arrays;
15 import org.opendaylight.controller.sal.core.NodeConnector;
16 import org.opendaylight.controller.sal.utils.HexEncode;
17 import org.opendaylight.controller.sal.utils.NetUtils;
20 * Represents the binding between the id, the value and mask type and the range
21 * values of the elements type that can be matched on the network
22 * frame/packet/message
24 public enum MatchType {
25 IN_PORT("inPort", 1 << 0, NodeConnector.class, 1, 0),
26 DL_SRC("dlSrc", 1 << 1, Byte[].class, 0, 0xffffffffffffL),
27 DL_DST("dlDst", 1 << 2, Byte[].class, 0, 0xffffffffffffL),
28 DL_VLAN("dlVlan", 1 << 3, Short.class, 1, 0xfff), // 2 bytes
29 DL_VLAN_PR("dlVlanPriority", 1 << 4, Byte.class, 0, 0x7), // 3 bits
30 DL_OUTER_VLAN("dlOuterVlan", 1 << 5, Short.class, 1, 0xfff),
31 DL_OUTER_VLAN_PR("dlOuterVlanPriority", 1 << 6, Short.class, 0, 0x7),
32 DL_TYPE("dlType", 1 << 7, Short.class, 0, 0xffff), // 2 bytes
33 NW_TOS("nwTOS", 1 << 8, Byte.class, 0, 0x3f), // 6 bits (DSCP field)
34 NW_PROTO("nwProto", 1 << 9, Byte.class, 0, 0xff), // 1 byte
35 NW_SRC("nwSrc", 1 << 10, InetAddress.class, 0, 0),
36 NW_DST("nwDst", 1 << 11, InetAddress.class, 0, 0),
37 TP_SRC("tpSrc", 1 << 12, Short.class, 1, 0xffff), // 2 bytes
38 TP_DST("tpDst", 1 << 13, Short.class, 1, 0xffff); // 2 bytes
42 private Class<?> dataType;
43 private long minValue;
44 private long maxValue;
46 private MatchType(String id, int index, Class<?> dataType, long minValue, long maxValue) {
49 this.dataType = dataType;
50 this.minValue = minValue;
51 this.maxValue = maxValue;
58 public int getIndex() {
62 public Class<?> dataType() {
66 public String getRange() {
67 return "[0x" + Long.toHexString(minValue) + "-0x" + Long.toHexString(maxValue) + "]";
71 * Perform the assignment type validation
77 public boolean isCongruentType(Object value, Object mask) {
78 // Mask type has to match value type
79 if (mask != null && (mask.getClass() != value.getClass())) {
83 Class<?> e = this.dataType();
84 Class<?> g = value.getClass();
86 // This is all what we need, if value type is same of match required
92 // This is for the numeric class vs primitive congruence
93 // For what concerns here, for instance, Integer is congruent to int
94 if (e == Short.class) {
95 return g.equals(short.class);
98 if (e == Integer.class) {
99 return g.equals(int.class);
102 if (e == Byte.class) {
103 return g.equals(byte.class);
106 if (e == Byte[].class) {
107 return g.equals(byte[].class);
110 if (e == InetAddress.class) {
111 return g.getSuperclass().equals(InetAddress.class);
117 * Perform the value and mask range validation
123 public boolean isValid(Object value, Object mask) {
124 // Skip if main error
125 if (mask != null && (mask.getClass() != value.getClass())) {
128 // For the complex below types let's skip the value range check for now
129 if (this.dataType == InetAddress.class) {
132 if (this.dataType() == Byte[].class) {
135 if (this.dataType() == NodeConnector.class) {
141 if (value.getClass() == Integer.class || value.getClass() == int.class) {
142 val = ((Integer) value).intValue();
143 msk = (mask != null) ? ((Integer) mask).intValue() : 0;
145 } else if (value.getClass() == Short.class || value.getClass() == short.class) {
146 val = ((Short) value).intValue() & 0xffff;
147 msk = (mask != null) ? ((Short) mask).intValue() & 0xffff : 0;
149 } else if (value.getClass() == Byte.class || value.getClass() == byte.class) {
150 val = ((Byte) value).intValue() & 0xff;
151 msk = (mask != null) ? ((Byte) mask).intValue() & 0xff : 0;
153 return ((val >= minValue && val <= maxValue) && (mask == null || (msk >= minValue && msk <= maxValue)));
158 * Return the mask value in 64 bits bitmask form
163 public long getBitMask(Object mask) {
164 if (this.dataType == InetAddress.class) {
165 // TODO handle Inet v4 and v6 v6 will have a second upper mask
168 if (this.dataType() == Byte[].class) {
170 return 0xffffffffffffL;
172 byte mac[] = (byte[]) mask;
174 for (short i = 0; i < 6; i++) {
175 bitmask |= ((mac[i] & 0xffL) << ((5 - i) * 8));
179 if (this.dataType == Integer.class || this.dataType == int.class) {
180 return (mask == null) ? this.maxValue : ((Integer) mask).longValue();
183 if (this.dataType == Short.class || this.dataType == short.class) {
184 return (mask == null) ? this.maxValue : ((Short) mask).longValue();
186 if (this.dataType == Byte.class || this.dataType == byte.class) {
187 return (mask == null) ? this.maxValue : ((Byte) mask).longValue();
193 public String stringify(Object value) {
201 return HexEncode.bytesToHexStringFormat((byte[]) value);
204 return ((Integer) NetUtils.getUnsignedShort((Short) value)).toString();
207 return ((InetAddress) value).getHostAddress();
209 return ((Integer) NetUtils.getUnsignedByte((Byte) value)).toString();
212 return ((Integer) NetUtils.getUnsignedShort((Short) value)).toString();
216 return value.toString();
219 public int valueHashCode(Object o) {
226 return NetUtils.byteArray4ToInt((byte[])o);
232 public int hashCode(Object v, Object m) {
233 final int prime = 31;
235 result = prime * result + this.hashCode();
240 result = prime * result + ((v == null)? 0 : NetUtils.byteArray4ToInt((byte[])v));
241 result = prime * result + ((m == null)? 0 : NetUtils.byteArray4ToInt((byte[])m));
245 result = prime * result + ((v == null)? 0 : v.hashCode());
246 result = prime * result + ((m == null)? NetUtils.gethighestIP(v instanceof Inet6Address).hashCode() : m.hashCode());
249 result = prime * result + ((v == null)? 0 : v.hashCode());
250 result = prime * result + ((m == null)? 0 : m.hashCode());
254 public boolean equalValues(Object a, Object b) {
258 if (a == null || b == null) {
264 return Arrays.equals((byte[]) a, (byte[]) b);
270 public boolean equalMasks(Object a, Object b) {
278 * For network address mask, network node may return full mask for
279 * flows the controller generated with a null mask object
281 byte maskBytes[] = null;
283 maskBytes = ((InetAddress) b).getAddress();
284 } else if (b == null) {
285 maskBytes = ((InetAddress) a).getAddress();
287 if (maskBytes != null) {
288 return (NetUtils.getSubnetMaskLength(maskBytes) == 0);