blob: aebcbb2afb41544fde556f2309f7d860b38aac97 [file] [log] [blame]
Yotam Harcholf3f11152013-09-05 16:47:16 -07001package org.projectfloodlight.openflow.protocol.match;
2
3import org.projectfloodlight.openflow.types.ArpOpcode;
Rich Laneeb21c4f2013-10-28 17:34:41 -07004import org.projectfloodlight.openflow.types.ClassId;
Yotam Harcholf3f11152013-09-05 16:47:16 -07005import org.projectfloodlight.openflow.types.EthType;
6import org.projectfloodlight.openflow.types.ICMPv4Code;
7import org.projectfloodlight.openflow.types.ICMPv4Type;
Yotam Harchola289d552013-09-16 10:10:40 -07008import org.projectfloodlight.openflow.types.IPv4Address;
9import org.projectfloodlight.openflow.types.IPv6Address;
Yotam Harcholf3f11152013-09-05 16:47:16 -070010import org.projectfloodlight.openflow.types.IPv6FlowLabel;
11import org.projectfloodlight.openflow.types.IpDscp;
12import org.projectfloodlight.openflow.types.IpEcn;
13import org.projectfloodlight.openflow.types.IpProtocol;
Rich Lane376cafe2013-10-27 21:49:14 -070014import org.projectfloodlight.openflow.types.LagId;
Yotam Harcholf3f11152013-09-05 16:47:16 -070015import org.projectfloodlight.openflow.types.MacAddress;
Andreas Wundsam520c8802013-10-08 22:05:23 -070016import org.projectfloodlight.openflow.types.OFBitMask128;
Rich Lane9c27b5d2013-10-30 17:14:32 -070017import org.projectfloodlight.openflow.types.OFBooleanValue;
Yotam Harcholf3f11152013-09-05 16:47:16 -070018import org.projectfloodlight.openflow.types.OFMetadata;
19import org.projectfloodlight.openflow.types.OFPort;
20import org.projectfloodlight.openflow.types.OFValueType;
Andreas Wundsam98a18632013-11-05 11:34:24 -080021import org.projectfloodlight.openflow.types.OFVlanVidMatch;
Yotam Harcholf3f11152013-09-05 16:47:16 -070022import org.projectfloodlight.openflow.types.TransportPort;
Yotam Harchola86e4252013-09-06 15:36:28 -070023import org.projectfloodlight.openflow.types.U32;
24import org.projectfloodlight.openflow.types.U8;
Rich Lane53ddf5c2014-03-20 15:24:08 -070025import org.projectfloodlight.openflow.types.UDF;
Rich Laneeb21c4f2013-10-28 17:34:41 -070026import org.projectfloodlight.openflow.types.VRF;
Andreas Wundsam98a18632013-11-05 11:34:24 -080027import org.projectfloodlight.openflow.types.VlanPcp;
Yotam Harcholf3f11152013-09-05 16:47:16 -070028
29@SuppressWarnings("unchecked")
30public class MatchField<F extends OFValueType<F>> {
31 private final String name;
32 public final MatchFields id;
33 private final Prerequisite<?>[] prerequisites;
34
35 private MatchField(final String name, final MatchFields id, Prerequisite<?>... prerequisites) {
36 this.name = name;
37 this.id = id;
38 this.prerequisites = prerequisites;
39 }
40
41 public final static MatchField<OFPort> IN_PORT =
42 new MatchField<OFPort>("in_port", MatchFields.IN_PORT);
43
44 public final static MatchField<OFPort> IN_PHY_PORT =
45 new MatchField<OFPort>("in_phy_port", MatchFields.IN_PHY_PORT,
46 new Prerequisite<OFPort>(MatchField.IN_PORT));
47
48 public final static MatchField<OFMetadata> METADATA =
49 new MatchField<OFMetadata>("metadata", MatchFields.METADATA);
50
51 public final static MatchField<MacAddress> ETH_DST =
52 new MatchField<MacAddress>("eth_dst", MatchFields.ETH_DST);
53
54 public final static MatchField<MacAddress> ETH_SRC =
55 new MatchField<MacAddress>("eth_src", MatchFields.ETH_SRC);
56
57 public final static MatchField<EthType> ETH_TYPE =
58 new MatchField<EthType>("eth_type", MatchFields.ETH_TYPE);
59
Andreas Wundsam98a18632013-11-05 11:34:24 -080060 public final static MatchField<OFVlanVidMatch> VLAN_VID =
61 new MatchField<OFVlanVidMatch>("vlan_vid", MatchFields.VLAN_VID);
Yotam Harcholf3f11152013-09-05 16:47:16 -070062
63 public final static MatchField<VlanPcp> VLAN_PCP =
64 new MatchField<VlanPcp>("vlan_pcp", MatchFields.VLAN_PCP,
Andreas Wundsam98a18632013-11-05 11:34:24 -080065 new Prerequisite<OFVlanVidMatch>(MatchField.VLAN_VID));
Yotam Harcholf3f11152013-09-05 16:47:16 -070066
67 public final static MatchField<IpDscp> IP_DSCP =
68 new MatchField<IpDscp>("ip_dscp", MatchFields.IP_DSCP,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070069 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070070
71 public final static MatchField<IpEcn> IP_ECN =
Ronald Li8083dfa2013-11-20 15:00:05 -080072 new MatchField<IpEcn>("ip_ecn", MatchFields.IP_ECN,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070073 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070074
75 public final static MatchField<IpProtocol> IP_PROTO =
76 new MatchField<IpProtocol>("ip_proto", MatchFields.IP_PROTO,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070077 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070078
Yotam Harchola289d552013-09-16 10:10:40 -070079 public final static MatchField<IPv4Address> IPV4_SRC =
80 new MatchField<IPv4Address>("ipv4_src", MatchFields.IPV4_SRC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070081 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4));
Yotam Harcholf3f11152013-09-05 16:47:16 -070082
Yotam Harchola289d552013-09-16 10:10:40 -070083 public final static MatchField<IPv4Address> IPV4_DST =
84 new MatchField<IPv4Address>("ipv4_dst", MatchFields.IPV4_DST,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070085 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4));
Yotam Harcholf3f11152013-09-05 16:47:16 -070086
87 public final static MatchField<TransportPort> TCP_SRC = new MatchField<TransportPort>(
88 "tcp_src", MatchFields.TCP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -070089 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.TCP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070090
91 public final static MatchField<TransportPort> TCP_DST = new MatchField<TransportPort>(
92 "tcp_dst", MatchFields.TCP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -070093 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.TCP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070094
95 public final static MatchField<TransportPort> UDP_SRC = new MatchField<TransportPort>(
96 "udp_src", MatchFields.UDP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -070097 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.UDP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070098
99 public final static MatchField<TransportPort> UDP_DST = new MatchField<TransportPort>(
100 "udp_dst", MatchFields.UDP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700101 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.UDP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700102
103 public final static MatchField<TransportPort> SCTP_SRC = new MatchField<TransportPort>(
104 "sctp_src", MatchFields.SCTP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700105 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.SCTP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700106
107 public final static MatchField<TransportPort> SCTP_DST = new MatchField<TransportPort>(
108 "sctp_dst", MatchFields.SCTP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700109 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.SCTP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700110
111 public final static MatchField<ICMPv4Type> ICMPV4_TYPE = new MatchField<ICMPv4Type>(
Ronald Lid7a63f02013-11-20 15:49:33 -0800112 "icmpv4_type", MatchFields.ICMPV4_TYPE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700113 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.ICMP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700114
115 public final static MatchField<ICMPv4Code> ICMPV4_CODE = new MatchField<ICMPv4Code>(
Ronald Lid7a63f02013-11-20 15:49:33 -0800116 "icmpv4_code", MatchFields.ICMPV4_CODE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700117 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.ICMP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700118
119 public final static MatchField<ArpOpcode> ARP_OP = new MatchField<ArpOpcode>(
120 "arp_op", MatchFields.ARP_OP,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700121 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700122
Yotam Harchola289d552013-09-16 10:10:40 -0700123 public final static MatchField<IPv4Address> ARP_SPA =
124 new MatchField<IPv4Address>("arp_spa", MatchFields.ARP_SPA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700125 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700126
Yotam Harchola289d552013-09-16 10:10:40 -0700127 public final static MatchField<IPv4Address> ARP_TPA =
128 new MatchField<IPv4Address>("arp_tpa", MatchFields.ARP_TPA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700129 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700130
131 public final static MatchField<MacAddress> ARP_SHA =
132 new MatchField<MacAddress>("arp_sha", MatchFields.ARP_SHA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700133 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700134
135 public final static MatchField<MacAddress> ARP_THA =
136 new MatchField<MacAddress>("arp_tha", MatchFields.ARP_THA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700137 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700138
Yotam Harchola289d552013-09-16 10:10:40 -0700139 public final static MatchField<IPv6Address> IPV6_SRC =
140 new MatchField<IPv6Address>("ipv6_src", MatchFields.IPV6_SRC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700141 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700142
Yotam Harchola289d552013-09-16 10:10:40 -0700143 public final static MatchField<IPv6Address> IPV6_DST =
144 new MatchField<IPv6Address>("ipv6_dst", MatchFields.IPV6_DST,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700145 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700146
147 public final static MatchField<IPv6FlowLabel> IPV6_FLABEL =
148 new MatchField<IPv6FlowLabel>("ipv6_flabel", MatchFields.IPV6_FLABEL,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700149 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700150
Yotam Harchola86e4252013-09-06 15:36:28 -0700151 public final static MatchField<U8> ICMPV6_TYPE =
152 new MatchField<U8>("icmpv6_type", MatchFields.ICMPV6_TYPE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700153 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.IPv6_ICMP));
Yotam Harchola86e4252013-09-06 15:36:28 -0700154
155 public final static MatchField<U8> ICMPV6_CODE =
156 new MatchField<U8>("icmpv6_code", MatchFields.ICMPV6_CODE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700157 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.IPv6_ICMP));
Yotam Harchola86e4252013-09-06 15:36:28 -0700158
Yotam Harchola289d552013-09-16 10:10:40 -0700159 public final static MatchField<IPv6Address> IPV6_ND_TARGET =
160 new MatchField<IPv6Address>("ipv6_nd_target", MatchFields.IPV6_ND_TARGET,
Yotam Harchola86e4252013-09-06 15:36:28 -0700161 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)135), U8.of((short)136)));
162
163 public final static MatchField<MacAddress> IPV6_ND_SLL =
164 new MatchField<MacAddress>("ipv6_nd_sll", MatchFields.IPV6_ND_SLL,
165 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)135)));
166
167 public final static MatchField<MacAddress> IPV6_ND_TLL =
168 new MatchField<MacAddress>("ipv6_nd_tll", MatchFields.IPV6_ND_TLL,
169 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)136)));
170
171 public final static MatchField<U32> MPLS_LABEL =
172 new MatchField<U32>("mpls_label", MatchFields.MPLS_LABEL,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700173 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.MPLS_UNICAST, EthType.MPLS_MULTICAST));
Yotam Harchola86e4252013-09-06 15:36:28 -0700174
175 public final static MatchField<U8> MPLS_TC =
176 new MatchField<U8>("mpls_tc", MatchFields.MPLS_TC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700177 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.MPLS_UNICAST, EthType.MPLS_MULTICAST));
Yotam Harchola86e4252013-09-06 15:36:28 -0700178
Yotam Harchol2c535582013-10-01 15:50:20 -0700179 public final static MatchField<OFBitMask128> BSN_IN_PORTS_128 =
Ronald Lia07b2572013-11-18 13:54:08 -0800180 new MatchField<OFBitMask128>("bsn_in_ports_128", MatchFields.BSN_IN_PORTS_128);
Yotam Harchola11f38b2013-09-26 15:38:17 -0700181
Rich Lane376cafe2013-10-27 21:49:14 -0700182 public final static MatchField<LagId> BSN_LAG_ID =
183 new MatchField<LagId>("bsn_lag_id", MatchFields.BSN_LAG_ID);
Rich Lane1424d0b2013-10-24 17:16:24 -0700184
Rich Laneeb21c4f2013-10-28 17:34:41 -0700185 public final static MatchField<VRF> BSN_VRF =
186 new MatchField<VRF>("bsn_vrf", MatchFields.BSN_VRF);
187
Rich Lane9c27b5d2013-10-30 17:14:32 -0700188 public final static MatchField<OFBooleanValue> BSN_GLOBAL_VRF_ALLOWED =
189 new MatchField<OFBooleanValue>("bsn_global_vrf_allowed", MatchFields.BSN_GLOBAL_VRF_ALLOWED);
Rich Laneeb21c4f2013-10-28 17:34:41 -0700190
191 public final static MatchField<ClassId> BSN_L3_INTERFACE_CLASS_ID =
192 new MatchField<ClassId>("bsn_l3_interface_class_id", MatchFields.BSN_L3_INTERFACE_CLASS_ID);
193
194 public final static MatchField<ClassId> BSN_L3_SRC_CLASS_ID =
195 new MatchField<ClassId>("bsn_l3_src_class_id", MatchFields.BSN_L3_SRC_CLASS_ID);
196
197 public final static MatchField<ClassId> BSN_L3_DST_CLASS_ID =
198 new MatchField<ClassId>("bsn_l3_dst_class_id", MatchFields.BSN_L3_DST_CLASS_ID);
199
Rich Lane917bb9a2014-03-11 17:49:56 -0700200 public final static MatchField<ClassId> BSN_EGR_PORT_GROUP_ID =
201 new MatchField<ClassId>("bsn_egr_port_group_id", MatchFields.BSN_EGR_PORT_GROUP_ID);
202
Rich Lane53ddf5c2014-03-20 15:24:08 -0700203 public final static MatchField<UDF> BSN_UDF0 =
204 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF0);
205
206 public final static MatchField<UDF> BSN_UDF1 =
207 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF1);
208
209 public final static MatchField<UDF> BSN_UDF2 =
210 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF2);
211
212 public final static MatchField<UDF> BSN_UDF3 =
213 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF3);
214
215 public final static MatchField<UDF> BSN_UDF4 =
216 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF4);
217
218 public final static MatchField<UDF> BSN_UDF5 =
219 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF5);
220
221 public final static MatchField<UDF> BSN_UDF6 =
222 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF6);
223
224 public final static MatchField<UDF> BSN_UDF7 =
225 new MatchField<UDF>("bsn_udf", MatchFields.BSN_UDF7);
226
Yotam Harcholf3f11152013-09-05 16:47:16 -0700227 public String getName() {
228 return name;
229 }
230
231 public boolean arePrerequisitesOK(Match match) {
232 for (Prerequisite<?> p : this.prerequisites) {
233 if (!p.isSatisfied(match)) {
234 return false;
235 }
236 }
237 return true;
238 }
239
240}