2 * Copyright 2014-2015 Open Networking Laboratory
4 * 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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org.onosproject.provider.of.flow.impl;
18 import static org.onosproject.net.flow.criteria.Criteria.matchLambda;
19 import static org.onosproject.net.flow.criteria.Criteria.matchOchSignalType;
20 import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupChannelSpacing;
21 import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupGridType;
22 import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupOchSignalType;
23 import static org.slf4j.LoggerFactory.getLogger;
25 import java.util.List;
27 import org.onlab.packet.Ip4Address;
28 import org.onlab.packet.Ip4Prefix;
29 import org.onlab.packet.Ip6Address;
30 import org.onlab.packet.Ip6Prefix;
31 import org.onlab.packet.MacAddress;
32 import org.onlab.packet.MplsLabel;
33 import org.onlab.packet.TpPort;
34 import org.onlab.packet.VlanId;
35 import org.onosproject.core.DefaultGroupId;
36 import org.onosproject.net.DeviceId;
37 import org.onosproject.net.Lambda;
38 import org.onosproject.net.PortNumber;
39 import org.onosproject.net.flow.DefaultFlowEntry;
40 import org.onosproject.net.flow.DefaultFlowRule;
41 import org.onosproject.net.flow.DefaultTrafficSelector;
42 import org.onosproject.net.flow.DefaultTrafficTreatment;
43 import org.onosproject.net.flow.FlowEntry;
44 import org.onosproject.net.flow.FlowEntry.FlowEntryState;
45 import org.onosproject.net.flow.FlowRule;
46 import org.onosproject.net.flow.TrafficSelector;
47 import org.onosproject.net.flow.TrafficTreatment;
48 import org.onosproject.net.flow.instructions.Instructions;
49 import org.onosproject.openflow.controller.Dpid;
50 import org.projectfloodlight.openflow.protocol.OFFlowMod;
51 import org.projectfloodlight.openflow.protocol.OFFlowRemoved;
52 import org.projectfloodlight.openflow.protocol.OFFlowStatsEntry;
53 import org.projectfloodlight.openflow.protocol.action.OFAction;
54 import org.projectfloodlight.openflow.protocol.action.OFActionCircuit;
55 import org.projectfloodlight.openflow.protocol.action.OFActionExperimenter;
56 import org.projectfloodlight.openflow.protocol.action.OFActionGroup;
57 import org.projectfloodlight.openflow.protocol.action.OFActionOutput;
58 import org.projectfloodlight.openflow.protocol.action.OFActionSetQueue;
59 import org.projectfloodlight.openflow.protocol.action.OFActionPopMpls;
60 import org.projectfloodlight.openflow.protocol.action.OFActionSetDlDst;
61 import org.projectfloodlight.openflow.protocol.action.OFActionSetDlSrc;
62 import org.projectfloodlight.openflow.protocol.action.OFActionSetField;
63 import org.projectfloodlight.openflow.protocol.action.OFActionSetNwDst;
64 import org.projectfloodlight.openflow.protocol.action.OFActionSetNwSrc;
65 import org.projectfloodlight.openflow.protocol.action.OFActionSetVlanPcp;
66 import org.projectfloodlight.openflow.protocol.action.OFActionSetVlanVid;
67 import org.projectfloodlight.openflow.protocol.instruction.OFInstruction;
68 import org.projectfloodlight.openflow.protocol.instruction.OFInstructionApplyActions;
69 import org.projectfloodlight.openflow.protocol.instruction.OFInstructionGotoTable;
70 import org.projectfloodlight.openflow.protocol.instruction.OFInstructionWriteActions;
71 import org.projectfloodlight.openflow.protocol.instruction.OFInstructionWriteMetadata;
72 import org.projectfloodlight.openflow.protocol.match.Match;
73 import org.projectfloodlight.openflow.protocol.match.MatchField;
74 import org.projectfloodlight.openflow.protocol.oxm.OFOxm;
75 import org.projectfloodlight.openflow.protocol.oxm.OFOxmOchSigidBasic;
76 import org.projectfloodlight.openflow.protocol.ver13.OFFactoryVer13;
77 import org.projectfloodlight.openflow.types.CircuitSignalID;
78 import org.projectfloodlight.openflow.types.EthType;
79 import org.projectfloodlight.openflow.types.IPv4Address;
80 import org.projectfloodlight.openflow.types.IPv6Address;
81 import org.projectfloodlight.openflow.types.Masked;
82 import org.projectfloodlight.openflow.types.OFVlanVidMatch;
83 import org.projectfloodlight.openflow.types.TransportPort;
84 import org.projectfloodlight.openflow.types.U32;
85 import org.projectfloodlight.openflow.types.U64;
86 import org.projectfloodlight.openflow.types.U8;
87 import org.projectfloodlight.openflow.types.VlanPcp;
88 import org.slf4j.Logger;
90 import com.google.common.collect.Lists;
92 public class FlowEntryBuilder {
93 private final Logger log = getLogger(getClass());
95 private final OFFlowStatsEntry stat;
96 private final OFFlowRemoved removed;
97 private final OFFlowMod flowMod;
99 private final Match match;
101 // All actions are contained in an OFInstruction. For OF1.0
102 // the instruction type is apply instruction (immediate set in ONOS speak)
103 private final List<OFInstruction> instructions;
105 private final Dpid dpid;
107 public enum FlowType { STAT, REMOVED, MOD }
109 private final FlowType type;
111 public FlowEntryBuilder(Dpid dpid, OFFlowStatsEntry entry) {
113 this.match = entry.getMatch();
114 this.instructions = getInstructions(entry);
118 this.type = FlowType.STAT;
121 public FlowEntryBuilder(Dpid dpid, OFFlowRemoved removed) {
122 this.match = removed.getMatch();
123 this.removed = removed;
126 this.instructions = null;
129 this.type = FlowType.REMOVED;
133 public FlowEntryBuilder(Dpid dpid, OFFlowMod fm) {
134 this.match = fm.getMatch();
136 this.instructions = getInstructions(fm);
137 this.type = FlowType.MOD;
143 public FlowEntry build(FlowEntryState... state) {
147 rule = DefaultFlowRule.builder()
148 .forDevice(DeviceId.deviceId(Dpid.uri(dpid)))
149 .withSelector(buildSelector())
150 .withTreatment(buildTreatment())
151 .withPriority(stat.getPriority())
152 .makeTemporary(stat.getIdleTimeout())
153 .withCookie(stat.getCookie().getValue())
154 .forTable(stat.getTableId().getValue())
157 return new DefaultFlowEntry(rule, FlowEntryState.ADDED,
158 stat.getDurationSec(), stat.getPacketCount().getValue(),
159 stat.getByteCount().getValue());
161 rule = DefaultFlowRule.builder()
162 .forDevice(DeviceId.deviceId(Dpid.uri(dpid)))
163 .withSelector(buildSelector())
164 .withPriority(removed.getPriority())
165 .makeTemporary(removed.getIdleTimeout())
166 .withCookie(removed.getCookie().getValue())
167 .forTable(removed.getTableId().getValue())
170 return new DefaultFlowEntry(rule, FlowEntryState.REMOVED, removed.getDurationSec(),
171 removed.getPacketCount().getValue(), removed.getByteCount().getValue());
173 FlowEntryState flowState = state.length > 0 ? state[0] : FlowEntryState.FAILED;
174 rule = DefaultFlowRule.builder()
175 .forDevice(DeviceId.deviceId(Dpid.uri(dpid)))
176 .withSelector(buildSelector())
177 .withTreatment(buildTreatment())
178 .withPriority(flowMod.getPriority())
179 .makeTemporary(flowMod.getIdleTimeout())
180 .withCookie(flowMod.getCookie().getValue())
181 .forTable(flowMod.getTableId().getValue())
184 return new DefaultFlowEntry(rule, flowState, 0, 0, 0);
186 log.error("Unknown flow type : {}", this.type);
192 private List<OFInstruction> getInstructions(OFFlowMod entry) {
193 switch (entry.getVersion()) {
195 return Lists.newArrayList(OFFactoryVer13.INSTANCE.instructions()
197 entry.getActions()));
201 return entry.getInstructions();
203 log.warn("Unknown OF version {}", entry.getVersion());
205 return Lists.newLinkedList();
208 private List<OFInstruction> getInstructions(OFFlowStatsEntry entry) {
209 switch (entry.getVersion()) {
211 return Lists.newArrayList(
212 OFFactoryVer13.INSTANCE.instructions().applyActions(entry.getActions()));
216 return entry.getInstructions();
218 log.warn("Unknown OF version {}", entry.getVersion());
220 return Lists.newLinkedList();
223 private TrafficTreatment buildTreatment() {
224 TrafficTreatment.Builder builder = DefaultTrafficTreatment.builder();
225 for (OFInstruction in : instructions) {
226 switch (in.getType()) {
228 builder.transition(((int) ((OFInstructionGotoTable) in)
229 .getTableId().getValue()));
232 OFInstructionWriteMetadata m = (OFInstructionWriteMetadata) in;
233 builder.writeMetadata(m.getMetadata().getValue(),
234 m.getMetadataMask().getValue());
238 buildActions(((OFInstructionWriteActions) in).getActions(),
243 buildActions(((OFInstructionApplyActions) in).getActions(),
247 builder.wipeDeferred();
254 log.warn("Unknown instructions type {}", in.getType());
258 return builder.build();
261 private TrafficTreatment.Builder buildActions(List<OFAction> actions,
262 TrafficTreatment.Builder builder) {
263 for (OFAction act : actions) {
264 switch (act.getType()) {
266 OFActionOutput out = (OFActionOutput) act;
268 PortNumber.portNumber(out.getPort().getPortNumber()));
271 OFActionSetVlanVid vlan = (OFActionSetVlanVid) act;
272 builder.setVlanId(VlanId.vlanId(vlan.getVlanVid().getVlan()));
275 OFActionSetVlanPcp pcp = (OFActionSetVlanPcp) act;
276 builder.setVlanPcp(pcp.getVlanPcp().getValue());
279 OFActionSetDlDst dldst = (OFActionSetDlDst) act;
281 MacAddress.valueOf(dldst.getDlAddr().getLong()));
284 OFActionSetDlSrc dlsrc = (OFActionSetDlSrc) act;
286 MacAddress.valueOf(dlsrc.getDlAddr().getLong()));
290 OFActionSetNwDst nwdst = (OFActionSetNwDst) act;
291 IPv4Address di = nwdst.getNwAddr();
292 builder.setIpDst(Ip4Address.valueOf(di.getInt()));
295 OFActionSetNwSrc nwsrc = (OFActionSetNwSrc) act;
296 IPv4Address si = nwsrc.getNwAddr();
297 builder.setIpSrc(Ip4Address.valueOf(si.getInt()));
300 OFActionExperimenter exp = (OFActionExperimenter) act;
301 if (exp.getExperimenter() == 0x80005A06 ||
302 exp.getExperimenter() == 0x748771) {
303 OFActionCircuit ct = (OFActionCircuit) exp;
304 short lambda = ((OFOxmOchSigidBasic) ct.getField()).getValue().getChannelNumber();
305 builder.add(Instructions.modL0Lambda(Lambda.indexedLambda(lambda)));
307 log.warn("Unsupported OFActionExperimenter {}", exp.getExperimenter());
311 OFActionSetField setField = (OFActionSetField) act;
312 handleSetField(builder, setField.getField());
315 OFActionPopMpls popMpls = (OFActionPopMpls) act;
316 builder.popMpls((short) popMpls.getEthertype().getValue());
325 builder.copyTtlOut();
328 builder.decMplsTtl();
334 OFActionGroup group = (OFActionGroup) act;
335 builder.group(new DefaultGroupId(group.getGroup().getGroupNumber()));
338 OFActionSetQueue setQueue = (OFActionSetQueue) act;
339 builder.setQueue(setQueue.getQueueId());
361 log.warn("Action type {} not yet implemented.", act.getType());
368 private void handleSetField(TrafficTreatment.Builder builder, OFOxm<?> oxm) {
369 switch (oxm.getMatchField().id) {
371 @SuppressWarnings("unchecked")
372 OFOxm<VlanPcp> vlanpcp = (OFOxm<VlanPcp>) oxm;
373 builder.setVlanPcp(vlanpcp.getValue().getValue());
376 @SuppressWarnings("unchecked")
377 OFOxm<OFVlanVidMatch> vlanvid = (OFOxm<OFVlanVidMatch>) oxm;
378 builder.setVlanId(VlanId.vlanId(vlanvid.getValue().getVlan()));
381 @SuppressWarnings("unchecked")
382 OFOxm<org.projectfloodlight.openflow.types.MacAddress> ethdst =
383 (OFOxm<org.projectfloodlight.openflow.types.MacAddress>) oxm;
384 builder.setEthDst(MacAddress.valueOf(ethdst.getValue().getLong()));
387 @SuppressWarnings("unchecked")
388 OFOxm<org.projectfloodlight.openflow.types.MacAddress> ethsrc =
389 (OFOxm<org.projectfloodlight.openflow.types.MacAddress>) oxm;
390 builder.setEthSrc(MacAddress.valueOf(ethsrc.getValue().getLong()));
393 @SuppressWarnings("unchecked")
394 OFOxm<IPv4Address> ip4dst = (OFOxm<IPv4Address>) oxm;
395 builder.setIpDst(Ip4Address.valueOf(ip4dst.getValue().getInt()));
398 @SuppressWarnings("unchecked")
399 OFOxm<IPv4Address> ip4src = (OFOxm<IPv4Address>) oxm;
400 builder.setIpSrc(Ip4Address.valueOf(ip4src.getValue().getInt()));
403 @SuppressWarnings("unchecked")
404 OFOxm<U32> labelId = (OFOxm<U32>) oxm;
405 builder.setMpls(MplsLabel.mplsLabel((int) labelId.getValue().getValue()));
408 @SuppressWarnings("unchecked")
409 OFOxm<U8> mplsBos = (OFOxm<U8>) oxm;
410 builder.setMplsBos(mplsBos.getValue() == U8.ZERO ? false : true);
413 @SuppressWarnings("unchecked")
414 OFOxm<U64> tunnelId = (OFOxm<U64>) oxm;
415 builder.setTunnelId(tunnelId.getValue().getValue());
418 @SuppressWarnings("unchecked")
419 OFOxm<TransportPort> tcpdst = (OFOxm<TransportPort>) oxm;
420 builder.setTcpDst(TpPort.tpPort(tcpdst.getValue().getPort()));
423 @SuppressWarnings("unchecked")
424 OFOxm<TransportPort> tcpsrc = (OFOxm<TransportPort>) oxm;
425 builder.setTcpSrc(TpPort.tpPort(tcpsrc.getValue().getPort()));
428 @SuppressWarnings("unchecked")
429 OFOxm<TransportPort> udpdst = (OFOxm<TransportPort>) oxm;
430 builder.setUdpDst(TpPort.tpPort(udpdst.getValue().getPort()));
433 @SuppressWarnings("unchecked")
434 OFOxm<TransportPort> udpsrc = (OFOxm<TransportPort>) oxm;
435 builder.setUdpSrc(TpPort.tpPort(udpsrc.getValue().getPort()));
442 case BSN_EGR_PORT_GROUP_ID:
443 case BSN_GLOBAL_VRF_ALLOWED:
444 case BSN_IN_PORTS_128:
445 case BSN_L3_DST_CLASS_ID:
446 case BSN_L3_INTERFACE_CLASS_ID:
447 case BSN_L3_SRC_CLASS_ID:
458 case BSN_VLAN_XLATE_PORT_GROUP_ID:
479 case OCH_SIGID_BASIC:
481 case OCH_SIGTYPE_BASIC:
485 log.warn("Set field type {} not yet implemented.", oxm.getMatchField().id);
490 // CHECKSTYLE IGNORE MethodLength FOR NEXT 1 LINES
491 private TrafficSelector buildSelector() {
494 Ip6Address ip6Address;
497 TrafficSelector.Builder builder = DefaultTrafficSelector.builder();
498 for (MatchField<?> field : match.getMatchFields()) {
501 builder.matchInPort(PortNumber
502 .portNumber(match.get(MatchField.IN_PORT).getPortNumber()));
505 builder.matchInPhyPort(PortNumber
506 .portNumber(match.get(MatchField.IN_PHY_PORT).getPortNumber()));
510 match.get(MatchField.METADATA).getValue().getValue();
511 builder.matchMetadata(metadata);
514 mac = MacAddress.valueOf(match.get(MatchField.ETH_DST).getLong());
515 builder.matchEthDst(mac);
518 mac = MacAddress.valueOf(match.get(MatchField.ETH_SRC).getLong());
519 builder.matchEthSrc(mac);
522 int ethType = match.get(MatchField.ETH_TYPE).getValue();
523 if (ethType == EthType.VLAN_FRAME.getValue()) {
524 builder.matchVlanId(VlanId.ANY);
526 builder.matchEthType((short) ethType);
530 VlanId vlanId = null;
531 if (match.isPartiallyMasked(MatchField.VLAN_VID)) {
532 Masked<OFVlanVidMatch> masked = match.getMasked(MatchField.VLAN_VID);
533 if (masked.getValue().equals(OFVlanVidMatch.PRESENT)
534 && masked.getMask().equals(OFVlanVidMatch.PRESENT)) {
538 if (!match.get(MatchField.VLAN_VID).isPresentBitSet()) {
539 vlanId = VlanId.NONE;
541 vlanId = VlanId.vlanId(match.get(MatchField.VLAN_VID).getVlan());
544 if (vlanId != null) {
545 builder.matchVlanId(vlanId);
549 byte vlanPcp = match.get(MatchField.VLAN_PCP).getValue();
550 builder.matchVlanPcp(vlanPcp);
553 byte ipDscp = match.get(MatchField.IP_DSCP).getDscpValue();
554 builder.matchIPDscp(ipDscp);
557 byte ipEcn = match.get(MatchField.IP_ECN).getEcnValue();
558 builder.matchIPEcn(ipEcn);
561 short proto = match.get(MatchField.IP_PROTO).getIpProtocolNumber();
562 builder.matchIPProtocol((byte) proto);
565 if (match.isPartiallyMasked(MatchField.IPV4_SRC)) {
566 Masked<IPv4Address> maskedIp = match.getMasked(MatchField.IPV4_SRC);
567 ip4Prefix = Ip4Prefix.valueOf(
568 maskedIp.getValue().getInt(),
569 maskedIp.getMask().asCidrMaskLength());
571 ip4Prefix = Ip4Prefix.valueOf(
572 match.get(MatchField.IPV4_SRC).getInt(),
573 Ip4Prefix.MAX_MASK_LENGTH);
575 builder.matchIPSrc(ip4Prefix);
578 if (match.isPartiallyMasked(MatchField.IPV4_DST)) {
579 Masked<IPv4Address> maskedIp = match.getMasked(MatchField.IPV4_DST);
580 ip4Prefix = Ip4Prefix.valueOf(
581 maskedIp.getValue().getInt(),
582 maskedIp.getMask().asCidrMaskLength());
584 ip4Prefix = Ip4Prefix.valueOf(
585 match.get(MatchField.IPV4_DST).getInt(),
586 Ip4Prefix.MAX_MASK_LENGTH);
588 builder.matchIPDst(ip4Prefix);
591 builder.matchTcpSrc(TpPort.tpPort(match.get(MatchField.TCP_SRC).getPort()));
594 builder.matchTcpDst(TpPort.tpPort(match.get(MatchField.TCP_DST).getPort()));
597 builder.matchUdpSrc(TpPort.tpPort(match.get(MatchField.UDP_SRC).getPort()));
600 builder.matchUdpDst(TpPort.tpPort(match.get(MatchField.UDP_DST).getPort()));
603 builder.matchMplsLabel(MplsLabel.mplsLabel((int) match.get(MatchField.MPLS_LABEL)
607 builder.matchMplsBos(match.get(MatchField.MPLS_BOS).getValue());
610 builder.matchSctpSrc(TpPort.tpPort(match.get(MatchField.SCTP_SRC).getPort()));
613 builder.matchSctpDst(TpPort.tpPort(match.get(MatchField.SCTP_DST).getPort()));
616 byte icmpType = (byte) match.get(MatchField.ICMPV4_TYPE).getType();
617 builder.matchIcmpType(icmpType);
620 byte icmpCode = (byte) match.get(MatchField.ICMPV4_CODE).getCode();
621 builder.matchIcmpCode(icmpCode);
624 if (match.isPartiallyMasked(MatchField.IPV6_SRC)) {
625 Masked<IPv6Address> maskedIp = match.getMasked(MatchField.IPV6_SRC);
626 ip6Prefix = Ip6Prefix.valueOf(
627 maskedIp.getValue().getBytes(),
628 maskedIp.getMask().asCidrMaskLength());
630 ip6Prefix = Ip6Prefix.valueOf(
631 match.get(MatchField.IPV6_SRC).getBytes(),
632 Ip6Prefix.MAX_MASK_LENGTH);
634 builder.matchIPv6Src(ip6Prefix);
637 if (match.isPartiallyMasked(MatchField.IPV6_DST)) {
638 Masked<IPv6Address> maskedIp = match.getMasked(MatchField.IPV6_DST);
639 ip6Prefix = Ip6Prefix.valueOf(
640 maskedIp.getValue().getBytes(),
641 maskedIp.getMask().asCidrMaskLength());
643 ip6Prefix = Ip6Prefix.valueOf(
644 match.get(MatchField.IPV6_DST).getBytes(),
645 Ip6Prefix.MAX_MASK_LENGTH);
647 builder.matchIPv6Dst(ip6Prefix);
651 match.get(MatchField.IPV6_FLABEL).getIPv6FlowLabelValue();
652 builder.matchIPv6FlowLabel(flowLabel);
655 byte icmpv6type = (byte) match.get(MatchField.ICMPV6_TYPE).getValue();
656 builder.matchIcmpv6Type(icmpv6type);
659 byte icmpv6code = (byte) match.get(MatchField.ICMPV6_CODE).getValue();
660 builder.matchIcmpv6Code(icmpv6code);
664 Ip6Address.valueOf(match.get(MatchField.IPV6_ND_TARGET).getBytes());
665 builder.matchIPv6NDTargetAddress(ip6Address);
668 mac = MacAddress.valueOf(match.get(MatchField.IPV6_ND_SLL).getLong());
669 builder.matchIPv6NDSourceLinkLayerAddress(mac);
672 mac = MacAddress.valueOf(match.get(MatchField.IPV6_ND_TLL).getLong());
673 builder.matchIPv6NDTargetLinkLayerAddress(mac);
676 builder.matchIPv6ExthdrFlags((short) match.get(MatchField.IPV6_EXTHDR)
680 CircuitSignalID sigId = match.get(MatchField.OCH_SIGID);
681 builder.add(matchLambda(Lambda.ochSignal(
682 lookupGridType(sigId.getGridType()), lookupChannelSpacing(sigId.getChannelSpacing()),
683 sigId.getChannelNumber(), sigId.getSpectralWidth())
687 U8 sigType = match.get(MatchField.OCH_SIGTYPE);
688 builder.add(matchOchSignalType(lookupOchSignalType((byte) sigType.getValue())));
691 long tunnelId = match.get(MatchField.TUNNEL_ID).getValue();
692 builder.matchTunnelId(tunnelId);
701 log.warn("Match type {} not yet implemented.", field.id);
704 return builder.build();