Kea  2.1.7-git
isc::dhcp::MySqlHostDataSourceImpl Class Reference

Implementation of the MySqlHostDataSource. More...

Public Types

enum  StatementIndex {
  GET_HOST_DHCPID, GET_HOST_ADDR, GET_HOST_SUBID4_DHCPID, GET_HOST_SUBID6_DHCPID,
  GET_HOST_SUBID_ADDR, GET_HOST_PREFIX, GET_HOST_SUBID6_ADDR, GET_HOST_SUBID4,
  GET_HOST_SUBID6, GET_HOST_HOSTNAME, GET_HOST_HOSTNAME_SUBID4, GET_HOST_HOSTNAME_SUBID6,
  GET_HOST_SUBID4_PAGE, GET_HOST_SUBID6_PAGE, GET_HOST_PAGE4, GET_HOST_PAGE6,
  INSERT_HOST_NON_UNIQUE_IP, INSERT_HOST_UNIQUE_IP, INSERT_V6_RESRV_NON_UNIQUE, INSERT_V6_RESRV_UNIQUE,
  INSERT_V4_HOST_OPTION, INSERT_V6_HOST_OPTION, DEL_HOST_ADDR4, DEL_HOST_ADDR6,
  DEL_HOST_SUBID4_ID, DEL_HOST_SUBID6_ID, NUM_STATEMENTS
}
 Statement Tags. More...
 

Public Member Functions

 MySqlHostDataSourceImpl (const DatabaseConnection::ParameterMap &parameters)
 Constructor. More...
 
 ~MySqlHostDataSourceImpl ()
 Destructor. More...
 
void addOption (MySqlHostContextPtr &ctx, const MySqlHostDataSourceImpl::StatementIndex &stindex, const OptionDescriptor &opt_desc, const std::string &opt_space, const Optional< SubnetID > &subnet_id, const HostID &host_id)
 Inserts a single DHCP option into the database. More...
 
void addOptions (MySqlHostContextPtr &ctx, const StatementIndex &stindex, const ConstCfgOptionPtr &options_cfg, const uint64_t host_id)
 Inserts multiple options into the database. More...
 
void addResv (MySqlHostContextPtr &ctx, const IPv6Resrv &resv, const HostID &id)
 Inserts IPv6 Reservation into ipv6_reservation table. More...
 
void addStatement (MySqlHostContextPtr &ctx, MySqlHostDataSourceImpl::StatementIndex stindex, std::vector< MYSQL_BIND > &bind)
 Executes statements which inserts a row into one of the tables. More...
 
void checkError (MySqlHostContextPtr &ctx, const int status, const StatementIndex index, const char *what) const
 Check Error and Throw Exception. More...
 
void checkReadOnly (MySqlHostContextPtr &ctx) const
 Throws exception if database is read only. More...
 
MySqlHostContextPtr createContext () const
 Create a new context. More...
 
bool delStatement (MySqlHostContextPtr &ctx, StatementIndex stindex, MYSQL_BIND *bind)
 Executes statements that delete records. More...
 
ConstHostPtr getHost (MySqlHostContextPtr &ctx, const SubnetID &subnet_id, const Host::IdentifierType &identifier_type, const uint8_t *identifier_begin, const size_t identifier_len, StatementIndex stindex, boost::shared_ptr< MySqlHostExchange > exchange) const
 Retrieves a host by subnet and client's unique identifier. More...
 
void getHostCollection (MySqlHostContextPtr &ctx, StatementIndex stindex, MYSQL_BIND *bind, boost::shared_ptr< MySqlHostExchange > exchange, ConstHostCollection &result, bool single) const
 Creates collection of Host objects with associated information such as IPv6 reservations and/or DHCP options. More...
 
std::pair< uint32_t, uint32_t > getVersion () const
 Returns backend version. More...
 

Static Public Member Functions

static bool dbReconnect (ReconnectCtlPtr db_reconnect_ctl)
 Attempts to reconnect the server to the host DB backend manager. More...
 

Public Attributes

bool ip_reservations_unique_
 Holds the setting whether the IP reservations must be unique or may be non-unique. More...
 
DatabaseConnection::ParameterMap parameters_
 The parameters. More...
 
MySqlHostContextPoolPtr pool_
 The pool of contexts. More...
 
std::string timer_name_
 Timer name used to register database reconnect timer. More...
 
bool unusable_
 Indicates if there is at least one connection that can no longer be used for normal operations. More...
 

Static Public Attributes

