blob: 69edeffcf2fa29bdcfebefab5f72f1ee469c7f66 [file] [log] [blame]
Yi Tsengfa4a1c72017-11-03 10:22:38 -07001/*
2 * Copyright 2017-present Open Networking Foundation
3 *
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
7 *
8 * 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.
15 */
16
17package org.onosproject.pipelines.fabric;
18
Yi Tsengfa4a1c72017-11-03 10:22:38 -070019import com.google.common.collect.ImmutableList;
Yi Tseng1d842672017-11-28 16:06:52 -080020import com.google.common.collect.ImmutableMap;
Yi Tsengfa4a1c72017-11-03 10:22:38 -070021import com.google.common.collect.ImmutableSet;
22import org.onlab.packet.DeserializationException;
23import org.onlab.packet.Ethernet;
24import org.onlab.util.ImmutableByteSequence;
25import org.onosproject.net.ConnectPoint;
26import org.onosproject.net.DeviceId;
27import org.onosproject.net.Port;
28import org.onosproject.net.PortNumber;
29import org.onosproject.net.device.DeviceService;
Yi Tsengfa4a1c72017-11-03 10:22:38 -070030import org.onosproject.net.flow.TrafficTreatment;
31import org.onosproject.net.flow.criteria.Criterion;
32import org.onosproject.net.flow.instructions.Instructions;
33import org.onosproject.net.packet.DefaultInboundPacket;
34import org.onosproject.net.packet.InboundPacket;
35import org.onosproject.net.packet.OutboundPacket;
Yi Tsengfa4a1c72017-11-03 10:22:38 -070036import org.onosproject.net.pi.model.PiMatchFieldId;
37import org.onosproject.net.pi.model.PiPipelineInterpreter;
38import org.onosproject.net.pi.model.PiTableId;
39import org.onosproject.net.pi.runtime.PiAction;
Carmelo Cascone4c289b72019-01-22 15:30:45 -080040import org.onosproject.net.pi.runtime.PiPacketMetadata;
Yi Tsengfa4a1c72017-11-03 10:22:38 -070041import org.onosproject.net.pi.runtime.PiPacketOperation;
42
43import java.nio.ByteBuffer;
44import java.util.Collection;
45import java.util.List;
46import java.util.Optional;
47import java.util.Set;
48
49import static java.lang.String.format;
50import static java.util.stream.Collectors.toList;
51import static org.onlab.util.ImmutableByteSequence.copyFrom;
Carmelo Cascone6880ba62018-09-06 00:04:34 -070052import static org.onosproject.net.PortNumber.CONTROLLER;
Yi Tsengfa4a1c72017-11-03 10:22:38 -070053import static org.onosproject.net.PortNumber.FLOOD;
54import static org.onosproject.net.flow.instructions.Instruction.Type.OUTPUT;
55import static org.onosproject.net.pi.model.PiPacketOperationType.PACKET_OUT;
56
57/**
58 * Interpreter for fabric pipeline.
59 */
Carmelo Casconeb5324e72018-11-25 02:26:32 -080060public class FabricInterpreter extends AbstractFabricHandlerBehavior
Yi Tsengfa4a1c72017-11-03 10:22:38 -070061 implements PiPipelineInterpreter {
Carmelo Cascone1e8843f2018-07-19 19:01:12 +020062
Carmelo Casconeb5324e72018-11-25 02:26:32 -080063 private static final int PORT_BITWIDTH = 9;
Carmelo Cascone6880ba62018-09-06 00:04:34 -070064
Carmelo Casconeb5324e72018-11-25 02:26:32 -080065 // Group tables by control block.
66 private static final Set<PiTableId> FILTERING_CTRL_TBLS = ImmutableSet.of(
67 FabricConstants.FABRIC_INGRESS_FILTERING_INGRESS_PORT_VLAN,
68 FabricConstants.FABRIC_INGRESS_FILTERING_FWD_CLASSIFIER);
69 private static final Set<PiTableId> FORWARDING_CTRL_TBLS = ImmutableSet.of(
70 FabricConstants.FABRIC_INGRESS_FORWARDING_MPLS,
71 FabricConstants.FABRIC_INGRESS_FORWARDING_ROUTING_V4,
72 FabricConstants.FABRIC_INGRESS_FORWARDING_ROUTING_V6,
73 FabricConstants.FABRIC_INGRESS_FORWARDING_BRIDGING);
74 private static final Set<PiTableId> ACL_CTRL_TBLS = ImmutableSet.of(
75 FabricConstants.FABRIC_INGRESS_ACL_ACL);
76 private static final Set<PiTableId> NEXT_CTRL_TBLS = ImmutableSet.of(
77 FabricConstants.FABRIC_INGRESS_NEXT_NEXT_VLAN,
78 FabricConstants.FABRIC_INGRESS_NEXT_SIMPLE,
Carmelo Cascone45cc0862018-11-26 11:50:41 -080079 FabricConstants.FABRIC_INGRESS_NEXT_HASHED,
80 FabricConstants.FABRIC_INGRESS_NEXT_XCONNECT);
Carmelo Casconeb5324e72018-11-25 02:26:32 -080081 private static final Set<PiTableId> E_NEXT_CTRL_TBLS = ImmutableSet.of(
82 FabricConstants.FABRIC_EGRESS_EGRESS_NEXT_EGRESS_VLAN);
Yi Tsengfa4a1c72017-11-03 10:22:38 -070083
Yi Tseng1d842672017-11-28 16:06:52 -080084 private static final ImmutableMap<Criterion.Type, PiMatchFieldId> CRITERION_MAP =
85 ImmutableMap.<Criterion.Type, PiMatchFieldId>builder()
Carmelo Casconeb5324e72018-11-25 02:26:32 -080086 .put(Criterion.Type.IN_PORT, FabricConstants.HDR_IG_PORT)
87 .put(Criterion.Type.ETH_DST, FabricConstants.HDR_ETH_DST)
88 .put(Criterion.Type.ETH_SRC, FabricConstants.HDR_ETH_SRC)
89 .put(Criterion.Type.ETH_DST_MASKED, FabricConstants.HDR_ETH_DST)
90 .put(Criterion.Type.ETH_SRC_MASKED, FabricConstants.HDR_ETH_SRC)
91 .put(Criterion.Type.ETH_TYPE, FabricConstants.HDR_ETH_TYPE)
Yi Tseng43ee7e82018-04-12 16:37:34 +080092 .put(Criterion.Type.MPLS_LABEL, FabricConstants.HDR_MPLS_LABEL)
Carmelo Casconeb5324e72018-11-25 02:26:32 -080093 .put(Criterion.Type.VLAN_VID, FabricConstants.HDR_VLAN_ID)
Daniele Moro7c3a0022019-07-12 13:38:34 -070094 .put(Criterion.Type.INNER_VLAN_VID, FabricConstants.HDR_INNER_VLAN_ID)
Carmelo Casconeb5324e72018-11-25 02:26:32 -080095 .put(Criterion.Type.IPV4_DST, FabricConstants.HDR_IPV4_DST)
96 .put(Criterion.Type.IPV4_SRC, FabricConstants.HDR_IPV4_SRC)
97 .put(Criterion.Type.IPV6_DST, FabricConstants.HDR_IPV6_DST)
98 .put(Criterion.Type.IP_PROTO, FabricConstants.HDR_IP_PROTO)
99 .put(Criterion.Type.ICMPV6_TYPE, FabricConstants.HDR_ICMP_TYPE)
100 .put(Criterion.Type.ICMPV6_CODE, FabricConstants.HDR_ICMP_CODE)
Daniele Moro59020df2019-08-05 15:37:45 -0700101 .put(Criterion.Type.UDP_DST, FabricConstants.HDR_L4_DPORT)
102 .put(Criterion.Type.UDP_SRC, FabricConstants.HDR_L4_SPORT)
103 .put(Criterion.Type.UDP_DST_MASKED, FabricConstants.HDR_L4_DPORT)
104 .put(Criterion.Type.UDP_SRC_MASKED, FabricConstants.HDR_L4_SPORT)
105 .put(Criterion.Type.TCP_DST, FabricConstants.HDR_L4_DPORT)
106 .put(Criterion.Type.TCP_SRC, FabricConstants.HDR_L4_SPORT)
107 .put(Criterion.Type.TCP_DST_MASKED, FabricConstants.HDR_L4_DPORT)
108 .put(Criterion.Type.TCP_SRC_MASKED, FabricConstants.HDR_L4_SPORT)
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700109 .build();
110
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800111 private static final PiAction NOP = PiAction.builder()
112 .withId(FabricConstants.NOP).build();
Carmelo Cascone50d195f2018-09-11 13:26:38 -0700113
114 private static final ImmutableMap<PiTableId, PiAction> DEFAULT_ACTIONS =
115 ImmutableMap.<PiTableId, PiAction>builder()
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800116 .put(FabricConstants.FABRIC_INGRESS_FORWARDING_ROUTING_V4, NOP)
Carmelo Cascone50d195f2018-09-11 13:26:38 -0700117 .build();
118
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700119 @Override
120 public Optional<PiMatchFieldId> mapCriterionType(Criterion.Type type) {
121 return Optional.ofNullable(CRITERION_MAP.get(type));
122 }
123
124 @Override
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700125 public Optional<PiTableId> mapFlowRuleTableId(int flowRuleTableId) {
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800126 // The only use case for Index ID->PiTableId is when using the single
127 // table pipeliner. fabric.p4 is never used with such pipeliner.
128 return Optional.empty();
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700129 }
130
131 @Override
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700132 public PiAction mapTreatment(TrafficTreatment treatment, PiTableId piTableId)
133 throws PiInterpreterException {
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700134 if (FILTERING_CTRL_TBLS.contains(piTableId)) {
Yi Tseng47eac892018-07-11 02:17:04 +0800135 return FabricTreatmentInterpreter.mapFilteringTreatment(treatment, piTableId);
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700136 } else if (FORWARDING_CTRL_TBLS.contains(piTableId)) {
Yi Tseng47eac892018-07-11 02:17:04 +0800137 return FabricTreatmentInterpreter.mapForwardingTreatment(treatment, piTableId);
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800138 } else if (ACL_CTRL_TBLS.contains(piTableId)) {
139 return FabricTreatmentInterpreter.mapAclTreatment(treatment, piTableId);
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700140 } else if (NEXT_CTRL_TBLS.contains(piTableId)) {
Yi Tseng47eac892018-07-11 02:17:04 +0800141 return FabricTreatmentInterpreter.mapNextTreatment(treatment, piTableId);
Yi Tseng20f9e7b2018-05-24 23:27:39 +0800142 } else if (E_NEXT_CTRL_TBLS.contains(piTableId)) {
Yi Tseng47eac892018-07-11 02:17:04 +0800143 return FabricTreatmentInterpreter.mapEgressNextTreatment(treatment, piTableId);
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700144 } else {
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800145 throw new PiInterpreterException(format(
146 "Treatment mapping not supported for table '%s'", piTableId));
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700147 }
148 }
149
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800150 private PiPacketOperation createPiPacketOperation(
151 DeviceId deviceId, ByteBuffer data, long portNumber)
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700152 throws PiInterpreterException {
Carmelo Cascone4c289b72019-01-22 15:30:45 -0800153 PiPacketMetadata metadata = createPacketMetadata(portNumber);
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700154 return PiPacketOperation.builder()
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700155 .withType(PACKET_OUT)
156 .withData(copyFrom(data))
157 .withMetadatas(ImmutableList.of(metadata))
158 .build();
159 }
160
Carmelo Cascone4c289b72019-01-22 15:30:45 -0800161 private PiPacketMetadata createPacketMetadata(long portNumber)
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800162 throws PiInterpreterException {
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700163 try {
Carmelo Cascone4c289b72019-01-22 15:30:45 -0800164 return PiPacketMetadata.builder()
Yi Tseng43ee7e82018-04-12 16:37:34 +0800165 .withId(FabricConstants.EGRESS_PORT)
Carmelo Cascone1e8843f2018-07-19 19:01:12 +0200166 .withValue(copyFrom(portNumber).fit(PORT_BITWIDTH))
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700167 .build();
168 } catch (ImmutableByteSequence.ByteSequenceTrimException e) {
169 throw new PiInterpreterException(format(
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800170 "Port number '%d' too big, %s", portNumber, e.getMessage()));
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700171 }
172 }
173
174 @Override
175 public Collection<PiPacketOperation> mapOutboundPacket(OutboundPacket packet)
176 throws PiInterpreterException {
177 DeviceId deviceId = packet.sendThrough();
178 TrafficTreatment treatment = packet.treatment();
179
180 // fabric.p4 supports only OUTPUT instructions.
181 List<Instructions.OutputInstruction> outInstructions = treatment
182 .allInstructions()
183 .stream()
184 .filter(i -> i.type().equals(OUTPUT))
185 .map(i -> (Instructions.OutputInstruction) i)
186 .collect(toList());
187
188 if (treatment.allInstructions().size() != outInstructions.size()) {
189 // There are other instructions that are not of type OUTPUT.
190 throw new PiInterpreterException("Treatment not supported: " + treatment);
191 }
192
193 ImmutableList.Builder<PiPacketOperation> builder = ImmutableList.builder();
194 for (Instructions.OutputInstruction outInst : outInstructions) {
195 if (outInst.port().isLogical() && !outInst.port().equals(FLOOD)) {
196 throw new PiInterpreterException(format(
197 "Output on logical port '%s' not supported", outInst.port()));
198 } else if (outInst.port().equals(FLOOD)) {
199 // Since fabric.p4 does not support flooding, we create a packet
200 // operation for each switch port.
201 final DeviceService deviceService = handler().get(DeviceService.class);
202 for (Port port : deviceService.getPorts(packet.sendThrough())) {
203 builder.add(createPiPacketOperation(deviceId, packet.data(), port.number().toLong()));
204 }
205 } else {
206 builder.add(createPiPacketOperation(deviceId, packet.data(), outInst.port().toLong()));
207 }
208 }
209 return builder.build();
210 }
211
212 @Override
Carmelo Cascone4c289b72019-01-22 15:30:45 -0800213 public InboundPacket mapInboundPacket(PiPacketOperation packetIn, DeviceId deviceId) throws PiInterpreterException {
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700214 // Assuming that the packet is ethernet, which is fine since fabric.p4
215 // can deparse only ethernet packets.
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700216 Ethernet ethPkt;
217 try {
218 ethPkt = Ethernet.deserializer().deserialize(packetIn.data().asArray(), 0,
219 packetIn.data().size());
220 } catch (DeserializationException dex) {
221 throw new PiInterpreterException(dex.getMessage());
222 }
223
224 // Returns the ingress port packet metadata.
Carmelo Cascone4c289b72019-01-22 15:30:45 -0800225 Optional<PiPacketMetadata> packetMetadata = packetIn.metadatas()
Yi Tseng43ee7e82018-04-12 16:37:34 +0800226 .stream().filter(m -> m.id().equals(FabricConstants.INGRESS_PORT))
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700227 .findFirst();
228
229 if (packetMetadata.isPresent()) {
230 ImmutableByteSequence portByteSequence = packetMetadata.get().value();
231 short s = portByteSequence.asReadOnlyBuffer().getShort();
232 ConnectPoint receivedFrom = new ConnectPoint(deviceId, PortNumber.portNumber(s));
233 ByteBuffer rawData = ByteBuffer.wrap(packetIn.data().asArray());
234 return new DefaultInboundPacket(receivedFrom, ethPkt, rawData);
235 } else {
236 throw new PiInterpreterException(format(
237 "Missing metadata '%s' in packet-in received from '%s': %s",
Yi Tseng43ee7e82018-04-12 16:37:34 +0800238 FabricConstants.INGRESS_PORT, deviceId, packetIn));
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700239 }
240 }
Carmelo Cascone6880ba62018-09-06 00:04:34 -0700241
242 @Override
Carmelo Cascone50d195f2018-09-11 13:26:38 -0700243 public Optional<PiAction> getOriginalDefaultAction(PiTableId tableId) {
244 return Optional.ofNullable(DEFAULT_ACTIONS.get(tableId));
245 }
246
247 @Override
Carmelo Cascone6880ba62018-09-06 00:04:34 -0700248 public Optional<Integer> mapLogicalPortNumber(PortNumber port) {
249 if (!port.equals(CONTROLLER)) {
250 return Optional.empty();
251 }
Carmelo Casconeb5324e72018-11-25 02:26:32 -0800252 return capabilities.cpuPort();
Carmelo Cascone6880ba62018-09-06 00:04:34 -0700253 }
Yi Tsengfa4a1c72017-11-03 10:22:38 -0700254}