xref: /freebsd/lib/libc/gen/valloc.3 (revision 6be3386466ab79a84b48429ae66244f21526d3df)
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.\" $FreeBSD$
30.\"
31.Dd October 30, 2007
32.Dt VALLOC 3
33.Os
34.Sh NAME
35.Nm valloc
36.Nd aligned memory allocation function
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In unistd.h
41.Ft void *
42.Fn valloc "size_t size"
43.Sh DESCRIPTION
44The
45.Fn valloc
46function is obsoleted by
47.Xr posix_memalign 3 ,
48which can be used to request page-aligned allocations.
49.Pp
50The
51.Fn valloc
52function
53allocates
54.Fa size
55bytes aligned on a page boundary.
56.Sh RETURN VALUES
57The
58.Fn valloc
59function returns
60a pointer to the allocated space if successful; otherwise
61a null pointer is returned.
62.Sh SEE ALSO
63.Xr posix_memalign 3
64.Sh HISTORY
65The
66.Fn valloc
67function appeared in
68.Bx 3.0 .
69.Pp
70The
71.Fn valloc
72function correctly allocated memory that could be deallocated via
73.Fn free
74starting in
75.Fx 7.0 .
76