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 /** \addtogroup rtos */
00032 /** @{*/
00033 
00034 /** Define and manage fixed-size memory pools of objects of a given type.
00035   @tparam  T         data type of a single object (element).
00036   @tparam  queue_sz  maximum number of objects (elements) in the memory pool.
00037 */
00038 template<typename T, uint32_t pool_sz>
00039 class MemoryPool {
00040 public:
00041     /** Create and Initialize a memory pool. */
00042     MemoryPool() {
00043     #ifdef CMSIS_OS_RTX
00044         memset(_pool_m, 0, sizeof(_pool_m));
00045         _pool_def.pool = _pool_m;
00046 
00047         _pool_def.pool_sz = pool_sz;
00048         _pool_def.item_sz =  sizeof(T);
00049     #endif
00050         _pool_id = osPoolCreate(&_pool_def);
00051     }
00052 
00053     /** Allocate a memory block of type T from a memory pool.
00054       @return  address of the allocated memory block or NULL in case of no memory available.
00055     */
00056     T* alloc(void) {
00057         return (T*)osPoolAlloc(_pool_id);
00058     }
00059 
00060     /** Allocate a memory block of type T from a memory pool and set memory block to zero.
00061       @return  address of the allocated memory block or NULL in case of no memory available.
00062     */
00063     T* calloc(void) {
00064         return (T*)osPoolCAlloc(_pool_id);
00065     }
00066 
00067     /** Return an allocated memory block back to a specific memory pool.
00068       @param   address of the allocated memory block that is returned to the memory pool.
00069       @return  status code that indicates the execution status of the function.
00070     */
00071     osStatus free(T *block) {
00072         return osPoolFree(_pool_id, (void*)block);
00073     }
00074 
00075 private:
00076     osPoolId    _pool_id;
00077     osPoolDef_t _pool_def;
00078 #ifdef CMSIS_OS_RTX
00079     uint32_t    _pool_m[3+((sizeof(T)+3)/4)*(pool_sz)];
00080 #endif
00081 };
00082 
00083 }
00084 #endif
00085 
00086 /** @}*/