projects / apple / libc.git / blame
| Commit | Line | Data |
|---|---|---|
| 5b2abdfb | 1 | .\" Copyright (c) 1980, 1991, 1993 |
| e9ce8d39 A |
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 | .\" | |
| 5b2abdfb | 32 | .\" @(#)alloca.3 8.1 (Berkeley) 6/4/93 |
| 3d9156a7 | 33 | .\" $FreeBSD: src/lib/libc/stdlib/alloca.3,v 1.11 2003/06/28 22:12:30 ru Exp $ |
| e9ce8d39 | 34 | .\" |
| 5b2abdfb A |
35 | .Dd June 4, 1993 |
| 36 | .Dt ALLOCA 3 | |
| e9ce8d39 A |
37 | .Os |
| 38 | .Sh NAME | |
| 5b2abdfb A |
39 | .Nm alloca |
| 40 | .Nd memory allocator | |
| e9ce8d39 A |
41 | .Sh LIBRARY |
| 42 | .Lb libc | |
| 43 | .Sh SYNOPSIS | |
| 5b2abdfb A |
44 | .In stdlib.h |
| 45 | .Ft void * | |
| 46 | .Fn alloca "size_t size" | |
| e9ce8d39 A |
47 | .Sh DESCRIPTION |
| 48 | The | |
| 5b2abdfb A |
49 | .Fn alloca |
| 50 | function | |
| 51 | allocates | |
| 52 | .Fa size | |
| 53 | bytes of space in the stack frame of the caller. | |
| 54 | This temporary space is automatically freed on | |
| 55 | return. | |
| e9ce8d39 | 56 | .Sh RETURN VALUES |
| 5b2abdfb A |
57 | The |
| 58 | .Fn alloca | |
| 59 | function returns a pointer to the beginning of the allocated space. | |
| 60 | If the allocation failed, a | |
| 61 | .Dv NULL | |
| 62 | pointer is returned. | |
| e9ce8d39 | 63 | .Sh SEE ALSO |
| 5b2abdfb A |
64 | .Xr brk 2 , |
| 65 | .Xr calloc 3 , | |
| 66 | .Xr getpagesize 3 , | |
| 67 | .Xr malloc 3 , | |
| 68 | .Xr realloc 3 | |
| 3d9156a7 | 69 | .Sh HISTORY |
| e9ce8d39 | 70 | The |
| 5b2abdfb | 71 | .Fn alloca |
| 3d9156a7 A |
72 | function appeared in |
| 73 | .At 32v . | |
| 5b2abdfb A |
74 | .\" .Bx ?? . |
| 75 | .\" The function appeared in 32v, pwb and pwb.2 and in 3bsd 4bsd | |
| 76 | .\" The first man page (or link to a man page that I can find at the | |
| 77 | .\" moment is 4.3... | |
| 3d9156a7 A |
78 | .Sh BUGS |
| 79 | The | |
| 80 | .Fn alloca | |
| 81 | function | |
| 82 | is machine and compiler dependent; | |
| 83 | its use is discouraged. |