add paragraph about alignment
authorSimon Marlow <marlowsd@gmail.com>
Wed, 14 Jul 2010 08:59:17 +0000 (08:59 +0000)
committerSimon Marlow <marlowsd@gmail.com>
Wed, 14 Jul 2010 08:59:17 +0000 (08:59 +0000)
report/libs/Foreign-Marshal-Alloc.tex

index b4fd0fa..789cff9 100644 (file)
@@ -25,6 +25,13 @@ further access to the memory area referenced by a pointer passed to
 \haddockid{realloc}, \haddockid{reallocBytes}, or \haddockid{free} entails undefined
 behaviour.
 \par
+All storage allocated by functions that allocate based on a \emph{size in bytes}
+must be sufficiently aligned for any of the basic foreign types
+that fits into the newly allocated storage. All storage allocated by
+functions that allocate based on a specific type must be sufficiently
+aligned for that type. Array allocation routines need to obey the same
+alignment constraints for each array element.
+\par
 
 \section{Memory allocation
 }