xref: /freebsd/lib/libc/gen/valloc.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
158f0484fSRodney W. Grimes.\" Copyright (c) 1980, 1991, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
658f0484fSRodney W. Grimes.\" are met:
758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
858f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1058f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1158f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
12*fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
1358f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1458f0484fSRodney W. Grimes.\"    without specific prior written permission.
1558f0484fSRodney W. Grimes.\"
1658f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1758f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1858f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1958f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2058f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2158f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2258f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2358f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2458f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2558f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2658f0484fSRodney W. Grimes.\" SUCH DAMAGE.
2758f0484fSRodney W. Grimes.\"
28aada4cf3SGiorgos Keramidas.Dd October 30, 2007
2958f0484fSRodney W. Grimes.Dt VALLOC 3
30a307d598SRuslan Ermilov.Os
3158f0484fSRodney W. Grimes.Sh NAME
3258f0484fSRodney W. Grimes.Nm valloc
3358f0484fSRodney W. Grimes.Nd aligned memory allocation function
3425bb73e0SAlexey Zelkin.Sh LIBRARY
3525bb73e0SAlexey Zelkin.Lb libc
3658f0484fSRodney W. Grimes.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In unistd.h
38a3315650SBruce Evans.Ft void *
39a3315650SBruce Evans.Fn valloc "size_t size"
4058f0484fSRodney W. Grimes.Sh DESCRIPTION
416575e6daSRuslan ErmilovThe
426575e6daSRuslan Ermilov.Fn valloc
4343326ef7SJason Evansfunction is obsoleted by
4443326ef7SJason Evans.Xr posix_memalign 3 ,
4543326ef7SJason Evanswhich can be used to request page-aligned allocations.
4658f0484fSRodney W. Grimes.Pp
4758f0484fSRodney W. GrimesThe
4858f0484fSRodney W. Grimes.Fn valloc
4958f0484fSRodney W. Grimesfunction
5058f0484fSRodney W. Grimesallocates
5158f0484fSRodney W. Grimes.Fa size
5258f0484fSRodney W. Grimesbytes aligned on a page boundary.
5358f0484fSRodney W. Grimes.Sh RETURN VALUES
5458f0484fSRodney W. GrimesThe
5558f0484fSRodney W. Grimes.Fn valloc
5658f0484fSRodney W. Grimesfunction returns
5758f0484fSRodney W. Grimesa pointer to the allocated space if successful; otherwise
5843326ef7SJason Evansa null pointer is returned.
5943326ef7SJason Evans.Sh SEE ALSO
6043326ef7SJason Evans.Xr posix_memalign 3
6158f0484fSRodney W. Grimes.Sh HISTORY
6258f0484fSRodney W. GrimesThe
6358f0484fSRodney W. Grimes.Fn valloc
6458f0484fSRodney W. Grimesfunction appeared in
6558f0484fSRodney W. Grimes.Bx 3.0 .
6643326ef7SJason Evans.Pp
6743326ef7SJason EvansThe
6843326ef7SJason Evans.Fn valloc
6943326ef7SJason Evansfunction correctly allocated memory that could be deallocated via
7043326ef7SJason Evans.Fn free
712872a3cdSJason Evansstarting in
722872a3cdSJason Evans.Fx 7.0 .
73