blob: ecced0618408d4e32bd3e0978d6018187bb4cb6d [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;
Yotam Harcholf3f11152013-09-05 16:47:16 -070017import org.projectfloodlight.openflow.types.OFMetadata;
18import org.projectfloodlight.openflow.types.OFPort;
19import org.projectfloodlight.openflow.types.OFValueType;
20import org.projectfloodlight.openflow.types.TransportPort;
Yotam Harchola86e4252013-09-06 15:36:28 -070021import org.projectfloodlight.openflow.types.U32;
22import org.projectfloodlight.openflow.types.U8;
Yotam Harcholf3f11152013-09-05 16:47:16 -070023import org.projectfloodlight.openflow.types.VlanPcp;
24import org.projectfloodlight.openflow.types.VlanVid;
Rich Laneeb21c4f2013-10-28 17:34:41 -070025import org.projectfloodlight.openflow.types.VRF;
Yotam Harcholf3f11152013-09-05 16:47:16 -070026
27@SuppressWarnings("unchecked")
28public class MatchField<F extends OFValueType<F>> {
29 private final String name;
30 public final MatchFields id;
31 private final Prerequisite<?>[] prerequisites;
32
33 private MatchField(final String name, final MatchFields id, Prerequisite<?>... prerequisites) {
34 this.name = name;
35 this.id = id;
36 this.prerequisites = prerequisites;
37 }
38
39 public final static MatchField<OFPort> IN_PORT =
40 new MatchField<OFPort>("in_port", MatchFields.IN_PORT);
41
42 public final static MatchField<OFPort> IN_PHY_PORT =
43 new MatchField<OFPort>("in_phy_port", MatchFields.IN_PHY_PORT,
44 new Prerequisite<OFPort>(MatchField.IN_PORT));
45
46 public final static MatchField<OFMetadata> METADATA =
47 new MatchField<OFMetadata>("metadata", MatchFields.METADATA);
48
49 public final static MatchField<MacAddress> ETH_DST =
50 new MatchField<MacAddress>("eth_dst", MatchFields.ETH_DST);
51
52 public final static MatchField<MacAddress> ETH_SRC =
53 new MatchField<MacAddress>("eth_src", MatchFields.ETH_SRC);
54
55 public final static MatchField<EthType> ETH_TYPE =
56 new MatchField<EthType>("eth_type", MatchFields.ETH_TYPE);
57
58 public final static MatchField<VlanVid> VLAN_VID =
59 new MatchField<VlanVid>("vlan_vid", MatchFields.VLAN_VID);
60
61 public final static MatchField<VlanPcp> VLAN_PCP =
62 new MatchField<VlanPcp>("vlan_pcp", MatchFields.VLAN_PCP,
63 new Prerequisite<VlanVid>(MatchField.VLAN_VID));
64
65 public final static MatchField<IpDscp> IP_DSCP =
66 new MatchField<IpDscp>("ip_dscp", MatchFields.IP_DSCP,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070067 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070068
69 public final static MatchField<IpEcn> IP_ECN =
70 new MatchField<IpEcn>("ip_dscp", MatchFields.IP_ECN,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070071 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070072
73 public final static MatchField<IpProtocol> IP_PROTO =
74 new MatchField<IpProtocol>("ip_proto", MatchFields.IP_PROTO,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070075 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -070076
Yotam Harchola289d552013-09-16 10:10:40 -070077 public final static MatchField<IPv4Address> IPV4_SRC =
78 new MatchField<IPv4Address>("ipv4_src", MatchFields.IPV4_SRC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070079 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4));
Yotam Harcholf3f11152013-09-05 16:47:16 -070080
Yotam Harchola289d552013-09-16 10:10:40 -070081 public final static MatchField<IPv4Address> IPV4_DST =
82 new MatchField<IPv4Address>("ipv4_dst", MatchFields.IPV4_DST,
Andreas Wundsamb70b0442013-09-23 14:44:43 -070083 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv4));
Yotam Harcholf3f11152013-09-05 16:47:16 -070084
85 public final static MatchField<TransportPort> TCP_SRC = new MatchField<TransportPort>(
86 "tcp_src", MatchFields.TCP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -070087 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.TCP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070088
89 public final static MatchField<TransportPort> TCP_DST = new MatchField<TransportPort>(
90 "tcp_dst", MatchFields.TCP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -070091 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.TCP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070092
93 public final static MatchField<TransportPort> UDP_SRC = new MatchField<TransportPort>(
94 "udp_src", MatchFields.UDP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -070095 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.UDP));
Yotam Harcholf3f11152013-09-05 16:47:16 -070096
97 public final static MatchField<TransportPort> UDP_DST = new MatchField<TransportPort>(
98 "udp_dst", MatchFields.UDP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -070099 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.UDP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700100
101 public final static MatchField<TransportPort> SCTP_SRC = new MatchField<TransportPort>(
102 "sctp_src", MatchFields.SCTP_SRC,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700103 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.SCTP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700104
105 public final static MatchField<TransportPort> SCTP_DST = new MatchField<TransportPort>(
106 "sctp_dst", MatchFields.SCTP_DST,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700107 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.SCTP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700108
109 public final static MatchField<ICMPv4Type> ICMPV4_TYPE = new MatchField<ICMPv4Type>(
110 "icmpv4_src", MatchFields.ICMPV4_TYPE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700111 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.ICMP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700112
113 public final static MatchField<ICMPv4Code> ICMPV4_CODE = new MatchField<ICMPv4Code>(
114 "icmpv4_dst", MatchFields.ICMPV4_CODE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700115 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.ICMP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700116
117 public final static MatchField<ArpOpcode> ARP_OP = new MatchField<ArpOpcode>(
118 "arp_op", MatchFields.ARP_OP,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700119 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700120
Yotam Harchola289d552013-09-16 10:10:40 -0700121 public final static MatchField<IPv4Address> ARP_SPA =
122 new MatchField<IPv4Address>("arp_spa", MatchFields.ARP_SPA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700123 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700124
Yotam Harchola289d552013-09-16 10:10:40 -0700125 public final static MatchField<IPv4Address> ARP_TPA =
126 new MatchField<IPv4Address>("arp_tpa", MatchFields.ARP_TPA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700127 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700128
129 public final static MatchField<MacAddress> ARP_SHA =
130 new MatchField<MacAddress>("arp_sha", MatchFields.ARP_SHA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700131 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700132
133 public final static MatchField<MacAddress> ARP_THA =
134 new MatchField<MacAddress>("arp_tha", MatchFields.ARP_THA,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700135 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.ARP));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700136
Yotam Harchola289d552013-09-16 10:10:40 -0700137 public final static MatchField<IPv6Address> IPV6_SRC =
138 new MatchField<IPv6Address>("ipv6_src", MatchFields.IPV6_SRC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700139 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700140
Yotam Harchola289d552013-09-16 10:10:40 -0700141 public final static MatchField<IPv6Address> IPV6_DST =
142 new MatchField<IPv6Address>("ipv6_dst", MatchFields.IPV6_DST,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700143 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700144
145 public final static MatchField<IPv6FlowLabel> IPV6_FLABEL =
146 new MatchField<IPv6FlowLabel>("ipv6_flabel", MatchFields.IPV6_FLABEL,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700147 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.IPv6));
Yotam Harcholf3f11152013-09-05 16:47:16 -0700148
Yotam Harchola86e4252013-09-06 15:36:28 -0700149 public final static MatchField<U8> ICMPV6_TYPE =
150 new MatchField<U8>("icmpv6_type", MatchFields.ICMPV6_TYPE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700151 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.IPv6_ICMP));
Yotam Harchola86e4252013-09-06 15:36:28 -0700152
153 public final static MatchField<U8> ICMPV6_CODE =
154 new MatchField<U8>("icmpv6_code", MatchFields.ICMPV6_CODE,
Andreas Wundsam520c8802013-10-08 22:05:23 -0700155 new Prerequisite<IpProtocol>(MatchField.IP_PROTO, IpProtocol.IPv6_ICMP));
Yotam Harchola86e4252013-09-06 15:36:28 -0700156
Yotam Harchola289d552013-09-16 10:10:40 -0700157 public final static MatchField<IPv6Address> IPV6_ND_TARGET =
158 new MatchField<IPv6Address>("ipv6_nd_target", MatchFields.IPV6_ND_TARGET,
Yotam Harchola86e4252013-09-06 15:36:28 -0700159 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)135), U8.of((short)136)));
160
161 public final static MatchField<MacAddress> IPV6_ND_SLL =
162 new MatchField<MacAddress>("ipv6_nd_sll", MatchFields.IPV6_ND_SLL,
163 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)135)));
164
165 public final static MatchField<MacAddress> IPV6_ND_TLL =
166 new MatchField<MacAddress>("ipv6_nd_tll", MatchFields.IPV6_ND_TLL,
167 new Prerequisite<U8>(MatchField.ICMPV6_TYPE, U8.of((short)136)));
168
169 public final static MatchField<U32> MPLS_LABEL =
170 new MatchField<U32>("mpls_label", MatchFields.MPLS_LABEL,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700171 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.MPLS_UNICAST, EthType.MPLS_MULTICAST));
Yotam Harchola86e4252013-09-06 15:36:28 -0700172
173 public final static MatchField<U8> MPLS_TC =
174 new MatchField<U8>("mpls_tc", MatchFields.MPLS_TC,
Andreas Wundsamb70b0442013-09-23 14:44:43 -0700175 new Prerequisite<EthType>(MatchField.ETH_TYPE, EthType.MPLS_UNICAST, EthType.MPLS_MULTICAST));
Yotam Harchola86e4252013-09-06 15:36:28 -0700176
Yotam Harchol2c535582013-10-01 15:50:20 -0700177 public final static MatchField<OFBitMask128> BSN_IN_PORTS_128 =
178 new MatchField<OFBitMask128>("bsn_in_port_masked_128", MatchFields.BSN_IN_PORTS_128);
Yotam Harchola11f38b2013-09-26 15:38:17 -0700179
Rich Lane376cafe2013-10-27 21:49:14 -0700180 public final static MatchField<LagId> BSN_LAG_ID =
181 new MatchField<LagId>("bsn_lag_id", MatchFields.BSN_LAG_ID);
Rich Lane1424d0b2013-10-24 17:16:24 -0700182
Rich Laneeb21c4f2013-10-28 17:34:41 -0700183 public final static MatchField<VRF> BSN_VRF =
184 new MatchField<VRF>("bsn_vrf", MatchFields.BSN_VRF);
185
186 public final static MatchField<U8> BSN_GLOBAL_VRF_ALLOWED =
187 new MatchField<U8>("bsn_global_vrf_allowed", MatchFields.BSN_GLOBAL_VRF_ALLOWED);
188
189 public final static MatchField<ClassId> BSN_L3_INTERFACE_CLASS_ID =
190 new MatchField<ClassId>("bsn_l3_interface_class_id", MatchFields.BSN_L3_INTERFACE_CLASS_ID);
191
192 public final static MatchField<ClassId> BSN_L3_SRC_CLASS_ID =
193 new MatchField<ClassId>("bsn_l3_src_class_id", MatchFields.BSN_L3_SRC_CLASS_ID);
194
195 public final static MatchField<ClassId> BSN_L3_DST_CLASS_ID =
196 new MatchField<ClassId>("bsn_l3_dst_class_id", MatchFields.BSN_L3_DST_CLASS_ID);
197
Yotam Harcholf3f11152013-09-05 16:47:16 -0700198 public String getName() {
199 return name;
200 }
201
202 public boolean arePrerequisitesOK(Match match) {
203 for (Prerequisite<?> p : this.prerequisites) {
204 if (!p.isSatisfied(match)) {
205 return false;
206 }
207 }
208 return true;
209 }
210
211}