xref: /freebsd/lib/libc/stdlib/alloca.3 (revision 6dcefcac2b043be030851e03a721607b414b666b)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)alloca.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD$
30.\"
31.Dd September 5, 2006
32.Dt ALLOCA 3
33.Os
34.Sh NAME
35.Nm alloca
36.Nd memory allocator
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In stdlib.h
41.Ft void *
42.Fn alloca "size_t size"
43.Sh DESCRIPTION
44The
45.Fn alloca
46function
47allocates
48.Fa size
49bytes of space in the stack frame of the caller.
50This temporary space is automatically freed on
51return.
52.Sh RETURN VALUES
53The
54.Fn alloca
55function returns a pointer to the beginning of the allocated space.
56.Sh SEE ALSO
57.Xr brk 2 ,
58.Xr calloc 3 ,
59.Xr getpagesize 3 ,
60.Xr malloc 3 ,
61.Xr realloc 3
62.Sh HISTORY
63The
64.Fn alloca
65function appeared in
66.At 32v .
67.\" .Bx ?? .
68.\" The function appeared in 32v, pwb and pwb.2 and in 3bsd 4bsd
69.\" The first man page (or link to a man page that I can find at the
70.\" moment is 4.3...
71.Sh BUGS
72The
73.Fn alloca
74function
75is machine and compiler dependent;
76its use is discouraged.
77.Pp
78The
79.Fn alloca
80function is slightly unsafe because it cannot ensure that the pointer
81returned points to a valid and usable block of memory.
82The allocation made may exceed the bounds of the stack, or even go
83further into other objects in memory, and
84.Fn alloca
85cannot determine such an error.
86Avoid
87.Fn alloca
88with large unbounded allocations.
89