Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
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 | |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableList; |
| 19 | import com.google.common.collect.Lists; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Activate; |
| 21 | import org.apache.felix.scr.annotations.Component; |
| 22 | import org.apache.felix.scr.annotations.Deactivate; |
| 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 25 | import org.apache.felix.scr.annotations.Service; |
Madan Jampani | 6f8b702 | 2015-12-07 16:59:59 -0800 | [diff] [blame] | 26 | import org.onosproject.cluster.ClusterService; |
| 27 | import org.onosproject.cluster.NodeId; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 28 | import org.onosproject.core.ApplicationId; |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 29 | import org.onosproject.core.CoreService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 30 | import org.onosproject.net.Device; |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 31 | import org.onosproject.net.DeviceId; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 32 | import org.onosproject.net.device.DeviceEvent; |
| 33 | import org.onosproject.net.device.DeviceListener; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 34 | import org.onosproject.net.device.DeviceService; |
Yi Tseng | 809b5d7 | 2017-08-16 14:00:37 -0700 | [diff] [blame] | 35 | import org.onosproject.net.driver.Driver; |
| 36 | import org.onosproject.net.driver.DriverService; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 37 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 38 | import org.onosproject.net.flow.TrafficSelector; |
Charles Chan | 874900e | 2016-12-09 16:55:39 -0800 | [diff] [blame] | 39 | import org.onosproject.net.flow.TrafficTreatment; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 40 | import org.onosproject.net.flowobjective.DefaultForwardingObjective; |
| 41 | import org.onosproject.net.flowobjective.FlowObjectiveService; |
| 42 | import org.onosproject.net.flowobjective.ForwardingObjective; |
| 43 | import org.onosproject.net.flowobjective.Objective; |
| 44 | import org.onosproject.net.flowobjective.ObjectiveContext; |
| 45 | import org.onosproject.net.flowobjective.ObjectiveError; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 46 | import org.onosproject.net.packet.DefaultPacketRequest; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 47 | import org.onosproject.net.packet.OutboundPacket; |
| 48 | import org.onosproject.net.packet.PacketContext; |
| 49 | import org.onosproject.net.packet.PacketEvent; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 50 | import org.onosproject.net.packet.PacketPriority; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 51 | import org.onosproject.net.packet.PacketProcessor; |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 52 | import org.onosproject.net.packet.PacketProcessorEntry; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 53 | import org.onosproject.net.packet.PacketProvider; |
| 54 | import org.onosproject.net.packet.PacketProviderRegistry; |
| 55 | import org.onosproject.net.packet.PacketProviderService; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 56 | import org.onosproject.net.packet.PacketRequest; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 57 | import org.onosproject.net.packet.PacketService; |
| 58 | import org.onosproject.net.packet.PacketStore; |
| 59 | import org.onosproject.net.packet.PacketStoreDelegate; |
| 60 | import org.onosproject.net.provider.AbstractProviderRegistry; |
| 61 | import org.onosproject.net.provider.AbstractProviderService; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 62 | import org.slf4j.Logger; |
| 63 | |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 64 | import java.util.List; |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 65 | import java.util.Optional; |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 66 | import java.util.concurrent.ExecutorService; |
| 67 | import java.util.concurrent.Executors; |
alshabib | 089bb77 | 2015-03-03 18:26:26 -0800 | [diff] [blame] | 68 | |
| 69 | import static com.google.common.base.Preconditions.checkNotNull; |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 70 | import static org.onlab.util.Tools.groupedThreads; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 71 | import static org.onosproject.security.AppGuard.checkPermission; |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 72 | import static org.onosproject.security.AppPermission.Type.PACKET_EVENT; |
| 73 | import static org.onosproject.security.AppPermission.Type.PACKET_READ; |
| 74 | import static org.onosproject.security.AppPermission.Type.PACKET_WRITE; |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 75 | import static org.slf4j.LoggerFactory.getLogger; |
alshabib | 089bb77 | 2015-03-03 18:26:26 -0800 | [diff] [blame] | 76 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 77 | /** |
| 78 | * Provides a basic implementation of the packet SB & NB APIs. |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 79 | */ |
| 80 | @Component(immediate = true) |
| 81 | @Service |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 82 | public class PacketManager |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 83 | extends AbstractProviderRegistry<PacketProvider, PacketProviderService> |
| 84 | implements PacketService, PacketProviderRegistry { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 85 | |
| 86 | private final Logger log = getLogger(getClass()); |
| 87 | |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 88 | private static final String ERROR_NULL_PROCESSOR = "Processor cannot be null"; |
| 89 | private static final String ERROR_NULL_SELECTOR = "Selector cannot be null"; |
| 90 | private static final String ERROR_NULL_APP_ID = "Application ID cannot be null"; |
| 91 | private static final String ERROR_NULL_DEVICE_ID = "Device ID cannot be null"; |
Yi Tseng | 809b5d7 | 2017-08-16 14:00:37 -0700 | [diff] [blame] | 92 | private static final String SUPPORT_PACKET_REQUEST_PROPERTY = "supportPacketRequest"; |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 93 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 94 | private final PacketStoreDelegate delegate = new InternalStoreDelegate(); |
| 95 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 96 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 97 | protected CoreService coreService; |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 98 | |
| 99 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 100 | protected ClusterService clusterService; |
Madan Jampani | 6f8b702 | 2015-12-07 16:59:59 -0800 | [diff] [blame] | 101 | |
| 102 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 103 | protected DeviceService deviceService; |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 104 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 105 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Yi Tseng | 809b5d7 | 2017-08-16 14:00:37 -0700 | [diff] [blame] | 106 | protected DriverService driverService; |
| 107 | |
| 108 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 109 | protected PacketStore store; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 110 | |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 111 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 112 | protected FlowObjectiveService objectiveService; |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 113 | |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 114 | private ExecutorService eventHandlingExecutor; |
| 115 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 116 | private final DeviceListener deviceListener = new InternalDeviceListener(); |
| 117 | |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 118 | private final List<ProcessorEntry> processors = Lists.newCopyOnWriteArrayList(); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 119 | |
Thomas Vachuska | 4267681 | 2017-10-03 15:12:41 -0700 | [diff] [blame] | 120 | private final PacketDriverProvider defaultProvider = new PacketDriverProvider(); |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 121 | |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 122 | private ApplicationId appId; |
Madan Jampani | 6f8b702 | 2015-12-07 16:59:59 -0800 | [diff] [blame] | 123 | private NodeId localNodeId; |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 124 | |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 125 | @Activate |
| 126 | public void activate() { |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 127 | eventHandlingExecutor = Executors.newSingleThreadExecutor( |
HIGUCHI Yuta | d9e0105 | 2016-04-14 09:31:42 -0700 | [diff] [blame] | 128 | groupedThreads("onos/net/packet", "event-handler", log)); |
Madan Jampani | 6f8b702 | 2015-12-07 16:59:59 -0800 | [diff] [blame] | 129 | localNodeId = clusterService.getLocalNode().id(); |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 130 | appId = coreService.getAppId(CoreService.CORE_APP_NAME); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 131 | store.setDelegate(delegate); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 132 | deviceService.addListener(deviceListener); |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 133 | defaultProvider.init(deviceService); |
Charles Chan | aa7e973 | 2018-04-06 17:03:23 -0700 | [diff] [blame] | 134 | store.existingRequests().forEach(request -> { |
| 135 | if (request.deviceId().isPresent()) { |
| 136 | Device device = deviceService.getDevice(request.deviceId().get()); |
| 137 | if (device != null) { |
| 138 | pushRule(device, request); |
| 139 | } else { |
| 140 | log.info("Device is not ready yet. Skip processing packet requests {}", request); |
| 141 | } |
| 142 | } else { |
| 143 | pushToAllDevices(request); |
| 144 | } |
| 145 | }); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 146 | log.info("Started"); |
| 147 | } |
| 148 | |
| 149 | @Deactivate |
| 150 | public void deactivate() { |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 151 | store.unsetDelegate(delegate); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 152 | deviceService.removeListener(deviceListener); |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 153 | eventHandlingExecutor.shutdown(); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 154 | log.info("Stopped"); |
| 155 | } |
| 156 | |
| 157 | @Override |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 158 | protected PacketProvider defaultProvider() { |
| 159 | return defaultProvider; |
| 160 | } |
| 161 | |
| 162 | @Override |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 163 | public void addProcessor(PacketProcessor processor, int priority) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 164 | checkPermission(PACKET_EVENT); |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 165 | checkNotNull(processor, ERROR_NULL_PROCESSOR); |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 166 | ProcessorEntry entry = new ProcessorEntry(processor, priority); |
| 167 | |
| 168 | // Insert the new processor according to its priority. |
| 169 | int i = 0; |
| 170 | for (; i < processors.size(); i++) { |
| 171 | if (priority < processors.get(i).priority()) { |
| 172 | break; |
| 173 | } |
| 174 | } |
| 175 | processors.add(i, entry); |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 176 | } |
| 177 | |
| 178 | @Override |
| 179 | public void removeProcessor(PacketProcessor processor) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 180 | checkPermission(PACKET_EVENT); |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 181 | checkNotNull(processor, ERROR_NULL_PROCESSOR); |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 182 | |
| 183 | // Remove the processor entry. |
| 184 | for (int i = 0; i < processors.size(); i++) { |
| 185 | if (processors.get(i).processor() == processor) { |
| 186 | processors.remove(i); |
| 187 | break; |
| 188 | } |
| 189 | } |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | @Override |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 193 | public List<PacketProcessorEntry> getProcessors() { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 194 | checkPermission(PACKET_READ); |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 195 | return ImmutableList.copyOf(processors); |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | @Override |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 199 | public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 200 | ApplicationId appId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 201 | checkPermission(PACKET_READ); |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 202 | checkNotNull(selector, ERROR_NULL_SELECTOR); |
| 203 | checkNotNull(appId, ERROR_NULL_APP_ID); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 204 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 205 | PacketRequest request = new DefaultPacketRequest(selector, priority, appId, |
Pier Luigi Ventre | 6fd1ca9 | 2017-01-13 03:15:50 +0000 | [diff] [blame] | 206 | localNodeId, Optional.empty()); |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 207 | store.requestPackets(request); |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | @Override |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 211 | public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 212 | ApplicationId appId, Optional<DeviceId> deviceId) { |
| 213 | checkPermission(PACKET_READ); |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 214 | checkNotNull(selector, ERROR_NULL_SELECTOR); |
| 215 | checkNotNull(appId, ERROR_NULL_APP_ID); |
| 216 | checkNotNull(deviceId, ERROR_NULL_DEVICE_ID); |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 217 | |
| 218 | PacketRequest request = |
| 219 | new DefaultPacketRequest(selector, priority, appId, |
| 220 | localNodeId, deviceId); |
| 221 | |
| 222 | store.requestPackets(request); |
Pier Luigi Ventre | 6fd1ca9 | 2017-01-13 03:15:50 +0000 | [diff] [blame] | 223 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | @Override |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 227 | public void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| 228 | ApplicationId appId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 229 | checkPermission(PACKET_READ); |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 230 | checkNotNull(selector, ERROR_NULL_SELECTOR); |
| 231 | checkNotNull(appId, ERROR_NULL_APP_ID); |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 232 | |
Pier Luigi Ventre | 6fd1ca9 | 2017-01-13 03:15:50 +0000 | [diff] [blame] | 233 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 234 | PacketRequest request = new DefaultPacketRequest(selector, priority, appId, |
Pier Luigi Ventre | 6fd1ca9 | 2017-01-13 03:15:50 +0000 | [diff] [blame] | 235 | localNodeId, Optional.empty()); |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 236 | store.cancelPackets(request); |
| 237 | } |
| 238 | |
| 239 | @Override |
| 240 | public void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| 241 | ApplicationId appId, Optional<DeviceId> deviceId) { |
| 242 | checkPermission(PACKET_READ); |
Jonathan Hart | dbaed99 | 2016-09-08 22:04:33 -0700 | [diff] [blame] | 243 | checkNotNull(selector, ERROR_NULL_SELECTOR); |
| 244 | checkNotNull(appId, ERROR_NULL_APP_ID); |
| 245 | checkNotNull(deviceId, ERROR_NULL_DEVICE_ID); |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 246 | |
| 247 | PacketRequest request = new DefaultPacketRequest(selector, priority, |
| 248 | appId, localNodeId, |
| 249 | deviceId); |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 250 | store.cancelPackets(request); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 251 | } |
| 252 | |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 253 | @Override |
| 254 | public List<PacketRequest> getRequests() { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 255 | checkPermission(PACKET_READ); |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 256 | return store.existingRequests(); |
| 257 | } |
| 258 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 259 | /** |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 260 | * Pushes all rules to the specified device. |
| 261 | * |
| 262 | * @param device device on which to install packet request flows |
| 263 | */ |
| 264 | private void pushRulesToDevice(Device device) { |
| 265 | log.debug("Pushing packet requests to device {}", device.id()); |
| 266 | for (PacketRequest request : store.existingRequests()) { |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 267 | if (!request.deviceId().isPresent()) { |
| 268 | pushRule(device, request); |
| 269 | } else if (request.deviceId().get().equals(device.id())) { |
| 270 | pushRule(device, request); |
| 271 | } |
| 272 | |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 273 | } |
| 274 | } |
| 275 | |
| 276 | /** |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 277 | * Pushes a packet request flow rule to all devices. |
| 278 | * |
| 279 | * @param request the packet request |
| 280 | */ |
| 281 | private void pushToAllDevices(PacketRequest request) { |
Thomas Vachuska | 88fd690 | 2015-08-04 10:08:34 -0700 | [diff] [blame] | 282 | log.debug("Pushing packet request {} to all devices", request); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 283 | for (Device device : deviceService.getDevices()) { |
Yi Tseng | 809b5d7 | 2017-08-16 14:00:37 -0700 | [diff] [blame] | 284 | Driver driver = driverService.getDriver(device.id()); |
| 285 | if (driver != null && |
| 286 | Boolean.parseBoolean(driver.getProperty(SUPPORT_PACKET_REQUEST_PROPERTY))) { |
Yuta HIGUCHI | e4cb8cf | 2017-05-01 22:18:28 -0700 | [diff] [blame] | 287 | pushRule(device, request); |
| 288 | } |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 289 | } |
| 290 | } |
| 291 | |
| 292 | /** |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 293 | * Removes packet request flow rule from all devices. |
| 294 | * |
| 295 | * @param request the packet request |
| 296 | */ |
| 297 | private void removeFromAllDevices(PacketRequest request) { |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 298 | deviceService.getAvailableDevices().forEach(d -> removeRule(d, request)); |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Pushes packet intercept flow rules to the device. |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 303 | * |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 304 | * @param device the device to push the rules to |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 305 | * @param request the packet request |
| 306 | */ |
| 307 | private void pushRule(Device device, PacketRequest request) { |
Marc De Leenheer | b931137 | 2015-07-09 11:36:49 -0700 | [diff] [blame] | 308 | if (!device.type().equals(Device.Type.SWITCH)) { |
Marc De Leenheer | 8b3e80b | 2015-03-06 14:27:03 -0800 | [diff] [blame] | 309 | return; |
| 310 | } |
| 311 | |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 312 | if (!deviceService.isAvailable(device.id())) { |
| 313 | return; |
| 314 | } |
| 315 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 316 | ForwardingObjective forwarding = createBuilder(request) |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 317 | .add(new ObjectiveContext() { |
| 318 | @Override |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 319 | public void onError(Objective objective, ObjectiveError error) { |
Thomas Vachuska | 88fd690 | 2015-08-04 10:08:34 -0700 | [diff] [blame] | 320 | log.warn("Failed to install packet request {} to {}: {}", |
| 321 | request, device.id(), error); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 322 | } |
| 323 | }); |
| 324 | |
| 325 | objectiveService.forward(device.id(), forwarding); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 326 | } |
| 327 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 328 | /** |
| 329 | * Removes packet intercept flow rules from the device. |
| 330 | * |
| 331 | * @param device the device to remove the rules deom |
| 332 | * @param request the packet request |
| 333 | */ |
| 334 | private void removeRule(Device device, PacketRequest request) { |
Marc De Leenheer | b931137 | 2015-07-09 11:36:49 -0700 | [diff] [blame] | 335 | if (!device.type().equals(Device.Type.SWITCH)) { |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 336 | return; |
| 337 | } |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 338 | ForwardingObjective forwarding = createBuilder(request) |
| 339 | .remove(new ObjectiveContext() { |
| 340 | @Override |
| 341 | public void onError(Objective objective, ObjectiveError error) { |
Thomas Vachuska | 88fd690 | 2015-08-04 10:08:34 -0700 | [diff] [blame] | 342 | log.warn("Failed to withdraw packet request {} from {}: {}", |
| 343 | request, device.id(), error); |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 344 | } |
| 345 | }); |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 346 | objectiveService.forward(device.id(), forwarding); |
| 347 | } |
| 348 | |
| 349 | private DefaultForwardingObjective.Builder createBuilder(PacketRequest request) { |
DongRyeol Cha | ce65cc0 | 2018-07-23 15:02:28 +0900 | [diff] [blame^] | 350 | ApplicationId requestedAppId = coreService.getAppId(request.appId().name()); // Validate app id |
Pier Luigi Ventre | 6fd1ca9 | 2017-01-13 03:15:50 +0000 | [diff] [blame] | 351 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 352 | .punt() |
| 353 | .wipeDeferred() |
| 354 | .build(); |
Charles Chan | 874900e | 2016-12-09 16:55:39 -0800 | [diff] [blame] | 355 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 356 | return DefaultForwardingObjective.builder() |
| 357 | .withPriority(request.priority().priorityValue()) |
| 358 | .withSelector(request.selector()) |
DongRyeol Cha | ce65cc0 | 2018-07-23 15:02:28 +0900 | [diff] [blame^] | 359 | .fromApp(requestedAppId == null ? appId : requestedAppId) |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 360 | .withFlag(ForwardingObjective.Flag.VERSATILE) |
Pier Luigi Ventre | 6fd1ca9 | 2017-01-13 03:15:50 +0000 | [diff] [blame] | 361 | .withTreatment(treatment) |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 362 | .makePermanent(); |
| 363 | } |
| 364 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 365 | @Override |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 366 | public void emit(OutboundPacket packet) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 367 | checkPermission(PACKET_WRITE); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 368 | checkNotNull(packet, "Packet cannot be null"); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 369 | store.emit(packet); |
| 370 | } |
| 371 | |
| 372 | private void localEmit(OutboundPacket packet) { |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 373 | Device device = deviceService.getDevice(packet.sendThrough()); |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 374 | if (device == null) { |
| 375 | return; |
| 376 | } |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 377 | PacketProvider packetProvider = getProvider(device.providerId()); |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 378 | if (packetProvider != null) { |
| 379 | packetProvider.emit(packet); |
| 380 | } |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 381 | } |
| 382 | |
| 383 | @Override |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 384 | protected PacketProviderService createProviderService(PacketProvider provider) { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 385 | return new InternalPacketProviderService(provider); |
| 386 | } |
| 387 | |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 388 | /** |
| 389 | * Personalized packet provider service issued to the supplied provider. |
| 390 | */ |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 391 | private class InternalPacketProviderService |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 392 | extends AbstractProviderService<PacketProvider> |
| 393 | implements PacketProviderService { |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 394 | |
| 395 | protected InternalPacketProviderService(PacketProvider provider) { |
| 396 | super(provider); |
| 397 | } |
| 398 | |
| 399 | @Override |
| 400 | public void processPacket(PacketContext context) { |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 401 | // TODO filter packets sent to processors based on registrations |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 402 | for (ProcessorEntry entry : processors) { |
Jonathan Hart | f563830 | 2015-11-16 10:56:20 -0800 | [diff] [blame] | 403 | try { |
Jonathan Hart | 34a14f7 | 2018-01-25 09:34:33 -0800 | [diff] [blame] | 404 | if (log.isTraceEnabled()) { |
| 405 | log.trace("Starting packet processing by {}", |
| 406 | entry.processor().getClass().getName()); |
| 407 | } |
| 408 | |
Jonathan Hart | f563830 | 2015-11-16 10:56:20 -0800 | [diff] [blame] | 409 | long start = System.nanoTime(); |
| 410 | entry.processor().process(context); |
| 411 | entry.addNanos(System.nanoTime() - start); |
Jonathan Hart | 34a14f7 | 2018-01-25 09:34:33 -0800 | [diff] [blame] | 412 | |
| 413 | if (log.isTraceEnabled()) { |
| 414 | log.trace("Finished packet processing by {}", |
| 415 | entry.processor().getClass().getName()); |
| 416 | } |
Jonathan Hart | f563830 | 2015-11-16 10:56:20 -0800 | [diff] [blame] | 417 | } catch (Exception e) { |
| 418 | log.warn("Packet processor {} threw an exception", entry.processor(), e); |
| 419 | } |
alshabib | 7674db4 | 2014-09-12 23:40:46 -0700 | [diff] [blame] | 420 | } |
| 421 | } |
| 422 | |
| 423 | } |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 424 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 425 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 426 | /** |
| 427 | * Internal callback from the packet store. |
| 428 | */ |
Andrea Campanella | 5b24053 | 2016-02-05 09:44:41 -0800 | [diff] [blame] | 429 | protected class InternalStoreDelegate implements PacketStoreDelegate { |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 430 | @Override |
| 431 | public void notify(PacketEvent event) { |
| 432 | localEmit(event.subject()); |
| 433 | } |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 434 | |
| 435 | @Override |
| 436 | public void requestPackets(PacketRequest request) { |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 437 | DeviceId deviceid = request.deviceId().orElse(null); |
| 438 | |
| 439 | if (deviceid != null) { |
hyunho1986 | 5777064 | 2017-05-30 14:50:35 +0900 | [diff] [blame] | 440 | Device device = deviceService.getDevice(deviceid); |
| 441 | |
| 442 | if (device != null) { |
| 443 | pushRule(deviceService.getDevice(deviceid), request); |
| 444 | } |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 445 | } else { |
| 446 | pushToAllDevices(request); |
| 447 | } |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 448 | } |
| 449 | |
| 450 | @Override |
| 451 | public void cancelPackets(PacketRequest request) { |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 452 | DeviceId deviceid = request.deviceId().orElse(null); |
| 453 | |
| 454 | if (deviceid != null) { |
hyunho1986 | 5777064 | 2017-05-30 14:50:35 +0900 | [diff] [blame] | 455 | Device device = deviceService.getDevice(deviceid); |
| 456 | |
| 457 | if (device != null) { |
| 458 | removeRule(deviceService.getDevice(deviceid), request); |
| 459 | } |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 460 | } else { |
| 461 | removeFromAllDevices(request); |
| 462 | } |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 463 | } |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 464 | } |
| 465 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 466 | /** |
| 467 | * Internal listener for device service events. |
| 468 | */ |
| 469 | private class InternalDeviceListener implements DeviceListener { |
Thomas Vachuska | 4267681 | 2017-10-03 15:12:41 -0700 | [diff] [blame] | 470 | |
| 471 | @Override |
| 472 | public boolean isRelevant(DeviceEvent event) { |
| 473 | return event.type() == DeviceEvent.Type.DEVICE_ADDED || |
| 474 | event.type() == DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED; |
| 475 | } |
| 476 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 477 | @Override |
| 478 | public void event(DeviceEvent event) { |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 479 | eventHandlingExecutor.execute(() -> { |
| 480 | try { |
Ray Milkey | fa89f2a | 2017-11-30 13:52:54 -0800 | [diff] [blame] | 481 | if (driverService == null) { |
| 482 | // Event came in after the driver service shut down, nothing to be done |
| 483 | return; |
| 484 | } |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 485 | Device device = event.subject(); |
Yi Tseng | 809b5d7 | 2017-08-16 14:00:37 -0700 | [diff] [blame] | 486 | Driver driver = driverService.getDriver(device.id()); |
| 487 | if (driver == null) { |
| 488 | return; |
| 489 | } |
| 490 | if (!Boolean.parseBoolean(driver.getProperty(SUPPORT_PACKET_REQUEST_PROPERTY))) { |
| 491 | return; |
| 492 | } |
| 493 | if (!deviceService.isAvailable(event.subject().id())) { |
| 494 | return; |
| 495 | } |
Thomas Vachuska | 4267681 | 2017-10-03 15:12:41 -0700 | [diff] [blame] | 496 | pushRulesToDevice(device); |
Madan Jampani | c626f1e | 2015-05-29 13:53:38 -0700 | [diff] [blame] | 497 | } catch (Exception e) { |
| 498 | log.warn("Failed to process {}", event, e); |
| 499 | } |
| 500 | }); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 501 | } |
| 502 | } |
| 503 | |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 504 | /** |
| 505 | * Entity for tracking stats for a packet processor. |
| 506 | */ |
| 507 | private class ProcessorEntry implements PacketProcessorEntry { |
| 508 | private final PacketProcessor processor; |
| 509 | private final int priority; |
| 510 | private long invocations = 0; |
| 511 | private long nanos = 0; |
| 512 | |
| 513 | public ProcessorEntry(PacketProcessor processor, int priority) { |
| 514 | this.processor = processor; |
| 515 | this.priority = priority; |
| 516 | } |
| 517 | |
| 518 | @Override |
| 519 | public PacketProcessor processor() { |
| 520 | return processor; |
| 521 | } |
| 522 | |
| 523 | @Override |
| 524 | public int priority() { |
| 525 | return priority; |
| 526 | } |
| 527 | |
| 528 | @Override |
| 529 | public long invocations() { |
| 530 | return invocations; |
| 531 | } |
| 532 | |
| 533 | @Override |
| 534 | public long totalNanos() { |
| 535 | return nanos; |
| 536 | } |
| 537 | |
| 538 | @Override |
| 539 | public long averageNanos() { |
| 540 | return invocations > 0 ? nanos / invocations : 0; |
| 541 | } |
| 542 | |
| 543 | void addNanos(long nanos) { |
| 544 | this.nanos += nanos; |
| 545 | this.invocations++; |
| 546 | } |
| 547 | } |
alshabib | ae85758 | 2014-09-12 23:53:10 -0700 | [diff] [blame] | 548 | } |