BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / valloc.3

diff --git a/usr/src/lib/libc/gen/valloc.3 b/usr/src/lib/libc/gen/valloc.3
index 9fc9ea2..a737f77 100644 (file)
--- a/usr/src/lib/libc/gen/valloc.3
+++ b/usr/src/lib/libc/gen/valloc.3
@@ -1,37 +1,75 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)valloc.3    6.2 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH VALLOC 3C ""
-.UC 3
-.SH NAME
-valloc \- aligned memory allocator
-.SH SYNOPSIS
-.nf
-.B char *valloc(size)
-.B unsigned size;
-.fi
-.SH DESCRIPTION
-.ft B
-Valloc is obsoleted by the current version of malloc,
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)valloc.3   6.3 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt VALLOC 3
+.Os BSD 3
+.Sh NAME
+.Nm valloc
+.Nd aligned memory allocation function
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft char *
+.Fn valloc "unsigned size"
+.Sh DESCRIPTION
+.Bf -symbolic
+Valloc is obsoleted by the current version of malloc(3),

 which aligns page-sized and larger allocations.
 which aligns page-sized and larger allocations.

-.ft R
-.PP
-.I Valloc
+.Ef
+.Pp
+The
+.Fn valloc
+function

 allocates
 allocates

-.I size
+.Fa size

 bytes aligned on a page boundary.
 It is implemented by calling
 bytes aligned on a page boundary.
 It is implemented by calling

-.IR malloc (3)
+.Xr malloc 3

 with a slightly larger request, saving the true beginning of the block
 allocated, and returning a properly aligned pointer.
 with a slightly larger request, saving the true beginning of the block
 allocated, and returning a properly aligned pointer.

-.SH DIAGNOSTICS
-.I Valloc
-returns a null pointer (0) if there is no available memory
-or if the arena has been detectably corrupted by storing outside the bounds
-of a block.
-.SH BUGS
-.I Vfree
-isn't implemented.
+.Sh RETURN VALUES
+The
+.Fn valloc
+function returns
+a pointer to the allocated space if successful; otherwise
+a null pointer is returned
+.Sh HISTORY
+The
+.Fn valloc
+function appeared in 
+.Bx 3.0 .
+.Sh BUGS
+A
+.Em vfree
+function
+has not been implemented.