| /* |
| * Copyright 2017-present Open Networking Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.onosproject.pipelines.fabric; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| import org.onlab.packet.DeserializationException; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.util.ImmutableByteSequence; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.Port; |
| import org.onosproject.net.PortNumber; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.flow.TrafficTreatment; |
| import org.onosproject.net.flow.criteria.Criterion; |
| import org.onosproject.net.flow.instructions.Instructions; |
| import org.onosproject.net.packet.DefaultInboundPacket; |
| import org.onosproject.net.packet.InboundPacket; |
| import org.onosproject.net.packet.OutboundPacket; |
| import org.onosproject.net.pi.model.PiMatchFieldId; |
| import org.onosproject.net.pi.model.PiPipelineInterpreter; |
| import org.onosproject.net.pi.model.PiTableId; |
| import org.onosproject.net.pi.runtime.PiAction; |
| import org.onosproject.net.pi.runtime.PiControlMetadata; |
| import org.onosproject.net.pi.runtime.PiPacketOperation; |
| |
| import java.nio.ByteBuffer; |
| import java.util.Collection; |
| import java.util.List; |
| import java.util.Optional; |
| import java.util.Set; |
| |
| import static java.lang.String.format; |
| import static java.util.stream.Collectors.toList; |
| import static org.onlab.util.ImmutableByteSequence.copyFrom; |
| import static org.onosproject.net.PortNumber.CONTROLLER; |
| import static org.onosproject.net.PortNumber.FLOOD; |
| import static org.onosproject.net.flow.instructions.Instruction.Type.OUTPUT; |
| import static org.onosproject.net.pi.model.PiPacketOperationType.PACKET_OUT; |
| |
| /** |
| * Interpreter for fabric pipeline. |
| */ |
| public class FabricInterpreter extends AbstractFabricHandlerBehavior |
| implements PiPipelineInterpreter { |
| |
| private static final int PORT_BITWIDTH = 9; |
| |
| // Group tables by control block. |
| private static final Set<PiTableId> FILTERING_CTRL_TBLS = ImmutableSet.of( |
| FabricConstants.FABRIC_INGRESS_FILTERING_INGRESS_PORT_VLAN, |
| FabricConstants.FABRIC_INGRESS_FILTERING_FWD_CLASSIFIER); |
| private static final Set<PiTableId> FORWARDING_CTRL_TBLS = ImmutableSet.of( |
| FabricConstants.FABRIC_INGRESS_FORWARDING_MPLS, |
| FabricConstants.FABRIC_INGRESS_FORWARDING_ROUTING_V4, |
| FabricConstants.FABRIC_INGRESS_FORWARDING_ROUTING_V6, |
| FabricConstants.FABRIC_INGRESS_FORWARDING_BRIDGING); |
| private static final Set<PiTableId> ACL_CTRL_TBLS = ImmutableSet.of( |
| FabricConstants.FABRIC_INGRESS_ACL_ACL); |
| private static final Set<PiTableId> NEXT_CTRL_TBLS = ImmutableSet.of( |
| FabricConstants.FABRIC_INGRESS_NEXT_NEXT_VLAN, |
| FabricConstants.FABRIC_INGRESS_NEXT_SIMPLE, |
| FabricConstants.FABRIC_INGRESS_NEXT_HASHED, |
| FabricConstants.FABRIC_INGRESS_NEXT_XCONNECT); |
| private static final Set<PiTableId> E_NEXT_CTRL_TBLS = ImmutableSet.of( |
| FabricConstants.FABRIC_EGRESS_EGRESS_NEXT_EGRESS_VLAN); |
| |
| private static final ImmutableMap<Criterion.Type, PiMatchFieldId> CRITERION_MAP = |
| ImmutableMap.<Criterion.Type, PiMatchFieldId>builder() |
| .put(Criterion.Type.IN_PORT, FabricConstants.HDR_IG_PORT) |
| .put(Criterion.Type.ETH_DST, FabricConstants.HDR_ETH_DST) |
| .put(Criterion.Type.ETH_SRC, FabricConstants.HDR_ETH_SRC) |
| .put(Criterion.Type.ETH_DST_MASKED, FabricConstants.HDR_ETH_DST) |
| .put(Criterion.Type.ETH_SRC_MASKED, FabricConstants.HDR_ETH_SRC) |
| .put(Criterion.Type.ETH_TYPE, FabricConstants.HDR_ETH_TYPE) |
| .put(Criterion.Type.MPLS_LABEL, FabricConstants.HDR_MPLS_LABEL) |
| .put(Criterion.Type.VLAN_VID, FabricConstants.HDR_VLAN_ID) |
| .put(Criterion.Type.IPV4_DST, FabricConstants.HDR_IPV4_DST) |
| .put(Criterion.Type.IPV4_SRC, FabricConstants.HDR_IPV4_SRC) |
| .put(Criterion.Type.IPV6_DST, FabricConstants.HDR_IPV6_DST) |
| .put(Criterion.Type.IP_PROTO, FabricConstants.HDR_IP_PROTO) |
| .put(Criterion.Type.ICMPV6_TYPE, FabricConstants.HDR_ICMP_TYPE) |
| .put(Criterion.Type.ICMPV6_CODE, FabricConstants.HDR_ICMP_CODE) |
| .build(); |
| |
| private static final ImmutableMap<PiMatchFieldId, Criterion.Type> INVERSE_CRITERION_MAP = |
| ImmutableMap.<PiMatchFieldId, Criterion.Type>builder() |
| .put(FabricConstants.HDR_IG_PORT, Criterion.Type.IN_PORT) |
| .put(FabricConstants.HDR_ETH_DST, Criterion.Type.ETH_DST_MASKED) |
| .put(FabricConstants.HDR_ETH_SRC, Criterion.Type.ETH_SRC_MASKED) |
| .put(FabricConstants.HDR_ETH_TYPE, Criterion.Type.ETH_TYPE) |
| .put(FabricConstants.HDR_MPLS_LABEL, Criterion.Type.MPLS_LABEL) |
| .put(FabricConstants.HDR_VLAN_ID, Criterion.Type.VLAN_VID) |
| .put(FabricConstants.HDR_IPV4_DST, Criterion.Type.IPV4_DST) |
| .put(FabricConstants.HDR_IPV4_SRC, Criterion.Type.IPV4_SRC) |
| .put(FabricConstants.HDR_IPV6_DST, Criterion.Type.IPV6_DST) |
| // FIXME: might be incorrect if we inverse the map.... |
| .put(FabricConstants.HDR_L4_SPORT, Criterion.Type.UDP_SRC) |
| .put(FabricConstants.HDR_L4_DPORT, Criterion.Type.UDP_DST) |
| .put(FabricConstants.HDR_IP_PROTO, Criterion.Type.IP_PROTO) |
| .put(FabricConstants.HDR_ICMP_TYPE, Criterion.Type.ICMPV6_TYPE) |
| .put(FabricConstants.HDR_ICMP_CODE, Criterion.Type.ICMPV6_CODE) |
| .build(); |
| |
| private static final PiAction NOP = PiAction.builder() |
| .withId(FabricConstants.NOP).build(); |
| |
| private static final ImmutableMap<PiTableId, PiAction> DEFAULT_ACTIONS = |
| ImmutableMap.<PiTableId, PiAction>builder() |
| .put(FabricConstants.FABRIC_INGRESS_FORWARDING_ROUTING_V4, NOP) |
| .build(); |
| |
| @Override |
| public Optional<PiMatchFieldId> mapCriterionType(Criterion.Type type) { |
| return Optional.ofNullable(CRITERION_MAP.get(type)); |
| } |
| |
| @Override |
| public Optional<Criterion.Type> mapPiMatchFieldId(PiMatchFieldId fieldId) { |
| return Optional.ofNullable(INVERSE_CRITERION_MAP.get(fieldId)); |
| } |
| |
| @Override |
| public Optional<PiTableId> mapFlowRuleTableId(int flowRuleTableId) { |
| // The only use case for Index ID->PiTableId is when using the single |
| // table pipeliner. fabric.p4 is never used with such pipeliner. |
| return Optional.empty(); |
| } |
| |
| @Override |
| public Optional<Integer> mapPiTableId(PiTableId piTableId) { |
| // The only use case for Index ID->PiTableId is when using the single |
| // table pipeliner. fabric.p4 is never used with such pipeliner. |
| return Optional.empty(); |
| } |
| |
| @Override |
| public PiAction mapTreatment(TrafficTreatment treatment, PiTableId piTableId) |
| throws PiInterpreterException { |
| if (FILTERING_CTRL_TBLS.contains(piTableId)) { |
| return FabricTreatmentInterpreter.mapFilteringTreatment(treatment, piTableId); |
| } else if (FORWARDING_CTRL_TBLS.contains(piTableId)) { |
| return FabricTreatmentInterpreter.mapForwardingTreatment(treatment, piTableId); |
| } else if (ACL_CTRL_TBLS.contains(piTableId)) { |
| return FabricTreatmentInterpreter.mapAclTreatment(treatment, piTableId); |
| } else if (NEXT_CTRL_TBLS.contains(piTableId)) { |
| return FabricTreatmentInterpreter.mapNextTreatment(treatment, piTableId); |
| } else if (E_NEXT_CTRL_TBLS.contains(piTableId)) { |
| return FabricTreatmentInterpreter.mapEgressNextTreatment(treatment, piTableId); |
| } else { |
| throw new PiInterpreterException(format( |
| "Treatment mapping not supported for table '%s'", piTableId)); |
| } |
| } |
| |
| private PiPacketOperation createPiPacketOperation( |
| DeviceId deviceId, ByteBuffer data, long portNumber) |
| throws PiInterpreterException { |
| PiControlMetadata metadata = createPacketMetadata(portNumber); |
| return PiPacketOperation.builder() |
| .forDevice(deviceId) |
| .withType(PACKET_OUT) |
| .withData(copyFrom(data)) |
| .withMetadatas(ImmutableList.of(metadata)) |
| .build(); |
| } |
| |
| private PiControlMetadata createPacketMetadata(long portNumber) |
| throws PiInterpreterException { |
| try { |
| return PiControlMetadata.builder() |
| .withId(FabricConstants.EGRESS_PORT) |
| .withValue(copyFrom(portNumber).fit(PORT_BITWIDTH)) |
| .build(); |
| } catch (ImmutableByteSequence.ByteSequenceTrimException e) { |
| throw new PiInterpreterException(format( |
| "Port number '%d' too big, %s", portNumber, e.getMessage())); |
| } |
| } |
| |
| @Override |
| public Collection<PiPacketOperation> mapOutboundPacket(OutboundPacket packet) |
| throws PiInterpreterException { |
| DeviceId deviceId = packet.sendThrough(); |
| TrafficTreatment treatment = packet.treatment(); |
| |
| // fabric.p4 supports only OUTPUT instructions. |
| List<Instructions.OutputInstruction> outInstructions = treatment |
| .allInstructions() |
| .stream() |
| .filter(i -> i.type().equals(OUTPUT)) |
| .map(i -> (Instructions.OutputInstruction) i) |
| .collect(toList()); |
| |
| if (treatment.allInstructions().size() != outInstructions.size()) { |
| // There are other instructions that are not of type OUTPUT. |
| throw new PiInterpreterException("Treatment not supported: " + treatment); |
| } |
| |
| ImmutableList.Builder<PiPacketOperation> builder = ImmutableList.builder(); |
| for (Instructions.OutputInstruction outInst : outInstructions) { |
| if (outInst.port().isLogical() && !outInst.port().equals(FLOOD)) { |
| throw new PiInterpreterException(format( |
| "Output on logical port '%s' not supported", outInst.port())); |
| } else if (outInst.port().equals(FLOOD)) { |
| // Since fabric.p4 does not support flooding, we create a packet |
| // operation for each switch port. |
| final DeviceService deviceService = handler().get(DeviceService.class); |
| for (Port port : deviceService.getPorts(packet.sendThrough())) { |
| builder.add(createPiPacketOperation(deviceId, packet.data(), port.number().toLong())); |
| } |
| } else { |
| builder.add(createPiPacketOperation(deviceId, packet.data(), outInst.port().toLong())); |
| } |
| } |
| return builder.build(); |
| } |
| |
| @Override |
| public InboundPacket mapInboundPacket(PiPacketOperation packetIn) throws PiInterpreterException { |
| // Assuming that the packet is ethernet, which is fine since fabric.p4 |
| // can deparse only ethernet packets. |
| DeviceId deviceId = packetIn.deviceId(); |
| Ethernet ethPkt; |
| try { |
| ethPkt = Ethernet.deserializer().deserialize(packetIn.data().asArray(), 0, |
| packetIn.data().size()); |
| } catch (DeserializationException dex) { |
| throw new PiInterpreterException(dex.getMessage()); |
| } |
| |
| // Returns the ingress port packet metadata. |
| Optional<PiControlMetadata> packetMetadata = packetIn.metadatas() |
| .stream().filter(m -> m.id().equals(FabricConstants.INGRESS_PORT)) |
| .findFirst(); |
| |
| if (packetMetadata.isPresent()) { |
| ImmutableByteSequence portByteSequence = packetMetadata.get().value(); |
| short s = portByteSequence.asReadOnlyBuffer().getShort(); |
| ConnectPoint receivedFrom = new ConnectPoint(deviceId, PortNumber.portNumber(s)); |
| ByteBuffer rawData = ByteBuffer.wrap(packetIn.data().asArray()); |
| return new DefaultInboundPacket(receivedFrom, ethPkt, rawData); |
| } else { |
| throw new PiInterpreterException(format( |
| "Missing metadata '%s' in packet-in received from '%s': %s", |
| FabricConstants.INGRESS_PORT, deviceId, packetIn)); |
| } |
| } |
| |
| @Override |
| public Optional<PiAction> getOriginalDefaultAction(PiTableId tableId) { |
| return Optional.ofNullable(DEFAULT_ACTIONS.get(tableId)); |
| } |
| |
| @Override |
| public Optional<Integer> mapLogicalPortNumber(PortNumber port) { |
| if (!port.equals(CONTROLLER)) { |
| return Optional.empty(); |
| } |
| return capabilities.cpuPort(); |
| } |
| } |