pgsql_lease_mgr.h

Go to the documentation of this file.

// Copyright (C) 2013-2024 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 PGSQL_LEASE_MGR_H
#define PGSQL_LEASE_MGR_H
 
#include <asiolink/io_service.h>
#include <dhcp/hwaddr.h>
#include <dhcpsrv/dhcpsrv_exceptions.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/tracking_lease_mgr.h>
#include <pgsql/pgsql_connection.h>
#include <pgsql/pgsql_exchange.h>
 
#include <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
 
#include <vector>
#include <mutex>
 
namespace isc {
namespace dhcp {
 
// Forward declaration of the Lease exchange objects.  These classes are defined
// in the .cc file.
class PgSqlLease4Exchange;
class PgSqlLease6Exchange;

class PgSqlLeaseContext {
public:

    PgSqlLeaseContext(const db::DatabaseConnection::ParameterMap& parameters,
                      db::IOServiceAccessorPtr io_service_accessor,
                      db::DbCallback db_reconnect_callback);

    boost::scoped_ptr<PgSqlLease4Exchange> exchange4_; 
    boost::scoped_ptr<PgSqlLease6Exchange> exchange6_; 

    db::PgSqlConnection conn_;
};

typedef boost::shared_ptr<PgSqlLeaseContext> PgSqlLeaseContextPtr;

class PgSqlLeaseContextPool {
public:

    std::vector<PgSqlLeaseContextPtr> pool_;

    std::mutex mutex_;
};

typedef boost::shared_ptr<PgSqlLeaseContextPool> PgSqlLeaseContextPoolPtr;

 
class PgSqlLeaseMgr : public TrackingLeaseMgr {
public:

    PgSqlLeaseMgr(const db::DatabaseConnection::ParameterMap& parameters);

    virtual ~PgSqlLeaseMgr();

    PgSqlLeaseContextPtr createContext() const;

    static bool dbReconnect(util::ReconnectCtlPtr db_reconnect_ctl);

    static std::string getDBVersion();

    virtual bool addLease(const Lease4Ptr& lease) override;

    virtual bool addLease(const Lease6Ptr& lease) override;

    virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr) const override;

    virtual Lease4Collection getLease4(const isc::dhcp::HWAddr& hwaddr) const override;

    virtual Lease4Ptr getLease4(const isc::dhcp::HWAddr& hwaddr,
                                SubnetID subnet_id) const override;

    virtual Lease4Collection getLease4(const ClientId& clientid) const override;

    virtual Lease4Ptr getLease4(const ClientId& clientid,
                                SubnetID subnet_id) const override;

    virtual Lease4Collection getLeases4(SubnetID subnet_id) const override;

    virtual Lease4Collection getLeases4(const std::string& hostname) const override;

    virtual Lease4Collection getLeases4() const override;

