subnet.h

Go to the documentation of this file.

// Copyright (C) 2012-2018 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 SUBNET_H
#define SUBNET_H
 
#include <asiolink/io_address.h>
#include <cc/data.h>
#include <cc/user_context.h>
#include <dhcp/option_space_container.h>
#include <dhcpsrv/assignable_network.h>
#include <dhcpsrv/lease.h>
#include <dhcpsrv/pool.h>
#include <dhcpsrv/subnet_id.h>
#include <dhcpsrv/triplet.h>
 
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/indexed_by.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/random_access_index.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/pointer_cast.hpp>
#include <boost/shared_ptr.hpp>
#include <cstdint>
#include <map>
#include <utility>
 
namespace isc {
namespace dhcp {
 
class Subnet : public virtual data::UserContext, public data::CfgToElement {
 
    // Assignable network is our friend to allow it to call
    // @ref Subnet::setSharedNetwork private function.
    friend class AssignableNetwork;
 
public:
 
    bool inRange(const isc::asiolink::IOAddress& addr) const;
 
    bool inPool(Lease::Type type, const isc::asiolink::IOAddress& addr) const;
 
    bool inPool(Lease::Type type,
                const isc::asiolink::IOAddress& addr,
                const ClientClasses& client_classes) const;
 
    isc::asiolink::IOAddress getLastAllocated(Lease::Type type) const;
 
    boost::posix_time::ptime getLastAllocatedTime(const Lease::Type& lease_type) const;
 
    void setLastAllocated(Lease::Type type,
                          const isc::asiolink::IOAddress& addr);
 
    SubnetID getID() const { return (id_); }
 
    std::pair<isc::asiolink::IOAddress, uint8_t> get() const {
        return (std::make_pair(prefix_, prefix_len_));
    }
 
    void addPool(const PoolPtr& pool);
 
    void delPools(Lease::Type type);
 
    const PoolPtr getPool(Lease::Type type, const isc::asiolink::IOAddress& addr,
                          bool anypool = true) const;
 
    const PoolPtr getPool(Lease::Type type,
                          const ClientClasses& client_classes,
                          const isc::asiolink::IOAddress& addr) const;
 
    PoolPtr getAnyPool(Lease::Type type) {
        return (getPool(type, default_pool()));
    }
 
    virtual isc::asiolink::IOAddress default_pool() const = 0;
 
    const PoolCollection& getPools(Lease::Type type) const;
 
    uint64_t getPoolCapacity(Lease::Type type) const;
 
    uint64_t getPoolCapacity(Lease::Type type,
                             const ClientClasses& client_classes) const;
 
    virtual std::string toText() const;
 
    static void resetSubnetID() {
        static_id_ = 1;
    }
 
    template<typename SharedNetworkPtrType>
    void getSharedNetwork(SharedNetworkPtrType& shared_network) const {
        shared_network = boost::dynamic_pointer_cast<
            typename SharedNetworkPtrType::element_type>(shared_network_.lock());
    }
 
private:
 
    void setSharedNetwork(const NetworkPtr& shared_network) {
        shared_network_ = shared_network;
    }
 
public:
 
    std::string getSharedNetworkName() const {
        return (shared_network_name_);
    }
 
    void setSharedNetworkName(const std::string& shared_network_name) {
        shared_network_name_ = shared_network_name;
    }
 
protected:
    PoolCollection& getPoolsWritable(Lease::Type type);
 
    //
    Subnet(const isc::asiolink::IOAddress& prefix, uint8_t len,
           const SubnetID id);
 
    virtual ~Subnet() { };
 
    static SubnetID static_id_;
 
    static SubnetID generateNextID() {
        if (static_id_ == SUBNET_ID_MAX) {
            resetSubnetID();
        }
 
        return (static_id_++);
    }
 
    virtual void checkType(Lease::Type type) const = 0;
 
    uint64_t sumPoolCapacity(const PoolCollection& pools) const;
 
    uint64_t sumPoolCapacity(const PoolCollection& pools,
                             const ClientClasses& client_classes) const;
 
    bool poolOverlaps(const Lease::Type& pool_type, const PoolPtr& pool) const;
 
    virtual data::ElementPtr toElement() const;
 
    static std::pair<asiolink::IOAddress, uint8_t>
    parsePrefixCommon(const std::string& prefix);
 
    SubnetID id_;
 
    PoolCollection pools_;
 
    PoolCollection pools_ta_;
 
    PoolCollection pools_pd_;
 
    isc::asiolink::IOAddress prefix_;
 
    uint8_t prefix_len_;
 
    isc::asiolink::IOAddress last_allocated_ia_;
 
    isc::asiolink::IOAddress last_allocated_ta_;
 
    isc::asiolink::IOAddress last_allocated_pd_;
 
    std::map<Lease::Type, boost::posix_time::ptime> last_allocated_time_;
 
    std::string iface_;
 
    WeakNetworkPtr shared_network_;
 
    std::string shared_network_name_;
};
 
typedef boost::shared_ptr<Subnet> SubnetPtr;
 
 
class Subnet4;
 
typedef boost::shared_ptr<const Subnet4> ConstSubnet4Ptr;
 
typedef boost::shared_ptr<Subnet4> Subnet4Ptr;
 
class Subnet4 : public Subnet, public Network4 {
public:
 
