memfile_lease_mgr.h 9.17 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#ifndef MEMFILE_LEASE_MGR_H
#define MEMFILE_LEASE_MGR_H

18
#include <dhcp/hwaddr.h>
19 20
#include <dhcpsrv/lease_mgr.h>

21 22
#include <boost/multi_index/indexed_by.hpp>
#include <boost/multi_index/member.hpp>
23 24
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index_container.hpp>
25

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
namespace isc {
namespace dhcp {

// This is a concrete implementation of a Lease database.
//
// It is for testing purposes only. It is NOT a production code.
//
// It does not do anything useful now, and is used for abstract LeaseMgr
// class testing. It may later evolve into more useful backend if the
// need arises. We can reuse code from memfile benchmark. See code in
// tests/tools/dhcp-ubench/memfile_bench.{cc|h}
class Memfile_LeaseMgr : public LeaseMgr {
public:

    /// @brief The sole lease manager constructor
    ///
    /// dbconfig is a generic way of passing parameters. Parameters
    /// are passed in the "name=value" format, separated by spaces.
    /// Values may be enclosed in double quotes, if needed.
    ///
46 47 48
    /// @param parameters A data structure relating keywords and values
    ///        concerned with the database.
    Memfile_LeaseMgr(const ParameterMap& parameters);
49 50 51 52 53 54

    /// @brief Destructor (closes file)
    virtual ~Memfile_LeaseMgr();

    /// @brief Adds an IPv4 lease.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
55
    /// @todo Not implemented yet
56
    /// @param lease lease to be added
Tomek Mrugalski's avatar
Tomek Mrugalski committed
57
    virtual bool addLease(const Lease4Ptr& lease);
58 59 60 61

    /// @brief Adds an IPv6 lease.
    ///
    /// @param lease lease to be added
Tomek Mrugalski's avatar
Tomek Mrugalski committed
62
    virtual bool addLease(const Lease6Ptr& lease);
63 64 65

    /// @brief Returns existing IPv4 lease for specified IPv4 address.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
66
    /// @todo Not implemented yet
67 68 69
    /// @param addr address of the searched lease
    ///
    /// @return a collection of leases
70
    virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr) const;
71 72 73

    /// @brief Returns existing IPv4 leases for specified hardware address.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
74 75
    /// @todo Not implemented yet
    ///
76 77 78 79 80 81 82 83
    /// Although in the usual case there will be only one lease, for mobile
    /// clients or clients with multiple static/fixed/reserved leases there
    /// can be more than one. Thus return type is a container, not a single
    /// pointer.
    ///
    /// @param hwaddr hardware address of the client
    ///
    /// @return lease collection
84
    virtual Lease4Collection getLease4(const isc::dhcp::HWAddr& hwaddr) const;
85 86 87 88

    /// @brief Returns existing IPv4 leases for specified hardware address
    ///        and a subnet
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
89 90
    /// @todo Not implemented yet
    ///
91 92 93 94 95 96 97 98 99 100 101 102
    /// There can be at most one lease for a given HW address in a single
    /// pool, so this method with either return a single lease or NULL.
    ///
    /// @param hwaddr hardware address of the client
    /// @param subnet_id identifier of the subnet that lease must belong to
    ///
    /// @return a pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(const HWAddr& hwaddr,
                                SubnetID subnet_id) const;

    /// @brief Returns existing IPv4 lease for specified client-id
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
103 104
    /// @todo Not implemented yet
    ///
105 106 107 108 109 110 111 112
    /// @param clientid client identifier
    virtual Lease4Collection getLease4(const ClientId& clientid) const;

    /// @brief Returns existing IPv4 lease for specified client-id
    ///
    /// There can be at most one lease for a given HW address in a single
    /// pool, so this method with either return a single lease or NULL.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
113 114
    /// @todo Not implemented yet
    ///
115 116 117 118 119 120 121 122 123 124 125 126
    /// @param clientid client identifier
    /// @param subnet_id identifier of the subnet that lease must belong to
    ///
    /// @return a pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(const ClientId& clientid,
                                SubnetID subnet_id) const;

    /// @brief Returns existing IPv6 lease for a given IPv6 address.
    ///
    /// @param addr address of the searched lease
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
127
    virtual Lease6Ptr getLease6(const isc::asiolink::IOAddress& addr) const;
128 129 130

    /// @brief Returns existing IPv6 lease for a given DUID+IA combination
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
131 132
    /// @todo Not implemented yet
    ///
