High Availability hooks library implementation. More...

#include <ha_impl.h>

Inheritance diagram for isc::ha::HAImpl:

Public Member Functions
	HAImpl ()
	Constructor. More...

void	buffer4Receive (hooks::CalloutHandle &callout_handle)
	Implementation of the "buffer4_receive" callout. More...

void	buffer6Receive (hooks::CalloutHandle &callout_handle)
	Implementation of the "buffer6_receive" callout. More...

void	commandProcessed (hooks::CalloutHandle &callout_handle)
	Implementation of the "command_processed" callout. More...

void	configure (const data::ConstElementPtr &input_config)
	Parases configuration. More...

void	continueHandler (hooks::CalloutHandle &callout_handle)
	Implements handler for the ha-continue command. More...

HAConfigPtr	getConfig () const
	Returns parsed configuration. More...

void	heartbeatHandler (hooks::CalloutHandle &callout_handle)
	Implements handle for the heartbeat command. More...

void	leases4Committed (hooks::CalloutHandle &callout_handle)
	Implementation of the "leases4_committed" callout. More...

void	leases6Committed (hooks::CalloutHandle &callout_handle)
	Implementation of the "leases6_committed" callout. More...

void	scopesHandler (hooks::CalloutHandle &callout_handle)
	Implements handler for the ha-scopes command. More...

void	startService (const asiolink::IOServicePtr &io_service, const dhcp::NetworkStatePtr &network_state, const HAServerType &server_type)
	Creates high availability service using current configuration. More...

void	synchronizeHandler (hooks::CalloutHandle &callout_handle)
	Implements handler for the ha-sync command. More...

Protected Attributes
HAConfigPtr	config_
	Holds parsed configuration. More...

HAServicePtr	service_
	Pointer to the high availability service (state machine). More...

Detailed Description

High Availability hooks library implementation.

This object provides an interface between the HA hook library callouts and the HA state model implemented in the HAService. Callouts invoke respective methods of the HAImpl to configure the service, generate lease updates etc. The HAImpl retrieves and validates the arguments provided within CalloutHandle object and then invokes appropriate methods of the HAService class.

Definition at line 31 of file ha_impl.h.

Constructor & Destructor Documentation

◆ HAImpl()

isc::ha::HAImpl::HAImpl ( )

Constructor.

Definition at line 30 of file ha_impl.cc.

Member Function Documentation

◆ buffer4Receive()

void isc::ha::HAImpl::buffer4Receive ( hooks::CalloutHandle & callout_handle )

Implementation of the "buffer4_receive" callout.

This callout uses HA service to check if the query should be processed by this server or a partner. If the partner should process the query, this callout sets the status to CalloutHandle::NEXT_STEP_DROP to cause the server to drop the packet. Therefore it is important to note that, if multiple hook libraries implementing buffer4_receive hook are loaded, the order of loading the libraries may matter. If this library sets the status to CalloutHandle::NEXT_STEP_DROP and the other library overrides this status, the query will be processed by the server instead of being dropped. This problem may be mitigated by loading the HA library last, i.e. placing the library at the end of the "hooks-libraries" list within a Kea configuration file.

If the received query is to be processed by this server instance, the CalloutHabndle::NEXT_STEP_SKIP status is set to prevent the server from unpacking the query because the query is unpacked by the callout.

Parameters

callout_handle Callout handle provided to the callout.

Todo:: Add unit tests to verify the behavior for different malformed packets.

Definition at line 50 of file ha_impl.cc.

References isc::stats::StatsMgr::addValue(), isc::log::DBGLVL_TRACE_BASIC, isc::hooks::CalloutHandle::getArgument(), isc::ha::ha_logger, isc::stats::StatsMgr::instance(), LOG_DEBUG, service_, isc::hooks::CalloutHandle::setStatus(), and isc::Exception::what().

Here is the call graph for this function:

◆ buffer6Receive()

void isc::ha::HAImpl::buffer6Receive ( hooks::CalloutHandle & callout_handle )

Implementation of the "buffer6_receive" callout.

This callout uses HA service to check if the query should be processed by this server or a partner. If the partner should process the query, this callout sets the status to CalloutHandle::NEXT_STEP_DROP to cause the server to drop the packet. Therefore it is important to note that, if multiple hook libraries implementing buffer6_receive hook are loaded, the order of loading the libraries may matter. If this library sets the status to CalloutHandle::NEXT_STEP_DROP and the other library overrides this status, the query will be processed by the server instead of being dropped. This problem may be mitigated by loading the HA library last, i.e. placing the library at the end of the "hooks-libraries" list within a Kea configuration file.

If the received query is to be processed by this server instance, the CalloutHabndle::NEXT_STEP_SKIP status is set to prevent the server from unpacking the query because the query is unpacked by the callout.

Parameters

callout_handle Callout handle provided to the callout.

Todo:: Add unit tests to verify the behavior for different malformed packets.

Definition at line 155 of file ha_impl.cc.

References isc::stats::StatsMgr::addValue(), isc::log::DBGLVL_TRACE_BASIC, isc::hooks::CalloutHandle::getArgument(), isc::ha::ha_logger, isc::stats::StatsMgr::instance(), LOG_DEBUG, service_, isc::hooks::CalloutHandle::setStatus(), and isc::Exception::what().

Here is the call graph for this function:

◆ commandProcessed()

void isc::ha::HAImpl::commandProcessed ( hooks::CalloutHandle & callout_handle )

