d1/d3b/cfg__hosts_8h_source.html

// Copyright (C) 2014-2023 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 CFG_HOSTS_H

#define CFG_HOSTS_H


#include <asiolink/io_address.h>

#include <cc/cfg_to_element.h>

#include <dhcpsrv/base_host_data_source.h>

#include <dhcpsrv/host.h>

#include <dhcpsrv/host_container.h>

#include <dhcpsrv/subnet_id.h>

#include <dhcpsrv/writable_host_data_source.h>

#include <boost/shared_ptr.hpp>

#include <vector>


namespace isc {

namespace dhcp {


class CfgHosts : public BaseHostDataSource, public WritableHostDataSource,

                 public isc::data::CfgToElement {

public:


    virtual ~CfgHosts() { }


    virtual ConstHostCollection

    getAll(const Host::IdentifierType& identifier_type,

           const uint8_t* identifier_begin, const size_t identifier_len) const;


    virtual HostCollection

    getAll(const Host::IdentifierType& identifier_type,

           const uint8_t* identifier_begin,

           const size_t identifier_len);


    virtual ConstHostCollection

    getAll4(const SubnetID& subnet_id) const;


    virtual HostCollection

    getAll4(const SubnetID& subnet_id);


    virtual ConstHostCollection

    getAll6(const SubnetID& subnet_id) const;


    virtual HostCollection

    getAll6(const SubnetID& subnet_id);


    virtual ConstHostCollection

    getAllbyHostname(const std::string& hostname) const;


    virtual HostCollection

    getAllbyHostname(const std::string& hostname);


    virtual ConstHostCollection

    getAllbyHostname4(const std::string& hostname, const SubnetID& subnet_id) const;


    virtual HostCollection

    getAllbyHostname4(const std::string& hostname, const SubnetID& subnet_id);


    virtual ConstHostCollection

    getAllbyHostname6(const std::string& hostname, const SubnetID& subnet_id) const;


    virtual HostCollection

    getAllbyHostname6(const std::string& hostname, const SubnetID& subnet_id);


    virtual ConstHostCollection

    getPage4(const SubnetID& subnet_id,

             size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size) const;


    virtual HostCollection

    getPage4(const SubnetID& subnet_id,

             size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size);


    virtual ConstHostCollection

    getPage6(const SubnetID& subnet_id,

             size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size) const;


    virtual HostCollection

    getPage6(const SubnetID& subnet_id,

             size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size);


    virtual ConstHostCollection

    getPage4(size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size) const;


    virtual HostCollection

    getPage4(size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size);


    virtual ConstHostCollection

    getPage6(size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size) const;


    virtual HostCollection

    getPage6(size_t& source_index,

             uint64_t lower_host_id,

             const HostPageSize& page_size);


    virtual ConstHostCollection

    getAll4(const asiolink::IOAddress& address) const;


    virtual HostCollection

    getAll4(const asiolink::IOAddress& address);


    virtual ConstHostCollection

    getAll6(const asiolink::IOAddress& address) const;


    virtual HostCollection

    getAll6(const asiolink::IOAddress& address);


    virtual ConstHostPtr

    get4(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,

         const uint8_t* identifier_begin, const size_t identifier_len) const;


    virtual HostPtr

    get4(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,

         const uint8_t* identifier_begin, const size_t identifier_len);


    virtual ConstHostPtr

    get4(const SubnetID& subnet_id, const asiolink::IOAddress& address) const;


    virtual ConstHostCollection

    getAll4(const SubnetID& subnet_id,

            const asiolink::IOAddress& address) const;


    virtual ConstHostPtr

    get6(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,

         const uint8_t* identifier_begin, const size_t identifier_len) const;


    virtual HostPtr

    get6(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,

         const uint8_t* identifier_begin, const size_t identifier_len);


    virtual ConstHostPtr

    get6(const asiolink::IOAddress& prefix, const uint8_t prefix_len) const;


    virtual HostPtr

    get6(const asiolink::IOAddress& prefix, const uint8_t prefix_len);


    virtual ConstHostPtr

    get6(const SubnetID& subnet_id, const asiolink::IOAddress& address) const;


    virtual HostPtr

    get6(const SubnetID& subnet_id, const asiolink::IOAddress& address);


    virtual ConstHostCollection

    getAll6(const SubnetID& subnet_id,

            const asiolink::IOAddress& address) const;


    virtual void add(const HostPtr& host);


    virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr);


