lib/libc/alloca.3

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" 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 .\"     $OpenBSD: alloca.3,v 1.14 2015/01/17 18:01:43 tedu Exp $
  29 .\"
  30 .Dd $Mdocdate: January 17 2015 $
  31 .Dt ALLOCA 3
  32 .Os
  33 .Sh NAME
  34 .Nm alloca
  35 .Nd memory allocator
  36 .Sh SYNOPSIS
  37 .In stdlib.h
  38 .Ft void *
  39 .Fn alloca "size_t size"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn alloca
  43 function allocates
  44 .Fa size
  45 bytes of space in the stack frame of the caller.
  46 This temporary space is automatically freed on return.
  47 .Sh RETURN VALUES
  48 The
  49 .Fn alloca
  50 function returns a pointer to the beginning of the allocated space.
  51 .Sh SEE ALSO
  52 .Xr pagesize 1 ,
  53 .Xr brk 2 ,
  54 .Xr malloc 3
  55 .\" .Sh HISTORY
  56 .\" The
  57 .\" .Fn alloca
  58 .\" function appeared in
  59 .\" .Bx ?? .
  60 .\" The function appeared in 32v, pwb and pwb.2 and in 3bsd 4bsd
  61 .\" The first man page (or link to a man page that I can find at the
  62 .\" moment is 4.3...
  63 .Sh CAVEATS
  64 The
  65 .Fn alloca
  66 function is unsafe because it cannot ensure that the pointer
  67 returned points to a valid and usable block of memory.
  68 The allocation made may exceed the bounds of the stack, or even go
  69 further into other objects in memory, and
  70 .Fn alloca
  71 cannot determine such an error.
  72 Avoid
  73 .Fn alloca
  74 with large unbounded allocations.