xref: /netbsd-src/lib/libc/stdlib/alloca.3 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1.\"	$NetBSD: alloca.3,v 1.4 1997/07/15 07:03:25 mikel Exp $
2.\"
3.\" Copyright (c) 1980, 1991 Regents of the University of California.
4.\" 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.\"     from: @(#)alloca.3	5.1 (Berkeley) 5/2/91
35.\"
36.Dd May 2, 1991
37.Dt ALLOCA 3
38.Os BSD 4
39.Sh NAME
40.Nm alloca
41.Nd memory allocator
42.Sh SYNOPSIS
43.Fd #include <stdlib.h>
44.Ft void *
45.Fn alloca "size_t size"
46.Sh DESCRIPTION
47The
48.Fn alloca
49function
50allocates
51.Fa size
52bytes of space in the stack frame of the caller.
53This temporary space is automatically freed on
54return.
55.Sh RETURN VALUES
56The
57.Fn alloca
58function returns a pointer to the beginning of the allocated space.
59If the allocation failed, a
60.Dv NULL
61pointer is returned.
62.Sh SEE ALSO
63.Xr brk 2 ,
64.Xr calloc 3 ,
65.Xr getpagesize 3 ,
66.Xr malloc 3 ,
67.Xr realloc 3
68.Sh BUGS
69The
70.Fn alloca
71function
72is machine dependent; its use is discouraged.
73.\" .Sh HISTORY
74.\" The
75.\" .Fn alloca
76.\" function appeared in
77.\" .Bx ?? .
78.\" The function appeared in 32v, pwb and pwb.2 and in 3bsd 4bsd
79.\" The first man page (or link to a man page that I can find at the
80.\" moment is 4.3...
81