Add explicit flow rules to receive control packets: ARP, LLDP, BDDP
This fixes ONOS-540
NOTES:
* Currently, the flow rules are pushed by each module that needs to receive
the corresponding control packets:
- ARP: ProxyArpManager, HostLocationProvider
- LLDP and BDDP: LLDPLinkProvider
* Pushing the corresponding IPv6 rules for Neighbor Discovery is not done yet
* In the future, we might want to consider an explicit service to
subscribe for receiving particular control packets
Change-Id: I292ad11a2e48390624f381c278e55e5d0af93c6d
diff --git a/providers/host/pom.xml b/providers/host/pom.xml
index 5cf7c40..2ea2ad6 100644
--- a/providers/host/pom.xml
+++ b/providers/host/pom.xml
@@ -52,6 +52,11 @@
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.easymock</groupId>
+ <artifactId>easymock</artifactId>
+ <scope>test</scope>
+ </dependency>
</dependencies>
</project>
diff --git a/providers/host/src/main/java/org/onosproject/provider/host/impl/HostLocationProvider.java b/providers/host/src/main/java/org/onosproject/provider/host/impl/HostLocationProvider.java
index ffe6c41..7c3d2ec 100644
--- a/providers/host/src/main/java/org/onosproject/provider/host/impl/HostLocationProvider.java
+++ b/providers/host/src/main/java/org/onosproject/provider/host/impl/HostLocationProvider.java
@@ -22,14 +22,23 @@
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
import org.onosproject.net.ConnectPoint;
-import org.onosproject.net.DeviceId;
+import org.onosproject.net.Device;
import org.onosproject.net.Host;
import org.onosproject.net.HostId;
import org.onosproject.net.HostLocation;
import org.onosproject.net.device.DeviceEvent;
import org.onosproject.net.device.DeviceListener;
import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.flow.DefaultFlowRule;
+import org.onosproject.net.flow.DefaultTrafficSelector;
+import org.onosproject.net.flow.DefaultTrafficTreatment;
+import org.onosproject.net.flow.FlowRule;
+import org.onosproject.net.flow.FlowRuleService;
+import org.onosproject.net.flow.TrafficSelector;
+import org.onosproject.net.flow.TrafficTreatment;
import org.onosproject.net.host.DefaultHostDescription;
import org.onosproject.net.host.HostDescription;
import org.onosproject.net.host.HostProvider;
@@ -68,6 +77,14 @@
private final Logger log = getLogger(getClass());
+ private static final int FLOW_RULE_PRIORITY = 40000;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected CoreService coreService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected FlowRuleService flowRuleService;
+
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
protected HostProviderRegistry providerRegistry;
@@ -88,6 +105,8 @@
private final InternalHostProvider processor = new InternalHostProvider();
private final DeviceListener deviceListener = new InternalDeviceListener();
+ private ApplicationId appId;
+
@Property(name = "hostRemovalEnabled", boolValue = true,
label = "Enable host removal on port/device down events")
private boolean hostRemovalEnabled = true;
@@ -102,10 +121,15 @@
@Activate
public void activate(ComponentContext context) {
+ appId =
+ coreService.registerApplication("org.onosproject.provider.host");
+
modified(context);
providerService = providerRegistry.register(this);
pktService.addProcessor(processor, 1);
deviceService.addListener(deviceListener);
+ pushRules();
+
log.info("Started");
}
@@ -137,6 +161,36 @@
log.info("Triggering probe on device {}", host);
}
+ /**
+ * Pushes flow rules to all devices.
+ */
+ private void pushRules() {
+ for (Device device : deviceService.getDevices()) {
+ pushRules(device);
+ }
+ }
+
+ /**
+ * Pushes flow rules to the device to receive control packets that need
+ * to be processed.
+ *
+ * @param device the device to push the rules to
+ */
+ private synchronized void pushRules(Device device) {
+ TrafficSelector.Builder sbuilder = DefaultTrafficSelector.builder();
+ TrafficTreatment.Builder tbuilder = DefaultTrafficTreatment.builder();
+
+ // Get all ARP packets
+ sbuilder.matchEthType(Ethernet.TYPE_ARP);
+ tbuilder.punt();
+ FlowRule flowArp =
+ new DefaultFlowRule(device.id(),
+ sbuilder.build(), tbuilder.build(),
+ FLOW_RULE_PRIORITY, appId, 0, true);
+
+ flowRuleService.applyFlowRules(flowArp);
+ }
+
private class InternalHostProvider implements PacketProcessor {
@Override
@@ -204,23 +258,40 @@
private class InternalDeviceListener implements DeviceListener {
@Override
public void event(DeviceEvent event) {
- if (!hostRemovalEnabled) {
- return;
- }
-
- DeviceEvent.Type type = event.type();
- DeviceId deviceId = event.subject().id();
- if (type == DeviceEvent.Type.PORT_UPDATED) {
- ConnectPoint point = new ConnectPoint(deviceId, event.port().number());
- removeHosts(hostService.getConnectedHosts(point));
-
- } else if (type == DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED) {
- if (!deviceService.isAvailable(deviceId)) {
- removeHosts(hostService.getConnectedHosts(deviceId));
+ Device device = event.subject();
+ switch (event.type()) {
+ case DEVICE_ADDED:
+ pushRules(device);
+ break;
+ case DEVICE_AVAILABILITY_CHANGED:
+ if (hostRemovalEnabled &&
+ !deviceService.isAvailable(device.id())) {
+ removeHosts(hostService.getConnectedHosts(device.id()));
}
-
- } else if (type == DeviceEvent.Type.DEVICE_REMOVED) {
- removeHosts(hostService.getConnectedHosts(deviceId));
+ break;
+ case DEVICE_SUSPENDED:
+ case DEVICE_UPDATED:
+ // Nothing to do?
+ break;
+ case DEVICE_REMOVED:
+ if (hostRemovalEnabled) {
+ removeHosts(hostService.getConnectedHosts(device.id()));
+ }
+ break;
+ case PORT_ADDED:
+ break;
+ case PORT_UPDATED:
+ if (hostRemovalEnabled) {
+ ConnectPoint point =
+ new ConnectPoint(device.id(), event.port().number());
+ removeHosts(hostService.getConnectedHosts(point));
+ }
+ break;
+ case PORT_REMOVED:
+ // Nothing to do?
+ break;
+ default:
+ break;
}
}
}
diff --git a/providers/host/src/test/java/org/onosproject/provider/host/impl/HostLocationProviderTest.java b/providers/host/src/test/java/org/onosproject/provider/host/impl/HostLocationProviderTest.java
index 84c2ee6..4db62b4 100644
--- a/providers/host/src/test/java/org/onosproject/provider/host/impl/HostLocationProviderTest.java
+++ b/providers/host/src/test/java/org/onosproject/provider/host/impl/HostLocationProviderTest.java
@@ -15,10 +15,19 @@
*/
package org.onosproject.provider.host.impl;
+import static org.easymock.EasyMock.anyObject;
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.expectLastCall;
+import static org.easymock.EasyMock.replay;
+
import com.google.common.collect.ImmutableSet;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.core.DefaultApplicationId;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DefaultDevice;
import org.onosproject.net.DefaultHost;
@@ -31,6 +40,8 @@
import org.onosproject.net.device.DeviceEvent;
import org.onosproject.net.device.DeviceListener;
import org.onosproject.net.device.DeviceServiceAdapter;
+import org.onosproject.net.flow.FlowRule;
+import org.onosproject.net.flow.FlowRuleService;
import org.onosproject.net.flow.TrafficTreatment;
import org.onosproject.net.host.HostDescription;
import org.onosproject.net.host.HostProvider;
@@ -56,6 +67,7 @@
import org.onlab.packet.VlanId;
import java.nio.ByteBuffer;
+import java.util.Collections;
import java.util.Dictionary;
import java.util.Hashtable;
import java.util.Set;
@@ -118,10 +130,29 @@
private final TestPacketService packetService = new TestPacketService();
private PacketProcessor testProcessor;
+ private CoreService coreService;
+ private FlowRuleService flowRuleService;
private TestHostProviderService providerService;
+ private ApplicationId appId = new DefaultApplicationId((short) 100,
+ "org.onosproject.provider.host");
+
@Before
public void setUp() {
+
+ coreService = createMock(CoreService.class);
+ expect(coreService.registerApplication(appId.name()))
+ .andReturn(appId).anyTimes();
+ replay(coreService);
+
+ flowRuleService = createMock(FlowRuleService.class);
+ flowRuleService.applyFlowRules(anyObject(FlowRule.class));
+ expectLastCall().anyTimes();
+ replay(flowRuleService);
+
+ provider.coreService = coreService;
+ provider.flowRuleService = flowRuleService;
+
provider.providerRegistry = hostRegistry;
provider.topologyService = topoService;
provider.pktService = packetService;
@@ -189,8 +220,9 @@
@After
public void tearDown() {
provider.deactivate();
+ provider.coreService = null;
+ provider.flowRuleService = null;
provider.providerRegistry = null;
-
}
private class TestHostRegistry implements HostProviderRegistry {
@@ -339,6 +371,11 @@
public void addListener(DeviceListener listener) {
this.listener = listener;
}
+
+ @Override
+ public Iterable<Device> getDevices() {
+ return Collections.emptyList();
+ }
}
private class TestHostService extends HostServiceAdapter {