static const StatementIndex WRITE_STMTS_BEGIN = INSERT_HOST_NON_UNIQUE_IP
 Index of first statement performing write to the database. More...
 

Detailed Description

Implementation of the MySqlHostDataSource.

Definition at line 2002 of file mysql_host_data_source.cc.

Member Enumeration Documentation

◆ StatementIndex

Statement Tags.

The contents of the enum are indexes into the list of SQL statements. It is assumed that the order is such that the indices of statements reading the database are less than those of statements modifying the database.

Note
: please add new statements doing read only operations before the WRITE_STMTS_BEGIN position.
Enumerator
GET_HOST_DHCPID 
GET_HOST_ADDR 
GET_HOST_SUBID4_DHCPID 
GET_HOST_SUBID6_DHCPID 
GET_HOST_SUBID_ADDR 
GET_HOST_PREFIX 
GET_HOST_SUBID6_ADDR 
GET_HOST_SUBID4 
GET_HOST_SUBID6 
GET_HOST_HOSTNAME 
GET_HOST_HOSTNAME_SUBID4 
GET_HOST_HOSTNAME_SUBID6 
GET_HOST_SUBID4_PAGE 
GET_HOST_SUBID6_PAGE 
GET_HOST_PAGE4 
GET_HOST_PAGE6 
INSERT_HOST_NON_UNIQUE_IP 
INSERT_HOST_UNIQUE_IP 
INSERT_V6_RESRV_NON_UNIQUE 
INSERT_V6_RESRV_UNIQUE 
INSERT_V4_HOST_OPTION 
INSERT_V6_HOST_OPTION 
DEL_HOST_ADDR4 
DEL_HOST_ADDR6 
DEL_HOST_SUBID4_ID 
DEL_HOST_SUBID6_ID 
NUM_STATEMENTS 

Definition at line 2013 of file mysql_host_data_source.cc.

Constructor & Destructor Documentation

◆ MySqlHostDataSourceImpl()

isc::dhcp::MySqlHostDataSourceImpl::MySqlHostDataSourceImpl ( const DatabaseConnection::ParameterMap parameters)

Constructor.

This constructor opens database connection and initializes prepared statements used in the queries.

Definition at line 2768 of file mysql_host_data_source.cc.

References createContext(), getVersion(), isc_throw, isc::db::MYSQL_SCHEMA_VERSION_MAJOR, isc::db::MYSQL_SCHEMA_VERSION_MINOR, pool_, and timer_name_.

+ Here is the call graph for this function:

◆ ~MySqlHostDataSourceImpl()

isc::dhcp::MySqlHostDataSourceImpl::~MySqlHostDataSourceImpl ( )

Destructor.

Definition at line 2851 of file mysql_host_data_source.cc.

Member Function Documentation

◆ addOption()

void isc::dhcp::MySqlHostDataSourceImpl::addOption ( MySqlHostContextPtr ctx,
const MySqlHostDataSourceImpl::StatementIndex stindex,
const OptionDescriptor opt_desc,
const std::string &  opt_space,
const Optional< SubnetID > &  subnet_id,
const HostID host_id 
)

Inserts a single DHCP option into the database.

Parameters
ctxContext
stindexIndex of a statement being executed.
opt_descOption descriptor holding information about an option to be inserted into the database.
opt_spaceOption space name.
subnet_idSubnet identifier.
host_idHost identifier.

Definition at line 2997 of file mysql_host_data_source.cc.

References addStatement().

Referenced by addOptions().

+ Here is the call graph for this function:

◆ addOptions()

void isc::dhcp::MySqlHostDataSourceImpl::addOptions ( MySqlHostContextPtr ctx,
const StatementIndex stindex,
const ConstCfgOptionPtr options_cfg,
const uint64_t  host_id 
)

Inserts multiple options into the database.

Parameters
ctxContext
stindexIndex of a statement being executed.
options_cfgAn object holding a collection of options to be inserted into the database.
host_idHost identifier retrieved using mysql_insert_id.

Definition at line 3009 of file mysql_host_data_source.cc.

References addOption().

+ Here is the call graph for this function:

◆ addResv()

void isc::dhcp::MySqlHostDataSourceImpl::addResv ( MySqlHostContextPtr ctx,
const IPv6Resrv resv,
const HostID id 
)

Inserts IPv6 Reservation into ipv6_reservation table.

Parameters
ctxContext
resvIPv6 Reservation to be added
idID of a host owning this reservation

Definition at line 2987 of file mysql_host_data_source.cc.

