alloc_engine.cc 9.59 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// 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.

15 16
#include <dhcpsrv/alloc_engine.h>
#include <dhcpsrv/lease_mgr_factory.h>
17

18
#include <cstring>
19

20
#include <string.h>
21

22 23 24 25 26 27 28 29 30
using namespace isc::asiolink;

namespace isc {
namespace dhcp {

AllocEngine::IterativeAllocator::IterativeAllocator()
    :Allocator() {
}

31 32
isc::asiolink::IOAddress
AllocEngine::IterativeAllocator::increaseAddress(const isc::asiolink::IOAddress& addr) {
33 34 35 36 37 38 39 40 41
    // Get a buffer holding an address.
    const std::vector<uint8_t>& vec = addr.toBytes();
    // Get the address length.
    const int len = vec.size();

    // Since the same array will be used to hold the IPv4 and IPv6
    // address we have to make sure that the size of the array
    // we allocate will work for both types of address.
    BOOST_STATIC_ASSERT(V4ADDRESS_LEN <= V6ADDRESS_LEN);
42 43
    uint8_t packed[V6ADDRESS_LEN];

44 45 46 47
    // Copy the address. It can be either V4 or V6.
    std::memcpy(packed, &vec[0], len);

    // Increase the address.
48
    for (int i = len - 1; i >= 0; --i) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
49
        ++packed[i];
50 51 52 53 54
        if (packed[i] != 0) {
            break;
        }
    }

55
    return (IOAddress::fromBytes(addr.getFamily(), packed));
56 57 58
}


59 60
isc::asiolink::IOAddress
AllocEngine::IterativeAllocator::pickAddress(const Subnet6Ptr& subnet,
61 62
                                             const DuidPtr&,
                                             const IOAddress&) {
63

64
    // Let's get the last allocated address. It is usually set correctly,
65 66 67 68 69 70
    // but there are times when it won't be (like after removing a pool or
    // perhaps restaring the server).
    IOAddress last = subnet->getLastAllocated();

    const Pool6Collection& pools = subnet->getPools();

71
    if (pools.empty()) {
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
        isc_throw(AllocFailed, "No pools defined in selected subnet");
    }

    // first we need to find a pool the last address belongs to.
    Pool6Collection::const_iterator it;
    for (it = pools.begin(); it != pools.end(); ++it) {
        if ((*it)->inRange(last)) {
            break;
        }
    }

    // last one was bogus for one of several reasons:
    // - we just booted up and that's the first address we're allocating
    // - a subnet was removed or other reconfiguration just completed
    // - perhaps allocation algorithm was changed
    if (it == pools.end()) {
        // ok to access first element directly. We checked that pools is non-empty
        IOAddress next = pools[0]->getFirstAddress();
        subnet->setLastAllocated(next);
        return (next);
    }

    // Ok, we have a pool that the last address belonged to, let's use it.

    IOAddress next = increaseAddress(last); // basically addr++
    if ((*it)->inRange(next)) {
98
        // the next one is in the pool as well, so we haven't hit pool boundary yet
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
        subnet->setLastAllocated(next);
        return (next);
    }

    // We hit pool boundary, let's try to jump to the next pool and try again
    ++it;
    if (it == pools.end()) {
        // Really out of luck today. That was the last pool. Let's rewind
        // to the beginning.
        next = pools[0]->getFirstAddress();
        subnet->setLastAllocated(next);
        return (next);
    }

    // there is a next pool, let's try first adddress from it
    next = (*it)->getFirstAddress();
    subnet->setLastAllocated(next);
    return (next);
}

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
AllocEngine::HashedAllocator::HashedAllocator()
    :Allocator() {
    isc_throw(NotImplemented, "Hashed allocator is not implemented");
}


isc::asiolink::IOAddress
AllocEngine::HashedAllocator::pickAddress(const Subnet6Ptr&,
                                             const DuidPtr&,
                                             const IOAddress&) {
    isc_throw(NotImplemented, "Hashed allocator is not implemented");
}

AllocEngine::RandomAllocator::RandomAllocator()
    :Allocator() {
    isc_throw(NotImplemented, "Random allocator is not implemented");
}


isc::asiolink::IOAddress
AllocEngine::RandomAllocator::pickAddress(const Subnet6Ptr&,
                                             const DuidPtr&,
                                             const IOAddress&) {
    isc_throw(NotImplemented, "Random allocator is not implemented");
}

145 146 147 148 149

AllocEngine::AllocEngine(AllocType engine_type, unsigned int attempts)
    :attempts_(attempts) {
    switch (engine_type) {
    case ALLOC_ITERATIVE:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
150
        allocator_ = boost::shared_ptr<Allocator>(new IterativeAllocator());
151 152
        break;
    case ALLOC_HASHED:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
153
        allocator_ = boost::shared_ptr<Allocator>(new HashedAllocator());
154 155
        break;
    case ALLOC_RANDOM:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
156
        allocator_ = boost::shared_ptr<Allocator>(new RandomAllocator());
157 158 159 160 161 162 163 164 165 166 167
        break;

    default:
        isc_throw(BadValue, "Invalid/unsupported allocation algorithm");
    }
}

Lease6Ptr
AllocEngine::allocateAddress6(const Subnet6Ptr& subnet,
                              const DuidPtr& duid,
                              uint32_t iaid,
168
                              const IOAddress& hint,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
169 170
                              bool fake_allocation /* = false */ ) {

171 172 173 174 175 176
    // That check is not necessary. We create allocator in AllocEngine
    // constructor
    if (!allocator_) {
        isc_throw(InvalidOperation, "No allocator selected");
    }

177
    // check if there's existing lease for that subnet/duid/iaid combination.
178
    Lease6Ptr existing = LeaseMgrFactory::instance().getLease6(*duid, iaid, subnet->getID());
179 180 181 182 183 184
    if (existing) {
        // we have a lease already. This is a returning client, probably after
        // his reboot.
        return (existing);
    }

185 186
    // check if the hint is in pool and is available
    if (subnet->inPool(hint)) {
187
        existing = LeaseMgrFactory::instance().getLease6(hint);
188 189 190 191 192
        if (!existing) {
            /// @todo: check if the hint is reserved once we have host support
            /// implemented

            // the hint is valid and not currently used, let's create a lease for it
Tomek Mrugalski's avatar
Tomek Mrugalski committed
193
            Lease6Ptr lease = createLease(subnet, duid, iaid, hint, fake_allocation);
194 195 196 197 198 199 200 201

            // It can happen that the lease allocation failed (we could have lost
            // the race condition. That means that the hint is lo longer usable and
            // we need to continue the regular allocation path.
            if (lease) {
                return (lease);
            }
        }
202 203
    }

204 205 206 207 208 209 210
    unsigned int i = attempts_;
    do {
        IOAddress candidate = allocator_->pickAddress(subnet, duid, hint);

        /// @todo: check if the address is reserved once we have host support
        /// implemented

211
        Lease6Ptr existing = LeaseMgrFactory::instance().getLease6(candidate);
212 213 214
        // there's no existing lease for selected candidate, so it is
        // free. Let's allocate it.
        if (!existing) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
215 216
            Lease6Ptr lease = createLease(subnet, duid, iaid, candidate,
                                          fake_allocation);
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
            if (lease) {
                return (lease);
            }

            // Although the address was free just microseconds ago, it may have
            // been taken just now. If the lease insertion fails, we continue
            // allocation attempts.
        }

        // continue trying allocation until we run out of attempts
        // (or attempts are set to 0, which means infinite)
        --i;
    } while ( i || !attempts_);

