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 2013-10-07 "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 ATTRIBUTES
  66 .SS Multithreading (see pthreads(7))
  67 The
  68 .BR alloca ()
  69 function is thread-safe.
  70 .SH CONFORMING TO
  71 This function is not in POSIX.1-2001.
  72
  73 There is evidence that the
  74 .BR alloca ()
  75 function appeared in 32V, PWB, PWB.2, 3BSD, and 4BSD.
  76 There is a man page for it in 4.3BSD.
  77 Linux uses the GNU version.
  78 .SH NOTES
  79 The
  80 .BR alloca ()
  81 function is machine- and compiler-dependent.
  82 For certain applications,
  83 its use can improve efficiency compared to the use of
  84 .BR malloc (3)
  85 plus
  86 .BR free (3).
  87 In certain cases,
  88 it can also simplify memory deallocation in applications that use
  89 .BR longjmp (3)
  90 or
  91 .BR siglongjmp (3).
  92 Otherwise, its use is discouraged.
  93
  94 Because the space allocated by
  95 .BR alloca ()
  96 is allocated within the stack frame,
  97 that space is automatically freed if the function return
  98 is jumped over by a call to
  99 .BR longjmp (3)
 100 or
 101 .BR siglongjmp (3).
 102
 103 Do not attempt to
 104 .BR free (3)
 105 space allocated by
 106 .BR alloca ()!
 107 .SS Notes on the GNU version
 108 Normally,
 109 .BR gcc (1)
 110 translates calls to
 111 .BR alloca ()
 112 with inlined code.
 113 This is not done when either the
 114 .IR "\-ansi" ,
 115 .IR "\-std=c89" ,
 116 .IR "\-std=c99" ,
 117 or the
 118 .IR "\-std=c11"
 119 option is given
 120 .BR and
 121 the header
 122 .I <alloca.h>
 123 is not included.
 124 Otherwise, (without an \-ansi or \-std=c* option) the glibc version of
 125 .I <stdlib.h>
 126 includes
 127 .I <alloca.h>
 128 and that contains the lines:
 129 .nf
 130
 131     #ifdef  __GNUC__
 132     #define alloca(size)   __builtin_alloca (size)
 133     #endif
 134
 135 .fi
 136 with messy consequences if one has a private version of this function.
 137 .LP
 138 The fact that the code is inlined means that it is impossible
 139 to take the address of this function, or to change its behavior
 140 by linking with a different library.
 141 .LP
 142 The inlined code often consists of a single instruction adjusting
 143 the stack pointer, and does not check for stack overflow.
 144 Thus, there is no NULL error return.
 145 .SH BUGS
 146 There is no error indication if the stack frame cannot be extended.
 147 (However, after a failed allocation, the program is likely to receive a
 148 .B SIGSEGV
 149 signal if it attempts to access the unallocated space.)
 150
 151 On many systems
 152 .BR alloca ()
 153 cannot be used inside the list of arguments of a function call, because
 154 the stack space reserved by
 155 .BR alloca ()
 156 would appear on the stack in the middle of the space for the
 157 function arguments.
 158 .SH SEE ALSO
 159 .BR brk (2),
 160 .BR longjmp (3),
 161 .BR malloc (3)
 162 .SH COLOPHON
 163 This page is part of release 3.68 of the Linux
 164 .I man-pages
 165 project.
 166 A description of the project,
 167 information about reporting bugs,
 168 and the latest version of this page,
 169 can be found at
 170 \%http://www.kernel.org/doc/man\-pages/.