ONOS-3759 Packet fallback driver provider
Change-Id: I8d526f66200b68d21aad3bd88575f6021d10c9a1
diff --git a/core/api/src/main/java/org/onosproject/net/packet/PacketProgrammable.java b/core/api/src/main/java/org/onosproject/net/packet/PacketProgrammable.java
new file mode 100644
index 0000000..8356590
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/packet/PacketProgrammable.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2016 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;
+
+import org.onosproject.net.driver.HandlerBehaviour;
+
+/**
+ * Packet programmable device behaviour.
+ */
+public interface PacketProgrammable extends HandlerBehaviour {
+
+ /**
+ * Emits the specified outbound packet onto the network from the device.
+ * @param packet outbound packet
+ */
+ void emit(OutboundPacket packet);
+}
diff --git a/core/net/src/main/java/org/onosproject/net/packet/impl/PacketDriverProvider.java b/core/net/src/main/java/org/onosproject/net/packet/impl/PacketDriverProvider.java
new file mode 100644
index 0000000..ae37736
--- /dev/null
+++ b/core/net/src/main/java/org/onosproject/net/packet/impl/PacketDriverProvider.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2016 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.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.packet.OutboundPacket;
+import org.onosproject.net.packet.PacketProgrammable;
+import org.onosproject.net.packet.PacketProvider;
+import org.onosproject.net.provider.AbstractProvider;
+import org.onosproject.net.provider.ProviderId;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Driver-based packet rule provider.
+ */
+public class PacketDriverProvider extends AbstractProvider implements PacketProvider {
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ // To be extracted for reuse as we deal with other.
+ private static final String SCHEME = "default";
+ private static final String PROVIDER_NAME = "org.onosproject.provider";
+ protected DeviceService deviceService;
+
+ public PacketDriverProvider() {
+ super(new ProviderId(SCHEME, PROVIDER_NAME));
+ }
+
+ /**
+ * Initializes the provider with the necessary device service.
+ *
+ * @param deviceService device service
+ */
+ void init(DeviceService deviceService) {
+ this.deviceService = deviceService;
+ }
+
+ @Override
+ public void emit(OutboundPacket packet) {
+ PacketProgrammable programmable = getPacketProgrammable(packet.sendThrough());
+ if (programmable != null) {
+ programmable.emit(packet);
+ }
+ }
+
+ private PacketProgrammable getPacketProgrammable(DeviceId deviceId) {
+ PacketProgrammable programmable = deviceService.getDevice(deviceId).as(PacketProgrammable.class);
+ if (programmable == null) {
+ log.warn("Device {} is not packet programmable");
+ }
+ return programmable;
+ }
+}
diff --git a/core/net/src/main/java/org/onosproject/net/packet/impl/PacketManager.java b/core/net/src/main/java/org/onosproject/net/packet/impl/PacketManager.java
index c0a2286..ba16d13 100644
--- a/core/net/src/main/java/org/onosproject/net/packet/impl/PacketManager.java
+++ b/core/net/src/main/java/org/onosproject/net/packet/impl/PacketManager.java
@@ -89,19 +89,19 @@
private final PacketStoreDelegate delegate = new InternalStoreDelegate();
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
- private CoreService coreService;
+ protected CoreService coreService;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
- private ClusterService clusterService;
+ protected ClusterService clusterService;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
- private DeviceService deviceService;
+ protected DeviceService deviceService;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
- private FlowRuleService flowService;
+ protected FlowRuleService flowService;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
- private PacketStore store;
+ protected PacketStore store;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
private FlowObjectiveService objectiveService;
@@ -112,6 +112,8 @@
private final List<ProcessorEntry> processors = Lists.newCopyOnWriteArrayList();
+ private final PacketDriverProvider defaultProvider = new PacketDriverProvider();
+
private ApplicationId appId;
private NodeId localNodeId;
@@ -124,6 +126,7 @@
store.setDelegate(delegate);
deviceService.addListener(deviceListener);
store.existingRequests().forEach(this::pushToAllDevices);
+ defaultProvider.init(deviceService);
log.info("Started");
}
@@ -136,6 +139,11 @@
}
@Override
+ protected PacketProvider defaultProvider() {
+ return defaultProvider;
+ }
+
+ @Override
public void addProcessor(PacketProcessor processor, int priority) {
checkPermission(PACKET_EVENT);
checkNotNull(processor, "Processor cannot be null");
@@ -374,7 +382,7 @@
/**
* Internal callback from the packet store.
*/
- private class InternalStoreDelegate implements PacketStoreDelegate {
+ protected class InternalStoreDelegate implements PacketStoreDelegate {
@Override
public void notify(PacketEvent event) {
localEmit(event.subject());
diff --git a/core/net/src/test/java/org/onosproject/net/packet/impl/PacketManagerTest.java b/core/net/src/test/java/org/onosproject/net/packet/impl/PacketManagerTest.java
new file mode 100644
index 0000000..393cc06
--- /dev/null
+++ b/core/net/src/test/java/org/onosproject/net/packet/impl/PacketManagerTest.java
@@ -0,0 +1,158 @@
+/*
+ * Copyright 2016 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 com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import org.junit.Before;
+import org.junit.Test;
+import org.onosproject.cluster.ClusterServiceAdapter;
+import org.onosproject.common.event.impl.TestEventDispatcher;
+import org.onosproject.core.CoreServiceAdapter;
+import org.onosproject.core.IdGenerator;
+import org.onosproject.event.TestListener;
+import org.onosproject.net.AnnotationKeys;
+import org.onosproject.net.DefaultAnnotations;
+import org.onosproject.net.DefaultDevice;
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceServiceAdapter;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.onosproject.net.driver.DefaultDriver;
+import org.onosproject.net.driver.impl.DriverManager;
+import org.onosproject.net.flow.DefaultTrafficTreatment;
+import org.onosproject.net.packet.DefaultOutboundPacket;
+import org.onosproject.net.packet.OutboundPacket;
+import org.onosproject.net.packet.PacketProgrammable;
+import org.onosproject.net.packet.PacketProviderRegistry;
+import org.onosproject.net.provider.ProviderId;
+import org.onosproject.net.provider.TestProvider;
+import org.onosproject.store.trivial.SimplePacketStore;
+
+import java.nio.ByteBuffer;
+import java.util.concurrent.atomic.AtomicLong;
+
+import static org.junit.Assert.assertEquals;
+import static org.onosproject.net.NetTestTools.injectEventDispatcher;
+
+/**
+ * Test packet manager activity.
+ */
+public class PacketManagerTest {
+
+ private static final ProviderId FOO_PID = new ProviderId("foo", "foo");
+
+ private static final DeviceId FOO_DID = DeviceId.deviceId("foo:002");
+
+ private static final DefaultAnnotations ANNOTATIONS =
+ DefaultAnnotations.builder().set(AnnotationKeys.DRIVER, "foo").build();
+
+ private static final Device FOO_DEV =
+ new DefaultDevice(FOO_PID, FOO_DID, Device.Type.SWITCH, "", "", "", "", null, ANNOTATIONS);
+
+ private PacketManager mgr;
+
+ protected TestProvider provider;
+ protected TestListener listener = new TestListener();
+
+ private PacketProviderRegistry providerRegistry;
+
+ private TestDriverManager driverService;
+
+ @Before
+ public void setUp() {
+ mgr = new PacketManager();
+ injectEventDispatcher(mgr, new TestEventDispatcher());
+ mgr.store = new SimplePacketStore();
+ mgr.clusterService = new ClusterServiceAdapter();
+ mgr.deviceService = new TestDeviceService();
+ mgr.deviceService = new TestDeviceService();
+ mgr.coreService = new TestCoreService();
+ providerRegistry = mgr;
+ mgr.activate();
+ driverService = new TestDriverManager();
+ driverService.addDriver(new DefaultDriver("foo", ImmutableList.of(), "", "", "",
+ ImmutableMap.of(PacketProgrammable.class,
+ TestPacketProgrammable.class),
+ ImmutableMap.of()));
+ }
+
+ /**
+ * Tests the correct usage of fallback driver provider for packets.
+ */
+ @Test
+ public void packetProviderfallbackBasics() {
+ OutboundPacket packet =
+ new DefaultOutboundPacket(FOO_DID, DefaultTrafficTreatment.emptyTreatment(), ByteBuffer.allocate(5));
+ mgr.emit(packet);
+ assertEquals("Packet not emitted correctly", packet, emittedPacket);
+ }
+
+ private static class TestDeviceService extends DeviceServiceAdapter {
+ @Override
+ public int getDeviceCount() {
+ return 1;
+ }
+
+ @Override
+ public Iterable<Device> getDevices() {
+ return ImmutableList.of(FOO_DEV);
+ }
+
+ @Override
+ public Iterable<Device> getAvailableDevices() {
+ return getDevices();
+ }
+
+ @Override
+ public Device getDevice(DeviceId deviceId) {
+ return FOO_DEV;
+ }
+ }
+
+ private class TestCoreService extends CoreServiceAdapter {
+
+ @Override
+ public IdGenerator getIdGenerator(String topic) {
+ return new IdGenerator() {
+ private AtomicLong counter = new AtomicLong(0);
+
+ @Override
+ public long getNewId() {
+ return counter.getAndIncrement();
+ }
+ };
+ }
+ }
+
+ private class TestDriverManager extends DriverManager {
+ TestDriverManager() {
+ this.deviceService = mgr.deviceService;
+ activate();
+ }
+ }
+
+ private static OutboundPacket emittedPacket = null;
+
+ public static class TestPacketProgrammable extends AbstractHandlerBehaviour implements PacketProgrammable {
+
+ @Override
+ public void emit(OutboundPacket packet) {
+ emittedPacket = packet;
+ }
+ }
+}