wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 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.p4runtime.packet.impl; |
| 18 | |
| 19 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 20 | import org.osgi.service.component.annotations.Activate; |
| 21 | import org.osgi.service.component.annotations.Component; |
| 22 | import org.osgi.service.component.annotations.Deactivate; |
| 23 | import org.osgi.service.component.annotations.Reference; |
| 24 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Andrea Campanella | 14e196d | 2017-07-24 18:11:36 +0200 | [diff] [blame] | 25 | import org.onosproject.mastership.MastershipService; |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 26 | import org.onosproject.net.Device; |
| 27 | import org.onosproject.net.DeviceId; |
| 28 | import org.onosproject.net.device.DeviceService; |
| 29 | import org.onosproject.net.flow.TrafficTreatment; |
| 30 | import org.onosproject.net.packet.DefaultOutboundPacket; |
| 31 | import org.onosproject.net.packet.DefaultPacketContext; |
| 32 | import org.onosproject.net.packet.InboundPacket; |
| 33 | import org.onosproject.net.packet.OutboundPacket; |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 34 | import org.onosproject.net.packet.PacketContext; |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 35 | import org.onosproject.net.packet.PacketProgrammable; |
| 36 | import org.onosproject.net.packet.PacketProvider; |
| 37 | import org.onosproject.net.packet.PacketProviderRegistry; |
| 38 | import org.onosproject.net.packet.PacketProviderService; |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 39 | import org.onosproject.net.pi.model.PiPipelineInterpreter; |
| 40 | import org.onosproject.net.pi.runtime.PiPacketOperation; |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 41 | import org.onosproject.net.provider.AbstractProvider; |
| 42 | import org.onosproject.net.provider.ProviderId; |
| 43 | import org.onosproject.p4runtime.api.P4RuntimeController; |
| 44 | import org.onosproject.p4runtime.api.P4RuntimeEvent; |
| 45 | import org.onosproject.p4runtime.api.P4RuntimeEventListener; |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 46 | import org.onosproject.p4runtime.api.P4RuntimePacketIn; |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 47 | import org.slf4j.Logger; |
| 48 | |
| 49 | import java.nio.ByteBuffer; |
| 50 | |
| 51 | import static org.onosproject.net.flow.DefaultTrafficTreatment.emptyTreatment; |
| 52 | import static org.slf4j.LoggerFactory.getLogger; |
| 53 | |
| 54 | /** |
| 55 | * Implementation of a packet provider for P4Runtime device. |
| 56 | */ |
| 57 | @Component(immediate = true) |
| 58 | public class P4RuntimePacketProvider extends AbstractProvider implements PacketProvider { |
| 59 | |
| 60 | private final Logger log = getLogger(getClass()); |
| 61 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 62 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 63 | protected P4RuntimeController controller; |
| 64 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 66 | protected PacketProviderRegistry providerRegistry; |
| 67 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 69 | protected DeviceService deviceService; |
| 70 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | 14e196d | 2017-07-24 18:11:36 +0200 | [diff] [blame] | 72 | protected MastershipService mastershipService; |
| 73 | |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 74 | private PacketProviderService providerService; |
| 75 | |
| 76 | private InternalPacketListener packetListener = new InternalPacketListener(); |
| 77 | |
| 78 | /** |
| 79 | * Creates a new P4Runtime packet provider. |
| 80 | */ |
| 81 | public P4RuntimePacketProvider() { |
| 82 | super(new ProviderId("p4runtime", "org.onosproject.provider.p4runtime.packet")); |
| 83 | } |
| 84 | |
| 85 | @Activate |
| 86 | protected void activate() { |
| 87 | providerService = providerRegistry.register(this); |
| 88 | controller.addListener(packetListener); |
| 89 | log.info("Started"); |
| 90 | } |
| 91 | |
| 92 | @Deactivate |
| 93 | public void deactivate() { |
| 94 | controller.removeListener(packetListener); |
| 95 | providerRegistry.unregister(this); |
| 96 | providerService = null; |
| 97 | log.info("Stopped"); |
| 98 | } |
| 99 | |
| 100 | @Override |
| 101 | public void emit(OutboundPacket packet) { |
| 102 | if (packet != null) { |
| 103 | DeviceId deviceId = packet.sendThrough(); |
| 104 | Device device = deviceService.getDevice(deviceId); |
Andrea Campanella | 14e196d | 2017-07-24 18:11:36 +0200 | [diff] [blame] | 105 | if (device.is(PacketProgrammable.class) && mastershipService.isLocalMaster(deviceId)) { |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 106 | PacketProgrammable packetProgrammable = device.as(PacketProgrammable.class); |
| 107 | packetProgrammable.emit(packet); |
| 108 | } else { |
| 109 | log.warn("No PacketProgrammable behavior for device {}", deviceId); |
| 110 | } |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Internal packet context implementation. |
| 116 | */ |
| 117 | private class P4RuntimePacketContext extends DefaultPacketContext { |
| 118 | |
| 119 | P4RuntimePacketContext(long time, InboundPacket inPkt, OutboundPacket outPkt, boolean block) { |
| 120 | super(time, inPkt, outPkt, block); |
| 121 | } |
| 122 | |
| 123 | @Override |
| 124 | public void send() { |
| 125 | |
| 126 | if (this.block()) { |
| 127 | log.info("Unable to send, packet context is blocked"); |
| 128 | return; |
| 129 | } |
| 130 | |
| 131 | DeviceId deviceId = outPacket().sendThrough(); |
| 132 | ByteBuffer rawData = outPacket().data(); |
| 133 | |
| 134 | TrafficTreatment treatment; |
| 135 | if (outPacket().treatment() == null) { |
| 136 | treatment = (treatmentBuilder() == null) ? emptyTreatment() : treatmentBuilder().build(); |
| 137 | } else { |
| 138 | treatment = outPacket().treatment(); |
| 139 | } |
| 140 | |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 141 | OutboundPacket outboundPacket = new DefaultOutboundPacket(deviceId, treatment, rawData); |
| 142 | log.debug("Processing outbound packet: {}", outboundPacket); |
| 143 | |
| 144 | emit(outboundPacket); |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 145 | } |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Internal packet listener to handle packet-in events received from the P4Runtime controller. |
| 150 | */ |
| 151 | private class InternalPacketListener implements P4RuntimeEventListener { |
| 152 | |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 153 | @Override |
| 154 | public void event(P4RuntimeEvent event) { |
Andrea Campanella | 14e196d | 2017-07-24 18:11:36 +0200 | [diff] [blame] | 155 | //Masterhip message is sent to everybody but picked up only by master. |
| 156 | //FIXME we need the device ID into p4RuntimeEvnetSubject to check for mastsership |
| 157 | if (!(event.subject() instanceof P4RuntimePacketIn) || event.type() != P4RuntimeEvent.Type.PACKET_IN) { |
| 158 | log.debug("Event type {}", event.type()); |
Yi Tseng | 3e7f145 | 2017-10-20 10:31:53 -0700 | [diff] [blame] | 159 | // Not a packet-in event, ignore it. |
| 160 | return; |
| 161 | } |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 162 | P4RuntimePacketIn eventSubject = (P4RuntimePacketIn) event.subject(); |
Carmelo Cascone | 5bff7ca | 2017-09-12 15:11:03 +0200 | [diff] [blame] | 163 | DeviceId deviceId = eventSubject.deviceId(); |
| 164 | |
| 165 | Device device = deviceService.getDevice(eventSubject.deviceId()); |
| 166 | if (device == null) { |
| 167 | log.warn("Unable to process packet-in from {}, device is null in the core", deviceId); |
| 168 | return; |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 169 | } |
Carmelo Cascone | 5bff7ca | 2017-09-12 15:11:03 +0200 | [diff] [blame] | 170 | |
| 171 | if (!device.is(PiPipelineInterpreter.class)) { |
| 172 | log.warn("Unable to process packet-in from {}, device has no PiPipelineInterpreter behaviour", |
Andrea Campanella | 14e196d | 2017-07-24 18:11:36 +0200 | [diff] [blame] | 173 | deviceId); |
Carmelo Cascone | 5bff7ca | 2017-09-12 15:11:03 +0200 | [diff] [blame] | 174 | return; |
| 175 | } |
| 176 | |
| 177 | PiPacketOperation operation = eventSubject.packetOperation(); |
| 178 | InboundPacket inPkt; |
| 179 | try { |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 180 | inPkt = device.as(PiPipelineInterpreter.class).mapInboundPacket(operation); |
Carmelo Cascone | 5bff7ca | 2017-09-12 15:11:03 +0200 | [diff] [blame] | 181 | } catch (PiPipelineInterpreter.PiInterpreterException e) { |
| 182 | log.warn("Unable to interpret inbound packet from {}: {}", deviceId, e.getMessage()); |
| 183 | return; |
| 184 | } |
| 185 | |
| 186 | if (inPkt == null) { |
| 187 | log.debug("Received null inbound packet. Ignoring."); |
| 188 | return; |
| 189 | } |
| 190 | |
| 191 | log.debug("Processing inbound packet: {}", inPkt.toString()); |
| 192 | |
| 193 | OutboundPacket outPkt = new DefaultOutboundPacket(eventSubject.deviceId(), null, |
Andrea Campanella | 14e196d | 2017-07-24 18:11:36 +0200 | [diff] [blame] | 194 | operation.data().asReadOnlyBuffer()); |
Carmelo Cascone | 5bff7ca | 2017-09-12 15:11:03 +0200 | [diff] [blame] | 195 | PacketContext pktCtx = new P4RuntimePacketContext(System.currentTimeMillis(), inPkt, outPkt, false); |
| 196 | |
| 197 | // Pushing the packet context up for processing. |
| 198 | providerService.processPacket(pktCtx); |
wu | 2883c76 | 2017-07-20 16:24:48 +0800 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | } |