1 #ifndef __DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H__
2 #define __DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H__
5 * Copyright (c) 2015 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.
32 * @brief Calculate the size of a type taking alignment into account
34 template< typename T >
35 struct TypeSizeWithAlignment
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* );
42 * @brief Memory pool for a given fixed size of memory.
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.
52 class FixedSizeMemoryPool
56 typedef uint32_t SizeType;
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).
69 explicit FixedSizeMemoryPool( SizeType fixedSize, SizeType initialCapacity = 32, SizeType maximumBlockCapacity = 1048576 );
74 ~FixedSizeMemoryPool();
77 * @brief Allocate a new fixed size block of memory
79 * @return Return the newly allocated memory
84 * @brief Delete a block of memory for the allocation that has been allocated by this memory pool
86 * @param memory The memory to be deleted. Must have been allocated by this memory pool
88 void Free( void* memory );
97 } // namespace Internal
101 #endif /* __DALI_INTERNAL_FIXED_SIZE_MEMORY_POOL_H__ */