1
/* alloca.c -- allocate automatically reclaimed memory
2
(Mostly) portable public-domain implementation -- D A Gwyn
4
This implementation of the PWB library alloca function,
5
which is used to allocate space off the run-time stack so
6
that it is automatically reclaimed upon procedure exit,
7
was inspired by discussions with J. Q. Johnson of Cornell.
8
J.Otto Tennant <jot@cray.com> contributed the Cray support.
10
There are some preprocessor constants that can
11
be defined when compiling for your specific system, for
12
improved efficiency; however, the defaults should be okay.
14
The general concept of this implementation is to keep
15
track of all alloca-allocated blocks, and reclaim any
16
that are found to be deeper in the stack than the current
17
invocation. This heuristic does not reclaim storage as
18
soon as it becomes invalid, but it will do so eventually.
20
As a special case, alloca(0) reclaims storage without
21
allocating any. It is a good idea to use alloca(0) in
22
your main control loop, etc. to force garbage collection. */
33
# include "blockinput.h"
36
# define free EMACS_FREE
39
# define memory_full() abort ()
42
/* If compiling with GCC 2, this file's not needed. */
43
#if !defined (__GNUC__) || __GNUC__ < 2
45
/* If someone has defined alloca as a macro,
46
there must be some other way alloca is supposed to work. */
51
/* actually, only want this if static is defined as ""
52
-- this is for usg, in which emacs must undefine static
53
in order to make unexec workable
55
# ifndef STACK_DIRECTION
58
-- must know STACK_DIRECTION at compile-time
59
/* Using #error here is not wise since this file should work for
60
old and obscure compilers. */
61
# endif /* STACK_DIRECTION undefined */
65
/* If your stack is a linked list of frames, you have to
66
provide an "address metric" ADDRESS_FUNCTION macro. */
68
# if defined (CRAY) && defined (CRAY_STACKSEG_END)
70
# define ADDRESS_FUNCTION(arg) (char *) i00afunc (&(arg))
72
# define ADDRESS_FUNCTION(arg) &(arg)
75
/* Define STACK_DIRECTION if you know the direction of stack
76
growth for your system; otherwise it will be automatically
79
STACK_DIRECTION > 0 => grows toward higher addresses
80
STACK_DIRECTION < 0 => grows toward lower addresses
81
STACK_DIRECTION = 0 => direction of growth unknown */
83
# ifndef STACK_DIRECTION
84
# define STACK_DIRECTION 0 /* Direction unknown. */
87
# if STACK_DIRECTION != 0
89
# define STACK_DIR STACK_DIRECTION /* Known at compile-time. */
91
# else /* STACK_DIRECTION == 0; need run-time code. */
93
static int stack_dir; /* 1 or -1 once known. */
94
# define STACK_DIR stack_dir
97
find_stack_direction (void)
99
static char *addr = NULL; /* Address of first `dummy', once known. */
100
auto char dummy; /* To get stack address. */
103
{ /* Initial entry. */
104
addr = ADDRESS_FUNCTION (dummy);
106
find_stack_direction (); /* Recurse once. */
111
if (ADDRESS_FUNCTION (dummy) > addr)
112
stack_dir = 1; /* Stack grew upward. */
114
stack_dir = -1; /* Stack grew downward. */
118
# endif /* STACK_DIRECTION == 0 */
120
/* An "alloca header" is used to:
121
(a) chain together all alloca'ed blocks;
122
(b) keep track of stack depth.
124
It is very important that sizeof(header) agree with malloc
125
alignment chunk size. The following default should work okay. */
128
# define ALIGN_SIZE sizeof(double)
133
char align[ALIGN_SIZE]; /* To force sizeof(header). */
136
union hdr *next; /* For chaining headers. */
137
char *deep; /* For stack depth measure. */
141
static header *last_alloca_header = NULL; /* -> last alloca header. */
143
/* Return a pointer to at least SIZE bytes of storage,
144
which will be automatically reclaimed upon exit from
145
the procedure that called alloca. Originally, this space
146
was supposed to be taken from the current stack frame of the
147
caller, but that method cannot be made to work for some
148
implementations of C, for example under Gould's UTX/32. */
153
auto char probe; /* Probes stack depth: */
154
register char *depth = ADDRESS_FUNCTION (probe);
156
# if STACK_DIRECTION == 0
157
if (STACK_DIR == 0) /* Unknown growth direction. */
158
find_stack_direction ();
161
/* Reclaim garbage, defined as all alloca'd storage that
162
was allocated from deeper in the stack than currently. */
165
register header *hp; /* Traverses linked list. */
171
for (hp = last_alloca_header; hp != NULL;)
172
if ((STACK_DIR > 0 && hp->h.deep > depth)
173
|| (STACK_DIR < 0 && hp->h.deep < depth))
175
register header *np = hp->h.next;
177
free (hp); /* Collect garbage. */
179
hp = np; /* -> next header. */
182
break; /* Rest are not deeper. */
184
last_alloca_header = hp; /* -> last valid storage. */
192
return NULL; /* No allocation required. */
194
/* Allocate combined header + user data storage. */
197
/* Address of header. */
198
register header *new;
200
size_t combined_size = sizeof (header) + size;
201
if (combined_size < sizeof (header))
204
new = malloc (combined_size);
209
new->h.next = last_alloca_header;
212
last_alloca_header = new;
214
/* User storage begins just after header. */
216
return (void *) (new + 1);
220
# if defined (CRAY) && defined (CRAY_STACKSEG_END)
222
# ifdef DEBUG_I00AFUNC
229
/* Stack structures for CRAY-1, CRAY X-MP, and CRAY Y-MP */
230
struct stack_control_header
232
long shgrow:32; /* Number of times stack has grown. */
233
long shaseg:32; /* Size of increments to stack. */
234
long shhwm:32; /* High water mark of stack. */
235
long shsize:32; /* Current size of stack (all segments). */
238
/* The stack segment linkage control information occurs at
239
the high-address end of a stack segment. (The stack
240
grows from low addresses to high addresses.) The initial
241
part of the stack segment linkage control information is
242
0200 (octal) words. This provides for register storage
243
for the routine which overflows the stack. */
245
struct stack_segment_linkage
247
long ss[0200]; /* 0200 overflow words. */
248
long sssize:32; /* Number of words in this segment. */
249
long ssbase:32; /* Offset to stack base. */
251
long sspseg:32; /* Offset to linkage control of previous
254
long sstcpt:32; /* Pointer to task common address block. */
255
long sscsnm; /* Private control structure number for
257
long ssusr1; /* Reserved for user. */
258
long ssusr2; /* Reserved for user. */
259
long sstpid; /* Process ID for pid based multi-tasking. */
260
long ssgvup; /* Pointer to multitasking thread giveup. */
261
long sscray[7]; /* Reserved for Cray Research. */
281
/* The following structure defines the vector of words
282
returned by the STKSTAT library routine. */
285
long now; /* Current total stack size. */
286
long maxc; /* Amount of contiguous space which would
287
be required to satisfy the maximum
288
stack demand to date. */
289
long high_water; /* Stack high-water mark. */
290
long overflows; /* Number of stack overflow ($STKOFEN) calls. */
291
long hits; /* Number of internal buffer hits. */
292
long extends; /* Number of block extensions. */
293
long stko_mallocs; /* Block allocations by $STKOFEN. */
294
long underflows; /* Number of stack underflow calls ($STKRETN). */
295
long stko_free; /* Number of deallocations by $STKRETN. */
296
long stkm_free; /* Number of deallocations by $STKMRET. */
297
long segments; /* Current number of stack segments. */
298
long maxs; /* Maximum number of stack segments so far. */
299
long pad_size; /* Stack pad size. */
300
long current_address; /* Current stack segment address. */
301
long current_size; /* Current stack segment size. This
302
number is actually corrupted by STKSTAT to
303
include the fifteen word trailer area. */
304
long initial_address; /* Address of initial segment. */
305
long initial_size; /* Size of initial segment. */
308
/* The following structure describes the data structure which trails
309
any stack segment. I think that the description in 'asdef' is
310
out of date. I only describe the parts that I am sure about. */
314
long this_address; /* Address of this block. */
315
long this_size; /* Size of this block (does not include
319
long link; /* Address of trailer block of previous
334
# endif /* not CRAY_STACK */
337
/* Determine a "stack measure" for an arbitrary ADDRESS.
338
I doubt that "lint" will like this much. */
341
i00afunc (long *address)
343
struct stk_stat status;
344
struct stk_trailer *trailer;
348
/* We want to iterate through all of the segments. The first
349
step is to get the stack status structure. We could do this
350
more quickly and more directly, perhaps, by referencing the
351
$LM00 common block, but I know that this works. */
355
/* Set up the iteration. */
357
trailer = (struct stk_trailer *) (status.current_address
358
+ status.current_size
361
/* There must be at least one stack segment. Therefore it is
362
a fatal error if "trailer" is null. */
367
/* Discard segments that do not contain our argument address. */
371
block = (long *) trailer->this_address;
372
size = trailer->this_size;
373
if (block == 0 || size == 0)
375
trailer = (struct stk_trailer *) trailer->link;
376
if ((block <= address) && (address < (block + size)))
380
/* Set the result to the offset in this segment and add the sizes
381
of all predecessor segments. */
383
result = address - block;
392
if (trailer->this_size <= 0)
394
result += trailer->this_size;
395
trailer = (struct stk_trailer *) trailer->link;
397
while (trailer != 0);
399
/* We are done. Note that if you present a bogus address (one
400
not in any segment), you will get a different number back, formed
401
from subtracting the address of the first block. This is probably
402
not what you want. */
407
# else /* not CRAY2 */
408
/* Stack address function for a CRAY-1, CRAY X-MP, or CRAY Y-MP.
409
Determine the number of the cell within the stack,
410
given the address of the cell. The purpose of this
411
routine is to linearize, in some sense, stack addresses
415
i00afunc (long address)
419
long size, pseg, this_segment, stack;
422
struct stack_segment_linkage *ssptr;
424
/* Register B67 contains the address of the end of the
425
current stack segment. If you (as a subprogram) store
426
your registers on the stack and find that you are past
427
the contents of B67, you have overflowed the segment.
429
B67 also points to the stack segment linkage control
430
area, which is what we are really interested in. */
432
stkl = CRAY_STACKSEG_END ();
433
ssptr = (struct stack_segment_linkage *) stkl;
435
/* If one subtracts 'size' from the end of the segment,
436
one has the address of the first word of the segment.
438
If this is not the first segment, 'pseg' will be
441
pseg = ssptr->sspseg;
442
size = ssptr->sssize;
444
this_segment = stkl - size;
446
/* It is possible that calling this routine itself caused
447
a stack overflow. Discard stack segments which do not
448
contain the target address. */
450
while (!(this_segment <= address && address <= stkl))
452
# ifdef DEBUG_I00AFUNC
453
fprintf (stderr, "%011o %011o %011o\n", this_segment, address, stkl);
458
ssptr = (struct stack_segment_linkage *) stkl;
459
size = ssptr->sssize;
460
pseg = ssptr->sspseg;
461
this_segment = stkl - size;
464
result = address - this_segment;
466
/* If you subtract pseg from the current end of the stack,
467
you get the address of the previous stack segment's end.
468
This seems a little convoluted to me, but I'll bet you save
469
a cycle somewhere. */
473
# ifdef DEBUG_I00AFUNC
474
fprintf (stderr, "%011o %011o\n", pseg, size);
477
ssptr = (struct stack_segment_linkage *) stkl;
478
size = ssptr->sssize;
479
pseg = ssptr->sspseg;
485
# endif /* not CRAY2 */
488
# endif /* no alloca */
489
#endif /* not GCC version 2 */
added
removed
win32/alloca.c
