1 .\" Copyright (C) 2006 Jason Evans <jasone@FreeBSD.org>.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice(s), this list of conditions and the following disclaimer as
9 .\" the first lines of this file unmodified other than the possible
10 .\" addition of one or more copyright notices.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice(s), this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 .Nd aligned memory allocation
40 .Fn posix_memalign "void **ptr" "size_t alignment" "size_t size"
42 .Fn aligned_alloc "size_t alignment" "size_t size"
48 bytes of memory such that the allocation's base address is an even multiple of
50 and returns the allocation in the value pointed to by
55 must be a power of 2 at least as large as
58 Memory that is allocated via
60 can be used as an argument in subsequent calls to
68 function is the same as
74 and the allocation pointer is returned.
75 .Sh IMPLEMENTATION NOTES
78 function is directly supported by matching the requested alignment against a zone
79 of the slab allocator with a compatible chunking, and using the power-of-2
80 shortcut whenever possible.
81 Alignments beyond those supported by the zone mechanism are still
87 is thus able to take advantage of the slab allocator to produce
88 well-fitted results when the requests are reasonable.
92 function returns the value 0 if successful; otherwise it returns an error value.
95 returns a pointer to the allocated memory if successful; otherwise a
97 pointer is returned and
105 functions will fail if:
110 parameter is not a power of 2 at least as large as
111 .Fn sizeof "void *" .
113 Memory allocation error.