Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [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 | */ |
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 | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Reference; |
| 22 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 23 | import org.apache.felix.scr.annotations.Service; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 24 | import org.onosproject.core.ApplicationId; |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 25 | import org.onosproject.core.CoreService; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 26 | import org.onosproject.core.Permission; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 27 | import org.onosproject.net.Device; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 28 | import org.onosproject.net.device.DeviceEvent; |
| 29 | import org.onosproject.net.device.DeviceListener; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 30 | import org.onosproject.net.device.DeviceService; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 31 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 32 | import org.onosproject.net.flow.FlowRule; |
| 33 | import org.onosproject.net.flow.FlowRuleService; |
| 34 | import org.onosproject.net.flow.TrafficSelector; |
| 35 | import org.onosproject.net.flow.TrafficTreatment; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 36 | import org.onosproject.net.flowobjective.DefaultForwardingObjective; |
| 37 | import org.onosproject.net.flowobjective.FlowObjectiveService; |
| 38 | import org.onosproject.net.flowobjective.ForwardingObjective; |
| 39 | import org.onosproject.net.flowobjective.Objective; |
| 40 | import org.onosproject.net.flowobjective.ObjectiveContext; |
| 41 | import org.onosproject.net.flowobjective.ObjectiveError; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 42 | import org.onosproject.net.packet.DefaultPacketRequest; |
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; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 51 | import org.onosproject.net.packet.PacketRequest; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 52 | import org.onosproject.net.packet.PacketService; |
| 53 | import org.onosproject.net.packet.PacketStore; |
| 54 | import org.onosproject.net.packet.PacketStoreDelegate; |
| 55 | import org.onosproject.net.provider.AbstractProviderRegistry; |
| 56 | import org.onosproject.net.provider.AbstractProviderService; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 57 | import org.slf4j.Logger; |
| 58 | |
alshabib | 089bb77 | 2015-03-03 18:26:26 -0800 | [diff] [blame] | 59 | import java.util.Map; |
alshabib | 089bb77 | 2015-03-03 18:26:26 -0800 | [diff] [blame] | 60 | import java.util.concurrent.ConcurrentHashMap; |
| 61 | |
| 62 | import static com.google.common.base.Preconditions.checkNotNull; |
| 63 | import static org.slf4j.LoggerFactory.getLogger; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 64 | import static org.onosproject.security.AppGuard.checkPermission; |
| 65 | |
alshabib | 089bb77 | 2015-03-03 18:26:26 -0800 | [diff] [blame] | 66 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 67 | /** |
| 68 | * Provides a basic implementation of the packet SB & NB APIs. |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 69 | */ |
| 70 | @Component(immediate = true) |
| 71 | @Service |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 72 | public class PacketManager |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 73 | extends AbstractProviderRegistry<PacketProvider, PacketProviderService> |
| 74 | implements PacketService, PacketProviderRegistry { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 75 | |
| 76 | private final Logger log = getLogger(getClass()); |
| 77 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 78 | private final PacketStoreDelegate delegate = new InternalStoreDelegate(); |
| 79 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 80 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 81 | private CoreService coreService; |
| 82 | |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 84 | private DeviceService deviceService; |
| 85 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 86 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 87 | private FlowRuleService flowService; |
| 88 | |
| 89 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 90 | private PacketStore store; |
| 91 | |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 92 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 93 | private FlowObjectiveService objectiveService; |
| 94 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 95 | private final DeviceListener deviceListener = new InternalDeviceListener(); |
| 96 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 97 | private final Map<Integer, PacketProcessor> processors = new ConcurrentHashMap<>(); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 98 | |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 99 | private ApplicationId appId; |
| 100 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 101 | @Activate |
| 102 | public void activate() { |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 103 | appId = coreService.getAppId(CoreService.CORE_APP_NAME); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 104 | store.setDelegate(delegate); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 105 | deviceService.addListener(deviceListener); |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 106 | // TODO: Should we request packets for all existing devices? I believe we should. |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 107 | log.info("Started"); |
| 108 | } |
| 109 | |
| 110 | @Deactivate |
| 111 | public void deactivate() { |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 112 | store.unsetDelegate(delegate); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 113 | deviceService.removeListener(deviceListener); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 114 | log.info("Stopped"); |
| 115 | } |
| 116 | |
| 117 | @Override |
| 118 | public void addProcessor(PacketProcessor processor, int priority) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 119 | checkPermission(Permission.PACKET_EVENT); |
| 120 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 121 | checkNotNull(processor, "Processor cannot be null"); |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 122 | processors.put(priority, processor); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 123 | } |
| 124 | |
| 125 | @Override |
| 126 | public void removeProcessor(PacketProcessor processor) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 127 | checkPermission(Permission.PACKET_EVENT); |
| 128 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 129 | checkNotNull(processor, "Processor cannot be null"); |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 130 | processors.values().remove(processor); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | @Override |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 134 | public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 135 | ApplicationId appId) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 136 | checkPermission(Permission.PACKET_READ); |
| 137 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 138 | checkNotNull(selector, "Selector cannot be null"); |
| 139 | checkNotNull(appId, "Application ID cannot be null"); |
| 140 | |
| 141 | PacketRequest request = |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 142 | new DefaultPacketRequest(selector, priority, appId, FlowRule.Type.DEFAULT); |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 143 | |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 144 | if (store.requestPackets(request)) { |
| 145 | pushToAllDevices(request); |
| 146 | } |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 147 | } |
| 148 | |
| 149 | @Override |
| 150 | public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 151 | ApplicationId appId, FlowRule.Type tableType) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 152 | checkPermission(Permission.PACKET_READ); |
| 153 | |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 154 | checkNotNull(selector, "Selector cannot be null"); |
| 155 | checkNotNull(appId, "Application ID cannot be null"); |
| 156 | checkNotNull(tableType, "Table Type cannot be null. For requesting packets +" |
| 157 | + "without table hints, use other methods in the packetService API"); |
| 158 | |
| 159 | PacketRequest request = |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 160 | new DefaultPacketRequest(selector, priority, appId, tableType); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 161 | |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 162 | if (store.requestPackets(request)) { |
alshabib | 089bb77 | 2015-03-03 18:26:26 -0800 | [diff] [blame] | 163 | pushToAllDevices(request); |
| 164 | } |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 165 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Pushes a packet request flow rule to all devices. |
| 170 | * |
| 171 | * @param request the packet request |
| 172 | */ |
| 173 | private void pushToAllDevices(PacketRequest request) { |
| 174 | for (Device device : deviceService.getDevices()) { |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 175 | pushRule(device, request); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 176 | } |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * Pushes flow rules to the device to request packets be sent to the |
| 181 | * controller. |
| 182 | * |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 183 | * @param device the device to push the rules to |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 184 | * @param request the packet request |
| 185 | */ |
| 186 | private void pushRule(Device device, PacketRequest request) { |
Marc De Leenheer | 8b3e80b | 2015-03-06 14:27:03 -0800 | [diff] [blame] | 187 | // Everything is pre-provisioned on ROADMs |
| 188 | if (device.type().equals(Device.Type.ROADM)) { |
| 189 | return; |
| 190 | } |
| 191 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 192 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 193 | .punt() |
| 194 | .build(); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 195 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 196 | ForwardingObjective forwarding = DefaultForwardingObjective.builder() |
| 197 | .withPriority(request.priority().priorityValue()) |
| 198 | .withSelector(request.selector()) |
| 199 | .fromApp(appId) |
| 200 | .withFlag(ForwardingObjective.Flag.VERSATILE) |
| 201 | .withTreatment(treatment) |
| 202 | .makePermanent() |
| 203 | .add(new ObjectiveContext() { |
| 204 | @Override |
| 205 | public void onSuccess(Objective objective) { } |
| 206 | |
| 207 | @Override |
| 208 | public void onError(Objective objective, ObjectiveError error) { |
Saurav Das | 3d03826 | 2015-04-23 12:36:58 -0700 | [diff] [blame] | 209 | log.warn("Failed to install packet request {}: {}", |
| 210 | request, error); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 211 | } |
| 212 | }); |
| 213 | |
| 214 | objectiveService.forward(device.id(), forwarding); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 215 | } |
| 216 | |
| 217 | @Override |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 218 | public void emit(OutboundPacket packet) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame^] | 219 | checkPermission(Permission.PACKET_WRITE); |
| 220 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 221 | checkNotNull(packet, "Packet cannot be null"); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 222 | |
| 223 | store.emit(packet); |
| 224 | } |
| 225 | |
| 226 | private void localEmit(OutboundPacket packet) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 227 | final Device device = deviceService.getDevice(packet.sendThrough()); |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 228 | |
| 229 | if (device == null) { |
| 230 | return; |
| 231 | } |
| 232 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 233 | final PacketProvider packetProvider = getProvider(device.providerId()); |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 234 | |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 235 | if (packetProvider != null) { |
| 236 | packetProvider.emit(packet); |
| 237 | } |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | @Override |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 241 | protected PacketProviderService createProviderService(PacketProvider provider) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 242 | return new InternalPacketProviderService(provider); |
| 243 | } |
| 244 | |
| 245 | // Personalized link provider service issued to the supplied provider. |
| 246 | private class InternalPacketProviderService |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 247 | extends AbstractProviderService<PacketProvider> |
| 248 | implements PacketProviderService { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 249 | |
| 250 | protected InternalPacketProviderService(PacketProvider provider) { |
| 251 | super(provider); |
| 252 | } |
| 253 | |
| 254 | @Override |
| 255 | public void processPacket(PacketContext context) { |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 256 | // TODO filter packets sent to processors based on registrations |
alshabib | d58d352 | 2014-09-13 17:14:53 -0700 | [diff] [blame] | 257 | for (PacketProcessor processor : processors.values()) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 258 | processor.process(context); |
| 259 | } |
| 260 | } |
| 261 | |
| 262 | } |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 263 | |
| 264 | /** |
| 265 | * Internal callback from the packet store. |
| 266 | */ |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 267 | private class InternalStoreDelegate implements PacketStoreDelegate { |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 268 | @Override |
| 269 | public void notify(PacketEvent event) { |
| 270 | localEmit(event.subject()); |
| 271 | } |
| 272 | } |
| 273 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 274 | /** |
| 275 | * Internal listener for device service events. |
| 276 | */ |
| 277 | private class InternalDeviceListener implements DeviceListener { |
| 278 | @Override |
| 279 | public void event(DeviceEvent event) { |
| 280 | Device device = event.subject(); |
sangho | 864a9db2 | 2015-04-28 12:06:31 -0700 | [diff] [blame] | 281 | switch (event.type()) { |
| 282 | case DEVICE_ADDED: |
| 283 | case DEVICE_AVAILABILITY_CHANGED: |
| 284 | if (deviceService.isAvailable(event.subject().id())) { |
| 285 | for (PacketRequest request : store.existingRequests()) { |
| 286 | pushRule(device, request); |
| 287 | } |
| 288 | } |
| 289 | break; |
| 290 | default: |
| 291 | break; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 292 | } |
| 293 | } |
| 294 | } |
| 295 | |
alshabib | ae85758 | 2014-09-12 23:53:10 -0700 | [diff] [blame] | 296 | } |