lease_query_impl.h

Go to the documentation of this file.

// Copyright (C) 2020-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 LEASE_QUERY_IMPL_H
#define LEASE_QUERY_IMPL_H
 
#include <exceptions/exceptions.h>
#include <asiolink/io_address.h>
#include <asiolink/io_service.h>
#include <dhcp/pkt.h>
#include <dhcpsrv/pool.h>
#include <cc/data.h>
#include <cc/simple_parser.h>
 
#include <boost/functional/hash.hpp>
#include <unordered_set>
 
namespace isc {
namespace lease_query {

class QueryTerminated : public isc::Exception {
public:
    QueryTerminated(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {
    }
};
 
#define CHECK_TERMINATED \
    if (LeaseQueryImpl::terminated_) { \
        isc_throw(isc::lease_query::QueryTerminated, "terminated"); \
    }

class AddressList {
public:
    AddressList(uint16_t family)
    : family_(family) { };

    void insert(const isc::asiolink::IOAddress& address);

    bool contains(const isc::asiolink::IOAddress& address) const;

    size_t size() const {
        return (addresses_.size());
    }

    uint16_t getFamily() {
        return (family_);
    }
 
private:
    uint16_t family_;

    std::unordered_set<asiolink::IOAddress, asiolink::IOAddress::Hash> addresses_;
};

struct PoolRangeHash {
    std::size_t operator()(const isc::dhcp::PoolPtr& p) const noexcept {
        const auto& f = p->getFirstAddress();
        const auto& l = p->getLastAddress();
 
        isc::asiolink::IOAddress::Hash haddr;
        std::size_t h1 = haddr(f);
        std::size_t h2 = haddr(l);
 
        // hash_combine
        return h1 ^ (h2 + 0x9e3779b97f4a7c15ULL + (h1 << 6) + (h1 >> 2));
    }
};

struct PoolRangeEqual {
    bool operator()(const isc::dhcp::PoolPtr& a,
                    const isc::dhcp::PoolPtr& b) const noexcept {
        return a->getFirstAddress() == b->getFirstAddress() &&
               a->getLastAddress()  == b->getLastAddress();
    }
};

using PoolRangeSet = std::unordered_set<isc::dhcp::PoolPtr,
                                        PoolRangeHash,
                                        PoolRangeEqual>;

class PoolSet {
public:
    PoolSet(uint16_t family)
    : family_(family) { };

    void insert(const isc::asiolink::IOAddress& prefix, uint8_t prefix_len);

    bool contains(const isc::asiolink::IOAddress& address) const;

    size_t size() const {
        return (pools_.size());
    }

    uint16_t getFamily() const {
        return (family_);
    }
 
private:
    uint16_t family_;

    PoolRangeSet pools_;
};

class LeaseQueryImpl : public boost::noncopyable {
public:
    LeaseQueryImpl(uint16_t family, const isc::data::ConstElementPtr config);

    virtual ~LeaseQueryImpl();

    bool isRequester(const isc::asiolink::IOAddress& address) const;

    size_t getNumRequesters() const {
        return (address_list_.size());
    }

    size_t getNumRequesterPools() const {
        return (pool_set_.size());
    }

    virtual void processQuery(isc::dhcp::PktPtr base_query,
                              bool& invalid) const = 0;

    static const isc::data::SimpleKeywords LEASE_QUERY_KEYWORDS;

    uint16_t getFamily() {
        return (address_list_.getFamily());
    }

    isc::asiolink::IOServicePtr getIOService() {
        return (io_service_);
    }

    void setIOService(isc::asiolink::IOServicePtr io_service) {
        io_service_ = io_service;
    }

    static bool terminated_;

    static size_t PageSize;
 
private:
    void parserRequesters(isc::data::ConstElementPtr requesters);

    isc::asiolink::IOServicePtr io_service_;

    AddressList address_list_;

    PoolSet pool_set_;
};

typedef boost::shared_ptr<LeaseQueryImpl> LeaseQueryImplPtr;
 
} // end of namespace isc::lease_query
} // end of namespace isc
 
#endif // LEASE_QUERY_IMPL_H