memfile_lease_mgr.h

Go to the documentation of this file.

// Copyright (C) 2012-2021 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 MEMFILE_LEASE_MGR_H
#define MEMFILE_LEASE_MGR_H

#include <asiolink/interval_timer.h>
#include <asiolink/process_spawn.h>
#include <database/database_connection.h>
#include <dhcp/hwaddr.h>
#include <dhcpsrv/csv_lease_file4.h>
#include <dhcpsrv/csv_lease_file6.h>
#include <dhcpsrv/memfile_lease_storage.h>
#include <dhcpsrv/lease_mgr.h>

#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>

#include <mutex>

namespace isc {
namespace dhcp {

class LFCSetup;

class Memfile_LeaseMgr : public LeaseMgr {
public:

    static const int MAJOR_VERSION = 2;

    static const int MINOR_VERSION = 1;



    enum Universe {
        V4,
        V6
    };



    Memfile_LeaseMgr(const db::DatabaseConnection::ParameterMap& parameters);

    virtual ~Memfile_LeaseMgr();

    static std::string getDBVersion();

    virtual bool addLease(const Lease4Ptr& lease);

    virtual bool addLease(const Lease6Ptr& lease);

    virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr) const;

    virtual Lease4Collection getLease4(const isc::dhcp::HWAddr& hwaddr) const;

    virtual Lease4Ptr getLease4(const HWAddr& hwaddr,
                                SubnetID subnet_id) const;

    virtual Lease4Collection getLease4(const ClientId& client_id) const;

    virtual Lease4Ptr getLease4(const ClientId& clientid,
                                SubnetID subnet_id) const;

    virtual Lease4Collection getLeases4(SubnetID subnet_id) const;

    virtual Lease4Collection getLeases4(const std::string& hostname) const;

    virtual Lease4Collection getLeases4() const;

