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