xref: /openbsd-src/lib/libc/gen/valloc.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: valloc.3,v 1.9 2000/12/24 00:30:53 aaron 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.Dd June 4, 1993
35.Dt VALLOC 3
36.Os
37.Sh NAME
38.Nm valloc
39.Nd aligned memory allocation function
40.Sh SYNOPSIS
41.Fd #include <unistd.h>
42.Ft void *
43.Fn valloc "size_t size"
44.Sh DESCRIPTION
45.Bf -symbolic
46The
47.Fn valloc
48function is obsoleted by the current version of
49.Xr malloc 3 ,
50which aligns page-sized and larger allocations.
51.Ef
52.Pp
53The
54.Fn valloc
55function allocates
56.Fa size
57bytes aligned on a page boundary.
58It is implemented by calling
59.Xr malloc 3
60with a slightly larger request, saving the true beginning of the block
61allocated, and returning a properly aligned pointer.
62.Sh RETURN VALUES
63The
64.Fn valloc
65function returns
66a pointer to the allocated space if successful; otherwise a
67null pointer is returned.
68.Sh HISTORY
69The
70.Fn valloc
71function appeared in
72.Bx 3.0 .
73.Sh BUGS
74A
75.Fn vfree
76function has not been implemented.
77