| /* |
| * Copyright 2014-present Open Networking Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.net.packet.impl; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Lists; |
| import org.onlab.util.ItemNotFoundException; |
| import org.onosproject.cluster.ClusterService; |
| import org.onosproject.cluster.NodeId; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.net.Device; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.device.DeviceEvent; |
| import org.onosproject.net.device.DeviceListener; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.driver.Driver; |
| import org.onosproject.net.driver.DriverService; |
| import org.onosproject.net.flow.DefaultTrafficTreatment; |
| import org.onosproject.net.flow.TrafficSelector; |
| import org.onosproject.net.flow.TrafficTreatment; |
| import org.onosproject.net.flowobjective.DefaultForwardingObjective; |
| import org.onosproject.net.flowobjective.FlowObjectiveService; |
| import org.onosproject.net.flowobjective.ForwardingObjective; |
| import org.onosproject.net.flowobjective.Objective; |
| import org.onosproject.net.flowobjective.ObjectiveContext; |
| import org.onosproject.net.flowobjective.ObjectiveError; |
| import org.onosproject.net.packet.DefaultPacketRequest; |
| import org.onosproject.net.packet.OutboundPacket; |
| import org.onosproject.net.packet.PacketContext; |
| import org.onosproject.net.packet.PacketEvent; |
| import org.onosproject.net.packet.PacketPriority; |
| import org.onosproject.net.packet.PacketProcessor; |
| import org.onosproject.net.packet.PacketProcessorEntry; |
| import org.onosproject.net.packet.PacketProvider; |
| import org.onosproject.net.packet.PacketProviderRegistry; |
| import org.onosproject.net.packet.PacketProviderService; |
| import org.onosproject.net.packet.PacketRequest; |
| import org.onosproject.net.packet.PacketService; |
| import org.onosproject.net.packet.PacketStore; |
| import org.onosproject.net.packet.PacketStoreDelegate; |
| import org.onosproject.net.provider.AbstractProviderRegistry; |
| import org.onosproject.net.provider.AbstractProviderService; |
| import org.osgi.service.component.annotations.Activate; |
| import org.osgi.service.component.annotations.Component; |
| import org.osgi.service.component.annotations.Deactivate; |
| import org.osgi.service.component.annotations.Reference; |
| import org.osgi.service.component.annotations.ReferenceCardinality; |
| import org.onosproject.net.packet.PacketInFilter; |
| import org.onosproject.net.packet.PacketInFilter.FilterAction; |
| import org.slf4j.Logger; |
| |
| import java.util.List; |
| import java.util.Optional; |
| import java.util.concurrent.ExecutorService; |
| import java.util.concurrent.Executors; |
| import java.util.concurrent.CopyOnWriteArrayList; |
| |
| |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static org.onlab.util.Tools.groupedThreads; |
| import static org.onosproject.security.AppGuard.checkPermission; |
| import static org.onosproject.security.AppPermission.Type.PACKET_EVENT; |
| import static org.onosproject.security.AppPermission.Type.PACKET_READ; |
| import static org.onosproject.security.AppPermission.Type.PACKET_WRITE; |
| import static org.slf4j.LoggerFactory.getLogger; |
| |
| /** |
| * Provides a basic implementation of the packet SB & NB APIs. |
| */ |
| @Component(immediate = true, service = { PacketService.class, PacketProviderRegistry.class }) |
| public class PacketManager |
| extends AbstractProviderRegistry<PacketProvider, PacketProviderService> |
| implements PacketService, PacketProviderRegistry { |
| |
| private final Logger log = getLogger(getClass()); |
| |
| private static final String ERROR_NULL_PROCESSOR = "Processor cannot be null"; |
| private static final String ERROR_NULL_SELECTOR = "Selector cannot be null"; |
| private static final String ERROR_NULL_APP_ID = "Application ID cannot be null"; |
| private static final String ERROR_NULL_DEVICE_ID = "Device ID cannot be null"; |
| private static final String SUPPORT_PACKET_REQUEST_PROPERTY = "supportPacketRequest"; |
| |
| private final PacketStoreDelegate delegate = new InternalStoreDelegate(); |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected CoreService coreService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected ClusterService clusterService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected DeviceService deviceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected DriverService driverService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected PacketStore store; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected FlowObjectiveService objectiveService; |
| |
| private ExecutorService eventHandlingExecutor; |
| |
| private final DeviceListener deviceListener = new InternalDeviceListener(); |
| |
| private final List<ProcessorEntry> processors = Lists.newCopyOnWriteArrayList(); |
| |
| private final PacketDriverProvider defaultProvider = new PacketDriverProvider(); |
| |
| private ApplicationId appId; |
| private NodeId localNodeId; |
| |
| private List<PacketInFilter> filters = new CopyOnWriteArrayList<>(); |
| |
| @Activate |
| public void activate() { |
| eventHandlingExecutor = Executors.newSingleThreadExecutor( |
| groupedThreads("onos/net/packet", "event-handler", log)); |
| localNodeId = clusterService.getLocalNode().id(); |
| appId = coreService.getAppId(CoreService.CORE_APP_NAME); |
| store.setDelegate(delegate); |
| deviceService.addListener(deviceListener); |
| defaultProvider.init(deviceService); |
| store.existingRequests().forEach(request -> { |
| if (request.deviceId().isPresent()) { |
| Device device = deviceService.getDevice(request.deviceId().get()); |
| if (device != null) { |
| pushRule(device, request); |
| } else { |
| log.info("Device is not ready yet; not processing packet request {}", request); |
| } |
| } else { |
| pushToAllDevices(request); |
| } |
| }); |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| store.unsetDelegate(delegate); |
| deviceService.removeListener(deviceListener); |
| eventHandlingExecutor.shutdown(); |
| log.info("Stopped"); |
| } |
| |
| @Override |
| protected PacketProvider defaultProvider() { |
| return defaultProvider; |
| } |
| |
| @Override |
| public void addProcessor(PacketProcessor processor, int priority) { |
| checkPermission(PACKET_EVENT); |
| checkNotNull(processor, ERROR_NULL_PROCESSOR); |
| ProcessorEntry entry = new ProcessorEntry(processor, priority); |
| |
| // Insert the new processor according to its priority. |
| int i = 0; |
| for (; i < processors.size(); i++) { |
| if (priority < processors.get(i).priority()) { |
| break; |
| } |
| } |
| processors.add(i, entry); |
| } |
| |
| @Override |
| public void removeProcessor(PacketProcessor processor) { |
| checkPermission(PACKET_EVENT); |
| checkNotNull(processor, ERROR_NULL_PROCESSOR); |
| |
| // Remove the processor entry. |
| for (int i = 0; i < processors.size(); i++) { |
| if (processors.get(i).processor() == processor) { |
| processors.remove(i); |
| break; |
| } |
| } |
| } |
| |
| @Override |
| public void addFilter(PacketInFilter filter) { |
| filters.add(filter); |
| } |
| |
| @Override |
| public void removeFilter(PacketInFilter filter) { |
| filters.remove(filter); |
| } |
| |
| @Override |
| public List<PacketProcessorEntry> getProcessors() { |
| checkPermission(PACKET_READ); |
| return ImmutableList.copyOf(processors); |
| } |
| |
| @Override |
| public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| ApplicationId appId) { |
| checkPermission(PACKET_READ); |
| checkNotNull(selector, ERROR_NULL_SELECTOR); |
| checkNotNull(appId, ERROR_NULL_APP_ID); |
| |
| PacketRequest request = new DefaultPacketRequest(selector, priority, appId, |
| localNodeId, Optional.empty()); |
| store.requestPackets(request); |
| } |
| |
| @Override |
| public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| ApplicationId appId, Optional<DeviceId> deviceId) { |
| checkPermission(PACKET_READ); |
| checkNotNull(selector, ERROR_NULL_SELECTOR); |
| checkNotNull(appId, ERROR_NULL_APP_ID); |
| checkNotNull(deviceId, ERROR_NULL_DEVICE_ID); |
| |
| PacketRequest request = |
| new DefaultPacketRequest(selector, priority, appId, |
| localNodeId, deviceId); |
| |
| store.requestPackets(request); |
| |
| } |
| |
| @Override |
| public void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| ApplicationId appId) { |
| checkPermission(PACKET_READ); |
| checkNotNull(selector, ERROR_NULL_SELECTOR); |
| checkNotNull(appId, ERROR_NULL_APP_ID); |
| |
| |
| PacketRequest request = new DefaultPacketRequest(selector, priority, appId, |
| localNodeId, Optional.empty()); |
| store.cancelPackets(request); |
| } |
| |
| @Override |
| public void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| ApplicationId appId, Optional<DeviceId> deviceId) { |
| checkPermission(PACKET_READ); |
| checkNotNull(selector, ERROR_NULL_SELECTOR); |
| checkNotNull(appId, ERROR_NULL_APP_ID); |
| checkNotNull(deviceId, ERROR_NULL_DEVICE_ID); |
| |
| PacketRequest request = new DefaultPacketRequest(selector, priority, |
| appId, localNodeId, |
| deviceId); |
| store.cancelPackets(request); |
| } |
| |
| @Override |
| public List<PacketRequest> getRequests() { |
| checkPermission(PACKET_READ); |
| return store.existingRequests(); |
| } |
| |
| /** |
| * Pushes all rules to the specified device. |
| * |
| * @param device device on which to install packet request flows |
| */ |
| private void pushRulesToDevice(Device device) { |
| log.debug("Pushing packet requests to device {}", device.id()); |
| for (PacketRequest request : store.existingRequests()) { |
| if (!request.deviceId().isPresent()) { |
| pushRule(device, request); |
| } else if (request.deviceId().get().equals(device.id())) { |
| pushRule(device, request); |
| } |
| |
| } |
| } |
| |
| /** |
| * Pushes a packet request flow rule to all devices. |
| * |
| * @param request the packet request |
| */ |
| private void pushToAllDevices(PacketRequest request) { |
| log.debug("Pushing packet request {} to all devices", request); |
| for (Device device : deviceService.getDevices()) { |
| try { |
| Driver driver = driverService.getDriver(device.id()); |
| if (driver != null && |
| Boolean.parseBoolean(driver.getProperty(SUPPORT_PACKET_REQUEST_PROPERTY))) { |
| pushRule(device, request); |
| } |
| } catch (ItemNotFoundException e) { |
| log.warn("Device driver not found for {}; not processing packet request {}", |
| device.id(), request); |
| } |
| } |
| } |
| |
| /** |
| * Removes packet request flow rule from all devices. |
| * |
| * @param request the packet request |
| */ |
| private void removeFromAllDevices(PacketRequest request) { |
| deviceService.getAvailableDevices().forEach(d -> removeRule(d, request)); |
| } |
| |
| /** |
| * Pushes packet intercept flow rules to the device. |
| * |
| * @param device the device to push the rules to |
| * @param request the packet request |
| */ |
| private void pushRule(Device device, PacketRequest request) { |
| if (!device.type().equals(Device.Type.SWITCH)) { |
| return; |
| } |
| |
| if (!deviceService.isAvailable(device.id())) { |
| return; |
| } |
| |
| ForwardingObjective forwarding = createBuilder(request) |
| .add(new ObjectiveContext() { |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.warn("Failed to install packet request {} to {}: {}", |
| request, device.id(), error); |
| } |
| }); |
| |
| objectiveService.forward(device.id(), forwarding); |
| } |
| |
| /** |
| * Removes packet intercept flow rules from the device. |
| * |
| * @param device the device to remove the rules deom |
| * @param request the packet request |
| */ |
| private void removeRule(Device device, PacketRequest request) { |
| if (!device.type().equals(Device.Type.SWITCH)) { |
| return; |
| } |
| ForwardingObjective forwarding = createBuilder(request) |
| .remove(new ObjectiveContext() { |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.warn("Failed to withdraw packet request {} from {}: {}", |
| request, device.id(), error); |
| } |
| }); |
| objectiveService.forward(device.id(), forwarding); |
| } |
| |
| private DefaultForwardingObjective.Builder createBuilder(PacketRequest request) { |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .punt() |
| .wipeDeferred() |
| .build(); |
| |
| return DefaultForwardingObjective.builder() |
| .withPriority(request.priority().priorityValue()) |
| .withSelector(request.selector()) |
| .fromApp(appId) |
| .withFlag(ForwardingObjective.Flag.VERSATILE) |
| .withTreatment(treatment) |
| .makePermanent(); |
| } |
| |
| @Override |
| public void emit(OutboundPacket packet) { |
| checkPermission(PACKET_WRITE); |
| checkNotNull(packet, "Packet cannot be null"); |
| store.emit(packet); |
| } |
| |
| @Override |
| public List<PacketInFilter> getFilters() { |
| return ImmutableList.copyOf(filters); |
| } |
| |
| @Override |
| public void clearFilters() { |
| for (PacketInFilter filter: filters) { |
| filter.stop(); |
| } |
| filters.clear(); |
| } |
| |
| private void localEmit(OutboundPacket packet) { |
| Device device = deviceService.getDevice(packet.sendThrough()); |
| if (device == null) { |
| return; |
| } |
| PacketProvider packetProvider = getProvider(device.providerId()); |
| if (packetProvider != null) { |
| packetProvider.emit(packet); |
| } |
| } |
| |
| @Override |
| protected PacketProviderService createProviderService(PacketProvider provider) { |
| return new InternalPacketProviderService(provider); |
| } |
| |
| /** |
| * Personalized packet provider service issued to the supplied provider. |
| */ |
| private class InternalPacketProviderService |
| extends AbstractProviderService<PacketProvider> |
| implements PacketProviderService { |
| |
| protected InternalPacketProviderService(PacketProvider provider) { |
| super(provider); |
| } |
| |
| /** |
| * Loops through all packet filters and checks if the filter is |
| * enabled and allowed to be processed. |
| * It increments the counter to track the pending packets to be |
| * processed based on the filter selected. |
| * |
| * @param context PackerContext holding the packet information |
| * @return FilterAction Action decided for the based on the filter applied |
| */ |
| private FilterAction prePacketProcess(PacketContext context) { |
| FilterAction filterAction = FilterAction.FILTER_INVALID; |
| for (PacketInFilter filter: filters) { |
| filterAction = filter.preProcess(context); |
| if (filterAction == FilterAction.FILTER_DISABLED) { |
| if (log.isTraceEnabled()) { |
| log.trace("{}: filter is disabled during pre processing", filter.name()); |
| } |
| continue; |
| } |
| if (filterAction == FilterAction.PACKET_DENY) { |
| if (log.isTraceEnabled()) { |
| log.trace("{}: overflow counter after dropping packet is: {}", filter.name(), |
| filter.droppedPackets()); |
| } |
| break; |
| } |
| if (filterAction == FilterAction.PACKET_ALLOW) { |
| if (log.isTraceEnabled()) { |
| log.trace("{}: counter after picked for processing is: {}", filter.name(), |
| filter.pendingPackets()); |
| } |
| break; |
| } |
| } |
| return filterAction; |
| } |
| |
| @Override |
| public void processPacket(PacketContext context) { |
| FilterAction filterAction = prePacketProcess(context); |
| |
| if (filterAction == FilterAction.PACKET_DENY) { |
| if (log.isTraceEnabled()) { |
| log.trace("The packet is dropped as crossed the maxcount"); |
| } |
| return; |
| } |
| // TODO filter packets sent to processors based on registrations |
| for (ProcessorEntry entry : processors) { |
| try { |
| if (log.isTraceEnabled()) { |
| log.trace("Starting packet processing by {}", |
| entry.processor().getClass().getName()); |
| } |
| |
| long start = System.nanoTime(); |
| entry.processor().process(context); |
| entry.addNanos(System.nanoTime() - start); |
| |
| if (log.isTraceEnabled()) { |
| log.trace("Finished packet processing by {}", |
| entry.processor().getClass().getName()); |
| } |
| } catch (Exception e) { |
| log.warn("Packet processor {} threw an exception", entry.processor(), e); |
| } |
| } |
| } |
| |
| } |
| |
| |
| /** |
| * Internal callback from the packet store. |
| */ |
| protected class InternalStoreDelegate implements PacketStoreDelegate { |
| @Override |
| public void notify(PacketEvent event) { |
| localEmit(event.subject()); |
| } |
| |
| @Override |
| public void requestPackets(PacketRequest request) { |
| DeviceId deviceid = request.deviceId().orElse(null); |
| |
| if (deviceid != null) { |
| Device device = deviceService.getDevice(deviceid); |
| |
| if (device != null) { |
| pushRule(deviceService.getDevice(deviceid), request); |
| } |
| } else { |
| pushToAllDevices(request); |
| } |
| } |
| |
| @Override |
| public void cancelPackets(PacketRequest request) { |
| DeviceId deviceid = request.deviceId().orElse(null); |
| |
| if (deviceid != null) { |
| Device device = deviceService.getDevice(deviceid); |
| |
| if (device != null) { |
| removeRule(deviceService.getDevice(deviceid), request); |
| } |
| } else { |
| removeFromAllDevices(request); |
| } |
| } |
| } |
| |
| /** |
| * Internal listener for device service events. |
| */ |
| private class InternalDeviceListener implements DeviceListener { |
| |
| @Override |
| public boolean isRelevant(DeviceEvent event) { |
| return event.type() == DeviceEvent.Type.DEVICE_ADDED || |
| event.type() == DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED; |
| } |
| |
| @Override |
| public void event(DeviceEvent event) { |
| eventHandlingExecutor.execute(() -> { |
| try { |
| if (driverService == null) { |
| // Event came in after the driver service shut down, nothing to be done |
| return; |
| } |
| Device device = event.subject(); |
| Driver driver = driverService.getDriver(device.id()); |
| if (driver == null) { |
| return; |
| } |
| if (!Boolean.parseBoolean(driver.getProperty(SUPPORT_PACKET_REQUEST_PROPERTY))) { |
| return; |
| } |
| if (!deviceService.isAvailable(event.subject().id())) { |
| return; |
| } |
| pushRulesToDevice(device); |
| } catch (Exception e) { |
| log.warn("Failed to process {}: {}", event, e.getMessage()); |
| } |
| }); |
| } |
| } |
| |
| /** |
| * Entity for tracking stats for a packet processor. |
| */ |
| private class ProcessorEntry implements PacketProcessorEntry { |
| private final PacketProcessor processor; |
| private final int priority; |
| private long invocations = 0; |
| private long nanos = 0; |
| |
| public ProcessorEntry(PacketProcessor processor, int priority) { |
| this.processor = processor; |
| this.priority = priority; |
| } |
| |
| @Override |
| public PacketProcessor processor() { |
| return processor; |
| } |
| |
| @Override |
| public int priority() { |
| return priority; |
| } |
| |
| @Override |
| public long invocations() { |
| return invocations; |
| } |
| |
| @Override |
| public long totalNanos() { |
| return nanos; |
| } |
| |
| @Override |
| public long averageNanos() { |
| return invocations > 0 ? nanos / invocations : 0; |
| } |
| |
| void addNanos(long nanos) { |
| this.nanos += nanos; |
| this.invocations++; |
| } |
| } |
| } |