133 134 135 136
    /// @param duid client DUID
    /// @param iaid IA identifier
    ///
    /// @return collection of IPv6 leases
137
    virtual Lease6Collection getLease6(const DUID& duid, uint32_t iaid) const;
138 139 140

    /// @brief Returns existing IPv6 lease for a given DUID+IA combination
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
141 142
    /// @todo Not implemented yet
    ///
143 144 145 146 147
    /// @param duid client DUID
    /// @param iaid IA identifier
    /// @param subnet_id identifier of the subnet the lease must belong to
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
148
    virtual Lease6Ptr getLease6(const DUID& duid, uint32_t iaid, SubnetID subnet_id) const;
149 150 151

    /// @brief Updates IPv4 lease.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
152 153
    /// @todo Not implemented yet
    ///
154 155 156
    /// @param lease4 The lease to be updated.
    ///
    /// If no such lease is present, an exception will be thrown.
157
    virtual void updateLease4(const Lease4Ptr& lease4);
158 159 160

    /// @brief Updates IPv4 lease.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
161 162
    /// @todo Not implemented yet
    ///
163
    /// @param lease6 The lease to be updated.
164 165
    ///
    /// If no such lease is present, an exception will be thrown.
166
    virtual void updateLease6(const Lease6Ptr& lease6);
167 168 169

    /// @brief Deletes a lease.
    ///
170 171
    /// @param addr Address of the lease to be deleted. (This can be IPv4 or
    ///        IPv6.)
172 173
    ///
    /// @return true if deletion was successful, false if no such lease exists
174
    virtual bool deleteLease(const isc::asiolink::IOAddress& addr);
175

176 177 178 179 180 181 182 183 184
    /// @brief Return backend type
    ///
    /// Returns the type of the backend.
    ///
    /// @return Type of the backend.
    virtual std::string getType() const {
        return (std::string("memfile"));
    }

185 186
    /// @brief Returns backend name.
    ///
187
    /// For now, memfile can only store data in memory.
188 189 190
    ///
    /// @return Name of the backend.
    virtual std::string getName() const {
191
        return ("memory");
192
    }
193 194 195 196

    /// @brief Returns description of the backend.
    ///
    /// This description may be multiline text that describes the backend.
197 198 199
    ///
    /// @return Description of the backend.
    virtual std::string getDescription() const;
200 201

    /// @brief Returns backend version.
202 203 204
    ///
    /// @return Version number as a pair of unsigned integers.  "first" is the
    ///         major version number, "second" the minor number.
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    virtual std::pair<uint32_t, uint32_t> getVersion() const {
        return (std::make_pair(1, 0));
    }

    /// @brief Commit Transactions
    ///
    /// Commits all pending database operations.  On databases that don't
    /// support transactions, this is a no-op.
    virtual void commit();

    /// @brief Rollback Transactions
    ///
    /// Rolls back all pending database operations.  On databases that don't
    /// support transactions, this is a no-op.
    virtual void rollback();
220 221 222 223 224 225 226 227 228

protected:

    typedef boost::multi_index_container< // this is a multi-index container...
    Lease6Ptr, // it will hold shared_ptr to leases6
        boost::multi_index::indexed_by< // and will be sorted by
            // IPv6 address that are unique. That particular key is a member
            // of the Lease6 structure, is of type IOAddress and can be accessed
            // by doing &Lease6::addr_
229 230
            boost::multi_index::ordered_unique<
                boost::multi_index::member<Lease, isc::asiolink::IOAddress, &Lease::addr_>
231 232 233 234
            >
        >
    > Lease6Storage; // Let the whole contraption be called Lease6Storage.

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    typedef boost::multi_index_container< // this is a multi-index container...
    Lease4Ptr, // it will hold shared_ptr to leases6
        boost::multi_index::indexed_by< // and will be sorted by
            // IPv6 address that are unique. That particular key is a member
            // of the Lease6 structure, is of type IOAddress and can be accessed
            // by doing &Lease6::addr_
            boost::multi_index::ordered_unique<
                boost::multi_index::member<Lease, isc::asiolink::IOAddress, &Lease::addr_>
            >
        >
    > Lease4Storage; // Let the whole contraption be called Lease6Storage.

    /// @brief stores IPv4 leases
    Lease4Storage storage4_;

    /// @brief stores IPv6 leases
251 252 253 254 255 256
    Lease6Storage storage6_;
};

}; // end of isc::dhcp namespace
}; // end of isc namespace

257
#endif // MEMFILE_LEASE_MGR