Merge from vendor branch BZIP:
[dragonfly.git] / lib / libc / gen / valloc.3
CommitLineData
984263bc
MD
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 $
1de703da 34.\" $DragonFly: src/lib/libc/gen/valloc.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
984263bc
MD
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.In unistd.h
46.Ft void *
47.Fn valloc "size_t size"
48.Sh DESCRIPTION
49.Bf -symbolic
50The
51.Fn valloc
52function is obsoleted by the current version of
53.Xr malloc 3 ,
54which aligns page-sized and larger allocations.
55.Ef
56.Pp
57The
58.Fn valloc
59function
60allocates
61.Fa size
62bytes aligned on a page boundary.
63It is implemented by calling
64.Xr malloc 3
65with a slightly larger request, saving the true beginning of the block
66allocated, and returning a properly aligned pointer.
67.Sh RETURN VALUES
68The
69.Fn valloc
70function returns
71a pointer to the allocated space if successful; otherwise
72a null pointer is returned
73.Sh HISTORY
74The
75.Fn valloc
76function appeared in
77.Bx 3.0 .
78.Sh BUGS
79A
80.Em vfree
81function
82has not been implemented.