Kea  2.3.3-git
isc::dhcp::PgSqlLeaseMgr Class Reference

PostgreSQL Lease Manager. More...

#include <pgsql_lease_mgr.h>

+ Inheritance diagram for isc::dhcp::PgSqlLeaseMgr:

Public Types

enum  StatementIndex {
  DELETE_LEASE4, DELETE_LEASE4_STATE_EXPIRED, DELETE_LEASE6, DELETE_LEASE6_STATE_EXPIRED,
  GET_LEASE4, GET_LEASE4_ADDR, GET_LEASE4_CLIENTID, GET_LEASE4_CLIENTID_SUBID,
  GET_LEASE4_HWADDR, GET_LEASE4_HWADDR_SUBID, GET_LEASE4_PAGE, GET_LEASE4_SUBID,
  GET_LEASE4_HOSTNAME, GET_LEASE4_EXPIRE, GET_LEASE6, GET_LEASE6_ADDR,
  GET_LEASE6_DUID_IAID, GET_LEASE6_DUID_IAID_SUBID, GET_LEASE6_PAGE, GET_LEASE6_SUBID,
  GET_LEASE6_DUID, GET_LEASE6_HOSTNAME, GET_LEASE6_EXPIRE, INSERT_LEASE4,
  INSERT_LEASE6, UPDATE_LEASE4, UPDATE_LEASE6, ALL_LEASE4_STATS,
  SUBNET_LEASE4_STATS, SUBNET_RANGE_LEASE4_STATS, ALL_LEASE6_STATS, SUBNET_LEASE6_STATS,
  SUBNET_RANGE_LEASE6_STATS, CHECK_LEASE4_LIMITS, CHECK_LEASE6_LIMITS, IS_JSON_SUPPORTED,
  GET_LEASE4_COUNT_BY_CLASS, GET_LEASE6_COUNT_BY_CLASS, NUM_STATEMENTS
}
 Statement Tags. More...
 

Public Member Functions

 PgSqlLeaseMgr (const db::DatabaseConnection::ParameterMap &parameters)
 Constructor. More...
 
virtual ~PgSqlLeaseMgr ()
 Destructor (closes database) More...
 
virtual bool addLease (const Lease4Ptr &lease) override
 Adds an IPv4 lease. More...
 
virtual bool addLease (const Lease6Ptr &lease) override
 Adds an IPv6 lease. More...
 
virtual void commit () override
 Commit Transactions. More...
 
PgSqlLeaseContextPtr createContext () const
 Create a new context. More...
 
virtual uint64_t deleteExpiredReclaimedLeases4 (const uint32_t secs) override
 Deletes all expired-reclaimed DHCPv4 leases. More...
 
virtual uint64_t deleteExpiredReclaimedLeases6 (const uint32_t secs) override
 Deletes all expired-reclaimed DHCPv6 leases. More...
 
virtual bool deleteLease (const Lease4Ptr &lease) override
 Deletes an IPv4 lease. More...
 
virtual bool deleteLease (const Lease6Ptr &lease) override
 Deletes an IPv6 lease. More...
 
virtual std::string getDescription () const override
 Returns description of the backend. More...
 
virtual void getExpiredLeases4 (Lease4Collection &expired_leases, const size_t max_leases) const override
 Returns a collection of expired DHCPv4 leases. More...
 
virtual void getExpiredLeases6 (Lease6Collection &expired_leases, const size_t max_leases) const override
 Returns a collection of expired DHCPv6 leases. More...
 
virtual Lease4Ptr getLease4 (const isc::asiolink::IOAddress &addr) const override
 Returns an IPv4 lease for specified IPv4 address. More...
 
virtual Lease4Collection getLease4 (const isc::dhcp::HWAddr &hwaddr) const override
 Returns existing IPv4 leases for specified hardware address. More...
 
virtual Lease4Ptr getLease4 (const isc::dhcp::HWAddr &hwaddr, SubnetID subnet_id) const override
 Returns existing IPv4 leases for specified hardware address and a subnet. More...
 
virtual Lease4Collection getLease4 (const ClientId &clientid) const override
 Returns existing IPv4 leases for specified client-id. More...
 
virtual Lease4Ptr getLease4 (const ClientId &clientid, SubnetID subnet_id) const override
 Returns existing IPv4 lease for specified client-id. More...
 
virtual Lease6Ptr getLease6 (Lease::Type type, const isc::asiolink::IOAddress &addr) const override
 Returns existing IPv6 lease for a given IPv6 address. More...
 
virtual Lease4Collection getLeases4 (SubnetID subnet_id) const override
 Returns all IPv4 leases for the particular subnet identifier. More...
 
virtual Lease4Collection getLeases4 (const std::string &hostname) const override
 Returns all IPv4 leases for the particular hostname. More...
 
virtual Lease4Collection getLeases4 () const override
 Returns all IPv4 leases. More...
 
virtual Lease4Collection getLeases4 (const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size) const override
 Returns range of IPv4 leases using paging. More...
 
virtual Lease6Collection getLeases6 (Lease::Type type, const DUID &duid, uint32_t iaid) const override
 Returns existing IPv6 leases for a given DUID+IA combination. More...
 
virtual Lease6Collection getLeases6 (Lease::Type type, const DUID &duid, uint32_t iaid, SubnetID subnet_id) const override
 Returns existing IPv6 lease for a given DUID+IA combination. More...
 
virtual Lease6Collection getLeases6 (SubnetID subnet_id) const override
 Returns all IPv6 leases for the particular subnet identifier. More...
 
virtual Lease6Collection getLeases6 (const std::string &hostname) const override
 Returns all IPv6 leases for the particular hostname. More...
 
