host_mgr.h

Go to the documentation of this file.

// Copyright (C) 2014-2026 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 HOST_MGR_H
#define HOST_MGR_H
 
#include <asiolink/io_service.h>
#include <database/database_connection.h>
#include <dhcpsrv/base_host_data_source.h>
#include <dhcpsrv/cache_host_data_source.h>
#include <dhcpsrv/host.h>
#include <dhcpsrv/subnet_id.h>
 
#include <cstdint>
#include <string>
 
#include <boost/noncopyable.hpp>
#include <boost/scoped_ptr.hpp>
 
namespace isc {
namespace dhcp {
 
// Enum flags to define a target of the host manager functions.
enum HostMgrOperationTarget : uint16_t {
    // The operation target not specified. Consider nothing.
    UNSPECIFIED_SOURCE = 0,
    // Consider only the CfgHosts instance.
    PRIMARY_SOURCE = 1, // 1 << 1
    // Consider only the alternate sources.
    ALTERNATE_SOURCES = 2, // 1 << 2
    // Consider both CfgInstance and alternate sources.
    ALL_SOURCES = 3  // PRIMARY_SOURCE | ALTERNATE_SOURCES
};

class HostMgr : public boost::noncopyable, public BaseHostDataSource {
public:

    static void create();

    static void addBackend(const std::string& access);

    static bool delBackend(const std::string& db_type);

    static bool delBackend(const std::string& db_type,
                           const std::string& access,
                           bool if_unusable = false);

    static void delAllBackends();

    static bool checkCacheBackend(bool logging = false);

    static HostMgr& instance();

    ConstHostCollection
    getAll(const Host::IdentifierType& identifier_type,
           const uint8_t* identifier_begin,
           const size_t identifier_len,
           const HostMgrOperationTarget target) const;

    virtual ConstHostCollection
    getAll(const Host::IdentifierType& identifier_type,
           const uint8_t* identifier_begin,
           const size_t identifier_len) const;

    ConstHostCollection
    getAll4(const SubnetID& subnet_id, const HostMgrOperationTarget target) const;

    virtual ConstHostCollection
    getAll4(const SubnetID& subnet_id) const;

    ConstHostCollection
    getAll6(const SubnetID& subnet_id,
            const HostMgrOperationTarget target) const;

    virtual ConstHostCollection
    getAll6(const SubnetID& subnet_id) const;

    ConstHostCollection
    getAllbyHostname(const std::string& hostname,
                     const HostMgrOperationTarget target) const;

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

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

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

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

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

    virtual ConstHostCollection
    getPage4(const SubnetID& subnet_id,
             size_t& source_index,
             uint64_t lower_host_id,
             const HostPageSize& page_size) const;

    virtual ConstHostCollection
    getPage6(const SubnetID& subnet_id,
             size_t& source_index,
             uint64_t lower_host_id,
             const HostPageSize& page_size) const;

    virtual ConstHostCollection
    getPage4(size_t& source_index,
             uint64_t lower_host_id,
             const HostPageSize& page_size) const;

    virtual ConstHostCollection
    getPage6(size_t& source_index,
             uint64_t lower_host_id,
             const HostPageSize& page_size) const;

    ConstHostCollection
    getAll4(const asiolink::IOAddress& address,
            const HostMgrOperationTarget target) const;

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

    ConstHostPtr
    get4Any(const SubnetID& subnet_id,
            const Host::IdentifierType& identifier_type,
            const uint8_t* identifier_begin,
            const size_t identifier_len,
            const HostMgrOperationTarget target) const;

    virtual ConstHostPtr
    get4Any(const SubnetID& subnet_id,
            const Host::IdentifierType& identifier_type,
            const uint8_t* identifier_begin,
            const size_t identifier_len) const;

    ConstHostPtr
    get4(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len,
         const HostMgrOperationTarget target) const;

    virtual ConstHostPtr
    get4(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len) const;

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

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

    ConstHostCollection
    getAll4(const SubnetID& subnet_id,
            const asiolink::IOAddress& address,
            const HostMgrOperationTarget target) const;

    virtual ConstHostCollection
    getAll4(const SubnetID& subnet_id,
            const asiolink::IOAddress& address) const;

    ConstHostPtr
    get6Any(const SubnetID& subnet_id,
            const Host::IdentifierType& identifier_type,
            const uint8_t* identifier_begin,
            const size_t identifier_len,
            const HostMgrOperationTarget target) const;

    virtual ConstHostPtr
    get6Any(const SubnetID& subnet_id,
            const Host::IdentifierType& identifier_type,
            const uint8_t* identifier_begin,
            const size_t identifier_len) const;

    ConstHostPtr
    get6(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len,
         const HostMgrOperationTarget target) const;

    virtual ConstHostPtr
    get6(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len) const;

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

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

    ConstHostPtr
    get6(const SubnetID& subnet_id, const asiolink::IOAddress& addr,
         const HostMgrOperationTarget target) const;

    virtual ConstHostPtr
    get6(const SubnetID& subnet_id, const asiolink::IOAddress& addr) const;

    ConstHostCollection
    getAll6(const SubnetID& subnet_id,
            const asiolink::IOAddress& address,
            const HostMgrOperationTarget target) const;

    virtual ConstHostCollection
    getAll6(const SubnetID& subnet_id,
            const asiolink::IOAddress& address) const;

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

    ConstHostCollection
    getAll6(const asiolink::IOAddress& address,
            const HostMgrOperationTarget target) const;

    void add(const HostPtr& host, const HostMgrOperationTarget target);

    virtual void add(const HostPtr& host);

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

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

    bool
    del4(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len,
         const HostMgrOperationTarget target);

    virtual bool
    del4(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len);

    bool
    del6(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len,
         const HostMgrOperationTarget target);

    virtual bool
    del6(const SubnetID& subnet_id, const Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin, const size_t identifier_len);

    void update(HostPtr const& host, const HostMgrOperationTarget target);

    void update(HostPtr const& host);

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

    HostDataSourceList& getHostDataSourceList() {
        return (alternate_sources_);
    }

    HostDataSourcePtr getHostDataSource() const;

    bool getNegativeCaching() const {
        return (negative_caching_);
    }

    void setNegativeCaching(bool negative_caching) {
        negative_caching_ = negative_caching;
    }

    bool getDisableSingleQuery() const {
        return (disable_single_query_);
    }

    void setDisableSingleQuery(bool disable_single_query) {
        disable_single_query_ = disable_single_query;
    }

    virtual bool setIPReservationsUnique(const bool unique);

    bool getIPReservationsUnique() const {
        return (ip_reservations_unique_);
    }
 
protected:

    bool negative_caching_;

    bool disable_single_query_;

    virtual void cache(ConstHostPtr host) const;

    virtual void cacheNegative(const SubnetID& ipv4_subnet_id,
                               const SubnetID& ipv6_subnet_id,
                               const Host::IdentifierType& identifier_type,
                               const uint8_t* identifier_begin,
                               const size_t identifier_len) const;
 
private:

    bool ip_reservations_unique_;

    HostMgr() : negative_caching_(false), disable_single_query_(false),
                ip_reservations_unique_(true) { }

    HostDataSourceList alternate_sources_;

    CacheHostDataSourcePtr cache_ptr_;

    static boost::scoped_ptr<HostMgr>& getHostMgrPtr();
};
 
}  // namespace dhcp
}  // namespace isc
 
#endif // HOST_MGR_H