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. */
36
# include "blockinput.h"
39
/* If compiling with GCC 2, this file's not needed. */
40
#if !defined (__GNUC__) || __GNUC__ < 2
42
/* If someone has defined alloca as a macro,
43
there must be some other way alloca is supposed to work. */
48
/* actually, only want this if static is defined as ""
49
-- this is for usg, in which emacs must undefine static
50
in order to make unexec workable
52
# ifndef STACK_DIRECTION
55
-- must know STACK_DIRECTION at compile-time
56
# endif /* STACK_DIRECTION undefined */
60
/* If your stack is a linked list of frames, you have to
61
provide an "address metric" ADDRESS_FUNCTION macro. */
63
# if defined (CRAY) && defined (CRAY_STACKSEG_END)
65
# define ADDRESS_FUNCTION(arg) (char *) i00afunc (&(arg))
67
# define ADDRESS_FUNCTION(arg) &(arg)
71
typedef void *pointer;
73
typedef char *pointer;
80
/* Different portions of Emacs need to call different versions of
81
malloc. The Emacs executable needs alloca to call xmalloc, because
82
ordinary malloc isn't protected from input signals. On the other
83
hand, the utilities in lib-src need alloca to call malloc; some of
84
them are very simple, and don't have an xmalloc routine.
86
Non-Emacs programs expect this to call xmalloc.
88
Callers below should use malloc. */
92
# define malloc xmalloc
94
extern pointer malloc ();
96
/* Define STACK_DIRECTION if you know the direction of stack
97
growth for your system; otherwise it will be automatically
100
STACK_DIRECTION > 0 => grows toward higher addresses
101
STACK_DIRECTION < 0 => grows toward lower addresses
102
STACK_DIRECTION = 0 => direction of growth unknown */
104
# ifndef STACK_DIRECTION
105
# define STACK_DIRECTION 0 /* Direction unknown. */
108
# if STACK_DIRECTION != 0
110
# define STACK_DIR STACK_DIRECTION /* Known at compile-time. */
112
# else /* STACK_DIRECTION == 0; need run-time code. */
114
static int stack_dir; /* 1 or -1 once known. */
115
# define STACK_DIR stack_dir
118
find_stack_direction ()
120
static char *addr = NULL; /* Address of first `dummy', once known. */
121
auto char dummy; /* To get stack address. */
124
{ /* Initial entry. */
125
addr = ADDRESS_FUNCTION (dummy);
127
find_stack_direction (); /* Recurse once. */
132
if (ADDRESS_FUNCTION (dummy) > addr)
133
stack_dir = 1; /* Stack grew upward. */
135
stack_dir = -1; /* Stack grew downward. */
139
# endif /* STACK_DIRECTION == 0 */
141
/* An "alloca header" is used to:
142
(a) chain together all alloca'ed blocks;
143
(b) keep track of stack depth.
145
It is very important that sizeof(header) agree with malloc
146
alignment chunk size. The following default should work okay. */
149
# define ALIGN_SIZE sizeof(double)
154
char align[ALIGN_SIZE]; /* To force sizeof(header). */
157
union hdr *next; /* For chaining headers. */
158
char *deep; /* For stack depth measure. */
162
static header *last_alloca_header = NULL; /* -> last alloca header. */
164
/* Return a pointer to at least SIZE bytes of storage,
165
which will be automatically reclaimed upon exit from
166
the procedure that called alloca. Originally, this space
167
was supposed to be taken from the current stack frame of the
168
caller, but that method cannot be made to work for some
169
implementations of C, for example under Gould's UTX/32. */
174
auto char probe; /* Probes stack depth: */
175
register char *depth = ADDRESS_FUNCTION (probe);
177
# if STACK_DIRECTION == 0
178
if (STACK_DIR == 0) /* Unknown growth direction. */
179
find_stack_direction ();
182
/* Reclaim garbage, defined as all alloca'd storage that
183
was allocated from deeper in the stack than currently. */
186
register header *hp; /* Traverses linked list. */
192
for (hp = last_alloca_header; hp != NULL;)
193
if ((STACK_DIR > 0 && hp->h.deep > depth)
194
|| (STACK_DIR < 0 && hp->h.deep < depth))
196
register header *np = hp->h.next;
198
free ((pointer) hp); /* Collect garbage. */
200
hp = np; /* -> next header. */
203
break; /* Rest are not deeper. */
205
last_alloca_header = hp; /* -> last valid storage. */
213
return NULL; /* No allocation required. */
215
/* Allocate combined header + user data storage. */
218
register pointer new = malloc (sizeof (header) + size);
219
/* Address of header. */
224
((header *) new)->h.next = last_alloca_header;
225
((header *) new)->h.deep = depth;
227
last_alloca_header = (header *) new;
229
/* User storage begins just after header. */
231
return (pointer) ((char *) new + sizeof (header));
235
# if defined (CRAY) && defined (CRAY_STACKSEG_END)
237
# ifdef DEBUG_I00AFUNC
244
/* Stack structures for CRAY-1, CRAY X-MP, and CRAY Y-MP */
245
struct stack_control_header
247
long shgrow:32; /* Number of times stack has grown. */
248
long shaseg:32; /* Size of increments to stack. */
249
long shhwm:32; /* High water mark of stack. */
250
long shsize:32; /* Current size of stack (all segments). */
253
/* The stack segment linkage control information occurs at
254
the high-address end of a stack segment. (The stack
255
grows from low addresses to high addresses.) The initial
256
part of the stack segment linkage control information is
257
0200 (octal) words. This provides for register storage
258
for the routine which overflows the stack. */
260
struct stack_segment_linkage
262
long ss[0200]; /* 0200 overflow words. */
263
long sssize:32; /* Number of words in this segment. */
264
long ssbase:32; /* Offset to stack base. */
266
long sspseg:32; /* Offset to linkage control of previous
269
long sstcpt:32; /* Pointer to task common address block. */
270
long sscsnm; /* Private control structure number for
272
long ssusr1; /* Reserved for user. */
273
long ssusr2; /* Reserved for user. */
274
long sstpid; /* Process ID for pid based multi-tasking. */
275
long ssgvup; /* Pointer to multitasking thread giveup. */
276
long sscray[7]; /* Reserved for Cray Research. */
296
/* The following structure defines the vector of words
297
returned by the STKSTAT library routine. */
300
long now; /* Current total stack size. */
301
long maxc; /* Amount of contiguous space which would
302
be required to satisfy the maximum
303
stack demand to date. */
304
long high_water; /* Stack high-water mark. */
305
long overflows; /* Number of stack overflow ($STKOFEN) calls. */
306
long hits; /* Number of internal buffer hits. */
307
long extends; /* Number of block extensions. */
308
long stko_mallocs; /* Block allocations by $STKOFEN. */
309
long underflows; /* Number of stack underflow calls ($STKRETN). */
310
long stko_free; /* Number of deallocations by $STKRETN. */
311
long stkm_free; /* Number of deallocations by $STKMRET. */
312
long segments; /* Current number of stack segments. */
313
long maxs; /* Maximum number of stack segments so far. */
314
long pad_size; /* Stack pad size. */
315
long current_address; /* Current stack segment address. */
316
long current_size; /* Current stack segment size. This
317
number is actually corrupted by STKSTAT to
318
include the fifteen word trailer area. */
319
long initial_address; /* Address of initial segment. */
320
long initial_size; /* Size of initial segment. */
323
/* The following structure describes the data structure which trails
324
any stack segment. I think that the description in 'asdef' is
325
out of date. I only describe the parts that I am sure about. */
329
long this_address; /* Address of this block. */
330
long this_size; /* Size of this block (does not include
334
long link; /* Address of trailer block of previous
349
# endif /* not CRAY_STACK */
352
/* Determine a "stack measure" for an arbitrary ADDRESS.
353
I doubt that "lint" will like this much. */
356
i00afunc (long *address)
358
struct stk_stat status;
359
struct stk_trailer *trailer;
363
/* We want to iterate through all of the segments. The first
364
step is to get the stack status structure. We could do this
365
more quickly and more directly, perhaps, by referencing the
366
$LM00 common block, but I know that this works. */
370
/* Set up the iteration. */
372
trailer = (struct stk_trailer *) (status.current_address
373
+ status.current_size
376
/* There must be at least one stack segment. Therefore it is
377
a fatal error if "trailer" is null. */
382
/* Discard segments that do not contain our argument address. */
386
block = (long *) trailer->this_address;
387
size = trailer->this_size;
388
if (block == 0 || size == 0)
390
trailer = (struct stk_trailer *) trailer->link;
391
if ((block <= address) && (address < (block + size)))
395
/* Set the result to the offset in this segment and add the sizes
396
of all predecessor segments. */
398
result = address - block;
407
if (trailer->this_size <= 0)
409
result += trailer->this_size;
410
trailer = (struct stk_trailer *) trailer->link;
412
while (trailer != 0);
414
/* We are done. Note that if you present a bogus address (one
415
not in any segment), you will get a different number back, formed
416
from subtracting the address of the first block. This is probably
417
not what you want. */
422
# else /* not CRAY2 */
423
/* Stack address function for a CRAY-1, CRAY X-MP, or CRAY Y-MP.
424
Determine the number of the cell within the stack,
425
given the address of the cell. The purpose of this
426
routine is to linearize, in some sense, stack addresses
430
i00afunc (long address)
434
long size, pseg, this_segment, stack;
437
struct stack_segment_linkage *ssptr;
439
/* Register B67 contains the address of the end of the
440
current stack segment. If you (as a subprogram) store
441
your registers on the stack and find that you are past
442
the contents of B67, you have overflowed the segment.
444
B67 also points to the stack segment linkage control
445
area, which is what we are really interested in. */
447
stkl = CRAY_STACKSEG_END ();
448
ssptr = (struct stack_segment_linkage *) stkl;
450
/* If one subtracts 'size' from the end of the segment,
451
one has the address of the first word of the segment.
453
If this is not the first segment, 'pseg' will be
456
pseg = ssptr->sspseg;
457
size = ssptr->sssize;
459
this_segment = stkl - size;
461
/* It is possible that calling this routine itself caused
462
a stack overflow. Discard stack segments which do not
463
contain the target address. */
465
while (!(this_segment <= address && address <= stkl))
467
# ifdef DEBUG_I00AFUNC
468
fprintf (stderr, "%011o %011o %011o\n", this_segment, address, stkl);
473
ssptr = (struct stack_segment_linkage *) stkl;
474
size = ssptr->sssize;
475
pseg = ssptr->sspseg;
476
this_segment = stkl - size;
479
result = address - this_segment;
481
/* If you subtract pseg from the current end of the stack,
482
you get the address of the previous stack segment's end.
483
This seems a little convoluted to me, but I'll bet you save
484
a cycle somewhere. */
488
# ifdef DEBUG_I00AFUNC
489
fprintf (stderr, "%011o %011o\n", pseg, size);
492
ssptr = (struct stack_segment_linkage *) stkl;
493
size = ssptr->sssize;
494
pseg = ssptr->sspseg;
500
# endif /* not CRAY2 */
503
# endif /* no alloca */
504
#endif /* not GCC version 2 */
added
removed
src/alloca.c