    Subnet4(const isc::asiolink::IOAddress& prefix, uint8_t length,
            const Triplet<uint32_t>& t1,
            const Triplet<uint32_t>& t2,
            const Triplet<uint32_t>& valid_lifetime,
            const SubnetID id = 0);
 
    Subnet4Ptr getNextSubnet(const Subnet4Ptr& first_subnet) const;
 
    Subnet4Ptr getNextSubnet(const Subnet4Ptr& first_subnet,
                             const ClientClasses& client_classes) const;
 
    virtual bool
    clientSupported(const isc::dhcp::ClientClasses& client_classes) const;
 
    void setSiaddr(const isc::asiolink::IOAddress& siaddr);
 
    isc::asiolink::IOAddress getSiaddr() const;
 
    void setSname(const std::string& sname);
 
    const std::string& getSname() const;
 
    void setFilename(const std::string& filename);
 
    const std::string& getFilename() const;
 
    Cfg4o6& get4o6() {
        return (dhcp4o6_);
    }
 
    const Cfg4o6& get4o6() const {
        return (dhcp4o6_);
    }
 
    virtual data::ElementPtr toElement() const;
 
    static std::pair<asiolink::IOAddress, uint8_t>
    parsePrefix(const std::string& prefix);
 
private:
 
    virtual isc::asiolink::IOAddress default_pool() const {
        return (isc::asiolink::IOAddress("0.0.0.0"));
    }
 
    virtual void checkType(Lease::Type type) const;
 
    isc::asiolink::IOAddress siaddr_;
 
    std::string sname_;
 
    std::string filename_;
 
    Cfg4o6 dhcp4o6_;
};
 
class Subnet6;
 
typedef boost::shared_ptr<const Subnet6> ConstSubnet6Ptr;
 
typedef boost::shared_ptr<Subnet6> Subnet6Ptr;
 
class Subnet6 : public Subnet, public Network6 {
public:
 
    Subnet6(const isc::asiolink::IOAddress& prefix, uint8_t length,
            const Triplet<uint32_t>& t1,
            const Triplet<uint32_t>& t2,
            const Triplet<uint32_t>& preferred_lifetime,
            const Triplet<uint32_t>& valid_lifetime,
            const SubnetID id = 0);
 
    Subnet6Ptr getNextSubnet(const Subnet6Ptr& first_subnet) const;
 
    Subnet6Ptr getNextSubnet(const Subnet6Ptr& first_subnet,
                             const ClientClasses& client_classes) const;
 
    virtual bool
    clientSupported(const isc::dhcp::ClientClasses& client_classes) const;
 
    virtual data::ElementPtr toElement() const;
 
    static std::pair<asiolink::IOAddress, uint8_t>
    parsePrefix(const std::string& prefix);
 
private:
 
    virtual isc::asiolink::IOAddress default_pool() const {
        return (isc::asiolink::IOAddress("::"));
    }
 
    virtual void checkType(Lease::Type type) const;
 
};
 
 
 
struct SubnetRandomAccessIndexTag { };
 
struct SubnetSubnetIdIndexTag { };
 
struct SubnetPrefixIndexTag { };
 
struct SubnetServerIdIndexTag { };
 
typedef boost::multi_index_container<
    // Multi index container holds pointers to the subnets.
    Subnet4Ptr,
    // The following holds all indexes.
    boost::multi_index::indexed_by<
        // First is the random access index allowing for accessing
        // objects just like we'd do with a vector.
        boost::multi_index::random_access<
            boost::multi_index::tag<SubnetRandomAccessIndexTag>
        >,
        // Second index allows for searching using subnet identifier.
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<SubnetSubnetIdIndexTag>,
            boost::multi_index::const_mem_fun<Subnet, SubnetID, &Subnet::getID>
        >,
        // Third index allows for searching using an output from toText function.
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<SubnetPrefixIndexTag>,
            boost::multi_index::const_mem_fun<Subnet, std::string, &Subnet::toText>
        >,
 
        // Fourth index allows for searching using an output from getServerId
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<SubnetServerIdIndexTag>,
            boost::multi_index::const_mem_fun<Network4, asiolink::IOAddress,
                                              &Network4::getServerId>
        >
    >
> Subnet4Collection;
 
typedef boost::multi_index_container<
    // Multi index container holds pointers to the subnets.
    Subnet6Ptr,
    // The following holds all indexes.
    boost::multi_index::indexed_by<
        // First is the random access index allowing for accessing
        // objects just like we'd do with a vector.
        boost::multi_index::random_access<
            boost::multi_index::tag<SubnetRandomAccessIndexTag>
        >,
        // Second index allows for searching using subnet identifier.
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<SubnetSubnetIdIndexTag>,
            boost::multi_index::const_mem_fun<Subnet, SubnetID, &Subnet::getID>
        >,
        // Third index allows for searching using an output from toText function.
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<SubnetPrefixIndexTag>,
            boost::multi_index::const_mem_fun<Subnet, std::string, &Subnet::toText>
        >
    >
> Subnet6Collection;
 
 
} // end of isc::dhcp namespace
} // end of isc namespace
 
#endif // SUBNET_H