host_cache.h

Go to the documentation of this file.

// Copyright (C) 2018-2025 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_CACHE_H
#define HOST_CACHE_H
 
#include <config.h>
#include <exceptions/exceptions.h>
#include <cc/data.h>
#include <asiolink/io_address.h>
#include <dhcpsrv/cache_host_data_source.h>
#include <dhcpsrv/host.h>
#include <dhcpsrv/subnet_id.h>
#include <config/cmds_impl.h>
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <mutex>
#include <vector>
 
namespace isc {
namespace host_cache {
 
class HostCacheImpl;

class HostCache : public isc::dhcp::CacheHostDataSource,
    private isc::config::CmdsImpl  {
public:

    HostCache();

    virtual ~HostCache();

    virtual void configure(const data::ConstElementPtr& config);

    virtual void setMaximum(size_t maximum);

    virtual size_t getMaximum() const;



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

    virtual dhcp::ConstHostCollection
    getAll4(const dhcp::SubnetID& subnet_id) const;

    virtual dhcp::ConstHostCollection
    getAll6(const dhcp::SubnetID& subnet_id) const;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virtual void add(const dhcp::HostPtr& host);

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

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

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

    void update(isc::dhcp::HostPtr const& host);

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

    virtual bool setIPReservationsUnique(const bool unique);

    virtual data::ElementPtr toElement() const;

    virtual size_t insert(const dhcp::ConstHostPtr& host, bool overwrite);

    virtual bool remove(const dhcp::HostPtr& host);

    virtual void flush(size_t count);

    virtual size_t size() const;

    virtual size_t capacity() const;

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


    int cacheSizeHandler(hooks::CalloutHandle& handle);

    int cacheClearHandler(hooks::CalloutHandle& handle);

    int cacheFlushHandler(hooks::CalloutHandle& handle);

    int cacheGetHandler(hooks::CalloutHandle& handle);

    int cacheGetByIdHandler(hooks::CalloutHandle& handle);

    int cacheInsertHandler(hooks::CalloutHandle& handle);

    int cacheWriteHandler(hooks::CalloutHandle& handle);

    int cacheLoadHandler(hooks::CalloutHandle& handle);

    int cacheRemoveHandler(hooks::CalloutHandle& handle);
 
protected:

    boost::shared_ptr<HostCacheImpl> impl_;

    boost::scoped_ptr<std::mutex> mutex_;
};

typedef boost::shared_ptr<HostCache> HostCachePtr;

data::ElementPtr toElement(const dhcp::ConstHostPtr& host);
 
} // end of namespace isc::host_cache
} // end of namespace isc
 
#endif