RD allocation using IDManager

JIRA: GENIUS-262

RD is currently allocated by opensatck in netvirt.
For COE, RD has to be auto generated.
These changes is to introduce the logic in GENIUS using IDmanager

Change-Id: I8afadbc330b41f8dc7b71252de396f8500bfd5d1
Signed-off-by: Vyshakh Krishnan CH <vyshakh.krishnan.c.h@ericsson.com>

diff --git a/mdsalutil/mdsalutil-api/src/main/java/org/opendaylight/genius/mdsalutil/NwConstants.java b/mdsalutil/mdsalutil-api/src/main/java/org/opendaylight/genius/mdsalutil/NwConstants.java
index 3e10a9d1a29a26cce5325eb32d3661c832b1c5e7..2783d6c98316c58484dd07b9f5e4cb14ccf7e332 100644 (file)
--- a/mdsalutil/mdsalutil-api/src/main/java/org/opendaylight/genius/mdsalutil/NwConstants.java
+++ b/mdsalutil/mdsalutil-api/src/main/java/org/opendaylight/genius/mdsalutil/NwConstants.java
@@ -197,6 +197,11 @@ public interface NwConstants {
     long VNI_DEFAULT_LOW_VALUE = 70000L;
     long VNI_DEFAULT_HIGH_VALUE = 99999L;
 
+    String ODL_RD_POOL_NAME = "opendaylight-rd-ranges";
+    String RD_DEFAULT_LOW_VALUE = "100:1";
+    long RD_DEFAULT_COUNT = 65535L;
+    long RD_MAX_VALUE_FIELD = 65535L;
+
     enum NxmOfFieldType {
         NXM_OF_IN_PORT(0x0000, 0, 2, 16),
         NXM_OF_ETH_DST(0x0000, 1, 6, 48),

diff --git a/networkutils/networkutils/src/main/java/org/opendaylight/genius/networkutils/RDUtils.java b/networkutils/networkutils/src/main/java/org/opendaylight/genius/networkutils/RDUtils.java
new file mode 100644 (file)
index 0000000..e6909e7
--- /dev/null
+++ b/networkutils/networkutils/src/main/java/org/opendaylight/genius/networkutils/RDUtils.java
@@ -0,0 +1,25 @@
+/*
+ * Copyright © 2018 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.genius.networkutils;
+
+import com.google.common.base.Optional;
+import java.util.concurrent.ExecutionException;
+
+import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
+
+
+public interface RDUtils {
+
+    String getRD(String rdKey) throws ExecutionException, InterruptedException;
+
+    void releaseRD(String rdKey) throws ExecutionException, InterruptedException;
+
+    Optional<IdPool> getRDPool() throws ReadFailedException;
+}
\ No newline at end of file

diff --git a/networkutils/networkutils/src/main/java/org/opendaylight/genius/networkutils/impl/RDUtilsImpl.java b/networkutils/networkutils/src/main/java/org/opendaylight/genius/networkutils/impl/RDUtilsImpl.java
new file mode 100644 (file)
index 0000000..9c53ae3
--- /dev/null
+++ b/networkutils/networkutils/src/main/java/org/opendaylight/genius/networkutils/impl/RDUtilsImpl.java
@@ -0,0 +1,193 @@
+/*
+ * Copyright © 2018 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.genius.networkutils.impl;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Optional;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+import org.apache.aries.blueprint.annotation.service.Reference;
+import org.apache.aries.blueprint.annotation.service.Service;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
+import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
+import org.opendaylight.genius.mdsalutil.NwConstants;
+import org.opendaylight.genius.networkutils.RDUtils;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.DeleteIdPoolInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.DeleteIdPoolInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.DeleteIdPoolOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.networkutils.config.rev181129.NetworkConfig;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Singleton
+@Service(classes = RDUtils.class)
+public class RDUtilsImpl implements RDUtils {
+
+    private static final Logger LOG = LoggerFactory.getLogger(RDUtilsImpl.class);
+
+    private final IdManagerService idManagerService;
+    private final DataBroker dataBroker;
+    private final NetworkConfig networkConfig;
+
+    @Inject
+    public RDUtilsImpl(NetworkConfig networkConfig, IdManagerService idManagerService,
+                       @Reference DataBroker dataBroker) throws ReadFailedException {
+        this.idManagerService = idManagerService;
+        this.dataBroker = dataBroker;
+        this.networkConfig = networkConfig;
+        validateAndCreateRDPool();
+    }
+
+    /*
+     * if the base RD is 100:1 and generated idValue is 100, this fn returns 100:101
+     * if the base RD is 200:2000 and generated RD value is 64000, this fn should return 201:2465
+     *
+     *   if RD is x:y
+     *   y can go till 65535(RD_MAX_VALUE_FIELD) and then x is incremented with y reset to 0
+     */
+
+    public String convertIdValuetoRD(long idValue) {
+        String configuredRDStartValue = networkConfig.getOpendaylightRdStartValue();
+        String[] configureRDSplit = NwConstants.RD_DEFAULT_LOW_VALUE.split(":");
+        if (configuredRDStartValue != null) {
+            configureRDSplit = configuredRDStartValue.split(":");
+        }
+        long baseAsNum = Long.parseLong(configureRDSplit[0]);
+        long baseValue = Long.parseLong(configureRDSplit[1]);
+        baseAsNum = baseAsNum + ((baseValue + idValue) / NwConstants.RD_MAX_VALUE_FIELD) ;
+        baseValue = (baseValue + idValue) % NwConstants.RD_MAX_VALUE_FIELD ;
+
+        return String.valueOf(baseAsNum) + ":" + String.valueOf(baseValue);
+    }
+
+    @Override
+    public String getRD(String rdKey) throws ExecutionException, InterruptedException {
+        AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(NwConstants.ODL_RD_POOL_NAME)
+                .setIdKey(rdKey).build();
+        Future<RpcResult<AllocateIdOutput>> result = idManagerService.allocateId(getIdInput);
+        RpcResult<AllocateIdOutput> rpcResult = result.get();
+        if (rpcResult.isSuccessful()) {
+            String rd = convertIdValuetoRD(rpcResult.getResult().getIdValue());
+            return rd;
+        }
+        return null;
+    }
+
+    @Override
+    public void releaseRD(String rdKey) throws ExecutionException, InterruptedException {
+        ReleaseIdInput releaseIdInput = new ReleaseIdInputBuilder().setPoolName(NwConstants.ODL_RD_POOL_NAME)
+                .setIdKey(rdKey).build();
+        RpcResult<ReleaseIdOutput> rpcResult = idManagerService.releaseId(releaseIdInput).get();
+        if (!rpcResult.isSuccessful()) {
+            LOG.warn("releaseRD : Unable to release ID {} from OpenDaylight RD pool. Error {}",
+                    rdKey, rpcResult.getErrors());
+        }
+    }
+
+    public Optional<IdPool> getRDPool() throws ReadFailedException {
+        return SingleTransactionDataBroker.syncReadOptional(dataBroker,
+                LogicalDatastoreType.CONFIGURATION, buildIdPoolInstanceIdentifier(NwConstants.ODL_RD_POOL_NAME));
+    }
+
+    private void validateAndCreateRDPool() throws ReadFailedException {
+        long lowLimit = 0L;
+        long highLimit = networkConfig.getOpendaylightRdCount();
+        if (highLimit == 0L) {
+            highLimit = NwConstants.RD_DEFAULT_COUNT;
+        }
+        Optional<IdPool> existingIdPool = SingleTransactionDataBroker.syncReadOptional(dataBroker,
+                LogicalDatastoreType.CONFIGURATION,
+                buildIdPoolInstanceIdentifier(NwConstants.ODL_RD_POOL_NAME));
+        if (existingIdPool.isPresent()) {
+            IdPool odlRDPool = existingIdPool.get();
+            long currentStartLimit = odlRDPool.getAvailableIdsHolder().getStart();
+            long currentEndLimit = odlRDPool.getAvailableIdsHolder().getEnd();
+
+            if (lowLimit == currentStartLimit && highLimit == currentEndLimit) {
+                LOG.debug("validateAndCreateRDPool : OpenDaylight RD pool already exists "
+                        + "with configured Range");
+            } else {
+                if (odlRDPool.getIdEntries() != null && odlRDPool.getIdEntries().size() != 0) {
+                    LOG.warn("validateAndCreateRDPool : Some Allocation already exists with old Range. "
+                            + "Cannot modify existing limit of OpenDaylight RD pool");
+                } else {
+                    LOG.debug("validateAndCreateRDPool : No RDs allocated from OpenDaylight RD pool "
+                            + "Delete and re-create pool with new configured Range {}-{}",lowLimit, highLimit);
+                    deleteOpenDaylightRDPool();
+                    createOpenDaylightRDPool(lowLimit, highLimit);
+                }
+            }
+        } else {
+            createOpenDaylightRDPool(lowLimit, highLimit);
+        }
+    }
+
+    private void createOpenDaylightRDPool(long lowLimit, long highLimit) {
+        CreateIdPoolInput createPool = new CreateIdPoolInputBuilder()
+                .setPoolName(NwConstants.ODL_RD_POOL_NAME).setLow(lowLimit).setHigh(highLimit).build();
+        try {
+            Future<RpcResult<CreateIdPoolOutput>> result = idManagerService.createIdPool(createPool);
+            if (result != null && result.get().isSuccessful()) {
+                LOG.debug("createOpenDaylightRDPool : Created OpenDaylight RD pool {} "
+                        + "with range {}-{}", NwConstants.ODL_RD_POOL_NAME, lowLimit, highLimit);
+            } else {
+                LOG.error("createOpenDaylightRDPool : Failed to create OpenDaylight RD pool {} "
+                        + "with range {}-{}", NwConstants.ODL_RD_POOL_NAME, lowLimit, highLimit);
+            }
+        } catch (InterruptedException | ExecutionException e) {
+            LOG.error("createOpenDaylightRDPool : Failed to create OpenDaylight RD pool {} "
+                    + "with range {}-{}", NwConstants.ODL_RD_POOL_NAME, lowLimit, highLimit);
+        }
+    }
+
+    private void deleteOpenDaylightRDPool() {
+
+        DeleteIdPoolInput deletePool = new DeleteIdPoolInputBuilder()
+                .setPoolName(NwConstants.ODL_RD_POOL_NAME).build();
+        Future<RpcResult<DeleteIdPoolOutput>> result = idManagerService.deleteIdPool(deletePool);
+        try {
+            if (result != null && result.get().isSuccessful()) {
+                LOG.debug("deleteOpenDaylightRDPool : Deleted OpenDaylight RD pool {} successfully",
+                        NwConstants.ODL_RD_POOL_NAME);
+            } else {
+                LOG.error("deleteOpenDaylightRDPool : Failed to delete OpenDaylight RD pool {} ",
+                        NwConstants.ODL_RD_POOL_NAME);
+            }
+        } catch (InterruptedException | ExecutionException e) {
+            LOG.error("deleteOpenDaylightRDPool : Failed to delete OpenDaylight RD range pool {} ",
+                    NwConstants.ODL_RD_POOL_NAME, e);
+        }
+    }
+
+    @VisibleForTesting
+    InstanceIdentifier<IdPool> buildIdPoolInstanceIdentifier(String poolName) {
+        InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idPoolBuilder =
+                InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
+        return idPoolBuilder.build();
+    }
+}
\ No newline at end of file

diff --git a/networkutils/networkutils/src/main/yang/network-config.yang b/networkutils/networkutils/src/main/yang/network-config.yang
index 3a33087c744cf14b0f443451bba5c29148aefcf8..36166467a5cae08d29f40cbcd4834f277310e2c4 100644 (file)
--- a/networkutils/networkutils/src/main/yang/network-config.yang
+++ b/networkutils/networkutils/src/main/yang/network-config.yang
@@ -17,5 +17,17 @@ module network-config {
             type string;
             default "70000:99999";
         }
+
+        leaf opendaylight-rd-start-value {
+            type         string;
+            description  "start value of auto generated RD";
+            default      "100:1";
+        }
+
+        leaf opendaylight-rd-count {
+            type         uint32;
+            description  "number of RD values to be autogenarated";
+            default      65535;
+        }
     }
 }

