1.\" $NetBSD: alloca.3,v 1.13 2010/05/03 06:11:38 jruoho 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.\" from: @(#)alloca.3 8.1 (Berkeley) 6/4/93 31.\" 32.Dd May 3, 2010 33.Dt ALLOCA 3 34.Os 35.Sh NAME 36.Nm alloca 37.Nd memory allocator 38.Sh LIBRARY 39.Lb libc 40.Sh SYNOPSIS 41.In stdlib.h 42.Ft void * 43.Fn alloca "size_t size" 44.Sh DESCRIPTION 45The 46.Fn alloca 47function 48allocates 49.Fa size 50bytes of space in the stack frame of the caller. 51This temporary space is automatically freed on 52return. 53.Sh RETURN VALUES 54The 55.Fn alloca 56function returns a pointer to the beginning of the allocated space. 57If the allocation failed, a 58.Dv NULL 59pointer is returned. 60.Sh SEE ALSO 61.Xr brk 2 , 62.Xr calloc 3 , 63.Xr getpagesize 3 , 64.Xr malloc 3 , 65.Xr realloc 3 66.Sh CAVEATS 67Few limitations can be mentioned: 68.Bl -bullet 69.It 70The 71.Fn alloca 72function 73is machine dependent; its use is discouraged. 74.It 75The 76.Fn alloca 77function is slightly unsafe because it cannot ensure that the pointer 78returned points to a valid and usable block of memory. 79The allocation made may exceed the bounds of the stack, or even go 80further into other objects in memory, and 81.Fn alloca 82cannot determine such an error. 83Avoid 84.Fn alloca 85with large unbounded allocations. 86.It 87Since 88.Fn alloca 89modifies the stack at runtime, 90it causes problems to certain security features. 91See 92.Xr security 8 93for a discussion. 94.El 95.\" .Sh HISTORY 96.\" The 97.\" .Fn alloca 98.\" function appeared in 99.\" .Bx ?? . 100.\" The function appeared in 32v, pwb and pwb.2 and in 3bsd 4bsd 101.\" The first man page (or link to a man page that I can find at the 102.\" moment is 4.3... 103