Drop using BNG attachment IDs in favor or dynamically allocated line IDs
The current implementation of BngProgrammable for fabric.p4 uses
attachment IDs as line IDs, thus forcing apps such as bngc to be aware
of such implementation detail and to manage the allocation of such IDs.
Unfortunately, allocation of IDs is dependent on the device (P4 program)
implementation (e.g., line counter size), and so it should not be left
to apps.
This patch removes the need for attachment IDs at all and instead relies
on a driver-level service to dynamically allocate line IDs based on the
attachment attributes (currently s-tag, c-tag, mac address).
The current implementation of the allocation logic is a trivial one,
i.e. non-distributed and non-optimized.
Change-Id: Ie960936ee750cf565b8de41370085ecf9d49e931
(cherry picked from commit 6aa2a6ea743e8104ee3c62acb7d26acbd1452614)
diff --git a/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/FabricBngLineIdAllocatorHandleTest.java b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/FabricBngLineIdAllocatorHandleTest.java
new file mode 100644
index 0000000..bff0b24
--- /dev/null
+++ b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/FabricBngLineIdAllocatorHandleTest.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2019-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.pipelines.fabric.impl.behaviour.bng;
+
+import com.google.common.testing.EqualsTester;
+import org.junit.Test;
+
+/**
+ * Tests for FabricBngLineIdAllocator.Handle.
+ */
+public class FabricBngLineIdAllocatorHandleTest {
+
+ @Test
+ public void equalityTest() {
+ var handle1 = new FabricBngLineIdAllocator.Handle(
+ new MockAttachment(1));
+ var sameAsHandle1 = new FabricBngLineIdAllocator.Handle(
+ new MockAttachment(1));
+ var handle2 = new FabricBngLineIdAllocator.Handle(
+ new MockAttachment(2));
+
+ new EqualsTester()
+ .addEqualityGroup(handle1, sameAsHandle1)
+ .addEqualityGroup(handle2)
+ .testEquals();
+ }
+}
\ No newline at end of file
diff --git a/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/FabricBngProgrammableServiceTest.java b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/FabricBngProgrammableServiceTest.java
new file mode 100644
index 0000000..28023a2
--- /dev/null
+++ b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/FabricBngProgrammableServiceTest.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2019-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.pipelines.fabric.impl.behaviour.bng;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.onosproject.net.DeviceId;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.fail;
+
+/**
+ * Tests for FabricBngProgrammableService.
+ */
+public class FabricBngProgrammableServiceTest {
+
+ private static final int SIZE = 10;
+ private static final DeviceId DEVICE_ID_1 = DeviceId.deviceId("device:1");
+ private static final DeviceId DEVICE_ID_2 = DeviceId.deviceId("device:2");
+
+ private final FabricBngProgrammableService service = new FabricBngProgrammableService();
+
+ @Before
+ public void setUp() throws Exception {
+ service.deviceService = new MockDeviceService();
+ service.activate();
+ }
+
+ @After
+ public void tearDown() throws Exception {
+ service.deactivate();
+ try {
+ service.getLineIdAllocator(DEVICE_ID_1, SIZE);
+ fail("Service methods should fail after deactivation");
+ } catch (NullPointerException e) {
+ // Expected.
+ }
+ }
+
+ @Test
+ public void getLineIdAllocatorTest() {
+ var allocator1 = service.getLineIdAllocator(DEVICE_ID_1, SIZE);
+ var sameAsAllocator1 = service.getLineIdAllocator(DEVICE_ID_1, SIZE);
+ var allocator2 = service.getLineIdAllocator(DEVICE_ID_2, SIZE);
+
+ assertEquals(allocator1.size(), SIZE);
+ assertEquals(allocator1, sameAsAllocator1);
+ assertNotEquals(allocator1, allocator2);
+
+ try {
+ service.getLineIdAllocator(DEVICE_ID_1, SIZE + 1);
+ fail("Retrieving allocators with different size should fail");
+ } catch (IllegalArgumentException e) {
+ // Expected.
+ }
+ }
+}
\ No newline at end of file
diff --git a/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/MockAttachment.java b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/MockAttachment.java
new file mode 100644
index 0000000..a0668be
--- /dev/null
+++ b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/MockAttachment.java
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2019-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.pipelines.fabric.impl.behaviour.bng;
+
+import org.onlab.packet.IpAddress;
+import org.onlab.packet.MacAddress;
+import org.onlab.packet.VlanId;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.net.behaviour.BngProgrammable;
+
+/**
+ * Mock implementation of BngProgrammable.Attachment.
+ */
+class MockAttachment implements BngProgrammable.Attachment {
+
+ private final VlanId stag;
+ private final VlanId ctag;
+ private final MacAddress macAddress;
+
+ MockAttachment(int seed) {
+ this.stag = VlanId.vlanId((short) seed);
+ this.ctag = VlanId.vlanId((short) seed);
+ this.macAddress = MacAddress.valueOf(seed);
+ }
+
+ @Override
+ public ApplicationId appId() {
+ return null;
+ }
+
+ @Override
+ public VlanId sTag() {
+ return stag;
+ }
+
+ @Override
+ public VlanId cTag() {
+ return ctag;
+ }
+
+ @Override
+ public MacAddress macAddress() {
+ return macAddress;
+ }
+
+ @Override
+ public IpAddress ipAddress() {
+ return null;
+ }
+
+ @Override
+ public boolean lineActive() {
+ return false;
+ }
+
+ @Override
+ public AttachmentType type() {
+ return null;
+ }
+
+ @Override
+ public short pppoeSessionId() {
+ return 0;
+ }
+}
diff --git a/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/MockDeviceService.java b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/MockDeviceService.java
new file mode 100644
index 0000000..a69d0af
--- /dev/null
+++ b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/MockDeviceService.java
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2019-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.pipelines.fabric.impl.behaviour.bng;
+
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.MastershipRole;
+import org.onosproject.net.Port;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.device.DeviceListener;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.device.PortStatistics;
+
+import java.util.List;
+
+/**
+ * Mock implmentation of DeviceService.
+ */
+class MockDeviceService implements DeviceService {
+ @Override
+ public int getDeviceCount() {
+ return 0;
+ }
+
+ @Override
+ public Iterable<Device> getDevices() {
+ return null;
+ }
+
+ @Override
+ public Iterable<Device> getDevices(Device.Type type) {
+ return null;
+ }
+
+ @Override
+ public Iterable<Device> getAvailableDevices() {
+ return null;
+ }
+
+ @Override
+ public Iterable<Device> getAvailableDevices(Device.Type type) {
+ return null;
+ }
+
+ @Override
+ public Device getDevice(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public MastershipRole getRole(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public List<Port> getPorts(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public List<PortStatistics> getPortStatistics(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public List<PortStatistics> getPortDeltaStatistics(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public Port getPort(DeviceId deviceId, PortNumber portNumber) {
+ return null;
+ }
+
+ @Override
+ public boolean isAvailable(DeviceId deviceId) {
+ return false;
+ }
+
+ @Override
+ public String localStatus(DeviceId deviceId) {
+ return null;
+ }
+
+ @Override
+ public long getLastUpdatedInstant(DeviceId deviceId) {
+ return 0;
+ }
+
+ @Override
+ public void addListener(DeviceListener listener) {
+
+ }
+
+ @Override
+ public void removeListener(DeviceListener listener) {
+
+ }
+}
diff --git a/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/SimpleBngLineIdAllocatorTest.java b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/SimpleBngLineIdAllocatorTest.java
new file mode 100644
index 0000000..3a9c064
--- /dev/null
+++ b/pipelines/fabric/impl/src/test/java/org/onosproject/pipelines/fabric/impl/behaviour/bng/SimpleBngLineIdAllocatorTest.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2019-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.pipelines.fabric.impl.behaviour.bng;
+
+import com.google.common.testing.EqualsTester;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.fail;
+
+/**
+ * Tests for SimpleBngLineIdAllocator.
+ */
+public class SimpleBngLineIdAllocatorTest {
+
+ private static final int SIZE = 10;
+
+ @Test
+ public void allocateAndReleaseTest() throws FabricBngLineIdAllocator.IdExhaustedException {
+ var allocator = new SimpleBngLineIdAllocator(SIZE);
+
+ var id1 = allocator.allocate(new MockAttachment(1));
+ var sameAsId1 = allocator.allocate(new MockAttachment(1));
+
+ var id2 = allocator.allocate(new MockAttachment(2));
+
+ assertEquals(allocator.allocatedCount(), 2);
+ assertEquals(allocator.freeCount(), SIZE - allocator.allocatedCount());
+
+ assertEquals(id1, sameAsId1);
+ assertNotEquals(id1, id2);
+
+ allocator.release(new MockAttachment(1));
+ assertEquals(allocator.allocatedCount(), 1);
+ assertEquals(allocator.freeCount(), SIZE - allocator.allocatedCount());
+
+ allocator.release(id2);
+ assertEquals(allocator.allocatedCount(), 0);
+ assertEquals(allocator.freeCount(), SIZE);
+ }
+
+ @Test
+ public void exhaustionTest() throws FabricBngLineIdAllocator.IdExhaustedException {
+ var allocator = new SimpleBngLineIdAllocator(SIZE);
+ var equalTester = new EqualsTester();
+ for (int i = 0; i < SIZE; i++) {
+ // Add ID to equality group to later make sure that all IDs are
+ // different.
+ equalTester.addEqualityGroup(
+ allocator.allocate(new MockAttachment(i)));
+ }
+
+ assertEquals(allocator.allocatedCount(), SIZE);
+ assertEquals(allocator.freeCount(), 0);
+ equalTester.testEquals();
+
+ try {
+ allocator.allocate(new MockAttachment(SIZE + 1));
+ fail("IdExhaustedException not thrown");
+ } catch (FabricBngLineIdAllocator.IdExhaustedException e) {
+ // Expected.
+ }
+
+ for (int i = 0; i < SIZE; i++) {
+ allocator.release(new MockAttachment(i));
+ }
+
+ assertEquals(allocator.allocatedCount(), 0);
+ assertEquals(allocator.freeCount(), SIZE);
+ }
+
+}
\ No newline at end of file