virtual Lease6Collection getLeases6 () const override
 Returns all IPv6 leases. More...
 
virtual Lease6Collection getLeases6 (const DUID &duid) const override
 Returns all IPv6 leases for the DUID. More...
 
virtual Lease6Collection getLeases6 (const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size) const override
 Returns range of IPv6 leases using paging. More...
 
virtual std::string getName () const override
 Returns backend name. More...
 
virtual std::string getType () const override
 Return backend type. More...
 
virtual std::pair< uint32_t, uint32_t > getVersion () const override
 Returns backend version. More...
 
virtual void rollback () override
 Rollback Transactions. More...
 
virtual LeaseStatsQueryPtr startLeaseStatsQuery4 () override
 Creates and runs the IPv4 lease stats query. More...
 
virtual LeaseStatsQueryPtr startLeaseStatsQuery6 () override
 Creates and runs the IPv6 lease stats query. More...
 
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4 (const SubnetID &subnet_id) override
 Creates and runs the IPv4 lease stats query for a single subnet. More...
 
virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6 (const SubnetID &subnet_id) override
 Creates and runs the IPv6 lease stats query for a single subnet. More...
 
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. More...
 
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. More...
 
virtual void updateLease4 (const Lease4Ptr &lease4) override
 Updates IPv4 lease. More...
 
virtual void updateLease6 (const Lease6Ptr &lease6) override
 Updates IPv6 lease. More...
 
virtual size_t wipeLeases4 (const SubnetID &subnet_id) override
 Removes specified IPv4 leases. More...
 
virtual size_t wipeLeases6 (const SubnetID &subnet_id) override
 Removed specified IPv6 leases. More...
 
- Public Member Functions inherited from isc::dhcp::LeaseMgr
 LeaseMgr ()
 Constructor. More...
 
virtual ~LeaseMgr ()
 Destructor. More...
 
bool getExtendedInfoTablesEnabled () const
 Returns the setting indicating if lease extended info tables are enabled. More...
 
Lease6Ptr getLease6 (Lease::Type type, const DUID &duid, uint32_t iaid, SubnetID subnet_id) const
 returns zero or one IPv6 lease for a given duid+iaid+subnet_id More...
 
void recountLeaseStats4 ()
 Recalculates per-subnet and global stats for IPv4 leases. More...
 
void recountLeaseStats6 ()
 Recalculates per-subnet and global stats for IPv6 leases. More...
 

Static Public Member Functions

static bool dbReconnect (util::ReconnectCtlPtr db_reconnect_ctl)
 Attempts to reconnect the server to the lease DB backend manager. More...
 
static std::string getDBVersion ()
 Local version of getDBVersion() class method. More...
 
- Static Public Member Functions inherited from isc::dhcp::LeaseMgr
static std::string getDBVersion ()
 Class method to return extended version info This class method must be redeclared and redefined in derived classes. More...
 
static isc::asiolink::IOServicePtrgetIOService ()
 Returns pointer to the IO service. More...
 
static void setIOService (const isc::asiolink::IOServicePtr &io_service)
 Sets IO service to be used by the Lease Manager. More...
 
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. More...
 
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. More...
 

Protected Member Functions

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. More...
 
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. More...
 
virtual void deleteExtendedInfo6 (const isc::asiolink::IOAddress &addr) override
 Delete lease6 extended info from tables. More...
 
virtual void setExtendedInfoTablesEnabled (const bool enabled) override
 Extended information / Bulk Lease Query shared interface. More...
 
virtual void setExtendedInfoTablesEnabled (const db::DatabaseConnection::ParameterMap &parameters) override
 Decode parameters to set whether the lease extended info tables are enabled. More...
 
- Protected Member Functions inherited from isc::dhcp::LeaseMgr
virtual bool addExtendedInfo6 (const Lease6Ptr &lease)
 Extract extended info from a lease6 and add it into tables. More...
 

Detailed Description

PostgreSQL Lease Manager.

This class provides the isc::dhcp::LeaseMgr interface to the PostgreSQL database. Use of this backend presupposes that a PostgreSQL database is available and that the Kea schema has been created within it.

Definition at line 91 of file pgsql_lease_mgr.h.

Member Enumeration Documentation

◆ StatementIndex

Statement Tags.

The contents of the enum are indexes into the list of compiled SQL statements

Enumerator
DELETE_LEASE4 
DELETE_LEASE4_STATE_EXPIRED 
DELETE_LEASE6 
DELETE_LEASE6_STATE_EXPIRED 
GET_LEASE4 
GET_LEASE4_ADDR 
GET_LEASE4_CLIENTID 
GET_LEASE4_CLIENTID_SUBID 
GET_LEASE4_HWADDR 
GET_LEASE4_HWADDR_SUBID 
GET_LEASE4_PAGE 
GET_LEASE4_SUBID 
GET_LEASE4_HOSTNAME 
GET_LEASE4_EXPIRE 
GET_LEASE6 
GET_LEASE6_ADDR 
GET_LEASE6_DUID_IAID 
GET_LEASE6_DUID_IAID_SUBID 
GET_LEASE6_PAGE 
GET_LEASE6_SUBID 
GET_LEASE6_DUID 
GET_LEASE6_HOSTNAME 
GET_LEASE6_EXPIRE 
INSERT_LEASE4 
INSERT_LEASE6 
UPDATE_LEASE4 
UPDATE_LEASE6 
ALL_LEASE4_STATS 
SUBNET_LEASE4_STATS 
SUBNET_RANGE_LEASE4_STATS 
ALL_LEASE6_STATS 
SUBNET_LEASE6_STATS 
SUBNET_RANGE_LEASE6_STATS 
CHECK_LEASE4_LIMITS 
CHECK_LEASE6_LIMITS 
IS_JSON_SUPPORTED 
GET_LEASE4_COUNT_BY_CLASS 
GET_LEASE6_COUNT_BY_CLASS 
NUM_STATEMENTS 

