xref: /openbsd-src/lib/libc/gen/valloc.3 (revision 898184e3e61f9129feb5978fad5a8c6865f00b92)
1.\"	$OpenBSD: valloc.3,v 1.13 2010/05/18 22:24:55 tedu Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd $Mdocdate: May 18 2010 $
31.Dt VALLOC 3
32.Os
33.Sh NAME
34.Nm valloc
35.Nd aligned memory allocation function
36.Sh SYNOPSIS
37.Fd #include <unistd.h>
38.Ft void *
39.Fn valloc "size_t size"
40.Sh DESCRIPTION
41.Bf -symbolic
42The
43.Fn valloc
44function is obsoleted by the current version of
45.Xr malloc 3 ,
46which aligns page-sized and larger allocations,
47and
48.Xr posix_memalign 3 ,
49which allocates memory with a given alignment.
50.Ef
51.Pp
52The
53.Fn valloc
54function allocates
55.Fa size
56bytes aligned on a page boundary.
57It is implemented by calling
58.Xr malloc 3
59with a slightly larger request, saving the true beginning of the block
60allocated, and returning a properly aligned pointer.
61.Sh RETURN VALUES
62The
63.Fn valloc
64function returns
65a pointer to the allocated space if successful; otherwise a
66null pointer is returned.
67.Sh SEE ALSO
68.Xr malloc 3
69.Sh HISTORY
70The
71.Fn valloc
72function appeared in
73.Bx 3.0 .
74.Sh BUGS
75A
76.Fn vfree
77function has not been implemented.
78