Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.packet.impl; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 17 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 18 | import static com.google.common.base.Preconditions.checkNotNull; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 19 | import static org.slf4j.LoggerFactory.getLogger; |
| 20 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 21 | import java.util.Collections; |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 22 | import java.util.Map; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 23 | import java.util.Set; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 24 | import java.util.concurrent.ConcurrentHashMap; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 25 | |
| 26 | import org.apache.felix.scr.annotations.Activate; |
| 27 | import org.apache.felix.scr.annotations.Component; |
| 28 | import org.apache.felix.scr.annotations.Deactivate; |
| 29 | import org.apache.felix.scr.annotations.Reference; |
| 30 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 31 | import org.apache.felix.scr.annotations.Service; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 32 | import org.onosproject.core.ApplicationId; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 33 | import org.onosproject.net.Device; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 34 | import org.onosproject.net.device.DeviceEvent; |
| 35 | import org.onosproject.net.device.DeviceListener; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 36 | import org.onosproject.net.device.DeviceService; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 37 | import org.onosproject.net.flow.DefaultFlowRule; |
| 38 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 39 | import org.onosproject.net.flow.FlowRule; |
| 40 | import org.onosproject.net.flow.FlowRuleService; |
| 41 | import org.onosproject.net.flow.TrafficSelector; |
| 42 | import org.onosproject.net.flow.TrafficTreatment; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 43 | import org.onosproject.net.packet.OutboundPacket; |
| 44 | import org.onosproject.net.packet.PacketContext; |
| 45 | import org.onosproject.net.packet.PacketEvent; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 46 | import org.onosproject.net.packet.PacketPriority; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 47 | import org.onosproject.net.packet.PacketProcessor; |
| 48 | import org.onosproject.net.packet.PacketProvider; |
| 49 | import org.onosproject.net.packet.PacketProviderRegistry; |
| 50 | import org.onosproject.net.packet.PacketProviderService; |
| 51 | import org.onosproject.net.packet.PacketService; |
| 52 | import org.onosproject.net.packet.PacketStore; |
| 53 | import org.onosproject.net.packet.PacketStoreDelegate; |
| 54 | import org.onosproject.net.provider.AbstractProviderRegistry; |
| 55 | import org.onosproject.net.provider.AbstractProviderService; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 56 | import org.slf4j.Logger; |
| 57 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 58 | /** |
| 59 | * Provides a basic implementation of the packet SB & NB APIs. |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 60 | */ |
| 61 | @Component(immediate = true) |
| 62 | @Service |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 63 | public class PacketManager |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 64 | extends AbstractProviderRegistry<PacketProvider, PacketProviderService> |
| 65 | implements PacketService, PacketProviderRegistry { |
| 66 | |
| 67 | private final Logger log = getLogger(getClass()); |
| 68 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 69 | private final PacketStoreDelegate delegate = new InternalStoreDelegate(); |
| 70 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 72 | private DeviceService deviceService; |
| 73 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 75 | private FlowRuleService flowService; |
| 76 | |
| 77 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 78 | private PacketStore store; |
| 79 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 80 | private final DeviceListener deviceListener = new InternalDeviceListener(); |
| 81 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 82 | private final Map<Integer, PacketProcessor> processors = new ConcurrentHashMap<>(); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 83 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 84 | private Set<PacketRequest> packetRequests = |
| 85 | Collections.newSetFromMap(new ConcurrentHashMap<>()); |
| 86 | |
| 87 | private final class PacketRequest { |
| 88 | private final TrafficSelector selector; |
| 89 | private final PacketPriority priority; |
| 90 | private final ApplicationId appId; |
| 91 | |
| 92 | public PacketRequest(TrafficSelector selector, PacketPriority priority, |
| 93 | ApplicationId appId) { |
| 94 | this.selector = selector; |
| 95 | this.priority = priority; |
| 96 | this.appId = appId; |
| 97 | } |
| 98 | |
| 99 | public TrafficSelector selector() { |
| 100 | return selector; |
| 101 | } |
| 102 | |
| 103 | public PacketPriority priority() { |
| 104 | return priority; |
| 105 | } |
| 106 | |
| 107 | public ApplicationId appId() { |
| 108 | return appId; |
| 109 | } |
| 110 | |
| 111 | } |
| 112 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 113 | @Activate |
| 114 | public void activate() { |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 115 | store.setDelegate(delegate); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 116 | deviceService.addListener(deviceListener); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 117 | log.info("Started"); |
| 118 | } |
| 119 | |
| 120 | @Deactivate |
| 121 | public void deactivate() { |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 122 | store.unsetDelegate(delegate); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 123 | deviceService.removeListener(deviceListener); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 124 | log.info("Stopped"); |
| 125 | } |
| 126 | |
| 127 | @Override |
| 128 | public void addProcessor(PacketProcessor processor, int priority) { |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 129 | checkNotNull(processor, "Processor cannot be null"); |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 130 | processors.put(priority, processor); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public void removeProcessor(PacketProcessor processor) { |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 135 | checkNotNull(processor, "Processor cannot be null"); |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 136 | processors.values().remove(processor); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | @Override |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 140 | public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 141 | ApplicationId appId) { |
| 142 | checkNotNull(selector, "Selector cannot be null"); |
| 143 | checkNotNull(appId, "Application ID cannot be null"); |
| 144 | |
| 145 | PacketRequest request = |
| 146 | new PacketRequest(selector, priority, appId); |
| 147 | |
| 148 | packetRequests.add(request); |
| 149 | pushToAllDevices(request); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Pushes a packet request flow rule to all devices. |
| 154 | * |
| 155 | * @param request the packet request |
| 156 | */ |
| 157 | private void pushToAllDevices(PacketRequest request) { |
| 158 | for (Device device : deviceService.getDevices()) { |
| 159 | pushRule(device, request); |
| 160 | } |
| 161 | } |
| 162 | |
| 163 | /** |
| 164 | * Pushes flow rules to the device to request packets be sent to the |
| 165 | * controller. |
| 166 | * |
| 167 | * @param device the device to push the rules to |
| 168 | * @param request the packet request |
| 169 | */ |
| 170 | private void pushRule(Device device, PacketRequest request) { |
| 171 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 172 | .punt() |
| 173 | .build(); |
| 174 | |
| 175 | FlowRule flow = new DefaultFlowRule(device.id(), |
| 176 | request.selector(), |
| 177 | treatment, |
| 178 | request.priority().priorityValue(), |
| 179 | request.appId(), |
| 180 | 0, true); |
| 181 | |
| 182 | flowService.applyFlowRules(flow); |
| 183 | } |
| 184 | |
| 185 | @Override |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 186 | public void emit(OutboundPacket packet) { |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 187 | checkNotNull(packet, "Packet cannot be null"); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 188 | |
| 189 | store.emit(packet); |
| 190 | } |
| 191 | |
| 192 | private void localEmit(OutboundPacket packet) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 193 | final Device device = deviceService.getDevice(packet.sendThrough()); |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 194 | |
| 195 | if (device == null) { |
| 196 | return; |
| 197 | } |
| 198 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 199 | final PacketProvider packetProvider = getProvider(device.providerId()); |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 200 | |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 201 | if (packetProvider != null) { |
| 202 | packetProvider.emit(packet); |
| 203 | } |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 204 | } |
| 205 | |
| 206 | @Override |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 207 | protected PacketProviderService createProviderService(PacketProvider provider) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 208 | return new InternalPacketProviderService(provider); |
| 209 | } |
| 210 | |
| 211 | // Personalized link provider service issued to the supplied provider. |
| 212 | private class InternalPacketProviderService |
| 213 | extends AbstractProviderService<PacketProvider> |
| 214 | implements PacketProviderService { |
| 215 | |
| 216 | protected InternalPacketProviderService(PacketProvider provider) { |
| 217 | super(provider); |
| 218 | } |
| 219 | |
| 220 | @Override |
| 221 | public void processPacket(PacketContext context) { |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 222 | // TODO filter packets sent to processors based on registrations |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 223 | for (PacketProcessor processor : processors.values()) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 224 | processor.process(context); |
| 225 | } |
| 226 | } |
| 227 | |
| 228 | } |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 229 | |
| 230 | /** |
| 231 | * Internal callback from the packet store. |
| 232 | */ |
| 233 | private class InternalStoreDelegate |
| 234 | implements PacketStoreDelegate { |
| 235 | @Override |
| 236 | public void notify(PacketEvent event) { |
| 237 | localEmit(event.subject()); |
| 238 | } |
| 239 | } |
| 240 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 241 | /** |
| 242 | * Internal listener for device service events. |
| 243 | */ |
| 244 | private class InternalDeviceListener implements DeviceListener { |
| 245 | @Override |
| 246 | public void event(DeviceEvent event) { |
| 247 | Device device = event.subject(); |
| 248 | if (event.type() == DeviceEvent.Type.DEVICE_ADDED) { |
| 249 | for (PacketRequest request : packetRequests) { |
| 250 | pushRule(device, request); |
| 251 | } |
| 252 | } |
| 253 | } |
| 254 | } |
| 255 | |
alshabib | ae85758 | 2014-09-12 23:53:10 -0700 | [diff] [blame] | 256 | } |