References addStatement(), INSERT_V6_RESRV_NON_UNIQUE, INSERT_V6_RESRV_UNIQUE, and ip_reservations_unique_.

+ Here is the call graph for this function:

◆ addStatement()

void isc::dhcp::MySqlHostDataSourceImpl::addStatement ( MySqlHostContextPtr ctx,
MySqlHostDataSourceImpl::StatementIndex  stindex,
std::vector< MYSQL_BIND > &  bind 
)

Executes statements which inserts a row into one of the tables.

Parameters
ctxContext
stindexIndex of a statement being executed.
bindVector of MYSQL_BIND objects to be used when making the query.
Exceptions
isc::db::DuplicateEntryDatabase throws duplicate entry error

Definition at line 2936 of file mysql_host_data_source.cc.

References checkError(), isc_throw, and isc::db::MysqlExecuteStatement().

Referenced by addOption(), and addResv().

+ Here is the call graph for this function:

◆ checkError()

void isc::dhcp::MySqlHostDataSourceImpl::checkError ( MySqlHostContextPtr ctx,
const int  status,
const StatementIndex  index,
const char *  what 
) const

Check Error and Throw Exception.

This method invokes db::MySqlConnection::checkError.

Parameters
ctxContext
statusStatus code: non-zero implies an error
indexIndex of statement that caused the error
whatHigh-level description of the error
Exceptions
isc::dhcp::DbOperationErrorAn operation on the open database has failed.

Definition at line 3033 of file mysql_host_data_source.cc.

Referenced by addStatement(), delStatement(), and getHostCollection().

◆ checkReadOnly()

void isc::dhcp::MySqlHostDataSourceImpl::checkReadOnly ( MySqlHostContextPtr ctx) const

Throws exception if database is read only.

This method should be called by the methods which write to the database. If the backend is operating in read-only mode this method will throw exception.

Parameters
ctxContext
Exceptions
DbReadOnlyif backend is operating in read only mode.

Definition at line 3150 of file mysql_host_data_source.cc.

References isc_throw.

◆ createContext()

MySqlHostContextPtr isc::dhcp::MySqlHostDataSourceImpl::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 2797 of file mysql_host_data_source.cc.

References dbReconnect(), isc::dhcp::DHCPSRV_DBG_TRACE, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_MYSQL_HOST_DB_READONLY, isc::dhcp::DHCPSRV_MYSQL_NO_TLS, isc::dhcp::DHCPSRV_MYSQL_TLS_CIPHER, isc::dhcp::HostMgr::getIOService(), LOG_DEBUG, LOG_ERROR, LOG_INFO, parameters_, timer_name_, and WRITE_STMTS_BEGIN.

Referenced by isc::dhcp::MySqlHostDataSource::MySqlHostContextAlloc::MySqlHostContextAlloc(), and MySqlHostDataSourceImpl().

+ Here is the call graph for this function:

◆ dbReconnect()

bool isc::dhcp::MySqlHostDataSourceImpl::dbReconnect ( ReconnectCtlPtr  db_reconnect_ctl)
static

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

This is a self-rescheduling function that attempts to reconnect to the server's host DB backends after connectivity to one or more have been lost. Upon entry it will attempt to reconnect via HostDataSourceFactory::add. 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 2855 of file mysql_host_data_source.cc.

References isc::dhcp::HostMgr::addBackend(), isc::dhcp::HostMgr::delBackend(), isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_MYSQL_HOST_DB_RECONNECT_ATTEMPT_FAILED, isc::dhcp::DHCPSRV_MYSQL_HOST_DB_RECONNECT_ATTEMPT_SCHEDULE, isc::dhcp::DHCPSRV_MYSQL_HOST_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, isc::asiolink::IntervalTimer::ONE_SHOT, and isc::db::DatabaseConnection::parse().

Referenced by createContext().

+ Here is the call graph for this function:

◆ delStatement()

bool isc::dhcp::MySqlHostDataSourceImpl::delStatement ( MySqlHostContextPtr ctx,
StatementIndex  stindex,
MYSQL_BIND *  bind 
)

Executes statements that delete records.

Parameters
ctxContext
stindexIndex of a statement being executed.
bindVector of MYSQL_BIND objects to be used when making the query.
Returns
true if any records were deleted, false otherwise

Definition at line 2966 of file mysql_host_data_source.cc.

References checkError(), and isc::db::MysqlExecuteStatement().

+ Here is the call graph for this function:

◆ getHost()

