1 #ifndef DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H
2 #define DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
30 * @brief Calculate the size of a type taking alignment into account
33 struct TypeSizeWithAlignment
35 ///< The size of the type with alignment taken into account
36 static const size_t size = ((sizeof(T) + sizeof(void*) - 1) / sizeof(void*)) * sizeof(void*);
40 * @brief Memory pool for a given fixed size of memory.
42 * The pool will allocate and reclaim blocks of memory without concern for what is
43 * stored in them. This means it is up to the client to construct/destruct objects
44 * and hence determine what data type is stored in the memory block. See FixedSizeObjectAllocator
45 * below for an example client for creating objects of a given type. It is also up to the client
46 * to ensure that the size of the block takes memory alignment into account for the
47 * type of data they wish to store in the block. The TypeSizeWithAlignment<T> template
48 * can be useful for determining the size of memory aligned blocks for a given type.
50 class FixedSizeMemoryPool
53 using SizeType = uint32_t;
59 * @param fixedSize The fixed size of each memory allocation. Use TypeSizeWithAlignment if aligned memory is required.
60 * @param initialCapacity The initial size of the memory pool. Defaults to a small value (32) after
61 * which the capacity will double as needed.
62 * @param maximumBlockCapacity The maximum size that a new block of memory can be allocated. Defaults to
63 * a large value (1024 * 1024 = 1048576).
65 explicit FixedSizeMemoryPool(SizeType fixedSize, SizeType initialCapacity = 32, SizeType maximumBlockCapacity = 1048576);
70 ~FixedSizeMemoryPool();
73 * @brief Allocate a new fixed size block of memory
75 * @return Return the newly allocated memory
80 * @brief Thread-safe version of Allocate()
82 * @return Return the newly allocated memory
84 void* AllocateThreadSafe();
87 * @brief Delete a block of memory for the allocation that has been allocated by this memory pool
89 * @param memory The memory to be deleted. Must have been allocated by this memory pool
91 void Free(void* memory);
94 * @brief Thread-safe version of Free()
96 * @param memory The memory to be deleted. Must have been allocated by this memory pool
98 void FreeThreadSafe(void* memory);
102 FixedSizeMemoryPool(const FixedSizeMemoryPool& fixedSizeMemoryPool);
105 FixedSizeMemoryPool& operator=(const FixedSizeMemoryPool& fixedSizeMemoryPool);
112 } // namespace Internal
116 #endif // DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H