Kea 2.2.0
mysql_lease_mgr.h
Go to the documentation of this file.
1// Copyright (C) 2012-2022 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef MYSQL_LEASE_MGR_H
8#define MYSQL_LEASE_MGR_H
9
10#include <asiolink/io_service.h>
11#include <dhcp/hwaddr.h>
13#include <dhcpsrv/lease_mgr.h>
15
16#include <boost/scoped_ptr.hpp>
17#include <boost/utility.hpp>
18#include <mysql.h>
19
20#include <time.h>
21#include <vector>
22#include <mutex>
23
24namespace isc {
25namespace dhcp {
26
27// Forward declaration of the Lease exchange objects. These classes are defined
28// in the .cc file.
29class MySqlLease4Exchange;
30class MySqlLease6Exchange;
31
42public:
43
50 db::IOServiceAccessorPtr io_service_accessor,
51 db::DbCallback db_reconnect_callback);
52
57 boost::scoped_ptr<MySqlLease4Exchange> exchange4_;
58 boost::scoped_ptr<MySqlLease6Exchange> exchange6_;
59
62};
63
65typedef boost::shared_ptr<MySqlLeaseContext> MySqlLeaseContextPtr;
66
74public:
75
77 std::vector<MySqlLeaseContextPtr> pool_;
78
80 std::mutex mutex_;
81};
82
84typedef boost::shared_ptr<MySqlLeaseContextPool> MySqlLeaseContextPoolPtr;
85
91
92class MySqlLeaseMgr : public LeaseMgr {
93public:
94
115
117 virtual ~MySqlLeaseMgr();
118
128
151 static bool dbReconnect(util::ReconnectCtlPtr db_reconnect_ctl);
152
154 static std::string getDBVersion();
155
165 virtual bool addLease(const Lease4Ptr& lease) override;
166
176 virtual bool addLease(const Lease6Ptr& lease) override;
177
196 virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr) const override;
197
214 virtual Lease4Collection getLease4(const isc::dhcp::HWAddr& hwaddr) const override;
215
232 virtual Lease4Ptr getLease4(const isc::dhcp::HWAddr& hwaddr,
233 SubnetID subnet_id) const override;
234
251 virtual Lease4Collection getLease4(const ClientId& clientid) const override;
252
268 virtual Lease4Ptr getLease4(const ClientId& clientid,
269 SubnetID subnet_id) const override;
270
276 virtual Lease4Collection getLeases4(SubnetID subnet_id) const override;
277
283 virtual Lease4Collection getLeases4(const std::string& hostname) const override;
284
288 virtual Lease4Collection getLeases4() const override;
289
314 virtual Lease4Collection
315 getLeases4(const asiolink::IOAddress& lower_bound_address,
316 const LeasePageSize& page_size) const override;
317
336 virtual Lease6Ptr getLease6(Lease::Type type,
337 const isc::asiolink::IOAddress& addr) const override;
338
359 virtual Lease6Collection getLeases6(Lease::Type type, const DUID& duid,
360 uint32_t iaid) const override;
361
378 virtual Lease6Collection getLeases6(Lease::Type type, const DUID& duid,
379 uint32_t iaid, SubnetID subnet_id) const override;
380
386 virtual Lease6Collection getLeases6(SubnetID subnet_id) const override;
387
393 virtual Lease6Collection getLeases6(const std::string& hostname) const override;
394
398 virtual Lease6Collection getLeases6() const override;
399
405 virtual Lease6Collection getLeases6(const DUID& duid) const override;
406
431 virtual Lease6Collection
432 getLeases6(const asiolink::IOAddress& lower_bound_address,
433 const LeasePageSize& page_size) const override;
434
445 virtual void getExpiredLeases4(Lease4Collection& expired_leases,
446 const size_t max_leases) const override;
447
458 virtual void getExpiredLeases6(Lease6Collection& expired_leases,
459 const size_t max_leases) const override;
460
481 virtual void updateLease4(const Lease4Ptr& lease4) override;
482
503 virtual void updateLease6(const Lease6Ptr& lease6) override;
504
519 virtual bool deleteLease(const Lease4Ptr& lease) override;
520
535 virtual bool deleteLease(const Lease6Ptr& lease) override;
536
544 virtual uint64_t deleteExpiredReclaimedLeases4(const uint32_t secs) override;
545
553 virtual uint64_t deleteExpiredReclaimedLeases6(const uint32_t secs) override;
554
563 virtual LeaseStatsQueryPtr startLeaseStatsQuery4() override;
564
573 virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID& subnet_id) override;
574
584 virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery4(const SubnetID& first_subnet_id,
585 const SubnetID& last_subnet_id) override;
586
595 virtual LeaseStatsQueryPtr startLeaseStatsQuery6() override;
596
605 virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID& subnet_id) override;
606
616 virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery6(const SubnetID& first_subnet_id,
617 const SubnetID& last_subnet_id) override;
618
628 virtual size_t wipeLeases4(const SubnetID& subnet_id) override;
629
639 virtual size_t wipeLeases6(const SubnetID& subnet_id) override;
640
646 virtual std::string getType() const override {
647 return (std::string("mysql"));
648 }
649
655 virtual std::string getName() const override;
656
662 virtual std::string getDescription() const override;
663
671 virtual std::pair<uint32_t, uint32_t> getVersion() const override;
672
679 virtual void commit() override;
680
687 virtual void rollback() override;
688
694 DELETE_LEASE4, // Delete from lease4 by address
695 DELETE_LEASE4_STATE_EXPIRED, // Delete expired lease4 in a given state
696 DELETE_LEASE6, // Delete from lease6 by address
697 DELETE_LEASE6_STATE_EXPIRED, // Delete expired lease6 in a given state
698 GET_LEASE4, // Get all IPv4 leases
699 GET_LEASE4_ADDR, // Get lease4 by address
700 GET_LEASE4_CLIENTID, // Get lease4 by client ID
701 GET_LEASE4_CLIENTID_SUBID, // Get lease4 by client ID & subnet ID
702 GET_LEASE4_HWADDR, // Get lease4 by HW address
703 GET_LEASE4_HWADDR_SUBID, // Get lease4 by HW address & subnet ID
704 GET_LEASE4_PAGE, // Get page of leases beginning with an address
705 GET_LEASE4_SUBID, // Get IPv4 leases by subnet ID
706 GET_LEASE4_HOSTNAME, // Get IPv4 leases by hostname
707 GET_LEASE4_EXPIRE, // Get lease4 by expiration.
708 GET_LEASE6, // Get all IPv6 leases
709 GET_LEASE6_ADDR, // Get lease6 by address
710 GET_LEASE6_DUID_IAID, // Get lease6 by DUID and IAID
711 GET_LEASE6_DUID_IAID_SUBID, // Get lease6 by DUID, IAID and subnet ID
712 GET_LEASE6_PAGE, // Get page of leases beginning with an address
713 GET_LEASE6_SUBID, // Get IPv6 leases by subnet ID
714 GET_LEASE6_DUID, // Get IPv6 leases by DUID
715 GET_LEASE6_HOSTNAME, // Get IPv6 leases by hostname
716 GET_LEASE6_EXPIRE, // Get lease6 by expiration.
717 INSERT_LEASE4, // Add entry to lease4 table
718 INSERT_LEASE6, // Add entry to lease6 table
719 UPDATE_LEASE4, // Update a Lease4 entry
720 UPDATE_LEASE6, // Update a Lease6 entry
721 ALL_LEASE4_STATS, // Fetches IPv4 lease statistics
722 SUBNET_LEASE4_STATS, // Fetched IPv4 lease stats for a single subnet.
723 SUBNET_RANGE_LEASE4_STATS, // Fetched IPv4 lease stats for a subnet range.
724 ALL_LEASE6_STATS, // Fetches IPv6 lease statistics
725 SUBNET_LEASE6_STATS, // Fetched IPv6 lease stats for a single subnet.
726 SUBNET_RANGE_LEASE6_STATS, // Fetched IPv6 lease stats for a subnet range.
727 CHECK_LEASE4_LIMITS, // Check if allocated IPv4 leases are inside the set limits.
728 CHECK_LEASE6_LIMITS, // Check if allocated IPv6 leases are inside the set limits.
729 IS_JSON_SUPPORTED, // Checks if JSON support is enabled in the database.
730 GET_LEASE4_COUNT_BY_CLASS, // Fetches the IPv4 lease count for a given class.
731 GET_LEASE6_COUNT_BY_CLASS, // Fetches the IPv6 lease count for given class and lease type.
732 NUM_STATEMENTS // Number of statements
733 };
734
735private:
736
753 bool addLeaseCommon(MySqlLeaseContextPtr& ctx,
754 StatementIndex stindex, std::vector<MYSQL_BIND>& bind);
755
777 template <typename Exchange, typename LeaseCollection>
778 void getLeaseCollection(MySqlLeaseContextPtr& ctx,
779 StatementIndex stindex,
780 MYSQL_BIND* bind,
781 Exchange& exchange, LeaseCollection& result,
782 bool single = false) const;
783
801 void getLeaseCollection(MySqlLeaseContextPtr& ctx,
802 StatementIndex stindex,
803 MYSQL_BIND* bind,
804 Lease4Collection& result) const {
805 getLeaseCollection(ctx, stindex, bind, ctx->exchange4_, result);
806 }
807
824 void getLeaseCollection(MySqlLeaseContextPtr& ctx,
825 StatementIndex stindex,
826 MYSQL_BIND* bind,
827 Lease6Collection& result) const {
828 getLeaseCollection(ctx, stindex, bind, ctx->exchange6_, result);
829 }
830
841 void getLease(MySqlLeaseContextPtr& ctx,
842 StatementIndex stindex,
843 MYSQL_BIND* bind,
844 Lease4Ptr& result) const;
845
856 void getLease(MySqlLeaseContextPtr& ctx,
857 StatementIndex stindex,
858 MYSQL_BIND* bind,
859 Lease6Ptr& result) const;
860
875 template<typename LeaseCollection>
876 void getExpiredLeasesCommon(LeaseCollection& expired_leases,
877 const size_t max_leases,
878 StatementIndex statement_index) const;
879
897 template <typename LeasePtr>
898 void updateLeaseCommon(MySqlLeaseContextPtr& ctx,
899 StatementIndex stindex,
900 MYSQL_BIND* bind,
901 const LeasePtr& lease);
902
918 uint64_t deleteLeaseCommon(StatementIndex stindex,
919 MYSQL_BIND* bind);
920
930 uint64_t deleteExpiredReclaimedLeasesCommon(const uint32_t secs,
931 StatementIndex statement_index);
932
944 std::string
945 checkLimits(isc::data::ConstElementPtr const& user_context, StatementIndex const stindex) const;
946
958 virtual std::string
959 checkLimits4(isc::data::ConstElementPtr const& user_context) const override;
960
972 virtual std::string
973 checkLimits6(isc::data::ConstElementPtr const& user_context) const override;
974
979 virtual bool isJsonSupported() const override;
980
988 virtual size_t getClassLeaseCount(const ClientClass& client_class,
989 const Lease::Type& ltype = Lease::TYPE_V4) const override;
990
992 virtual void recountClassLeases4() override;
993
995 virtual void recountClassLeases6() override;
996
998 virtual void clearClassLeaseCounts() override;
999
1011 void checkError(MySqlLeaseContextPtr& ctx,
1012 int status, StatementIndex index,
1013 const char* what) const;
1014
1016 class MySqlLeaseContextAlloc {
1017 public:
1018
1025 MySqlLeaseContextAlloc(const MySqlLeaseMgr& mgr);
1026
1030 ~MySqlLeaseContextAlloc();
1031
1034
1035 private:
1036
1038 const MySqlLeaseMgr& mgr_;
1039 };
1040
1041private:
1042
1043 // Members
1044
1047
1050
1052 std::string timer_name_;
1053};
1054
1055} // namespace dhcp
1056} // namespace isc
1057
1058#endif // MYSQL_LEASE_MGR_H
std::map< std::string, std::string > ParameterMap
Database configuration parameter map.
Common MySQL Connector Pool.
Holds Client identifier or client IPv4 address.
Definition: duid.h:111
Holds DUID (DHCPv6 Unique Identifier)
Definition: duid.h:27
Abstract Lease Manager.
Definition: lease_mgr.h:223
Wraps value holding size of the page with leases.
Definition: lease_mgr.h:44
MySQL Lease Context Pool.
std::mutex mutex_
The mutex to protect pool access.
std::vector< MySqlLeaseContextPtr > pool_
The vector of available contexts.
MySQL Lease Context.
boost::scoped_ptr< MySqlLease6Exchange > exchange6_
Exchange object.
boost::scoped_ptr< MySqlLease4Exchange > exchange4_
The exchange objects are used for transfer of data to/from the database.
MySqlLeaseContext(const db::DatabaseConnection::ParameterMap &parameters, db::IOServiceAccessorPtr io_service_accessor, db::DbCallback db_reconnect_callback)
Constructor.
db::MySqlConnection conn_
MySQL connection.
MySQL Lease Manager.
virtual Lease6Ptr getLease6(Lease::Type type, const isc::asiolink::IOAddress &addr) const override
Returns existing IPv6 lease for a given IPv6 address.
virtual std::string getDescription() const override
Returns description of the backend.
virtual size_t wipeLeases6(const SubnetID &subnet_id) override
Removed specified IPv6 leases.
virtual bool deleteLease(const Lease4Ptr &lease) override
Deletes an IPv4 lease.
static std::string getDBVersion()
Local version of getDBVersion() class method.
virtual bool addLease(const Lease4Ptr &lease) override
Adds an IPv4 lease.
virtual uint64_t deleteExpiredReclaimedLeases6(const uint32_t secs) override
Deletes all expired-reclaimed DHCPv6 leases.
virtual std::string getType() const override
Return backend type.
virtual LeaseStatsQueryPtr startLeaseStatsQuery4() override
Creates and runs the IPv4 lease stats query.
virtual void rollback() override
Rollback Transactions.
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 Lease6Collection getLeases6() const override
Returns all IPv6 leases.
virtual void getExpiredLeases4(Lease4Collection &expired_leases, const size_t max_leases) const override
Returns a collection of expired DHCPv4 leases.
virtual void commit() override
Commit Transactions.
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID &subnet_id) override
Creates and runs the IPv6 lease stats query for a single subnet.
MySqlLeaseContextPtr createContext() const
Create a new context.
virtual void getExpiredLeases6(Lease6Collection &expired_leases, const size_t max_leases) const override
Returns a collection of expired DHCPv6 leases.
virtual void updateLease6(const Lease6Ptr &lease6) override
Updates IPv6 lease.
MySqlLeaseMgr(const db::DatabaseConnection::ParameterMap &parameters)
Constructor.
virtual std::string getName() const override
Returns backend name.
StatementIndex
Statement Tags.
virtual LeaseStatsQueryPtr startLeaseStatsQuery6() override
Creates and runs the IPv6 lease stats query.
virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress &addr) const override
Returns an IPv4 lease for specified IPv4 address.
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 updateLease4(const Lease4Ptr &lease4) override
Updates IPv4 lease.
virtual std::pair< uint32_t, uint32_t > getVersion() const override
Returns backend version.
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID &subnet_id) override
Creates and runs the IPv4 lease stats query for a single subnet.
virtual ~MySqlLeaseMgr()
Destructor (closes database)
virtual size_t wipeLeases4(const SubnetID &subnet_id) override
Removes specified IPv4 leases.
virtual Lease4Collection getLeases4() const override
Returns all IPv4 leases.
virtual uint64_t deleteExpiredReclaimedLeases4(const uint32_t secs) override
Deletes all expired-reclaimed DHCPv4 leases.
static bool dbReconnect(util::ReconnectCtlPtr db_reconnect_ctl)
Attempts to reconnect the server to the lease DB backend manager.
An abstract API for lease database.
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:27
boost::shared_ptr< IOServiceAccessor > IOServiceAccessorPtr
Pointer to an instance of IOServiceAccessor.
std::function< bool(util::ReconnectCtlPtr db_reconnect_ctl)> DbCallback
Defines a callback prototype for propagating events upward.
std::string ClientClass
Defines a single class name.
Definition: classify.h:42
boost::shared_ptr< Lease6 > Lease6Ptr
Pointer to a Lease6 structure.
Definition: lease.h:503
boost::shared_ptr< MySqlLeaseContextPool > MySqlLeaseContextPoolPtr
Type of pointers to context pools.
std::vector< Lease6Ptr > Lease6Collection
A collection of IPv6 leases.
Definition: lease.h:661
boost::shared_ptr< LeaseStatsQuery > LeaseStatsQueryPtr
Defines a pointer to a LeaseStatsQuery.
Definition: lease_mgr.h:208
uint32_t SubnetID
Defines unique IPv4 or IPv6 subnet identifier.
Definition: subnet_id.h:24
boost::shared_ptr< Lease > LeasePtr
Pointer to the lease object.
Definition: lease.h:22
std::vector< Lease4Ptr > Lease4Collection
A collection of IPv4 leases.
Definition: lease.h:498
boost::shared_ptr< Lease4 > Lease4Ptr
Pointer to a Lease4 structure.
Definition: lease.h:284
boost::shared_ptr< MySqlLeaseContext > MySqlLeaseContextPtr
Type of pointers to contexts.
boost::shared_ptr< ReconnectCtl > ReconnectCtlPtr
Pointer to an instance of ReconnectCtl.
Defines the logger used by the top-level component of kea-lfc.
Hardware type that represents information from DHCPv4 packet.
Definition: hwaddr.h:20
Type
Type of lease or pool.
Definition: lease.h:46
@ TYPE_V4
IPv4 lease.
Definition: lease.h:50