    virtual Lease4Collection
    getLeases4(const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const;

    virtual Lease6Ptr getLease6(Lease::Type type,
                                const isc::asiolink::IOAddress& addr) const;

    virtual Lease6Collection getLeases6(Lease::Type type,
                                        const DUID& duid,
                                        uint32_t iaid) const;

    virtual Lease6Collection getLeases6(Lease::Type type,
                                        const DUID& duid,
                                        uint32_t iaid,
                                        SubnetID subnet_id) const;

    virtual Lease6Collection getLeases6(SubnetID subnet_id) const;

    virtual Lease6Collection getLeases6(const std::string& hostname) const;

    virtual Lease6Collection getLeases6() const;

    virtual Lease6Collection getLeases6(const DUID& duid) const;

    virtual Lease6Collection
    getLeases6(const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const;

    virtual void getExpiredLeases4(Lease4Collection& expired_leases,
                                   const size_t max_leases) const;

    virtual void getExpiredLeases6(Lease6Collection& expired_leases,
                                   const size_t max_leases) const;

    virtual void updateLease4(const Lease4Ptr& lease4);

    virtual void updateLease6(const Lease6Ptr& lease6);

    virtual bool deleteLease(const Lease4Ptr& lease);

    virtual bool deleteLease(const Lease6Ptr& lease);

    virtual uint64_t deleteExpiredReclaimedLeases4(const uint32_t secs);

    virtual uint64_t deleteExpiredReclaimedLeases6(const uint32_t secs);

    virtual size_t wipeLeases4(const SubnetID& subnet_id);

    virtual size_t wipeLeases6(const SubnetID& subnet_id);

private:


    bool addLeaseInternal(const Lease4Ptr& lease);

    bool addLeaseInternal(const Lease6Ptr& lease);

    Lease4Ptr getLease4Internal(const isc::asiolink::IOAddress& addr) const;

    void getLease4Internal(const isc::dhcp::HWAddr& hwaddr,
                           Lease4Collection& collection) const;

    Lease4Ptr getLease4Internal(const HWAddr& hwaddr,
                                SubnetID subnet_id) const;

    void getLease4Internal(const ClientId& client_id,
                           Lease4Collection& collection) const;

    Lease4Ptr getLease4Internal(const ClientId& clientid,
                                const HWAddr& hwaddr,
                                SubnetID subnet_id) const;

    Lease4Ptr getLease4Internal(const ClientId& clientid,
                                SubnetID subnet_id) const;

    void getLeases4Internal(SubnetID subnet_id,
                            Lease4Collection& collection) const;

    void getLeases4Internal(const std::string& hostname,
                            Lease4Collection& collection) const;

    void getLeases4Internal(Lease4Collection& collection) const;

    void getLeases4Internal(const asiolink::IOAddress& lower_bound_address,
                            const LeasePageSize& page_size,
                            Lease4Collection& collection) const;

    Lease6Ptr getLease6Internal(Lease::Type type,
                                const isc::asiolink::IOAddress& addr) const;

    void getLeases6Internal(Lease::Type type,
                            const DUID& duid,
                            uint32_t iaid,
                            Lease6Collection& collection) const;

    void getLeases6Internal(Lease::Type type,
                            const DUID& duid,
                            uint32_t iaid,
                            SubnetID subnet_id,
                            Lease6Collection& collection) const;

    void getLeases6Internal(SubnetID subnet_id,
                            Lease6Collection& collection) const;

    void getLeases6Internal(const std::string& hostname,
                            Lease6Collection& collection) const;

    void getLeases6Internal(Lease6Collection& collection) const;

    void getLeases6Internal(const DUID& duid,
                            Lease6Collection& collection) const;

    void getLeases6Internal(const asiolink::IOAddress& lower_bound_address,
                            const LeasePageSize& page_size,
                            Lease6Collection& collection) const;

    void getExpiredLeases4Internal(Lease4Collection& expired_leases,
                                   const size_t max_leases) const;

    void getExpiredLeases6Internal(Lease6Collection& expired_leases,
                                   const size_t max_leases) const;

    void updateLease4Internal(const Lease4Ptr& lease4);

    void updateLease6Internal(const Lease6Ptr& lease6);

    bool deleteLeaseInternal(const Lease4Ptr& addr);

    bool deleteLeaseInternal(const Lease6Ptr& addr);

    size_t wipeLeases4Internal(const SubnetID& subnet_id);

    size_t wipeLeases6Internal(const SubnetID& subnet_id);

    template<typename IndexType, typename LeaseType, typename StorageType,
             typename LeaseFileType>
    uint64_t deleteExpiredReclaimedLeases(const uint32_t secs,
                                          const Universe& universe,
                                          StorageType& storage,
                                          LeaseFileType& lease_file) const;

public:

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

    virtual std::string getName() const {
        return ("memory");
    }

    virtual std::string getDescription() const;

    virtual std::pair<uint32_t, uint32_t> getVersion() const {
        return (std::make_pair(MAJOR_VERSION, MINOR_VERSION));
    }

    virtual void commit();

    virtual void rollback();




    enum LFCFileType {
        FILE_CURRENT,  
        FILE_INPUT,    
        FILE_PREVIOUS, 
        FILE_OUTPUT,   
        FILE_FINISH,   
        FILE_PID       
    };

    static std::string appendSuffix(const std::string& file_name,
                                    const LFCFileType& file_type);




    std::string getDefaultLeaseFilePath(Universe u) const;

    std::string getLeaseFilePath(Universe u) const;

    bool persistLeases(Universe u) const;


private:


    std::string initLeaseFilePath(Universe u);

    template<typename LeaseObjectType, typename LeaseFileType,
             typename StorageType>
    bool loadLeasesFromFiles(const std::string& filename,
                             boost::shared_ptr<LeaseFileType>& lease_file,
                             StorageType& storage);

    Lease4Storage storage4_;

    Lease6Storage storage6_;

    boost::shared_ptr<CSVLeaseFile4> lease_file4_;

    boost::shared_ptr<CSVLeaseFile6> lease_file6_;

public:



    bool isLFCRunning() const;

    int getLFCExitStatus() const;

    virtual LeaseStatsQueryPtr startLeaseStatsQuery4();

    virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID& subnet_id);

    virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery4(const SubnetID& first_subnet_id,
                                                                const SubnetID& last_subnet_id);

    virtual LeaseStatsQueryPtr startLeaseStatsQuery6();

    virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID& subnet_id);

    virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery6(const SubnetID& first_subnet_id,
                                                                const SubnetID& last_subnet_id);



protected:

    virtual void lfcCallback();



private:

    void lfcSetup(bool conversion_needed = false);

    template<typename LeaseFileType>
    void lfcExecute(boost::shared_ptr<LeaseFileType>& lease_file);

    boost::scoped_ptr<LFCSetup> lfc_setup_;

    db::DatabaseConnection conn_;


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

}  // namespace dhcp
}  // namespace isc

#endif // MEMFILE_LEASE_MGR_H