    virtual size_t delAll4(const SubnetID& subnet_id);


    virtual bool del4(const SubnetID& subnet_id,

                      const Host::IdentifierType& identifier_type,

                      const uint8_t* identifier_begin, const size_t identifier_len);


    virtual size_t delAll6(const SubnetID& subnet_id);


    virtual bool del6(const SubnetID& subnet_id,

                      const Host::IdentifierType& identifier_type,

                      const uint8_t* identifier_begin, const size_t identifier_len);


    virtual std::string getType() const {

        return (std::string("configuration file"));

    }


    virtual bool setIPReservationsUnique(const bool unique);


    isc::data::ElementPtr toElement() const;


private:


    template<typename Storage>

    void getAllInternal(const Host::IdentifierType& identifier_type,

                        const uint8_t* identifier,

                        const size_t identifier_len,

                        Storage& storage) const;


    template<typename Storage>

    void getAllInternal4(const SubnetID& subnet_id,

                         Storage& storage) const;


    template<typename Storage>

    void getAllInternal6(const SubnetID& subnet_id,

                         Storage& storage) const;


    template<typename Storage>

    void getAllbyHostnameInternal(const std::string& hostname,

                                  Storage& storage) const;


    template<typename Storage>

    void getAllbyHostnameInternal4(const std::string& hostname,

                                   const SubnetID& subnet_id,

                                   Storage& storage) const;


    template<typename Storage>

    void getAllbyHostnameInternal6(const std::string& hostname,

                                   const SubnetID& subnet_id,

                                   Storage& storage) const;


    template<typename Storage>

    void getPageInternal4(const SubnetID& subnet_id,

                          uint64_t lower_host_id,

                          const HostPageSize& page_size,

                          Storage& storage) const;


    template<typename Storage>

    void getPageInternal6(const SubnetID& subnet_id,

                          uint64_t lower_host_id,

                          const HostPageSize& page_size,

                          Storage& storage) const;


    template<typename Storage>

    void getPageInternal(uint64_t lower_host_id,

                         const HostPageSize& page_size,

                         Storage& storage) const;


    template<typename Storage>

    void getAllInternal4(const asiolink::IOAddress& address,

                         Storage& storage) const;


    template<typename Storage>

    void getAllInternal6(const asiolink::IOAddress& address,

                         Storage& storage) const;


    template<typename Storage>

    void

    getAllInternal6(const SubnetID& subnet_id,

                    const asiolink::IOAddress& address,

                    Storage& storage) const;


    HostPtr

    getHostInternal(const SubnetID& subnet_id, const bool subnet6,

                    const Host::IdentifierType& identifier_type,

                    const uint8_t* identifier,

                    const size_t identifier_len) const;


    template<typename ReturnType, typename Storage>

    ReturnType getHostInternal6(const SubnetID& subnet_id,

                                const asiolink::IOAddress& address) const;


    template<typename ReturnType>

    ReturnType getHostInternal6(const asiolink::IOAddress& prefix,

                                const uint8_t prefix_len) const;


    virtual void add4(const HostPtr& host);


    virtual void add6(const HostPtr& host);


    uint64_t next_host_id_ = 0;


    HostContainer hosts_;


    HostContainer6 hosts6_;


    bool ip_reservations_unique_ = true;


    isc::data::ElementPtr toElement4() const;


    isc::data::ElementPtr toElement6() const;

};


typedef boost::shared_ptr<CfgHosts> CfgHostsPtr;


typedef boost::shared_ptr<const CfgHosts> ConstCfgHostsPtr;


}

}


#endif // CFG_HOSTS_H

base_host_data_source.h

cfg_to_element.h

isc::asiolink::IOAddress
The IOAddress class represents an IP addresses (version agnostic)
Definition: io_address.h:45

isc::dhcp::BaseHostDataSource
Base interface for the classes implementing simple data source for host reservations.
Definition: base_host_data_source.h:88

isc::dhcp::CfgHosts
Represents the host reservations specified in the configuration file.
Definition: cfg_hosts.h:38

isc::dhcp::CfgHosts::~CfgHosts
virtual ~CfgHosts()
Destructor.
Definition: cfg_hosts.h:42

