kea/tests/tools/dhcp-ubench/memfile_ubench.cc

// 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.

#include <sstream>
#include <iostream>
#include <map>
#include "memfile_ubench.h"

using namespace std;


/// @brief In-memory + lease file database implementation
///
/// This is a simplified in-memory database that mimics ISC DHCP4 implementation.
/// It uses STL and boost: std::map for storage, boost::shared ptr for memory
/// management. It does use C file operations (fopen, fwrite, etc.), because
/// C++ streams does not offer any easy way to flush their contents, like
/// fflush() and fsync() does.
///
/// IPv4 address is used as a key in the hash.
class memfile_LeaseMgr {
public:

    /// A hash table for Lease4 leases.
    typedef std::map<uint32_t /* addr */, Lease4Ptr /* lease info */> IPv4Hash;

    /// An iterator for Lease4 hash table.
    typedef std::map<uint32_t, Lease4Ptr>::iterator leaseIt;

    /// @brief The sole memfile lease manager constructor
    ///
    /// @param filename name of the lease file (will be overwritten)
    /// @param sync should operations be
    memfile_LeaseMgr(const std::string& filename, bool sync);

    /// @brief Destructor (closes file)
    ~memfile_LeaseMgr();

    /// @brief adds a lease to the hash
    ///
    /// @param lease lease to be added
    bool addLease(Lease4Ptr lease);

    /// @brief returns existing lease
    ///
    /// @param addr address of the searched lease
    ///
    /// @return smart pointer to the lease (or NULL if lease is not found)
    Lease4Ptr getLease(uint32_t addr);

    /// @brief Simplified lease update.
    ///
    /// Searches for a lease and then updates its client last transmission
    /// time. Writes new lease content to lease file (and calls fflush()/fsync(),
    /// if synchronous operation is enabled).
    ///
    /// @param addr IPv4 address
    /// @param new_cltt New client last transmission time
    ///
    /// @return pointer to the updated lease (or NULL)
    Lease4Ptr updateLease(uint32_t addr, uint32_t new_cltt);

    /// @brief Deletes a lease.
    ///
    /// @param addr IPv4 address of the lease to be deleted.
    ///
    /// @return true if deletion was successful, false if no such lease exists
    bool deleteLease(uint32_t addr);

protected:

    /// @brief Writes updated lease to a file.
    ///
    /// @param lease lease to be written
    void writeLease(Lease4Ptr lease);

    /// Name of the lease file.
    std::string Filename_;

    /// should we do flush after each operation?
    bool Sync_;

    /// File handle to the open lease file.
    FILE * File_;

    /// Hash table for IPv4 leases
    IPv4Hash ip4Hash_;
};

memfile_LeaseMgr::memfile_LeaseMgr(const std::string& filename, bool sync)
    : Filename_(filename), Sync_(sync) {
    File_ = fopen(filename.c_str(), "w");
    if (!File_) {
        throw "Failed to create file " + filename;
    }

}

memfile_LeaseMgr::~memfile_LeaseMgr() {
    fclose(File_);
}

void memfile_LeaseMgr::writeLease(Lease4Ptr lease) {
    fprintf(File_, "lease %d {\n  hw-addr ", lease->addr);
    for (std::vector<uint8_t>::const_iterator it = lease->hwaddr.begin();
         it != lease->hwaddr.end(); ++it) {
        fprintf(File_,"%02x:", *it);
    }
    fprintf(File_, ";\n client-id ");
    for (std::vector<uint8_t>::const_iterator it = lease->client_id.begin();
         it != lease->client_id.end(); ++it) {
        fprintf(File_, "%02x:", *it);
    }
    fprintf(File_, ";\n  valid-lifetime %d;\n  recycle-time %d;\n"
            "  cltt %d;\n  pool-id %d;\n  fixed %s;  hostname %s;\n"
            "  fqdn_fwd %s;\n  fqdn_rev %s;\n};\n",
            lease->valid_lft, lease->recycle_time, (int)lease->cltt,
            lease->pool_id, lease->fixed?"true":"false",
            lease->hostname.c_str(), lease->fqdn_fwd?"true":"false",
            lease->fqdn_rev?"true":"false");

    if (Sync_) {
        fflush(File_);
        fsync(fileno(File_));
    }
}

bool memfile_LeaseMgr::addLease(Lease4Ptr lease) {
    if (ip4Hash_.find(lease->addr) != ip4Hash_.end()) {
        // there is such an address already in the hash
        return false;
    }
    ip4Hash_.insert(pair<uint32_t, Lease4Ptr>(lease->addr, lease));
    lease->hostname = "add";
    writeLease(lease);
    return (true);
}

Lease4Ptr memfile_LeaseMgr::getLease(uint32_t addr) {
    leaseIt x = ip4Hash_.find(addr);
    if (x != ip4Hash_.end())
        return x->second; // found

    // not found
    return Lease4Ptr();
}

Lease4Ptr memfile_LeaseMgr::updateLease(uint32_t addr, uint32_t new_cltt) {
    leaseIt x = ip4Hash_.find(addr);
    if (x != ip4Hash_.end()) {
        x->second->cltt = new_cltt;
        x->second->hostname = "update";
        writeLease(x->second);
        return x->second;
    }
    return Lease4Ptr();
}

bool memfile_LeaseMgr::deleteLease(uint32_t addr) {
    leaseIt x = ip4Hash_.find(addr);
    if (x != ip4Hash_.end()) {
        x->second->hostname = "delete";
        writeLease(x->second);
        ip4Hash_.erase(x);
        return true;
    }
    return false;
}

