22#include <boost/foreach.hpp>
39const char* KEA_LFC_EXECUTABLE_ENV_NAME =
"KEA_LFC_EXECUTABLE";
94 void setup(
const uint32_t lfc_interval,
95 const boost::shared_ptr<CSVLeaseFile4>& lease_file4,
96 const boost::shared_ptr<CSVLeaseFile6>& lease_file6,
97 bool run_once_now =
false);
114 boost::scoped_ptr<ProcessSpawn> process_;
130 : process_(), callback_(callback), pid_(0),
146 timer_mgr_->unregisterTimer(
"memfile-lfc");
148 }
catch (
const std::exception& ex) {
159 const boost::shared_ptr<CSVLeaseFile4>& lease_file4,
160 const boost::shared_ptr<CSVLeaseFile6>& lease_file6,
164 if (lfc_interval == 0 && !run_once_now) {
169 std::string executable;
170 char* c_executable = getenv(KEA_LFC_EXECUTABLE_ENV_NAME);
172 executable = KEA_LFC_EXECUTABLE;
174 executable = c_executable;
178 std::string lease_file = lease_file4 ? lease_file4->getFilename() :
179 lease_file6->getFilename();
184 args.push_back(lease_file4 ?
"-4" :
"-6");
187 args.push_back(
"-x");
191 args.push_back(
"-i");
195 args.push_back(
"-o");
199 args.push_back(
"-f");
203 args.push_back(
"-p");
208 args.push_back(
"-c");
209 args.push_back(
"ignored-path");
221 if (lfc_interval > 0) {
228 timer_mgr_->registerTimer(
"memfile-lfc", callback_, lfc_interval * 1000,
230 timer_mgr_->setup(
"memfile-lfc");
238 .arg(process_->getCommandLine());
239 pid_ = process_->spawn();
248 return (process_ && process_->isRunning(pid_));
255 " the process is null");
257 return (process_->getExitStatus(pid_));
316 return (
rows_.size());
412 void startSubnets() {
417 Lease4StorageSubnetIdIndex::const_iterator lower;
418 Lease4StorageSubnetIdIndex::const_iterator upper;
441 if (lower == upper) {
449 int64_t assigned = 0;
450 int64_t declined = 0;
451 for (Lease4StorageSubnetIdIndex::const_iterator lease = lower;
452 lease != upper; ++lease) {
455 if ((*lease)->subnet_id_ != cur_id) {
458 rows_.push_back(LeaseStatsRow(cur_id,
465 rows_.push_back(LeaseStatsRow(cur_id,
473 cur_id = (*lease)->subnet_id_;
513 void startSubnetPools() {
515 = storage4_.get<SubnetIdPoolIdIndexTag>();
518 Lease4StorageSubnetIdPoolIdIndex::const_iterator lower;
519 Lease4StorageSubnetIdPoolIdIndex::const_iterator upper;
531 if (lower == upper) {
539 uint32_t cur_pool_id = 0;
540 int64_t assigned = 0;
541 int64_t declined = 0;
542 for (Lease4StorageSubnetIdPoolIdIndex::const_iterator lease = lower;
543 lease != upper; ++lease) {
546 if ((*lease)->pool_id_ != cur_pool_id) {
548 rows_.push_back(LeaseStatsRow(cur_id,
550 assigned, cur_pool_id));
555 rows_.push_back(LeaseStatsRow(cur_id,
557 declined, cur_pool_id));
562 cur_pool_id = (*lease)->pool_id_;
567 if ((*lease)->subnet_id_ != cur_id) {
570 rows_.push_back(LeaseStatsRow(cur_id,
572 assigned, cur_pool_id));
577 rows_.push_back(LeaseStatsRow(cur_id,
579 declined, cur_pool_id));
585 cur_id = (*lease)->subnet_id_;
602 assigned, cur_pool_id));
607 declined, cur_pool_id));
706 virtual void startSubnets() {
711 Lease6StorageSubnetIdIndex::const_iterator lower;
712 Lease6StorageSubnetIdIndex::const_iterator upper;
734 if (lower == upper) {
742 int64_t assigned = 0;
743 int64_t declined = 0;
744 int64_t assigned_pds = 0;
745 int64_t registered = 0;
746 for (Lease6StorageSubnetIdIndex::const_iterator lease = lower;
747 lease != upper; ++lease) {
750 if ((*lease)->subnet_id_ != cur_id) {
766 if (assigned_pds > 0) {
773 if (registered > 0) {
782 cur_id = (*lease)->subnet_id_;
787 switch((*lease)->type_) {
821 if (assigned_pds > 0) {
826 if (registered > 0) {
849 virtual void startSubnetPools() {
851 = storage6_.get<SubnetIdPoolIdIndexTag>();
854 Lease6StorageSubnetIdPoolIdIndex::const_iterator lower;
855 Lease6StorageSubnetIdPoolIdIndex::const_iterator upper;
867 if (lower == upper) {
875 uint32_t cur_pool_id = 0;
876 int64_t assigned = 0;
877 int64_t declined = 0;
878 int64_t assigned_pds = 0;
879 for (Lease6StorageSubnetIdPoolIdIndex::const_iterator lease = lower;
880 lease != upper; ++lease) {
883 if ((*lease)->pool_id_ != cur_pool_id) {
887 assigned, cur_pool_id));
894 declined, cur_pool_id));
898 if (assigned_pds > 0) {
901 assigned_pds, cur_pool_id));
906 cur_pool_id = (*lease)->pool_id_;
911 if ((*lease)->subnet_id_ != cur_id) {
916 assigned, cur_pool_id));
923 declined, cur_pool_id));
927 if (assigned_pds > 0) {
930 assigned_pds, cur_pool_id));
936 cur_id = (*lease)->subnet_id_;
944 switch((*lease)->type_) {
975 if (assigned_pds > 0) {
997 :
TrackingLeaseMgr(), lfc_setup_(), conn_(parameters), mutex_(new std::mutex) {
998 bool conversion_needed =
false;
1005 if (universe ==
"4") {
1006 std::string file4 = initLeaseFilePath(
V4);
1007 if (!file4.empty()) {
1008 conversion_needed = loadLeasesFromFiles<
Lease4,
1015 std::string file6 = initLeaseFilePath(
V6);
1016 if (!file6.empty()) {
1017 conversion_needed = loadLeasesFromFiles<
Lease6,
1032 if (conversion_needed) {
1037 lfcSetup(conversion_needed);
1054 std::stringstream tmp;
1055 tmp <<
"Memfile backend ";
1058 }
else if (u ==
V6) {
1067 if (family == AF_INET6) {
1075Memfile_LeaseMgr::addLeaseInternal(
const Lease4Ptr& lease) {
1076 if (getLease4Internal(lease->addr_)) {
1088 storage4_.insert(lease);
1092 lease->updateCurrentExpirationTime();
1095 class_lease_counter_.
addLease(lease);
1111 std::lock_guard<std::mutex> lock(*mutex_);
1112 return (addLeaseInternal(lease));
1114 return (addLeaseInternal(lease));
1119Memfile_LeaseMgr::addLeaseInternal(
const Lease6Ptr& lease) {
1120 if (getLease6Internal(lease->type_, lease->addr_)) {
1133 storage6_.insert(lease);
1137 lease->updateCurrentExpirationTime();
1140 class_lease_counter_.
addLease(lease);
1160 std::lock_guard<std::mutex> lock(*mutex_);
1161 return (addLeaseInternal(lease));
1163 return (addLeaseInternal(lease));
1170 Lease4StorageAddressIndex::iterator l = idx.find(addr);
1171 if (l == idx.end()) {
1184 std::lock_guard<std::mutex> lock(*mutex_);
1185 return (getLease4Internal(addr));
1187 return (getLease4Internal(addr));
1192Memfile_LeaseMgr::getLease4Internal(
const HWAddr& hwaddr,
1198 std::pair<Lease4StorageHWAddressSubnetIdIndex::const_iterator,
1199 Lease4StorageHWAddressSubnetIdIndex::const_iterator> l
1200 = idx.equal_range(boost::make_tuple(hwaddr.
hwaddr_));
1202 BOOST_FOREACH(
auto const& lease, l) {
1214 std::lock_guard<std::mutex> lock(*mutex_);
1215 getLease4Internal(hwaddr, collection);
1217 getLease4Internal(hwaddr, collection);
1220 return (collection);
1224Memfile_LeaseMgr::getLease4Internal(
const HWAddr& hwaddr,
1230 Lease4StorageHWAddressSubnetIdIndex::const_iterator lease =
1231 idx.find(boost::make_tuple(hwaddr.
hwaddr_, subnet_id));
1233 if (lease == idx.end()) {
1238 return (
Lease4Ptr(
new Lease4(**lease)));
1249 std::lock_guard<std::mutex> lock(*mutex_);
1250 return (getLease4Internal(hwaddr, subnet_id));
1252 return (getLease4Internal(hwaddr, subnet_id));
1257Memfile_LeaseMgr::getLease4Internal(
const ClientId& client_id,
1263 std::pair<Lease4StorageClientIdSubnetIdIndex::const_iterator,
1264 Lease4StorageClientIdSubnetIdIndex::const_iterator> l
1265 = idx.equal_range(boost::make_tuple(client_id.
getClientId()));
1267 BOOST_FOREACH(
auto const& lease, l) {
1279 std::lock_guard<std::mutex> lock(*mutex_);
1280 getLease4Internal(client_id, collection);
1282 getLease4Internal(client_id, collection);
1285 return (collection);
1289Memfile_LeaseMgr::getLease4Internal(
const ClientId& client_id,
1295 Lease4StorageClientIdSubnetIdIndex::const_iterator lease =
1296 idx.find(boost::make_tuple(client_id.
getClientId(), subnet_id));
1298 if (lease == idx.end()) {
1302 return (
Lease4Ptr(
new Lease4(**lease)));
1310 .arg(client_id.
toText());
1313 std::lock_guard<std::mutex> lock(*mutex_);
1314 return (getLease4Internal(client_id, subnet_id));
1316 return (getLease4Internal(client_id, subnet_id));
1321Memfile_LeaseMgr::getLeases4Internal(
SubnetID subnet_id,
1324 std::pair<Lease4StorageSubnetIdIndex::const_iterator,
1325 Lease4StorageSubnetIdIndex::const_iterator> l =
1326 idx.equal_range(subnet_id);
1328 BOOST_FOREACH(
auto const& lease, l) {
1340 std::lock_guard<std::mutex> lock(*mutex_);
1341 getLeases4Internal(subnet_id, collection);
1343 getLeases4Internal(subnet_id, collection);
1346 return (collection);
1350Memfile_LeaseMgr::getLeases4Internal(
const std::string& hostname,
1353 std::pair<Lease4StorageHostnameIndex::const_iterator,
1354 Lease4StorageHostnameIndex::const_iterator> l =
1355 idx.equal_range(hostname);
1357 BOOST_FOREACH(
auto const& lease, l) {
1369 std::lock_guard<std::mutex> lock(*mutex_);
1370 getLeases4Internal(hostname, collection);
1372 getLeases4Internal(hostname, collection);
1375 return (collection);
1380 for (
auto const& lease : storage4_) {
1391 std::lock_guard<std::mutex> lock(*mutex_);
1392 getLeases4Internal(collection);
1394 getLeases4Internal(collection);
1397 return (collection);
1405 Lease4StorageAddressIndex::const_iterator lb = idx.lower_bound(lower_bound_address);
1408 if ((lb != idx.end()) && ((*lb)->addr_ == lower_bound_address)) {
1413 for (
auto lease = lb;
1414 (lease != idx.end()) && (std::distance(lb, lease) < page_size.
page_size_);
1416 collection.push_back(
Lease4Ptr(
new Lease4(**lease)));
1424 if (!lower_bound_address.
isV4()) {
1426 "retrieving leases from the lease database, got "
1427 << lower_bound_address);
1432 .arg(lower_bound_address.
toText());
1436 std::lock_guard<std::mutex> lock(*mutex_);
1437 getLeases4Internal(lower_bound_address, page_size, collection);
1439 getLeases4Internal(lower_bound_address, page_size, collection);
1442 return (collection);
1446Memfile_LeaseMgr::getLease6Internal(
Lease::Type type,
1448 Lease6Storage::iterator l = storage6_.find(addr);
1449 if (l == storage6_.end() || !(*l) || ((*l)->type_ != type)) {
1458 Lease6Storage::iterator l = storage6_.find(addr);
1459 if (l == storage6_.end() || !(*l)) {
1475 std::lock_guard<std::mutex> lock(*mutex_);
1476 return (getLease6Internal(type, addr));
1478 return (getLease6Internal(type, addr));
1483Memfile_LeaseMgr::getLeases6Internal(
Lease::Type type,
1490 std::pair<Lease6StorageDuidIaidTypeIndex::const_iterator,
1491 Lease6StorageDuidIaidTypeIndex::const_iterator> l =
1492 idx.equal_range(boost::make_tuple(duid.
getDuid(), iaid, type));
1494 for (Lease6StorageDuidIaidTypeIndex::const_iterator lease =
1495 l.first; lease != l.second; ++lease) {
1503 uint32_t iaid)
const {
1512 std::lock_guard<std::mutex> lock(*mutex_);
1513 getLeases6Internal(type, duid, iaid, collection);
1515 getLeases6Internal(type, duid, iaid, collection);
1518 return (collection);
1522Memfile_LeaseMgr::getLeases6Internal(
Lease::Type type,
1530 std::pair<Lease6StorageDuidIaidTypeIndex::const_iterator,
1531 Lease6StorageDuidIaidTypeIndex::const_iterator> l =
1532 idx.equal_range(boost::make_tuple(duid.
getDuid(), iaid, type));
1534 for (Lease6StorageDuidIaidTypeIndex::const_iterator lease =
1535 l.first; lease != l.second; ++lease) {
1537 if ((*lease)->subnet_id_ == subnet_id) {
1557 std::lock_guard<std::mutex> lock(*mutex_);
1558 getLeases6Internal(type, duid, iaid, subnet_id, collection);
1560 getLeases6Internal(type, duid, iaid, subnet_id, collection);
1563 return (collection);
1567Memfile_LeaseMgr::getLeases6Internal(
SubnetID subnet_id,
1570 std::pair<Lease6StorageSubnetIdIndex::const_iterator,
1571 Lease6StorageSubnetIdIndex::const_iterator> l =
1572 idx.equal_range(subnet_id);
1574 BOOST_FOREACH(
auto const& lease, l) {
1586 std::lock_guard<std::mutex> lock(*mutex_);
1587 getLeases6Internal(subnet_id, collection);
1589 getLeases6Internal(subnet_id, collection);
1592 return (collection);
1596Memfile_LeaseMgr::getLeases6Internal(
const std::string& hostname,
1599 std::pair<Lease6StorageHostnameIndex::const_iterator,
1600 Lease6StorageHostnameIndex::const_iterator> l =
1601 idx.equal_range(hostname);
1603 BOOST_FOREACH(
auto const& lease, l) {
1615 std::lock_guard<std::mutex> lock(*mutex_);
1616 getLeases6Internal(hostname, collection);
1618 getLeases6Internal(hostname, collection);
1621 return (collection);
1626 for (
auto const& lease : storage6_) {
1637 std::lock_guard<std::mutex> lock(*mutex_);
1638 getLeases6Internal(collection);
1640 getLeases6Internal(collection);
1643 return (collection);
1647Memfile_LeaseMgr::getLeases6Internal(
const DUID& duid,
1650 std::pair<Lease6StorageDuidIndex::const_iterator,
1651 Lease6StorageDuidIndex::const_iterator> l =
1652 idx.equal_range(duid.
getDuid());
1654 BOOST_FOREACH(
auto const& lease, l) {
1666 std::lock_guard<std::mutex> lock(*mutex_);
1667 getLeases6Internal(duid, collection);
1669 getLeases6Internal(duid, collection);
1672 return (collection);
1680 Lease6StorageAddressIndex::const_iterator lb = idx.lower_bound(lower_bound_address);
1683 if ((lb != idx.end()) && ((*lb)->addr_ == lower_bound_address)) {
1688 for (
auto lease = lb;
1689 (lease != idx.end()) && (std::distance(lb, lease) < page_size.
page_size_);
1691 collection.push_back(
Lease6Ptr(
new Lease6(**lease)));
1699 if (!lower_bound_address.
isV6()) {
1701 "retrieving leases from the lease database, got "
1702 << lower_bound_address);
1707 .arg(lower_bound_address.
toText());
1711 std::lock_guard<std::mutex> lock(*mutex_);
1712 getLeases6Internal(lower_bound_address, page_size, collection);
1714 getLeases6Internal(lower_bound_address, page_size, collection);
1717 return (collection);
1721Memfile_LeaseMgr::getLeases6Internal(
SubnetID subnet_id,
1726 Lease6StorageSubnetIdIndex::const_iterator lb =
1727 idx.lower_bound(boost::make_tuple(subnet_id, lower_bound_address));
1730 if ((lb != idx.end()) && ((*lb)->addr_ == lower_bound_address)) {
1735 for (
auto it = lb; it != idx.end(); ++it) {
1736 if ((*it)->subnet_id_ != subnet_id) {
1740 collection.push_back(
Lease6Ptr(
new Lease6(**it)));
1741 if (collection.size() >= page_size.
page_size_) {
1745 return (collection);
1755 .arg(lower_bound_address.
toText())
1759 if (!lower_bound_address.
isV6()) {
1761 "retrieving leases from the lease database, got "
1762 << lower_bound_address);
1766 std::lock_guard<std::mutex> lock(*mutex_);
1767 return (getLeases6Internal(subnet_id,
1768 lower_bound_address,
1771 return (getLeases6Internal(subnet_id,
1772 lower_bound_address,
1778Memfile_LeaseMgr::getExpiredLeases4Internal(
Lease4Collection& expired_leases,
1779 const size_t max_leases)
const {
1787 Lease4StorageExpirationIndex::const_iterator ub =
1788 index.upper_bound(boost::make_tuple(
false, time(0)));
1791 for (Lease4StorageExpirationIndex::const_iterator lease = index.begin();
1792 (lease != ub) && ((max_leases == 0) || (std::distance(index.begin(), lease) <
1801 const size_t max_leases)
const {
1806 std::lock_guard<std::mutex> lock(*mutex_);
1807 getExpiredLeases4Internal(expired_leases, max_leases);
1809 getExpiredLeases4Internal(expired_leases, max_leases);
1814Memfile_LeaseMgr::getExpiredLeases6Internal(
Lease6Collection& expired_leases,
1815 const size_t max_leases)
const {
1823 Lease6StorageExpirationIndex::const_iterator ub =
1824 index.upper_bound(boost::make_tuple(
false, time(0)));
1827 for (Lease6StorageExpirationIndex::const_iterator lease = index.begin();
1828 (lease != ub) && ((max_leases == 0) || (std::distance(index.begin(), lease) <
1837 const size_t max_leases)
const {
1842 std::lock_guard<std::mutex> lock(*mutex_);
1843 getExpiredLeases6Internal(expired_leases, max_leases);
1845 getExpiredLeases6Internal(expired_leases, max_leases);
1850Memfile_LeaseMgr::updateLease4Internal(
const Lease4Ptr& lease) {
1857 Lease4StorageAddressIndex::const_iterator lease_it = index.find(lease->addr_);
1858 if (lease_it == index.end()) {
1860 << lease->addr_ <<
" - no such lease");
1861 }
else if ((!persist) && (((*lease_it)->cltt_ != lease->current_cltt_) ||
1862 ((*lease_it)->valid_lft_ != lease->current_valid_lft_))) {
1865 isc_throw(NoSuchLease,
"unable to update lease for address " <<
1866 lease->addr_.toText() <<
" either because the lease does not exist, "
1867 "it has been deleted or it has changed in the database.");
1878 lease->updateCurrentExpirationTime();
1885 index.replace(lease_it,
Lease4Ptr(
new Lease4(*lease)));
1888 class_lease_counter_.
updateLease(lease, old_lease);
1902 std::lock_guard<std::mutex> lock(*mutex_);
1903 updateLease4Internal(lease);
1905 updateLease4Internal(lease);
1910Memfile_LeaseMgr::updateLease6Internal(
const Lease6Ptr& lease) {
1921 Lease6StorageAddressIndex::const_iterator lease_it = index.find(lease->addr_);
1922 if (lease_it == index.end()) {
1924 << lease->addr_ <<
" - no such lease");
1925 }
else if ((!persist) && (((*lease_it)->cltt_ != lease->current_cltt_) ||
1926 ((*lease_it)->valid_lft_ != lease->current_valid_lft_))) {
1929 isc_throw(NoSuchLease,
"unable to update lease for address " <<
1930 lease->addr_.toText() <<
" either because the lease does not exist, "
1931 "it has been deleted or it has changed in the database.");
1942 lease->updateCurrentExpirationTime();
1949 index.replace(lease_it,
Lease6Ptr(
new Lease6(*lease)));
1952 class_lease_counter_.
updateLease(lease, old_lease);
1956 switch (recorded_action) {
1983 std::lock_guard<std::mutex> lock(*mutex_);
1984 updateLease6Internal(lease);
1986 updateLease6Internal(lease);
1991Memfile_LeaseMgr::deleteLeaseInternal(
const Lease4Ptr& lease) {
1993 Lease4Storage::iterator l = storage4_.find(addr);
1994 if (l == storage4_.end()) {
2001 Lease4 lease_copy = **l;
2004 lease_copy.valid_lft_ = 0;
2009 if (((*l)->cltt_ != lease->current_cltt_) ||
2010 ((*l)->valid_lft_ != lease->current_valid_lft_)) {
2035 std::lock_guard<std::mutex> lock(*mutex_);
2036 return (deleteLeaseInternal(lease));
2038 return (deleteLeaseInternal(lease));
2043Memfile_LeaseMgr::deleteLeaseInternal(
const Lease6Ptr& lease) {
2047 Lease6Storage::iterator l = storage6_.find(addr);
2048 if (l == storage6_.end()) {
2055 Lease6 lease_copy = **l;
2057 lease_copy.valid_lft_ = 0;
2058 lease_copy.preferred_lft_ = 0;
2063 if (((*l)->cltt_ != lease->current_cltt_) ||
2064 ((*l)->valid_lft_ != lease->current_valid_lft_)) {
2094 std::lock_guard<std::mutex> lock(*mutex_);
2095 return (deleteLeaseInternal(lease));
2097 return (deleteLeaseInternal(lease));
2108 std::lock_guard<std::mutex> lock(*mutex_);
2109 return (deleteExpiredReclaimedLeases<
2113 return (deleteExpiredReclaimedLeases<
2126 std::lock_guard<std::mutex> lock(*mutex_);
2127 return (deleteExpiredReclaimedLeases<
2131 return (deleteExpiredReclaimedLeases<
2137template<
typename IndexType,
typename LeaseType,
typename StorageType,
2138 typename LeaseFileType>
2140Memfile_LeaseMgr::deleteExpiredReclaimedLeases(
const uint32_t secs,
2141 const Universe& universe,
2142 StorageType& storage,
2143 LeaseFileType& lease_file) {
2145 IndexType& index = storage.template get<ExpirationIndexTag>();
2156 typename IndexType::const_iterator upper_limit =
2157 index.upper_bound(boost::make_tuple(
true, time(0) - secs));
2166 typename IndexType::const_iterator lower_limit =
2167 index.upper_bound(boost::make_tuple(
true, std::numeric_limits<int64_t>::min()));
2170 uint64_t num_leases =
static_cast<uint64_t
>(std::distance(lower_limit, upper_limit));
2171 if (num_leases > 0) {
2181 for (
typename IndexType::const_iterator lease = lower_limit;
2182 lease != upper_limit; ++lease) {
2184 LeaseType lease_copy(**lease);
2187 lease_copy.valid_lft_ = 0;
2188 lease_file->append(lease_copy);
2193 index.erase(lower_limit, upper_limit);
2197 return (num_leases);
2202 return (std::string(
"In memory database with leases stored in a CSV file."));
2205std::pair<uint32_t, uint32_t>
2207 std::string
const& universe(conn_.
getParameter(
"universe"));
2208 if (universe ==
"4") {
2210 }
else if (universe ==
"6") {
2230 std::string name(file_name);
2231 switch (file_type) {
2242 name +=
".completed";
2257 std::ostringstream s;
2259 s << (u ==
V4 ?
"4" :
"6");
2286Memfile_LeaseMgr::initLeaseFilePath(Universe u) {
2287 std::string persist_val;
2293 persist_val =
"true";
2297 if (persist_val ==
"false") {
2300 }
else if (persist_val !=
"true") {
2302 << persist_val <<
"'");
2305 std::string lease_file;
2311 return (lease_file);
2314template<
typename LeaseObjectType,
typename LeaseFileType,
typename StorageType>
2316Memfile_LeaseMgr::loadLeasesFromFiles(
const std::string& filename,
2317 boost::shared_ptr<LeaseFileType>& lease_file,
2318 StorageType& storage) {
2326 if (pid_file.check()) {
2328 "lease file cleanup is in progress");
2333 std::string max_row_errors_str =
"0";
2335 max_row_errors_str = conn_.
getParameter(
"max-row-errors");
2336 }
catch (
const std::exception&) {
2340 int64_t max_row_errors64;
2342 max_row_errors64 = boost::lexical_cast<int64_t>(max_row_errors_str);
2343 }
catch (
const boost::bad_lexical_cast&) {
2345 << max_row_errors_str <<
" specified");
2347 if ((max_row_errors64 < 0) ||
2348 (max_row_errors64 > std::numeric_limits<uint32_t>::max())) {
2350 << max_row_errors_str <<
" specified");
2352 uint32_t max_row_errors =
static_cast<uint32_t
>(max_row_errors64);
2355 bool conversion_needed =
false;
2356 lease_file.reset(
new LeaseFileType(std::string(filename +
".completed")));
2357 if (lease_file->exists()) {
2360 conversion_needed = conversion_needed || lease_file->needsConversion();
2365 if (lease_file->exists()) {
2368 conversion_needed = conversion_needed || lease_file->needsConversion();
2372 if (lease_file->exists()) {
2375 conversion_needed = conversion_needed || lease_file->needsConversion();
2385 lease_file.reset(
new LeaseFileType(filename));
2387 max_row_errors,
false);
2388 conversion_needed = conversion_needed || lease_file->needsConversion();
2390 return (conversion_needed);
2396 return (lfc_setup_->isRunning());
2401 return (lfc_setup_->getExitStatus());
2419Memfile_LeaseMgr::lfcSetup(
bool conversion_needed) {
2420 std::string lfc_interval_str =
"3600";
2423 }
catch (
const std::exception&) {
2427 uint32_t lfc_interval = 0;
2429 lfc_interval = boost::lexical_cast<uint32_t>(lfc_interval_str);
2430 }
catch (
const boost::bad_lexical_cast&) {
2432 << lfc_interval_str <<
" specified");
2435 if (lfc_interval > 0 || conversion_needed) {
2441template<
typename LeaseFileType>
2443Memfile_LeaseMgr::lfcExecute(boost::shared_ptr<LeaseFileType>& lease_file) {
2453 if (!lease_file_finish.exists() && !lease_file_copy.exists()) {
2455 lease_file->close();
2458 do_lfc = (rename(lease_file->getFilename().c_str(),
2459 lease_file_copy.getFilename().c_str()) == 0);
2463 .arg(lease_file->getFilename())
2464 .arg(lease_file_copy.getFilename())
2465 .arg(strerror(errno));
2474 lease_file->open(
true);
2487 .arg(lease_file->getFilename())
2498 lfc_setup_->execute();
2506 std::lock_guard<std::mutex> lock(*mutex_);
2519 std::lock_guard<std::mutex> lock(*mutex_);
2532 std::lock_guard<std::mutex> lock(*mutex_);
2547 std::lock_guard<std::mutex> lock(*mutex_);
2560 std::lock_guard<std::mutex> lock(*mutex_);
2573 std::lock_guard<std::mutex> lock(*mutex_);
2586 std::lock_guard<std::mutex> lock(*mutex_);
2601 std::lock_guard<std::mutex> lock(*mutex_);
2619 std::pair<Lease4StorageSubnetIdIndex::const_iterator,
2620 Lease4StorageSubnetIdIndex::const_iterator> r =
2621 idx.equal_range(subnet_id);
2625 BOOST_FOREACH(
auto const& lease, r) {
2626 leases.push_back(lease);
2629 size_t num = leases.size();
2630 for (
auto const& l : leases) {
2634 .arg(subnet_id).arg(num);
2648 std::pair<Lease6StorageSubnetIdIndex::const_iterator,
2649 Lease6StorageSubnetIdIndex::const_iterator> r =
2650 idx.equal_range(subnet_id);
2654 BOOST_FOREACH(
auto const& lease, r) {
2655 leases.push_back(lease);
2658 size_t num = leases.size();
2659 for (
auto const& l : leases) {
2663 .arg(subnet_id).arg(num);
2670 class_lease_counter_.
clear();
2671 for (
auto const& lease : storage4_) {
2674 class_lease_counter_.
addLease(lease);
2681 class_lease_counter_.
clear();
2682 for (
auto const& lease : storage6_) {
2685 class_lease_counter_.
addLease(lease);
2694 std::lock_guard<std::mutex> lock(*mutex_);
2695 return(class_lease_counter_.
getClassCount(client_class, ltype));
2697 return(class_lease_counter_.
getClassCount(client_class, ltype));
2703 return(class_lease_counter_.
clear());
2708 if (!user_context) {
2721 for (
int i = 0; i < classes->size(); ++i) {
2730 std::string name = name_elem->stringValue();
2741 size_t lease_count = 0;
2747 if (lease_count >= limit) {
2748 std::ostringstream ss;
2749 ss <<
"address limit " << limit <<
" for client class \""
2750 << name <<
"\", current lease count " << lease_count;
2766 SubnetID subnet_id = id_elem->intValue();
2773 int64_t lease_count = 0;
2775 lease_count = getSubnetStat(subnet_id,
"assigned-addresses");
2779 if (lease_count >= limit) {
2780 std::ostringstream ss;
2781 ss <<
"address limit " << limit <<
" for subnet ID " << subnet_id
2782 <<
", current lease count " << lease_count;
2794 if (!user_context) {
2808 for (
int i = 0; i < classes->size(); ++i) {
2817 std::string name = name_elem->stringValue();
2822 if (!getLeaseLimit(class_elem, ltype, limit)) {
2824 if (!getLeaseLimit(class_elem, ltype, limit)) {
2832 size_t lease_count = 0;
2838 if (lease_count >= limit) {
2839 std::ostringstream ss;
2841 <<
" limit " << limit <<
" for client class \""
2842 << name <<
"\", current lease count " << lease_count;
2858 SubnetID subnet_id = id_elem->intValue();
2863 if (!getLeaseLimit(subnet_elem, ltype, limit)) {
2865 if (!getLeaseLimit(subnet_elem, ltype, limit)) {
2873 int64_t lease_count = 0;
2875 lease_count = getSubnetStat(subnet_id, (ltype ==
Lease::TYPE_NA ?
2876 "assigned-nas" :
"assigned-pds"));
2880 if (lease_count >= limit) {
2881 std::ostringstream ss;
2883 <<
" limit " << limit <<
" for subnet ID " << subnet_id
2884 <<
", current lease count " << lease_count;
2899Memfile_LeaseMgr::getSubnetStat(
const SubnetID& subnet_id,
const std::string& stat_label)
const {
2905 if (samples && samples->size()) {
2906 auto sample = samples->get(0);
2907 if (sample->size()) {
2908 auto count_elem = sample->get(0);
2909 return (count_elem->intValue());
2919 "prefix-limit" :
"address-limit");
2921 limit = limit_elem->intValue();
2932 std::stringstream tmp;
2935 for (
auto const& it :
id) {
2939 tmp << std::setw(2) << std::setfill(
'0')
2940 <<
static_cast<unsigned int>(it);
2952 const time_t& qry_start_time ,
2953 const time_t& qry_end_time ) {
2957 .arg(lower_bound_address.
toText())
2958 .arg(idToText(relay_id))
2959 .arg(qry_start_time)
2963 if (!lower_bound_address.
isV4()) {
2965 "retrieving leases from the lease database, got "
2966 << lower_bound_address);
2970 if ((qry_start_time < 0) || (qry_end_time < 0)) {
2975 if ((qry_start_time > 0) && (qry_end_time > 0) &&
2976 (qry_start_time > qry_end_time)) {
2981 std::lock_guard<std::mutex> lock(*mutex_);
2982 return (getLeases4ByRelayIdInternal(relay_id,
2983 lower_bound_address,
2988 return (getLeases4ByRelayIdInternal(relay_id,
2989 lower_bound_address,
2997Memfile_LeaseMgr::getLeases4ByRelayIdInternal(
const OptionBuffer& relay_id,
3000 const time_t& qry_start_time,
3001 const time_t& qry_end_time) {
3004 Lease4StorageRelayIdIndex::const_iterator lb =
3005 idx.lower_bound(boost::make_tuple(relay_id, lower_bound_address));
3007 IOAddress last_addr = lower_bound_address;
3008 for (; lb != idx.end(); ++lb) {
3009 if ((*lb)->addr_ == last_addr) {
3013 if ((*lb)->relay_id_ != relay_id) {
3017 last_addr = (*lb)->addr_;
3018 if ((qry_start_time > 0) && ((*lb)->cltt_ < qry_start_time)) {
3022 if ((qry_end_time > 0) && ((*lb)->cltt_ > qry_end_time)) {
3026 collection.push_back(
Lease4Ptr(
new Lease4(**lb)));
3027 if (collection.size() >= page_size.
page_size_) {
3031 return (collection);
3038 const time_t& qry_start_time ,
3039 const time_t& qry_end_time ) {
3043 .arg(lower_bound_address.
toText())
3044 .arg(idToText(remote_id))
3045 .arg(qry_start_time)
3049 if (!lower_bound_address.
isV4()) {
3051 "retrieving leases from the lease database, got "
3052 << lower_bound_address);
3056 if ((qry_start_time < 0) || (qry_end_time < 0)) {
3061 if ((qry_start_time > 0) && (qry_end_time > 0) &&
3062 (qry_start_time > qry_end_time)) {
3067 std::lock_guard<std::mutex> lock(*mutex_);
3068 return (getLeases4ByRemoteIdInternal(remote_id,
3069 lower_bound_address,
3074 return (getLeases4ByRemoteIdInternal(remote_id,
3075 lower_bound_address,
3083Memfile_LeaseMgr::getLeases4ByRemoteIdInternal(
const OptionBuffer& remote_id,
3086 const time_t& qry_start_time,
3087 const time_t& qry_end_time) {
3089 std::map<IOAddress, Lease4Ptr> sorted;
3093 BOOST_FOREACH(
auto const& it, er) {
3095 if (addr <= lower_bound_address) {
3099 if ((qry_start_time > 0) && (it->cltt_ < qry_start_time)) {
3103 if ((qry_end_time > 0) && (it->cltt_ > qry_end_time)) {
3111 for (
auto const& it : sorted) {
3112 collection.push_back(
Lease4Ptr(
new Lease4(*it.second)));
3113 if (collection.size() >= page_size.
page_size_) {
3117 return (collection);
3123 std::lock_guard<std::mutex> lock(*mutex_);
3149 .arg(lower_bound_address.
toText())
3153 if (!lower_bound_address.
isV6()) {
3155 "retrieving leases from the lease database, got "
3156 << lower_bound_address);
3160 std::lock_guard<std::mutex> lock(*mutex_);
3161 return (getLeases6ByRelayIdInternal(relay_id,
3162 lower_bound_address,
3165 return (getLeases6ByRelayIdInternal(relay_id,
3166 lower_bound_address,
3172Memfile_LeaseMgr::getLeases6ByRelayIdInternal(
const DUID& relay_id,
3175 const std::vector<uint8_t>& relay_id_data = relay_id.
getDuid();
3178 RelayIdIndex::const_iterator lb =
3179 idx.lower_bound(boost::make_tuple(relay_id_data, lower_bound_address));
3182 IOAddress last_addr = lower_bound_address;
3183 for (; lb != idx.end(); ++lb) {
3184 if ((*lb)->lease_addr_ == last_addr) {
3188 if ((*lb)->id_ != relay_id_data) {
3192 last_addr = (*lb)->lease_addr_;
3193 Lease6Ptr lease = getAnyLease6Internal(last_addr);
3195 collection.push_back(lease);
3196 if (collection.size() >= page_size.
page_size_) {
3201 return (collection);
3211 .arg(lower_bound_address.
toText())
3212 .arg(idToText(remote_id));
3215 if (!lower_bound_address.
isV6()) {
3217 "retrieving leases from the lease database, got "
3218 << lower_bound_address);
3222 std::lock_guard<std::mutex> lock(*mutex_);
3223 return (getLeases6ByRemoteIdInternal(remote_id,
3224 lower_bound_address,
3227 return (getLeases6ByRemoteIdInternal(remote_id,
3228 lower_bound_address,
3234Memfile_LeaseMgr::getLeases6ByRemoteIdInternal(
const OptionBuffer& remote_id,
3238 std::set<IOAddress> sorted;
3242 BOOST_FOREACH(
auto const& it, er) {
3243 const IOAddress& addr = it->lease_addr_;
3244 if (addr <= lower_bound_address) {
3247 static_cast<void>(sorted.insert(addr));
3252 Lease6Ptr lease = getAnyLease6Internal(addr);
3254 collection.push_back(lease);
3255 if (collection.size() >= page_size.
page_size_) {
3260 return (collection);
3273 <<
" consistency configuration is null");
3275 auto check = cfg->getExtendedInfoSanityCheck();
3280 .arg(update ?
" updating in file" :
"");
3283 size_t modified = 0;
3285 size_t processed = 0;
3287 auto lease_it = index.begin();
3288 auto next_it = index.end();
3290 for (; lease_it != index.end(); lease_it = next_it) {
3291 next_it = std::next(lease_it);
3306 if (!
copy->relay_id_.empty() || !
copy->remote_id_.empty()) {
3307 index.replace(lease_it,
copy);
3310 }
catch (
const std::exception& ex) {
3313 .arg(lease->addr_.toText())
3338 auto check = cfg->getExtendedInfoSanityCheck();
3344 .arg(enabled ?
"enabled" :
"disabled");
3353 size_t modified = 0;
3354 size_t processed = 0;
3356 for (
auto const& lease : storage6_) {
3365 }
catch (
const std::exception& ex) {
3368 .arg(lease->addr_.toText())
3388 static_cast<void>(relay_id_idx.erase(addr));
3391 static_cast<void>(remote_id_idx.erase(addr));
3396 const std::vector<uint8_t>& relay_id) {
3404 const std::vector<uint8_t>& remote_id) {
3413 std::lock_guard<std::mutex> lock(*mutex_);
3414 writeLeases4Internal(filename);
3416 writeLeases4Internal(filename);
3421Memfile_LeaseMgr::writeLeases4Internal(
const std::string& filename) {
3427 std::ostringstream old;
3428 old << filename <<
".bak" << getpid();
3429 ::rename(filename.c_str(), old.str().c_str());
3430 CSVLeaseFile4 backup(filename);
3432 for (
auto const& lease : storage4_) {
3433 backup.append(*lease);
3439 }
catch (
const std::exception&) {
3450 std::lock_guard<std::mutex> lock(*mutex_);
3451 writeLeases6Internal(filename);
3453 writeLeases6Internal(filename);
3458Memfile_LeaseMgr::writeLeases6Internal(
const std::string& filename) {
3464 std::ostringstream old;
3465 old << filename <<
".bak" << getpid();
3466 ::rename(filename.c_str(), old.str().c_str());
3467 CSVLeaseFile6 backup(filename);
3469 for (
auto const& lease : storage6_) {
3470 backup.append(*lease);
3476 }
catch (
const std::exception&) {
int version()
returns Kea hooks version.
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
A generic exception that is thrown if a function is called in a prohibited way.
A generic exception that is thrown when an unexpected error condition occurs.
The IOAddress class represents an IP addresses (version agnostic)
std::string toText() const
Convert the address to a string.
bool isV6() const
Convenience function to check for an IPv6 address.
bool isV4() const
Convenience function to check for an IPv4 address.
std::function< void()> Callback
Exception thrown when error occurs during spawning a process.
Utility class for spawning new processes.
std::string getParameter(const std::string &name) const
Returns value of a connection parameter.
static std::string redactedAccessString(const ParameterMap ¶meters)
Redact database access string.
std::map< std::string, std::string > ParameterMap
Database configuration parameter map.
Exception thrown on failure to open database.
Invalid address family used as input to Lease Manager.
Provides methods to access CSV file with DHCPv4 leases.
Provides methods to access CSV file with DHCPv6 leases.
static std::string sanityCheckToText(LeaseSanity check_type)
Converts lease sanity check value to printable text.
util::Optional< std::string > getDataDir() const
returns path do the data directory
uint16_t getFamily() const
Returns address family.
static CfgMgr & instance()
returns a single instance of Configuration Manager
SrvConfigPtr getStagingCfg()
Returns a pointer to the staging configuration.
SrvConfigPtr getCurrentCfg()
Returns a pointer to the current configuration.
void addLease(LeasePtr lease)
Increment the counts for all of a lease's classes by one.
void clear()
Remove all entries.
void removeLease(LeasePtr lease)
Decrement the counts for all of a lease's classes by one.
void updateLease(LeasePtr new_lease, LeasePtr old_lease)
Adjust class lease counts given a new and old version of a lease.
size_t getClassCount(const ClientClass &client_class, const Lease::Type <ype=Lease::TYPE_V4) const
Fetches the lease count for the given class and lease type.
Holds Client identifier or client IPv4 address.
const std::vector< uint8_t > & getClientId() const
Returns reference to the client-id data.
Holds DUID (DHCPv6 Unique Identifier)
const std::vector< uint8_t > & getDuid() const
Returns a const reference to the actual DUID value.
std::string toText() const
Returns textual representation of the identifier (e.g.
Represents a configuration for Lease File Cleanup.
void execute()
Spawns a new process.
int getExitStatus() const
Returns exit code of the last completed cleanup.
bool isRunning() const
Checks if the lease file cleanup is in progress.
LFCSetup(asiolink::IntervalTimer::Callback callback)
Constructor.
void setup(const uint32_t lfc_interval, const boost::shared_ptr< CSVLeaseFile4 > &lease_file4, const boost::shared_ptr< CSVLeaseFile6 > &lease_file6, bool run_once_now=false)
Sets the new configuration for the Lease File Cleanup.
Lease6 extended informations for Bulk Lease Query.
static void load(LeaseFileType &lease_file, StorageType &storage, const uint32_t max_errors=0, const bool close_file_on_exit=true)
Load leases from the lease file into the specified storage.
void setExtendedInfoTablesEnabled(const bool enabled)
Modifies the setting whether the lease6 extended info tables are enabled.
static bool upgradeLease6ExtendedInfo(const Lease6Ptr &lease, CfgConsistency::ExtendedInfoSanity check=CfgConsistency::EXTENDED_INFO_CHECK_FIX)
Upgrade a V6 lease user context to the new extended info entry.
bool getExtendedInfoTablesEnabled() const
Returns the setting indicating if lease6 extended info tables are enabled.
static void extractLease4ExtendedInfo(const Lease4Ptr &lease, bool ignore_errors=true)
Extract relay and remote identifiers from the extended info.
static bool upgradeLease4ExtendedInfo(const Lease4Ptr &lease, CfgConsistency::ExtendedInfoSanity check=CfgConsistency::EXTENDED_INFO_CHECK_FIX)
The following queries are used to fulfill Bulk Lease Query queries.
virtual bool addExtendedInfo6(const Lease6Ptr &lease)
Extract extended info from a lease6 and add it into tables.
Wraps value holding size of the page with leases.
const size_t page_size_
Holds page size.
Base class for fulfilling a statistical lease data query.
SubnetID getLastSubnetID() const
Returns the value of last subnet ID specified (or zero)
SubnetID getFirstSubnetID() const
Returns the value of first subnet ID specified (or zero)
SelectMode getSelectMode() const
Returns the selection criteria mode The value returned is based upon the constructor variant used and...
SelectMode
Defines the types of selection criteria supported.
Memfile derivation of the IPv4 statistical lease data query.
MemfileLeaseStatsQuery4(Lease4Storage &storage4, const SubnetID &first_subnet_id, const SubnetID &last_subnet_id)
Constructor for a subnet range query.
MemfileLeaseStatsQuery4(Lease4Storage &storage4, const SelectMode &select_mode=ALL_SUBNETS)
Constructor for an all subnets query.
virtual ~MemfileLeaseStatsQuery4()
Destructor.
void start()
Creates the IPv4 lease statistical data result set.
MemfileLeaseStatsQuery4(Lease4Storage &storage4, const SubnetID &subnet_id)
Constructor for a single subnet query.
Memfile derivation of the IPv6 statistical lease data query.
void start()
Creates the IPv6 lease statistical data result set.
virtual ~MemfileLeaseStatsQuery6()
Destructor.
MemfileLeaseStatsQuery6(Lease6Storage &storage6, const SubnetID &first_subnet_id, const SubnetID &last_subnet_id)
Constructor for a subnet range query.
MemfileLeaseStatsQuery6(Lease6Storage &storage6, const SelectMode &select_mode=ALL_SUBNETS)
Constructor.
MemfileLeaseStatsQuery6(Lease6Storage &storage6, const SubnetID &subnet_id)
Constructor for a single subnet query.
Base Memfile derivation of the statistical lease data query.
std::vector< LeaseStatsRow >::iterator next_pos_
An iterator for accessing the next row within the result set.
MemfileLeaseStatsQuery(const SubnetID &first_subnet_id, const SubnetID &last_subnet_id)
Constructor for subnet range query.
virtual bool getNextRow(LeaseStatsRow &row)
Fetches the next row in the result set.
std::vector< LeaseStatsRow > rows_
A vector containing the "result set".
MemfileLeaseStatsQuery(const SelectMode &select_mode=ALL_SUBNETS)
Constructor for all subnets query.
virtual ~MemfileLeaseStatsQuery()
Destructor.
int getRowCount() const
Returns the number of rows in the result set.
MemfileLeaseStatsQuery(const SubnetID &subnet_id)
Constructor for single subnet query.
Lease6ExtendedInfoRemoteIdTable remote_id6_
stores IPv6 by-remote-id cross-reference table
virtual void rollback() override
Rollback Transactions.
size_t extractExtendedInfo4(bool update, bool current)
Extract extended info for v4 leases.
virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery6(const SubnetID &first_subnet_id, const SubnetID &last_subnet_id) override
Creates and runs the IPv6 lease stats query for a single subnet.
virtual void clearClassLeaseCounts() override
Clears the class-lease count map.
virtual size_t byRelayId6size() const override
Return the by-relay-id table size.
virtual Lease4Collection getLeases4ByRelayId(const OptionBuffer &relay_id, const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size, const time_t &qry_start_time=0, const time_t &qry_end_time=0) override
The following queries are used to fulfill Bulk Lease Query queries.
Memfile_LeaseMgr(const db::DatabaseConnection::ParameterMap ¶meters)
The sole lease manager constructor.
bool isLFCRunning() const
Checks if the process performing lease file cleanup is running.
virtual void writeLeases4(const std::string &filename) override
Write V4 leases to a file.
virtual void updateLease4(const Lease4Ptr &lease4) override
Updates IPv4 lease.
virtual size_t wipeLeases4(const SubnetID &subnet_id) override
Removes specified IPv4 leases.
virtual void deleteExtendedInfo6(const isc::asiolink::IOAddress &addr) override
Delete lease6 extended info from tables.
virtual bool isJsonSupported() const override
Checks if JSON support is enabled in the database.
Universe
Specifies universe (V4, V6)
static TrackingLeaseMgrPtr factory(const isc::db::DatabaseConnection::ParameterMap ¶meters)
Factory class method.
LFCFileType
Types of the lease files used by the Lease File Cleanup.
@ FILE_PREVIOUS
Previous Lease File.
@ FILE_FINISH
LFC Finish File.
@ FILE_OUTPUT
LFC Output File.
@ FILE_INPUT
Lease File Copy
virtual bool deleteLease(const Lease4Ptr &lease) override
Deletes an IPv4 lease.
virtual void commit() override
Commit Transactions.
virtual size_t wipeLeases6(const SubnetID &subnet_id) override
Removed specified IPv6 leases.
virtual std::pair< uint32_t, uint32_t > getVersion(const std::string &timer_name=std::string()) const override
Returns backend version.
int getLFCExitStatus() const
Returns the status code returned by the last executed LFC process.
virtual LeaseStatsQueryPtr startPoolLeaseStatsQuery6() override
Creates and runs the IPv6 lease stats query for all subnets and pools.
bool persistLeases(Universe u) const
Specifies whether or not leases are written to disk.
virtual void addRemoteId6(const isc::asiolink::IOAddress &lease_addr, const std::vector< uint8_t > &remote_id) override
Add lease6 extended info into by-remote-id table.
static std::string getDBVersion()
Return extended version info.
virtual Lease4Collection getLeases4() const override
Returns all IPv4 leases.
virtual size_t getClassLeaseCount(const ClientClass &client_class, const Lease::Type <ype=Lease::TYPE_V4) const override
Returns the class lease count for a given class and lease type.
virtual void getExpiredLeases6(Lease6Collection &expired_leases, const size_t max_leases) const override
Returns a collection of expired DHCPv6 leases.
void buildExtendedInfoTables6()
Extended information / Bulk Lease Query shared interface.
virtual bool addLease(const Lease4Ptr &lease) override
Adds an IPv4 lease.
virtual size_t byRemoteId6size() const override
Return the by-remote-id table size.
virtual void writeLeases6(const std::string &filename) override
Write V6 leases to a file.
Lease6ExtendedInfoRelayIdTable relay_id6_
stores IPv6 by-relay-id cross-reference table
virtual void recountClassLeases6() override
Recount the leases per class for V6 leases.
virtual Lease4Collection getLeases4ByRemoteId(const OptionBuffer &remote_id, const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size, const time_t &qry_start_time=0, const time_t &qry_end_time=0) override
Returns existing IPv4 leases with a given remote-id.
virtual void wipeExtendedInfoTables6() override
Wipe extended info table (v6).
boost::shared_ptr< CSVLeaseFile4 > lease_file4_
Holds the pointer to the DHCPv4 lease file IO.
std::string getLeaseFilePath(Universe u) const
Returns an absolute path to the lease file.
virtual Lease6Collection getLeases6ByRemoteId(const OptionBuffer &remote_id, const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size) override
Returns existing IPv6 leases with a given remote-id.
virtual Lease6Collection getLeases6() const override
Returns all IPv6 leases.
virtual void lfcCallback()
A callback function triggering Lease File Cleanup (LFC).
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID &subnet_id) override
Creates and runs the IPv4 lease stats query for a single subnet.
virtual Lease6Collection getLeases6ByRelayId(const DUID &relay_id, const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size) override
Returns existing IPv6 leases with a given relay-id.
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID &subnet_id) override
Creates and runs the IPv6 lease stats query for a single subnet.
virtual std::string getDescription() const override
Returns description of the backend.
static std::string appendSuffix(const std::string &file_name, const LFCFileType &file_type)
Appends appropriate suffix to the file name.
virtual void addRelayId6(const isc::asiolink::IOAddress &lease_addr, const std::vector< uint8_t > &relay_id) override
Add lease6 extended info into by-relay-id table.
virtual size_t upgradeExtendedInfo6(const LeasePageSize &page_size) override
Upgrade extended info (v6).
virtual LeaseStatsQueryPtr startLeaseStatsQuery4() override
Creates and runs the IPv4 lease stats query.
virtual Lease6Ptr getLease6(Lease::Type type, const isc::asiolink::IOAddress &addr) const override
Returns existing IPv6 lease for a given IPv6 address.
virtual void recountClassLeases4() override
Recount the leases per class for V4 leases.
virtual void updateLease6(const Lease6Ptr &lease6) override
Updates IPv6 lease.
virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery4(const SubnetID &first_subnet_id, const SubnetID &last_subnet_id) override
Creates and runs the IPv4 lease stats query for a single subnet.
virtual uint64_t deleteExpiredReclaimedLeases4(const uint32_t secs) override
Deletes all expired-reclaimed DHCPv4 leases.
static std::string getDBVersionInternal(Universe const &u)
Local version of getDBVersion() class method.
virtual LeaseStatsQueryPtr startPoolLeaseStatsQuery4() override
Creates and runs the IPv4 lease stats query for all subnets and pools.
virtual std::string checkLimits6(isc::data::ConstElementPtr const &user_context) const override
Checks if the IPv6 lease limits set in the given user context are exceeded.
virtual LeaseStatsQueryPtr startLeaseStatsQuery6() override
Creates and runs the IPv6 lease stats query.
virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress &addr) const override
Returns existing IPv4 lease for specified IPv4 address.
virtual ~Memfile_LeaseMgr()
Destructor (closes file)
virtual std::string checkLimits4(isc::data::ConstElementPtr const &user_context) const override
Checks if the IPv4 lease limits set in the given user context are exceeded.
boost::shared_ptr< CSVLeaseFile6 > lease_file6_
Holds the pointer to the DHCPv6 lease file IO.
std::string getDefaultLeaseFilePath(Universe u) const
Returns default path to the lease file.
virtual size_t upgradeExtendedInfo4(const LeasePageSize &page_size) override
Upgrade extended info (v4).
virtual uint64_t deleteExpiredReclaimedLeases6(const uint32_t secs) override
Deletes all expired-reclaimed DHCPv6 leases.
virtual void getExpiredLeases4(Lease4Collection &expired_leases, const size_t max_leases) const override
Returns a collection of expired DHCPv4 leases.
Attempt to update lease that was not there.
Manages a pool of asynchronous interval timers.
Introduces callbacks into the LeaseMgr.
void trackAddLease(const LeasePtr &lease)
Invokes the callbacks when a new lease is added.
void trackUpdateLease(const LeasePtr &lease)
Invokes the callbacks when a lease is updated.
void trackDeleteLease(const LeasePtr &lease)
Invokes the callbacks when a lease is deleted.
bool hasCallbacks() const
Checks if any callbacks have been registered.
static StatsMgr & instance()
Statistics Manager accessor method.
static std::string generateName(const std::string &context, Type index, const std::string &stat_name)
Generates statistic name in a given context.
Exception thrown when an error occurs during CSV file processing.
Provides input/output access to CSV files.
RAII class creating a critical section.
static MultiThreadingMgr & instance()
Returns a single instance of Multi Threading Manager.
Class to help with processing PID files.
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
isc::data::ConstElementPtr get(const std::string &name) const
Returns a single statistic as a JSON structure.
static const int MAJOR_VERSION_V4
static const int MINOR_VERSION_V4
the minor version of the v4 memfile backend
static const int MAJOR_VERSION_V6
static const int MINOR_VERSION_V6
the minor version of the v6 memfile backend
#define LOG_ERROR(LOGGER, MESSAGE)
Macro to conveniently test error output and log it.
#define LOG_INFO(LOGGER, MESSAGE)
Macro to conveniently test info output and log it.
#define LOG_WARN(LOGGER, MESSAGE)
Macro to conveniently test warn output and log it.
#define LOG_DEBUG(LOGGER, LEVEL, MESSAGE)
Macro to conveniently test debug output and log it.
std::vector< std::string > ProcessArgs
Type of the container holding arguments of the executable being run as a background process.
std::vector< std::string > ProcessEnvVars
Type of the container holding environment variables of the executable being run as a background proce...
ElementPtr copy(ConstElementPtr from, int level)
Copy the data up to a nesting level.
void prettyPrint(ConstElementPtr element, std::ostream &out, unsigned indent, unsigned step)
Pretty prints the data into stream.
boost::shared_ptr< const Element > ConstElementPtr
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_START
isc::log::Logger dhcpsrv_logger("dhcpsrv")
DHCP server library Logger.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_SUBID_CLIENTID
const isc::log::MessageID DHCPSRV_MEMFILE_EXTRACT_EXTENDED_INFO4
std::string ClientClass
Defines a single class name.
boost::multi_index_container< Lease4Ptr, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::tag< AddressIndexTag >, boost::multi_index::member< Lease, isc::asiolink::IOAddress, &Lease::addr_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< HWAddressSubnetIdIndexTag >, boost::multi_index::composite_key< Lease4, boost::multi_index::const_mem_fun< Lease, const std::vector< uint8_t > &, &Lease::getHWAddrVector >, boost::multi_index::member< Lease, SubnetID, &Lease::subnet_id_ > > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< ClientIdSubnetIdIndexTag >, boost::multi_index::composite_key< Lease4, boost::multi_index::const_mem_fun< Lease4, const std::vector< uint8_t > &, &Lease4::getClientIdVector >, boost::multi_index::member< Lease, uint32_t, &Lease::subnet_id_ > > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< ExpirationIndexTag >, boost::multi_index::composite_key< Lease4, boost::multi_index::const_mem_fun< Lease, bool, &Lease::stateExpiredReclaimed >, boost::multi_index::const_mem_fun< Lease, int64_t, &Lease::getExpirationTime > > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< SubnetIdIndexTag >, boost::multi_index::member< Lease, isc::dhcp::SubnetID, &Lease::subnet_id_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< HostnameIndexTag >, boost::multi_index::member< Lease, std::string, &Lease::hostname_ > >, boost::multi_index::hashed_non_unique< boost::multi_index::tag< RemoteIdIndexTag >, boost::multi_index::member< Lease4, std::vector< uint8_t >, &Lease4::remote_id_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< RelayIdIndexTag >, boost::multi_index::composite_key< Lease4, boost::multi_index::member< Lease4, std::vector< uint8_t >, &Lease4::relay_id_ >, boost::multi_index::member< Lease, isc::asiolink::IOAddress, &Lease::addr_ > > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< SubnetIdPoolIdIndexTag >, boost::multi_index::composite_key< Lease4, boost::multi_index::member< Lease, SubnetID, &Lease::subnet_id_ >, boost::multi_index::member< Lease, uint32_t, &Lease::pool_id_ > > > > > Lease4Storage
A multi index container holding DHCPv4 leases.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_SUBID_HWADDR
const isc::log::MessageID DHCPSRV_MEMFILE_WIPE_LEASES6
const isc::log::MessageID DHCPSRV_MEMFILE_GET4
const isc::log::MessageID DHCPSRV_MEMFILE_BUILD_EXTENDED_INFO_TABLES6_ERROR
const isc::log::MessageID DHCPSRV_MEMFILE_GET_REMOTEID6
const isc::log::MessageID DHCPSRV_MEMFILE_GET_SUBID_PAGE6
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_UNREGISTER_TIMER_FAILED
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_SPAWN_FAIL
const isc::log::MessageID DHCPSRV_MEMFILE_DB
Lease6Storage::index< ExpirationIndexTag >::type Lease6StorageExpirationIndex
DHCPv6 lease storage index by expiration time.
const isc::log::MessageID DHCPSRV_MEMFILE_CONVERTING_LEASE_FILES
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_SETUP
const isc::log::MessageID DHCPSRV_MEMFILE_WIPE_LEASES6_FINISHED
Lease6Storage::index< DuidIndexTag >::type Lease6StorageDuidIndex
DHCPv6 lease storage index by DUID.
boost::shared_ptr< Lease6 > Lease6Ptr
Pointer to a Lease6 structure.
std::vector< Lease6Ptr > Lease6Collection
A collection of IPv6 leases.
boost::shared_ptr< LeaseStatsQuery > LeaseStatsQueryPtr
Defines a pointer to a LeaseStatsQuery.
const isc::log::MessageID DHCPSRV_MEMFILE_WIPE_LEASES4
Lease6Storage::index< SubnetIdPoolIdIndexTag >::type Lease6StorageSubnetIdPoolIdIndex
DHCPv6 lease storage index subnet-id and pool-id.
Lease6Storage::index< DuidIaidTypeIndexTag >::type Lease6StorageDuidIaidTypeIndex
DHCPv6 lease storage index by DUID, IAID, lease type.
boost::shared_ptr< TimerMgr > TimerMgrPtr
Type definition of the shared pointer to TimerMgr.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_RELAYID4
const isc::log::MessageID DHCPSRV_MEMFILE_DELETE_EXPIRED_RECLAIMED_START
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_LEASE_FILE_RENAME_FAIL
const isc::log::MessageID DHCPSRV_MEMFILE_UPDATE_ADDR4
const isc::log::MessageID DHCPSRV_MEMFILE_GET_SUBID6
Lease4Storage::index< ExpirationIndexTag >::type Lease4StorageExpirationIndex
DHCPv4 lease storage index by expiration time.
Lease6Storage::index< AddressIndexTag >::type Lease6StorageAddressIndex
DHCPv6 lease storage index by address.
const int DHCPSRV_DBG_TRACE_DETAIL
Additional information.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_ADDR4
const isc::log::MessageID DHCPSRV_MEMFILE_ROLLBACK
const isc::log::MessageID DHCPSRV_MEMFILE_UPDATE_ADDR6
Lease4Storage::index< HostnameIndexTag >::type Lease4StorageHostnameIndex
DHCPv4 lease storage index by hostname.
std::pair< Lease4StorageRemoteIdIndex::const_iterator, Lease4StorageRemoteIdIndex::const_iterator > Lease4StorageRemoteIdRange
DHCPv4 lease storage range by remote-id.
Lease6Storage::index< HostnameIndexTag >::type Lease6StorageHostnameIndex
DHCPv6 lease storage index by hostname.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_EXPIRED4
const isc::log::MessageID DHCPSRV_MEMFILE_GET_EXPIRED6
const isc::log::MessageID DHCPSRV_MEMFILE_GET_HOSTNAME4
boost::multi_index_container< Lease6Ptr, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::tag< AddressIndexTag >, boost::multi_index::member< Lease, isc::asiolink::IOAddress, &Lease::addr_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< DuidIaidTypeIndexTag >, boost::multi_index::composite_key< Lease6, boost::multi_index::const_mem_fun< Lease6, const std::vector< uint8_t > &, &Lease6::getDuidVector >, boost::multi_index::member< Lease6, uint32_t, &Lease6::iaid_ >, boost::multi_index::member< Lease6, Lease::Type, &Lease6::type_ > > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< ExpirationIndexTag >, boost::multi_index::composite_key< Lease6, boost::multi_index::const_mem_fun< Lease, bool, &Lease::stateExpiredReclaimed >, boost::multi_index::const_mem_fun< Lease, int64_t, &Lease::getExpirationTime > > >, boost::multi_index::ordered_unique< boost::multi_index::tag< SubnetIdIndexTag >, boost::multi_index::composite_key< Lease6, boost::multi_index::member< Lease, isc::dhcp::SubnetID, &Lease::subnet_id_ >, boost::multi_index::member< Lease, isc::asiolink::IOAddress, &Lease::addr_ > > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< DuidIndexTag >, boost::multi_index::const_mem_fun< Lease6, const std::vector< uint8_t > &, &Lease6::getDuidVector > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< HostnameIndexTag >, boost::multi_index::member< Lease, std::string, &Lease::hostname_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< SubnetIdPoolIdIndexTag >, boost::multi_index::composite_key< Lease6, boost::multi_index::member< Lease, SubnetID, &Lease::subnet_id_ >, boost::multi_index::member< Lease, uint32_t, &Lease::pool_id_ > > > > > Lease6Storage
A multi index container holding DHCPv6 leases.
Lease4Storage::index< ClientIdSubnetIdIndexTag >::type Lease4StorageClientIdSubnetIdIndex
DHCPv4 lease storage index by client-id and subnet-id.
Lease4Storage::index< HWAddressSubnetIdIndexTag >::type Lease4StorageHWAddressSubnetIdIndex
DHCPv4 lease storage index by HW address and subnet-id.
const isc::log::MessageID DHCPSRV_MEMFILE_EXTRACT_EXTENDED_INFO4_ERROR
const isc::log::MessageID DHCPSRV_MEMFILE_ADD_ADDR6
Lease6ExtendedInfoRelayIdTable::index< LeaseAddressIndexTag >::type LeaseAddressRelayIdIndex
Lease6 extended information by lease address index of by relay id table.
Lease6ExtendedInfoRelayIdTable::index< RelayIdIndexTag >::type RelayIdIndex
Lease6 extended information by relay id index.
Lease4Storage::index< RemoteIdIndexTag >::type Lease4StorageRemoteIdIndex
DHCPv4 lease storage index by remote-id.
uint32_t SubnetID
Defines unique IPv4 or IPv6 subnet identifier.
const isc::log::MessageID DHCPSRV_MEMFILE_BEGIN_EXTRACT_EXTENDED_INFO4
const isc::log::MessageID DHCPSRV_MEMFILE_WIPE_LEASES4_FINISHED
const isc::log::MessageID DHCPSRV_MEMFILE_GET_SUBID4
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_LEASE_FILE_REOPEN_FAIL
const isc::log::MessageID DHCPSRV_MEMFILE_COMMIT
const isc::log::MessageID DHCPSRV_MEMFILE_DELETE_EXPIRED_RECLAIMED4
boost::shared_ptr< CfgConsistency > CfgConsistencyPtr
Type used to for pointing to CfgConsistency structure.
const isc::log::MessageID DHCPSRV_MEMFILE_BEGIN_BUILD_EXTENDED_INFO_TABLES6
const isc::log::MessageID DHCPSRV_MEMFILE_GET_HOSTNAME6
const isc::log::MessageID DHCPSRV_MEMFILE_DELETE_EXPIRED_RECLAIMED6
const isc::log::MessageID DHCPSRV_MEMFILE_LFC_EXECUTE
std::pair< RemoteIdIndex::const_iterator, RemoteIdIndex::const_iterator > RemoteIdIndexRange
Lease6 extended information by remote id range.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_RELAYID6
const isc::log::MessageID DHCPSRV_MEMFILE_NO_STORAGE
const isc::log::MessageID DHCPSRV_MEMFILE_BUILD_EXTENDED_INFO_TABLES6
std::unique_ptr< TrackingLeaseMgr > TrackingLeaseMgrPtr
TrackingLeaseMgr pointer.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_PAGE4
const isc::log::MessageID DHCPSRV_MEMFILE_GET_HWADDR
const isc::log::MessageID DHCPSRV_MEMFILE_GET6_DUID
Lease4Storage::index< SubnetIdIndexTag >::type Lease4StorageSubnetIdIndex
DHCPv4 lease storage index subnet-id.
std::vector< uint8_t > OptionBuffer
buffer types used in DHCP code.
const isc::log::MessageID DHCPSRV_MEMFILE_DELETE_ADDR4
std::vector< Lease4Ptr > Lease4Collection
A collection of IPv4 leases.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_ADDR6
const isc::log::MessageID DHCPSRV_MEMFILE_ADD_ADDR4
const isc::log::MessageID DHCPSRV_MEMFILE_GET_CLIENTID
Lease4Storage::index< AddressIndexTag >::type Lease4StorageAddressIndex
DHCPv4 lease storage index by address.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_IAID_DUID
const isc::log::MessageID DHCPSRV_MEMFILE_GET6
const isc::log::MessageID DHCPSRV_MEMFILE_GET_REMOTEID4
boost::shared_ptr< Lease4 > Lease4Ptr
Pointer to a Lease4 structure.
Lease6ExtendedInfoRemoteIdTable::index< LeaseAddressIndexTag >::type LeaseAddressRemoteIdIndex
Lease6 extended information by lease address index of by remote id table.
const int DHCPSRV_DBG_TRACE
DHCP server library logging levels.
Lease6Storage::index< SubnetIdIndexTag >::type Lease6StorageSubnetIdIndex
DHCPv6 lease storage index by subnet-id.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_IAID_SUBID_DUID
boost::shared_ptr< Lease6ExtendedInfo > Lease6ExtendedInfoPtr
Pointer to a Lease6ExtendedInfo object.
const isc::log::MessageID DHCPSRV_MEMFILE_DELETE_ADDR6
Lease6ExtendedInfoRemoteIdTable::index< RemoteIdIndexTag >::type RemoteIdIndex
Lease6 extended information by remote id index.
Lease4Storage::index< SubnetIdPoolIdIndexTag >::type Lease4StorageSubnetIdPoolIdIndex
DHCPv4 lease storage index subnet-id and pool-id.
Lease4Storage::index< RelayIdIndexTag >::type Lease4StorageRelayIdIndex
DHCPv4 lease storage index by relay-id.
const isc::log::MessageID DHCPSRV_MEMFILE_GET_PAGE6
Defines the logger used by the top-level component of kea-lfc.
Tag for indexes by address.
Tag for indexes by client-id, subnet-id tuple.
Tag for indexes by DUID, IAID, lease type tuple.
Tag for index using DUID.
Tag for indexes by expiration time.
Hardware type that represents information from DHCPv4 packet.
std::vector< uint8_t > hwaddr_
std::string toText(bool include_htype=true) const
Returns textual representation of a hardware address (e.g.
Tag for indexes by HW address, subnet-id tuple.
Tag for index using hostname.
Structure that holds a lease for IPv4 address.
Structure that holds a lease for IPv6 address and/or prefix.
ExtendedInfoAction
Action on extended info tables.
@ ACTION_UPDATE
update extended info tables.
@ ACTION_DELETE
delete reference to the lease
@ ACTION_IGNORE
ignore extended info,
Tag for indexes by lease address.
Contains a single row of lease statistical data.
static const uint32_t STATE_DEFAULT
A lease in the default state.
static const uint32_t STATE_DECLINED
Declined lease.
Type
Type of lease or pool.
@ TYPE_PD
the lease contains IPv6 prefix (for prefix delegation)
@ TYPE_NA
the lease contains non-temporary IPv6 address
static const uint32_t STATE_REGISTERED
Registered self-generated lease.
static std::string typeToText(Type type)
returns text representation of a lease type
Tag for index using relay-id.
Tag for index using remote-id.
Tag for indexes by subnet-id (and address for v6).