Definition at line 668 of file pgsql_lease_mgr.h.

Constructor & Destructor Documentation

◆ PgSqlLeaseMgr()

isc::dhcp::PgSqlLeaseMgr::PgSqlLeaseMgr ( const db::DatabaseConnection::ParameterMap parameters)

Constructor.

Uses the following keywords in the parameters passed to it to connect to the database:

  • name - Name of the database to which to connect (mandatory)
  • host - Host to which to connect (optional, defaults to "localhost")
  • user - Username under which to connect (optional)
  • password - Password for "user" on the database (optional)

Check the schema version and create an initial context.

Parameters
parametersA data structure relating keywords and values concerned with the database.
Exceptions
isc::dhcp::NoDatabaseNameMandatory database name not given
isc::db::DbOpenErrorError opening the database or the schema version is incorrect.
isc::db::DbOperationErrorAn operation on the open database has failed.

Definition at line 1260 of file pgsql_lease_mgr.cc.

References createContext(), isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_NO_TLS_SUPPORT, isc::dhcp::DHCPSRV_PGSQL_TLS_SUPPORT, getVersion(), isc_throw, LOG_ERROR, LOG_INFO, isc::db::PGSQL_SCHEMA_VERSION_MAJOR, isc::db::PGSQL_SCHEMA_VERSION_MINOR, isc::db::DatabaseConnection::redactedAccessString(), isc::dhcp::LeaseMgr::setExtendedInfoTablesEnabled(), and isc::db::PgSqlConnection::warned_about_tls.

+ Here is the call graph for this function:

◆ ~PgSqlLeaseMgr()

isc::dhcp::PgSqlLeaseMgr::~PgSqlLeaseMgr ( )
virtual

Destructor (closes database)

Definition at line 1310 of file pgsql_lease_mgr.cc.

Member Function Documentation

◆ addLease() [1/2]

bool isc::dhcp::PgSqlLeaseMgr::addLease ( const Lease4Ptr lease)
overridevirtual

Adds an IPv4 lease.

Parameters
leaselease to be added
Returns
true if the lease was added, false if not (because a lease with the same address was already there).
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1450 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_ADD_ADDR4, INSERT_LEASE4, and LOG_DEBUG.

◆ addLease() [2/2]

bool isc::dhcp::PgSqlLeaseMgr::addLease ( const Lease6Ptr lease)
overridevirtual

Adds an IPv6 lease.

Parameters
leaselease to be added
Returns
true if the lease was added, false if not (because a lease with the same address was already there).
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1470 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_ADD_ADDR6, isc::db::PsqlBindArray::formats_, INSERT_LEASE6, isc_throw, isc::db::PsqlBindArray::lengths_, LOG_DEBUG, and isc::db::PsqlBindArray::values_.

◆ addRelayId6()

void isc::dhcp::PgSqlLeaseMgr::addRelayId6 ( const isc::asiolink::IOAddress lease_addr,
const std::vector< uint8_t > &  relay_id 
)
overrideprotectedvirtual

Add lease6 extended info into by-relay-id table.

Parameters
lease_addrThe address of the lease.
relay_idThe relay id from the relay header options.

Implements isc::dhcp::LeaseMgr.

Definition at line 2573 of file pgsql_lease_mgr.cc.

References isc_throw.

◆ addRemoteId6()

void isc::dhcp::PgSqlLeaseMgr::addRemoteId6 ( const isc::asiolink::IOAddress lease_addr,
const std::vector< uint8_t > &  remote_id 
)
overrideprotectedvirtual

Add lease6 extended info into by-remote-id table.

Parameters
lease_addrThe address of the lease.
remote_idThe remote id from the relay header options.

Implements isc::dhcp::LeaseMgr.

Definition at line 2579 of file pgsql_lease_mgr.cc.

References isc_throw.

◆ commit()

void isc::dhcp::PgSqlLeaseMgr::commit ( )
overridevirtual

Commit Transactions.

Commits all pending database operations. On databases that don't support transactions, this is a no-op.

PostgreSQL supports transactions but this manager does not use them.

Implements isc::dhcp::LeaseMgr.

Definition at line 2558 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_COMMIT, and LOG_DEBUG.

◆ createContext()

PgSqlLeaseContextPtr isc::dhcp::PgSqlLeaseMgr::createContext ( ) const

Create a new context.

The database is opened with all the SQL commands pre-compiled.

Returns
A new (never null) context.
Exceptions
isc::dhcp::NoDatabaseNameMandatory database name not given.
isc::db::DbOperationErrorAn operation on the open database has failed.

Definition at line 1384 of file pgsql_lease_mgr.cc.

References dbReconnect(), isc::dhcp::LeaseMgr::getIOService(), isc_throw, and NUM_STATEMENTS.

Referenced by PgSqlLeaseMgr().

+ Here is the call graph for this function:

◆ dbReconnect()

bool isc::dhcp::PgSqlLeaseMgr::dbReconnect ( util::ReconnectCtlPtr  db_reconnect_ctl)
static

Attempts to reconnect the server to the lease DB backend manager.

This is a self-rescheduling function that attempts to reconnect to the server's lease DB backends after connectivity to one or more have been lost. Upon entry it will attempt to reconnect via LeaseMgrFactory::create. If this is successful, DHCP servicing is re-enabled and server returns to normal operation.

