base_host_data_source.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 BASE_HOST_DATA_SOURCE_H
#define BASE_HOST_DATA_SOURCE_H
 
#include <asiolink/io_address.h>
#include <database/database_connection.h>
#include <dhcpsrv/host.h>
#include <exceptions/exceptions.h>
 
#include <cstdint>
#include <limits>
#include <vector>
 
#include <boost/shared_ptr.hpp>
 
namespace isc {
namespace dhcp {

class DuplicateHost : public Exception {
public:
    DuplicateHost(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class HostNotFound : public Exception {
public:
    HostNotFound(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class ReservedAddress : public Exception {
public:
    ReservedAddress(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class BadHostAddress : public isc::BadValue {
public:
    BadHostAddress(const char* file, size_t line, const char* what) :
        isc::BadValue(file, line, what) { }
};

class HostPageSize {
public:

    explicit HostPageSize(const size_t page_size) : page_size_(page_size) {
        if (page_size_ == 0) {
            isc_throw(OutOfRange, "page size of retrieved hosts must not be 0");
        }
        if (page_size_ > std::numeric_limits<uint32_t>::max()) {
            isc_throw(OutOfRange, "page size of retrieved hosts must not be greate than "
                     << std::numeric_limits<uint32_t>::max());
        }
    }
 
    const size_t page_size_; 
};

class BaseHostDataSource {
public:

    enum IdType : uint16_t {
        ID_HWADDR = 0, 
        ID_DUID = 1    
    };

    virtual ~BaseHostDataSource() { }

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

    virtual ConstHostCollection
    getAll4(const SubnetID& subnet_id) const = 0;

    virtual ConstHostCollection
    getAll6(const SubnetID& subnet_id) const = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virtual void add(const HostPtr& host) = 0;

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

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

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

    virtual void update(HostPtr const& host) {
        bool deleted(false);
        if (host->getIPv4SubnetID() != SUBNET_ID_UNUSED) {
            std::vector<uint8_t> const& identifier(host->getIdentifier());
            deleted = del4(host->getIPv4SubnetID(), host->getIdentifierType(), identifier.data(),
                identifier.size());
        } else if (host->getIPv6SubnetID() != SUBNET_ID_UNUSED) {
            std::vector<uint8_t> const& identifier(host->getIdentifier());
            deleted = del6(host->getIPv6SubnetID(), host->getIdentifierType(), identifier.data(),
                identifier.size());
        } else {
            isc_throw(HostNotFound, "Mandatory 'subnet-id' parameter missing.");
        }
        if (!deleted) {
            isc_throw(HostNotFound, "Host not updated (not found).");
        }
        add(host);
    }

    virtual std::string getType() const = 0;

    virtual isc::db::DatabaseConnection::ParameterMap getParameters() const {
        return (isc::db::DatabaseConnection::ParameterMap());
    }

    virtual void commit() {}

    virtual void rollback() {}

    virtual bool setIPReservationsUnique(const bool unique) = 0;

    virtual bool isUnusable() {
        return (false);
    }
};

typedef boost::shared_ptr<BaseHostDataSource> HostDataSourcePtr;

typedef std::vector<HostDataSourcePtr> HostDataSourceList;
 
}  // namespace dhcp
}  // namespace isc
 
#endif // BASE_HOST_DATA_SOURCE_H