| /* |
| * Copyright 2014-2015 Open Networking Laboratory |
| * |
| * 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 org.apache.felix.scr.annotations.Activate; |
| import org.apache.felix.scr.annotations.Component; |
| import org.apache.felix.scr.annotations.Deactivate; |
| import org.apache.felix.scr.annotations.Reference; |
| import org.apache.felix.scr.annotations.ReferenceCardinality; |
| import org.apache.felix.scr.annotations.Service; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.net.Device; |
| import org.onosproject.net.device.DeviceEvent; |
| import org.onosproject.net.device.DeviceListener; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.flow.DefaultTrafficTreatment; |
| import org.onosproject.net.flow.FlowRuleService; |
| import org.onosproject.net.flow.TrafficSelector; |
| 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.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.slf4j.Logger; |
| |
| import java.util.Map; |
| import java.util.concurrent.ConcurrentHashMap; |
| import java.util.concurrent.ExecutorService; |
| import java.util.concurrent.Executors; |
| |
| 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.slf4j.LoggerFactory.getLogger; |
| import static org.onosproject.security.AppPermission.Type.*; |
| |
| /** |
| * Provides a basic implementation of the packet SB & NB APIs. |
| */ |
| @Component(immediate = true) |
| @Service |
| public class PacketManager |
| extends AbstractProviderRegistry<PacketProvider, PacketProviderService> |
| implements PacketService, PacketProviderRegistry { |
| |
| private final Logger log = getLogger(getClass()); |
| |
| private static final String TABLE_TYPE_MSG = |
| "Table Type cannot be null. For requesting packets without " + |
| "table hints, use other methods in the packetService API"; |
| |
| private final PacketStoreDelegate delegate = new InternalStoreDelegate(); |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| private CoreService coreService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| private DeviceService deviceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| private FlowRuleService flowService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| private PacketStore store; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| private FlowObjectiveService objectiveService; |
| |
| private ExecutorService eventHandlingExecutor; |
| |
| private final DeviceListener deviceListener = new InternalDeviceListener(); |
| |
| private final Map<Integer, PacketProcessor> processors = new ConcurrentHashMap<>(); |
| |
| private ApplicationId appId; |
| |
| @Activate |
| public void activate() { |
| eventHandlingExecutor = Executors.newSingleThreadExecutor( |
| groupedThreads("onos/net/packet", "event-handler")); |
| appId = coreService.getAppId(CoreService.CORE_APP_NAME); |
| store.setDelegate(delegate); |
| deviceService.addListener(deviceListener); |
| // TODO: Should we request packets for all existing devices? I believe we should. |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| store.unsetDelegate(delegate); |
| deviceService.removeListener(deviceListener); |
| eventHandlingExecutor.shutdown(); |
| log.info("Stopped"); |
| } |
| |
| @Override |
| public void addProcessor(PacketProcessor processor, int priority) { |
| checkPermission(PACKET_EVENT); |
| checkNotNull(processor, "Processor cannot be null"); |
| processors.put(priority, processor); |
| } |
| |
| @Override |
| public void removeProcessor(PacketProcessor processor) { |
| checkPermission(PACKET_EVENT); |
| checkNotNull(processor, "Processor cannot be null"); |
| processors.values().remove(processor); |
| } |
| |
| @Override |
| public void requestPackets(TrafficSelector selector, PacketPriority priority, |
| ApplicationId appId) { |
| checkPermission(PACKET_READ); |
| checkNotNull(selector, "Selector cannot be null"); |
| checkNotNull(appId, "Application ID cannot be null"); |
| |
| PacketRequest request = new DefaultPacketRequest(selector, priority, appId); |
| if (store.requestPackets(request)) { |
| pushToAllDevices(request); |
| } |
| } |
| |
| @Override |
| public void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| ApplicationId appId) { |
| checkPermission(PACKET_READ); |
| checkNotNull(selector, "Selector cannot be null"); |
| checkNotNull(appId, "Application ID cannot be null"); |
| |
| PacketRequest request = new DefaultPacketRequest(selector, priority, appId); |
| if (store.cancelPackets(request)) { |
| removeFromAllDevices(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()) { |
| pushRule(device, request); |
| } |
| } |
| |
| |
| /** |
| * Removes packet request flow rule from all devices. |
| * |
| * @param request the packet request |
| */ |
| private void removeFromAllDevices(PacketRequest request) { |
| for (Device device : deviceService.getDevices()) { |
| removeRule(device, 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; |
| } |
| |
| 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) { |
| return DefaultForwardingObjective.builder() |
| .withPriority(request.priority().priorityValue()) |
| .withSelector(request.selector()) |
| .fromApp(appId) |
| .withFlag(ForwardingObjective.Flag.VERSATILE) |
| .withTreatment(DefaultTrafficTreatment.builder().punt().build()) |
| .makePermanent(); |
| } |
| |
| @Override |
| public void emit(OutboundPacket packet) { |
| checkPermission(PACKET_WRITE); |
| checkNotNull(packet, "Packet cannot be null"); |
| store.emit(packet); |
| } |
| |
| private void localEmit(OutboundPacket packet) { |
| final 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); |
| } |
| |
| @Override |
| public void processPacket(PacketContext context) { |
| // TODO filter packets sent to processors based on registrations |
| for (PacketProcessor processor : processors.values()) { |
| processor.process(context); |
| } |
| } |
| |
| } |
| |
| /** |
| * Internal callback from the packet store. |
| */ |
| private class InternalStoreDelegate implements PacketStoreDelegate { |
| @Override |
| public void notify(PacketEvent event) { |
| localEmit(event.subject()); |
| } |
| } |
| |
| /** |
| * Internal listener for device service events. |
| */ |
| private class InternalDeviceListener implements DeviceListener { |
| @Override |
| public void event(DeviceEvent event) { |
| eventHandlingExecutor.execute(() -> { |
| try { |
| Device device = event.subject(); |
| switch (event.type()) { |
| case DEVICE_ADDED: |
| case DEVICE_AVAILABILITY_CHANGED: |
| if (deviceService.isAvailable(event.subject().id())) { |
| log.debug("Pushing packet requests to device {}", event.subject().id()); |
| for (PacketRequest request : store.existingRequests()) { |
| pushRule(device, request); |
| } |
| } |
| break; |
| default: |
| break; |
| } |
| } catch (Exception e) { |
| log.warn("Failed to process {}", event, e); |
| } |
| }); |
| } |
| } |
| |
| } |