flq_allocator.h

Go to the documentation of this file.

// Copyright (C) 2023-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 FLQ_ALLOCATOR_H
#define FLQ_ALLOCATOR_H
 
#include <dhcpsrv/allocator.h>
#include <dhcpsrv/flq_allocation_state.h>
#include <dhcpsrv/lease.h>
#include <cstdint>
 
namespace isc {
namespace dhcp {

class FreeLeaseQueueAllocator : public Allocator {
public:

    FreeLeaseQueueAllocator(Lease::Type type, const WeakSubnetPtr& subnet);

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

    virtual double
    getOccupancyRate(const asiolink::IOAddress& addr,
                     const ClientClasses& client_classes) const;

    virtual double
    getOccupancyRate(const asiolink::IOAddress& pref,
                     const uint8_t plen,
                     const ClientClasses& client_classes) const;
 
private:

    virtual void initAfterConfigureInternal();

    template<typename LeaseCollectionType>
    void populateFreeAddressLeases(const LeaseCollectionType& leases, const PoolCollection& pools);

    void populateFreePrefixDelegationLeases(const Lease6Collection& leases, const PoolCollection& pools);

    virtual asiolink::IOAddress pickAddressInternal(const ClientClasses& client_classes,
                                                    const IdentifierBaseTypePtr& duid,
                                                    const asiolink::IOAddress& hint);

    virtual isc::asiolink::IOAddress
    pickPrefixInternal(const ClientClasses& client_classes,
                       Pool6Ptr& pool,
                       const IdentifierBaseTypePtr& duid,
                       PrefixLenMatchType prefix_length_match,
                       const isc::asiolink::IOAddress& hint,
                       uint8_t hint_prefix_length);

    PoolFreeLeaseQueueAllocationStatePtr getPoolState(const PoolPtr& pool) const;

    PoolPtr getLeasePool(const LeasePtr& lease) const;

    void addLeaseCallback(LeasePtr lease);

    void addLeaseCallbackInternal(LeasePtr lease);

    void updateLeaseCallback(LeasePtr lease);

    void updateLeaseCallbackInternal(LeasePtr lease);

    void deleteLeaseCallback(LeasePtr lease);

    void deleteLeaseCallbackInternal(LeasePtr lease);

    uint64_t getRandomNumber(uint64_t limit);

    std::mt19937 generator_;
};
 
} // end of namespace isc::dhcp
} // end of namespace isc
 
#endif // FLQ_ALLOCATOR_H