1.\"	$OpenBSD: valloc.3,v 1.15 2018/11/05 10:31:32 otto 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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd $Mdocdate: November 5 2018 $
31.Dt VALLOC 3
32.Os
33.Sh NAME
34.Nm valloc
35.Nd aligned memory allocation function
36.Sh SYNOPSIS
37.In unistd.h
38.Ft void *
39.Fn valloc "size_t size"
40.Sh DESCRIPTION
41.Bf -symbolic
42The
43.Fn valloc
44function is obsoleted by the current version of
45.Xr malloc 3 ,
46which aligns page-sized and larger allocations
47and both
48.Xr aligned_alloc 3
49and
50.Xr posix_memalign 3 ,
51which allocate memory with a given alignment.
52.Ef
53.Pp
54The
55.Fn valloc
56function allocates
57.Fa size
58bytes aligned on a page boundary.
59It is implemented by calling
60.Xr malloc 3
61with a slightly larger request, saving the true beginning of the block
62allocated, and returning a properly aligned pointer.
63.Sh RETURN VALUES
64The
65.Fn valloc
66function returns
67a pointer to the allocated space if successful; otherwise a
68null pointer is returned.
69.Sh SEE ALSO
70.Xr malloc 3
71.Sh HISTORY
72The
73.Fn valloc
74function appeared in
75.Bx 3.0 .
76.Sh BUGS
77A
78.Fn vfree
79function has not been implemented.
80