Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 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 | |
| 17 | package org.onosproject.provider.bmv2.packet.impl; |
| 18 | |
| 19 | import org.apache.felix.scr.annotations.Activate; |
| 20 | import org.apache.felix.scr.annotations.Component; |
| 21 | import org.apache.felix.scr.annotations.Deactivate; |
| 22 | import org.apache.felix.scr.annotations.Reference; |
| 23 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 24 | import org.onlab.packet.Ethernet; |
| 25 | import org.onlab.util.ImmutableByteSequence; |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 26 | import org.onosproject.bmv2.api.runtime.Bmv2Device; |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 27 | import org.onosproject.bmv2.api.service.Bmv2Controller; |
| 28 | import org.onosproject.bmv2.api.service.Bmv2PacketListener; |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 29 | import org.onosproject.core.CoreService; |
| 30 | import org.onosproject.net.ConnectPoint; |
| 31 | import org.onosproject.net.Device; |
| 32 | import org.onosproject.net.DeviceId; |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 33 | import org.onosproject.net.Port; |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 34 | import org.onosproject.net.PortNumber; |
| 35 | import org.onosproject.net.device.DeviceService; |
| 36 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 37 | import org.onosproject.net.flow.TrafficTreatment; |
| 38 | import org.onosproject.net.packet.DefaultInboundPacket; |
| 39 | import org.onosproject.net.packet.DefaultOutboundPacket; |
| 40 | import org.onosproject.net.packet.DefaultPacketContext; |
| 41 | import org.onosproject.net.packet.InboundPacket; |
| 42 | import org.onosproject.net.packet.OutboundPacket; |
| 43 | import org.onosproject.net.packet.PacketContext; |
| 44 | import org.onosproject.net.packet.PacketProgrammable; |
| 45 | import org.onosproject.net.packet.PacketProvider; |
| 46 | import org.onosproject.net.packet.PacketProviderRegistry; |
| 47 | import org.onosproject.net.packet.PacketProviderService; |
| 48 | import org.onosproject.net.provider.AbstractProvider; |
| 49 | import org.onosproject.net.provider.ProviderId; |
| 50 | import org.slf4j.Logger; |
| 51 | import org.slf4j.LoggerFactory; |
| 52 | |
| 53 | import java.nio.ByteBuffer; |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 54 | import java.util.Optional; |
| 55 | |
| 56 | import static org.onosproject.net.PortNumber.FLOOD; |
| 57 | import static org.onosproject.net.flow.DefaultTrafficTreatment.emptyTreatment; |
| 58 | import static org.onosproject.net.flow.instructions.Instruction.Type.OUTPUT; |
| 59 | import static org.onosproject.net.flow.instructions.Instructions.OutputInstruction; |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 60 | |
| 61 | /** |
| 62 | * Implementation of a packet provider for BMv2. |
| 63 | */ |
| 64 | @Component(immediate = true) |
| 65 | public class Bmv2PacketProvider extends AbstractProvider implements PacketProvider { |
| 66 | |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 67 | private final Logger log = LoggerFactory.getLogger(Bmv2PacketProvider.class); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 68 | private static final String APP_NAME = "org.onosproject.bmv2"; |
| 69 | |
| 70 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 71 | protected Bmv2Controller controller; |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 72 | |
| 73 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 74 | protected CoreService coreService; |
| 75 | |
| 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 77 | protected PacketProviderRegistry providerRegistry; |
| 78 | |
| 79 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 80 | protected DeviceService deviceService; |
| 81 | |
| 82 | private PacketProviderService providerService; |
| 83 | |
| 84 | private InternalPacketListener packetListener = new InternalPacketListener(); |
| 85 | |
| 86 | /** |
| 87 | * Creates a new BMv2 packet provider. |
| 88 | */ |
| 89 | public Bmv2PacketProvider() { |
| 90 | super(new ProviderId("bmv2", "org.onosproject.provider.packet")); |
| 91 | } |
| 92 | |
| 93 | @Activate |
| 94 | protected void activate() { |
| 95 | providerService = providerRegistry.register(this); |
| 96 | coreService.registerApplication(APP_NAME); |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 97 | controller.addPacketListener(packetListener); |
| 98 | log.info("Started"); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | @Deactivate |
| 102 | public void deactivate() { |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 103 | controller.removePacketListener(packetListener); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 104 | providerRegistry.unregister(this); |
| 105 | providerService = null; |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 106 | log.info("Stopped"); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | @Override |
| 110 | public void emit(OutboundPacket packet) { |
| 111 | if (packet != null) { |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 112 | DeviceId deviceId = packet.sendThrough(); |
| 113 | Device device = deviceService.getDevice(deviceId); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 114 | if (device.is(PacketProgrammable.class)) { |
| 115 | PacketProgrammable packetProgrammable = device.as(PacketProgrammable.class); |
| 116 | packetProgrammable.emit(packet); |
| 117 | } else { |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 118 | log.info("No PacketProgrammable behavior for device {}", deviceId); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 119 | } |
| 120 | } |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Internal packet context implementation. |
| 125 | */ |
| 126 | private class Bmv2PacketContext extends DefaultPacketContext { |
| 127 | |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 128 | Bmv2PacketContext(long time, InboundPacket inPkt, OutboundPacket outPkt, boolean block) { |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 129 | super(time, inPkt, outPkt, block); |
| 130 | } |
| 131 | |
| 132 | @Override |
| 133 | public void send() { |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 134 | |
| 135 | if (this.block()) { |
| 136 | log.info("Unable to send, packet context not blocked"); |
| 137 | return; |
| 138 | } |
| 139 | |
| 140 | DeviceId deviceId = outPacket().sendThrough(); |
| 141 | ByteBuffer rawData = outPacket().data(); |
| 142 | |
| 143 | TrafficTreatment treatment; |
| 144 | if (outPacket().treatment() == null) { |
| 145 | treatment = (treatmentBuilder() == null) ? emptyTreatment() : treatmentBuilder().build(); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 146 | } else { |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 147 | treatment = outPacket().treatment(); |
| 148 | } |
| 149 | |
| 150 | // BMv2 doesn't support FLOOD for packet-outs. |
| 151 | // Workaround here is to perform multiple emits, one for each device port != packet inPort. |
| 152 | Optional<OutputInstruction> floodInst = treatment.allInstructions() |
| 153 | .stream() |
| 154 | .filter(i -> i.type().equals(OUTPUT)) |
| 155 | .map(i -> (OutputInstruction) i) |
| 156 | .filter(i -> i.port().equals(FLOOD)) |
| 157 | .findAny(); |
| 158 | |
| 159 | if (floodInst.isPresent() && treatment.allInstructions().size() == 1) { |
| 160 | // Only one instruction and is FLOOD. Do the trick. |
| 161 | PortNumber inPort = inPacket().receivedFrom().port(); |
| 162 | deviceService.getPorts(outPacket().sendThrough()) |
| 163 | .stream() |
| 164 | .map(Port::number) |
| 165 | .filter(port -> !port.equals(inPort)) |
| 166 | .map(outPort -> DefaultTrafficTreatment.builder().setOutput(outPort).build()) |
| 167 | .map(outTreatment -> new DefaultOutboundPacket(deviceId, outTreatment, rawData)) |
| 168 | .forEach(Bmv2PacketProvider.this::emit); |
| 169 | } else { |
| 170 | // Not FLOOD treatment, what to do is up to driver. |
| 171 | emit(new DefaultOutboundPacket(deviceId, treatment, rawData)); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 172 | } |
| 173 | } |
| 174 | } |
| 175 | |
| 176 | /** |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 177 | * Internal packet listener to handle packet-in events received from the BMv2 controller. |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 178 | */ |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 179 | private class InternalPacketListener implements Bmv2PacketListener { |
| 180 | |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 181 | @Override |
Carmelo Cascone | 25f1888 | 2016-06-14 19:16:50 -0700 | [diff] [blame] | 182 | public void handlePacketIn(Bmv2Device device, int inputPort, ImmutableByteSequence packet) { |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 183 | Ethernet ethPkt = new Ethernet(); |
| 184 | ethPkt.deserialize(packet.asArray(), 0, packet.size()); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 185 | |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 186 | DeviceId deviceId = device.asDeviceId(); |
| 187 | ConnectPoint receivedFrom = new ConnectPoint(deviceId, PortNumber.portNumber(inputPort)); |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 188 | |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 189 | ByteBuffer rawData = ByteBuffer.wrap(packet.asArray()); |
| 190 | |
| 191 | InboundPacket inPkt = new DefaultInboundPacket(receivedFrom, ethPkt, rawData); |
| 192 | OutboundPacket outPkt = new DefaultOutboundPacket(deviceId, null, rawData); |
| 193 | |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 194 | PacketContext pktCtx = new Bmv2PacketContext(System.currentTimeMillis(), inPkt, outPkt, false); |
Carmelo Cascone | 0831efb | 2016-05-31 14:50:19 -0700 | [diff] [blame] | 195 | |
Carmelo Cascone | c0fbbee | 2016-04-27 18:03:36 -0700 | [diff] [blame] | 196 | providerService.processPacket(pktCtx); |
| 197 | } |
| 198 | } |
| 199 | } |