Module: xenomai-3
Branch: next
Commit: dec31a18e8aba5cb46262716991f6e944c242de4
URL:    
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=dec31a18e8aba5cb46262716991f6e944c242de4

Author: Philippe Gerum <r...@xenomai.org>
Date:   Sun Jun 21 12:48:09 2015 +0200

alchemy/heap: document rounding of large block sizes

---

 lib/alchemy/heap.c |    7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/alchemy/heap.c b/lib/alchemy/heap.c
index 79de42b..20531e3 100644
--- a/lib/alchemy/heap.c
+++ b/lib/alchemy/heap.c
@@ -407,6 +407,13 @@ out:
  *
  * @apitags{xthread-nowait, switch-primary}
  *
+ * @note If shared multi-processing is enabled (i.e. --enable-pshared
+ * was passed to the configure script), requests for a block size
+ * larger than twice the allocation page size are rounded up to the
+ * next page size. The allocation page size is currently 512 bytes
+ * long (HOBJ_PAGE_SIZE), which means that any request larger than 1k
+ * will be rounded up to the next 512 byte boundary.
+ *
  * @note @a abs_timeout is interpreted as a multiple of the Alchemy
  * clock resolution (see --alchemy-clock-resolution option, defaults
  * to 1 nanosecond).


_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://xenomai.org/mailman/listinfo/xenomai-git

Reply via email to