diff options
Diffstat (limited to 'os/common/oslib/include/chmempools.h')
| -rw-r--r-- | os/common/oslib/include/chmempools.h | 103 |
1 files changed, 97 insertions, 6 deletions
diff --git a/os/common/oslib/include/chmempools.h b/os/common/oslib/include/chmempools.h index 2d582f48a..2dfe40e20 100644 --- a/os/common/oslib/include/chmempools.h +++ b/os/common/oslib/include/chmempools.h @@ -69,6 +69,17 @@ typedef struct { for this pool. */
} memory_pool_t;
+#if (CH_CFG_USE_SEMAPHORES == TRUE) || defined(__DOXYGEN__)
+/**
+ * @brief Guarded memory pool descriptor.
+ */
+typedef struct {
+ semaphore_t sem; /**< @brief Counter semaphore quarding
+ the memory pool. */
+ memory_pool_t pool; /**< @brief The memory pool itself. */
+} guarded_memory_pool_t;
+#endif /* CH_CFG_USE_SEMAPHORES == TRUE */
+
/*===========================================================================*/
/* Module macros. */
/*===========================================================================*/
@@ -86,18 +97,46 @@ typedef struct { {NULL, size, provider}
/**
- * @brief Static memory pool initializer in hungry mode.
+ * @brief Static memory pool initializer.
* @details Statically initialized memory pools require no explicit
* initialization using @p chPoolInit().
*
- * @param[in] name the name of the memory pool variable
- * @param[in] size size of the memory pool contained objects
- * @param[in] provider memory provider function for the memory pool or @p NULL
- * if the pool is not allowed to grow automatically
+ * @param[in] name the name of the memory pool variable
+ * @param[in] size size of the memory pool contained objects
+ * @param[in] provider memory provider function for the memory pool or @p NULL
+ * if the pool is not allowed to grow automatically
*/
#define MEMORYPOOL_DECL(name, size, provider) \
memory_pool_t name = _MEMORYPOOL_DATA(name, size, provider)
+#if (CH_CFG_USE_SEMAPHORES == TRUE) || defined(__DOXYGEN__)
+/**
+ * @brief Data part of a static guarded memory pool initializer.
+ * @details This macro should be used when statically initializing a
+ * memory pool that is part of a bigger structure.
+ *
+ * @param[in] name the name of the memory pool variable
+ * @param[in] size size of the memory pool contained objects
+ */
+#define _GUARDEDMEMORYPOOL_DATA(name, size) { \
+ _SEMAPHORE_DATA(name.sem, (cnt_t)0), \
+ NULL, \
+ size, \
+ NULL \
+}
+
+/**
+ * @brief Static guarded memory pool initializer.
+ * @details Statically initialized guardedmemory pools require no explicit
+ * initialization using @p chGuardedPoolInit().
+ *
+ * @param[in] name the name of the guarded memory pool variable
+ * @param[in] size size of the memory pool contained objects
+ */
+#define GUARDEDMEMORYPOOL_DECL(name, size) \
+ memory_pool_t name = _MEMORYPOOL_DATA(name, size)
+#endif /* CH_CFG_USE_SEMAPHORES == TRUE */
+
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
@@ -111,6 +150,16 @@ extern "C" { void *chPoolAlloc(memory_pool_t *mp);
void chPoolFreeI(memory_pool_t *mp, void *objp);
void chPoolFree(memory_pool_t *mp, void *objp);
+#if CH_CFG_USE_SEMAPHORES == TRUE
+ void chGuardedPoolObjectInit(guarded_memory_pool_t *gmp, size_t size);
+ void chGuardedPoolLoadArray(guarded_memory_pool_t *gmp, void *p, size_t n);
+ void *chGuardedPoolAllocTimeoutS(guarded_memory_pool_t *gmp,
+ systime_t timeout);
+ void *chGuardedPoolAllocTimeout(guarded_memory_pool_t *gmp,
+ systime_t timeout);
+ void chGuardedPoolFreeI(guarded_memory_pool_t *gmp, void *objp);
+ void chGuardedPoolFree(guarded_memory_pool_t *gmp, void *objp);
+#endif
#ifdef __cplusplus
}
#endif
@@ -146,7 +195,7 @@ static inline void chPoolAdd(memory_pool_t *mp, void *objp) { * memory pool.
* @pre The added object must be memory aligned to the size of
* @p stkalign_t type.
- * @note This function is just an alias for @p chPoolFree() and has been
+ * @note This function is just an alias for @p chPoolFreeI() and has been
* added for clarity.
*
* @param[in] mp pointer to a @p memory_pool_t structure
@@ -161,6 +210,48 @@ static inline void chPoolAddI(memory_pool_t *mp, void *objp) { chPoolFreeI(mp, objp);
}
+#if (CH_CFG_USE_SEMAPHORES == TRUE) || defined(__DOXYGEN__)
+/**
+ * @brief Adds an object to a guarded memory pool.
+ * @pre The guarded memory pool must be already been initialized.
+ * @pre The added object must be of the right size for the specified
+ * guarded memory pool.
+ * @pre The added object must be properly aligned.
+ * @note This function is just an alias for @p chGuardedPoolFree() and
+ * has been added for clarity.
+ *
+ * @param[in] gmp pointer to a @p guarded_memory_pool_t structure
+ * @param[in] objp the pointer to the object to be added
+ *
+ * @api
+ */
+static inline void chGuardedPoolAdd(guarded_memory_pool_t *gmp, void *objp) {
+
+ chGuardedPoolFree(gmp, objp);
+}
+
+/**
+ * @brief Adds an object to a guarded memory pool.
+ * @pre The guarded memory pool must be already been initialized.
+ * @pre The added object must be of the right size for the specified
+ * guarded memory pool.
+ * @pre The added object must be properly aligned.
+ * @note This function is just an alias for @p chGuardedPoolFreeI() and
+ * has been added for clarity.
+ *
+ * @param[in] gmp pointer to a @p guarded_memory_pool_t structure
+ * @param[in] objp the pointer to the object to be added
+ *
+ * @iclass
+ */
+static inline void chGuardedPoolAddI(guarded_memory_pool_t *gmp, void *objp) {
+
+ chDbgCheckClassI();
+
+ chGuardedPoolFreeI(gmp, objp);
+}
+#endif /* CH_CFG_USE_SEMAPHORES == TRUE */
+
#endif /* CH_CFG_USE_MEMPOOLS == TRUE */
#endif /* _CHMEMPOOLS_H_ */
|