    isc_throw(AllocFailed, "Failed to allocate address after " << attempts_
              << " tries");
}

Lease6Ptr AllocEngine::createLease(const Subnet6Ptr& subnet,
                                   const DuidPtr& duid,
                                   uint32_t iaid,
238
                                   const IOAddress& addr,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
239
                                   bool fake_allocation /*= false */ ) {
240

241 242 243
    Lease6Ptr lease(new Lease6(Lease6::LEASE_IA_NA, addr, duid, iaid,
                               subnet->getPreferred(), subnet->getValid(),
                               subnet->getT1(), subnet->getT2(), subnet->getID()));
244

Tomek Mrugalski's avatar
Tomek Mrugalski committed
245
    if (!fake_allocation) {
246
        // That is a real (REQUEST) allocation
247
        bool status = LeaseMgrFactory::instance().addLease(lease);
248

249 250 251 252 253 254 255 256 257 258
        if (status) {

            return (lease);
        } else {
            // One of many failures with LeaseMgr (e.g. lost connection to the
            // database, database failed etc.). One notable case for that
            // is that we are working in multi-process mode and we lost a race
            // (some other process got that address first)
            return (Lease6Ptr());
        }
259
    } else {
260 261 262 263
        // That is only fake (SOLICIT without rapid-commit) allocation

        // It is for advertise only. We should not insert the lease into LeaseMgr,
        // but rather check that we could have inserted it.
264
        Lease6Ptr existing = LeaseMgrFactory::instance().getLease6(addr);
265 266 267 268 269
        if (!existing) {
            return (lease);
        } else {
            return (Lease6Ptr());
        }
270 271 272 273
    }
}

AllocEngine::~AllocEngine() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
274
    // no need to delete allocator. smart_ptr will do the trick for us
275 276 277 278
}

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