lib/libc/stdlib/alloca.3

   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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)alloca.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/stdlib/alloca.3,v 1.4.2.4 2001/12/14 18:33:58 ru Exp $
  34 .\" $DragonFly: src/lib/libc/stdlib/alloca.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt ALLOCA 3
  38 .Os
  39 .Sh NAME
  40 .Nm alloca
  41 .Nd memory allocator
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdlib.h
  46 .Ft void *
  47 .Fn alloca "size_t size"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn alloca
  51 function
  52 allocates
  53 .Fa size
  54 bytes of space in the stack frame of the caller.
  55 This temporary space is automatically freed on
  56 return.
  57 .Sh RETURN VALUES
  58 The
  59 .Fn alloca
  60 function returns a pointer to the beginning of the allocated space.
  61 If the allocation failed, a
  62 .Dv NULL
  63 pointer is returned.
  64 .Sh SEE ALSO
  65 .Xr brk 2 ,
  66 .Xr calloc 3 ,
  67 .Xr getpagesize 3 ,
  68 .Xr malloc 3 ,
  69 .Xr realloc 3
  70 .Sh BUGS
  71 The
  72 .Fn alloca
  73 function
  74 is machine dependent; its use is discouraged.
  75 .\" .Sh HISTORY
  76 .\" The
  77 .\" .Fn alloca
  78 .\" function appeared in
  79 .\" .Bx ?? .
  80 .\" The function appeared in 32v, pwb and pwb.2 and in 3bsd 4bsd
  81 .\" The first man page (or link to a man page that I can find at the
  82 .\" moment is 4.3...