blob: 4cdbb838efced125781520bf28c5a30765e0bcfe [file] [log] [blame]
Thomas Vachuska781d18b2014-10-27 10:31:25 -07001/*
Ray Milkey34c95902015-04-15 09:47:53 -07002 * Copyright 2014-2015 Open Networking Laboratory
Thomas Vachuska781d18b2014-10-27 10:31:25 -07003 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07004 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
Thomas Vachuska781d18b2014-10-27 10:31:25 -07007 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07008 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
Thomas Vachuska781d18b2014-10-27 10:31:25 -070015 */
Brian O'Connorabafb502014-12-02 22:26:20 -080016package org.onosproject.provider.of.flow.impl;
alshabibeec3a062014-09-17 18:01:26 -070017
Jonathan Hart6cd2f352015-01-13 17:44:45 -080018import org.onlab.packet.Ip4Address;
19import org.onlab.packet.Ip4Prefix;
Charles M.C. Chan52fae7d2015-01-17 00:35:53 +080020import org.onlab.packet.Ip6Address;
21import org.onlab.packet.Ip6Prefix;
Jonathan Hart6cd2f352015-01-13 17:44:45 -080022import org.onlab.packet.VlanId;
Jonathan Hart26a8d952015-12-02 15:16:35 -080023import org.onosproject.net.DeviceId;
Sho SHIMIZUc15ce512015-05-26 16:54:08 -070024import org.onosproject.net.OchSignal;
Jonathan Hart42feabd2016-02-03 17:56:21 -080025import org.onosproject.net.OduSignalId;
Jonathan Hart26a8d952015-12-02 15:16:35 -080026import org.onosproject.net.driver.DefaultDriverData;
27import org.onosproject.net.driver.DefaultDriverHandler;
28import org.onosproject.net.driver.Driver;
Jonathan Hart3c259162015-10-21 21:31:19 -070029import org.onosproject.net.driver.DriverService;
Brian O'Connorabafb502014-12-02 22:26:20 -080030import org.onosproject.net.flow.FlowRule;
31import org.onosproject.net.flow.TrafficSelector;
BitOhenry76430852015-11-20 19:04:49 +080032import org.onosproject.net.flow.criteria.ArpHaCriterion;
BitOhenryb40129a2015-11-30 12:41:18 +080033import org.onosproject.net.flow.criteria.ArpOpCriterion;
BitOhenryc1e5fcc2015-11-23 20:47:53 +080034import org.onosproject.net.flow.criteria.ArpPaCriterion;
Saurav Dasffc5bbc2015-08-18 23:30:19 -070035import org.onosproject.net.flow.criteria.Criterion;
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -070036import org.onosproject.net.flow.criteria.EthCriterion;
37import org.onosproject.net.flow.criteria.EthTypeCriterion;
Jonathan Hart26a8d952015-12-02 15:16:35 -080038import org.onosproject.net.flow.criteria.ExtensionCriterion;
39import org.onosproject.net.flow.criteria.ExtensionSelector;
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -070040import org.onosproject.net.flow.criteria.IPCriterion;
41import org.onosproject.net.flow.criteria.IPDscpCriterion;
42import org.onosproject.net.flow.criteria.IPEcnCriterion;
43import org.onosproject.net.flow.criteria.IPProtocolCriterion;
44import org.onosproject.net.flow.criteria.IPv6ExthdrFlagsCriterion;
45import org.onosproject.net.flow.criteria.IPv6FlowLabelCriterion;
46import org.onosproject.net.flow.criteria.IPv6NDLinkLayerAddressCriterion;
47import org.onosproject.net.flow.criteria.IPv6NDTargetAddressCriterion;
48import org.onosproject.net.flow.criteria.IcmpCodeCriterion;
49import org.onosproject.net.flow.criteria.IcmpTypeCriterion;
50import org.onosproject.net.flow.criteria.Icmpv6CodeCriterion;
51import org.onosproject.net.flow.criteria.Icmpv6TypeCriterion;
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -070052import org.onosproject.net.flow.criteria.MetadataCriterion;
Saurav Dasffc5bbc2015-08-18 23:30:19 -070053import org.onosproject.net.flow.criteria.MplsBosCriterion;
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -070054import org.onosproject.net.flow.criteria.MplsCriterion;
Sho SHIMIZUc15ce512015-05-26 16:54:08 -070055import org.onosproject.net.flow.criteria.OchSignalCriterion;
Marc De Leenheerd24420f2015-05-27 09:40:59 -070056import org.onosproject.net.flow.criteria.OchSignalTypeCriterion;
Yafit Hadar73514612015-11-04 10:14:21 +020057import org.onosproject.net.flow.criteria.OduSignalIdCriterion;
58import org.onosproject.net.flow.criteria.OduSignalTypeCriterion;
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -070059import org.onosproject.net.flow.criteria.PortCriterion;
60import org.onosproject.net.flow.criteria.SctpPortCriterion;
61import org.onosproject.net.flow.criteria.TcpPortCriterion;
Hyunsun Moona08c5d02015-07-14 17:53:00 -070062import org.onosproject.net.flow.criteria.TunnelIdCriterion;
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -070063import org.onosproject.net.flow.criteria.UdpPortCriterion;
64import org.onosproject.net.flow.criteria.VlanIdCriterion;
65import org.onosproject.net.flow.criteria.VlanPcpCriterion;
Jonathan Hart26a8d952015-12-02 15:16:35 -080066import org.onosproject.openflow.controller.ExtensionSelectorInterpreter;
alshabibeec3a062014-09-17 18:01:26 -070067import org.projectfloodlight.openflow.protocol.OFFactory;
68import org.projectfloodlight.openflow.protocol.OFFlowMod;
alshabibeec3a062014-09-17 18:01:26 -070069import org.projectfloodlight.openflow.protocol.match.Match;
70import org.projectfloodlight.openflow.protocol.match.MatchField;
Jonathan Hart26a8d952015-12-02 15:16:35 -080071import org.projectfloodlight.openflow.protocol.oxm.OFOxm;
BitOhenryb40129a2015-11-30 12:41:18 +080072import org.projectfloodlight.openflow.types.ArpOpcode;
Marc De Leenheer49087752014-10-23 13:54:09 -070073import org.projectfloodlight.openflow.types.CircuitSignalID;
alshabibeec3a062014-09-17 18:01:26 -070074import org.projectfloodlight.openflow.types.EthType;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -080075import org.projectfloodlight.openflow.types.ICMPv4Code;
76import org.projectfloodlight.openflow.types.ICMPv4Type;
alshabibeec3a062014-09-17 18:01:26 -070077import org.projectfloodlight.openflow.types.IPv4Address;
Charles M.C. Chan52fae7d2015-01-17 00:35:53 +080078import org.projectfloodlight.openflow.types.IPv6Address;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -080079import org.projectfloodlight.openflow.types.IPv6FlowLabel;
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -080080import org.projectfloodlight.openflow.types.IpDscp;
81import org.projectfloodlight.openflow.types.IpEcn;
alshabibeec3a062014-09-17 18:01:26 -070082import org.projectfloodlight.openflow.types.IpProtocol;
83import org.projectfloodlight.openflow.types.MacAddress;
84import org.projectfloodlight.openflow.types.Masked;
Saurav Dasffc5bbc2015-08-18 23:30:19 -070085import org.projectfloodlight.openflow.types.OFBooleanValue;
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -080086import org.projectfloodlight.openflow.types.OFMetadata;
alshabibeec3a062014-09-17 18:01:26 -070087import org.projectfloodlight.openflow.types.OFPort;
88import org.projectfloodlight.openflow.types.OFVlanVidMatch;
Jonathan Hart42feabd2016-02-03 17:56:21 -080089import org.projectfloodlight.openflow.types.OduSignalID;
Jonathan Hart34bc6142014-10-17 11:00:43 -070090import org.projectfloodlight.openflow.types.TransportPort;
Pavlin Radoslavov5e4f7542015-02-06 18:18:21 -080091import org.projectfloodlight.openflow.types.U16;
Praseed Balakrishnan8c67d172014-11-10 10:15:41 -080092import org.projectfloodlight.openflow.types.U32;
Hyunsun Moona08c5d02015-07-14 17:53:00 -070093import org.projectfloodlight.openflow.types.U64;
Praseed Balakrishnan2dd5abd2014-11-03 14:56:28 -080094import org.projectfloodlight.openflow.types.U8;
alshabibeec3a062014-09-17 18:01:26 -070095import org.projectfloodlight.openflow.types.VlanPcp;
96import org.projectfloodlight.openflow.types.VlanVid;
97import org.slf4j.Logger;
98
Jonathan Hart3c259162015-10-21 21:31:19 -070099import java.util.Optional;
100
101import static org.slf4j.LoggerFactory.getLogger;
102
Jonathan Hart86e59352014-10-22 10:42:16 -0700103/**
104 * Builder for OpenFlow flow mods based on FlowRules.
105 */
106public abstract class FlowModBuilder {
alshabibeec3a062014-09-17 18:01:26 -0700107
108 private final Logger log = getLogger(getClass());
109
110 private final OFFactory factory;
Jonathan Hart86e59352014-10-22 10:42:16 -0700111 private final FlowRule flowRule;
alshabibeec3a062014-09-17 18:01:26 -0700112 private final TrafficSelector selector;
Brian O'Connor427a1762014-11-19 18:40:32 -0800113 protected final Long xid;
Jonathan Hart3c259162015-10-21 21:31:19 -0700114 protected final Optional<DriverService> driverService;
Jonathan Hart26a8d952015-12-02 15:16:35 -0800115 protected final DeviceId deviceId;
alshabibeec3a062014-09-17 18:01:26 -0700116
Jonathan Hart86e59352014-10-22 10:42:16 -0700117 /**
118 * Creates a new flow mod builder.
119 *
120 * @param flowRule the flow rule to transform into a flow mod
121 * @param factory the OpenFlow factory to use to build the flow mod
Pavlin Radoslavov119fd5c2014-11-25 19:08:19 -0800122 * @param xid the transaction ID
Charles Chan30ba4002015-11-05 14:45:16 -0800123 * @param driverService the device driver service
Jonathan Hart86e59352014-10-22 10:42:16 -0700124 * @return the new flow mod builder
125 */
Brian O'Connor427a1762014-11-19 18:40:32 -0800126 public static FlowModBuilder builder(FlowRule flowRule,
alshabib9af70072015-02-09 14:34:16 -0800127 OFFactory factory,
Jonathan Hart3c259162015-10-21 21:31:19 -0700128 Optional<Long> xid,
129 Optional<DriverService> driverService) {
Jonathan Hart86e59352014-10-22 10:42:16 -0700130 switch (factory.getVersion()) {
131 case OF_10:
Jonathan Hart3c259162015-10-21 21:31:19 -0700132 return new FlowModBuilderVer10(flowRule, factory, xid, driverService);
Jonathan Hart86e59352014-10-22 10:42:16 -0700133 case OF_13:
Jonathan Hart3c259162015-10-21 21:31:19 -0700134 return new FlowModBuilderVer13(flowRule, factory, xid, driverService);
Jonathan Hart86e59352014-10-22 10:42:16 -0700135 default:
136 throw new UnsupportedOperationException(
137 "No flow mod builder for protocol version " + factory.getVersion());
138 }
139 }
alshabibeec3a062014-09-17 18:01:26 -0700140
Jonathan Hart86e59352014-10-22 10:42:16 -0700141 /**
142 * Constructs a flow mod builder.
143 *
144 * @param flowRule the flow rule to transform into a flow mod
145 * @param factory the OpenFlow factory to use to build the flow mod
Charles Chan30ba4002015-11-05 14:45:16 -0800146 * @param driverService the device driver service
Pavlin Radoslavov119fd5c2014-11-25 19:08:19 -0800147 * @param xid the transaction ID
Jonathan Hart86e59352014-10-22 10:42:16 -0700148 */
Jonathan Hart3c259162015-10-21 21:31:19 -0700149 protected FlowModBuilder(FlowRule flowRule, OFFactory factory, Optional<Long> xid,
150 Optional<DriverService> driverService) {
alshabibeec3a062014-09-17 18:01:26 -0700151 this.factory = factory;
Jonathan Hart86e59352014-10-22 10:42:16 -0700152 this.flowRule = flowRule;
alshabibeec3a062014-09-17 18:01:26 -0700153 this.selector = flowRule.selector();
Sho SHIMIZUc14b2a22015-05-05 18:15:13 -0700154 this.xid = xid.orElse(0L);
Jonathan Hart3c259162015-10-21 21:31:19 -0700155 this.driverService = driverService;
Jonathan Hart26a8d952015-12-02 15:16:35 -0800156 this.deviceId = flowRule.deviceId();
alshabibeec3a062014-09-17 18:01:26 -0700157 }
158
Jonathan Hart86e59352014-10-22 10:42:16 -0700159 /**
160 * Builds an ADD flow mod.
161 *
162 * @return the flow mod
163 */
Jonathan Hart42feabd2016-02-03 17:56:21 -0800164 public abstract OFFlowMod buildFlowAdd();
alshabibeec3a062014-09-17 18:01:26 -0700165
Jonathan Hart86e59352014-10-22 10:42:16 -0700166 /**
167 * Builds a MODIFY flow mod.
168 *
169 * @return the flow mod
170 */
171 public abstract OFFlowMod buildFlowMod();
alshabibeec3a062014-09-17 18:01:26 -0700172
Jonathan Hart86e59352014-10-22 10:42:16 -0700173 /**
174 * Builds a DELETE flow mod.
175 *
176 * @return the flow mod
177 */
Jonathan Hart42feabd2016-02-03 17:56:21 -0800178 public abstract OFFlowMod buildFlowDel();
alshabibeec3a062014-09-17 18:01:26 -0700179
Jonathan Hart86e59352014-10-22 10:42:16 -0700180 /**
181 * Builds the match for the flow mod.
182 *
183 * @return the match
184 */
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800185 // CHECKSTYLE IGNORE MethodLength FOR NEXT 300 LINES
Jonathan Hart86e59352014-10-22 10:42:16 -0700186 protected Match buildMatch() {
alshabibeec3a062014-09-17 18:01:26 -0700187 Match.Builder mBuilder = factory.buildMatch();
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800188 Ip6Address ip6Address;
Pavlin Radoslavov23e398d2014-11-05 15:17:57 -0800189 Ip4Prefix ip4Prefix;
Charles M.C. Chan52fae7d2015-01-17 00:35:53 +0800190 Ip6Prefix ip6Prefix;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800191 EthCriterion ethCriterion;
192 IPCriterion ipCriterion;
193 TcpPortCriterion tcpPortCriterion;
194 UdpPortCriterion udpPortCriterion;
195 SctpPortCriterion sctpPortCriterion;
196 IPv6NDLinkLayerAddressCriterion llAddressCriterion;
BitOhenry76430852015-11-20 19:04:49 +0800197 ArpHaCriterion arpHaCriterion;
BitOhenryc1e5fcc2015-11-23 20:47:53 +0800198 ArpPaCriterion arpPaCriterion;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800199
alshabibeec3a062014-09-17 18:01:26 -0700200 for (Criterion c : selector.criteria()) {
201 switch (c.type()) {
202 case IN_PORT:
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -0800203 PortCriterion inPort = (PortCriterion) c;
204 mBuilder.setExact(MatchField.IN_PORT,
205 OFPort.of((int) inPort.port().toLong()));
206 break;
207 case IN_PHY_PORT:
208 PortCriterion inPhyPort = (PortCriterion) c;
209 mBuilder.setExact(MatchField.IN_PORT,
210 OFPort.of((int) inPhyPort.port().toLong()));
211 break;
212 case METADATA:
213 MetadataCriterion metadata = (MetadataCriterion) c;
214 mBuilder.setExact(MatchField.METADATA,
215 OFMetadata.ofRaw(metadata.metadata()));
alshabibeec3a062014-09-17 18:01:26 -0700216 break;
alshabibeec3a062014-09-17 18:01:26 -0700217 case ETH_DST:
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800218 ethCriterion = (EthCriterion) c;
219 mBuilder.setExact(MatchField.ETH_DST,
220 MacAddress.of(ethCriterion.mac().toLong()));
221 break;
Saurav Das9d6c86b2016-02-19 09:01:07 -0800222 case ETH_DST_MASKED:
223 ethCriterion = (EthCriterion) c;
224 mBuilder.setMasked(MatchField.ETH_DST,
225 MacAddress.of(ethCriterion.mac().toLong()),
226 MacAddress.of(ethCriterion.mask().toLong()));
227 break;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800228 case ETH_SRC:
229 ethCriterion = (EthCriterion) c;
230 mBuilder.setExact(MatchField.ETH_SRC,
231 MacAddress.of(ethCriterion.mac().toLong()));
alshabibeec3a062014-09-17 18:01:26 -0700232 break;
Saurav Das9d6c86b2016-02-19 09:01:07 -0800233 case ETH_SRC_MASKED:
234 ethCriterion = (EthCriterion) c;
235 mBuilder.setMasked(MatchField.ETH_SRC,
236 MacAddress.of(ethCriterion.mac().toLong()),
237 MacAddress.of(ethCriterion.mask().toLong()));
238 break;
alshabibeec3a062014-09-17 18:01:26 -0700239 case ETH_TYPE:
240 EthTypeCriterion ethType = (EthTypeCriterion) c;
alshabibcaf1ca22015-06-25 15:18:16 -0700241 mBuilder.setExact(MatchField.ETH_TYPE, EthType.of(ethType.ethType().toShort()));
alshabibeec3a062014-09-17 18:01:26 -0700242 break;
alshabibeec3a062014-09-17 18:01:26 -0700243 case VLAN_VID:
244 VlanIdCriterion vid = (VlanIdCriterion) c;
Jonathan Hart6cd2f352015-01-13 17:44:45 -0800245
246 if (vid.vlanId().equals(VlanId.ANY)) {
247 mBuilder.setMasked(MatchField.VLAN_VID, OFVlanVidMatch.PRESENT,
248 OFVlanVidMatch.PRESENT);
Jonathan Hart1468fee2015-07-16 18:50:34 -0700249 } else if (vid.vlanId().equals(VlanId.NONE)) {
250 mBuilder.setExact(MatchField.VLAN_VID, OFVlanVidMatch.NONE);
Jonathan Hart6cd2f352015-01-13 17:44:45 -0800251 } else {
252 mBuilder.setExact(MatchField.VLAN_VID,
Charles Chan14967c22015-12-07 11:11:50 -0800253 OFVlanVidMatch.ofVlanVid(VlanVid.ofVlan(vid.vlanId().toShort())));
Jonathan Hart6cd2f352015-01-13 17:44:45 -0800254 }
alshabibeec3a062014-09-17 18:01:26 -0700255 break;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800256 case VLAN_PCP:
257 VlanPcpCriterion vpcp = (VlanPcpCriterion) c;
258 mBuilder.setExact(MatchField.VLAN_PCP, VlanPcp.of(vpcp.priority()));
259 break;
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -0800260 case IP_DSCP:
261 IPDscpCriterion ipDscpCriterion = (IPDscpCriterion) c;
262 mBuilder.setExact(MatchField.IP_DSCP,
263 IpDscp.of(ipDscpCriterion.ipDscp()));
264 break;
265 case IP_ECN:
266 IPEcnCriterion ipEcnCriterion = (IPEcnCriterion) c;
267 mBuilder.setExact(MatchField.IP_ECN,
268 IpEcn.of(ipEcnCriterion.ipEcn()));
269 break;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800270 case IP_PROTO:
271 IPProtocolCriterion p = (IPProtocolCriterion) c;
272 mBuilder.setExact(MatchField.IP_PROTO, IpProtocol.of(p.protocol()));
273 break;
274 case IPV4_SRC:
275 ipCriterion = (IPCriterion) c;
276 ip4Prefix = ipCriterion.ip().getIp4Prefix();
277 if (ip4Prefix.prefixLength() != Ip4Prefix.MAX_MASK_LENGTH) {
278 Ip4Address maskAddr =
279 Ip4Address.makeMaskPrefix(ip4Prefix.prefixLength());
280 Masked<IPv4Address> maskedIp =
281 Masked.of(IPv4Address.of(ip4Prefix.address().toInt()),
282 IPv4Address.of(maskAddr.toInt()));
283 mBuilder.setMasked(MatchField.IPV4_SRC, maskedIp);
284 } else {
285 mBuilder.setExact(MatchField.IPV4_SRC,
286 IPv4Address.of(ip4Prefix.address().toInt()));
287 }
288 break;
289 case IPV4_DST:
290 ipCriterion = (IPCriterion) c;
291 ip4Prefix = ipCriterion.ip().getIp4Prefix();
292 if (ip4Prefix.prefixLength() != Ip4Prefix.MAX_MASK_LENGTH) {
293 Ip4Address maskAddr =
294 Ip4Address.makeMaskPrefix(ip4Prefix.prefixLength());
295 Masked<IPv4Address> maskedIp =
296 Masked.of(IPv4Address.of(ip4Prefix.address().toInt()),
297 IPv4Address.of(maskAddr.toInt()));
298 mBuilder.setMasked(MatchField.IPV4_DST, maskedIp);
299 } else {
300 mBuilder.setExact(MatchField.IPV4_DST,
301 IPv4Address.of(ip4Prefix.address().toInt()));
302 }
Jonathan Hart34bc6142014-10-17 11:00:43 -0700303 break;
304 case TCP_SRC:
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800305 tcpPortCriterion = (TcpPortCriterion) c;
306 mBuilder.setExact(MatchField.TCP_SRC,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700307 TransportPort.of(tcpPortCriterion.tcpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800308 break;
309 case TCP_DST:
310 tcpPortCriterion = (TcpPortCriterion) c;
311 mBuilder.setExact(MatchField.TCP_DST,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700312 TransportPort.of(tcpPortCriterion.tcpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800313 break;
314 case UDP_SRC:
315 udpPortCriterion = (UdpPortCriterion) c;
316 mBuilder.setExact(MatchField.UDP_SRC,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700317 TransportPort.of(udpPortCriterion.udpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800318 break;
319 case UDP_DST:
320 udpPortCriterion = (UdpPortCriterion) c;
321 mBuilder.setExact(MatchField.UDP_DST,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700322 TransportPort.of(udpPortCriterion.udpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800323 break;
324 case SCTP_SRC:
325 sctpPortCriterion = (SctpPortCriterion) c;
326 mBuilder.setExact(MatchField.SCTP_SRC,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700327 TransportPort.of(sctpPortCriterion.sctpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800328 break;
329 case SCTP_DST:
330 sctpPortCriterion = (SctpPortCriterion) c;
331 mBuilder.setExact(MatchField.SCTP_DST,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700332 TransportPort.of(sctpPortCriterion.sctpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800333 break;
334 case ICMPV4_TYPE:
335 IcmpTypeCriterion icmpType = (IcmpTypeCriterion) c;
336 mBuilder.setExact(MatchField.ICMPV4_TYPE,
337 ICMPv4Type.of(icmpType.icmpType()));
338 break;
339 case ICMPV4_CODE:
340 IcmpCodeCriterion icmpCode = (IcmpCodeCriterion) c;
341 mBuilder.setExact(MatchField.ICMPV4_CODE,
342 ICMPv4Code.of(icmpCode.icmpCode()));
343 break;
344 case IPV6_SRC:
345 ipCriterion = (IPCriterion) c;
346 ip6Prefix = ipCriterion.ip().getIp6Prefix();
347 if (ip6Prefix.prefixLength() != Ip6Prefix.MAX_MASK_LENGTH) {
348 Ip6Address maskAddr =
349 Ip6Address.makeMaskPrefix(ip6Prefix.prefixLength());
350 Masked<IPv6Address> maskedIp =
351 Masked.of(IPv6Address.of(ip6Prefix.address().toString()),
352 IPv6Address.of(maskAddr.toString()));
353 mBuilder.setMasked(MatchField.IPV6_SRC, maskedIp);
354 } else {
355 mBuilder.setExact(MatchField.IPV6_SRC,
356 IPv6Address.of(ip6Prefix.address().toString()));
357 }
358 break;
359 case IPV6_DST:
360 ipCriterion = (IPCriterion) c;
361 ip6Prefix = ipCriterion.ip().getIp6Prefix();
362 if (ip6Prefix.prefixLength() != Ip6Prefix.MAX_MASK_LENGTH) {
363 Ip6Address maskAddr =
364 Ip6Address.makeMaskPrefix(ip6Prefix.prefixLength());
365 Masked<IPv6Address> maskedIp =
366 Masked.of(IPv6Address.of(ip6Prefix.address().toString()),
367 IPv6Address.of(maskAddr.toString()));
368 mBuilder.setMasked(MatchField.IPV6_DST, maskedIp);
369 } else {
370 mBuilder.setExact(MatchField.IPV6_DST,
371 IPv6Address.of(ip6Prefix.address().toString()));
372 }
373 break;
374 case IPV6_FLABEL:
375 IPv6FlowLabelCriterion flowLabelCriterion =
376 (IPv6FlowLabelCriterion) c;
377 mBuilder.setExact(MatchField.IPV6_FLABEL,
378 IPv6FlowLabel.of(flowLabelCriterion.flowLabel()));
379 break;
380 case ICMPV6_TYPE:
381 Icmpv6TypeCriterion icmpv6Type = (Icmpv6TypeCriterion) c;
382 mBuilder.setExact(MatchField.ICMPV6_TYPE,
Pavlin Radoslavovf3b69332015-02-06 15:47:05 -0800383 U8.of(icmpv6Type.icmpv6Type()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800384 break;
385 case ICMPV6_CODE:
386 Icmpv6CodeCriterion icmpv6Code = (Icmpv6CodeCriterion) c;
387 mBuilder.setExact(MatchField.ICMPV6_CODE,
Pavlin Radoslavovf3b69332015-02-06 15:47:05 -0800388 U8.of(icmpv6Code.icmpv6Code()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800389 break;
390 case IPV6_ND_TARGET:
391 IPv6NDTargetAddressCriterion targetAddressCriterion =
392 (IPv6NDTargetAddressCriterion) c;
393 ip6Address = targetAddressCriterion.targetAddress();
394 mBuilder.setExact(MatchField.IPV6_ND_TARGET,
395 IPv6Address.of(ip6Address.toOctets()));
396 break;
397 case IPV6_ND_SLL:
398 llAddressCriterion =
399 (IPv6NDLinkLayerAddressCriterion) c;
400 mBuilder.setExact(MatchField.IPV6_ND_SLL,
401 MacAddress.of(llAddressCriterion.mac().toLong()));
402 break;
403 case IPV6_ND_TLL:
404 llAddressCriterion =
405 (IPv6NDLinkLayerAddressCriterion) c;
406 mBuilder.setExact(MatchField.IPV6_ND_TLL,
407 MacAddress.of(llAddressCriterion.mac().toLong()));
Jonathan Hart34bc6142014-10-17 11:00:43 -0700408 break;
Praseed Balakrishnan8c67d172014-11-10 10:15:41 -0800409 case MPLS_LABEL:
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -0700410 MplsCriterion mp = (MplsCriterion) c;
Michele Santuari4b6019e2014-12-19 11:31:45 +0100411 mBuilder.setExact(MatchField.MPLS_LABEL, U32.of(mp.label().toInt()));
Praseed Balakrishnan8c67d172014-11-10 10:15:41 -0800412 break;
Pavlin Radoslavov5e4f7542015-02-06 18:18:21 -0800413 case IPV6_EXTHDR:
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -0700414 IPv6ExthdrFlagsCriterion exthdrFlagsCriterion =
415 (IPv6ExthdrFlagsCriterion) c;
Pavlin Radoslavov5e4f7542015-02-06 18:18:21 -0800416 mBuilder.setExact(MatchField.IPV6_EXTHDR,
417 U16.of(exthdrFlagsCriterion.exthdrFlags()));
418 break;
Marc De Leenheer49087752014-10-23 13:54:09 -0700419 case OCH_SIGID:
Sho SHIMIZUc15ce512015-05-26 16:54:08 -0700420 try {
421 OchSignalCriterion ochSignalCriterion = (OchSignalCriterion) c;
422 OchSignal signal = ochSignalCriterion.lambda();
Sho SHIMIZUc17042d2015-05-28 12:07:23 -0700423 byte gridType = OpenFlowValueMapper.lookupGridType(signal.gridType());
424 byte channelSpacing = OpenFlowValueMapper.lookupChannelSpacing(signal.channelSpacing());
Yafit Hadar73514612015-11-04 10:14:21 +0200425 mBuilder.setExact(MatchField.EXP_OCH_SIG_ID,
Sho SHIMIZUc15ce512015-05-26 16:54:08 -0700426 new CircuitSignalID(gridType, channelSpacing,
427 (short) signal.spacingMultiplier(), (short) signal.slotGranularity()));
Sho SHIMIZUc17042d2015-05-28 12:07:23 -0700428 } catch (NoMappingFoundException e) {
Sho SHIMIZUc15ce512015-05-26 16:54:08 -0700429 log.warn(e.getMessage());
430 }
Marc De Leenheer49087752014-10-23 13:54:09 -0700431 break;
Praseed Balakrishnan2dd5abd2014-11-03 14:56:28 -0800432 case OCH_SIGTYPE:
Yafit Hadar73514612015-11-04 10:14:21 +0200433 try {
434 OchSignalTypeCriterion sc = (OchSignalTypeCriterion) c;
435 byte signalType = OpenFlowValueMapper.lookupOchSignalType(sc.signalType());
436 mBuilder.setExact(MatchField.EXP_OCH_SIGTYPE, U8.of(signalType));
437 } catch (NoMappingFoundException e) {
438 log.warn(e.getMessage());
439 }
440 break;
441 case ODU_SIGID:
442 OduSignalIdCriterion oduSignalIdCriterion = (OduSignalIdCriterion) c;
443 OduSignalId oduSignalId = oduSignalIdCriterion.oduSignalId();
444 mBuilder.setExact(MatchField.EXP_ODU_SIG_ID,
445 new OduSignalID((short) oduSignalId.tributaryPortNumber(),
446 (short) oduSignalId.tributarySlotLength(),
447 oduSignalId.tributarySlotBitmap()));
448 break;
449 case ODU_SIGTYPE:
450 try {
451 OduSignalTypeCriterion oduSignalTypeCriterion = (OduSignalTypeCriterion) c;
452 byte oduSigType = OpenFlowValueMapper.lookupOduSignalType(oduSignalTypeCriterion.signalType());
453 mBuilder.setExact(MatchField.EXP_ODU_SIGTYPE, U8.of(oduSigType));
454 } catch (NoMappingFoundException e) {
455 log.warn(e.getMessage());
456 }
Praseed Balakrishnan2dd5abd2014-11-03 14:56:28 -0800457 break;
Hyunsun Moona08c5d02015-07-14 17:53:00 -0700458 case TUNNEL_ID:
459 TunnelIdCriterion tunnelId = (TunnelIdCriterion) c;
460 mBuilder.setExact(MatchField.TUNNEL_ID,
461 U64.of(tunnelId.tunnelId()));
462 break;
Saurav Dasffc5bbc2015-08-18 23:30:19 -0700463 case MPLS_BOS:
464 MplsBosCriterion mplsBos = (MplsBosCriterion) c;
465 mBuilder.setExact(MatchField.MPLS_BOS,
466 mplsBos.mplsBos() ? OFBooleanValue.TRUE
467 : OFBooleanValue.FALSE);
468 break;
BitOhenryb40129a2015-11-30 12:41:18 +0800469 case ARP_OP:
470 ArpOpCriterion arpOp = (ArpOpCriterion) c;
471 mBuilder.setExact(MatchField.ARP_OP,
472 ArpOpcode.of(arpOp.arpOp()));
473 break;
BitOhenrya331b182015-11-23 08:39:37 +0800474 case ARP_SHA:
475 arpHaCriterion = (ArpHaCriterion) c;
476 mBuilder.setExact(MatchField.ARP_SHA,
477 MacAddress.of(arpHaCriterion.mac().toLong()));
478 break;
BitOhenry296b4542015-11-24 08:41:58 +0800479 case ARP_SPA:
480 arpPaCriterion = (ArpPaCriterion) c;
481 mBuilder.setExact(MatchField.ARP_SPA,
482 IPv4Address.of(arpPaCriterion.ip().toInt()));
483 break;
BitOhenry76430852015-11-20 19:04:49 +0800484 case ARP_THA:
485 arpHaCriterion = (ArpHaCriterion) c;
486 mBuilder.setExact(MatchField.ARP_THA,
487 MacAddress.of(arpHaCriterion.mac().toLong()));
488 break;
BitOhenryc1e5fcc2015-11-23 20:47:53 +0800489 case ARP_TPA:
490 arpPaCriterion = (ArpPaCriterion) c;
491 mBuilder.setExact(MatchField.ARP_TPA,
492 IPv4Address.of(arpPaCriterion.ip().toInt()));
493 break;
Jonathan Hart26a8d952015-12-02 15:16:35 -0800494 case EXTENSION:
495 ExtensionCriterion extensionCriterion = (ExtensionCriterion) c;
496 OFOxm oxm = buildExtensionOxm(extensionCriterion.extensionSelector());
497 if (oxm == null) {
498 log.warn("Unable to build extension selector");
499 break;
500 }
501
502 if (oxm.isMasked()) {
503 mBuilder.setMasked(oxm.getMatchField(), oxm.getValue(), oxm.getMask());
504 } else {
505 mBuilder.setExact(oxm.getMatchField(), oxm.getValue());
506 }
507
508 break;
alshabibeec3a062014-09-17 18:01:26 -0700509 case MPLS_TC:
510 case PBB_ISID:
Jian Lif1ecf992015-12-02 17:48:54 -0800511 // TODO: need to implement PBB-ISID case when OpenFlowJ is ready
alshabibeec3a062014-09-17 18:01:26 -0700512 default:
513 log.warn("Match type {} not yet implemented.", c.type());
514 }
515 }
516 return mBuilder.build();
517 }
518
Jonathan Hart86e59352014-10-22 10:42:16 -0700519 /**
520 * Returns the flow rule for this builder.
521 *
522 * @return the flow rule
523 */
524 protected FlowRule flowRule() {
525 return flowRule;
526 }
alshabib219ebaa2014-09-22 15:41:24 -0700527
Jonathan Hart86e59352014-10-22 10:42:16 -0700528 /**
529 * Returns the factory used for building OpenFlow constructs.
530 *
531 * @return the factory
532 */
533 protected OFFactory factory() {
534 return factory;
535 }
alshabib219ebaa2014-09-22 15:41:24 -0700536
Jonathan Hart26a8d952015-12-02 15:16:35 -0800537 private OFOxm buildExtensionOxm(ExtensionSelector extension) {
538 if (!driverService.isPresent()) {
539 log.error("No driver service present");
540 return null;
541 }
542 Driver driver = driverService.get().getDriver(deviceId);
543 if (driver.hasBehaviour(ExtensionSelectorInterpreter.class)) {
544 DefaultDriverHandler handler =
545 new DefaultDriverHandler(new DefaultDriverData(driver, deviceId));
546 ExtensionSelectorInterpreter interpreter = handler.behaviour(ExtensionSelectorInterpreter.class);
547
548 return interpreter.mapSelector(factory(), extension);
549 }
550
551 return null;
552 }
553
alshabibeec3a062014-09-17 18:01:26 -0700554}