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