diff --git a/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTest.java b/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTest.java
index 026638537d0051aaa08214ff97007d59061489d9..a43513afa8da51fc197d49f3110b68ec74b85f82 100644 (file)
--- a/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTest.java
+++ b/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTest.java
@@ -18,6 +18,7 @@ import org.opendaylight.controller.md.sal.binding.test.AbstractConcurrentDataBro
 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
 import org.opendaylight.genius.datastoreutils.testutils.JobCoordinatorTestModule;
 import org.opendaylight.genius.mdsalutil.NwConstants;
+import org.opendaylight.genius.networkutils.RDUtils;
 import org.opendaylight.genius.networkutils.VniUtils;
 import org.opendaylight.infrautils.inject.guice.testutils.GuiceRule;
 import org.opendaylight.infrautils.testutils.LogCaptureRule;
@@ -40,6 +41,7 @@ public class NetworkUtilTest extends AbstractConcurrentDataBrokerTest {
     public @Rule MethodRule guice = new GuiceRule(NetworkUtilTestModule.class, JobCoordinatorTestModule.class);
 
     private @Inject VniUtils vniUtils;
+    private @Inject RDUtils  rdUtils;
 
     @Test
     public void testDefaultVniPoolCreated() throws ReadFailedException {
@@ -51,4 +53,17 @@ public class NetworkUtilTest extends AbstractConcurrentDataBrokerTest {
     public void testGetVNI() throws ExecutionException, InterruptedException {
         assertThat(vniUtils.getVNI("test").longValue()).isEqualTo(NwConstants.VNI_DEFAULT_LOW_VALUE);
     }
+
+    @Test
+    public void testDefaultRDPoolCreated() throws ReadFailedException {
+        IdPool idPool = rdUtils.getRDPool().get();
+        assertThat(idPool.getPoolName()).isEqualTo(NwConstants.ODL_RD_POOL_NAME);
+    }
+
+    @Test
+    public void testGetRD() throws ExecutionException, InterruptedException {
+        assertThat(rdUtils.getRD("testRD").equals(NwConstants.RD_DEFAULT_LOW_VALUE));
+    }
+
+
 }

diff --git a/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTestModule.java b/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTestModule.java
index b953eaae5967b1572e69e6a185c786ff9dacd008..8053961a1be47c1a8f8529cad58b998cc083554e 100644 (file)
--- a/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTestModule.java
+++ b/networkutils/networkutils/src/test/java/org/opendaylight/genius/networkutils/test/NetworkUtilTestModule.java
@@ -14,7 +14,9 @@ import org.opendaylight.controller.md.sal.binding.test.DataBrokerTestModule;
 import org.opendaylight.daexim.DataImportBootReady;
 import org.opendaylight.genius.idmanager.IdManager;
 import org.opendaylight.genius.lockmanager.impl.LockManagerServiceImpl;
+import org.opendaylight.genius.networkutils.RDUtils;
 import org.opendaylight.genius.networkutils.VniUtils;
+import org.opendaylight.genius.networkutils.impl.RDUtilsImpl;
 import org.opendaylight.genius.networkutils.impl.VniUtilsImpl;
 import org.opendaylight.infrautils.inject.guice.testutils.AbstractGuiceJsr250Module;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
@@ -33,5 +35,6 @@ public class NetworkUtilTestModule extends AbstractGuiceJsr250Module {
         bind(DataImportBootReady.class).toInstance(new DataImportBootReady() {});
         bind(LockManagerService.class).to(LockManagerServiceImpl.class);
         bind(VniUtils.class).to(VniUtilsImpl.class);
+        bind(RDUtils.class).to(RDUtilsImpl.class);
     }
 }