dali/internal/common/fixed-size-memory-pool.h

   1 #ifndef DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H
   2 #define DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <stdint.h>
  23 #include <cstddef>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 /**
  32  * @brief Calculate the size of a type taking alignment into account
  33  */
  34 template< typename T >
  35 struct TypeSizeWithAlignment
  36 {
  37   ///< The size of the type with alignment taken into account
  38   static const size_t size = ( ( sizeof( T ) + sizeof( void* ) - 1 ) / sizeof( void* ) ) * sizeof( void* );
  39 };
  40
  41 /**
  42  * @brief Memory pool for a given fixed size of memory.
  43  *
  44  * The pool will allocate and reclaim blocks of memory without concern for what is
  45  * stored in them. This means it is up to the client to construct/destruct objects
  46  * and hence determine what data type is stored in the memory block. See FixedSizeObjectAllocator
  47  * below for an example client for creating objects of a given type. It is also up to the client
  48  * to ensure that the size of the block takes memory alignment into account for the
  49  * type of data they wish to store in the block. The TypeSizeWithAlignment<T> template
  50  * can be useful for determining the size of memory aligned blocks for a given type.
  51  */
  52 class FixedSizeMemoryPool
  53 {
  54 public:
  55
  56   typedef uint32_t SizeType;
  57
  58 public:
  59
  60   /**
  61    * @brief Constructor.
  62    *
  63    * @param fixedSize The fixed size of each memory allocation. Use TypeSizeWithAlignment if aligned memory is required.
  64    * @param initialCapacity The initial size of the memory pool. Defaults to a small value (32) after
  65    *                        which the capacity will double as needed.
  66    * @param maximumBlockCapacity The maximum size that a new block of memory can be allocated. Defaults to
  67    *                             a large value (1024 * 1024 = 1048576).
  68    */
  69   explicit FixedSizeMemoryPool( SizeType fixedSize, SizeType initialCapacity = 32, SizeType maximumBlockCapacity = 1048576 );
  70
  71   /**
  72    * @brief Destructor.
  73    */
  74   ~FixedSizeMemoryPool();
  75
  76   /**
  77    * @brief Allocate a new fixed size block of memory
  78    *
  79    * @return Return the newly allocated memory
  80    */
  81   void* Allocate();
  82
  83   /**
  84    * @brief Thread-safe version of Allocate()
  85    *
  86    * @return Return the newly allocated memory
  87    */
  88   void* AllocateThreadSafe();
  89
  90   /**
  91    * @brief Delete a block of memory for the allocation that has been allocated by this memory pool
  92    *
  93    * @param memory The memory to be deleted. Must have been allocated by this memory pool
  94    */
  95   void Free( void* memory );
  96
  97   /**
  98    * @brief Thread-safe version of Free()
  99    *
 100    * @param memory The memory to be deleted. Must have been allocated by this memory pool
 101    */
 102   void FreeThreadSafe( void* memory );
 103
 104 private:
 105
 106   // Undefined
 107   FixedSizeMemoryPool( const FixedSizeMemoryPool& fixedSizeMemoryPool );
 108
 109   // Undefined
 110   FixedSizeMemoryPool& operator=( const FixedSizeMemoryPool& fixedSizeMemoryPool );
 111
 112 private:
 113
 114   struct Impl;
 115   Impl* mImpl;
 116
 117 };
 118
 119 } // namespace Internal
 120
 121 } // namespace Dali
 122
 123 #endif // DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H