fixedAllocator.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_FIXED_ALLOCATOR_H
#define GUM_FIXED_ALLOCATOR_H

// ============================================================================
#include <mutex>
#include <thread>
// ============================================================================
#include <agrum/agrum.h>
// ============================================================================

namespace gum {
  class FixedAllocator {
    // clang-format off
    // clang-format on
    struct __Chunk {
      // ============================================================================
      // ============================================================================
      void __init(const std::size_t& blockSize, const unsigned char& numBlocks);

      // ============================================================================
      // ============================================================================
      void* __allocate(const std::size_t& blockSize);

      // ============================================================================
      // ============================================================================
      void __deallocat(void* p, const std::size_t& blockSize);

      // ============================================================================
      // ============================================================================
      void __release();

      // ============================================================================
      // ============================================================================
      unsigned char* __pData;

      // ============================================================================
      // ============================================================================
      unsigned char __firstAvailableBlock;

      // ============================================================================
      // ============================================================================
      unsigned char __blocksAvailable;
    };

    public:
    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    FixedAllocator(const std::size_t&   blockSize,
                   const unsigned char& numBlocks = UCHAR_MAX);

    // ============================================================================
    // ============================================================================
    ~FixedAllocator();


    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    void* allocate();

    // ============================================================================
    // ============================================================================
    void deallocate(void* pDeallocatedBlock);


    // ============================================================================
    // ============================================================================
    const size_t& objectSize() { return __blockSize; }

    private:
    // ============================================================================
    // ============================================================================
    std::size_t __blockSize;

    // ============================================================================
    // ============================================================================
    unsigned char __numBlocks;

    // ============================================================================
    // ============================================================================
    typedef std::vector< __Chunk > __Chunks;
    __Chunks                       __chunks;

    // ============================================================================
    // ============================================================================
    __Chunks::iterator __allocChunk;

    // ============================================================================
    // ============================================================================
    __Chunks::iterator __deallocChunk;
  };

}   // namespace gum

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

#endif   // FIXEDALLOCATOR_H