[#1415] Moved address_range.h to ip_range.h

Author: msiodelski

src/lib/dhcpsrv/Makefile.am

@@ -63,7 +63,6 @@ CLEANFILES += *.csv
 
 lib_LTLIBRARIES = libkea-dhcpsrv.la
 libkea_dhcpsrv_la_SOURCES  =
-libkea_dhcpsrv_la_SOURCES += address_range.h address_range.cc
 libkea_dhcpsrv_la_SOURCES += address_range_permutation.h address_range_permutation.cc
 libkea_dhcpsrv_la_SOURCES += alloc_engine.cc alloc_engine.h
 libkea_dhcpsrv_la_SOURCES += alloc_engine_log.cc alloc_engine_log.h
@@ -115,6 +114,7 @@ libkea_dhcpsrv_la_SOURCES += host_data_source_factory.cc host_data_source_factor
 libkea_dhcpsrv_la_SOURCES += host_mgr.cc host_mgr.h
 libkea_dhcpsrv_la_SOURCES += hosts_log.cc hosts_log.h
 libkea_dhcpsrv_la_SOURCES += hosts_messages.h hosts_messages.cc
+libkea_dhcpsrv_la_SOURCES += ip_range.h ip_range.cc
 libkea_dhcpsrv_la_SOURCES += key_from_key.h
 libkea_dhcpsrv_la_SOURCES += lease.cc lease.h
 libkea_dhcpsrv_la_SOURCES += lease_file_loader.h
@@ -300,7 +300,6 @@ EXTRA_DIST += database_backends.dox libdhcpsrv.dox
 # Specify the headers for copying into the installation directory tree.
 libkea_dhcpsrv_includedir = $(pkgincludedir)/dhcpsrv
 libkea_dhcpsrv_include_HEADERS = \
-	address_range.h \
 	address_range_permutation.h \
 	alloc_engine.h \
 	alloc_engine_log.h \
@@ -352,6 +351,7 @@ libkea_dhcpsrv_include_HEADERS = \
 	hosts_messages.h \
 	host_mgr.h \
 	hosts_log.h \
+	ip_range.h \
 	key_from_key.h \
 	lease.h \
 	lease_file_loader.h \

src/lib/dhcpsrv/address_range.h

@@ -8,7 +8,7 @@
 #define ADDRESS_RANGE_PERMUTATION_H
 
 #include <asiolink/io_address.h>
-#include <dhcpsrv/address_range.h>
+#include <dhcpsrv/ip_range.h>
 
 #include <boost/shared_ptr.hpp>
 

src/lib/dhcpsrv/address_range_permutation.h

@@ -8,7 +8,7 @@
 #define FREE_LEASE_QUEUE_H
 
 #include <asiolink/io_address.h>
-#include <dhcpsrv/address_range.h>
+#include <dhcpsrv/ip_range.h>
 #include <exceptions/exceptions.h>
 
 #include <boost/multi_index_container.hpp>

src/lib/dhcpsrv/free_lease_queue.h

@@ -7,7 +7,7 @@
 #include <config.h>
 #include <asiolink/addr_utilities.h>
 #include <asiolink/io_address.h>
-#include <dhcpsrv/address_range.h>
+#include <dhcpsrv/ip_range.h>
 #include <exceptions/exceptions.h>
 
 using namespace isc::asiolink;

src/lib/dhcpsrv/address_range.cc renamed to src/lib/dhcpsrv/ip_range.cc

@@ -0,0 +1,64 @@
+// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#ifndef IP_RANGE_H
+#define IP_RANGE_H
+
+#include <asiolink/io_address.h>
+
+namespace isc {
+namespace dhcp {
+
+/// @brief Structure representing IP address range.
+struct AddressRange {
+    /// IP address denoting the start of the address range.
+    asiolink::IOAddress start_;
+    /// IP address denoting the end of the address range.
+    asiolink::IOAddress end_;
+
+    /// @brief Constructor.
+    ///
+    /// @param start beginning of the address range.
+    /// @param end end of the address range.
+    /// @throw BadValue if the @c start is greater than the end or
+    /// specified boundaries do not belong to the same family.
+    AddressRange(const asiolink::IOAddress& start, const asiolink::IOAddress& end);
+};
+
+/// @brief Structure representing delegated prefix range.
+struct PrefixRange {
+    /// IP address denoting the start of the prefix range.
+    asiolink::IOAddress start_;
+    /// IP address denoting the first address within the last prefix
+    /// in the prefix range.
+    asiolink::IOAddress end_;
+    /// Delegated prefix length.
+    uint8_t delegated_length_;
+
+    /// @brief Constructor.
+    ///
+    /// @param prefix prefix from which prefixes are delegated.
+    /// @param length length of the prefix from which prefixes are delegated.
+    /// @param delegated delegated prefix length.
+    /// @throw BadValue if the values provided to the constructor are invalid,
+    /// e.g. it is not IPv6 prefix, delegated length is lower than prefix length
+    /// etc.
+    PrefixRange(const asiolink::IOAddress& prefix, const uint8_t length, const uint8_t delegated);
+
+    /// @brief Constructor.
+    ///
+    /// @param start beginning of the prefix range.
+    /// @param end end of the prefix range.
+    /// @throw BadValue if the values provided to the constructor are invalid,
+    /// e.g. it is not IPv6 prefix.
+    PrefixRange(const asiolink::IOAddress& start, const asiolink::IOAddress& end,
+                const uint8_t delegated);
+};
+
+} // end of namespace isc::dhcp
+} // end of namespace isc
+
+#endif // IP_RANGE_H

src/lib/dhcpsrv/ip_range.h

@@ -57,7 +57,6 @@ libco3_la_LDFLAGS = -avoid-version -export-dynamic -module -rpath /nowhere
 TESTS += libdhcpsrv_unittests
 
 libdhcpsrv_unittests_SOURCES  = run_unittests.cc
-libdhcpsrv_unittests_SOURCES += address_range_unittest.cc
 libdhcpsrv_unittests_SOURCES += address_range_permutation_unittest.cc
 libdhcpsrv_unittests_SOURCES += alloc_engine_utils.cc alloc_engine_utils.h
 libdhcpsrv_unittests_SOURCES += alloc_engine_expiration_unittest.cc
@@ -100,6 +99,7 @@ libdhcpsrv_unittests_SOURCES += host_unittest.cc
 libdhcpsrv_unittests_SOURCES += host_reservation_parser_unittest.cc
 libdhcpsrv_unittests_SOURCES += host_reservations_list_parser_unittest.cc
 libdhcpsrv_unittests_SOURCES += ifaces_config_parser_unittest.cc
+libdhcpsrv_unittests_SOURCES += ip_range_unittest.cc
 libdhcpsrv_unittests_SOURCES += lease_file_loader_unittest.cc
 libdhcpsrv_unittests_SOURCES += lease_unittest.cc
 libdhcpsrv_unittests_SOURCES += lease_mgr_factory_unittest.cc

src/lib/dhcpsrv/tests/Makefile.am

@@ -5,7 +5,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 #include <config.h>
-#include <dhcpsrv/address_range.h>
+#include <dhcpsrv/ip_range.h>
 #include <boost/scoped_ptr.hpp>
 #include <gtest/gtest.h>