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   using SizeType = uint32_t;
  56
  57 public:
  58
  59   /**
  60    * @brief Constructor.
  61    *
  62    * @param fixedSize The fixed size of each memory allocation. Use TypeSizeWithAlignment if aligned memory is required.
  63    * @param initialCapacity The initial size of the memory pool. Defaults to a small value (32) after
  64    *                        which the capacity will double as needed.
  65    * @param maximumBlockCapacity The maximum size that a new block of memory can be allocated. Defaults to
  66    *                             a large value (1024 * 1024 = 1048576).
  67    */
  68   explicit FixedSizeMemoryPool( SizeType fixedSize, SizeType initialCapacity = 32, SizeType maximumBlockCapacity = 1048576 );
  69
  70   /**
  71    * @brief Destructor.
  72    */
  73   ~FixedSizeMemoryPool();
  74
  75   /**
  76    * @brief Allocate a new fixed size block of memory
  77    *
  78    * @return Return the newly allocated memory
  79    */
  80   void* Allocate();
  81
  82   /**
  83    * @brief Thread-safe version of Allocate()
  84    *
  85    * @return Return the newly allocated memory
  86    */
  87   void* AllocateThreadSafe();
  88
  89   /**
  90    * @brief Delete a block of memory for the allocation that has been allocated by this memory pool
  91    *
  92    * @param memory The memory to be deleted. Must have been allocated by this memory pool
  93    */
  94   void Free( void* memory );
  95
  96   /**
  97    * @brief Thread-safe version of Free()
  98    *
  99    * @param memory The memory to be deleted. Must have been allocated by this memory pool
 100    */
 101   void FreeThreadSafe( void* memory );
 102
 103 private:
 104
 105   // Undefined
 106   FixedSizeMemoryPool( const FixedSizeMemoryPool& fixedSizeMemoryPool );
 107
 108   // Undefined
 109   FixedSizeMemoryPool& operator=( const FixedSizeMemoryPool& fixedSizeMemoryPool );
 110
 111 private:
 112
 113   struct Impl;
 114   Impl* mImpl;
 115
 116 };
 117
 118 } // namespace Internal
 119
 120 } // namespace Dali
 121
 122 #endif // DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H