posix_memalign.3: Add implementation notes from malloc.3
authorStathis Kamperis <beket@dragonflybsd.org>
Sat, 2 May 2009 18:54:09 +0000 (18:54 +0000)
committerStathis Kamperis <beket@dragonflybsd.org>
Sat, 2 May 2009 20:47:59 +0000 (20:47 +0000)
Reviewed-by: swildner@
lib/libc/stdlib/malloc.3
lib/libc/stdlib/posix_memalign.3

index fbb6c51..e4011d9 100644 (file)
@@ -37,7 +37,7 @@
 .\" $FreeBSD: src/lib/libc/stdlib/malloc.3,v 1.25.2.16 2003/01/06 17:10:45 trhodes Exp $
 .\" $DragonFly: src/lib/libc/stdlib/malloc.3,v 1.8 2008/05/02 02:05:04 swildner Exp $
 .\"
-.Dd April 30, 2009
+.Dd May 2, 2009
 .Dt MALLOC 3
 .Os
 .Sh NAME
@@ -196,19 +196,6 @@ The zone mechanism also has the nice side effect of greatly reducing
 fragmentation over the original
 .Nm .
 .Pp
-.Xr posix_memalign 3
-is directly supported by matching the requested alignment against a zone
-with a compatible chunking, and using the power-of-2 shortcut whenever
-possible.
-Alignments beyond those supported by the zone mechanism are still
-guaranteed using cute
-.Xr mmap 2
-tricks.
-Our
-.Xr posix_memalign 3
-is thus able to take advantage of the slab allocator to produce
-well-fitted results when the requests are reasonable.
-.Pp
 .Fn calloc
 is directly supported by keeping track of newly-allocated zones which
 will be demand-zero'd by the system.
@@ -277,7 +264,8 @@ and the process will dump core.
 .Xr mmap 2 ,
 .Xr alloca 3 ,
 .Xr getpagesize 3 ,
-.Xr memory 3
+.Xr memory 3 ,
+.Xr posix_memalign
 .Sh STANDARDS
 The
 .Fn malloc ,
index 4efb942..5fff120 100644 (file)
@@ -59,6 +59,20 @@ can be used as an argument in subsequent calls to
 .Xr reallocf 3 ,
 and
 .Xr free 3 .
+.Sh IMPLEMENTATION NOTES
+The
+.Fn posix_memalign
+function is directly supported by matching the requested alignment against a zone
+of the slab allocator with a compatible chunking, and using the power-of-2
+shortcut whenever possible.
+Alignments beyond those supported by the zone mechanism are still
+guaranteed using cute
+.Xr mmap 2
+tricks.
+Our
+.Fn posix_memalign
+is thus able to take advantage of the slab allocator to produce
+well-fitted results when the requests are reasonable.
 .Sh RETURN VALUES
 The
 .Fn posix_memalign