memfile_uBenchmark::memfile_uBenchmark(const string& filename,
                                       uint32_t num_iterations,
                                       bool sync,
                                       bool verbose)
    :uBenchmark(num_iterations, filename, sync, verbose),
     Filename_(filename) {

}

void memfile_uBenchmark::connect() {
    try {
        LeaseMgr_ = new memfile_LeaseMgr(Filename_, Sync_);
    } catch (const std::string& e) {
        failure(e.c_str());
    }
}

void memfile_uBenchmark::disconnect() {
    delete LeaseMgr_;
    LeaseMgr_ = NULL;
}

void memfile_uBenchmark::createLease4Test() {
    if (!LeaseMgr_) {
        throw "No LeaseMgr instantiated.";
    }

    uint32_t addr = BASE_ADDR4;     // Let's start with 1.0.0.0 address
    const uint8_t hwaddr_len = 20;  // Not a real field
    char hwaddr_tmp[hwaddr_len];
    const uint8_t client_id_len = 128;
    char client_id_tmp[client_id_len];
    uint32_t valid_lft = 1000;      // We can use the same value for all leases
    uint32_t recycle_time = 0;      // Not supported in any foreseeable future,
                                    //     so keep this as 0
    time_t cltt = time(NULL);       // Timestamp
    uint32_t pool_id = 0;           // Let's use pools 0-99
    bool fixed = false;
    string hostname("foo");         // Will generate it dynamically
    bool fqdn_fwd = true;           // Let's pretend to do AAAA update
    bool fqdn_rev = true;           // Let's pretend to do PTR update

    printf("CREATE:   ");

    // While we could put the data directly into vector, I would like to
    // keep the code as  similar to other benchmarks as possible
    for (uint8_t i = 0; i < hwaddr_len; i++) {
        hwaddr_tmp[i] = 65 + i;
    }
    vector<uint8_t> hwaddr(hwaddr_tmp, hwaddr_tmp + 19);

    for (uint8_t i = 0; i < client_id_len; i++) {
        client_id_tmp[i] = 33 + i;
    }
    vector<uint8_t> client_id(client_id_tmp, client_id_tmp + 19);

    for (uint32_t i = 0; i < Num_; i++) {

        cltt++;

        Lease4Ptr lease = boost::shared_ptr<Lease4>(new Lease4());
        lease->addr = addr;
        lease->hwaddr = hwaddr;
        lease->client_id = client_id;
        lease->valid_lft = valid_lft;
        lease->recycle_time = recycle_time;
        lease->cltt = cltt;
        lease->pool_id = pool_id;
        lease->fixed = fixed;
        lease->hostname = "foo";
        lease->fqdn_fwd = fqdn_fwd;
        lease->fqdn_rev = fqdn_rev;

        if (!LeaseMgr_->addLease(lease)) {
            failure("addLease() failed");
        } else {
            if (Verbose_) {
                printf(".");
            }
        };

        addr++;
    }
    printf("\n");
}

void memfile_uBenchmark::searchLease4Test() {
    if (!LeaseMgr_) {
        throw "No LeaseMgr instantiated.";
    }

    // This formula should roughly find something a lease in 90% cases
    float hitRatio = 0.5;

    printf("RETRIEVE: ");

    for (uint32_t i = 0; i < Num_; i++) {
        uint32_t x = BASE_ADDR4 + random() % int(Num_ / hitRatio);

        Lease4Ptr lease = LeaseMgr_->getLease(x);
        if (Verbose_) {
            if (lease) {
                printf(".");
            } else {
                printf("X");
            }
        }
    }

    printf("\n");
}

void memfile_uBenchmark::updateLease4Test() {
    if (!LeaseMgr_) {
        throw "No LeaseMgr instantiated.";
    }

    printf("UPDATE:   ");

    time_t cltt = time(NULL);

    for (uint32_t i = 0; i < Num_; i++) {

        uint32_t x = BASE_ADDR4 + random() % Num_;

        Lease4Ptr lease = LeaseMgr_->updateLease(x, cltt);
        if (!lease) {
            stringstream tmp;
            tmp << "UPDATE failed for lease " << hex << x << dec;
            failure(tmp.str().c_str());
        }
        if (Verbose_) {
            printf(".");
        }
    }

    printf("\n");
}

void memfile_uBenchmark::deleteLease4Test() {
    if (!LeaseMgr_) {
        throw "No LeaseMgr instantiated.";
    }

    printf("DELETE:   ");

    for (uint32_t i = 0; i < Num_; i++) {

        uint32_t x = BASE_ADDR4 + i;

        if (!LeaseMgr_->deleteLease(x)) {
            stringstream tmp;
            tmp << "UPDATE failed for lease " << hex << x << dec;
            failure(tmp.str().c_str());
        }
        if (Verbose_) {
            printf(".");
        }
    }

    printf("\n");
}

void memfile_uBenchmark::printInfo() {
    cout << "Memory db (using std::map) + write-only file." << endl;
}


int main(int argc, char * const argv[]) {

    const char * filename = "dhcpd.leases";
    uint32_t num = 100;
    bool sync = true;
    bool verbose = false;

    memfile_uBenchmark bench(filename, num, sync, verbose);

    bench.parseCmdline(argc, argv);

    int result = bench.run();

    return (result);
}