blob: 92d487865032c5bf2e7a4a2f3490e9739652a745 [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 Laneeb21c4f2013-10-28 17:34:41 -070025import org.projectfloodlight.openflow.types.VRF;
Andreas Wundsam98a18632013-11-05 11:34:24 -080026import org.projectfloodlight.openflow.types.VlanPcp;
Yotam Harcholf3f11152013-09-05 16:47:16 -070027
28@SuppressWarnings("unchecked")
29public class MatchField<F extends OFValueType<F>> {
30 private final String name;
31 public final MatchFields id;
32 private final Prerequisite<?>[] prerequisites;
33
34 private MatchField(final String name, final MatchFields id, Prerequisite<?>... prerequisites) {
35 this.name = name;
36 this.id = id;
37 this.prerequisites = prerequisites;
38 }
39
40 public final static MatchField<OFPort> IN_PORT =
41 new MatchField<OFPort>("in_port", MatchFields.IN_PORT);
42
43 public final static MatchField<OFPort> IN_PHY_PORT =
44 new MatchField<OFPort>("in_phy_port", MatchFields.IN_PHY_PORT,
45 new Prerequisite<OFPort>(MatchField.IN_PORT));
46
47 public final static MatchField<OFMetadata> METADATA =
48 new MatchField<OFMetadata>("metadata", MatchFields.METADATA);
49
50 public final static MatchField<MacAddress> ETH_DST =
51 new MatchField<MacAddress>("eth_dst", MatchFields.ETH_DST);
52
53 public final static MatchField<MacAddress> ETH_SRC =
54 new MatchField<MacAddress>("eth_src", MatchFields.ETH_SRC);
55
56 public final static MatchField<EthType> ETH_TYPE =
57 new MatchField<EthType>("eth_type", MatchFields.ETH_TYPE);
58
Andreas Wundsam98a18632013-11-05 11:34:24 -080059 public final static MatchField<OFVlanVidMatch> VLAN_VID =
60 new MatchField<OFVlanVidMatch>("vlan_vid", MatchFields.VLAN_VID);
Yotam Harcholf3f11152013-09-05 16:47:16 -070061
62 public final static MatchField<VlanPcp> VLAN_PCP =
63 new MatchField<VlanPcp>("vlan_pcp", MatchFields.VLAN_PCP,
Andreas Wundsam98a18632013-11-05 11:34:24 -080064 new Prerequisite<OFVlanVidMatch>(MatchField.VLAN_VID));
Yotam Harcholf3f11152013-09-05 16:47:16 -070065
66 public final static MatchField<IpDscp> IP_DSCP =
67 new MatchField<IpDscp>("ip_dscp", MatchFields.IP_DSCP,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070068 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070069
70 public final static MatchField<IpEcn> IP_ECN =
71 new MatchField<IpEcn>("ip_dscp", MatchFields.IP_ECN,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070072 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070073
74 public final static MatchField<IpProtocol> IP_PROTO =
75 new MatchField<IpProtocol>("ip_proto", MatchFields.IP_PROTO,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070076 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070077
Yotam Harchola289d552013-09-16 10:10:40 -070078 public final static MatchField<IPv4Address> IPV4_SRC =
79 new MatchField<IPv4Address>("ipv4_src", MatchFields.IPV4_SRC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070080 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4));
Yotam Harcholf3f11152013-09-05 16:47:16 -070081
Yotam Harchola289d552013-09-16 10:10:40 -070082 public final static MatchField<IPv4Address> IPV4_DST =
83 new MatchField<IPv4Address>("ipv4_dst", MatchFields.IPV4_DST,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070084 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4));
Yotam Harcholf3f11152013-09-05 16:47:16 -070085
86 public final static MatchField<TransportPort> TCP_SRC = new MatchField<TransportPort>(
87 "tcp_src", MatchFields.TCP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -070088 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.TCP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070089
90 public final static MatchField<TransportPort> TCP_DST = new MatchField<TransportPort>(
91 "tcp_dst", MatchFields.TCP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -070092 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.TCP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070093
94 public final static MatchField<TransportPort> UDP_SRC = new MatchField<TransportPort>(
95 "udp_src", MatchFields.UDP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -070096 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.UDP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070097
98 public final static MatchField<TransportPort> UDP_DST = new MatchField<TransportPort>(
99 "udp_dst", MatchFields.UDP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700100 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.UDP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700101
102 public final static MatchField<TransportPort> SCTP_SRC = new MatchField<TransportPort>(
103 "sctp_src", MatchFields.SCTP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700104 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.SCTP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700105
106 public final static MatchField<TransportPort> SCTP_DST = new MatchField<TransportPort>(
107 "sctp_dst", MatchFields.SCTP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700108 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.SCTP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700109
110 public final static MatchField<ICMPv4Type> ICMPV4_TYPE = new MatchField<ICMPv4Type>(
111 "icmpv4_src", MatchFields.ICMPV4_TYPE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700112 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.ICMP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700113
114 public final static MatchField<ICMPv4Code> ICMPV4_CODE = new MatchField<ICMPv4Code>(
115 "icmpv4_dst", MatchFields.ICMPV4_CODE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700116 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.ICMP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700117
118 public final static MatchField<ArpOpcode> ARP_OP = new MatchField<ArpOpcode>(
119 "arp_op", MatchFields.ARP_OP,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700120 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700121
Yotam Harchola289d552013-09-16 10:10:40 -0700122 public final static MatchField<IPv4Address> ARP_SPA =
123 new MatchField<IPv4Address>("arp_spa", MatchFields.ARP_SPA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700124 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700125
Yotam Harchola289d552013-09-16 10:10:40 -0700126 public final static MatchField<IPv4Address> ARP_TPA =
127 new MatchField<IPv4Address>("arp_tpa", MatchFields.ARP_TPA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700128 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700129
130 public final static MatchField<MacAddress> ARP_SHA =
131 new MatchField<MacAddress>("arp_sha", MatchFields.ARP_SHA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700132 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700133
134 public final static MatchField<MacAddress> ARP_THA =
135 new MatchField<MacAddress>("arp_tha", MatchFields.ARP_THA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700136 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700137
Yotam Harchola289d552013-09-16 10:10:40 -0700138 public final static MatchField<IPv6Address> IPV6_SRC =
139 new MatchField<IPv6Address>("ipv6_src", MatchFields.IPV6_SRC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700140 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700141
Yotam Harchola289d552013-09-16 10:10:40 -0700142 public final static MatchField<IPv6Address> IPV6_DST =
143 new MatchField<IPv6Address>("ipv6_dst", MatchFields.IPV6_DST,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700144 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700145
146 public final static MatchField<IPv6FlowLabel> IPV6_FLABEL =
147 new MatchField<IPv6FlowLabel>("ipv6_flabel", MatchFields.IPV6_FLABEL,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700148 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700149
Yotam Harchola86e4252013-09-06 15:36:28 -0700150 public final static MatchField<U8> ICMPV6_TYPE =
151 new MatchField<U8>("icmpv6_type", MatchFields.ICMPV6_TYPE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700152 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.IPv6_ICMP));
Yotam Harchola86e4252013-09-06 15:36:28 -0700153
154 public final static MatchField<U8> ICMPV6_CODE =
155 new MatchField<U8>("icmpv6_code", MatchFields.ICMPV6_CODE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700156 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.IPv6_ICMP));
Yotam Harchola86e4252013-09-06 15:36:28 -0700157
Yotam Harchola289d552013-09-16 10:10:40 -0700158 public final static MatchField<IPv6Address> IPV6_ND_TARGET =
159 new MatchField<IPv6Address>("ipv6_nd_target", MatchFields.IPV6_ND_TARGET,
Yotam Harchola86e4252013-09-06 15:36:28 -0700160 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)135), U8.of((short)136)));
161
162 public final static MatchField<MacAddress> IPV6_ND_SLL =
163 new MatchField<MacAddress>("ipv6_nd_sll", MatchFields.IPV6_ND_SLL,
164 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)135)));
165
166 public final static MatchField<MacAddress> IPV6_ND_TLL =
167 new MatchField<MacAddress>("ipv6_nd_tll", MatchFields.IPV6_ND_TLL,
168 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)136)));
169
170 public final static MatchField<U32> MPLS_LABEL =
171 new MatchField<U32>("mpls_label", MatchFields.MPLS_LABEL,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700172 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.MPLS_UNICAST, EthType.MPLS_MULTICAST));
Yotam Harchola86e4252013-09-06 15:36:28 -0700173
174 public final static MatchField<U8> MPLS_TC =
175 new MatchField<U8>("mpls_tc", MatchFields.MPLS_TC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700176 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.MPLS_UNICAST, EthType.MPLS_MULTICAST));
Yotam Harchola86e4252013-09-06 15:36:28 -0700177
Yotam Harchol2c535582013-10-01 15:50:20 -0700178 public final static MatchField<OFBitMask128> BSN_IN_PORTS_128 =
179 new MatchField<OFBitMask128>("bsn_in_port_masked_128", MatchFields.BSN_IN_PORTS_128);
Yotam Harchola11f38b2013-09-26 15:38:17 -0700180
Rich Lane376cafe2013-10-27 21:49:14 -0700181 public final static MatchField<LagId> BSN_LAG_ID =
182 new MatchField<LagId>("bsn_lag_id", MatchFields.BSN_LAG_ID);
Rich Lane1424d0b2013-10-24 17:16:24 -0700183
Rich Laneeb21c4f2013-10-28 17:34:41 -0700184 public final static MatchField<VRF> BSN_VRF =
185 new MatchField<VRF>("bsn_vrf", MatchFields.BSN_VRF);
186
Rich Lane9c27b5d2013-10-30 17:14:32 -0700187 public final static MatchField<OFBooleanValue> BSN_GLOBAL_VRF_ALLOWED =
188 new MatchField<OFBooleanValue>("bsn_global_vrf_allowed", MatchFields.BSN_GLOBAL_VRF_ALLOWED);
Rich Laneeb21c4f2013-10-28 17:34:41 -0700189
190 public final static MatchField<ClassId> BSN_L3_INTERFACE_CLASS_ID =
191 new MatchField<ClassId>("bsn_l3_interface_class_id", MatchFields.BSN_L3_INTERFACE_CLASS_ID);
192
193 public final static MatchField<ClassId> BSN_L3_SRC_CLASS_ID =
194 new MatchField<ClassId>("bsn_l3_src_class_id", MatchFields.BSN_L3_SRC_CLASS_ID);
195
196 public final static MatchField<ClassId> BSN_L3_DST_CLASS_ID =
197 new MatchField<ClassId>("bsn_l3_dst_class_id", MatchFields.BSN_L3_DST_CLASS_ID);
198
Yotam Harcholf3f11152013-09-05 16:47:16 -0700199 public String getName() {
200 return name;
201 }
202
203 public boolean arePrerequisitesOK(Match match) {
204 for (Prerequisite<?> p : this.prerequisites) {
205 if (!p.isSatisfied(match)) {
206 return false;
207 }
208 }
209 return true;
210 }
211
212}