Renaming DHCP* to Dhcp* to follow ONOS conventions.
Change-Id: I36cfbe5b57e342af2e436e31374f1a1f49633e78
diff --git a/apps/dhcp/src/main/java/org/onosproject/dhcp/impl/DistributedDhcpStore.java b/apps/dhcp/src/main/java/org/onosproject/dhcp/impl/DistributedDhcpStore.java
new file mode 100644
index 0000000..6e29216
--- /dev/null
+++ b/apps/dhcp/src/main/java/org/onosproject/dhcp/impl/DistributedDhcpStore.java
@@ -0,0 +1,324 @@
+/*
+ * Copyright 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.dhcp.impl;
+
+import com.google.common.collect.ImmutableSet;
+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.jboss.netty.util.Timeout;
+import org.jboss.netty.util.TimerTask;
+import org.onlab.packet.Ip4Address;
+import org.onlab.packet.MacAddress;
+import org.onlab.util.KryoNamespace;
+import org.onlab.util.Timer;
+import org.onosproject.dhcp.DhcpStore;
+import org.onosproject.dhcp.IpAssignment;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.ConsistentMap;
+import org.onosproject.store.service.DistributedSet;
+import org.onosproject.store.service.Serializer;
+import org.onosproject.store.service.StorageService;
+import org.onosproject.store.service.Versioned;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Manages the pool of available IP Addresses in the network and
+ * Remembers the mapping between MAC ID and IP Addresses assigned.
+ */
+
+@Component(immediate = true)
+@Service
+public class DistributedDhcpStore implements DhcpStore {
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected StorageService storageService;
+
+ private ConsistentMap<MacAddress, IpAssignment> allocationMap;
+
+ private DistributedSet<Ip4Address> freeIPPool;
+
+ private Timeout timeout;
+
+ private static Ip4Address startIPRange;
+
+ private static Ip4Address endIPRange;
+
+ // Hardcoded values are default values.
+
+ private static int timerDelay = 2;
+
+ private static int timeoutForPendingAssignments = 60;
+
+ @Activate
+ protected void activate() {
+ allocationMap = storageService.<MacAddress, IpAssignment>consistentMapBuilder()
+ .withName("onos-dhcp-assignedIP")
+ .withSerializer(Serializer.using(
+ new KryoNamespace.Builder()
+ .register(KryoNamespaces.API)
+ .register(IpAssignment.class,
+ IpAssignment.AssignmentStatus.class,
+ Date.class,
+ long.class,
+ Ip4Address.class)
+ .build()))
+ .build();
+
+ freeIPPool = storageService.<Ip4Address>setBuilder()
+ .withName("onos-dhcp-freeIP")
+ .withSerializer(Serializer.using(KryoNamespaces.API))
+ .build();
+
+ timeout = Timer.getTimer().newTimeout(new PurgeListTask(), timerDelay, TimeUnit.MINUTES);
+
+ log.info("Started");
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ timeout.cancel();
+ log.info("Stopped");
+ }
+
+ @Override
+ public Ip4Address suggestIP(MacAddress macID, Ip4Address requestedIP) {
+
+ IpAssignment assignmentInfo;
+ if (allocationMap.containsKey(macID)) {
+ assignmentInfo = allocationMap.get(macID).value();
+ IpAssignment.AssignmentStatus status = assignmentInfo.assignmentStatus();
+ Ip4Address ipAddr = assignmentInfo.ipAddress();
+
+ if (status == IpAssignment.AssignmentStatus.Option_Assigned ||
+ status == IpAssignment.AssignmentStatus.Option_Requested) {
+ // Client has a currently Active Binding.
+ if ((ipAddr.toInt() > startIPRange.toInt()) && (ipAddr.toInt() < endIPRange.toInt())) {
+ return ipAddr;
+ }
+
+ } else if (status == IpAssignment.AssignmentStatus.Option_Expired) {
+ // Client has a Released or Expired Binding.
+ if (freeIPPool.contains(ipAddr)) {
+ assignmentInfo = IpAssignment.builder()
+ .ipAddress(ipAddr)
+ .timestamp(new Date())
+ .leasePeriod(timeoutForPendingAssignments)
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Requested)
+ .build();
+ if (freeIPPool.remove(ipAddr)) {
+ allocationMap.put(macID, assignmentInfo);
+ return ipAddr;
+ }
+ }
+ }
+ return assignmentInfo.ipAddress();
+
+ } else if (requestedIP.toInt() != 0) {
+ // Client has requested an IP.
+ if (freeIPPool.contains(requestedIP)) {
+ assignmentInfo = IpAssignment.builder()
+ .ipAddress(requestedIP)
+ .timestamp(new Date())
+ .leasePeriod(timeoutForPendingAssignments)
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Requested)
+ .build();
+ if (freeIPPool.remove(requestedIP)) {
+ allocationMap.put(macID, assignmentInfo);
+ return requestedIP;
+ }
+ }
+ }
+
+ // Allocate a new IP from the server's pool of available IP.
+ Ip4Address nextIPAddr = fetchNextIP();
+ assignmentInfo = IpAssignment.builder()
+ .ipAddress(nextIPAddr)
+ .timestamp(new Date())
+ .leasePeriod(timeoutForPendingAssignments)
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Requested)
+ .build();
+
+ allocationMap.put(macID, assignmentInfo);
+ return nextIPAddr;
+
+ }
+
+ @Override
+ public boolean assignIP(MacAddress macID, Ip4Address ipAddr, int leaseTime) {
+
+ IpAssignment assignmentInfo;
+ if (allocationMap.containsKey(macID)) {
+ assignmentInfo = allocationMap.get(macID).value();
+ if ((assignmentInfo.ipAddress().toInt() == ipAddr.toInt()) &&
+ (ipAddr.toInt() > startIPRange.toInt()) && (ipAddr.toInt() < endIPRange.toInt())) {
+
+ assignmentInfo = IpAssignment.builder()
+ .ipAddress(ipAddr)
+ .timestamp(new Date())
+ .leasePeriod(leaseTime)
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Assigned)
+ .build();
+ allocationMap.put(macID, assignmentInfo);
+ return true;
+ }
+ } else if (freeIPPool.contains(ipAddr)) {
+ assignmentInfo = IpAssignment.builder()
+ .ipAddress(ipAddr)
+ .timestamp(new Date())
+ .leasePeriod(leaseTime)
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Assigned)
+ .build();
+ if (freeIPPool.remove(ipAddr)) {
+ allocationMap.put(macID, assignmentInfo);
+ return true;
+ }
+ }
+ return false;
+ }
+
+ @Override
+ public void releaseIP(MacAddress macID) {
+ if (allocationMap.containsKey(macID)) {
+ IpAssignment newAssignment = IpAssignment.builder(allocationMap.get(macID).value())
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Expired)
+ .build();
+ Ip4Address freeIP = newAssignment.ipAddress();
+ allocationMap.put(macID, newAssignment);
+ freeIPPool.add(freeIP);
+ }
+ }
+
+ @Override
+ public void setDefaultTimeoutForPurge(int timeInSeconds) {
+ timeoutForPendingAssignments = timeInSeconds;
+ }
+
+ @Override
+ public void setTimerDelay(int timeInSeconds) {
+ timerDelay = timeInSeconds;
+ }
+
+ @Override
+ public Map<MacAddress, IpAssignment> listMapping() {
+
+ Map<MacAddress, IpAssignment> allMapping = new HashMap<>();
+ for (Map.Entry<MacAddress, Versioned<IpAssignment>> entry: allocationMap.entrySet()) {
+ IpAssignment assignment = entry.getValue().value();
+ if (assignment.assignmentStatus() == IpAssignment.AssignmentStatus.Option_Assigned) {
+ allMapping.put(entry.getKey(), assignment);
+ }
+ }
+ return allMapping;
+
+ }
+
+ @Override
+ public boolean assignStaticIP(MacAddress macID, Ip4Address ipAddr) {
+ return assignIP(macID, ipAddr, -1);
+ }
+
+ @Override
+ public boolean removeStaticIP(MacAddress macID) {
+ if (allocationMap.containsKey(macID)) {
+ IpAssignment assignment = allocationMap.get(macID).value();
+ Ip4Address freeIP = assignment.ipAddress();
+ if (assignment.leasePeriod() < 0) {
+ allocationMap.remove(macID);
+ freeIPPool.add(freeIP);
+ return true;
+ }
+ }
+ return false;
+ }
+
+ @Override
+ public Iterable<Ip4Address> getAvailableIPs() {
+ return ImmutableSet.<Ip4Address>copyOf(freeIPPool);
+ }
+
+ @Override
+ public void populateIPPoolfromRange(Ip4Address startIP, Ip4Address endIP) {
+ // Clear all entries from previous range.
+ startIPRange = startIP;
+ endIPRange = endIP;
+ freeIPPool.clear();
+
+ int lastIP = endIP.toInt();
+ Ip4Address nextIP;
+ for (int loopCounter = startIP.toInt(); loopCounter <= lastIP; loopCounter++) {
+ nextIP = Ip4Address.valueOf(loopCounter);
+ freeIPPool.add(nextIP);
+ }
+ }
+
+ /**
+ * Fetches the next available IP from the free pool pf IPs.
+ *
+ * @return the next available IP address
+ */
+ private Ip4Address fetchNextIP() {
+ for (Ip4Address freeIP : freeIPPool) {
+ if (freeIPPool.remove(freeIP)) {
+ return freeIP;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Purges the IP allocation map to remove expired entries and returns the freed IPs to the free pool.
+ */
+ private class PurgeListTask implements TimerTask {
+
+ @Override
+ public void run(Timeout to) {
+ IpAssignment ipAssignment, newAssignment;
+ Date dateNow = new Date();
+ for (Map.Entry<MacAddress, Versioned<IpAssignment>> entry: allocationMap.entrySet()) {
+ ipAssignment = entry.getValue().value();
+ long timeLapsed = dateNow.getTime() - ipAssignment.timestamp().getTime();
+ if ((ipAssignment.assignmentStatus() != IpAssignment.AssignmentStatus.Option_Expired) &&
+ (ipAssignment.leasePeriod() > 0) && (timeLapsed > (ipAssignment.leasePeriod()))) {
+ Ip4Address freeIP = ipAssignment.ipAddress();
+
+ newAssignment = IpAssignment.builder(ipAssignment)
+ .assignmentStatus(IpAssignment.AssignmentStatus.Option_Expired)
+ .build();
+ allocationMap.put(entry.getKey(), newAssignment);
+
+ if ((freeIP.toInt() > startIPRange.toInt()) && (freeIP.toInt() < endIPRange.toInt())) {
+ freeIPPool.add(freeIP);
+ }
+ }
+ }
+ timeout = Timer.getTimer().newTimeout(new PurgeListTask(), timerDelay, TimeUnit.MINUTES);
+ }
+
+ }
+
+}