If reconnection fails and the maximum number of retries has not been exhausted, it will schedule a call to itself to occur at the configured retry interval. DHCP service remains disabled.

If the maximum number of retries has been exhausted an error is logged and the server shuts down.

This function is passed to the connection recovery mechanism. It will be invoked when a connection loss is detected.

Parameters
db_reconnect_ctlpointer to the ReconnectCtl containing the configured reconnect parameters.
Returns
true if connection has been recovered, false otherwise.

Definition at line 1314 of file pgsql_lease_mgr.cc.

References isc::dhcp::LeaseMgrFactory::create(), isc::dhcp::LeaseMgrFactory::destroy(), isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_LEASE_DB_RECONNECT_ATTEMPT_FAILED, isc::dhcp::DHCPSRV_PGSQL_LEASE_DB_RECONNECT_ATTEMPT_SCHEDULE, isc::dhcp::DHCPSRV_PGSQL_LEASE_DB_RECONNECT_FAILED, isc::dhcp::CfgMgr::getCurrentCfg(), isc::dhcp::TimerMgr::instance(), isc::dhcp::CfgMgr::instance(), isc::db::DatabaseConnection::invokeDbFailedCallback(), isc::db::DatabaseConnection::invokeDbLostCallback(), isc::db::DatabaseConnection::invokeDbRecoveredCallback(), LOG_ERROR, LOG_INFO, and isc::asiolink::IntervalTimer::ONE_SHOT.

Referenced by createContext().

+ Here is the call graph for this function:

◆ deleteExpiredReclaimedLeases4()

uint64_t isc::dhcp::PgSqlLeaseMgr::deleteExpiredReclaimedLeases4 ( const uint32_t  secs)
overridevirtual

Deletes all expired-reclaimed DHCPv4 leases.

Parameters
secsNumber of seconds since expiration of leases before they can be removed. Leases which have expired later than this time will not be deleted.
Returns
Number of leases deleted.

Implements isc::dhcp::LeaseMgr.

Definition at line 2285 of file pgsql_lease_mgr.cc.

References DELETE_LEASE4_STATE_EXPIRED, isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_DELETE_EXPIRED_RECLAIMED4, and LOG_DEBUG.

◆ deleteExpiredReclaimedLeases6()

uint64_t isc::dhcp::PgSqlLeaseMgr::deleteExpiredReclaimedLeases6 ( const uint32_t  secs)
overridevirtual

◆ deleteExtendedInfo6()

void isc::dhcp::PgSqlLeaseMgr::deleteExtendedInfo6 ( const isc::asiolink::IOAddress addr)
overrideprotectedvirtual

Delete lease6 extended info from tables.

Parameters
addrThe address of the lease.

Implements isc::dhcp::LeaseMgr.

Definition at line 2568 of file pgsql_lease_mgr.cc.

References isc_throw.

◆ deleteLease() [1/2]

bool isc::dhcp::PgSqlLeaseMgr::deleteLease ( const Lease4Ptr lease)
overridevirtual

Deletes an IPv4 lease.

Parameters
leaseIPv4 lease being deleted.
Returns
true if deletion was successful, false if no such lease exists.
Note
The current_cltt_ and current_valid_lft_ are used to maximize the chance that only one thread or process performs an update or delete operation on the lease by matching these values with the expiration time data in the database.
The DELETE query uses WHERE expire = ? to delete the lease only if the value matches the one received on the SELECT query, effectively enforcing no update on the lease between SELECT and DELETE with different expiration time.

Implements isc::dhcp::LeaseMgr.

Definition at line 2204 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::db::PgSqlExchange::convertToDatabaseTime(), DELETE_LEASE4, isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_DELETE_ADDR, isc::dhcp::Lease::INFINITY_LFT, isc_throw, LOG_DEBUG, isc::asiolink::IOAddress::toText(), and isc::asiolink::IOAddress::toUint32().

+ Here is the call graph for this function:

◆ deleteLease() [2/2]

bool isc::dhcp::PgSqlLeaseMgr::deleteLease ( const Lease6Ptr lease)
overridevirtual

Deletes an IPv6 lease.

Parameters
leaseIPv6 lease being deleted.
Returns
true if deletion was successful, false if no such lease exists.
Note
The current_cltt_ and current_valid_lft_ are used to maximize the chance that only one thread or process performs an update or delete operation on the lease by matching these values with the expiration time data in the database.
The DELETE query uses WHERE expire = ? to delete the lease only if the value matches the one received on the SELECT query, effectively enforcing no update on the lease between SELECT and DELETE with different expiration time.

Implements isc::dhcp::LeaseMgr.

Definition at line 2244 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::db::PgSqlExchange::convertToDatabaseTime(), DELETE_LEASE6, isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_DELETE_ADDR, isc::dhcp::Lease::INFINITY_LFT, isc_throw, LOG_DEBUG, and isc::asiolink::IOAddress::toText().

+ Here is the call graph for this function:

◆ getDBVersion()

◆ getDescription()

std::string isc::dhcp::PgSqlLeaseMgr::getDescription ( ) const
overridevirtual

Returns description of the backend.

This description may be multiline text that describes the backend.

Returns
Description of the backend.

Implements isc::dhcp::LeaseMgr.

Definition at line 2546 of file pgsql_lease_mgr.cc.

◆ getExpiredLeases4()

void isc::dhcp::PgSqlLeaseMgr::getExpiredLeases4 ( Lease4Collection expired_leases,
const size_t  max_leases 
) const
overridevirtual

Returns a collection of expired DHCPv4 leases.

This method returns at most max_leases expired leases. The leases returned haven't been reclaimed, i.e. the database query must exclude reclaimed leases from the results returned.

