blob: d025180bd66a5705b1af210b743d54d0af7de59d [file] [log] [blame]
Thomas Vachuska781d18b2014-10-27 10:31:25 -07001/*
Brian O'Connor5ab426f2016-04-09 01:19:45 -07002 * Copyright 2014-present 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;
Thomas Vachuska95caba32016-04-04 10:42:05 -070067import org.onosproject.provider.of.flow.util.NoMappingFoundException;
68import org.onosproject.provider.of.flow.util.OpenFlowValueMapper;
alshabibeec3a062014-09-17 18:01:26 -070069import org.projectfloodlight.openflow.protocol.OFFactory;
70import org.projectfloodlight.openflow.protocol.OFFlowMod;
alshabibeec3a062014-09-17 18:01:26 -070071import org.projectfloodlight.openflow.protocol.match.Match;
72import org.projectfloodlight.openflow.protocol.match.MatchField;
Jonathan Hart26a8d952015-12-02 15:16:35 -080073import org.projectfloodlight.openflow.protocol.oxm.OFOxm;
BitOhenryb40129a2015-11-30 12:41:18 +080074import org.projectfloodlight.openflow.types.ArpOpcode;
Marc De Leenheer49087752014-10-23 13:54:09 -070075import org.projectfloodlight.openflow.types.CircuitSignalID;
alshabibeec3a062014-09-17 18:01:26 -070076import org.projectfloodlight.openflow.types.EthType;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -080077import org.projectfloodlight.openflow.types.ICMPv4Code;
78import org.projectfloodlight.openflow.types.ICMPv4Type;
alshabibeec3a062014-09-17 18:01:26 -070079import org.projectfloodlight.openflow.types.IPv4Address;
Charles M.C. Chan52fae7d2015-01-17 00:35:53 +080080import org.projectfloodlight.openflow.types.IPv6Address;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -080081import org.projectfloodlight.openflow.types.IPv6FlowLabel;
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -080082import org.projectfloodlight.openflow.types.IpDscp;
83import org.projectfloodlight.openflow.types.IpEcn;
alshabibeec3a062014-09-17 18:01:26 -070084import org.projectfloodlight.openflow.types.IpProtocol;
85import org.projectfloodlight.openflow.types.MacAddress;
86import org.projectfloodlight.openflow.types.Masked;
Saurav Dasffc5bbc2015-08-18 23:30:19 -070087import org.projectfloodlight.openflow.types.OFBooleanValue;
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -080088import org.projectfloodlight.openflow.types.OFMetadata;
alshabibeec3a062014-09-17 18:01:26 -070089import org.projectfloodlight.openflow.types.OFPort;
90import org.projectfloodlight.openflow.types.OFVlanVidMatch;
Jonathan Hart42feabd2016-02-03 17:56:21 -080091import org.projectfloodlight.openflow.types.OduSignalID;
Jonathan Hart34bc6142014-10-17 11:00:43 -070092import org.projectfloodlight.openflow.types.TransportPort;
Pavlin Radoslavov5e4f7542015-02-06 18:18:21 -080093import org.projectfloodlight.openflow.types.U16;
Praseed Balakrishnan8c67d172014-11-10 10:15:41 -080094import org.projectfloodlight.openflow.types.U32;
Hyunsun Moona08c5d02015-07-14 17:53:00 -070095import org.projectfloodlight.openflow.types.U64;
Praseed Balakrishnan2dd5abd2014-11-03 14:56:28 -080096import org.projectfloodlight.openflow.types.U8;
alshabibeec3a062014-09-17 18:01:26 -070097import org.projectfloodlight.openflow.types.VlanPcp;
98import org.projectfloodlight.openflow.types.VlanVid;
99import org.slf4j.Logger;
100
Jonathan Hart3c259162015-10-21 21:31:19 -0700101import java.util.Optional;
102
103import static org.slf4j.LoggerFactory.getLogger;
104
Jonathan Hart86e59352014-10-22 10:42:16 -0700105/**
106 * Builder for OpenFlow flow mods based on FlowRules.
107 */
108public abstract class FlowModBuilder {
alshabibeec3a062014-09-17 18:01:26 -0700109
110 private final Logger log = getLogger(getClass());
111
112 private final OFFactory factory;
Jonathan Hart86e59352014-10-22 10:42:16 -0700113 private final FlowRule flowRule;
alshabibeec3a062014-09-17 18:01:26 -0700114 private final TrafficSelector selector;
Brian O'Connor427a1762014-11-19 18:40:32 -0800115 protected final Long xid;
Jonathan Hart3c259162015-10-21 21:31:19 -0700116 protected final Optional<DriverService> driverService;
Jonathan Hart26a8d952015-12-02 15:16:35 -0800117 protected final DeviceId deviceId;
alshabibeec3a062014-09-17 18:01:26 -0700118
Jonathan Hart86e59352014-10-22 10:42:16 -0700119 /**
120 * Creates a new flow mod builder.
121 *
122 * @param flowRule the flow rule to transform into a flow mod
123 * @param factory the OpenFlow factory to use to build the flow mod
Pavlin Radoslavov119fd5c2014-11-25 19:08:19 -0800124 * @param xid the transaction ID
Charles Chan30ba4002015-11-05 14:45:16 -0800125 * @param driverService the device driver service
Jonathan Hart86e59352014-10-22 10:42:16 -0700126 * @return the new flow mod builder
127 */
Brian O'Connor427a1762014-11-19 18:40:32 -0800128 public static FlowModBuilder builder(FlowRule flowRule,
alshabib9af70072015-02-09 14:34:16 -0800129 OFFactory factory,
Jonathan Hart3c259162015-10-21 21:31:19 -0700130 Optional<Long> xid,
131 Optional<DriverService> driverService) {
Jonathan Hart86e59352014-10-22 10:42:16 -0700132 switch (factory.getVersion()) {
133 case OF_10:
Jonathan Hart3c259162015-10-21 21:31:19 -0700134 return new FlowModBuilderVer10(flowRule, factory, xid, driverService);
Jonathan Hart86e59352014-10-22 10:42:16 -0700135 case OF_13:
Jonathan Hart3c259162015-10-21 21:31:19 -0700136 return new FlowModBuilderVer13(flowRule, factory, xid, driverService);
Jonathan Hart86e59352014-10-22 10:42:16 -0700137 default:
138 throw new UnsupportedOperationException(
139 "No flow mod builder for protocol version " + factory.getVersion());
140 }
141 }
alshabibeec3a062014-09-17 18:01:26 -0700142
Jonathan Hart86e59352014-10-22 10:42:16 -0700143 /**
144 * Constructs a flow mod builder.
145 *
146 * @param flowRule the flow rule to transform into a flow mod
147 * @param factory the OpenFlow factory to use to build the flow mod
Charles Chan30ba4002015-11-05 14:45:16 -0800148 * @param driverService the device driver service
Pavlin Radoslavov119fd5c2014-11-25 19:08:19 -0800149 * @param xid the transaction ID
Jonathan Hart86e59352014-10-22 10:42:16 -0700150 */
Jonathan Hart3c259162015-10-21 21:31:19 -0700151 protected FlowModBuilder(FlowRule flowRule, OFFactory factory, Optional<Long> xid,
152 Optional<DriverService> driverService) {
alshabibeec3a062014-09-17 18:01:26 -0700153 this.factory = factory;
Jonathan Hart86e59352014-10-22 10:42:16 -0700154 this.flowRule = flowRule;
alshabibeec3a062014-09-17 18:01:26 -0700155 this.selector = flowRule.selector();
Sho SHIMIZUc14b2a22015-05-05 18:15:13 -0700156 this.xid = xid.orElse(0L);
Jonathan Hart3c259162015-10-21 21:31:19 -0700157 this.driverService = driverService;
Jonathan Hart26a8d952015-12-02 15:16:35 -0800158 this.deviceId = flowRule.deviceId();
alshabibeec3a062014-09-17 18:01:26 -0700159 }
160
Jonathan Hart86e59352014-10-22 10:42:16 -0700161 /**
162 * Builds an ADD flow mod.
163 *
164 * @return the flow mod
165 */
Jonathan Hart42feabd2016-02-03 17:56:21 -0800166 public abstract OFFlowMod buildFlowAdd();
alshabibeec3a062014-09-17 18:01:26 -0700167
Jonathan Hart86e59352014-10-22 10:42:16 -0700168 /**
169 * Builds a MODIFY flow mod.
170 *
171 * @return the flow mod
172 */
173 public abstract OFFlowMod buildFlowMod();
alshabibeec3a062014-09-17 18:01:26 -0700174
Jonathan Hart86e59352014-10-22 10:42:16 -0700175 /**
176 * Builds a DELETE flow mod.
177 *
178 * @return the flow mod
179 */
Jonathan Hart42feabd2016-02-03 17:56:21 -0800180 public abstract OFFlowMod buildFlowDel();
alshabibeec3a062014-09-17 18:01:26 -0700181
Jonathan Hart86e59352014-10-22 10:42:16 -0700182 /**
183 * Builds the match for the flow mod.
184 *
185 * @return the match
186 */
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800187 // CHECKSTYLE IGNORE MethodLength FOR NEXT 300 LINES
Jonathan Hart86e59352014-10-22 10:42:16 -0700188 protected Match buildMatch() {
alshabibeec3a062014-09-17 18:01:26 -0700189 Match.Builder mBuilder = factory.buildMatch();
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800190 Ip6Address ip6Address;
Pavlin Radoslavov23e398d2014-11-05 15:17:57 -0800191 Ip4Prefix ip4Prefix;
Charles M.C. Chan52fae7d2015-01-17 00:35:53 +0800192 Ip6Prefix ip6Prefix;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800193 EthCriterion ethCriterion;
194 IPCriterion ipCriterion;
195 TcpPortCriterion tcpPortCriterion;
196 UdpPortCriterion udpPortCriterion;
197 SctpPortCriterion sctpPortCriterion;
198 IPv6NDLinkLayerAddressCriterion llAddressCriterion;
BitOhenry76430852015-11-20 19:04:49 +0800199 ArpHaCriterion arpHaCriterion;
BitOhenryc1e5fcc2015-11-23 20:47:53 +0800200 ArpPaCriterion arpPaCriterion;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800201
alshabibeec3a062014-09-17 18:01:26 -0700202 for (Criterion c : selector.criteria()) {
203 switch (c.type()) {
204 case IN_PORT:
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -0800205 PortCriterion inPort = (PortCriterion) c;
206 mBuilder.setExact(MatchField.IN_PORT,
207 OFPort.of((int) inPort.port().toLong()));
208 break;
209 case IN_PHY_PORT:
210 PortCriterion inPhyPort = (PortCriterion) c;
211 mBuilder.setExact(MatchField.IN_PORT,
212 OFPort.of((int) inPhyPort.port().toLong()));
213 break;
214 case METADATA:
215 MetadataCriterion metadata = (MetadataCriterion) c;
216 mBuilder.setExact(MatchField.METADATA,
217 OFMetadata.ofRaw(metadata.metadata()));
alshabibeec3a062014-09-17 18:01:26 -0700218 break;
alshabibeec3a062014-09-17 18:01:26 -0700219 case ETH_DST:
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800220 ethCriterion = (EthCriterion) c;
221 mBuilder.setExact(MatchField.ETH_DST,
222 MacAddress.of(ethCriterion.mac().toLong()));
223 break;
Saurav Das9d6c86b2016-02-19 09:01:07 -0800224 case ETH_DST_MASKED:
225 ethCriterion = (EthCriterion) c;
226 mBuilder.setMasked(MatchField.ETH_DST,
227 MacAddress.of(ethCriterion.mac().toLong()),
228 MacAddress.of(ethCriterion.mask().toLong()));
229 break;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800230 case ETH_SRC:
231 ethCriterion = (EthCriterion) c;
232 mBuilder.setExact(MatchField.ETH_SRC,
233 MacAddress.of(ethCriterion.mac().toLong()));
alshabibeec3a062014-09-17 18:01:26 -0700234 break;
Saurav Das9d6c86b2016-02-19 09:01:07 -0800235 case ETH_SRC_MASKED:
236 ethCriterion = (EthCriterion) c;
237 mBuilder.setMasked(MatchField.ETH_SRC,
238 MacAddress.of(ethCriterion.mac().toLong()),
239 MacAddress.of(ethCriterion.mask().toLong()));
240 break;
alshabibeec3a062014-09-17 18:01:26 -0700241 case ETH_TYPE:
242 EthTypeCriterion ethType = (EthTypeCriterion) c;
alshabibcaf1ca22015-06-25 15:18:16 -0700243 mBuilder.setExact(MatchField.ETH_TYPE, EthType.of(ethType.ethType().toShort()));
alshabibeec3a062014-09-17 18:01:26 -0700244 break;
alshabibeec3a062014-09-17 18:01:26 -0700245 case VLAN_VID:
246 VlanIdCriterion vid = (VlanIdCriterion) c;
Jonathan Hart6cd2f352015-01-13 17:44:45 -0800247
248 if (vid.vlanId().equals(VlanId.ANY)) {
249 mBuilder.setMasked(MatchField.VLAN_VID, OFVlanVidMatch.PRESENT,
250 OFVlanVidMatch.PRESENT);
Jonathan Hart1468fee2015-07-16 18:50:34 -0700251 } else if (vid.vlanId().equals(VlanId.NONE)) {
252 mBuilder.setExact(MatchField.VLAN_VID, OFVlanVidMatch.NONE);
Jonathan Hart6cd2f352015-01-13 17:44:45 -0800253 } else {
254 mBuilder.setExact(MatchField.VLAN_VID,
Charles Chan14967c22015-12-07 11:11:50 -0800255 OFVlanVidMatch.ofVlanVid(VlanVid.ofVlan(vid.vlanId().toShort())));
Jonathan Hart6cd2f352015-01-13 17:44:45 -0800256 }
alshabibeec3a062014-09-17 18:01:26 -0700257 break;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800258 case VLAN_PCP:
259 VlanPcpCriterion vpcp = (VlanPcpCriterion) c;
260 mBuilder.setExact(MatchField.VLAN_PCP, VlanPcp.of(vpcp.priority()));
261 break;
Pavlin Radoslavovd0fd8412015-02-04 13:57:00 -0800262 case IP_DSCP:
263 IPDscpCriterion ipDscpCriterion = (IPDscpCriterion) c;
264 mBuilder.setExact(MatchField.IP_DSCP,
265 IpDscp.of(ipDscpCriterion.ipDscp()));
266 break;
267 case IP_ECN:
268 IPEcnCriterion ipEcnCriterion = (IPEcnCriterion) c;
269 mBuilder.setExact(MatchField.IP_ECN,
270 IpEcn.of(ipEcnCriterion.ipEcn()));
271 break;
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800272 case IP_PROTO:
273 IPProtocolCriterion p = (IPProtocolCriterion) c;
274 mBuilder.setExact(MatchField.IP_PROTO, IpProtocol.of(p.protocol()));
275 break;
276 case IPV4_SRC:
277 ipCriterion = (IPCriterion) c;
278 ip4Prefix = ipCriterion.ip().getIp4Prefix();
279 if (ip4Prefix.prefixLength() != Ip4Prefix.MAX_MASK_LENGTH) {
280 Ip4Address maskAddr =
281 Ip4Address.makeMaskPrefix(ip4Prefix.prefixLength());
282 Masked<IPv4Address> maskedIp =
283 Masked.of(IPv4Address.of(ip4Prefix.address().toInt()),
284 IPv4Address.of(maskAddr.toInt()));
285 mBuilder.setMasked(MatchField.IPV4_SRC, maskedIp);
286 } else {
287 mBuilder.setExact(MatchField.IPV4_SRC,
288 IPv4Address.of(ip4Prefix.address().toInt()));
289 }
290 break;
291 case IPV4_DST:
292 ipCriterion = (IPCriterion) c;
293 ip4Prefix = ipCriterion.ip().getIp4Prefix();
294 if (ip4Prefix.prefixLength() != Ip4Prefix.MAX_MASK_LENGTH) {
295 Ip4Address maskAddr =
296 Ip4Address.makeMaskPrefix(ip4Prefix.prefixLength());
297 Masked<IPv4Address> maskedIp =
298 Masked.of(IPv4Address.of(ip4Prefix.address().toInt()),
299 IPv4Address.of(maskAddr.toInt()));
300 mBuilder.setMasked(MatchField.IPV4_DST, maskedIp);
301 } else {
302 mBuilder.setExact(MatchField.IPV4_DST,
303 IPv4Address.of(ip4Prefix.address().toInt()));
304 }
Jonathan Hart34bc6142014-10-17 11:00:43 -0700305 break;
306 case TCP_SRC:
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800307 tcpPortCriterion = (TcpPortCriterion) c;
308 mBuilder.setExact(MatchField.TCP_SRC,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700309 TransportPort.of(tcpPortCriterion.tcpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800310 break;
311 case TCP_DST:
312 tcpPortCriterion = (TcpPortCriterion) c;
313 mBuilder.setExact(MatchField.TCP_DST,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700314 TransportPort.of(tcpPortCriterion.tcpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800315 break;
316 case UDP_SRC:
317 udpPortCriterion = (UdpPortCriterion) c;
318 mBuilder.setExact(MatchField.UDP_SRC,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700319 TransportPort.of(udpPortCriterion.udpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800320 break;
321 case UDP_DST:
322 udpPortCriterion = (UdpPortCriterion) c;
323 mBuilder.setExact(MatchField.UDP_DST,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700324 TransportPort.of(udpPortCriterion.udpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800325 break;
326 case SCTP_SRC:
327 sctpPortCriterion = (SctpPortCriterion) c;
328 mBuilder.setExact(MatchField.SCTP_SRC,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700329 TransportPort.of(sctpPortCriterion.sctpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800330 break;
331 case SCTP_DST:
332 sctpPortCriterion = (SctpPortCriterion) c;
333 mBuilder.setExact(MatchField.SCTP_DST,
Hyunsun Mooncf732fb2015-08-22 21:04:23 -0700334 TransportPort.of(sctpPortCriterion.sctpPort().toInt()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800335 break;
336 case ICMPV4_TYPE:
337 IcmpTypeCriterion icmpType = (IcmpTypeCriterion) c;
338 mBuilder.setExact(MatchField.ICMPV4_TYPE,
339 ICMPv4Type.of(icmpType.icmpType()));
340 break;
341 case ICMPV4_CODE:
342 IcmpCodeCriterion icmpCode = (IcmpCodeCriterion) c;
343 mBuilder.setExact(MatchField.ICMPV4_CODE,
344 ICMPv4Code.of(icmpCode.icmpCode()));
345 break;
346 case IPV6_SRC:
347 ipCriterion = (IPCriterion) c;
348 ip6Prefix = ipCriterion.ip().getIp6Prefix();
349 if (ip6Prefix.prefixLength() != Ip6Prefix.MAX_MASK_LENGTH) {
350 Ip6Address maskAddr =
351 Ip6Address.makeMaskPrefix(ip6Prefix.prefixLength());
352 Masked<IPv6Address> maskedIp =
353 Masked.of(IPv6Address.of(ip6Prefix.address().toString()),
354 IPv6Address.of(maskAddr.toString()));
355 mBuilder.setMasked(MatchField.IPV6_SRC, maskedIp);
356 } else {
357 mBuilder.setExact(MatchField.IPV6_SRC,
358 IPv6Address.of(ip6Prefix.address().toString()));
359 }
360 break;
361 case IPV6_DST:
362 ipCriterion = (IPCriterion) c;
363 ip6Prefix = ipCriterion.ip().getIp6Prefix();
364 if (ip6Prefix.prefixLength() != Ip6Prefix.MAX_MASK_LENGTH) {
365 Ip6Address maskAddr =
366 Ip6Address.makeMaskPrefix(ip6Prefix.prefixLength());
367 Masked<IPv6Address> maskedIp =
368 Masked.of(IPv6Address.of(ip6Prefix.address().toString()),
369 IPv6Address.of(maskAddr.toString()));
370 mBuilder.setMasked(MatchField.IPV6_DST, maskedIp);
371 } else {
372 mBuilder.setExact(MatchField.IPV6_DST,
373 IPv6Address.of(ip6Prefix.address().toString()));
374 }
375 break;
376 case IPV6_FLABEL:
377 IPv6FlowLabelCriterion flowLabelCriterion =
378 (IPv6FlowLabelCriterion) c;
379 mBuilder.setExact(MatchField.IPV6_FLABEL,
380 IPv6FlowLabel.of(flowLabelCriterion.flowLabel()));
381 break;
382 case ICMPV6_TYPE:
383 Icmpv6TypeCriterion icmpv6Type = (Icmpv6TypeCriterion) c;
384 mBuilder.setExact(MatchField.ICMPV6_TYPE,
Pavlin Radoslavovf3b69332015-02-06 15:47:05 -0800385 U8.of(icmpv6Type.icmpv6Type()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800386 break;
387 case ICMPV6_CODE:
388 Icmpv6CodeCriterion icmpv6Code = (Icmpv6CodeCriterion) c;
389 mBuilder.setExact(MatchField.ICMPV6_CODE,
Pavlin Radoslavovf3b69332015-02-06 15:47:05 -0800390 U8.of(icmpv6Code.icmpv6Code()));
Pavlin Radoslavov320e6c92015-02-02 16:51:58 -0800391 break;
392 case IPV6_ND_TARGET:
393 IPv6NDTargetAddressCriterion targetAddressCriterion =
394 (IPv6NDTargetAddressCriterion) c;
395 ip6Address = targetAddressCriterion.targetAddress();
396 mBuilder.setExact(MatchField.IPV6_ND_TARGET,
397 IPv6Address.of(ip6Address.toOctets()));
398 break;
399 case IPV6_ND_SLL:
400 llAddressCriterion =
401 (IPv6NDLinkLayerAddressCriterion) c;
402 mBuilder.setExact(MatchField.IPV6_ND_SLL,
403 MacAddress.of(llAddressCriterion.mac().toLong()));
404 break;
405 case IPV6_ND_TLL:
406 llAddressCriterion =
407 (IPv6NDLinkLayerAddressCriterion) c;
408 mBuilder.setExact(MatchField.IPV6_ND_TLL,
409 MacAddress.of(llAddressCriterion.mac().toLong()));
Jonathan Hart34bc6142014-10-17 11:00:43 -0700410 break;
Praseed Balakrishnan8c67d172014-11-10 10:15:41 -0800411 case MPLS_LABEL:
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -0700412 MplsCriterion mp = (MplsCriterion) c;
Michele Santuari4b6019e2014-12-19 11:31:45 +0100413 mBuilder.setExact(MatchField.MPLS_LABEL, U32.of(mp.label().toInt()));
Praseed Balakrishnan8c67d172014-11-10 10:15:41 -0800414 break;
Pavlin Radoslavov5e4f7542015-02-06 18:18:21 -0800415 case IPV6_EXTHDR:
Sho SHIMIZUfbc80e52015-04-28 10:41:58 -0700416 IPv6ExthdrFlagsCriterion exthdrFlagsCriterion =
417 (IPv6ExthdrFlagsCriterion) c;
Pavlin Radoslavov5e4f7542015-02-06 18:18:21 -0800418 mBuilder.setExact(MatchField.IPV6_EXTHDR,
419 U16.of(exthdrFlagsCriterion.exthdrFlags()));
420 break;
Marc De Leenheer49087752014-10-23 13:54:09 -0700421 case OCH_SIGID:
Sho SHIMIZUc15ce512015-05-26 16:54:08 -0700422 try {
423 OchSignalCriterion ochSignalCriterion = (OchSignalCriterion) c;
424 OchSignal signal = ochSignalCriterion.lambda();
Sho SHIMIZUc17042d2015-05-28 12:07:23 -0700425 byte gridType = OpenFlowValueMapper.lookupGridType(signal.gridType());
426 byte channelSpacing = OpenFlowValueMapper.lookupChannelSpacing(signal.channelSpacing());
Yafit Hadar73514612015-11-04 10:14:21 +0200427 mBuilder.setExact(MatchField.EXP_OCH_SIG_ID,
Sho SHIMIZUc15ce512015-05-26 16:54:08 -0700428 new CircuitSignalID(gridType, channelSpacing,
429 (short) signal.spacingMultiplier(), (short) signal.slotGranularity()));
Sho SHIMIZUc17042d2015-05-28 12:07:23 -0700430 } catch (NoMappingFoundException e) {
Sho SHIMIZUc15ce512015-05-26 16:54:08 -0700431 log.warn(e.getMessage());
432 }
Marc De Leenheer49087752014-10-23 13:54:09 -0700433 break;
Praseed Balakrishnan2dd5abd2014-11-03 14:56:28 -0800434 case OCH_SIGTYPE:
Yafit Hadar73514612015-11-04 10:14:21 +0200435 try {
436 OchSignalTypeCriterion sc = (OchSignalTypeCriterion) c;
437 byte signalType = OpenFlowValueMapper.lookupOchSignalType(sc.signalType());
438 mBuilder.setExact(MatchField.EXP_OCH_SIGTYPE, U8.of(signalType));
439 } catch (NoMappingFoundException e) {
440 log.warn(e.getMessage());
441 }
442 break;
443 case ODU_SIGID:
444 OduSignalIdCriterion oduSignalIdCriterion = (OduSignalIdCriterion) c;
445 OduSignalId oduSignalId = oduSignalIdCriterion.oduSignalId();
446 mBuilder.setExact(MatchField.EXP_ODU_SIG_ID,
447 new OduSignalID((short) oduSignalId.tributaryPortNumber(),
448 (short) oduSignalId.tributarySlotLength(),
449 oduSignalId.tributarySlotBitmap()));
450 break;
451 case ODU_SIGTYPE:
452 try {
453 OduSignalTypeCriterion oduSignalTypeCriterion = (OduSignalTypeCriterion) c;
454 byte oduSigType = OpenFlowValueMapper.lookupOduSignalType(oduSignalTypeCriterion.signalType());
455 mBuilder.setExact(MatchField.EXP_ODU_SIGTYPE, U8.of(oduSigType));
456 } catch (NoMappingFoundException e) {
457 log.warn(e.getMessage());
458 }
Praseed Balakrishnan2dd5abd2014-11-03 14:56:28 -0800459 break;
Hyunsun Moona08c5d02015-07-14 17:53:00 -0700460 case TUNNEL_ID:
461 TunnelIdCriterion tunnelId = (TunnelIdCriterion) c;
462 mBuilder.setExact(MatchField.TUNNEL_ID,
463 U64.of(tunnelId.tunnelId()));
464 break;
Saurav Dasffc5bbc2015-08-18 23:30:19 -0700465 case MPLS_BOS:
466 MplsBosCriterion mplsBos = (MplsBosCriterion) c;
467 mBuilder.setExact(MatchField.MPLS_BOS,
468 mplsBos.mplsBos() ? OFBooleanValue.TRUE
469 : OFBooleanValue.FALSE);
470 break;
BitOhenryb40129a2015-11-30 12:41:18 +0800471 case ARP_OP:
472 ArpOpCriterion arpOp = (ArpOpCriterion) c;
473 mBuilder.setExact(MatchField.ARP_OP,
474 ArpOpcode.of(arpOp.arpOp()));
475 break;
BitOhenrya331b182015-11-23 08:39:37 +0800476 case ARP_SHA:
477 arpHaCriterion = (ArpHaCriterion) c;
478 mBuilder.setExact(MatchField.ARP_SHA,
479 MacAddress.of(arpHaCriterion.mac().toLong()));
480 break;
BitOhenry296b4542015-11-24 08:41:58 +0800481 case ARP_SPA:
482 arpPaCriterion = (ArpPaCriterion) c;
483 mBuilder.setExact(MatchField.ARP_SPA,
484 IPv4Address.of(arpPaCriterion.ip().toInt()));
485 break;
BitOhenry76430852015-11-20 19:04:49 +0800486 case ARP_THA:
487 arpHaCriterion = (ArpHaCriterion) c;
488 mBuilder.setExact(MatchField.ARP_THA,
489 MacAddress.of(arpHaCriterion.mac().toLong()));
490 break;
BitOhenryc1e5fcc2015-11-23 20:47:53 +0800491 case ARP_TPA:
492 arpPaCriterion = (ArpPaCriterion) c;
493 mBuilder.setExact(MatchField.ARP_TPA,
494 IPv4Address.of(arpPaCriterion.ip().toInt()));
495 break;
Jonathan Hart26a8d952015-12-02 15:16:35 -0800496 case EXTENSION:
497 ExtensionCriterion extensionCriterion = (ExtensionCriterion) c;
498 OFOxm oxm = buildExtensionOxm(extensionCriterion.extensionSelector());
499 if (oxm == null) {
500 log.warn("Unable to build extension selector");
501 break;
502 }
503
504 if (oxm.isMasked()) {
505 mBuilder.setMasked(oxm.getMatchField(), oxm.getValue(), oxm.getMask());
506 } else {
507 mBuilder.setExact(oxm.getMatchField(), oxm.getValue());
508 }
509
510 break;
alshabibeec3a062014-09-17 18:01:26 -0700511 case MPLS_TC:
512 case PBB_ISID:
Jian Lif1ecf992015-12-02 17:48:54 -0800513 // TODO: need to implement PBB-ISID case when OpenFlowJ is ready
alshabibeec3a062014-09-17 18:01:26 -0700514 default:
515 log.warn("Match type {} not yet implemented.", c.type());
516 }
517 }
518 return mBuilder.build();
519 }
520
Jonathan Hart86e59352014-10-22 10:42:16 -0700521 /**
522 * Returns the flow rule for this builder.
523 *
524 * @return the flow rule
525 */
526 protected FlowRule flowRule() {
527 return flowRule;
528 }
alshabib219ebaa2014-09-22 15:41:24 -0700529
Jonathan Hart86e59352014-10-22 10:42:16 -0700530 /**
531 * Returns the factory used for building OpenFlow constructs.
532 *
533 * @return the factory
534 */
535 protected OFFactory factory() {
536 return factory;
537 }
alshabib219ebaa2014-09-22 15:41:24 -0700538
Jonathan Hart26a8d952015-12-02 15:16:35 -0800539 private OFOxm buildExtensionOxm(ExtensionSelector extension) {
540 if (!driverService.isPresent()) {
541 log.error("No driver service present");
542 return null;
543 }
544 Driver driver = driverService.get().getDriver(deviceId);
545 if (driver.hasBehaviour(ExtensionSelectorInterpreter.class)) {
546 DefaultDriverHandler handler =
547 new DefaultDriverHandler(new DefaultDriverData(driver, deviceId));
548 ExtensionSelectorInterpreter interpreter = handler.behaviour(ExtensionSelectorInterpreter.class);
549
550 return interpreter.mapSelector(factory(), extension);
551 }
552
553 return null;
554 }
555
alshabibeec3a062014-09-17 18:01:26 -0700556}