You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by jo...@apache.org on 2004/09/22 11:11:49 UTC
cvs commit: apr-util/include apr_rmm.h
jorton 2004/09/22 02:11:49
Modified: include apr_rmm.h
Log:
* include/apr_rmm.h: Document alignment requirement for apr_rmm_init,
and hence the alignement guarantee which apr_rmm_addr_get can offer.
Revision Changes Path
1.11 +3 -0 apr-util/include/apr_rmm.h
Index: apr_rmm.h
===================================================================
RCS file: /home/cvs/apr-util/include/apr_rmm.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -d -w -u -r1.10 -r1.11
--- apr_rmm.h 13 Feb 2004 09:55:26 -0000 1.10
+++ apr_rmm.h 22 Sep 2004 09:11:48 -0000 1.11
@@ -48,6 +48,8 @@
* @param membuf The block of relocateable memory to be managed
* @param memsize The size of relocateable memory block to be managed
* @param cont The pool to use for local storage and management
+ * @remark Both @param membuf and @param memsize must be aligned
+ * (for instance using APR_ALIGN_DEFAULT).
*/
APU_DECLARE(apr_status_t) apr_rmm_init(apr_rmm_t **rmm, apr_anylock_t *lock,
void* membuf, apr_size_t memsize,
@@ -108,6 +110,7 @@
* Retrieve the physical address of a relocatable allocation of memory
* @param rmm The relocatable memory block
* @param entity The memory allocation to free
+ * @return address The address, aligned with APR_ALIGN_DEFAULT.
*/
APU_DECLARE(void *) apr_rmm_addr_get(apr_rmm_t *rmm, apr_rmm_off_t entity);