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