    virtual Lease4Collection
    getLeases4(const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const override;

    virtual Lease6Ptr getLease6(Lease::Type type,
                                const isc::asiolink::IOAddress& addr) const override;

    virtual Lease6Collection getLeases6(Lease::Type type, const DUID& duid,
                                        uint32_t iaid) const override;

    virtual Lease6Collection getLeases6(Lease::Type type, const DUID& duid,
                                        uint32_t iaid, SubnetID subnet_id) const override;

    virtual Lease6Collection getLeases6(SubnetID subnet_id) const override;

    virtual Lease6Collection getLeases6(const std::string& hostname) const override;

    virtual Lease6Collection getLeases6() const override;

    virtual Lease6Collection getLeases6(const DUID& duid) const override;

    virtual Lease6Collection
    getLeases6(const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const override;

    virtual Lease6Collection
    getLeases6(SubnetID subnet_id,
               const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const override;

    virtual void getExpiredLeases4(Lease4Collection& expired_leases,
                                   const size_t max_leases) const override;

    virtual void getExpiredLeases6(Lease6Collection& expired_leases,
                                   const size_t max_leases) const override;

    virtual void updateLease4(const Lease4Ptr& lease4) override;

    virtual void updateLease6(const Lease6Ptr& lease6) override;

    virtual bool deleteLease(const Lease4Ptr& lease) override;

    virtual bool deleteLease(const Lease6Ptr& lease) override;

    virtual uint64_t deleteExpiredReclaimedLeases4(const uint32_t secs) override;

    virtual uint64_t deleteExpiredReclaimedLeases6(const uint32_t secs) override;

    virtual LeaseStatsQueryPtr startLeaseStatsQuery4() override;

    virtual LeaseStatsQueryPtr startPoolLeaseStatsQuery4() override;

    virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID& subnet_id) override;

    virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery4(const SubnetID& first_subnet_id,
                                                                const SubnetID& last_subnet_id) override;

    virtual LeaseStatsQueryPtr startLeaseStatsQuery6() override;

    virtual LeaseStatsQueryPtr startPoolLeaseStatsQuery6() override;

    virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID& subnet_id) override;

    virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery6(const SubnetID& first_subnet_id,
                                                                const SubnetID& last_subnet_id) override;

    virtual size_t wipeLeases4(const SubnetID& subnet_id) override;

    virtual size_t wipeLeases6(const SubnetID& subnet_id) override;

    virtual std::string getType() const override {
        return (std::string("postgresql"));
    }

    virtual std::string getName() const override;

    virtual std::string getDescription() const override;

    virtual std::pair<uint32_t, uint32_t> getVersion(const std::string& timer_name = std::string()) const override;

    virtual void commit() override;

    virtual void rollback() override;

    enum StatementIndex {
        DELETE_LEASE4,               // Delete from lease4 by address
        DELETE_LEASE4_STATE_EXPIRED, // Delete expired lease4 in a given state
        DELETE_LEASE6,               // Delete from lease6 by address
        DELETE_LEASE6_STATE_EXPIRED, // Delete expired lease6 in a given state
        GET_LEASE4,                  // Get all IPv4 leases
        GET_LEASE4_ADDR,             // Get lease4 by address
        GET_LEASE4_CLIENTID,         // Get lease4 by client ID
        GET_LEASE4_CLIENTID_SUBID,   // Get lease4 by client ID & subnet ID
        GET_LEASE4_HWADDR,           // Get lease4 by HW address
        GET_LEASE4_HWADDR_SUBID,     // Get lease4 by HW address & subnet ID
        GET_LEASE4_PAGE,             // Get page of leases beginning with an address
        GET_LEASE4_UCTX_PAGE,        // Get page of leases with user context
        GET_LEASE4_SUBID,            // Get IPv4 leases by subnet ID
        GET_LEASE4_HOSTNAME,         // Get IPv4 leases by hostname
        GET_LEASE4_EXPIRE,           // Get lease4 by expiration.
        GET_LEASE4_RELAYID,          // Get page of lease by relay ID.
        GET_LEASE4_RELAYID_QST,      // Get page of leases by relay ID and query start time.
        GET_LEASE4_RELAYID_QSET,     // Get page of leases by relay ID and query start and end times.
        GET_LEASE4_RELAYID_QET,      // Get page of leases by relay ID and query end time.
        GET_LEASE4_REMOTEID,         // Get page of lease by remote ID.
        GET_LEASE4_REMOTEID_QST,     // Get page of leases by remote ID and query start time.
        GET_LEASE4_REMOTEID_QSET,    // Get page of leases by remote ID and query start and end times.
        GET_LEASE4_REMOTEID_QET,     // Get page of leases by remote ID and query end time.
        GET_LEASE6,                  // Get all IPv6 leases
        GET_LEASE6_ADDR,             // Get lease6 by address and type
        GET_LEASE6_DUID_IAID,        // Get lease6 by DUID and IAID
        GET_LEASE6_DUID_IAID_SUBID,  // Get lease6 by DUID, IAID and subnet ID
        GET_LEASE6_PAGE,             // Get page of leases beginning with an address
        GET_LEASE6_UCTX_PAGE,        // Get page of leases with user context
        GET_LEASE6_SUBID,            // Get IPv6 leases by subnet ID
        GET_LEASE6_SUBID_PAGE,       // Get page of IPv6 lease by subnet ID
        GET_LEASE6_DUID,             // Get IPv6 leases by DUID
        GET_LEASE6_HOSTNAME,         // Get IPv6 leases by hostname
        GET_LEASE6_EXPIRE,           // Get lease6 by expiration.
        INSERT_LEASE4,               // Add entry to lease4 table
        INSERT_LEASE6,               // Add entry to lease6 table
        UPDATE_LEASE4,               // Update a Lease4 entry
        UPDATE_LEASE6,               // Update a Lease6 entry
        ALL_LEASE4_STATS,            // Fetches IPv4 lease statistics
        SUBNET_LEASE4_STATS,         // Fetched IPv4 lease stats for a single subnet.
        SUBNET_RANGE_LEASE4_STATS,   // Fetched IPv4 lease stats for a subnet range.
        ALL_POOL_LEASE4_STATS,       // Fetches IPv4 lease pool statistics
        ALL_LEASE6_STATS,            // Fetches IPv6 lease statistics
        SUBNET_LEASE6_STATS,         // Fetched IPv6 lease stats for a single subnet.
        SUBNET_RANGE_LEASE6_STATS,   // Fetched IPv6 lease stats for a subnet range.
        ALL_POOL_LEASE6_STATS,       // Fetches IPv6 lease pool statistics
        CHECK_LEASE4_LIMITS,         // Check if allocated IPv4 leases are inside the set limits.
        CHECK_LEASE6_LIMITS,         // Check if allocated IPv6 leases are inside the set limits.
        IS_JSON_SUPPORTED,           // Checks if JSON support is enabled in the database.
        GET_LEASE4_COUNT_BY_CLASS,   // Fetches the IPv4 lease count for a given class.
        GET_LEASE6_COUNT_BY_CLASS,   // Fetches the IPv6 lease count for given class and lease type.
        WIPE_RELAY_ID6,              // Wipe the lease6_relay_id table
        WIPE_REMOTE_ID6,             // Wipe the lease6_remote_id table
        DELETE_RELAY_ID6,            // Delete a lease6_relay_id entry by address
        DELETE_REMOTE_ID6,           // Delete a lease6_remote_id entry by address
        ADD_RELAY_ID6,               // Add a lease6_relay_id entry
        ADD_REMOTE_ID6,              // Add a lease6_remote_id entry
        GET_RELAY_ID6,               // Get lease6_relay_id entries
        GET_REMOTE_ID6,              // Get lease6_remote_id entries
        COUNT_RELAY_ID6,             // Count the lease6_relay_id number of entries
        COUNT_REMOTE_ID6,            // Count the lease6_remote_id number of entries
        NUM_STATEMENTS               // Number of statements
    };
 
private:

    bool addLeaseCommon(PgSqlLeaseContextPtr& ctx,
                        StatementIndex stindex,
                        db::PsqlBindArray& bind_array);

    template <typename Exchange, typename LeaseCollection>
    void getLeaseCollection(PgSqlLeaseContextPtr& ctx,
                            StatementIndex stindex,
                            db::PsqlBindArray& bind_array,
                            Exchange& exchange, LeaseCollection& result,
                            bool single = false) const;

    void getLeaseCollection(PgSqlLeaseContextPtr& ctx,
                            StatementIndex stindex,
                            db::PsqlBindArray& bind_array,
                            Lease4Collection& result) const {
        getLeaseCollection(ctx, stindex, bind_array, ctx->exchange4_, result);
    }

    void getLeaseCollection(PgSqlLeaseContextPtr& ctx,
                            StatementIndex stindex,
                            db::PsqlBindArray& bind_array,
                            Lease6Collection& result) const {
        getLeaseCollection(ctx, stindex, bind_array, ctx->exchange6_, result);
    }

    void getLease(PgSqlLeaseContextPtr& ctx,
                  StatementIndex stindex,
                  db::PsqlBindArray& bind_array,
                  Lease4Ptr& result) const;

    void getLease(PgSqlLeaseContextPtr& ctx,
                  StatementIndex stindex,
                  db::PsqlBindArray& bind_array,
                  Lease6Ptr& result) const;

    template<typename LeaseCollection>
    void getExpiredLeasesCommon(LeaseCollection& expired_leases,
                                const size_t max_leases,
                                StatementIndex statement_index) const;

    template <typename LeasePtr>
    void updateLeaseCommon(PgSqlLeaseContextPtr& ctx,
                           StatementIndex stindex,
                           db::PsqlBindArray& bind_array,
                           const LeasePtr& lease);

    uint64_t deleteLeaseCommon(PgSqlLeaseContextPtr& ctx,
                               StatementIndex stindex,
                               db::PsqlBindArray& bind_array);

    uint64_t deleteExpiredReclaimedLeasesCommon(const uint32_t secs,
                                                StatementIndex statement_index);

    std::string
    checkLimits(isc::data::ConstElementPtr const& user_context, StatementIndex const stindex) const;
 
public:
    virtual std::string
    checkLimits4(isc::data::ConstElementPtr const& user_context) const override;

    virtual std::string
    checkLimits6(isc::data::ConstElementPtr const& user_context) const override;

    virtual bool isJsonSupported() const override;

    virtual size_t getClassLeaseCount(const ClientClass& client_class,
                                      const Lease::Type& ltype = Lease::TYPE_V4) const override;

    virtual void recountClassLeases4() override;

    virtual void recountClassLeases6() override;

    virtual void clearClassLeaseCounts() override;


    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;

    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;

    virtual Lease6Collection
    getLeases6ByRelayId(const DUID& relay_id,
                        const asiolink::IOAddress& lower_bound_address,
                        const LeasePageSize& page_size) override;

    virtual Lease6Collection
    getLeases6ByRemoteId(const OptionBuffer& remote_id,
                         const asiolink::IOAddress& lower_bound_address,
                         const LeasePageSize& page_size) override;

    virtual size_t upgradeExtendedInfo4(const LeasePageSize& page_size) override;

    virtual size_t upgradeExtendedInfo6(const LeasePageSize& page_size) override;

    virtual void wipeExtendedInfoTables6() override;

    virtual size_t byRelayId6size() const override;

    virtual size_t byRemoteId6size() const override;

    virtual void writeLeases4(const std::string& /*filename*/) override;

    virtual void writeLeases6(const std::string& /*filename*/) override;
 
private:
    class PgSqlLeaseContextAlloc {
    public:

        PgSqlLeaseContextAlloc(const PgSqlLeaseMgr& mgr);

        ~PgSqlLeaseContextAlloc();

        PgSqlLeaseContextPtr ctx_;
 
    private:

        const PgSqlLeaseMgr& mgr_;
    };

    class PgSqlLeaseTrackingContextAlloc {
    public:

        PgSqlLeaseTrackingContextAlloc(PgSqlLeaseMgr& mgr, const LeasePtr& lease);

        ~PgSqlLeaseTrackingContextAlloc();

        PgSqlLeaseContextPtr ctx_;
 
    private:

        PgSqlLeaseMgr& mgr_;

        LeasePtr lease_;
    };
 
protected:


    virtual void deleteExtendedInfo6(const isc::asiolink::IOAddress& addr) override;

    virtual void addRelayId6(const isc::asiolink::IOAddress& lease_addr,
                             const std::vector<uint8_t>& relay_id) override;

    virtual void addRemoteId6(const isc::asiolink::IOAddress& lease_addr,
                              const std::vector<uint8_t>& remote_id) override;
 
private:
    void deleteRelayId6(const isc::asiolink::IOAddress& addr);

    void deleteRemoteId6(const isc::asiolink::IOAddress& addr);
 
    // Members

    db::DatabaseConnection::ParameterMap parameters_;

    PgSqlLeaseContextPoolPtr pool_;

    std::string timer_name_;
};
 
}  // namespace dhcp
}  // namespace isc
 
#endif // PGSQL_LEASE_MGR_H