pool/test/test_pool_alloc.cpp

/* Copyright (C) 2000, 2001 Stephen Cleary
 * Copyright (C) 2011 Kwan Ting Chan
 * 
 * Use, modification and distribution is subject to the 
 * Boost Software License, Version 1.0. (See accompanying
 * file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
 */

#include "random_shuffle.hpp"
#include <boost/pool/pool_alloc.hpp>
#include <boost/pool/object_pool.hpp>

#include <boost/detail/lightweight_test.hpp>

#include <algorithm>
#include <deque>
#include <list>
#include <set>
#include <stdexcept>
#include <vector>

#include <cstdlib>
#include <ctime>

// Each "tester" object below checks into and out of the "cdtor_checker",
//  which will check for any problems related to the construction/destruction of
//  "tester" objects.
class cdtor_checker
{
private:
    // Each constructed object registers its "this" pointer into "objs"
    std::set<void*> objs;

public:
    // True iff all objects that have checked in have checked out
    bool ok() const { return objs.empty(); }

    ~cdtor_checker()
    {
        BOOST_TEST(ok());
    }

    void check_in(void * const This)
    {
        BOOST_TEST(objs.find(This) == objs.end());
        objs.insert(This);
    }

    void check_out(void * const This)
    {
        // Under current usage, 'This' is the 'this'-pointer of a 'tester' object.
        //   If it is NULL here, then something has already gone terribly wrong
        BOOST_TEST(This != NULL);

        BOOST_TEST(objs.find(This) != objs.end());
        objs.erase(This);
    }
};
static cdtor_checker mem;

struct tester
{
    tester(bool throw_except = false)
    {
        if(throw_except)
        {
            throw std::logic_error("Deliberate constructor exception");
        }

        mem.check_in(this);
    }

    tester(int a0, int a1)
    {
        set_values(a0, a1, -1, -1);

        mem.check_in(this);
    }

    tester(int a0, const int& a1, int a2, const int a3, bool throw_except = false)
    {
        if(throw_except)
        {
            throw std::logic_error("Deliberate constructor exception");
        }

        set_values(a0, a1, a2, a3);

        mem.check_in(this);
    }

    tester(const tester &)
    {
        mem.check_in(this);
    }

    ~tester()
    {
        mem.check_out(this);
    }

    int stored_a0;
    int stored_a1;
    int stored_a2;
    int stored_a3;

    void set_values(int a0, int a1, int a2, int a3)
    {
        stored_a0 = a0;
        stored_a1 = a1;
        stored_a2 = a2;
        stored_a3 = a3;
    }

    void check_values(int a0, int a1)
    {
        check_values(a0, a1, -1, -1);
    }

    void check_values(int a0, int a1, int a2, int a3)
    {
        BOOST_TEST( a0 == stored_a0 );
        BOOST_TEST( a1 == stored_a1 );
        BOOST_TEST( a2 == stored_a2 );
        BOOST_TEST( a3 == stored_a3 );
    }
};

// This is a wrapper around a UserAllocator. It just registers alloc/dealloc
//  to/from the system memory. It's used to make sure pool's are allocating
//  and deallocating system memory properly.
// Do NOT use this class with static or singleton pools.
template <typename UserAllocator>
struct TrackAlloc
{
    typedef typename UserAllocator::size_type size_type;
    typedef typename UserAllocator::difference_type difference_type;

    static std::set<char *> allocated_blocks;

    static char * malloc(const size_type bytes)
    {
        char * const ret = UserAllocator::malloc(bytes);
        allocated_blocks.insert(ret);
        return ret;
    }

    static void free(char * const block)
    {
        BOOST_TEST(allocated_blocks.find(block) != allocated_blocks.end());
        allocated_blocks.erase(block);
        UserAllocator::free(block);
    }

    static bool ok()
    {
        return allocated_blocks.empty();
    }
};
template <typename UserAllocator>
std::set<char *> TrackAlloc<UserAllocator>::allocated_blocks;

typedef TrackAlloc<boost::default_user_allocator_new_delete> track_alloc;

// This is a simple UserAllocator to allow coverage-testing of the codepath
//   where memory allocation fails.
struct always_fails_allocation_alloc
{
    typedef std::size_t size_type;
    typedef std::ptrdiff_t difference_type;

    static char * malloc(const size_type /*bytes*/)
    {
        return 0;
    }

    static void free(char * const /*block*/)
    {
    }
};

void test()
{
    {
        // Do nothing pool
        boost::object_pool<tester> pool;
    }

    {
        // Construct several tester objects. Don't delete them (i.e.,
        //  test pool's garbage collection).
        boost::object_pool<tester> pool;
        for(int i=0; i < 10; ++i)
        {
            pool.construct();
        }
    }

    {
        // Construct several tester objects. Delete some of them.
        boost::object_pool<tester> pool;
        std::vector<tester *> v;
        for(int i=0; i < 10; ++i)
        {
            v.push_back(pool.construct());
        }
        pool_test_random_shuffle(v.begin(), v.end());
        for(int j=0; j < 5; ++j)
        {
            pool.destroy(v[j]);
        }
    }

    {
        // Test how pool reacts with constructors that throw exceptions.
        //  Shouldn't have any memory leaks.
        boost::object_pool<tester> pool;
        for(int i=0; i < 5; ++i)
        {
            pool.construct();
        }
        for(int j=0; j < 5; ++j)
        {
            try
            {
                // The following constructions will raise an exception.
                pool.construct(true);
            }
            catch(const std::logic_error &) {}
        }
#if defined(BOOST_HAS_VARIADIC_TMPL) && defined(BOOST_HAS_RVALUE_REFS)
        for(int k=0; k < 5; ++k)
        {
            try
            {
                // The following constructions will raise an exception.
                pool.construct(k,2*k,3*k,4*k,true);
            }
            catch(const std::logic_error &) {}
        }
#endif
    }

    {
        // Test the 'pool.construct' with 2 ctor parameters
        boost::object_pool<tester> pool;
        for(int i=0; i < 5; ++i)
        {
            tester * newItem = pool.construct(i, 2*i);
            newItem->check_values(i, 2*i);
        }
    }

#if defined(BOOST_HAS_VARIADIC_TMPL) && defined(BOOST_HAS_RVALUE_REFS)
    {
        // Test the 'pool.construct' with 4 ctor parameters
        //   Without variadic-templates, this functionality requires
        //   that the end-user has run the 'detail/pool_construct.m4'
        //   functionality to generate a larger set of 'construct()'
        //   overloads. [see docs for object_pool::construct()]
        boost::object_pool<tester> pool;
        for(int i=0; i < 5; ++i)
        {
            tester * newItem = pool.construct(i, 2*i, 3*i, 5*i);
            newItem->check_values(i, 2*i, 3*i, 5*i);
        }
    }
#endif

    {
        // Test the case where memory allocation intentionally fails
        boost::object_pool<tester, always_fails_allocation_alloc> pool;
        BOOST_TEST( pool.construct() == 0 );
        BOOST_TEST( pool.construct(1,2) == 0 );
#if defined(BOOST_HAS_VARIADIC_TMPL) && defined(BOOST_HAS_RVALUE_REFS)
        BOOST_TEST( pool.construct(1,2,3,4) == 0 );
#endif
    }
}

void test_alloc()
{
    {
        // Allocate several tester objects. Delete one.
        std::vector<tester, boost::pool_allocator<tester> > l;
        for(int i=0; i < 10; ++i)
        {
            l.push_back(tester());
        }
        l.pop_back();
    }

    {
        // Allocate several tester objects. Delete two.
        std::deque<tester, boost::pool_allocator<tester> > l;
        for(int i=0; i < 10; ++i)
        {
            l.push_back(tester());
        }
        l.pop_back();
        l.pop_front();
    }

    {
        // Allocate several tester objects. Delete two.
        std::list<tester, boost::fast_pool_allocator<tester> > l;
        // lists rebind their allocators, so dumping is useless
        for(int i=0; i < 10; ++i)
        {
            l.push_back(tester());
        }
        l.pop_back();
        l.pop_front();
    }

    tester * tmp;
    {
        // Create a memory leak on purpose. (Allocator doesn't have
        //  garbage collection)
        // (Note: memory leak)
        boost::pool_allocator<tester> a;
        tmp = a.allocate(1, 0);
        new (tmp) tester();
    }
    if(mem.ok())
    {
        BOOST_ERROR("Pool allocator cleaned up itself");
    }
    // Remove memory checker entry (to avoid error later) and
    //  clean up memory leak
    tmp->~tester();
    boost::pool_allocator<tester>::deallocate(tmp, 1);

    // test allocating zero elements
    {
        boost::pool_allocator<tester> alloc;
        tester* ip = alloc.allocate(0);
        alloc.deallocate(ip, 0);
    }
}

void test_mem_usage()
{
    typedef boost::pool<track_alloc> pool_type;

    {
        // Constructor should do nothing; no memory allocation
        pool_type pool(sizeof(int));
        BOOST_TEST(track_alloc::ok());
        BOOST_TEST(!pool.release_memory());
        BOOST_TEST(!pool.purge_memory());

        // Should allocate from system
        pool.free(pool.malloc());
        BOOST_TEST(!track_alloc::ok());

        // Ask pool to give up memory it's not using; this should succeed
        BOOST_TEST(pool.release_memory());
        BOOST_TEST(track_alloc::ok());

        // Should allocate from system again
        pool.malloc(); // loses the pointer to the returned chunk (*A*)

        // Ask pool to give up memory it's not using; this should fail
        BOOST_TEST(!pool.release_memory());

        // Force pool to give up memory it's not using; this should succeed
        // This will clean up the memory leak from (*A*)
        BOOST_TEST(pool.purge_memory());
        BOOST_TEST(track_alloc::ok());

        // Should allocate from system again
        pool.malloc(); // loses the pointer to the returned chunk (*B*)

        // pool's destructor should purge the memory
        //  This will clean up the memory leak from (*B*)
    }

    {
        pool_type pool(sizeof(int), 2);
        void * ptr_0 = pool.malloc();
        void * ptr_1 = pool.malloc();
        void * ptr_2 = pool.malloc();
        void * ptr_3 = pool.malloc();
        pool.ordered_free(ptr_2);
        pool.ordered_free(ptr_3);
        BOOST_TEST(pool.release_memory());
        pool.ordered_free(ptr_0);
        pool.ordered_free(ptr_1);
        BOOST_TEST(pool.release_memory());
    }

    {
        pool_type pool(sizeof(int), 2);
        void * ptr_0 = pool.malloc();
        void * ptr_1 = pool.malloc();
        void * ptr_2 = pool.malloc();
        void * ptr_3 = pool.malloc();
        pool.ordered_free(ptr_0);
        pool.ordered_free(ptr_1);
        BOOST_TEST(pool.release_memory());
        pool.ordered_free(ptr_2);
        pool.ordered_free(ptr_3);
        BOOST_TEST(pool.release_memory());
    }

    BOOST_TEST(track_alloc::ok());
}

void test_free_chunk_selection()
{
    typedef boost::pool<track_alloc> pool_type;

    {
        // Expose a regression from the commit 8ec1be1e82ba559744ecfa3c6ec13f71f9c175cc.
        // Two checks will fail here.
        pool_type pool(sizeof(void *), 3);
        void * ptr_0 = pool.ordered_malloc(1);
        void * ptr_1 = pool.ordered_malloc(1);
        void * ptr_2 = pool.ordered_malloc(1);
        // The blocks are expected to be allocated at subsequent locations
        BOOST_TEST((char *)ptr_1 - (char *)ptr_0 == sizeof(void *));
        BOOST_TEST((char *)ptr_2 - (char *)ptr_1 == sizeof(void *));

        pool.ordered_free(ptr_1, 1);

        void * ptr_1a = pool.ordered_malloc(1);
        // Expected to reallocate the former ptr1 block
        // which should be the first and only available block
        BOOST_TEST(ptr_1a == ptr_1);

        pool.ordered_free(ptr_0, 1);
        pool.ordered_free(ptr_1a, 1);
        pool.ordered_free(ptr_2, 1);
    }

    {
        // Another way to expose a regression from the commit 8ec1be1e82ba559744ecfa3c6ec13f71f9c175cc.
        // This time we preallocate 4 rather than 3 blocks in the pool. In this case
        // the location of the ptr_2 block is as expected. The reallocation of ptr_1
        // block however still fails the location expectation.
        pool_type pool(sizeof(void *), 4);
        void * ptr_0 = pool.ordered_malloc(1);
        void * ptr_1 = pool.ordered_malloc(1);
        void * ptr_2 = pool.ordered_malloc(1);
        // The blocks are expected to be allocated at subsequent locations
        BOOST_TEST((char *)ptr_1 - (char *)ptr_0 == sizeof(void *));
        BOOST_TEST((char *)ptr_2 - (char *)ptr_1 == sizeof(void *));

        pool.ordered_free(ptr_1, 1);

        void * ptr_1a = pool.ordered_malloc(1);
        // Expected to reallocate the former ptr1 block
        // which should be the first available block
        BOOST_TEST(ptr_1a == ptr_1);

        pool.ordered_free(ptr_0, 1);
        pool.ordered_free(ptr_1a, 1);
        pool.ordered_free(ptr_2, 1);
    }

    BOOST_TEST(track_alloc::ok());
}

void test_void()
{
    typedef boost::pool_allocator<void> void_allocator;
    typedef boost::fast_pool_allocator<void> fast_void_allocator;

    typedef void_allocator::rebind<int>::other int_allocator;
    typedef fast_void_allocator::rebind<int>::other fast_int_allocator;

    std::vector<int, int_allocator> v1;
    std::vector<int, fast_int_allocator> v2;
}

int main()
{
    std::srand(static_cast<unsigned>(std::time(0)));

    test();
    test_alloc();
    test_mem_usage();
    test_free_chunk_selection();
    test_void();

    return boost::report_errors();
}