isc::dhcp::CfgHosts::delAll4
virtual size_t delAll4(const SubnetID &subnet_id)
Attempts to delete all hosts for a given IPv4 subnet.
Definition: cfg_hosts.cc:1117

isc::dhcp::CfgHosts::add
virtual void add(const HostPtr &host)
Adds a new host to the collection.
Definition: cfg_hosts.cc:949

isc::dhcp::CfgHosts::getPage6
virtual ConstHostCollection getPage6(const SubnetID &subnet_id, size_t &source_index, uint64_t lower_host_id, const HostPageSize &page_size) const
Returns range of hosts in a DHCPv6 subnet.
Definition: cfg_hosts.cc:176

isc::dhcp::CfgHosts::del4
virtual bool del4(const SubnetID &subnet_id, const Host::IdentifierType &identifier_type, const uint8_t *identifier_begin, const size_t identifier_len)
Attempts to delete a host by (subnet4-id, identifier, identifier-type)
Definition: cfg_hosts.cc:1129

isc::dhcp::CfgHosts::del
virtual bool del(const SubnetID &subnet_id, const asiolink::IOAddress &addr)
Attempts to delete a hosts by address.
Definition: cfg_hosts.cc:1084

isc::dhcp::CfgHosts::setIPReservationsUnique
virtual bool setIPReservationsUnique(const bool unique)
Controls whether IP reservations are unique or non-unique.
Definition: cfg_hosts.cc:1215

isc::dhcp::CfgHosts::delAll6
virtual size_t delAll6(const SubnetID &subnet_id)
Attempts to delete all hosts for a given IPv6 subnet.
Definition: cfg_hosts.cc:1159

isc::dhcp::CfgHosts::get6
virtual ConstHostPtr get6(const SubnetID &subnet_id, const Host::IdentifierType &identifier_type, const uint8_t *identifier_begin, const size_t identifier_len) const
Returns a host connected to the IPv6 subnet.
Definition: cfg_hosts.cc:729

isc::dhcp::CfgHosts::getAllbyHostname
virtual ConstHostCollection getAllbyHostname(const std::string &hostname) const
Return all hosts with a hostname.
Definition: cfg_hosts.cc:88

isc::dhcp::CfgHosts::del6
virtual bool del6(const SubnetID &subnet_id, const Host::IdentifierType &identifier_type, const uint8_t *identifier_begin, const size_t identifier_len)
Attempts to delete a host by (subnet6-id, identifier, identifier-type)
Definition: cfg_hosts.cc:1177

isc::dhcp::CfgHosts::getPage4
virtual ConstHostCollection getPage4(const SubnetID &subnet_id, size_t &source_index, uint64_t lower_host_id, const HostPageSize &page_size) const
Returns range of hosts in a DHCPv4 subnet.
Definition: cfg_hosts.cc:146

isc::dhcp::CfgHosts::getAll4
virtual ConstHostCollection getAll4(const SubnetID &subnet_id) const
Return all hosts in a DHCPv4 subnet.
Definition: cfg_hosts.cc:52

isc::dhcp::CfgHosts::get4
virtual ConstHostPtr get4(const SubnetID &subnet_id, const Host::IdentifierType &identifier_type, const uint8_t *identifier_begin, const size_t identifier_len) const
Returns a host connected to the IPv4 subnet.
Definition: cfg_hosts.cc:664

isc::dhcp::CfgHosts::getAll6
virtual ConstHostCollection getAll6(const SubnetID &subnet_id) const
Return all hosts in a DHCPv6 subnet.
Definition: cfg_hosts.cc:70

isc::dhcp::CfgHosts::getAllbyHostname6
virtual ConstHostCollection getAllbyHostname6(const std::string &hostname, const SubnetID &subnet_id) const
Return all hosts with a hostname in a DHCPv6 subnet.
Definition: cfg_hosts.cc:126

isc::dhcp::CfgHosts::getType
virtual std::string getType() const
Return backend type.
Definition: cfg_hosts.h:597

isc::dhcp::CfgHosts::toElement
isc::data::ElementPtr toElement() const
Unparse a configuration object.
Definition: cfg_hosts.cc:1222

isc::dhcp::CfgHosts::getAllbyHostname4
virtual ConstHostCollection getAllbyHostname4(const std::string &hostname, const SubnetID &subnet_id) const
Return all hosts with a hostname in a DHCPv4 subnet.
Definition: cfg_hosts.cc:106