ConstHostPtr isc::dhcp::MySqlHostDataSourceImpl::getHost ( MySqlHostContextPtr ctx,
const SubnetID subnet_id,
const Host::IdentifierType identifier_type,
const uint8_t *  identifier_begin,
const size_t  identifier_len,
StatementIndex  stindex,
boost::shared_ptr< MySqlHostExchange >  exchange 
) const

Retrieves a host by subnet and client's unique identifier.

This method is used by both MySqlHostDataSource::get4 and MySqlHOstDataSource::get6 methods.

Parameters
ctxContext
subnet_idSubnet identifier.
identifier_typeIdentifier type.
identifier_beginPointer to a beginning of a buffer containing an identifier.
identifier_lenIdentifier length.
stindexStatement index.
exchangePointer to the exchange object used for the particular query.
Returns
Pointer to const instance of Host or null pointer if no host found.

Definition at line 3105 of file mysql_host_data_source.cc.

References getHostCollection(), and isc::db::MLM_TRUE.

+ Here is the call graph for this function:

◆ getHostCollection()

void isc::dhcp::MySqlHostDataSourceImpl::getHostCollection ( MySqlHostContextPtr ctx,
StatementIndex  stindex,
MYSQL_BIND *  bind,
boost::shared_ptr< MySqlHostExchange >  exchange,
ConstHostCollection result,
bool  single 
) const

Creates collection of Host objects with associated information such as IPv6 reservations and/or DHCP options.

This method performs a query which returns host information from the 'hosts' table. The query may also use LEFT JOIN clause to retrieve information from other tables, e.g. ipv6_reservations, dhcp4_options and dhcp6_options. Whether IPv6 reservations and/or options are assigned to the Host objects depends on the type of the exchange object.

Parameters
ctxContext
stindexStatement index.
bindPointer to an array of MySQL bindings.
exchangePointer to the exchange object used for the particular query.
[out]resultReference to the collection of hosts returned.
singleA boolean value indicating if a single host is expected to be returned, or multiple hosts.

Definition at line 3041 of file mysql_host_data_source.cc.

References checkError(), isc_throw, isc::db::MLM_MYSQL_FETCH_FAILURE, isc::db::MLM_MYSQL_FETCH_SUCCESS, isc::db::MysqlExecuteStatement(), and isc::Exception::what().

Referenced by getHost().

+ Here is the call graph for this function:

◆ getVersion()

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

Returns backend version.

The method is called by the constructor before opening the database to verify that the schema version is correct.

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

Definition at line 2928 of file mysql_host_data_source.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::dhcp::DHCPSRV_MYSQL_HOST_DB_GET_VERSION, isc::db::MySqlConnection::getVersion(), LOG_DEBUG, and parameters_.

Referenced by MySqlHostDataSourceImpl().

+ Here is the call graph for this function:

Member Data Documentation

◆ ip_reservations_unique_

bool isc::dhcp::MySqlHostDataSourceImpl::ip_reservations_unique_

Holds the setting whether the IP reservations must be unique or may be non-unique.

Definition at line 2250 of file mysql_host_data_source.cc.

Referenced by addResv().

◆ parameters_

DatabaseConnection::ParameterMap isc::dhcp::MySqlHostDataSourceImpl::parameters_

The parameters.

Definition at line 2246 of file mysql_host_data_source.cc.

Referenced by createContext(), and getVersion().

◆ pool_

◆ timer_name_

std::string isc::dhcp::MySqlHostDataSourceImpl::timer_name_

Timer name used to register database reconnect timer.

Definition at line 2260 of file mysql_host_data_source.cc.

Referenced by createContext(), and MySqlHostDataSourceImpl().

◆ unusable_

bool isc::dhcp::MySqlHostDataSourceImpl::unusable_

Indicates if there is at least one connection that can no longer be used for normal operations.

Definition at line 2257 of file mysql_host_data_source.cc.

Referenced by isc::dhcp::MySqlHostDataSource::MySqlHostContextAlloc::~MySqlHostContextAlloc().

◆ WRITE_STMTS_BEGIN

const StatementIndex isc::dhcp::MySqlHostDataSourceImpl::WRITE_STMTS_BEGIN = INSERT_HOST_NON_UNIQUE_IP
static

Index of first statement performing write to the database.

This value is used to mark border line between queries and other statements and statements performing write operation on the database, such as INSERT, DELETE, UPDATE.

Definition at line 2048 of file mysql_host_data_source.cc.

Referenced by createContext().


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