aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--os/common/oslib/include/chfactory.h3
-rw-r--r--os/common/oslib/include/chfifo.h12
-rw-r--r--os/common/oslib/include/chmempools.h68
-rw-r--r--os/common/oslib/src/chfactory.c9
-rw-r--r--os/common/oslib/src/chmempools.c19
-rw-r--r--readme.txt1
-rw-r--r--test/nil/configuration.xml4
-rw-r--r--test/nil/source/test/test_sequence_006.c4
-rw-r--r--test/rt/configuration.xml4
-rw-r--r--test/rt/source/test/test_sequence_010.c4
10 files changed, 94 insertions, 34 deletions
diff --git a/os/common/oslib/include/chfactory.h b/os/common/oslib/include/chfactory.h
index 43b389cc4..e89d0814b 100644
--- a/os/common/oslib/include/chfactory.h
+++ b/os/common/oslib/include/chfactory.h
@@ -333,7 +333,8 @@ extern "C" {
#if (CH_CFG_FACTORY_OBJ_FIFOS == TRUE) || defined(__DOXIGEN__)
dyn_objects_fifo_t *chFactoryCreateObjectsFIFO(const char *name,
size_t objsize,
- size_t objn);
+ size_t objn,
+ unsigned objalign);
dyn_objects_fifo_t *chFactoryFindObjectsFIFO(const char *name);
void chFactoryReleaseObjectsFIFO(dyn_objects_fifo_t *dofp);
#endif
diff --git a/os/common/oslib/include/chfifo.h b/os/common/oslib/include/chfifo.h
index 9f3c0924b..1df57ef41 100644
--- a/os/common/oslib/include/chfifo.h
+++ b/os/common/oslib/include/chfifo.h
@@ -110,22 +110,26 @@ extern "C" {
/**
* @brief Initializes a FIFO object.
+ * @pre The messages size must be a multiple of the alignment
+ * requirement.
*
* @param[out] ofp pointer to a @p objects_fifo_t structure
* @param[in] objsize size of objects
* @param[in] objn number of objects available
+ * @param[in] objalign required objects alignment
* @param[in] objbuf pointer to the buffer of objects, it must be able
- * to hold @p objn objects of @p objsize size
+ * to hold @p objn objects of @p objsize size with
+ * @p objealign alignment
* @param[in] msgbuf pointer to the buffer of messages, it must be able
* to hold @p objn messages
*
* @init
*/
static inline void chFifoObjectInit(objects_fifo_t *ofp, size_t objsize,
- size_t objn, void *objbuf,
- msg_t *msgbuf) {
+ size_t objn, unsigned objalign,
+ void *objbuf, msg_t *msgbuf) {
- chGuardedPoolObjectInit(&ofp->free, objsize);
+ chGuardedPoolObjectInitAligned(&ofp->free, objsize, objalign);
chGuardedPoolLoadArray(&ofp->free, objbuf, objn);
chMBObjectInit(&ofp->mbx, msgbuf, objn);
}
diff --git a/os/common/oslib/include/chmempools.h b/os/common/oslib/include/chmempools.h
index 25de236ce..0e9773374 100644
--- a/os/common/oslib/include/chmempools.h
+++ b/os/common/oslib/include/chmempools.h
@@ -69,6 +69,7 @@ typedef struct {
struct pool_header *next; /**< @brief Pointer to the header. */
size_t object_size; /**< @brief Memory pool objects
size. */
+ unsigned align; /**< @brief Required alignment. */
memgetfunc_t provider; /**< @brief Memory blocks provider
for this pool. */
} memory_pool_t;
@@ -95,10 +96,11 @@ typedef struct {
*
* @param[in] name the name of the memory pool variable
* @param[in] size size of the memory pool contained objects
+ * @param[in] align required memory alignment
* @param[in] provider memory provider function for the memory pool
*/
-#define _MEMORYPOOL_DATA(name, size, provider) \
- {NULL, size, provider}
+#define _MEMORYPOOL_DATA(name, size, align, provider) \
+ {NULL, size, align, provider}
/**
* @brief Static memory pool initializer.
@@ -107,11 +109,12 @@ typedef struct {
*
* @param[in] name the name of the memory pool variable
* @param[in] size size of the memory pool contained objects
+ * @param[in] align required memory alignment
* @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)
+#define MEMORYPOOL_DECL(name, size, align, provider) \
+ memory_pool_t name = _MEMORYPOOL_DATA(name, size, align, provider)
#if (CH_CFG_USE_SEMAPHORES == TRUE) || defined(__DOXYGEN__)
/**
@@ -121,10 +124,11 @@ typedef struct {
*
* @param[in] name the name of the memory pool variable
* @param[in] size size of the memory pool contained objects
+ * @param[in] align required memory alignment
*/
-#define _GUARDEDMEMORYPOOL_DATA(name, size) { \
+#define _GUARDEDMEMORYPOOL_DATA(name, size, align) { \
_SEMAPHORE_DATA(name.sem, (cnt_t)0), \
- _MEMORYPOOL_DATA(NULL, size, NULL) \
+ _MEMORYPOOL_DATA(NULL, size, align, NULL) \
}
/**
@@ -134,9 +138,10 @@ typedef struct {
*
* @param[in] name the name of the guarded memory pool variable
* @param[in] size size of the memory pool contained objects
+ * @param[in] align required memory alignment
*/
-#define GUARDEDMEMORYPOOL_DECL(name, size) \
- guarded_memory_pool_t name = _GUARDEDMEMORYPOOL_DATA(name, size)
+#define GUARDEDMEMORYPOOL_DECL(name, size, align) \
+ guarded_memory_pool_t name = _GUARDEDMEMORYPOOL_DATA(name, size, align)
#endif /* CH_CFG_USE_SEMAPHORES == TRUE */
/*===========================================================================*/
@@ -146,14 +151,17 @@ typedef struct {
#ifdef __cplusplus
extern "C" {
#endif
- void chPoolObjectInit(memory_pool_t *mp, size_t size, memgetfunc_t provider);
+ void chPoolObjectInitAligned(memory_pool_t *mp, size_t size,
+ unsigned align, memgetfunc_t provider);
void chPoolLoadArray(memory_pool_t *mp, void *p, size_t n);
void *chPoolAllocI(memory_pool_t *mp);
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 chGuardedPoolObjectInitAligned(guarded_memory_pool_t *gmp,
+ size_t size,
+ unsigned align);
void chGuardedPoolLoadArray(guarded_memory_pool_t *gmp, void *p, size_t n);
void *chGuardedPoolAllocTimeoutS(guarded_memory_pool_t *gmp,
systime_t timeout);
@@ -171,6 +179,26 @@ extern "C" {
/*===========================================================================*/
/**
+ * @brief Initializes an empty memory pool.
+ *
+ * @param[out] mp pointer to a @p memory_pool_t structure
+ * @param[in] size the size of the objects contained in this memory pool,
+ * the minimum accepted size is the size of a pointer to
+ * void.
+ * @param[in] provider memory provider function for the memory pool or
+ * @p NULL if the pool is not allowed to grow
+ * automatically
+ *
+ * @init
+ */
+static inline void chPoolObjectInit(memory_pool_t *mp,
+ size_t size,
+ memgetfunc_t provider) {
+
+ chPoolObjectInitAligned(mp, size, PORT_NATURAL_ALIGN, provider);
+}
+
+/**
* @brief Adds an object to a memory pool.
* @pre The memory pool must be already been initialized.
* @pre The added object must be of the right size for the specified
@@ -207,13 +235,27 @@ static inline void chPoolAdd(memory_pool_t *mp, void *objp) {
*/
static inline void chPoolAddI(memory_pool_t *mp, void *objp) {
- chDbgCheckClassI();
-
chPoolFreeI(mp, objp);
}
#if (CH_CFG_USE_SEMAPHORES == TRUE) || defined(__DOXYGEN__)
/**
+ * @brief Initializes an empty guarded memory pool.
+ *
+ * @param[out] gmp pointer to a @p guarded_memory_pool_t structure
+ * @param[in] size the size of the objects contained in this guarded
+ * memory pool, the minimum accepted size is the size
+ * of a pointer to void.
+ *
+ * @init
+ */
+static inline void chGuardedPoolObjectInit(guarded_memory_pool_t *gmp,
+ size_t size) {
+
+ chGuardedPoolObjectInitAligned(gmp, size, PORT_NATURAL_ALIGN);
+}
+
+/**
* @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
@@ -248,8 +290,6 @@ static inline void chGuardedPoolAdd(guarded_memory_pool_t *gmp, void *objp) {
*/
static inline void chGuardedPoolAddI(guarded_memory_pool_t *gmp, void *objp) {
- chDbgCheckClassI();
-
chGuardedPoolFreeI(gmp, objp);
}
diff --git a/os/common/oslib/src/chfactory.c b/os/common/oslib/src/chfactory.c
index 5e7604917..45a6a0681 100644
--- a/os/common/oslib/src/chfactory.c
+++ b/os/common/oslib/src/chfactory.c
@@ -581,7 +581,9 @@ void chFactoryReleaseMailbox(dyn_mailbox_t *dmp) {
*
* @param[in] name name to be assigned to the new dynamic "objects FIFO"
* object
- *
+ * @param[in] objsize size of objects
+ * @param[in] objn number of objects available
+ * @param[in] objalign required objects alignment
* @return The reference to the created dynamic "objects FIFO"
* object.
* @retval NULL if the dynamic "objects FIFO" object cannot be
@@ -592,7 +594,8 @@ void chFactoryReleaseMailbox(dyn_mailbox_t *dmp) {
*/
dyn_objects_fifo_t *chFactoryCreateObjectsFIFO(const char *name,
size_t objsize,
- size_t objn) {
+ size_t objn,
+ unsigned objalign) {
dyn_objects_fifo_t *dofp;
chSysLock();
@@ -604,7 +607,7 @@ dyn_objects_fifo_t *chFactoryCreateObjectsFIFO(const char *name,
(objn * objsize));
if (dofp != NULL) {
/* Initializing mailbox object data.*/
- chFifoObjectInit(&dofp->fifo, objsize, objn,
+ chFifoObjectInit(&dofp->fifo, objsize, objn, objalign,
dofp->msgbuf, (void *)&dofp->msgbuf[objn]);
}
diff --git a/os/common/oslib/src/chmempools.c b/os/common/oslib/src/chmempools.c
index 384e2f7ee..aec47400c 100644
--- a/os/common/oslib/src/chmempools.c
+++ b/os/common/oslib/src/chmempools.c
@@ -67,18 +67,21 @@
* @param[in] size the size of the objects contained in this memory pool,
* the minimum accepted size is the size of a pointer to
* void.
+ * @param[in] align required memory alignment
* @param[in] provider memory provider function for the memory pool or
* @p NULL if the pool is not allowed to grow
* automatically
*
* @init
*/
-void chPoolObjectInit(memory_pool_t *mp, size_t size, memgetfunc_t provider) {
+void chPoolObjectInitAligned(memory_pool_t *mp, size_t size,
+ unsigned align, memgetfunc_t provider) {
chDbgCheck((mp != NULL) && (size >= sizeof(void *)));
mp->next = NULL;
mp->object_size = size;
+ mp->align = align;
mp->provider = provider;
}
@@ -87,6 +90,8 @@ void chPoolObjectInit(memory_pool_t *mp, size_t size, memgetfunc_t provider) {
* @pre The memory pool must be already been initialized.
* @pre The array elements must be of the right size for the specified
* memory pool.
+ * @pre The array elements size must be a multiple of the alignment
+ * requirement for the pool.
* @post The memory pool contains the elements of the input array.
*
* @param[in] mp pointer to a @p memory_pool_t structure
@@ -130,7 +135,7 @@ void *chPoolAllocI(memory_pool_t *mp) {
mp->next = mp->next->next;
}
else if (mp->provider != NULL) {
- objp = mp->provider(mp->object_size, PORT_NATURAL_ALIGN); /* TODO: Alignment is not properly handled */
+ objp = mp->provider(mp->object_size, mp->align);
}
/*lint -restore*/
@@ -175,6 +180,9 @@ void chPoolFreeI(memory_pool_t *mp, void *objp) {
chDbgCheckClassI();
chDbgCheck((mp != NULL) && (objp != NULL));
+ chDbgAssert(((size_t)objp & MEM_ALIGN_MASK(mp->align)) == 0U,
+ "unaligned object");
+
php->next = mp->next;
mp->next = php;
}
@@ -206,12 +214,15 @@ void chPoolFree(memory_pool_t *mp, void *objp) {
* @param[in] size the size of the objects contained in this guarded
* memory pool, the minimum accepted size is the size
* of a pointer to void.
+ * @param[in] align required memory alignment
*
* @init
*/
-void chGuardedPoolObjectInit(guarded_memory_pool_t *gmp, size_t size) {
+void chGuardedPoolObjectInitAligned(guarded_memory_pool_t *gmp,
+ size_t size,
+ unsigned align) {
- chPoolObjectInit(&gmp->pool, size, NULL);
+ chPoolObjectInitAligned(&gmp->pool, size, align, NULL);
chSemObjectInit(&gmp->sem, (cnt_t)0);
}
diff --git a/readme.txt b/readme.txt
index 7efa5ddeb..803ebe7f4 100644
--- a/readme.txt
+++ b/readme.txt
@@ -89,6 +89,7 @@
*****************************************************************************
*** Next ***
+- NEW: Added alignment capability to memory pools.
- NEW: Mailbox API changed by adding "Timeout" to those function that have
timeout capability, for consistency with the rest of the system.
- NEW: Modified mailboxes to use a size_t as counter instead of a cnt_t,
diff --git a/test/nil/configuration.xml b/test/nil/configuration.xml
index 542ccb8b6..c62e00a37 100644
--- a/test/nil/configuration.xml
+++ b/test/nil/configuration.xml
@@ -1152,10 +1152,10 @@ test_assert(msg1 == MSG_TIMEOUT, "wrong wake-up message");]]></value>
<value><![CDATA[#define MEMORY_POOL_SIZE 4
static uint32_t objects[MEMORY_POOL_SIZE];
-static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), NULL);
+static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), PORT_NATURAL_ALIGN, NULL);
#if CH_CFG_USE_SEMAPHORES
-static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t));
+static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t), PORT_NATURAL_ALIGN);
#endif
static void *null_provider(size_t size, unsigned align) {
diff --git a/test/nil/source/test/test_sequence_006.c b/test/nil/source/test/test_sequence_006.c
index 759ceae52..123b6d5e7 100644
--- a/test/nil/source/test/test_sequence_006.c
+++ b/test/nil/source/test/test_sequence_006.c
@@ -52,10 +52,10 @@
#define MEMORY_POOL_SIZE 4
static uint32_t objects[MEMORY_POOL_SIZE];
-static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), NULL);
+static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), PORT_NATURAL_ALIGN, NULL);
#if CH_CFG_USE_SEMAPHORES
-static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t));
+static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t), PORT_NATURAL_ALIGN);
#endif
static void *null_provider(size_t size, unsigned align) {
diff --git a/test/rt/configuration.xml b/test/rt/configuration.xml
index 00ecd82a8..056687afe 100644
--- a/test/rt/configuration.xml
+++ b/test/rt/configuration.xml
@@ -3541,10 +3541,10 @@ test_assert(msg1 == MSG_TIMEOUT, "wrong wake-up message");]]></value>
<value><![CDATA[#define MEMORY_POOL_SIZE 4
static uint32_t objects[MEMORY_POOL_SIZE];
-static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), NULL);
+static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), PORT_NATURAL_ALIGN, NULL);
#if CH_CFG_USE_SEMAPHORES
-static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t));
+static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t), PORT_NATURAL_ALIGN);
#endif
static void *null_provider(size_t size, unsigned align) {
diff --git a/test/rt/source/test/test_sequence_010.c b/test/rt/source/test/test_sequence_010.c
index 1a5833778..ebdf7acac 100644
--- a/test/rt/source/test/test_sequence_010.c
+++ b/test/rt/source/test/test_sequence_010.c
@@ -52,10 +52,10 @@
#define MEMORY_POOL_SIZE 4
static uint32_t objects[MEMORY_POOL_SIZE];
-static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), NULL);
+static MEMORYPOOL_DECL(mp1, sizeof (uint32_t), PORT_NATURAL_ALIGN, NULL);
#if CH_CFG_USE_SEMAPHORES
-static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t));
+static GUARDEDMEMORYPOOL_DECL(gmp1, sizeof (uint32_t), PORT_NATURAL_ALIGN);
#endif
static void *null_provider(size_t size, unsigned align) {
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-22 10:58:18 +0000