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