1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* alloca.c -- allocate automatically reclaimed memory
4 (Mostly) portable public-domain implementation -- D A Gwyn
6 This implementation of the PWB library alloca function,
7 which is used to allocate space off the run-time stack so
8 that it is automatically reclaimed upon procedure exit,
9 was inspired by discussions with J. Q. Johnson of Cornell.
10 J.Otto Tennant <jot@cray.com> contributed the Cray support.
12 There are some preprocessor constants that can
13 be defined when compiling for your specific system, for
14 improved efficiency; however, the defaults should be okay.
16 The general concept of this implementation is to keep
17 track of all alloca-allocated blocks, and reclaim any
18 that are found to be deeper in the stack than the current
19 invocation. This heuristic does not reclaim storage as
20 soon as it becomes invalid, but it will do so eventually.
22 As a special case, alloca(0) reclaims storage without
23 allocating any. It is a good idea to use alloca(0) in
24 your main control loop, etc. to force garbage collection. */
35 # include "blockinput.h"
38 # define free EMACS_FREE
41 # define memory_full() abort ()
44 /* If compiling with GCC 2, this file's not needed. */
45 #if !defined (__GNUC__) || __GNUC__ < 2
47 /* If someone has defined alloca as a macro,
48 there must be some other way alloca is supposed to work. */
53 /* actually, only want this if static is defined as ""
54 -- this is for usg, in which emacs must undefine static
55 in order to make unexec workable
57 # ifndef STACK_DIRECTION
60 -- must know STACK_DIRECTION at compile
-time
61 /* Using #error here is not wise since this file should work for
62 old and obscure compilers. */
63 # endif /* STACK_DIRECTION undefined */
67 /* If your stack is a linked list of frames, you have to
68 provide an "address metric" ADDRESS_FUNCTION macro. */
70 # if defined (CRAY) && defined (CRAY_STACKSEG_END)
72 # define ADDRESS_FUNCTION(arg) (char *) i00afunc (&(arg))
74 # define ADDRESS_FUNCTION(arg) &(arg)
77 /* Define STACK_DIRECTION if you know the direction of stack
78 growth for your system; otherwise it will be automatically
81 STACK_DIRECTION > 0 => grows toward higher addresses
82 STACK_DIRECTION < 0 => grows toward lower addresses
83 STACK_DIRECTION = 0 => direction of growth unknown */
85 # ifndef STACK_DIRECTION
86 # define STACK_DIRECTION 0 /* Direction unknown. */
89 # if STACK_DIRECTION != 0
91 # define STACK_DIR STACK_DIRECTION /* Known at compile-time. */
93 # else /* STACK_DIRECTION == 0; need run-time code. */
95 static int stack_dir
; /* 1 or -1 once known. */
96 # define STACK_DIR stack_dir
99 find_stack_direction (char **ptr
)
101 auto char dummy
; /* To get stack address. */
104 { /* Initial entry. */
105 *ptr
= ADDRESS_FUNCTION (dummy
);
107 find_stack_direction (ptr
); /* Recurse once. */
112 if (ADDRESS_FUNCTION (dummy
) > *ptr
)
113 stack_dir
= 1; /* Stack grew upward. */
115 stack_dir
= -1; /* Stack grew downward. */
119 # endif /* STACK_DIRECTION == 0 */
121 /* An "alloca header" is used to:
122 (a) chain together all alloca'ed blocks;
123 (b) keep track of stack depth.
125 It is very important that sizeof(header) agree with malloc
126 alignment chunk size. The following default should work okay. */
129 # define ALIGN_SIZE sizeof(double)
134 char align
[ALIGN_SIZE
]; /* To force sizeof(header). */
137 union hdr
*next
; /* For chaining headers. */
138 char *deep
; /* For stack depth measure. */
142 static header
*last_alloca_header
= NULL
; /* -> last alloca header. */
144 /* Return a pointer to at least SIZE bytes of storage,
145 which will be automatically reclaimed upon exit from
146 the procedure that called alloca. Originally, this space
147 was supposed to be taken from the current stack frame of the
148 caller, but that method cannot be made to work for some
149 implementations of C, for example under Gould's UTX/32. */
154 auto char probe
; /* Probes stack depth: */
155 register char *depth
= ADDRESS_FUNCTION (probe
);
157 # if STACK_DIRECTION == 0
158 if (STACK_DIR
== 0) /* Unknown growth direction. */
160 char *addr
= NULL
; /* Address of first `dummy', once known. */
161 find_stack_direction (&addr
);
165 /* Reclaim garbage, defined as all alloca'd storage that
166 was allocated from deeper in the stack than currently. */
169 register header
*hp
; /* Traverses linked list. */
175 for (hp
= last_alloca_header
; hp
!= NULL
;)
176 if ((STACK_DIR
> 0 && hp
->h
.deep
> depth
)
177 || (STACK_DIR
< 0 && hp
->h
.deep
< depth
))
179 register header
*np
= hp
->h
.next
;
181 free (hp
); /* Collect garbage. */
183 hp
= np
; /* -> next header. */
186 break; /* Rest are not deeper. */
188 last_alloca_header
= hp
; /* -> last valid storage. */
196 return NULL
; /* No allocation required. */
198 /* Allocate combined header + user data storage. */
201 /* Address of header. */
202 register header
*new;
204 size_t combined_size
= sizeof (header
) + size
;
205 if (combined_size
< sizeof (header
))
208 new = malloc (combined_size
);
213 new->h
.next
= last_alloca_header
;
216 last_alloca_header
= new;
218 /* User storage begins just after header. */
220 return (void *) (new + 1);
224 # if defined (CRAY) && defined (CRAY_STACKSEG_END)
226 # ifdef DEBUG_I00AFUNC
233 /* Stack structures for CRAY-1, CRAY X-MP, and CRAY Y-MP */
234 struct stack_control_header
236 long shgrow
:32; /* Number of times stack has grown. */
237 long shaseg
:32; /* Size of increments to stack. */
238 long shhwm
:32; /* High water mark of stack. */
239 long shsize
:32; /* Current size of stack (all segments). */
242 /* The stack segment linkage control information occurs at
243 the high-address end of a stack segment. (The stack
244 grows from low addresses to high addresses.) The initial
245 part of the stack segment linkage control information is
246 0200 (octal) words. This provides for register storage
247 for the routine which overflows the stack. */
249 struct stack_segment_linkage
251 long ss
[0200]; /* 0200 overflow words. */
252 long sssize
:32; /* Number of words in this segment. */
253 long ssbase
:32; /* Offset to stack base. */
255 long sspseg
:32; /* Offset to linkage control of previous
258 long sstcpt
:32; /* Pointer to task common address block. */
259 long sscsnm
; /* Private control structure number for
261 long ssusr1
; /* Reserved for user. */
262 long ssusr2
; /* Reserved for user. */
263 long sstpid
; /* Process ID for pid based multi-tasking. */
264 long ssgvup
; /* Pointer to multitasking thread giveup. */
265 long sscray
[7]; /* Reserved for Cray Research. */
285 /* The following structure defines the vector of words
286 returned by the STKSTAT library routine. */
289 long now
; /* Current total stack size. */
290 long maxc
; /* Amount of contiguous space which would
291 be required to satisfy the maximum
292 stack demand to date. */
293 long high_water
; /* Stack high-water mark. */
294 long overflows
; /* Number of stack overflow ($STKOFEN) calls. */
295 long hits
; /* Number of internal buffer hits. */
296 long extends
; /* Number of block extensions. */
297 long stko_mallocs
; /* Block allocations by $STKOFEN. */
298 long underflows
; /* Number of stack underflow calls ($STKRETN). */
299 long stko_free
; /* Number of deallocations by $STKRETN. */
300 long stkm_free
; /* Number of deallocations by $STKMRET. */
301 long segments
; /* Current number of stack segments. */
302 long maxs
; /* Maximum number of stack segments so far. */
303 long pad_size
; /* Stack pad size. */
304 long current_address
; /* Current stack segment address. */
305 long current_size
; /* Current stack segment size. This
306 number is actually corrupted by STKSTAT to
307 include the fifteen word trailer area. */
308 long initial_address
; /* Address of initial segment. */
309 long initial_size
; /* Size of initial segment. */
312 /* The following structure describes the data structure which trails
313 any stack segment. I think that the description in 'asdef' is
314 out of date. I only describe the parts that I am sure about. */
318 long this_address
; /* Address of this block. */
319 long this_size
; /* Size of this block (does not include
323 long link
; /* Address of trailer block of previous
338 # endif /* not CRAY_STACK */
341 /* Determine a "stack measure" for an arbitrary ADDRESS.
342 I doubt that "lint" will like this much. */
345 i00afunc (long *address
)
347 struct stk_stat status
;
348 struct stk_trailer
*trailer
;
352 /* We want to iterate through all of the segments. The first
353 step is to get the stack status structure. We could do this
354 more quickly and more directly, perhaps, by referencing the
355 $LM00 common block, but I know that this works. */
359 /* Set up the iteration. */
361 trailer
= (struct stk_trailer
*) (status
.current_address
362 + status
.current_size
365 /* There must be at least one stack segment. Therefore it is
366 a fatal error if "trailer" is null. */
371 /* Discard segments that do not contain our argument address. */
375 block
= (long *) trailer
->this_address
;
376 size
= trailer
->this_size
;
377 if (block
== 0 || size
== 0)
379 trailer
= (struct stk_trailer
*) trailer
->link
;
380 if ((block
<= address
) && (address
< (block
+ size
)))
384 /* Set the result to the offset in this segment and add the sizes
385 of all predecessor segments. */
387 result
= address
- block
;
396 if (trailer
->this_size
<= 0)
398 result
+= trailer
->this_size
;
399 trailer
= (struct stk_trailer
*) trailer
->link
;
401 while (trailer
!= 0);
403 /* We are done. Note that if you present a bogus address (one
404 not in any segment), you will get a different number back, formed
405 from subtracting the address of the first block. This is probably
406 not what you want. */
411 # else /* not CRAY2 */
412 /* Stack address function for a CRAY-1, CRAY X-MP, or CRAY Y-MP.
413 Determine the number of the cell within the stack,
414 given the address of the cell. The purpose of this
415 routine is to linearize, in some sense, stack addresses
419 i00afunc (long address
)
423 long size
, pseg
, this_segment
, stack
;
426 struct stack_segment_linkage
*ssptr
;
428 /* Register B67 contains the address of the end of the
429 current stack segment. If you (as a subprogram) store
430 your registers on the stack and find that you are past
431 the contents of B67, you have overflowed the segment.
433 B67 also points to the stack segment linkage control
434 area, which is what we are really interested in. */
436 stkl
= CRAY_STACKSEG_END ();
437 ssptr
= (struct stack_segment_linkage
*) stkl
;
439 /* If one subtracts 'size' from the end of the segment,
440 one has the address of the first word of the segment.
442 If this is not the first segment, 'pseg' will be
445 pseg
= ssptr
->sspseg
;
446 size
= ssptr
->sssize
;
448 this_segment
= stkl
- size
;
450 /* It is possible that calling this routine itself caused
451 a stack overflow. Discard stack segments which do not
452 contain the target address. */
454 while (!(this_segment
<= address
&& address
<= stkl
))
456 # ifdef DEBUG_I00AFUNC
457 fprintf (stderr
, "%011o %011o %011o\n", this_segment
, address
, stkl
);
462 ssptr
= (struct stack_segment_linkage
*) stkl
;
463 size
= ssptr
->sssize
;
464 pseg
= ssptr
->sspseg
;
465 this_segment
= stkl
- size
;
468 result
= address
- this_segment
;
470 /* If you subtract pseg from the current end of the stack,
471 you get the address of the previous stack segment's end.
472 This seems a little convoluted to me, but I'll bet you save
473 a cycle somewhere. */
477 # ifdef DEBUG_I00AFUNC
478 fprintf (stderr
, "%011o %011o\n", pseg
, size
);
481 ssptr
= (struct stack_segment_linkage
*) stkl
;
482 size
= ssptr
->sssize
;
483 pseg
= ssptr
->sspseg
;
489 # endif /* not CRAY2 */
492 # endif /* no alloca */
493 #endif /* not GCC version 3 */