MemoryPool.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2012 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MEMORYPOOL_H
00023 #define MEMORYPOOL_H
00024 
00025 #include <stdint.h>
00026 #include <string.h>
00027 
00028 #include "cmsis_os.h"
00029 
00030 namespace rtos {
00031 
00032 /** Define and manage fixed-size memory pools of objects of a given type.
00033   @tparam  T         data type of a single object (element).
00034   @tparam  queue_sz  maximum number of objects (elements) in the memory pool.
00035 */
00036 template<typename T, uint32_t pool_sz>
00037 class MemoryPool {
00038 public:
00039     /** Create and Initialize a memory pool. */
00040     MemoryPool() {
00041     #ifdef CMSIS_OS_RTX
00042         memset(_pool_m, 0, sizeof(_pool_m));
00043         _pool_def.pool = _pool_m;
00044 
00045         _pool_def.pool_sz = pool_sz;
00046         _pool_def.item_sz =  sizeof(T);
00047     #endif
00048         _pool_id = osPoolCreate(&_pool_def);
00049     }
00050 
00051     /** Allocate a memory block of type T from a memory pool.
00052       @return  address of the allocated memory block or NULL in case of no memory available.
00053     */
00054     T* alloc(void) {
00055         return (T*)osPoolAlloc(_pool_id);
00056     }
00057 
00058     /** Allocate a memory block of type T from a memory pool and set memory block to zero.
00059       @return  address of the allocated memory block or NULL in case of no memory available.
00060     */
00061     T* calloc(void) {
00062         return (T*)osPoolCAlloc(_pool_id);
00063     }
00064 
00065     /** Return an allocated memory block back to a specific memory pool.
00066       @param   address of the allocated memory block that is returned to the memory pool.
00067       @return  status code that indicates the execution status of the function.
00068     */
00069     osStatus free(T *block) {
00070         return osPoolFree(_pool_id, (void*)block);
00071     }
00072 
00073 private:
00074     osPoolId    _pool_id;
00075     osPoolDef_t _pool_def;
00076 #ifdef CMSIS_OS_RTX
00077     uint32_t    _pool_m[3+((sizeof(T)+3)/4)*(pool_sz)];
00078 #endif
00079 };
00080 
00081 }
00082 #endif