gcc/alloca.c

   1 /* alloca.c -- allocate automatically reclaimed memory
   2    (Mostly) portable public-domain implementation -- D A Gwyn
   3
   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.
   9
  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.
  13
  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.
  19
  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.  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #ifdef HAVE_STRING_H
  29 #include <string.h>
  30 #endif
  31 #ifdef HAVE_STDLIB_H
  32 #include <stdlib.h>
  33 #endif
  34
  35 #ifdef emacs
  36 #include "blockinput.h"
  37 #endif
  38
  39 /* If compiling with GCC 2, this file's not needed.  */
  40 #if !defined (__GNUC__) || __GNUC__ < 2
  41
  42 /* If someone has defined alloca as a macro,
  43    there must be some other way alloca is supposed to work.  */
  44 #ifndef alloca
  45
  46 #ifdef emacs
  47 #ifdef static
  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
  51    */
  52 #ifndef STACK_DIRECTION
  53 you
  54 lose
  55 -- must know STACK_DIRECTION at compile-time
  56 #endif /* STACK_DIRECTION undefined */
  57 #endif /* static */
  58 #endif /* emacs */
  59
  60 /* If your stack is a linked list of frames, you have to
  61    provide an "address metric" ADDRESS_FUNCTION macro.  */
  62
  63 #if defined (CRAY) && defined (CRAY_STACKSEG_END)
  64 long i00afunc ();
  65 #define ADDRESS_FUNCTION(arg) (char *) i00afunc (&(arg))
  66 #else
  67 #define ADDRESS_FUNCTION(arg) &(arg)
  68 #endif
  69
  70 #if __STDC__
  71 typedef void *pointer;
  72 #else
  73 typedef char *pointer;
  74 #endif
  75
  76 #define NULL    0
  77
  78 /* Different portions of Emacs need to call different versions of
  79    malloc.  The Emacs executable needs alloca to call xmalloc, because
  80    ordinary malloc isn't protected from input signals.  On the other
  81    hand, the utilities in lib-src need alloca to call malloc; some of
  82    them are very simple, and don't have an xmalloc routine.
  83
  84    Non-Emacs programs expect this to call use xmalloc.
  85
  86    Callers below should use malloc.  */
  87
  88 #ifndef emacs
  89 #define malloc xmalloc
  90 #endif
  91 extern pointer malloc ();
  92
  93 /* Define STACK_DIRECTION if you know the direction of stack
  94    growth for your system; otherwise it will be automatically
  95    deduced at run-time.
  96
  97    STACK_DIRECTION > 0 => grows toward higher addresses
  98    STACK_DIRECTION < 0 => grows toward lower addresses
  99    STACK_DIRECTION = 0 => direction of growth unknown  */
 100
 101 #ifndef STACK_DIRECTION
 102 #define STACK_DIRECTION 0       /* Direction unknown.  */
 103 #endif
 104
 105 #if STACK_DIRECTION != 0
 106
 107 #define STACK_DIR       STACK_DIRECTION /* Known at compile-time.  */
 108
 109 #else /* STACK_DIRECTION == 0; need run-time code.  */
 110
 111 static int stack_dir;           /* 1 or -1 once known.  */
 112 #define STACK_DIR       stack_dir
 113
 114 static void
 115 find_stack_direction ()
 116 {
 117   static char *addr = NULL;     /* Address of first `dummy', once known.  */
 118   auto char dummy;              /* To get stack address.  */
 119
 120   if (addr == NULL)
 121     {                           /* Initial entry.  */
 122       addr = ADDRESS_FUNCTION (dummy);
 123
 124       find_stack_direction ();  /* Recurse once.  */
 125     }
 126   else
 127     {
 128       /* Second entry.  */
 129       if (ADDRESS_FUNCTION (dummy) > addr)
 130         stack_dir = 1;          /* Stack grew upward.  */
 131       else
 132         stack_dir = -1;         /* Stack grew downward.  */
 133     }
 134 }
 135
 136 #endif /* STACK_DIRECTION == 0 */
 137
 138 /* An "alloca header" is used to:
 139    (a) chain together all alloca'ed blocks;
 140    (b) keep track of stack depth.
 141
 142    It is very important that sizeof(header) agree with malloc
 143    alignment chunk size.  The following default should work okay.  */
 144
 145 #ifndef ALIGN_SIZE
 146 #define ALIGN_SIZE      sizeof(double)
 147 #endif
 148
 149 typedef union hdr
 150 {
 151   char align[ALIGN_SIZE];       /* To force sizeof(header).  */
 152   struct
 153     {
 154       union hdr *next;          /* For chaining headers.  */
 155       char *deep;               /* For stack depth measure.  */
 156     } h;
 157 } header;
 158
 159 static header *last_alloca_header = NULL;       /* -> last alloca header.  */
 160
 161 /* Return a pointer to at least SIZE bytes of storage,
 162    which will be automatically reclaimed upon exit from
 163    the procedure that called alloca.  Originally, this space
 164    was supposed to be taken from the current stack frame of the
 165    caller, but that method cannot be made to work for some
 166    implementations of C, for example under Gould's UTX/32.  */
 167
 168 pointer
 169 alloca (size)
 170      unsigned size;
 171 {
 172   auto char probe;              /* Probes stack depth: */
 173   register char *depth = ADDRESS_FUNCTION (probe);
 174
 175 #if STACK_DIRECTION == 0
 176   if (STACK_DIR == 0)           /* Unknown growth direction.  */
 177     find_stack_direction ();
 178 #endif
 179
 180   /* Reclaim garbage, defined as all alloca'd storage that
 181      was allocated from deeper in the stack than currently. */
 182
 183   {
 184     register header *hp;        /* Traverses linked list.  */
 185
 186 #ifdef emacs
 187     BLOCK_INPUT;
 188 #endif
 189
 190     for (hp = last_alloca_header; hp != NULL;)
 191       if ((STACK_DIR > 0 && hp->h.deep > depth)
 192           || (STACK_DIR < 0 && hp->h.deep < depth))
 193         {
 194           register header *np = hp->h.next;
 195
 196           free ((pointer) hp);  /* Collect garbage.  */
 197
 198           hp = np;              /* -> next header.  */
 199         }
 200       else
 201         break;                  /* Rest are not deeper.  */
 202
 203     last_alloca_header = hp;    /* -> last valid storage.  */
 204
 205 #ifdef emacs
 206     UNBLOCK_INPUT;
 207 #endif
 208   }
 209
 210   if (size == 0)
 211     return NULL;                /* No allocation required.  */
 212
 213   /* Allocate combined header + user data storage.  */
 214
 215   {
 216     register pointer new = malloc (sizeof (header) + size);
 217     /* Address of header.  */
 218
 219     if (new == 0)
 220       abort();
 221
 222     ((header *) new)->h.next = last_alloca_header;
 223     ((header *) new)->h.deep = depth;
 224
 225     last_alloca_header = (header *) new;
 226
 227     /* User storage begins just after header.  */
 228
 229     return (pointer) ((char *) new + sizeof (header));
 230   }
 231 }
 232
 233 #if defined (CRAY) && defined (CRAY_STACKSEG_END)
 234
 235 #ifdef DEBUG_I00AFUNC
 236 #include <stdio.h>
 237 #endif
 238
 239 #ifndef CRAY_STACK
 240 #define CRAY_STACK
 241 #ifndef CRAY2
 242 /* Stack structures for CRAY-1, CRAY X-MP, and CRAY Y-MP */
 243 struct stack_control_header
 244   {
 245     long shgrow:32;             /* Number of times stack has grown.  */
 246     long shaseg:32;             /* Size of increments to stack.  */
 247     long shhwm:32;              /* High water mark of stack.  */
 248     long shsize:32;             /* Current size of stack (all segments).  */
 249   };
 250
 251 /* The stack segment linkage control information occurs at
 252    the high-address end of a stack segment.  (The stack
 253    grows from low addresses to high addresses.)  The initial
 254    part of the stack segment linkage control information is
 255    0200 (octal) words.  This provides for register storage
 256    for the routine which overflows the stack.  */
 257
 258 struct stack_segment_linkage
 259   {
 260     long ss[0200];              /* 0200 overflow words.  */
 261     long sssize:32;             /* Number of words in this segment.  */
 262     long ssbase:32;             /* Offset to stack base.  */
 263     long:32;
 264     long sspseg:32;             /* Offset to linkage control of previous
 265                                    segment of stack.  */
 266     long:32;
 267     long sstcpt:32;             /* Pointer to task common address block.  */
 268     long sscsnm;                /* Private control structure number for
 269                                    microtasking.  */
 270     long ssusr1;                /* Reserved for user.  */
 271     long ssusr2;                /* Reserved for user.  */
 272     long sstpid;                /* Process ID for pid based multi-tasking.  */
 273     long ssgvup;                /* Pointer to multitasking thread giveup.  */
 274     long sscray[7];             /* Reserved for Cray Research.  */
 275     long ssa0;
 276     long ssa1;
 277     long ssa2;
 278     long ssa3;
 279     long ssa4;
 280     long ssa5;
 281     long ssa6;
 282     long ssa7;
 283     long sss0;
 284     long sss1;
 285     long sss2;
 286     long sss3;
 287     long sss4;
 288     long sss5;
 289     long sss6;
 290     long sss7;
 291   };
 292
 293 #else /* CRAY2 */
 294 /* The following structure defines the vector of words
 295    returned by the STKSTAT library routine.  */
 296 struct stk_stat
 297   {
 298     long now;                   /* Current total stack size.  */
 299     long maxc;                  /* Amount of contiguous space which would
 300                                    be required to satisfy the maximum
 301                                    stack demand to date.  */
 302     long high_water;            /* Stack high-water mark.  */
 303     long overflows;             /* Number of stack overflow ($STKOFEN) calls.  */
 304     long hits;                  /* Number of internal buffer hits.  */
 305     long extends;               /* Number of block extensions.  */
 306     long stko_mallocs;          /* Block allocations by $STKOFEN.  */
 307     long underflows;            /* Number of stack underflow calls ($STKRETN).  */
 308     long stko_free;             /* Number of deallocations by $STKRETN.  */
 309     long stkm_free;             /* Number of deallocations by $STKMRET.  */
 310     long segments;              /* Current number of stack segments.  */
 311     long maxs;                  /* Maximum number of stack segments so far.  */
 312     long pad_size;              /* Stack pad size.  */
 313     long current_address;       /* Current stack segment address.  */
 314     long current_size;          /* Current stack segment size.  This
 315                                    number is actually corrupted by STKSTAT to
 316                                    include the fifteen word trailer area.  */
 317     long initial_address;       /* Address of initial segment.  */
 318     long initial_size;          /* Size of initial segment.  */
 319   };
 320
 321 /* The following structure describes the data structure which trails
 322    any stack segment.  I think that the description in 'asdef' is
 323    out of date.  I only describe the parts that I am sure about.  */
 324
 325 struct stk_trailer
 326   {
 327     long this_address;          /* Address of this block.  */
 328     long this_size;             /* Size of this block (does not include
 329                                    this trailer).  */
 330     long unknown2;
 331     long unknown3;
 332     long link;                  /* Address of trailer block of previous
 333                                    segment.  */
 334     long unknown5;
 335     long unknown6;
 336     long unknown7;
 337     long unknown8;
 338     long unknown9;
 339     long unknown10;
 340     long unknown11;
 341     long unknown12;
 342     long unknown13;
 343     long unknown14;
 344   };
 345
 346 #endif /* CRAY2 */
 347 #endif /* not CRAY_STACK */
 348
 349 #ifdef CRAY2
 350 /* Determine a "stack measure" for an arbitrary ADDRESS.
 351    I doubt that "lint" will like this much. */
 352
 353 static long
 354 i00afunc (long *address)
 355 {
 356   struct stk_stat status;
 357   struct stk_trailer *trailer;
 358   long *block, size;
 359   long result = 0;
 360
 361   /* We want to iterate through all of the segments.  The first
 362      step is to get the stack status structure.  We could do this
 363      more quickly and more directly, perhaps, by referencing the
 364      $LM00 common block, but I know that this works.  */
 365
 366   STKSTAT (&status);
 367
 368   /* Set up the iteration.  */
 369
 370   trailer = (struct stk_trailer *) (status.current_address
 371                                     + status.current_size
 372                                     - 15);
 373
 374   /* There must be at least one stack segment.  Therefore it is
 375      a fatal error if "trailer" is null.  */
 376
 377   if (trailer == 0)
 378     abort ();
 379
 380   /* Discard segments that do not contain our argument address.  */
 381
 382   while (trailer != 0)
 383     {
 384       block = (long *) trailer->this_address;
 385       size = trailer->this_size;
 386       if (block == 0 || size == 0)
 387         abort ();
 388       trailer = (struct stk_trailer *) trailer->link;
 389       if ((block <= address) && (address < (block + size)))
 390         break;
 391     }
 392
 393   /* Set the result to the offset in this segment and add the sizes
 394      of all predecessor segments.  */
 395
 396   result = address - block;
 397
 398   if (trailer == 0)
 399     {
 400       return result;
 401     }
 402
 403   do
 404     {
 405       if (trailer->this_size <= 0)
 406         abort ();
 407       result += trailer->this_size;
 408       trailer = (struct stk_trailer *) trailer->link;
 409     }
 410   while (trailer != 0);
 411
 412   /* We are done.  Note that if you present a bogus address (one
 413      not in any segment), you will get a different number back, formed
 414      from subtracting the address of the first block.  This is probably
 415      not what you want.  */
 416
 417   return (result);
 418 }
 419
 420 #else /* not CRAY2 */
 421 /* Stack address function for a CRAY-1, CRAY X-MP, or CRAY Y-MP.
 422    Determine the number of the cell within the stack,
 423    given the address of the cell.  The purpose of this
 424    routine is to linearize, in some sense, stack addresses
 425    for alloca.  */
 426
 427 static long
 428 i00afunc (long address)
 429 {
 430   long stkl = 0;
 431
 432   long size, pseg, this_segment, stack;
 433   long result = 0;
 434
 435   struct stack_segment_linkage *ssptr;
 436
 437   /* Register B67 contains the address of the end of the
 438      current stack segment.  If you (as a subprogram) store
 439      your registers on the stack and find that you are past
 440      the contents of B67, you have overflowed the segment.
 441
 442      B67 also points to the stack segment linkage control
 443      area, which is what we are really interested in.  */
 444
 445   stkl = CRAY_STACKSEG_END ();
 446   ssptr = (struct stack_segment_linkage *) stkl;
 447
 448   /* If one subtracts 'size' from the end of the segment,
 449      one has the address of the first word of the segment.
 450
 451      If this is not the first segment, 'pseg' will be
 452      nonzero.  */
 453
 454   pseg = ssptr->sspseg;
 455   size = ssptr->sssize;
 456
 457   this_segment = stkl - size;
 458
 459   /* It is possible that calling this routine itself caused
 460      a stack overflow.  Discard stack segments which do not
 461      contain the target address.  */
 462
 463   while (!(this_segment <= address && address <= stkl))
 464     {
 465 #ifdef DEBUG_I00AFUNC
 466       fprintf (stderr, "%011o %011o %011o\n", this_segment, address, stkl);
 467 #endif
 468       if (pseg == 0)
 469         break;
 470       stkl = stkl - pseg;
 471       ssptr = (struct stack_segment_linkage *) stkl;
 472       size = ssptr->sssize;
 473       pseg = ssptr->sspseg;
 474       this_segment = stkl - size;
 475     }
 476
 477   result = address - this_segment;
 478
 479   /* If you subtract pseg from the current end of the stack,
 480      you get the address of the previous stack segment's end.
 481      This seems a little convoluted to me, but I'll bet you save
 482      a cycle somewhere.  */
 483
 484   while (pseg != 0)
 485     {
 486 #ifdef DEBUG_I00AFUNC
 487       fprintf (stderr, "%011o %011o\n", pseg, size);
 488 #endif
 489       stkl = stkl - pseg;
 490       ssptr = (struct stack_segment_linkage *) stkl;
 491       size = ssptr->sssize;
 492       pseg = ssptr->sspseg;
 493       result += size;
 494     }
 495   return (result);
 496 }
 497
 498 #endif /* not CRAY2 */
 499 #endif /* CRAY */
 500
 501 #endif /* no alloca */
 502 #endif /* not GCC version 2 */