smallObjectAllocator.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_SMALL_OBJECT_ALLOCATOR_H
#define GUM_SMALL_OBJECT_ALLOCATOR_H

// ============================================================================
#include <agrum/agrum.h>
// ============================================================================
#include <agrum/core/hashTable.h>
#include <agrum/core/smallobjectallocator/fixedAllocator.h>
// ============================================================================


namespace gum {
  class SmallObjectAllocator {
    public:
    static const size_t GUM_DEFAULT_CHUNK_SIZE;

    static const size_t GUM_DEFAULT_MAX_OBJECT_SIZE;


    // ############################################################################
    // ############################################################################
    private:
    // ============================================================================
    // ============================================================================
    SmallObjectAllocator();

    // ============================================================================
    // ============================================================================
    SmallObjectAllocator(const SmallObjectAllocator&){};

    // ============================================================================
    // ============================================================================
    SmallObjectAllocator& operator=(const SmallObjectAllocator&) {
      return instance();
    }

    public:
    // ============================================================================
    // ============================================================================
    virtual ~SmallObjectAllocator();


    static SmallObjectAllocator& instance();

    // ############################################################################
    // ############################################################################
    // ============================================================================
    // ============================================================================
    void* allocate(const size_t& objectSize);

    // ============================================================================
    // ============================================================================
    void deallocate(void* pDeallocatedObject, const size_t& objectSize);


    // ============================================================================
    // ============================================================================
    void displayStats() {
      GUM_TRACE("Nb Small Allocation : " << nbAllocation
                                         << " -  Nb Small Deallocation : "
                                         << nbDeallocation);
    }

    Idx nbAlloc() { return nbAllocation; }
    Idx nbDealloc() { return nbDeallocation; }

    private:
    // ============================================================================
    // ============================================================================
    typedef HashTable< Size, FixedAllocator* > __Pool;
    __Pool                                     __pool;

    // ============================================================================
    // ============================================================================
    std::size_t __chunkSize;

    // ============================================================================
    // ============================================================================
    std::size_t __maxObjectSize;

    Idx nbAllocation;
    Idx nbDeallocation;
  };
}   // namespace gum

// Macro used to shorten code in classes using SmallObjectAllocator
#define SOA_ALLOCATE(x) SmallObjectAllocator::instance().allocate(x)
#define SOA_DEALLOCATE(x, y) SmallObjectAllocator::instance().deallocate(x, y)

#ifndef GUM_NO_INLINE
#  include <agrum/core/smallobjectallocator/smallObjectAllocator_inl.h>
#endif

#endif   // GUM_SMALL_OBJECT_ALLOCATOR_H