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