Parameters
[out]expired_leasesA container to which expired leases returned by the database backend are added.
max_leasesA maximum number of leases to be returned. If this value is set to 0, all expired (but not reclaimed) leases are returned.

Implements isc::dhcp::LeaseMgr.

Definition at line 2033 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_EXPIRED4, GET_LEASE4_EXPIRE, and LOG_DEBUG.

◆ getExpiredLeases6()

void isc::dhcp::PgSqlLeaseMgr::getExpiredLeases6 ( Lease6Collection expired_leases,
const size_t  max_leases 
) const
overridevirtual

Returns a collection of expired DHCPv6 leases.

This method returns at most max_leases expired leases. The leases returned haven't been reclaimed, i.e. the database query must exclude reclaimed leases from the results returned.

Parameters
[out]expired_leasesA container to which expired leases returned by the database backend are added.
max_leasesA maximum number of leases to be returned. If this value is set to 0, all expired (but not reclaimed) leases are returned.

Implements isc::dhcp::LeaseMgr.

Definition at line 2041 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::db::PgSqlExchange::convertToDatabaseTime(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_EXPIRED6, isc::db::PsqlBindArray::formats_, GET_LEASE6_EXPIRE, isc_throw, isc::db::PsqlBindArray::lengths_, LOG_DEBUG, isc::dhcp::Lease::STATE_EXPIRED_RECLAIMED, and isc::db::PsqlBindArray::values_.

+ Here is the call graph for this function:

◆ getLease4() [1/5]

Lease4Ptr isc::dhcp::PgSqlLeaseMgr::getLease4 ( const isc::asiolink::IOAddress addr) const
overridevirtual

Returns an IPv4 lease for specified IPv4 address.

This method return a lease that is associated with a given address. For other query types (by hardware addr, by Client ID) there can be several leases in different subnets (e.g. for mobile clients that got address in different subnets). However, for a single address there can be only one lease, so this method returns a pointer to a single lease, not a container of leases.

Parameters
addraddress of the searched lease
Returns
smart pointer to the lease (or NULL if a lease is not found)
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1563 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_ADDR4, GET_LEASE4_ADDR, LOG_DEBUG, isc::asiolink::IOAddress::toText(), and isc::asiolink::IOAddress::toUint32().

+ Here is the call graph for this function:

◆ getLease4() [2/5]

Lease4Collection isc::dhcp::PgSqlLeaseMgr::getLease4 ( const isc::dhcp::HWAddr hwaddr) const
overridevirtual

Returns existing IPv4 leases for specified hardware address.

Although in the usual case there will be only one lease, for mobile clients or clients with multiple static/fixed/reserved leases there can be more than one. Thus return type is a container, not a single pointer.

Parameters
hwaddrhardware address of the client
Returns
lease collection
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1587 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_HWADDR, GET_LEASE4_HWADDR, isc::dhcp::HWAddr::hwaddr_, LOG_DEBUG, and isc::dhcp::HWAddr::toText().

+ Here is the call graph for this function:

◆ getLease4() [3/5]

Lease4Ptr isc::dhcp::PgSqlLeaseMgr::getLease4 ( const isc::dhcp::HWAddr hwaddr,
SubnetID  subnet_id 
) const
overridevirtual

Returns existing IPv4 leases for specified hardware address and a subnet.

There can be at most one lease for a given HW address in a single pool, so this method with either return a single lease or NULL.

Parameters
hwaddrhardware address of the client
subnet_ididentifier of the subnet that lease must belong to
Returns
a pointer to the lease (or NULL if a lease is not found)
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1614 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_SUBID_HWADDR, GET_LEASE4_HWADDR_SUBID, isc::dhcp::HWAddr::hwaddr_, LOG_DEBUG, and isc::dhcp::HWAddr::toText().

+ Here is the call graph for this function:

◆ getLease4() [4/5]

Lease4Collection isc::dhcp::PgSqlLeaseMgr::getLease4 ( const ClientId clientid) const
overridevirtual

Returns existing IPv4 leases for specified client-id.

Although in the usual case there will be only one lease, for mobile clients or clients with multiple static/fixed/reserved leases there can be more than one. Thus return type is a container, not a single pointer.

Parameters
clientidclient identifier
Returns
lease collection
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1646 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_CLIENTID, GET_LEASE4_CLIENTID, isc::dhcp::ClientId::getClientId(), LOG_DEBUG, and isc::dhcp::ClientId::toText().

+ Here is the call graph for this function:

◆ getLease4() [5/5]

Lease4Ptr isc::dhcp::PgSqlLeaseMgr::getLease4 ( const ClientId clientid,
SubnetID  subnet_id 
) const
overridevirtual

Returns existing IPv4 lease for specified client-id.

There can be at most one lease for a given HW address in a single pool, so this method with either return a single lease or NULL.

Parameters
clientidclient identifier
subnet_ididentifier of the subnet that lease must belong to
Returns
a pointer to the lease (or NULL if a lease is not found)
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1669 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_SUBID_CLIENTID, GET_LEASE4_CLIENTID_SUBID, isc::dhcp::ClientId::getClientId(), LOG_DEBUG, and isc::dhcp::ClientId::toText().

+ Here is the call graph for this function:

◆ getLease6()

Lease6Ptr isc::dhcp::PgSqlLeaseMgr::getLease6 ( Lease::Type  type,
const isc::asiolink::IOAddress addr 
) const
overridevirtual

Returns existing IPv6 lease for a given IPv6 address.

For a given address, we assume that there will be only one lease. The assumption here is that there will not be site or link-local addresses used, so there is no way of having address duplication.

Parameters
typespecifies lease type: (NA, TA or PD)
addraddress of the searched lease
Returns
smart pointer to the lease (or NULL if a lease is not found)
Exceptions
isc::BadValuerecord retrieved from database had an invalid lease type field.
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1799 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_ADDR6, GET_LEASE6_ADDR, LOG_DEBUG, and isc::asiolink::IOAddress::toText().

+ Here is the call graph for this function:

◆ getLeases4() [1/4]

Lease4Collection isc::dhcp::PgSqlLeaseMgr::getLeases4 ( SubnetID  subnet_id) const
overridevirtual

Returns all IPv4 leases for the particular subnet identifier.

Parameters
subnet_idsubnet identifier.
Returns
Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1697 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_SUBID4, GET_LEASE4_SUBID, and LOG_DEBUG.

+ Here is the call graph for this function:

◆ getLeases4() [2/4]

Lease4Collection isc::dhcp::PgSqlLeaseMgr::getLeases4 ( const std::string &  hostname) const
overridevirtual

Returns all IPv4 leases for the particular hostname.

Parameters
hostnamehostname in lower case.
Returns
Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1721 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_HOSTNAME4, GET_LEASE4_HOSTNAME, and LOG_DEBUG.

+ Here is the call graph for this function:

◆ getLeases4() [3/4]

Lease4Collection isc::dhcp::PgSqlLeaseMgr::getLeases4 ( ) const
overridevirtual

Returns all IPv4 leases.

Returns
Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1744 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET4, GET_LEASE4, and LOG_DEBUG.

◆ getLeases4() [4/4]

Lease4Collection isc::dhcp::PgSqlLeaseMgr::getLeases4 ( const asiolink::IOAddress lower_bound_address,
const LeasePageSize page_size 
) const
overridevirtual

Returns range of IPv4 leases using paging.

This method implements paged browsing of the lease database. The first parameter specifies a page size. The second parameter is optional and specifies the starting address of the range. This address is excluded from the returned range. The IPv4 zero address (default) denotes that the first page should be returned. There is no guarantee about the order of returned leases.

The typical usage of this method is as follows:

  • Get the first page of leases by specifying IPv4 zero address as the beginning of the range.
  • Last address of the returned range should be used as a starting address for the next page in the subsequent call.
  • If the number of leases returned is lower than the page size, it indicates that the last page has been retrieved.
  • If there are no leases returned it indicates that the previous page was the last page.
Parameters
lower_bound_addressIPv4 address used as lower bound for the returned range.
page_sizemaximum size of the page returned.
Returns
Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1762 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_PAGE4, GET_LEASE4_PAGE, isc_throw, isc::asiolink::IOAddress::isV4(), LOG_DEBUG, isc::dhcp::LeasePageSize::page_size_, isc::asiolink::IOAddress::toText(), and isc::asiolink::IOAddress::toUint32().

+ Here is the call graph for this function:

◆ getLeases6() [1/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( Lease::Type  type,
const DUID duid,
uint32_t  iaid 
) const
overridevirtual

Returns existing IPv6 leases for a given DUID+IA combination.

Although in the usual case there will be only one lease, for mobile clients or clients with multiple static/fixed/reserved leases there can be more than one. Thus return type is a container, not a single pointer.

Parameters
typespecifies lease type: (NA, TA or PD)
duidclient DUID
iaidIA identifier
Returns
smart pointer to the lease (or NULL if a lease is not found)
Exceptions
isc::BadValuerecord retrieved from database had an invalid lease type field.
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1829 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::PgSqlLease6Exchange::Uiaid::dbInputString(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_IAID_DUID, GET_LEASE6_DUID_IAID, isc::dhcp::DUID::getDuid(), LOG_DEBUG, and isc::dhcp::DUID::toText().

+ Here is the call graph for this function:

◆ getLeases6() [2/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( Lease::Type  type,
const DUID duid,
uint32_t  iaid,
SubnetID  subnet_id 
) const
overridevirtual

Returns existing IPv6 lease for a given DUID+IA combination.

Parameters
typespecifies lease type: (NA, TA or PD)
duidclient DUID
iaidIA identifier
subnet_idsubnet id of the subnet the lease belongs to
Returns
lease collection (may be empty if no lease is found)
Exceptions
isc::BadValuerecord retrieved from database had an invalid lease type field.
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1863 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::PgSqlLease6Exchange::Uiaid::dbInputString(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_IAID_SUBID_DUID, GET_LEASE6_DUID_IAID_SUBID, isc::dhcp::DUID::getDuid(), LOG_DEBUG, and isc::dhcp::DUID::toText().

+ Here is the call graph for this function:

◆ getLeases6() [3/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( SubnetID  subnet_id) const
overridevirtual

Returns all IPv6 leases for the particular subnet identifier.

Parameters
subnet_idsubnet identifier.
Returns
Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1902 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_SUBID6, GET_LEASE6_SUBID, and LOG_DEBUG.

+ Here is the call graph for this function:

◆ getLeases6() [4/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( const std::string &  hostname) const
overridevirtual

Returns all IPv6 leases for the particular hostname.

Parameters
hostnamehostname in lower case.
Returns
Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1948 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_HOSTNAME6, GET_LEASE6_HOSTNAME, and LOG_DEBUG.

+ Here is the call graph for this function:

◆ getLeases6() [5/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( ) const
overridevirtual

Returns all IPv6 leases.

Returns
Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1971 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET6, GET_LEASE6, and LOG_DEBUG.

◆ getLeases6() [6/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( const DUID duid) const
overridevirtual

Returns all IPv6 leases for the DUID.

Todo:
: implement an optimised of the query using index.
Returns
Lease collection (may be empty if no IPv6 lease found) for the DUID.

Implements isc::dhcp::LeaseMgr.

Definition at line 1926 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_DUID, GET_LEASE6_DUID, isc::dhcp::DUID::getDuid(), LOG_DEBUG, and isc::dhcp::DUID::toText().

+ Here is the call graph for this function:

◆ getLeases6() [7/7]

Lease6Collection isc::dhcp::PgSqlLeaseMgr::getLeases6 ( const asiolink::IOAddress lower_bound_address,
const LeasePageSize page_size 
) const
overridevirtual

Returns range of IPv6 leases using paging.

This method implements paged browsing of the lease database. The first parameter specifies a page size. The second parameter is optional and specifies the starting address of the range. This address is excluded from the returned range. The IPv6 zero address (default) denotes that the first page should be returned. There is no guarantee about the order of returned leases.

The typical usage of this method is as follows:

  • Get the first page of leases by specifying IPv6 zero address as the beginning of the range.
  • Last address of the returned range should be used as a starting address for the next page in the subsequent call.
  • If the number of leases returned is lower than the page size, it indicates that the last page has been retrieved.
  • If there are no leases returned it indicates that the previous page was the last page.
Parameters
lower_bound_addressIPv6 address used as lower bound for the returned range.
page_sizemaximum size of the page returned.
Returns
Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 1989 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_PAGE6, GET_LEASE6_PAGE, isc_throw, isc::asiolink::IOAddress::isV6(), isc::asiolink::IOAddress::isV6Zero(), LOG_DEBUG, isc::dhcp::LeasePageSize::page_size_, and isc::asiolink::IOAddress::toText().

+ Here is the call graph for this function:

◆ getName()

std::string isc::dhcp::PgSqlLeaseMgr::getName ( ) const
overridevirtual

Returns backend name.

Each backend have specific name.

Returns
Name of the backend.

Implements isc::dhcp::LeaseMgr.

Definition at line 2531 of file pgsql_lease_mgr.cc.

◆ getType()

virtual std::string isc::dhcp::PgSqlLeaseMgr::getType ( ) const
inlineoverridevirtual

Return backend type.

Returns the type of the backend (e.g. "mysql", "memfile" etc.)

Returns
Type of the backend.

Implements isc::dhcp::LeaseMgr.

Definition at line 621 of file pgsql_lease_mgr.h.

◆ getVersion()

std::pair< uint32_t, uint32_t > isc::dhcp::PgSqlLeaseMgr::getVersion ( ) const
overridevirtual

Returns backend version.

Returns
Version number as a pair of unsigned integers. "first" is the major version number, "second" the minor number.
Exceptions
isc::db::DbOperationErrorAn operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2551 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_GET_VERSION, isc::db::PgSqlConnection::getVersion(), and LOG_DEBUG.

Referenced by PgSqlLeaseMgr().

+ Here is the call graph for this function:

◆ rollback()

void isc::dhcp::PgSqlLeaseMgr::rollback ( )
overridevirtual

Rollback Transactions.

Rolls back all pending database operations. On databases that don't support transactions, this is a no-op.

PostgreSQL supports transactions but this manager does not use them.

Implements isc::dhcp::LeaseMgr.

Definition at line 2563 of file pgsql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_ROLLBACK, and LOG_DEBUG.

◆ setExtendedInfoTablesEnabled() [1/2]

virtual void isc::dhcp::PgSqlLeaseMgr::setExtendedInfoTablesEnabled ( const bool  enabled)
inlineoverrideprotectedvirtual

Extended information / Bulk Lease Query shared interface.

Modifies the setting whether the lease extended info tables are enabled.

Transient redefine to refuse the enable setting.

Parameters
enablednew setting.

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 1114 of file pgsql_lease_mgr.h.

References isc_throw.

◆ setExtendedInfoTablesEnabled() [2/2]

void isc::dhcp::PgSqlLeaseMgr::setExtendedInfoTablesEnabled ( const db::DatabaseConnection::ParameterMap parameters)
overrideprotectedvirtual

Decode parameters to set whether the lease extended info tables are enabled.

Note
: common code in constructors.
Parameters
parametersThe parameter map.

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 1254 of file pgsql_lease_mgr.cc.

References isc_throw.

◆ startLeaseStatsQuery4()

LeaseStatsQueryPtr isc::dhcp::PgSqlLeaseMgr::startLeaseStatsQuery4 ( )
overridevirtual

Creates and runs the IPv4 lease stats query.

It creates an instance of a PgSqlLeaseStatsQuery4 and then invokes its start method, which fetches its statistical data result set by executing the ALL_LEASE_STATS4 query. The query object is then returned.

Returns
The populated query as a pointer to an LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2435 of file pgsql_lease_mgr.cc.

References ALL_LEASE4_STATS.

◆ startLeaseStatsQuery6()

LeaseStatsQueryPtr isc::dhcp::PgSqlLeaseMgr::startLeaseStatsQuery6 ( )
overridevirtual

Creates and runs the IPv6 lease stats query.

It creates an instance of a PgSqlLeaseStatsQuery and then invokes its start method, which fetches its statistical data result set by executing the ALL_LEASE_STATS6 query. The query object is then returned.

Returns
The populated query as a pointer to an LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2478 of file pgsql_lease_mgr.cc.

References ALL_LEASE6_STATS.

◆ startSubnetLeaseStatsQuery4()

LeaseStatsQueryPtr isc::dhcp::PgSqlLeaseMgr::startSubnetLeaseStatsQuery4 ( const SubnetID subnet_id)
overridevirtual

Creates and runs the IPv4 lease stats query for a single subnet.

It creates an instance of a PgSqlLeaseStatsQuery4 for a single subnet query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters
subnet_idid of the subnet for which stats are desired
Returns
A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2448 of file pgsql_lease_mgr.cc.

References SUBNET_LEASE4_STATS.

◆ startSubnetLeaseStatsQuery6()

LeaseStatsQueryPtr isc::dhcp::PgSqlLeaseMgr::startSubnetLeaseStatsQuery6 ( const SubnetID subnet_id)
overridevirtual

Creates and runs the IPv6 lease stats query for a single subnet.

It creates an instance of a PgSqlLeaseStatsQuery6 for a single subnet query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters
subnet_idid of the subnet for which stats are desired
Returns
A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2491 of file pgsql_lease_mgr.cc.

References SUBNET_LEASE6_STATS.

◆ startSubnetRangeLeaseStatsQuery4()

LeaseStatsQueryPtr isc::dhcp::PgSqlLeaseMgr::startSubnetRangeLeaseStatsQuery4 ( const SubnetID first_subnet_id,
const SubnetID last_subnet_id 
)
overridevirtual

Creates and runs the IPv4 lease stats query for a single subnet.

It creates an instance of a PgSqlLeaseStatsQuery4 for a subnet range query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters
first_subnet_idfirst subnet in the range of subnets
last_subnet_idlast subnet in the range of subnets
Returns
A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2462 of file pgsql_lease_mgr.cc.

References SUBNET_RANGE_LEASE4_STATS.

◆ startSubnetRangeLeaseStatsQuery6()

LeaseStatsQueryPtr isc::dhcp::PgSqlLeaseMgr::startSubnetRangeLeaseStatsQuery6 ( const SubnetID first_subnet_id,
const SubnetID last_subnet_id 
)
overridevirtual

Creates and runs the IPv6 lease stats query for a single subnet.

It creates an instance of a PgSqlLeaseStatsQuery6 for a subnet range query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters
first_subnet_idfirst subnet in the range of subnets
last_subnet_idlast subnet in the range of subnets
Returns
A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2505 of file pgsql_lease_mgr.cc.

References SUBNET_RANGE_LEASE6_STATS.

◆ updateLease4()

void isc::dhcp::PgSqlLeaseMgr::updateLease4 ( const Lease4Ptr lease4)
overridevirtual

Updates IPv4 lease.

Updates the record of the lease in the database (as identified by the address) with the data in the passed lease object.

Parameters
lease4The lease to be updated.
Exceptions
isc::dhcp::NoSuchLeaseAttempt to update a lease that did not exist.
isc::db::DbOperationErrorAn operation on the open database has failed.
Note
The current_cltt_ and current_valid_lft_ are used to maximize the chance that only one thread or process performs an update or delete operation on the lease by matching these values with the expiration time data in the database.
The UPDATE query uses WHERE expire = ? to update the lease only if the value matches the one received on the SELECT query, effectively enforcing no update on the lease between SELECT and UPDATE with different expiration time.

Implements isc::dhcp::LeaseMgr.

Definition at line 2112 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::db::PgSqlExchange::convertToDatabaseTime(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_UPDATE_ADDR4, isc::dhcp::Lease::INFINITY_LFT, LOG_DEBUG, and UPDATE_LEASE4.

+ Here is the call graph for this function:

◆ updateLease6()

void isc::dhcp::PgSqlLeaseMgr::updateLease6 ( const Lease6Ptr lease6)
overridevirtual

Updates IPv6 lease.

Updates the record of the lease in the database (as identified by the address) with the data in the passed lease object.

Parameters
lease6The lease to be updated.
Exceptions
isc::dhcp::NoSuchLeaseAttempt to update a lease that did not exist.
isc::db::DbOperationErrorAn operation on the open database has failed.
Note
The current_cltt_ and current_valid_lft_ are used to maximize the chance that only one thread or process performs an update or delete operation on the lease by matching these values with the expiration time data in the database.
The UPDATE query uses WHERE expire = ? to update the lease only if the value matches the one received on the SELECT query, effectively enforcing no update on the lease between SELECT and UPDATE with different expiration time.

Implements isc::dhcp::LeaseMgr.

Definition at line 2148 of file pgsql_lease_mgr.cc.

References isc::db::PsqlBindArray::add(), isc::db::PgSqlExchange::convertToDatabaseTime(), isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_PGSQL_UPDATE_ADDR6, isc::db::PsqlBindArray::formats_, isc::dhcp::Lease::INFINITY_LFT, isc::db::PsqlBindArray::lengths_, LOG_DEBUG, isc::db::PsqlBindArray::toText(), UPDATE_LEASE6, and isc::db::PsqlBindArray::values_.

+ Here is the call graph for this function:

◆ wipeLeases4()

size_t isc::dhcp::PgSqlLeaseMgr::wipeLeases4 ( const SubnetID subnet_id)
overridevirtual

Removes specified IPv4 leases.

This rather dangerous method is able to remove all leases from specified subnet.

Todo:
: Not implemented yet.
Parameters
subnet_ididentifier of the subnet
Returns
number of leases removed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2521 of file pgsql_lease_mgr.cc.

References isc_throw.

◆ wipeLeases6()

size_t isc::dhcp::PgSqlLeaseMgr::wipeLeases6 ( const SubnetID subnet_id)
overridevirtual

Removed specified IPv6 leases.

This rather dangerous method is able to remove all leases from specified subnet.

Todo:
: Not implemented yet.
Parameters
subnet_ididentifier of the subnet
Returns
number of leases removed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2526 of file pgsql_lease_mgr.cc.

References isc_throw.


The documentation for this class was generated from the following files: