fixed_mem_pool.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
// vim:tabstop=4:shiftwidth=4:expandtab:

/*
 * Copyright (C) 2005-2014 Wu Yongwei <adah at users dot sourceforge dot net>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any
 * damages arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute
 * it freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must
 *    not claim that you wrote the original software.  If you use this
 *    software in a product, an acknowledgement in the product
 *    documentation would be appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must
 *    not be misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source
 *    distribution.
 *
 * This file is part of Stones of Nvwa:
 *      http://sourceforge.net/projects/nvwa
 *
 */

#ifndef NVWA_FIXED_MEM_POOL_H
#define NVWA_FIXED_MEM_POOL_H

#include <new>                  // std::bad_alloc
#include <assert.h>             // assert
#include <stddef.h>             // size_t/NULL
#include "_nvwa.h"              // NVWA/NVWA_NAMESPACE_*
#include "c++11.h"              // _NOEXCEPT
#include "class_level_lock.h"   // nvwa::class_level_lock
#include "mem_pool_base.h"      // nvwa::mem_pool_base
#include "static_assert.h"      // STATIC_ASSERT

NVWA_NAMESPACE_BEGIN

#ifndef MEM_POOL_ALIGNMENT
#define MEM_POOL_ALIGNMENT sizeof(void*)
#endif

template <class _Tp>
class fixed_mem_pool
{
public:
    typedef typename class_level_lock<fixed_mem_pool<_Tp> >::lock lock;
    struct alignment
    {
        static const size_t value = MEM_POOL_ALIGNMENT;
    };
    struct block_size
    {
        static const size_t value =
            (sizeof(_Tp) + fixed_mem_pool<_Tp>::alignment::value - 1)
                       & ~(fixed_mem_pool<_Tp>::alignment::value - 1);
    };
    static void*  allocate();
    static void   deallocate(void*);
    static bool   initialize(size_t size);
    static int    deinitialize();
    static int    get_alloc_count();
    static bool   is_initialized();
protected:
    static bool   bad_alloc_handler();
private:
    static void*  _S_mem_pool_ptr;
    static void*  _S_first_avail_ptr;
    static int    _S_alloc_cnt;
};

template <class _Tp>
void* fixed_mem_pool<_Tp>::_S_mem_pool_ptr = _NULLPTR;

template <class _Tp>
void* fixed_mem_pool<_Tp>::_S_first_avail_ptr = _NULLPTR;

template <class _Tp>
int   fixed_mem_pool<_Tp>::_S_alloc_cnt = 0;

template <class _Tp>
inline void* fixed_mem_pool<_Tp>::allocate()
{
    lock guard;
    for (;;)
    {
        if (void* result = _S_first_avail_ptr)
        {
            _S_first_avail_ptr = *(void**)_S_first_avail_ptr;
            ++_S_alloc_cnt;
            return result;
        }
        else
            if (!bad_alloc_handler())
                return _NULLPTR;
    }
}

template <class _Tp>
inline void fixed_mem_pool<_Tp>::deallocate(void* block_ptr)
{
    if (block_ptr == _NULLPTR)
        return;
    lock guard;
    assert(_S_alloc_cnt != 0);
    --_S_alloc_cnt;
    *(void**)block_ptr = _S_first_avail_ptr;
    _S_first_avail_ptr = block_ptr;
}

template <class _Tp>
bool fixed_mem_pool<_Tp>::initialize(size_t size)
{
    STATIC_ASSERT(alignment::value > 0 && alignment::value <= 8192,
                  Bad_alignment);
    STATIC_ASSERT((alignment::value & (alignment::value - 1)) == 0,
                  Alignment_must_be_power_of_two);
    STATIC_ASSERT(block_size::value >= sizeof(void*),
                  Alignment_too_small);
    assert(!is_initialized());
    assert(size > 0);
    _S_mem_pool_ptr = mem_pool_base::alloc_sys(size * block_size::value);
    _S_first_avail_ptr = _S_mem_pool_ptr;
    if (_S_mem_pool_ptr == _NULLPTR)
        return false;
    char* block = (char*)_S_mem_pool_ptr;
    while (--size != 0)
    {
        char* next = block + block_size::value;
        *(void**)block = next;
        block = next;
    }
    *(void**)block = _NULLPTR;
    return true;
}

template <class _Tp>
int fixed_mem_pool<_Tp>::deinitialize()
{
    if (_S_alloc_cnt != 0)
        return _S_alloc_cnt;
    assert(is_initialized());
    mem_pool_base::dealloc_sys(_S_mem_pool_ptr);
    _S_mem_pool_ptr = _NULLPTR;
    _S_first_avail_ptr = _NULLPTR;
    return 0;
}

template <class _Tp>
inline int fixed_mem_pool<_Tp>::get_alloc_count()
{
    return _S_alloc_cnt;
}

template <class _Tp>
inline bool fixed_mem_pool<_Tp>::is_initialized()
{
    return _S_mem_pool_ptr != _NULLPTR;
}

template <class _Tp>
bool fixed_mem_pool<_Tp>::bad_alloc_handler()
{
    return false;
}

NVWA_NAMESPACE_END

#define DECLARE_FIXED_MEM_POOL(_Cls) \
public: \
    static void* operator new(size_t size) \
    { \
        assert(size == sizeof(_Cls)); \
        if (void* ptr = NVWA::fixed_mem_pool<_Cls>::allocate()) \
            return ptr; \
        else \
            throw std::bad_alloc(); \
    } \
    static void  operator delete(void* ptr) \
    { \
        if (ptr != _NULLPTR) \
            NVWA::fixed_mem_pool<_Cls>::deallocate(ptr); \
    }

#define DECLARE_FIXED_MEM_POOL__NOTHROW(_Cls) \
public: \
    static void* operator new(size_t size) _NOEXCEPT \
    { \
        assert(size == sizeof(_Cls)); \
        return NVWA::fixed_mem_pool<_Cls>::allocate(); \
    } \
    static void  operator delete(void* ptr) \
    { \
        if (ptr != _NULLPTR) \
            NVWA::fixed_mem_pool<_Cls>::deallocate(ptr); \
    }

#define DECLARE_FIXED_MEM_POOL__THROW_NOCHECK(_Cls) \
public: \
    static void* operator new(size_t size) \
    { \
        assert(size == sizeof(_Cls)); \
        return NVWA::fixed_mem_pool<_Cls>::allocate(); \
    } \
    static void  operator delete(void* ptr) \
    { \
        if (ptr != _NULLPTR) \
            NVWA::fixed_mem_pool<_Cls>::deallocate(ptr); \
    }

#endif // NVWA_FIXED_MEM_POOL_H