isc::dhcp::CfgHosts::getAll
virtual ConstHostCollection getAll(const Host::IdentifierType &identifier_type, const uint8_t *identifier_begin, const size_t identifier_len) const
Return all hosts connected to any subnet for which reservations have been made using a specified iden...
Definition: cfg_hosts.cc:29

isc::dhcp::HostPageSize
Wraps value holding size of the page with host reservations.
Definition: base_host_data_source.h:53

isc::dhcp::Host::IdentifierType
IdentifierType
Type of the host identifier.
Definition: host.h:307

isc::dhcp::WritableHostDataSource
Interface for retrieving writable host reservations.
Definition: writable_host_data_source.h:21

host.h

host_container.h

io_address.h

isc::data::ElementPtr
boost::shared_ptr< Element > ElementPtr
Definition: data.h:28

isc::dhcp::ConstCfgHostsPtr
boost::shared_ptr< const CfgHosts > ConstCfgHostsPtr
Const pointer.
Definition: cfg_hosts.h:944

isc::dhcp::HostContainer
boost::multi_index_container< HostPtr, boost::multi_index::indexed_by< boost::multi_index::ordered_non_unique< boost::multi_index::composite_key< Host, boost::multi_index::const_mem_fun< Host, const std::vector< uint8_t > &, &Host::getIdentifier >, boost::multi_index::const_mem_fun< Host, Host::IdentifierType, &Host::getIdentifierType > > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< Host, const asiolink::IOAddress &, &Host::getIPv4Reservation > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< Host, SubnetID, &Host::getIPv4SubnetID > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< Host, SubnetID, &Host::getIPv6SubnetID > >, boost::multi_index::ordered_unique< boost::multi_index::const_mem_fun< Host, uint64_t, &Host::getHostId > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< Host, std::string, &Host::getLowerHostname > > > > HostContainer
Multi-index container holding host reservations.
Definition: host_container.h:101

isc::dhcp::HostPtr
boost::shared_ptr< Host > HostPtr
Pointer to the Host object.
Definition: host.h:807

isc::dhcp::ConstHostCollection
std::vector< ConstHostPtr > ConstHostCollection
Collection of the const Host objects.
Definition: host.h:813

isc::dhcp::HostContainer6
boost::multi_index_container< HostResrv6Tuple, boost::multi_index::indexed_by< boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< HostResrv6Tuple, const asiolink::IOAddress &, &HostResrv6Tuple::getPrefix > >, boost::multi_index::ordered_non_unique< boost::multi_index::composite_key< HostResrv6Tuple, boost::multi_index::member< HostResrv6Tuple, const SubnetID, &HostResrv6Tuple::subnet_id_ >, boost::multi_index::const_mem_fun< HostResrv6Tuple, const asiolink::IOAddress &, &HostResrv6Tuple::getPrefix > > >, boost::multi_index::ordered_non_unique< boost::multi_index::member< HostResrv6Tuple, const SubnetID, &HostResrv6Tuple::subnet_id_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< HostResrv6Tuple, uint64_t, &HostResrv6Tuple::getHostId > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< HostResrv6Tuple, const asiolink::IOAddress &, &HostResrv6Tuple::getPrefix > > > > HostContainer6
Multi-index container holding IPv6 reservations.
Definition: host_container.h:262

isc::dhcp::HostCollection
std::vector< HostPtr > HostCollection
Collection of the Host objects.
Definition: host.h:816

isc::dhcp::SubnetID
uint32_t SubnetID
Defines unique IPv4 or IPv6 subnet identifier.
Definition: subnet_id.h:25

isc::dhcp::CfgHostsPtr
boost::shared_ptr< CfgHosts > CfgHostsPtr
Non-const pointer.
Definition: cfg_hosts.h:941

isc::dhcp::ConstHostPtr
boost::shared_ptr< const Host > ConstHostPtr
Const pointer to the Host object.
Definition: host.h:810

isc
Defines the logger used by the top-level component of kea-lfc.
Definition: agent_parser.cc:148

isc::data::CfgToElement
Abstract class for configuration Cfg_* classes.
Definition: cfg_to_element.h:29

subnet_id.h

writable_host_data_source.h