cfg_consistency.h

Go to the documentation of this file.

// Copyright (C) 2018-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 CFG_CONSISTENCY_H
#define CFG_CONSISTENCY_H
 
#include <cc/cfg_to_element.h>
#include <cc/user_context.h>
 
#include <cstdint>
 
namespace isc {
namespace dhcp {
 

class CfgConsistency : public isc::data::UserContext, public isc::data::CfgToElement {
 
    public:

    enum LeaseSanity : uint16_t {
        LEASE_CHECK_NONE, // Skip sanity checks
        LEASE_CHECK_WARN, // Print a warning if subnet-id is incorrect.
        LEASE_CHECK_FIX, // If subnet-id is incorrect, try to fix it (try to pick
                              // appropriate subnet, but if it fails, keep the lease,
                              // despite its broken subnet-id.
        LEASE_CHECK_FIX_DEL,  // If subnet-id is incorrect, try to fix it (try to pick
                              // appropriate subnet.  If it fails, delete broken lease.
        LEASE_CHECK_DEL       // Delete leases with invalid subnet-id.
    };

    enum ExtendedInfoSanity : uint16_t {
        EXTENDED_INFO_CHECK_NONE, // Skip sanity checks.
        EXTENDED_INFO_CHECK_FIX, // Fix extended info common inconsistencies.
        EXTENDED_INFO_CHECK_STRICT, // Fix extended info inconsistencies which
                                    // have an impact for Bulk Lease Query.
        EXTENDED_INFO_CHECK_PEDANTIC // Fix all extended info inconsistencies.
    };

    CfgConsistency()
        : lease_sanity_check_(LEASE_CHECK_NONE),
          extended_info_sanity_check_(EXTENDED_INFO_CHECK_FIX) {
    }

    virtual isc::data::ElementPtr toElement() const;

    void setLeaseSanityCheck(LeaseSanity l) {
        lease_sanity_check_ = l;
    }

    LeaseSanity getLeaseSanityCheck() const {
        return (lease_sanity_check_);
    }

    static std::string sanityCheckToText(LeaseSanity check_type);

    void setExtendedInfoSanityCheck(ExtendedInfoSanity l) {
        extended_info_sanity_check_ = l;
    }

    ExtendedInfoSanity getExtendedInfoSanityCheck() const {
        return (extended_info_sanity_check_);
    }

    static std::string sanityCheckToText(ExtendedInfoSanity check_type);
 
 private:

    LeaseSanity lease_sanity_check_;

    ExtendedInfoSanity extended_info_sanity_check_;
};

typedef boost::shared_ptr<CfgConsistency> CfgConsistencyPtr;

typedef boost::shared_ptr<const CfgConsistency> ConstCfgConsistencyPtr;
 
} // namespace isc::dhcp
} // namespace isc
 
#endif /* CFG_CONSISTENCY_H */