first commit
This commit is contained in:
bing
330
include/QxMemLeak/fixed_mem_pool.h
Normal file
330
include/QxMemLeak/fixed_mem_pool.h
Normal file
@@ -0,0 +1,330 @@
|
||||
// -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
|
||||
// vim:tabstop=4:shiftwidth=4:expandtab:
|
||||
|
||||
/*
|
||||
* Copyright (C) 2004-2008 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
|
||||
*
|
||||
*/
|
||||
|
||||
/*!
|
||||
* \file fixed_mem_pool.h
|
||||
* \ingroup QxMemLeak
|
||||
*
|
||||
* Definition of a fixed-size memory pool template for structs/classes.
|
||||
* This is a easy-to-use class template for pre-allocated memory pools.
|
||||
* The client side needs to do the following things:
|
||||
* - Use one of the macros #DECLARE_FIXED_MEM_POOL,
|
||||
* #DECLARE_FIXED_MEM_POOL__NOTHROW, and
|
||||
* #DECLARE_FIXED_MEM_POOL__THROW_NOCHECK at the end of the class
|
||||
* (say, \c class \e _Cls) definitions
|
||||
* - Call fixed_mem_pool<_Cls>::initialize at the beginning of the
|
||||
* program
|
||||
* - Optionally, specialize fixed_mem_pool<_Cls>::bad_alloc_handler to
|
||||
* change the behaviour when all memory blocks are allocated
|
||||
* - Optionally, call fixed_mem_pool<_Cls>::deinitialize at exit of the
|
||||
* program to check for memory leaks
|
||||
* - Optionally, call fixed_mem_pool<_Cls>::get_alloc_count to check
|
||||
* memory usage when the program is running
|
||||
*
|
||||
* \version 1.14, 2005/09/19
|
||||
* \author Wu Yongwei
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef QT_NO_DEBUG
|
||||
#ifndef _QX_MODE_RELEASE
|
||||
#if _QX_USE_MEM_LEAK_DETECTION
|
||||
|
||||
#ifndef _FIXED_MEM_POOL_H
|
||||
#define _FIXED_MEM_POOL_H
|
||||
|
||||
#ifdef _MSC_VER
|
||||
#pragma once
|
||||
#endif
|
||||
|
||||
#include <new>
|
||||
#include <assert.h>
|
||||
#include <stdlib.h>
|
||||
#include "class_level_lock.h"
|
||||
#include "mem_pool_base.h"
|
||||
|
||||
/**
|
||||
* Defines the alignment of memory blocks.
|
||||
*/
|
||||
#ifndef MEM_POOL_ALIGNMENT
|
||||
#define MEM_POOL_ALIGNMENT 4
|
||||
#endif
|
||||
|
||||
namespace qx {
|
||||
namespace memory {
|
||||
|
||||
/**
|
||||
* Class template to manipulate a fixed-size memory pool. Please notice
|
||||
* that only allocate and deallocate are protected by a lock.
|
||||
*
|
||||
* @param _Tp class to use the fixed_mem_pool
|
||||
*/
|
||||
template <class _Tp>
|
||||
class fixed_mem_pool
|
||||
{
|
||||
public:
|
||||
typedef typename class_level_lock<fixed_mem_pool<_Tp> >::lock lock;
|
||||
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 size_t _S_align(size_t __size);
|
||||
static void* _S_mem_pool_ptr;
|
||||
static void* _S_first_avail_ptr;
|
||||
static int _S_alloc_cnt;
|
||||
};
|
||||
|
||||
/** Pointer to the allocated chunk of memory. */
|
||||
template <class _Tp>
|
||||
void* fixed_mem_pool<_Tp>::_S_mem_pool_ptr = NULL;
|
||||
|
||||
/** Pointer to the first available memory block. */
|
||||
template <class _Tp>
|
||||
void* fixed_mem_pool<_Tp>::_S_first_avail_ptr = NULL;
|
||||
|
||||
/** Count of allocations. */
|
||||
template <class _Tp>
|
||||
int fixed_mem_pool<_Tp>::_S_alloc_cnt = 0;
|
||||
|
||||
/**
|
||||
* Allocates a memory block from the memory pool.
|
||||
*
|
||||
* @return pointer to the allocated memory block
|
||||
*/
|
||||
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 NULL;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Deallocates a memory block and returns it to the memory pool.
|
||||
*
|
||||
* @param __block_ptr pointer to the memory block to return
|
||||
*/
|
||||
template <class _Tp>
|
||||
inline void fixed_mem_pool<_Tp>::deallocate(void* __block_ptr)
|
||||
{
|
||||
if (__block_ptr == NULL)
|
||||
return;
|
||||
lock __guard;
|
||||
assert(_S_alloc_cnt != 0);
|
||||
--_S_alloc_cnt;
|
||||
*(void**)__block_ptr = _S_first_avail_ptr;
|
||||
_S_first_avail_ptr = __block_ptr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the memory pool.
|
||||
*
|
||||
* @param __size number of memory blocks to put in the memory pool
|
||||
* @return \c true if successful; \c false if memory insufficient
|
||||
*/
|
||||
template <class _Tp>
|
||||
bool fixed_mem_pool<_Tp>::initialize(size_t __size)
|
||||
{
|
||||
size_t __block_size = _S_align(sizeof(_Tp));
|
||||
assert(!is_initialized());
|
||||
assert(__size > 0 && __block_size >= sizeof(void*));
|
||||
_S_mem_pool_ptr = mem_pool_base::alloc_sys(__size * __block_size);
|
||||
_S_first_avail_ptr = _S_mem_pool_ptr;
|
||||
if (_S_mem_pool_ptr == NULL)
|
||||
return false;
|
||||
char* __block_ = (char*)_S_mem_pool_ptr;
|
||||
while (--__size != 0)
|
||||
{
|
||||
char* __next_ = __block_ + __block_size;
|
||||
*(void**)__block_ = __next_;
|
||||
__block_ = __next_;
|
||||
}
|
||||
*(void**)__block_ = NULL;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deinitializes the memory pool.
|
||||
*
|
||||
* @return \c 0 if all memory blocks are returned and the memory pool
|
||||
* successfully freed; or a non-zero value indicating number of
|
||||
* memory blocks still in allocation
|
||||
*/
|
||||
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 = NULL;
|
||||
_S_first_avail_ptr = NULL;
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the allocation count.
|
||||
*
|
||||
* @return the number of memory blocks still in allocation
|
||||
*/
|
||||
template <class _Tp>
|
||||
inline int fixed_mem_pool<_Tp>::get_alloc_count()
|
||||
{
|
||||
return _S_alloc_cnt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Is the memory pool initialized?
|
||||
*
|
||||
* @return \c true if it is successfully initialized; \c false otherwise
|
||||
*/
|
||||
template <class _Tp>
|
||||
inline bool fixed_mem_pool<_Tp>::is_initialized()
|
||||
{
|
||||
return _S_mem_pool_ptr != NULL;;
|
||||
}
|
||||
|
||||
/**
|
||||
* Bad allocation handler. Called when there are no memory blocks
|
||||
* available in the memory pool. If this function returns \c false
|
||||
* (default behaviour if not explicitly specialized), it indicates that
|
||||
* it can do nothing and allocate() should return \c NULL; if this
|
||||
* function returns \c true, it indicates that it has freed some memory
|
||||
* blocks and allocate() should try allocating again.
|
||||
*/
|
||||
template <class _Tp>
|
||||
bool fixed_mem_pool<_Tp>::bad_alloc_handler()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Aligns the memory block size.
|
||||
*
|
||||
* @param __size size to be aligned
|
||||
* @return aligned value of \a __size
|
||||
*/
|
||||
template <class _Tp>
|
||||
inline size_t fixed_mem_pool<_Tp>::_S_align(size_t __size)
|
||||
{
|
||||
return (__size + MEM_POOL_ALIGNMENT - 1)
|
||||
/ MEM_POOL_ALIGNMENT * MEM_POOL_ALIGNMENT;
|
||||
}
|
||||
|
||||
} // namespace memory
|
||||
} // namespace qx
|
||||
|
||||
/**
|
||||
* Declares the normal (exceptionable) overload of <b>operator new</b>
|
||||
* and <b>operator delete</b>.
|
||||
*
|
||||
* @param _Cls class to use the fixed_mem_pool
|
||||
* @see DECLARE_FIXED_MEM_POOL__THROW_NOCHECK, which, too,
|
||||
* defines an <b>operator new</b> that will never return
|
||||
* \c NULL, but requires more discipline on the
|
||||
* programmer's side.
|
||||
*/
|
||||
#define DECLARE_FIXED_MEM_POOL(_Cls) \
|
||||
public: \
|
||||
static void* operator new(size_t __size) \
|
||||
{ \
|
||||
assert(__size == sizeof(_Cls)); \
|
||||
if (void* __ptr = fixed_mem_pool<_Cls>::allocate()) \
|
||||
return __ptr; \
|
||||
else \
|
||||
throw std::bad_alloc(); \
|
||||
} \
|
||||
static void operator delete(void* __ptr) \
|
||||
{ \
|
||||
if (__ptr != NULL) \
|
||||
fixed_mem_pool<_Cls>::deallocate(__ptr); \
|
||||
}
|
||||
|
||||
/**
|
||||
* Declares the non-exceptionable overload of <b>operator new</b> and
|
||||
* <b>operator delete</b>.
|
||||
*
|
||||
* @param _Cls class to use the fixed_mem_pool
|
||||
*/
|
||||
#define DECLARE_FIXED_MEM_POOL__NOTHROW(_Cls) \
|
||||
public: \
|
||||
static void* operator new(size_t __size) throw() \
|
||||
{ \
|
||||
assert(__size == sizeof(_Cls)); \
|
||||
return fixed_mem_pool<_Cls>::allocate(); \
|
||||
} \
|
||||
static void operator delete(void* __ptr) \
|
||||
{ \
|
||||
if (__ptr != NULL) \
|
||||
fixed_mem_pool<_Cls>::deallocate(__ptr); \
|
||||
}
|
||||
|
||||
/**
|
||||
* Declares the exceptionable, non-checking overload of <b>operator
|
||||
* new</b> and <b>operator delete</b>.
|
||||
*
|
||||
* N.B. Using this macro \e requires users to explicitly specialize
|
||||
* fixed_mem_pool::bad_alloc_handler so that it shall never return
|
||||
* \c false (it may throw exceptions, say, \c std::bad_alloc, or simply
|
||||
* abort). Otherwise a segmentation fault might occur (instead of
|
||||
* returning a \c NULL pointer).
|
||||
*
|
||||
* @param _Cls class to use the fixed_mem_pool
|
||||
*/
|
||||
#define DECLARE_FIXED_MEM_POOL__THROW_NOCHECK(_Cls) \
|
||||
public: \
|
||||
static void* operator new(size_t __size) \
|
||||
{ \
|
||||
assert(__size == sizeof(_Cls)); \
|
||||
return fixed_mem_pool<_Cls>::allocate(); \
|
||||
} \
|
||||
static void operator delete(void* __ptr) \
|
||||
{ \
|
||||
if (__ptr != NULL) \
|
||||
fixed_mem_pool<_Cls>::deallocate(__ptr); \
|
||||
}
|
||||
|
||||
#endif // _FIXED_MEM_POOL_H
|
||||
#endif // _QX_USE_MEM_LEAK_DETECTION
|
||||
#endif // _QX_MODE_RELEASE
|
||||
#endif // QT_NO_DEBUG
|
||||
Reference in New Issue
Block a user