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