Marco Mayer / Mbed OS Queue

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/rtos/MemoryPool.h@2:c7897a3f5f11, 2020-04-22 (annotated)

Committer:
demayer
Date:
Wed Apr 22 11:50:00 2020 +0000
Revision:
2:c7897a3f5f11
Parent:
0:6bf0743ece18 
test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /* mbed Microcontroller Library
demayer 0:6bf0743ece18 2 * Copyright (c) 2006-2012 ARM Limited
demayer 0:6bf0743ece18 3 *
demayer 0:6bf0743ece18 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
demayer 0:6bf0743ece18 5 * of this software and associated documentation files (the "Software"), to deal
demayer 0:6bf0743ece18 6 * in the Software without restriction, including without limitation the rights
demayer 0:6bf0743ece18 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
demayer 0:6bf0743ece18 8 * copies of the Software, and to permit persons to whom the Software is
demayer 0:6bf0743ece18 9 * furnished to do so, subject to the following conditions:
demayer 0:6bf0743ece18 10 *
demayer 0:6bf0743ece18 11 * The above copyright notice and this permission notice shall be included in
demayer 0:6bf0743ece18 12 * all copies or substantial portions of the Software.
demayer 0:6bf0743ece18 13 *
demayer 0:6bf0743ece18 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
demayer 0:6bf0743ece18 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
demayer 0:6bf0743ece18 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
demayer 0:6bf0743ece18 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
demayer 0:6bf0743ece18 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
demayer 0:6bf0743ece18 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
demayer 0:6bf0743ece18 20 * SOFTWARE.
demayer 0:6bf0743ece18 21 */
demayer 0:6bf0743ece18 22 #ifndef MEMORYPOOL_H
demayer 0:6bf0743ece18 23 #define MEMORYPOOL_H
demayer 0:6bf0743ece18 24
demayer 0:6bf0743ece18 25 #include <stdint.h>
demayer 0:6bf0743ece18 26 #include <string.h>
demayer 0:6bf0743ece18 27
demayer 0:6bf0743ece18 28 #include "cmsis_os2.h"
demayer 0:6bf0743ece18 29 #include "mbed_rtos1_types.h"
demayer 0:6bf0743ece18 30 #include "mbed_rtos_storage.h"
demayer 0:6bf0743ece18 31 #include "platform/NonCopyable.h"
demayer 0:6bf0743ece18 32
demayer 0:6bf0743ece18 33 namespace rtos {
demayer 0:6bf0743ece18 34 /** \addtogroup rtos */
demayer 0:6bf0743ece18 35 /** @{*/
demayer 0:6bf0743ece18 36 /**
demayer 0:6bf0743ece18 37 * \defgroup rtos_MemoryPool MemoryPool class
demayer 0:6bf0743ece18 38 * @{
demayer 0:6bf0743ece18 39 */
demayer 0:6bf0743ece18 40
demayer 0:6bf0743ece18 41 /** Define and manage fixed-size memory pools of objects of a given type.
demayer 0:6bf0743ece18 42 @tparam T data type of a single object (element).
demayer 0:6bf0743ece18 43 @tparam queue_sz maximum number of objects (elements) in the memory pool.
demayer 0:6bf0743ece18 44
demayer 0:6bf0743ece18 45 @note
demayer 0:6bf0743ece18 46 Memory considerations: The memory pool data store and control structures will be created on current thread's stack,
demayer 0:6bf0743ece18 47 both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
demayer 0:6bf0743ece18 48 */
demayer 0:6bf0743ece18 49 template<typename T, uint32_t pool_sz>
demayer 0:6bf0743ece18 50 class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
demayer 0:6bf0743ece18 51 MBED_STATIC_ASSERT(pool_sz > 0, "Invalid memory pool size. Must be greater than 0.");
demayer 0:6bf0743ece18 52 public:
demayer 0:6bf0743ece18 53 /** Create and Initialize a memory pool. */
demayer 0:6bf0743ece18 54 MemoryPool() {
demayer 0:6bf0743ece18 55 memset(_pool_mem, 0, sizeof(_pool_mem));
demayer 0:6bf0743ece18 56 memset(&_obj_mem, 0, sizeof(_obj_mem));
demayer 0:6bf0743ece18 57 osMemoryPoolAttr_t attr = { 0 };
demayer 0:6bf0743ece18 58 attr.mp_mem = _pool_mem;
demayer 0:6bf0743ece18 59 attr.mp_size = sizeof(_pool_mem);
demayer 0:6bf0743ece18 60 attr.cb_mem = &_obj_mem;
demayer 0:6bf0743ece18 61 attr.cb_size = sizeof(_obj_mem);
demayer 0:6bf0743ece18 62 _id = osMemoryPoolNew(pool_sz, sizeof(T), &attr);
demayer 0:6bf0743ece18 63 MBED_ASSERT(_id);
demayer 0:6bf0743ece18 64 }
demayer 0:6bf0743ece18 65
demayer 0:6bf0743ece18 66 /** Destroy a memory pool */
demayer 0:6bf0743ece18 67 ~MemoryPool() {
demayer 0:6bf0743ece18 68 osMemoryPoolDelete(_id);
demayer 0:6bf0743ece18 69 }
demayer 0:6bf0743ece18 70
demayer 0:6bf0743ece18 71 /** Allocate a memory block of type T from a memory pool.
demayer 0:6bf0743ece18 72 @return address of the allocated memory block or NULL in case of no memory available.
demayer 0:6bf0743ece18 73 */
demayer 0:6bf0743ece18 74 T* alloc(void) {
demayer 0:6bf0743ece18 75 return (T*)osMemoryPoolAlloc(_id, 0);
demayer 0:6bf0743ece18 76 }
demayer 0:6bf0743ece18 77
demayer 0:6bf0743ece18 78 /** Allocate a memory block of type T from a memory pool and set memory block to zero.
demayer 0:6bf0743ece18 79 @return address of the allocated memory block or NULL in case of no memory available.
demayer 0:6bf0743ece18 80 */
demayer 0:6bf0743ece18 81 T* calloc(void) {
demayer 0:6bf0743ece18 82 T *item = (T*)osMemoryPoolAlloc(_id, 0);
demayer 0:6bf0743ece18 83 if (item != NULL) {
demayer 0:6bf0743ece18 84 memset(item, 0, sizeof(T));
demayer 0:6bf0743ece18 85 }
demayer 0:6bf0743ece18 86 return item;
demayer 0:6bf0743ece18 87 }
demayer 0:6bf0743ece18 88
demayer 0:6bf0743ece18 89 /** Free a memory block.
demayer 0:6bf0743ece18 90 @param block address of the allocated memory block to be freed.
demayer 0:6bf0743ece18 91 @return osOK on successful deallocation, osErrorParameter if given memory block id
demayer 0:6bf0743ece18 92 is NULL or invalid, or osErrorResource if given memory block is in an
demayer 0:6bf0743ece18 93 invalid memory pool state.
demayer 0:6bf0743ece18 94
demayer 0:6bf0743ece18 95 */
demayer 0:6bf0743ece18 96 osStatus free(T *block) {
demayer 0:6bf0743ece18 97 return osMemoryPoolFree(_id, (void*)block);
demayer 0:6bf0743ece18 98 }
demayer 0:6bf0743ece18 99
demayer 0:6bf0743ece18 100 private:
demayer 0:6bf0743ece18 101 osMemoryPoolId_t _id;
demayer 0:6bf0743ece18 102 /* osMemoryPoolNew requires that pool block size is a multiple of 4 bytes. */
demayer 0:6bf0743ece18 103 char _pool_mem[((sizeof(T) + 3) & ~3) * pool_sz];
demayer 0:6bf0743ece18 104 mbed_rtos_storage_mem_pool_t _obj_mem;
demayer 0:6bf0743ece18 105 };
demayer 0:6bf0743ece18 106 /** @}*/
demayer 0:6bf0743ece18 107 /** @}*/
demayer 0:6bf0743ece18 108
demayer 0:6bf0743ece18 109 }
demayer 0:6bf0743ece18 110 #endif
demayer 0:6bf0743ece18 111
demayer 0:6bf0743ece18 112