xref: /freebsd/lib/libc/gen/valloc.3 (revision a3315650db25238dce4f04adff4ed57f7738d5fd)
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
3358f0484fSRodney W. Grimes.\"
3458f0484fSRodney W. Grimes.Dd June 4, 1993
3558f0484fSRodney W. Grimes.Dt VALLOC 3
3658f0484fSRodney W. Grimes.Os BSD 3
3758f0484fSRodney W. Grimes.Sh NAME
3858f0484fSRodney W. Grimes.Nm valloc
3958f0484fSRodney W. Grimes.Nd aligned memory allocation function
4058f0484fSRodney W. Grimes.Sh SYNOPSIS
4158f0484fSRodney W. Grimes.Fd #include <unistd.h>
42a3315650SBruce Evans.Ft void *
43a3315650SBruce Evans.Fn valloc "size_t size"
4458f0484fSRodney W. Grimes.Sh DESCRIPTION
4558f0484fSRodney W. Grimes.Bf -symbolic
4658f0484fSRodney W. GrimesValloc is obsoleted by the current version of malloc(3),
4758f0484fSRodney W. Grimeswhich aligns page-sized and larger allocations.
4858f0484fSRodney W. Grimes.Ef
4958f0484fSRodney W. Grimes.Pp
5058f0484fSRodney W. GrimesThe
5158f0484fSRodney W. Grimes.Fn valloc
5258f0484fSRodney W. Grimesfunction
5358f0484fSRodney W. Grimesallocates
5458f0484fSRodney W. Grimes.Fa size
5558f0484fSRodney W. Grimesbytes aligned on a page boundary.
5658f0484fSRodney W. GrimesIt is implemented by calling
5758f0484fSRodney W. Grimes.Xr malloc 3
5858f0484fSRodney W. Grimeswith a slightly larger request, saving the true beginning of the block
5958f0484fSRodney W. Grimesallocated, and returning a properly aligned pointer.
6058f0484fSRodney W. Grimes.Sh RETURN VALUES
6158f0484fSRodney W. GrimesThe
6258f0484fSRodney W. Grimes.Fn valloc
6358f0484fSRodney W. Grimesfunction returns
6458f0484fSRodney W. Grimesa pointer to the allocated space if successful; otherwise
6558f0484fSRodney W. Grimesa null pointer is returned
6658f0484fSRodney W. Grimes.Sh HISTORY
6758f0484fSRodney W. GrimesThe
6858f0484fSRodney W. Grimes.Fn valloc
6958f0484fSRodney W. Grimesfunction appeared in
7058f0484fSRodney W. Grimes.Bx 3.0 .
7158f0484fSRodney W. Grimes.Sh BUGS
7258f0484fSRodney W. GrimesA
7358f0484fSRodney W. Grimes.Em vfree
7458f0484fSRodney W. Grimesfunction
7558f0484fSRodney W. Grimeshas not been implemented.
76