Main Page User Manual Library Reference FAQ Alphabetical Index Example Projects

alloca.h
1 /* Copyright (c) 2007, Dmitry Xmelkov
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 are met:
6 
7  * Redistributions of source code must retain the above copyright
8  notice, this list of conditions and the following disclaimer.
9  * Redistributions in binary form must reproduce the above copyright
10  notice, this list of conditions and the following disclaimer in
11  the documentation and/or other materials provided with the
12  distribution.
13  * Neither the name of the copyright holders nor the names of
14  contributors may be used to endorse or promote products derived
15  from this software without specific prior written permission.
16 
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  POSSIBILITY OF SUCH DAMAGE. */
28 
29 /* $Id: alloca.h 1508 2007-12-18 13:36:50Z dmix $ */
30 
31 #ifndef _ALLOCA_H
32 #define _ALLOCA_H 1
33 
34 #include <stddef.h>
35 
36 /** \defgroup alloca <alloca.h>: Allocate space in the stack */
37 
38 /** \ingroup alloca
39  \brief Allocate \a __size bytes of space in the stack frame of the caller.
40 
41  This temporary space is automatically freed when the function that
42  called alloca() returns to its caller. Avr-libc defines the alloca() as
43  a macro, which is translated into the inlined \c __builtin_alloca()
44  function. The fact that the code is inlined, means that it is impossible
45  to take the address of this function, or to change its behaviour by
46  linking with a different library.
47 
48  \return alloca() returns a pointer to the beginning of the allocated
49  space. If the allocation causes stack overflow, program behaviour is
50  undefined.
51 
52  \warning Avoid use alloca() inside the list of arguments of a function
53  call.
54  */
55 extern void *alloca (size_t __size);
56 
57 #define alloca(size) __builtin_alloca (size)
58 
59 #endif /* alloca.h */
void * alloca(size_t __size)
Allocate __size bytes of space in the stack frame of the caller.

Automatically generated by Doxygen 1.8.7 on Tue Jul 8 2014. Dash Docset conversion by Matt Kane