Implementation of the "command_processed" callout.

This callout adjusts network state (DHCP service state) after receiving a "dhcp-enable" commands. It is preventing a situation when the DHCP service is enabled in a state for which this is not allowed, e.g. waiting, syncing etc. We don't want to rely on the HA partner to do a correct thing in that respect.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 260 of file ha_impl.cc.

References isc::hooks::CalloutHandle::getArgument(), and service_.

Here is the call graph for this function:

◆ configure()

void isc::ha::HAImpl::configure ( const data::ConstElementPtr & input_config )

Parases configuration.

Parameters

input_config Configuration specified for the hooks library.

Exceptions

ConfigError when configuration fails.

Definition at line 35 of file ha_impl.cc.

References config_, and isc::ha::HAConfigParser::parse().

Here is the call graph for this function:

◆ continueHandler()

void isc::ha::HAImpl::continueHandler ( hooks::CalloutHandle & callout_handle )

Implements handler for the ha-continue command.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 394 of file ha_impl.cc.

References service_, and isc::hooks::CalloutHandle::setArgument().

Here is the call graph for this function:

◆ getConfig()

HAConfigPtr isc::ha::HAImpl::getConfig ( ) const

inline

Returns parsed configuration.

Definition at line 58 of file ha_impl.h.

References config_.

◆ heartbeatHandler()

void isc::ha::HAImpl::heartbeatHandler ( hooks::CalloutHandle & callout_handle )

Implements handle for the heartbeat command.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 269 of file ha_impl.cc.

References service_, and isc::hooks::CalloutHandle::setArgument().

Here is the call graph for this function:

◆ leases4Committed()

void isc::ha::HAImpl::leases4Committed ( hooks::CalloutHandle & callout_handle )

Implementation of the "leases4_committed" callout.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 101 of file ha_impl.cc.

References config_, isc::log::DBGLVL_TRACE_BASIC, isc::hooks::CalloutHandle::getArgument(), isc::hooks::CalloutHandle::getParkingLotHandlePtr(), isc::ha::ha_logger, LOG_DEBUG, service_, and isc::hooks::CalloutHandle::setStatus().

Here is the call graph for this function:

◆ leases6Committed()

void isc::ha::HAImpl::leases6Committed ( hooks::CalloutHandle & callout_handle )

Implementation of the "leases6_committed" callout.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 206 of file ha_impl.cc.

References config_, isc::log::DBGLVL_TRACE_BASIC, isc::hooks::CalloutHandle::getArgument(), isc::hooks::CalloutHandle::getParkingLotHandlePtr(), isc::ha::ha_logger, LOG_DEBUG, service_, and isc::hooks::CalloutHandle::setStatus().

Here is the call graph for this function:

◆ scopesHandler()

void isc::ha::HAImpl::scopesHandler ( hooks::CalloutHandle & callout_handle )

Implements handler for the ha-scopes command.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 337 of file ha_impl.cc.

References isc::config::CONTROL_RESULT_ERROR, isc::config::createAnswer(), isc::hooks::CalloutHandle::getArgument(), isc_throw, isc::config::parseCommand(), service_, and isc::hooks::CalloutHandle::setArgument().

Here is the call graph for this function:

◆ startService()

void isc::ha::HAImpl::startService	(	const asiolink::IOServicePtr &	io_service,
		const dhcp::NetworkStatePtr &	network_state,
		const HAServerType &	server_type
	)

Creates high availability service using current configuration.

The caller must ensure that the HA configuration is valid before calling this function.

Parameters

io_service	IO service object provided by the DHCP server.
network_state	pointer to the object holding a state of the DHCP service (enabled/disabled).
server_type	DHCP server type for which the HA service should be created.

Definition at line 41 of file ha_impl.cc.

References config_, and service_.

◆ synchronizeHandler()

void isc::ha::HAImpl::synchronizeHandler ( hooks::CalloutHandle & callout_handle )

Implements handler for the ha-sync command.

Parameters

callout_handle Callout handle provided to the callout.

Definition at line 275 of file ha_impl.cc.

References isc::config::CONTROL_RESULT_ERROR, isc::config::createAnswer(), isc::hooks::CalloutHandle::getArgument(), isc_throw, isc::config::parseCommand(), service_, and isc::hooks::CalloutHandle::setArgument().

Here is the call graph for this function:

Member Data Documentation

◆ config_

HAConfigPtr isc::ha::HAImpl::config_

protected

Holds parsed configuration.

Definition at line 148 of file ha_impl.h.

Referenced by configure(), getConfig(), leases4Committed(), leases6Committed(), and startService().

◆ service_

HAServicePtr isc::ha::HAImpl::service_

protected

Pointer to the high availability service (state machine).

Definition at line 151 of file ha_impl.h.

Referenced by buffer4Receive(), buffer6Receive(), commandProcessed(), continueHandler(), heartbeatHandler(), leases4Committed(), leases6Committed(), scopesHandler(), startService(), and synchronizeHandler().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HAImpl()

Member Function Documentation

◆ buffer4Receive()

◆ buffer6Receive()

◆ commandProcessed()

◆ configure()

◆ continueHandler()

◆ getConfig()

◆ heartbeatHandler()

◆ leases4Committed()

◆ leases6Committed()

◆ scopesHandler()

◆ startService()

◆ synchronizeHandler()

Member Data Documentation

◆ config_

◆ service_