xref: /freebsd/lib/libc/gen/valloc.3 (revision 43326ef72b468806b612b12fcff91e0dad3bbecf)
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.
1258f0484fSRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software
1358f0484fSRodney W. Grimes.\"    must display the following acknowledgement:
1458f0484fSRodney W. Grimes.\"	This product includes software developed by the University of
1558f0484fSRodney W. Grimes.\"	California, Berkeley and its contributors.
1658f0484fSRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors
1758f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1858f0484fSRodney W. Grimes.\"    without specific prior written permission.
1958f0484fSRodney W. Grimes.\"
2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3158f0484fSRodney W. Grimes.\"
3258f0484fSRodney W. Grimes.\"     @(#)valloc.3	8.1 (Berkeley) 6/4/93
337f3dea24SPeter Wemm.\" $FreeBSD$
3458f0484fSRodney W. Grimes.\"
3543326ef7SJason Evans.Dd September 13, 2005
3658f0484fSRodney W. Grimes.Dt VALLOC 3
37a307d598SRuslan Ermilov.Os
3858f0484fSRodney W. Grimes.Sh NAME
3958f0484fSRodney W. Grimes.Nm valloc
4058f0484fSRodney W. Grimes.Nd aligned memory allocation function
4125bb73e0SAlexey Zelkin.Sh LIBRARY
4225bb73e0SAlexey Zelkin.Lb libc
4358f0484fSRodney W. Grimes.Sh SYNOPSIS
4432eef9aeSRuslan Ermilov.In unistd.h
45a3315650SBruce Evans.Ft void *
46a3315650SBruce Evans.Fn valloc "size_t size"
4758f0484fSRodney W. Grimes.Sh DESCRIPTION
4858f0484fSRodney W. Grimes.Bf -symbolic
496575e6daSRuslan ErmilovThe
506575e6daSRuslan Ermilov.Fn valloc
5143326ef7SJason Evansfunction is obsoleted by
5243326ef7SJason Evans.Xr posix_memalign 3 ,
5343326ef7SJason Evanswhich can be used to request page-aligned allocations.
5458f0484fSRodney W. Grimes.Ef
5558f0484fSRodney W. Grimes.Pp
5658f0484fSRodney W. GrimesThe
5758f0484fSRodney W. Grimes.Fn valloc
5858f0484fSRodney W. Grimesfunction
5958f0484fSRodney W. Grimesallocates
6058f0484fSRodney W. Grimes.Fa size
6158f0484fSRodney W. Grimesbytes aligned on a page boundary.
6258f0484fSRodney W. Grimes.Sh RETURN VALUES
6358f0484fSRodney W. GrimesThe
6458f0484fSRodney W. Grimes.Fn valloc
6558f0484fSRodney W. Grimesfunction returns
6658f0484fSRodney W. Grimesa pointer to the allocated space if successful; otherwise
6743326ef7SJason Evansa null pointer is returned.
6843326ef7SJason Evans.Sh SEE ALSO
6943326ef7SJason Evans.Xr posix_memalign 3
7058f0484fSRodney W. Grimes.Sh HISTORY
7158f0484fSRodney W. GrimesThe
7258f0484fSRodney W. Grimes.Fn valloc
7358f0484fSRodney W. Grimesfunction appeared in
7458f0484fSRodney W. Grimes.Bx 3.0 .
7543326ef7SJason Evans.Pp
7643326ef7SJason EvansThe
7743326ef7SJason Evans.Fn valloc
7843326ef7SJason Evansfunction correctly allocated memory that could be deallocated via
7943326ef7SJason Evans.Fn free
8043326ef7SJason Evansin
8143326ef7SJason Evans.Bx 7.0 .
82