original/man3/alloca.3

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)alloca.3    5.1 (Berkeley) 5/2/91
  35 .\"
  36 .\" Converted Mon Nov 29 11:05:55 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified Tue Oct 22 23:41:56 1996 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 2002-07-17, aeb
  39 .\" 2008-01-24, mtk:
  40 .\"     Various rewrites and additions (notes on longjmp() and SIGSEGV).
  41 .\"     Weaken warning against use of alloca() (as per Debian bug 461100).
  42 .\"
  43 .TH ALLOCA 3 2008-01-24 "GNU" "Linux Programmer's Manual"
  44 .SH NAME
  45 alloca \- allocate memory that is automatically freed
  46 .SH SYNOPSIS
  47 .B #include <alloca.h>
  48 .sp
  49 .BI "void *alloca(size_t " size );
  50 .SH DESCRIPTION
  51 The
  52 .BR alloca ()
  53 function allocates
  54 .I size
  55 bytes of space in the stack frame of the caller.
  56 This temporary space is
  57 automatically freed when the function that called
  58 .BR alloca ()
  59 returns to its caller.
  60 .SH RETURN VALUE
  61 The
  62 .BR alloca ()
  63 function returns a pointer to the beginning of the allocated space.
  64 If the allocation causes stack overflow, program behavior is undefined.
  65 .SH CONFORMING TO
  66 This function is not in POSIX.1-2001.
  67
  68 There is evidence that the
  69 .BR alloca ()
  70 function appeared in 32V, PWB, PWB.2, 3BSD, and 4BSD.
  71 There is a man page for it in 4.3BSD.
  72 Linux uses the GNU version.
  73 .SH NOTES
  74 The
  75 .BR alloca ()
  76 function is machine- and compiler-dependent.
  77 For certain applications,
  78 its use can improve efficiency compared to the use of
  79 .BR malloc (3)
  80 plus
  81 .BR free (3).
  82 In certain cases,
  83 it can also simplify memory deallocation in applications that use
  84 .BR longjmp (3)
  85 or
  86 .BR siglongjmp (3).
  87 Otherwise, its use is discouraged.
  88
  89 Because the space allocated by
  90 .BR alloca ()
  91 is allocated within the stack frame,
  92 that space is automatically freed if the function return
  93 is jumped over by a call to
  94 .BR longjmp (3)
  95 or
  96 .BR siglongjmp (3).
  97
  98 Do not attempt to
  99 .BR free (3)
 100 space allocated by
 101 .BR alloca ()!
 102 .SS Notes on the GNU version
 103 Normally,
 104 .BR gcc (1)
 105 translates calls to
 106 .BR alloca ()
 107 with inlined code.
 108 This is not done when either the
 109 .IR "\-ansi" ,
 110 .IR "\-std=c89" ,
 111 .IR "\-std=c99" ,
 112 or the
 113 .IR "\-fno\-builtin"
 114 option is given
 115 (and the header
 116 .I <alloca.h>
 117 is not included).
 118 But beware!
 119 By default the glibc version of
 120 .I <stdlib.h>
 121 includes
 122 .I <alloca.h>
 123 and that contains the line:
 124 .nf
 125
 126     #define alloca(size)   __builtin_alloca (size)
 127
 128 .fi
 129 with messy consequences if one has a private version of this function.
 130 .LP
 131 The fact that the code is inlined means that it is impossible
 132 to take the address of this function, or to change its behavior
 133 by linking with a different library.
 134 .LP
 135 The inlined code often consists of a single instruction adjusting
 136 the stack pointer, and does not check for stack overflow.
 137 Thus, there is no NULL error return.
 138 .SH BUGS
 139 There is no error indication if the stack frame cannot be extended.
 140 (However, after a failed allocation, the program is likely to receive a
 141 .B SIGSEGV
 142 signal if it attempts to access the unallocated space.)
 143
 144 On many systems
 145 .BR alloca ()
 146 cannot be used inside the list of arguments of a function call, because
 147 the stack space reserved by
 148 .BR alloca ()
 149 would appear on the stack in the middle of the space for the
 150 function arguments.
 151 .SH SEE ALSO
 152 .BR brk (2),
 153 .BR longjmp (3),
 154 .BR malloc (3)