This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
f5c82b8cc3e7c6c20d312cbf5b2780a2e0ae720e
[perl5.git] / malloc.c
1 /*    malloc.c
2  *
3  */
4
5 /*
6  * "'The Chamber of Records,' said Gimli. 'I guess that is where we now stand.'"
7  */
8
9 /* This file contains Perl's own implementation of the malloc library.
10  * It is used if Configure decides that, on your platform, Perl's
11  * version is better than the OS's, or if you give Configure the
12  * -Dusemymalloc command-line option.
13  */
14
15 /*
16   Here are some notes on configuring Perl's malloc.  (For non-perl
17   usage see below.)
18  
19   There are two macros which serve as bulk disablers of advanced
20   features of this malloc: NO_FANCY_MALLOC, PLAIN_MALLOC (undef by
21   default).  Look in the list of default values below to understand
22   their exact effect.  Defining NO_FANCY_MALLOC returns malloc.c to the
23   state of the malloc in Perl 5.004.  Additionally defining PLAIN_MALLOC
24   returns it to the state as of Perl 5.000.
25
26   Note that some of the settings below may be ignored in the code based
27   on values of other macros.  The PERL_CORE symbol is only defined when
28   perl itself is being compiled (so malloc can make some assumptions
29   about perl's facilities being available to it).
30
31   Each config option has a short description, followed by its name,
32   default value, and a comment about the default (if applicable).  Some
33   options take a precise value, while the others are just boolean.
34   The boolean ones are listed first.
35
36     # Read configuration settings from malloc_cfg.h
37     HAVE_MALLOC_CFG_H           undef
38
39     # Enable code for an emergency memory pool in $^M.  See perlvar.pod
40     # for a description of $^M.
41     PERL_EMERGENCY_SBRK         (!PLAIN_MALLOC && (PERL_CORE || !NO_MALLOC_DYNAMIC_CFG))
42
43     # Enable code for printing memory statistics.
44     DEBUGGING_MSTATS            (!PLAIN_MALLOC && PERL_CORE)
45
46     # Move allocation info for small buckets into separate areas.
47     # Memory optimization (especially for small allocations, of the
48     # less than 64 bytes).  Since perl usually makes a large number
49     # of small allocations, this is usually a win.
50     PACK_MALLOC                 (!PLAIN_MALLOC && !RCHECK)
51
52     # Add one page to big powers of two when calculating bucket size.
53     # This is targeted at big allocations, as are common in image
54     # processing.
55     TWO_POT_OPTIMIZE            !PLAIN_MALLOC
56  
57     # Use intermediate bucket sizes between powers-of-two.  This is
58     # generally a memory optimization, and a (small) speed pessimization.
59     BUCKETS_ROOT2               !NO_FANCY_MALLOC
60
61     # Do not check small deallocations for bad free().  Memory
62     # and speed optimization, error reporting pessimization.
63     IGNORE_SMALL_BAD_FREE       (!NO_FANCY_MALLOC && !RCHECK)
64
65     # Use table lookup to decide in which bucket a given allocation will go.
66     SMALL_BUCKET_VIA_TABLE      !NO_FANCY_MALLOC
67
68     # Use a perl-defined sbrk() instead of the (presumably broken or
69     # missing) system-supplied sbrk().
70     USE_PERL_SBRK               undef
71
72     # Use system malloc() (or calloc() etc.) to emulate sbrk(). Normally
73     # only used with broken sbrk()s.
74     PERL_SBRK_VIA_MALLOC        undef
75
76     # Which allocator to use if PERL_SBRK_VIA_MALLOC
77     SYSTEM_ALLOC(a)             malloc(a)
78
79     # Minimal alignment (in bytes, should be a power of 2) of SYSTEM_ALLOC
80     SYSTEM_ALLOC_ALIGNMENT      MEM_ALIGNBYTES
81
82     # Disable memory overwrite checking with DEBUGGING.  Memory and speed
83     # optimization, error reporting pessimization.
84     NO_RCHECK                   undef
85
86     # Enable memory overwrite checking with DEBUGGING.  Memory and speed
87     # pessimization, error reporting optimization
88     RCHECK                      (DEBUGGING && !NO_RCHECK)
89
90     # Do not overwrite uninit areas with DEBUGGING.  Speed
91     # optimization, error reporting pessimization
92     NO_MFILL                    undef
93
94     # Overwrite uninit areas with DEBUGGING.  Speed
95     # pessimization, error reporting optimization
96     MALLOC_FILL                 (DEBUGGING && !NO_RCHECK && !NO_MFILL)
97
98     # Do not check overwritten uninit areas with DEBUGGING.  Speed
99     # optimization, error reporting pessimization
100     NO_FILL_CHECK               undef
101
102     # Check overwritten uninit areas with DEBUGGING.  Speed
103     # pessimization, error reporting optimization
104     MALLOC_FILL_CHECK           (DEBUGGING && !NO_RCHECK && !NO_FILL_CHECK)
105
106     # Failed allocations bigger than this size croak (if
107     # PERL_EMERGENCY_SBRK is enabled) without touching $^M.  See
108     # perlvar.pod for a description of $^M.
109     BIG_SIZE                     (1<<16)        # 64K
110
111     # Starting from this power of two, add an extra page to the
112     # size of the bucket. This enables optimized allocations of sizes
113     # close to powers of 2.  Note that the value is indexed at 0.
114     FIRST_BIG_POW2              15              # 32K, 16K is used too often
115
116     # Estimate of minimal memory footprint.  malloc uses this value to
117     # request the most reasonable largest blocks of memory from the system.
118     FIRST_SBRK                  (48*1024)
119
120     # Round up sbrk()s to multiples of this.
121     MIN_SBRK                    2048
122
123     # Round up sbrk()s to multiples of this percent of footprint.
124     MIN_SBRK_FRAC               3
125
126     # Round up sbrk()s to multiples of this multiple of 1/1000 of footprint.
127     MIN_SBRK_FRAC1000           (10 * MIN_SBRK_FRAC)
128
129     # Add this much memory to big powers of two to get the bucket size.
130     PERL_PAGESIZE               4096
131
132     # This many sbrk() discontinuities should be tolerated even
133     # from the start without deciding that sbrk() is usually
134     # discontinuous.
135     SBRK_ALLOW_FAILURES         3
136
137     # This many continuous sbrk()s compensate for one discontinuous one.
138     SBRK_FAILURE_PRICE          50
139
140     # Some configurations may ask for 12-byte-or-so allocations which
141     # require 8-byte alignment (?!).  In such situation one needs to
142     # define this to disable 12-byte bucket (will increase memory footprint)
143     STRICT_ALIGNMENT            undef
144
145     # Do not allow configuration of runtime options at runtime
146     NO_MALLOC_DYNAMIC_CFG       undef
147
148     # Do not allow configuration of runtime options via $ENV{PERL_MALLOC_OPT}
149     NO_PERL_MALLOC_ENV          undef
150
151         [The variable consists of ;-separated parts of the form CODE=VALUE
152          with 1-character codes F, M, f, A, P, G, d, a, c for runtime
153          configuration of FIRST_SBRK, MIN_SBRK, MIN_SBRK_FRAC1000,
154          SBRK_ALLOW_FAILURES, SBRK_FAILURE_PRICE, sbrk_goodness,
155          filldead, fillalive, fillcheck.  The last 3 are for DEBUGGING
156          build, and allow switching the tests for free()ed memory read,
157          uninit memory reads, and free()ed memory write.]
158
159   This implementation assumes that calling PerlIO_printf() does not
160   result in any memory allocation calls (used during a panic).
161
162  */
163
164 /*
165    If used outside of Perl environment, it may be useful to redefine
166    the following macros (listed below with defaults):
167
168      # Type of address returned by allocation functions
169      Malloc_t                           void *
170
171      # Type of size argument for allocation functions
172      MEM_SIZE                           unsigned long
173
174      # size of void*
175      PTRSIZE                            4
176
177      # Maximal value in LONG
178      LONG_MAX                           0x7FFFFFFF
179
180      # Unsigned integer type big enough to keep a pointer
181      UV                                 unsigned long
182
183      # Signed integer of the same sizeof() as UV
184      IV                                 long
185
186      # Type of pointer with 1-byte granularity
187      caddr_t                            char *
188
189      # Type returned by free()
190      Free_t                             void
191
192      # Conversion of pointer to integer
193      PTR2UV(ptr)                        ((UV)(ptr))
194
195      # Conversion of integer to pointer
196      INT2PTR(type, i)                   ((type)(i))
197
198      # printf()-%-Conversion of UV to pointer
199      UVuf                               "lu"
200
201      # printf()-%-Conversion of UV to hex pointer
202      UVxf                               "lx"
203
204      # Alignment to use
205      MEM_ALIGNBYTES                     4
206
207      # Very fatal condition reporting function (cannot call any )
208      fatalcroak(arg)                    write(2,arg,strlen(arg)) + exit(2)
209   
210      # Fatal error reporting function
211      croak(format, arg)                 warn(idem) + exit(1)
212   
213      # Fatal error reporting function
214      croak2(format, arg1, arg2)         warn2(idem) + exit(1)
215   
216      # Error reporting function
217      warn(format, arg)                  fprintf(stderr, idem)
218
219      # Error reporting function
220      warn2(format, arg1, arg2)          fprintf(stderr, idem)
221
222      # Locking/unlocking for MT operation
223      MALLOC_LOCK                        MUTEX_LOCK(&PL_malloc_mutex)
224      MALLOC_UNLOCK                      MUTEX_UNLOCK(&PL_malloc_mutex)
225
226      # Locking/unlocking mutex for MT operation
227      MUTEX_LOCK(l)                      void
228      MUTEX_UNLOCK(l)                    void
229  */
230
231 #ifdef HAVE_MALLOC_CFG_H
232 #  include "malloc_cfg.h"
233 #endif
234
235 #ifndef NO_FANCY_MALLOC
236 #  ifndef SMALL_BUCKET_VIA_TABLE
237 #    define SMALL_BUCKET_VIA_TABLE
238 #  endif 
239 #  ifndef BUCKETS_ROOT2
240 #    define BUCKETS_ROOT2
241 #  endif 
242 #  ifndef IGNORE_SMALL_BAD_FREE
243 #    define IGNORE_SMALL_BAD_FREE
244 #  endif 
245 #endif 
246
247 #ifndef PLAIN_MALLOC                    /* Bulk enable features */
248 #  ifndef PACK_MALLOC
249 #      define PACK_MALLOC
250 #  endif 
251 #  ifndef TWO_POT_OPTIMIZE
252 #    define TWO_POT_OPTIMIZE
253 #  endif 
254 #  if (defined(PERL_CORE) || !defined(NO_MALLOC_DYNAMIC_CFG)) && !defined(PERL_EMERGENCY_SBRK)
255 #    define PERL_EMERGENCY_SBRK
256 #  endif 
257 #  if defined(PERL_CORE) && !defined(DEBUGGING_MSTATS)
258 #    define DEBUGGING_MSTATS
259 #  endif 
260 #endif
261
262 #define MIN_BUC_POW2 (sizeof(void*) > 4 ? 3 : 2) /* Allow for 4-byte arena. */
263 #define MIN_BUCKET (MIN_BUC_POW2 * BUCKETS_PER_POW2)
264
265 #if !(defined(I286) || defined(atarist) || defined(__MINT__))
266         /* take 2k unless the block is bigger than that */
267 #  define LOG_OF_MIN_ARENA 11
268 #else
269         /* take 16k unless the block is bigger than that 
270            (80286s like large segments!), probably good on the atari too */
271 #  define LOG_OF_MIN_ARENA 14
272 #endif
273
274 #ifndef lint
275 #  if defined(DEBUGGING) && !defined(NO_RCHECK)
276 #    define RCHECK
277 #  endif
278 #  if defined(DEBUGGING) && !defined(NO_RCHECK) && !defined(NO_MFILL) && !defined(MALLOC_FILL)
279 #    define MALLOC_FILL
280 #  endif
281 #  if defined(DEBUGGING) && !defined(NO_RCHECK) && !defined(NO_FILL_CHECK) && !defined(MALLOC_FILL_CHECK)
282 #    define MALLOC_FILL_CHECK
283 #  endif
284 #  if defined(RCHECK) && defined(IGNORE_SMALL_BAD_FREE)
285 #    undef IGNORE_SMALL_BAD_FREE
286 #  endif 
287 /*
288  * malloc.c (Caltech) 2/21/82
289  * Chris Kingsley, kingsley@cit-20.
290  *
291  * This is a very fast storage allocator.  It allocates blocks of a small 
292  * number of different sizes, and keeps free lists of each size.  Blocks that
293  * don't exactly fit are passed up to the next larger size.  In this 
294  * implementation, the available sizes are 2^n-4 (or 2^n-12) bytes long.
295  * If PACK_MALLOC is defined, small blocks are 2^n bytes long.
296  * This is designed for use in a program that uses vast quantities of memory,
297  * but bombs when it runs out.
298  * 
299  * Modifications Copyright Ilya Zakharevich 1996-99.
300  * 
301  * Still very quick, but much more thrifty.  (Std config is 10% slower
302  * than it was, and takes 67% of old heap size for typical usage.)
303  *
304  * Allocations of small blocks are now table-driven to many different
305  * buckets.  Sizes of really big buckets are increased to accomodata
306  * common size=power-of-2 blocks.  Running-out-of-memory is made into
307  * an exception.  Deeply configurable and thread-safe.
308  * 
309  */
310
311 #ifdef PERL_CORE
312 #  include "EXTERN.h"
313 #  define PERL_IN_MALLOC_C
314 #  include "perl.h"
315 #  if defined(PERL_IMPLICIT_CONTEXT)
316 #    define croak       Perl_croak_nocontext
317 #    define croak2      Perl_croak_nocontext
318 #    define warn        Perl_warn_nocontext
319 #    define warn2       Perl_warn_nocontext
320 #  else
321 #    define croak2      croak
322 #    define warn2       warn
323 #  endif
324 #  if defined(USE_5005THREADS) || defined(USE_ITHREADS)
325 #     define PERL_MAYBE_ALIVE   PL_thr_key
326 #  else
327 #     define PERL_MAYBE_ALIVE   1
328 #  endif
329 #else
330 #  ifdef PERL_FOR_X2P
331 #    include "../EXTERN.h"
332 #    include "../perl.h"
333 #  else
334 #    include <stdlib.h>
335 #    include <stdio.h>
336 #    include <memory.h>
337 #    ifdef OS2
338 #      include <io.h>
339 #    endif
340 #    include <string.h>
341 #    ifndef Malloc_t
342 #      define Malloc_t void *
343 #    endif
344 #    ifndef PTRSIZE
345 #      define PTRSIZE 4
346 #    endif
347 #    ifndef MEM_SIZE
348 #      define MEM_SIZE unsigned long
349 #    endif
350 #    ifndef LONG_MAX
351 #      define LONG_MAX 0x7FFFFFFF
352 #    endif
353 #    ifndef UV
354 #      define UV unsigned long
355 #    endif
356 #    ifndef IV
357 #      define IV long
358 #    endif
359 #    ifndef caddr_t
360 #      define caddr_t char *
361 #    endif
362 #    ifndef Free_t
363 #      define Free_t void
364 #    endif
365 #    define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
366 #    define CopyD(s,d,n,t) memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
367 #    define PerlEnv_getenv getenv
368 #    define PerlIO_printf fprintf
369 #    define PerlIO_stderr() stderr
370 #    define PerlIO_puts(f,s)            fputs(s,f)
371 #    ifndef INT2PTR
372 #      define INT2PTR(t,i)              ((t)(i))
373 #    endif
374 #    ifndef PTR2UV
375 #      define PTR2UV(p)                 ((UV)(p))
376 #    endif
377 #    ifndef UVuf
378 #      define UVuf                      "lu"
379 #    endif
380 #    ifndef UVxf
381 #      define UVxf                      "lx"
382 #    endif
383 #    ifndef Nullch
384 #      define Nullch                    NULL
385 #    endif
386 #    ifndef MEM_ALIGNBYTES
387 #      define MEM_ALIGNBYTES            4
388 #    endif
389 #  endif
390 #  ifndef croak                         /* make depend */
391 #    define croak(mess, arg) (warn((mess), (arg)), exit(1))
392 #  endif 
393 #  ifndef croak2                        /* make depend */
394 #    define croak2(mess, arg1, arg2) (warn2((mess), (arg1), (arg2)), exit(1))
395 #  endif 
396 #  ifndef warn
397 #    define warn(mess, arg) fprintf(stderr, (mess), (arg))
398 #  endif 
399 #  ifndef warn2
400 #    define warn2(mess, arg1, arg2) fprintf(stderr, (mess), (arg1), (arg2))
401 #  endif 
402 #  ifdef DEBUG_m
403 #    undef DEBUG_m
404 #  endif 
405 #  define DEBUG_m(a)
406 #  ifdef DEBUGGING
407 #     undef DEBUGGING
408 #  endif
409 #  ifndef pTHX
410 #     define pTHX               void
411 #     define pTHX_
412 #     ifdef HASATTRIBUTE
413 #        define dTHX            extern int Perl___notused PERL_UNUSED_DECL
414 #     else
415 #        define dTHX            extern int Perl___notused
416 #     endif
417 #     define WITH_THX(s)        s
418 #  endif
419 #  ifndef PERL_GET_INTERP
420 #     define PERL_GET_INTERP    PL_curinterp
421 #  endif
422 #  define PERL_MAYBE_ALIVE      1
423 #  ifndef Perl_malloc
424 #     define Perl_malloc malloc
425 #  endif
426 #  ifndef Perl_mfree
427 #     define Perl_mfree free
428 #  endif
429 #  ifndef Perl_realloc
430 #     define Perl_realloc realloc
431 #  endif
432 #  ifndef Perl_calloc
433 #     define Perl_calloc calloc
434 #  endif
435 #  ifndef Perl_strdup
436 #     define Perl_strdup strdup
437 #  endif
438 #endif  /* defined PERL_CORE */
439
440 #ifndef MUTEX_LOCK
441 #  define MUTEX_LOCK(l)
442 #endif 
443
444 #ifndef MUTEX_UNLOCK
445 #  define MUTEX_UNLOCK(l)
446 #endif 
447
448 #ifndef MALLOC_LOCK
449 #  define MALLOC_LOCK           MUTEX_LOCK(&PL_malloc_mutex)
450 #endif 
451
452 #ifndef MALLOC_UNLOCK
453 #  define MALLOC_UNLOCK         MUTEX_UNLOCK(&PL_malloc_mutex)
454 #endif 
455
456 #  ifndef fatalcroak                            /* make depend */
457 #    define fatalcroak(mess)    (write(2, (mess), strlen(mess)), exit(2))
458 #  endif 
459
460 #ifdef DEBUGGING
461 #  undef DEBUG_m
462 #  define DEBUG_m(a)                                                    \
463     STMT_START {                                                        \
464         if (PERL_MAYBE_ALIVE && PERL_GET_THX) {                                         \
465             dTHX;                                                       \
466             if (DEBUG_m_TEST) {                                         \
467                 PL_debug &= ~DEBUG_m_FLAG;                              \
468                 a;                                                      \
469                 PL_debug |= DEBUG_m_FLAG;                               \
470             }                                                           \
471         }                                                               \
472     } STMT_END
473 #endif
474
475 #ifdef PERL_IMPLICIT_CONTEXT
476 #  define PERL_IS_ALIVE         aTHX
477 #else
478 #  define PERL_IS_ALIVE         TRUE
479 #endif
480     
481
482 /*
483  * Layout of memory:
484  * ~~~~~~~~~~~~~~~~
485  * The memory is broken into "blocks" which occupy multiples of 2K (and
486  * generally speaking, have size "close" to a power of 2).  The addresses
487  * of such *unused* blocks are kept in nextf[i] with big enough i.  (nextf
488  * is an array of linked lists.)  (Addresses of used blocks are not known.)
489  * 
490  * Moreover, since the algorithm may try to "bite" smaller blocks out
491  * of unused bigger ones, there are also regions of "irregular" size,
492  * managed separately, by a linked list chunk_chain.
493  * 
494  * The third type of storage is the sbrk()ed-but-not-yet-used space, its
495  * end and size are kept in last_sbrk_top and sbrked_remains.
496  * 
497  * Growing blocks "in place":
498  * ~~~~~~~~~~~~~~~~~~~~~~~~~
499  * The address of the block with the greatest address is kept in last_op
500  * (if not known, last_op is 0).  If it is known that the memory above
501  * last_op is not continuous, or contains a chunk from chunk_chain,
502  * last_op is set to 0.
503  * 
504  * The chunk with address last_op may be grown by expanding into
505  * sbrk()ed-but-not-yet-used space, or trying to sbrk() more continuous
506  * memory.
507  * 
508  * Management of last_op:
509  * ~~~~~~~~~~~~~~~~~~~~~
510  * 
511  * free() never changes the boundaries of blocks, so is not relevant.
512  * 
513  * The only way realloc() may change the boundaries of blocks is if it
514  * grows a block "in place".  However, in the case of success such a
515  * chunk is automatically last_op, and it remains last_op.  In the case
516  * of failure getpages_adjacent() clears last_op.
517  * 
518  * malloc() may change blocks by calling morecore() only.
519  * 
520  * morecore() may create new blocks by:
521  *   a) biting pieces from chunk_chain (cannot create one above last_op);
522  *   b) biting a piece from an unused block (if block was last_op, this
523  *      may create a chunk from chain above last_op, thus last_op is
524  *      invalidated in such a case).
525  *   c) biting of sbrk()ed-but-not-yet-used space.  This creates 
526  *      a block which is last_op.
527  *   d) Allocating new pages by calling getpages();
528  * 
529  * getpages() creates a new block.  It marks last_op at the bottom of
530  * the chunk of memory it returns.
531  * 
532  * Active pages footprint:
533  * ~~~~~~~~~~~~~~~~~~~~~~
534  * Note that we do not need to traverse the lists in nextf[i], just take
535  * the first element of this list.  However, we *need* to traverse the
536  * list in chunk_chain, but most the time it should be a very short one,
537  * so we do not step on a lot of pages we are not going to use.
538  * 
539  * Flaws:
540  * ~~~~~
541  * get_from_bigger_buckets(): forget to increment price => Quite
542  * aggressive.
543  */
544
545 /* I don't much care whether these are defined in sys/types.h--LAW */
546
547 #define u_char unsigned char
548 #define u_int unsigned int
549 /* 
550  * I removed the definition of u_bigint which appeared to be u_bigint = UV
551  * u_bigint was only used in TWOK_MASKED and TWOK_SHIFT 
552  * where I have used PTR2UV.  RMB
553  */
554 #define u_short unsigned short
555
556 /* 286 and atarist like big chunks, which gives too much overhead. */
557 #if (defined(RCHECK) || defined(I286) || defined(atarist) || defined(__MINT__)) && defined(PACK_MALLOC)
558 #  undef PACK_MALLOC
559 #endif 
560
561 /*
562  * The description below is applicable if PACK_MALLOC is not defined.
563  *
564  * The overhead on a block is at least 4 bytes.  When free, this space
565  * contains a pointer to the next free block, and the bottom two bits must
566  * be zero.  When in use, the first byte is set to MAGIC, and the second
567  * byte is the size index.  The remaining bytes are for alignment.
568  * If range checking is enabled and the size of the block fits
569  * in two bytes, then the top two bytes hold the size of the requested block
570  * plus the range checking words, and the header word MINUS ONE.
571  */
572 union   overhead {
573         union   overhead *ov_next;      /* when free */
574 #if MEM_ALIGNBYTES > 4
575         double  strut;                  /* alignment problems */
576 #  if MEM_ALIGNBYTES > 8
577         char    sstrut[MEM_ALIGNBYTES]; /* for the sizing */
578 #  endif
579 #endif
580         struct {
581 /*
582  * Keep the ovu_index and ovu_magic in this order, having a char
583  * field first gives alignment indigestion in some systems, such as
584  * MachTen.
585  */
586                 u_char  ovu_index;      /* bucket # */
587                 u_char  ovu_magic;      /* magic number */
588 #ifdef RCHECK
589             /* Subtract one to fit into u_short for an extra bucket */
590                 u_short ovu_size;       /* block size (requested + overhead - 1) */
591                 u_int   ovu_rmagic;     /* range magic number */
592 #endif
593         } ovu;
594 #define ov_magic        ovu.ovu_magic
595 #define ov_index        ovu.ovu_index
596 #define ov_size         ovu.ovu_size
597 #define ov_rmagic       ovu.ovu_rmagic
598 };
599
600 #define MAGIC           0xff            /* magic # on accounting info */
601 #define RMAGIC          0x55555555      /* magic # on range info */
602 #define RMAGIC_C        0x55            /* magic # on range info */
603
604 #ifdef RCHECK
605 #  define       RMAGIC_SZ       sizeof (u_int) /* Overhead at end of bucket */
606 #  ifdef TWO_POT_OPTIMIZE
607 #    define MAX_SHORT_BUCKET (12 * BUCKETS_PER_POW2) /* size-1 fits in short */
608 #  else
609 #    define MAX_SHORT_BUCKET (13 * BUCKETS_PER_POW2)
610 #  endif 
611 #else
612 #  define       RMAGIC_SZ       0
613 #endif
614
615 #if !defined(PACK_MALLOC) && defined(BUCKETS_ROOT2)
616 #  undef BUCKETS_ROOT2
617 #endif 
618
619 #ifdef BUCKETS_ROOT2
620 #  define BUCKET_TABLE_SHIFT 2
621 #  define BUCKET_POW2_SHIFT 1
622 #  define BUCKETS_PER_POW2 2
623 #else
624 #  define BUCKET_TABLE_SHIFT MIN_BUC_POW2
625 #  define BUCKET_POW2_SHIFT 0
626 #  define BUCKETS_PER_POW2 1
627 #endif 
628
629 #if !defined(MEM_ALIGNBYTES) || ((MEM_ALIGNBYTES > 4) && !defined(STRICT_ALIGNMENT))
630 /* Figure out the alignment of void*. */
631 struct aligner {
632   char c;
633   void *p;
634 };
635 #  define ALIGN_SMALL ((int)((caddr_t)&(((struct aligner*)0)->p)))
636 #else
637 #  define ALIGN_SMALL MEM_ALIGNBYTES
638 #endif
639
640 #define IF_ALIGN_8(yes,no)      ((ALIGN_SMALL>4) ? (yes) : (no))
641
642 #ifdef BUCKETS_ROOT2
643 #  define MAX_BUCKET_BY_TABLE 13
644 static u_short buck_size[MAX_BUCKET_BY_TABLE + 1] = 
645   { 
646       0, 0, 0, 0, 4, 4, 8, 12, 16, 24, 32, 48, 64, 80,
647   };
648 #  define BUCKET_SIZE_NO_SURPLUS(i) ((i) % 2 ? buck_size[i] : (1 << ((i) >> BUCKET_POW2_SHIFT)))
649 #  define BUCKET_SIZE_REAL(i) ((i) <= MAX_BUCKET_BY_TABLE               \
650                                ? buck_size[i]                           \
651                                : ((1 << ((i) >> BUCKET_POW2_SHIFT))     \
652                                   - MEM_OVERHEAD(i)                     \
653                                   + POW2_OPTIMIZE_SURPLUS(i)))
654 #else
655 #  define BUCKET_SIZE_NO_SURPLUS(i) (1 << ((i) >> BUCKET_POW2_SHIFT))
656 #  define BUCKET_SIZE(i) (BUCKET_SIZE_NO_SURPLUS(i) + POW2_OPTIMIZE_SURPLUS(i))
657 #  define BUCKET_SIZE_REAL(i) (BUCKET_SIZE(i) - MEM_OVERHEAD(i))
658 #endif 
659
660
661 #ifdef PACK_MALLOC
662 /* In this case there are several possible layout of arenas depending
663  * on the size.  Arenas are of sizes multiple to 2K, 2K-aligned, and
664  * have a size close to a power of 2.
665  *
666  * Arenas of the size >= 4K keep one chunk only.  Arenas of size 2K
667  * may keep one chunk or multiple chunks.  Here are the possible
668  * layouts of arenas:
669  *
670  *      # One chunk only, chunksize 2^k + SOMETHING - ALIGN, k >= 11
671  *
672  * INDEX MAGIC1 UNUSED CHUNK1
673  *
674  *      # Multichunk with sanity checking and chunksize 2^k-ALIGN, k>7
675  *
676  * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 CHUNK2 CHUNK3 ...
677  *
678  *      # Multichunk with sanity checking and size 2^k-ALIGN, k=7
679  *
680  * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 UNUSED CHUNK2 CHUNK3 ...
681  *
682  *      # Multichunk with sanity checking and size up to 80
683  *
684  * INDEX UNUSED MAGIC1 UNUSED MAGIC2 UNUSED ... CHUNK1 CHUNK2 CHUNK3 ...
685  *
686  *      # No sanity check (usually up to 48=byte-long buckets)
687  * INDEX UNUSED CHUNK1 CHUNK2 ...
688  *
689  * Above INDEX and MAGIC are one-byte-long.  Sizes of UNUSED are
690  * appropriate to keep algorithms simple and memory aligned.  INDEX
691  * encodes the size of the chunk, while MAGICn encodes state (used,
692  * free or non-managed-by-us-so-it-indicates-a-bug) of CHUNKn.  MAGIC
693  * is used for sanity checking purposes only.  SOMETHING is 0 or 4K
694  * (to make size of big CHUNK accomodate allocations for powers of two
695  * better).
696  *
697  * [There is no need to alignment between chunks, since C rules ensure
698  *  that structs which need 2^k alignment have sizeof which is
699  *  divisible by 2^k.  Thus as far as the last chunk is aligned at the
700  *  end of the arena, and 2K-alignment does not contradict things,
701  *  everything is going to be OK for sizes of chunks 2^n and 2^n +
702  *  2^k.  Say, 80-bit buckets will be 16-bit aligned, and as far as we
703  *  put allocations for requests in 65..80 range, all is fine.
704  *
705  *  Note, however, that standard malloc() puts more strict
706  *  requirements than the above C rules.  Moreover, our algorithms of
707  *  realloc() may break this idyll, but we suppose that realloc() does
708  *  need not change alignment.]
709  *
710  * Is very important to make calculation of the offset of MAGICm as
711  * quick as possible, since it is done on each malloc()/free().  In
712  * fact it is so quick that it has quite little effect on the speed of
713  * doing malloc()/free().  [By default] We forego such calculations
714  * for small chunks, but only to save extra 3% of memory, not because
715  * of speed considerations.
716  *
717  * Here is the algorithm [which is the same for all the allocations
718  * schemes above], see OV_MAGIC(block,bucket).  Let OFFSETm be the
719  * offset of the CHUNKm from the start of ARENA.  Then offset of
720  * MAGICm is (OFFSET1 >> SHIFT) + ADDOFFSET.  Here SHIFT and ADDOFFSET
721  * are numbers which depend on the size of the chunks only.
722  *
723  * Let as check some sanity conditions.  Numbers OFFSETm>>SHIFT are
724  * different for all the chunks in the arena if 2^SHIFT is not greater
725  * than size of the chunks in the arena.  MAGIC1 will not overwrite
726  * INDEX provided ADDOFFSET is >0 if OFFSET1 < 2^SHIFT.  MAGIClast
727  * will not overwrite CHUNK1 if OFFSET1 > (OFFSETlast >> SHIFT) +
728  * ADDOFFSET.
729  * 
730  * Make SHIFT the maximal possible (there is no point in making it
731  * smaller).  Since OFFSETlast is 2K - CHUNKSIZE, above restrictions
732  * give restrictions on OFFSET1 and on ADDOFFSET.
733  * 
734  * In particular, for chunks of size 2^k with k>=6 we can put
735  * ADDOFFSET to be from 0 to 2^k - 2^(11-k), and have
736  * OFFSET1==chunksize.  For chunks of size 80 OFFSET1 of 2K%80=48 is
737  * large enough to have ADDOFFSET between 1 and 16 (similarly for 96,
738  * when ADDOFFSET should be 1).  In particular, keeping MAGICs for
739  * these sizes gives no additional size penalty.
740  * 
741  * However, for chunks of size 2^k with k<=5 this gives OFFSET1 >=
742  * ADDOFSET + 2^(11-k).  Keeping ADDOFFSET 0 allows for 2^(11-k)-2^(11-2k)
743  * chunks per arena.  This is smaller than 2^(11-k) - 1 which are
744  * needed if no MAGIC is kept.  [In fact, having a negative ADDOFFSET
745  * would allow for slightly more buckets per arena for k=2,3.]
746  * 
747  * Similarly, for chunks of size 3/2*2^k with k<=5 MAGICs would span
748  * the area up to 2^(11-k)+ADDOFFSET.  For k=4 this give optimal
749  * ADDOFFSET as -7..0.  For k=3 ADDOFFSET can go up to 4 (with tiny
750  * savings for negative ADDOFFSET).  For k=5 ADDOFFSET can go -1..16
751  * (with no savings for negative values).
752  *
753  * In particular, keeping ADDOFFSET 0 for sizes of chunks up to 2^6
754  * leads to tiny pessimizations in case of sizes 4, 8, 12, 24, and
755  * leads to no contradictions except for size=80 (or 96.)
756  *
757  * However, it also makes sense to keep no magic for sizes 48 or less.
758  * This is what we do.  In this case one needs ADDOFFSET>=1 also for
759  * chunksizes 12, 24, and 48, unless one gets one less chunk per
760  * arena.
761  *  
762  * The algo of OV_MAGIC(block,bucket) keeps ADDOFFSET 0 until
763  * chunksize of 64, then makes it 1. 
764  *
765  * This allows for an additional optimization: the above scheme leads
766  * to giant overheads for sizes 128 or more (one whole chunk needs to
767  * be sacrifised to keep INDEX).  Instead we use chunks not of size
768  * 2^k, but of size 2^k-ALIGN.  If we pack these chunks at the end of
769  * the arena, then the beginnings are still in different 2^k-long
770  * sections of the arena if k>=7 for ALIGN==4, and k>=8 if ALIGN=8.
771  * Thus for k>7 the above algo of calculating the offset of the magic
772  * will still give different answers for different chunks.  And to
773  * avoid the overrun of MAGIC1 into INDEX, one needs ADDOFFSET of >=1.
774  * In the case k=7 we just move the first chunk an extra ALIGN
775  * backward inside the ARENA (this is done once per arena lifetime,
776  * thus is not a big overhead).  */
777 #  define MAX_PACKED_POW2 6
778 #  define MAX_PACKED (MAX_PACKED_POW2 * BUCKETS_PER_POW2 + BUCKET_POW2_SHIFT)
779 #  define MAX_POW2_ALGO ((1<<(MAX_PACKED_POW2 + 1)) - M_OVERHEAD)
780 #  define TWOK_MASK ((1<<LOG_OF_MIN_ARENA) - 1)
781 #  define TWOK_MASKED(x) (PTR2UV(x) & ~TWOK_MASK)
782 #  define TWOK_SHIFT(x) (PTR2UV(x) & TWOK_MASK)
783 #  define OV_INDEXp(block) (INT2PTR(u_char*,TWOK_MASKED(block)))
784 #  define OV_INDEX(block) (*OV_INDEXp(block))
785 #  define OV_MAGIC(block,bucket) (*(OV_INDEXp(block) +                  \
786                                     (TWOK_SHIFT(block)>>                \
787                                      (bucket>>BUCKET_POW2_SHIFT)) +     \
788                                     (bucket >= MIN_NEEDS_SHIFT ? 1 : 0)))
789     /* A bucket can have a shift smaller than it size, we need to
790        shift its magic number so it will not overwrite index: */
791 #  ifdef BUCKETS_ROOT2
792 #    define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2 - 1) /* Shift 80 greater than chunk 64. */
793 #  else
794 #    define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2) /* Shift 128 greater than chunk 32. */
795 #  endif 
796 #  define CHUNK_SHIFT 0
797
798 /* Number of active buckets of given ordinal. */
799 #ifdef IGNORE_SMALL_BAD_FREE
800 #define FIRST_BUCKET_WITH_CHECK (6 * BUCKETS_PER_POW2) /* 64 */
801 #  define N_BLKS(bucket) ( (bucket) < FIRST_BUCKET_WITH_CHECK           \
802                          ? ((1<<LOG_OF_MIN_ARENA) - 1)/BUCKET_SIZE_NO_SURPLUS(bucket) \
803                          : n_blks[bucket] )
804 #else
805 #  define N_BLKS(bucket) n_blks[bucket]
806 #endif 
807
808 static u_short n_blks[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] = 
809   {
810 #  if BUCKETS_PER_POW2==1
811       0, 0,
812       (MIN_BUC_POW2==2 ? 384 : 0),
813       224, 120, 62, 31, 16, 8, 4, 2
814 #  else
815       0, 0, 0, 0,
816       (MIN_BUC_POW2==2 ? 384 : 0), (MIN_BUC_POW2==2 ? 384 : 0), /* 4, 4 */
817       224, 149, 120, 80, 62, 41, 31, 25, 16, 16, 8, 8, 4, 4, 2, 2
818 #  endif
819   };
820
821 /* Shift of the first bucket with the given ordinal inside 2K chunk. */
822 #ifdef IGNORE_SMALL_BAD_FREE
823 #  define BLK_SHIFT(bucket) ( (bucket) < FIRST_BUCKET_WITH_CHECK        \
824                               ? ((1<<LOG_OF_MIN_ARENA)                  \
825                                  - BUCKET_SIZE_NO_SURPLUS(bucket) * N_BLKS(bucket)) \
826                               : blk_shift[bucket])
827 #else
828 #  define BLK_SHIFT(bucket) blk_shift[bucket]
829 #endif 
830
831 static u_short blk_shift[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] = 
832   { 
833 #  if BUCKETS_PER_POW2==1
834       0, 0,
835       (MIN_BUC_POW2==2 ? 512 : 0),
836       256, 128, 64, 64,                 /* 8 to 64 */
837       16*sizeof(union overhead), 
838       8*sizeof(union overhead), 
839       4*sizeof(union overhead), 
840       2*sizeof(union overhead), 
841 #  else
842       0, 0, 0, 0,
843       (MIN_BUC_POW2==2 ? 512 : 0), (MIN_BUC_POW2==2 ? 512 : 0),
844       256, 260, 128, 128, 64, 80, 64, 48, /* 8 to 96 */
845       16*sizeof(union overhead), 16*sizeof(union overhead), 
846       8*sizeof(union overhead), 8*sizeof(union overhead), 
847       4*sizeof(union overhead), 4*sizeof(union overhead), 
848       2*sizeof(union overhead), 2*sizeof(union overhead), 
849 #  endif 
850   };
851
852 #  define NEEDED_ALIGNMENT 0x800        /* 2k boundaries */
853 #  define WANTED_ALIGNMENT 0x800        /* 2k boundaries */
854
855 #else  /* !PACK_MALLOC */
856
857 #  define OV_MAGIC(block,bucket) (block)->ov_magic
858 #  define OV_INDEX(block) (block)->ov_index
859 #  define CHUNK_SHIFT 1
860 #  define MAX_PACKED -1
861 #  define NEEDED_ALIGNMENT MEM_ALIGNBYTES
862 #  define WANTED_ALIGNMENT 0x400        /* 1k boundaries */
863
864 #endif /* !PACK_MALLOC */
865
866 #define M_OVERHEAD (sizeof(union overhead) + RMAGIC_SZ) /* overhead at start+end */
867
868 #ifdef PACK_MALLOC
869 #  define MEM_OVERHEAD(bucket) \
870   (bucket <= MAX_PACKED ? 0 : M_OVERHEAD)
871 #  ifdef SMALL_BUCKET_VIA_TABLE
872 #    define START_SHIFTS_BUCKET ((MAX_PACKED_POW2 + 1) * BUCKETS_PER_POW2)
873 #    define START_SHIFT MAX_PACKED_POW2
874 #    ifdef BUCKETS_ROOT2                /* Chunks of size 3*2^n. */
875 #      define SIZE_TABLE_MAX 80
876 #    else
877 #      define SIZE_TABLE_MAX 64
878 #    endif 
879 static char bucket_of[] =
880   {
881 #    ifdef BUCKETS_ROOT2                /* Chunks of size 3*2^n. */
882       /* 0 to 15 in 4-byte increments. */
883       (sizeof(void*) > 4 ? 6 : 5),      /* 4/8, 5-th bucket for better reports */
884       6,                                /* 8 */
885       IF_ALIGN_8(8,7), 8,               /* 16/12, 16 */
886       9, 9, 10, 10,                     /* 24, 32 */
887       11, 11, 11, 11,                   /* 48 */
888       12, 12, 12, 12,                   /* 64 */
889       13, 13, 13, 13,                   /* 80 */
890       13, 13, 13, 13                    /* 80 */
891 #    else /* !BUCKETS_ROOT2 */
892       /* 0 to 15 in 4-byte increments. */
893       (sizeof(void*) > 4 ? 3 : 2),
894       3, 
895       4, 4, 
896       5, 5, 5, 5,
897       6, 6, 6, 6,
898       6, 6, 6, 6
899 #    endif /* !BUCKETS_ROOT2 */
900   };
901 #  else  /* !SMALL_BUCKET_VIA_TABLE */
902 #    define START_SHIFTS_BUCKET MIN_BUCKET
903 #    define START_SHIFT (MIN_BUC_POW2 - 1)
904 #  endif /* !SMALL_BUCKET_VIA_TABLE */
905 #else  /* !PACK_MALLOC */
906 #  define MEM_OVERHEAD(bucket) M_OVERHEAD
907 #  ifdef SMALL_BUCKET_VIA_TABLE
908 #    undef SMALL_BUCKET_VIA_TABLE
909 #  endif 
910 #  define START_SHIFTS_BUCKET MIN_BUCKET
911 #  define START_SHIFT (MIN_BUC_POW2 - 1)
912 #endif /* !PACK_MALLOC */
913
914 /*
915  * Big allocations are often of the size 2^n bytes. To make them a
916  * little bit better, make blocks of size 2^n+pagesize for big n.
917  */
918
919 #ifdef TWO_POT_OPTIMIZE
920
921 #  ifndef PERL_PAGESIZE
922 #    define PERL_PAGESIZE 4096
923 #  endif 
924 #  ifndef FIRST_BIG_POW2
925 #    define FIRST_BIG_POW2 15   /* 32K, 16K is used too often. */
926 #  endif
927 #  define FIRST_BIG_BLOCK (1<<FIRST_BIG_POW2)
928 /* If this value or more, check against bigger blocks. */
929 #  define FIRST_BIG_BOUND (FIRST_BIG_BLOCK - M_OVERHEAD)
930 /* If less than this value, goes into 2^n-overhead-block. */
931 #  define LAST_SMALL_BOUND ((FIRST_BIG_BLOCK>>1) - M_OVERHEAD)
932
933 #  define POW2_OPTIMIZE_ADJUST(nbytes)                          \
934    ((nbytes >= FIRST_BIG_BOUND) ? nbytes -= PERL_PAGESIZE : 0)
935 #  define POW2_OPTIMIZE_SURPLUS(bucket)                         \
936    ((bucket >= FIRST_BIG_POW2 * BUCKETS_PER_POW2) ? PERL_PAGESIZE : 0)
937
938 #else  /* !TWO_POT_OPTIMIZE */
939 #  define POW2_OPTIMIZE_ADJUST(nbytes)
940 #  define POW2_OPTIMIZE_SURPLUS(bucket) 0
941 #endif /* !TWO_POT_OPTIMIZE */
942
943 #if defined(HAS_64K_LIMIT) && defined(PERL_CORE)
944 #  define BARK_64K_LIMIT(what,nbytes,size)                              \
945         if (nbytes > 0xffff) {                                          \
946                 PerlIO_printf(PerlIO_stderr(),                          \
947                               "%s too large: %lx\n", what, size);       \
948                 my_exit(1);                                             \
949         }
950 #else /* !HAS_64K_LIMIT || !PERL_CORE */
951 #  define BARK_64K_LIMIT(what,nbytes,size)
952 #endif /* !HAS_64K_LIMIT || !PERL_CORE */
953
954 #ifndef MIN_SBRK
955 #  define MIN_SBRK 2048
956 #endif 
957
958 #ifndef FIRST_SBRK
959 #  define FIRST_SBRK (48*1024)
960 #endif 
961
962 /* Minimal sbrk in percents of what is already alloced. */
963 #ifndef MIN_SBRK_FRAC
964 #  define MIN_SBRK_FRAC 3
965 #endif 
966
967 #ifndef SBRK_ALLOW_FAILURES
968 #  define SBRK_ALLOW_FAILURES 3
969 #endif 
970
971 #ifndef SBRK_FAILURE_PRICE
972 #  define SBRK_FAILURE_PRICE 50
973 #endif 
974
975 static void     morecore        (register int bucket);
976 #  if defined(DEBUGGING)
977 static void     botch           (char *diag, char *s, char *file, int line);
978 #  endif
979 static void     add_to_chain    (void *p, MEM_SIZE size, MEM_SIZE chip);
980 static void*    get_from_chain  (MEM_SIZE size);
981 static void*    get_from_bigger_buckets(int bucket, MEM_SIZE size);
982 static union overhead *getpages (MEM_SIZE needed, int *nblksp, int bucket);
983 static int      getpages_adjacent(MEM_SIZE require);
984
985 #ifdef PERL_CORE
986
987 #ifdef I_MACH_CTHREADS
988 #  undef  MUTEX_LOCK
989 #  define MUTEX_LOCK(m)   STMT_START { if (*m) mutex_lock(*m);   } STMT_END
990 #  undef  MUTEX_UNLOCK
991 #  define MUTEX_UNLOCK(m) STMT_START { if (*m) mutex_unlock(*m); } STMT_END
992 #endif
993
994 #endif  /* defined PERL_CORE */ 
995
996 #ifndef PTRSIZE
997 #  define PTRSIZE       sizeof(void*)
998 #endif
999
1000 #ifndef BITS_IN_PTR
1001 #  define BITS_IN_PTR (8*PTRSIZE)
1002 #endif
1003
1004 /*
1005  * nextf[i] is the pointer to the next free block of size 2^i.  The
1006  * smallest allocatable block is 8 bytes.  The overhead information
1007  * precedes the data area returned to the user.
1008  */
1009 #define NBUCKETS (BITS_IN_PTR*BUCKETS_PER_POW2 + 1)
1010 static  union overhead *nextf[NBUCKETS];
1011
1012 #if defined(PURIFY) && !defined(USE_PERL_SBRK)
1013 #  define USE_PERL_SBRK
1014 #endif
1015
1016 #ifdef USE_PERL_SBRK
1017 # define sbrk(a) Perl_sbrk(a)
1018 Malloc_t Perl_sbrk (int size);
1019 #else
1020 # ifndef HAS_SBRK_PROTO /* <unistd.h> usually takes care of this */
1021 extern  Malloc_t sbrk(int);
1022 # endif
1023 #endif
1024
1025 #ifndef MIN_SBRK_FRAC1000       /* Backward compatibility */
1026 #  define MIN_SBRK_FRAC1000     (MIN_SBRK_FRAC * 10)
1027 #endif
1028
1029 #ifndef START_EXTERN_C
1030 #  ifdef __cplusplus
1031 #    define START_EXTERN_C      extern "C" {
1032 #  else
1033 #    define START_EXTERN_C
1034 #  endif
1035 #endif
1036
1037 #ifndef END_EXTERN_C
1038 #  ifdef __cplusplus
1039 #    define END_EXTERN_C                };
1040 #  else
1041 #    define END_EXTERN_C
1042 #  endif
1043 #endif
1044
1045 #include "malloc_ctl.h"
1046
1047 #ifndef NO_MALLOC_DYNAMIC_CFG
1048 #  define PERL_MALLOC_OPT_CHARS "FMfAPGdac"
1049
1050 #  ifndef FILL_DEAD_DEFAULT
1051 #    define FILL_DEAD_DEFAULT   1
1052 #  endif
1053 #  ifndef FILL_ALIVE_DEFAULT
1054 #    define FILL_ALIVE_DEFAULT  1
1055 #  endif
1056 #  ifndef FILL_CHECK_DEFAULT
1057 #    define FILL_CHECK_DEFAULT  1
1058 #  endif
1059
1060 static IV MallocCfg[MallocCfg_last] = {
1061   FIRST_SBRK,
1062   MIN_SBRK,
1063   MIN_SBRK_FRAC,
1064   SBRK_ALLOW_FAILURES,
1065   SBRK_FAILURE_PRICE,
1066   SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE,     /* sbrk_goodness */
1067   FILL_DEAD_DEFAULT,    /* FILL_DEAD */
1068   FILL_ALIVE_DEFAULT,   /* FILL_ALIVE */
1069   FILL_CHECK_DEFAULT,   /* FILL_CHECK */
1070   0,                    /* MallocCfg_skip_cfg_env */
1071   0,                    /* MallocCfg_cfg_env_read */
1072   0,                    /* MallocCfg_emergency_buffer_size */
1073   0,                    /* MallocCfg_emergency_buffer_prepared_size */
1074   0                     /* MallocCfg_emergency_buffer_last_req */
1075 };
1076 IV *MallocCfg_ptr = MallocCfg;
1077
1078 static char* MallocCfgP[MallocCfg_last] = {
1079   0,                    /* MallocCfgP_emergency_buffer */
1080   0,                    /* MallocCfgP_emergency_buffer_prepared */
1081 };
1082 char **MallocCfgP_ptr = MallocCfgP;
1083
1084 #  undef MIN_SBRK
1085 #  undef FIRST_SBRK
1086 #  undef MIN_SBRK_FRAC1000
1087 #  undef SBRK_ALLOW_FAILURES
1088 #  undef SBRK_FAILURE_PRICE
1089
1090 #  define MIN_SBRK              MallocCfg[MallocCfg_MIN_SBRK]
1091 #  define FIRST_SBRK            MallocCfg[MallocCfg_FIRST_SBRK]
1092 #  define MIN_SBRK_FRAC1000     MallocCfg[MallocCfg_MIN_SBRK_FRAC1000]
1093 #  define SBRK_ALLOW_FAILURES   MallocCfg[MallocCfg_SBRK_ALLOW_FAILURES]
1094 #  define SBRK_FAILURE_PRICE    MallocCfg[MallocCfg_SBRK_FAILURE_PRICE]
1095
1096 #  define sbrk_goodness         MallocCfg[MallocCfg_sbrk_goodness]
1097
1098 #  define emergency_buffer_size MallocCfg[MallocCfg_emergency_buffer_size]
1099 #  define emergency_buffer_last_req     MallocCfg[MallocCfg_emergency_buffer_last_req]
1100
1101 #  define FILL_DEAD             MallocCfg[MallocCfg_filldead]
1102 #  define FILL_ALIVE            MallocCfg[MallocCfg_fillalive]
1103 #  define FILL_CHECK_CFG        MallocCfg[MallocCfg_fillcheck]
1104 #  define FILL_CHECK            (FILL_DEAD && FILL_CHECK_CFG)
1105
1106 #  define emergency_buffer      MallocCfgP[MallocCfgP_emergency_buffer]
1107 #  define emergency_buffer_prepared     MallocCfgP[MallocCfgP_emergency_buffer_prepared]
1108
1109 #else   /* defined(NO_MALLOC_DYNAMIC_CFG) */
1110
1111 #  define FILL_DEAD     1
1112 #  define FILL_ALIVE    1
1113 #  define FILL_CHECK    1
1114 static int sbrk_goodness = SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE;
1115
1116 #  define NO_PERL_MALLOC_ENV
1117
1118 #endif
1119
1120 #ifdef DEBUGGING_MSTATS
1121 /*
1122  * nmalloc[i] is the difference between the number of mallocs and frees
1123  * for a given block size.
1124  */
1125 static  u_int nmalloc[NBUCKETS];
1126 static  u_int sbrk_slack;
1127 static  u_int start_slack;
1128 #else   /* !( defined DEBUGGING_MSTATS ) */
1129 #  define sbrk_slack    0
1130 #endif
1131
1132 static  u_int goodsbrk;
1133
1134 #ifdef PERL_EMERGENCY_SBRK
1135
1136 #  ifndef BIG_SIZE
1137 #    define BIG_SIZE (1<<16)            /* 64K */
1138 #  endif
1139
1140 #  ifdef NO_MALLOC_DYNAMIC_CFG
1141 static MEM_SIZE emergency_buffer_size;
1142         /* 0 if the last request for more memory succeeded.
1143            Otherwise the size of the failing request. */
1144 static MEM_SIZE emergency_buffer_last_req;
1145 static char *emergency_buffer;
1146 static char *emergency_buffer_prepared;
1147 #  endif
1148
1149 #  ifndef emergency_sbrk_croak
1150 #    define emergency_sbrk_croak        croak2
1151 #  endif
1152
1153 #  ifdef PERL_CORE
1154 static char *
1155 perl_get_emergency_buffer(IV *size)
1156 {
1157     dTHX;
1158     /* First offense, give a possibility to recover by dieing. */
1159     /* No malloc involved here: */
1160     GV **gvp = (GV**)hv_fetch(PL_defstash, "^M", 2, 0);
1161     SV *sv;
1162     char *pv;
1163     STRLEN n_a;
1164
1165     if (!gvp) gvp = (GV**)hv_fetch(PL_defstash, "\015", 1, 0);
1166     if (!gvp || !(sv = GvSV(*gvp)) || !SvPOK(sv) 
1167         || (SvLEN(sv) < (1<<LOG_OF_MIN_ARENA) - M_OVERHEAD))
1168         return NULL;            /* Now die die die... */
1169     /* Got it, now detach SvPV: */
1170     pv = SvPV(sv, n_a);
1171     /* Check alignment: */
1172     if ((PTR2UV(pv) - sizeof(union overhead)) & (NEEDED_ALIGNMENT - 1)) {
1173         PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
1174         return NULL;            /* die die die */
1175     }
1176
1177     SvPOK_off(sv);
1178     SvPV_set(sv, Nullch);
1179     SvCUR_set(sv, 0);
1180     SvLEN_set(sv, 0);
1181     *size = malloced_size(pv) + M_OVERHEAD;
1182     return pv - sizeof(union overhead);
1183 }
1184 #    define PERL_GET_EMERGENCY_BUFFER(p)        perl_get_emergency_buffer(p)
1185 #  else
1186 #    define PERL_GET_EMERGENCY_BUFFER(p)        NULL
1187 #  endif        /* defined PERL_CORE */
1188
1189 #  ifndef NO_MALLOC_DYNAMIC_CFG
1190 static char *
1191 get_emergency_buffer(IV *size)
1192 {
1193     char *pv = emergency_buffer_prepared;
1194
1195     *size = MallocCfg[MallocCfg_emergency_buffer_prepared_size];
1196     emergency_buffer_prepared = 0;
1197     MallocCfg[MallocCfg_emergency_buffer_prepared_size] = 0;
1198     return pv;
1199 }
1200
1201 /* Returns 0 on success, -1 on bad alignment, -2 if not implemented */
1202 int
1203 set_emergency_buffer(char *b, IV size)
1204 {
1205     if (PTR2UV(b) & (NEEDED_ALIGNMENT - 1))
1206         return -1;
1207     if (MallocCfg[MallocCfg_emergency_buffer_prepared_size])
1208         add_to_chain((void*)emergency_buffer_prepared,
1209                      MallocCfg[MallocCfg_emergency_buffer_prepared_size], 0);
1210     emergency_buffer_prepared = b;
1211     MallocCfg[MallocCfg_emergency_buffer_prepared_size] = size;
1212     return 0;
1213 }
1214 #    define GET_EMERGENCY_BUFFER(p)     get_emergency_buffer(p)
1215 #  else         /* NO_MALLOC_DYNAMIC_CFG */
1216 #    define GET_EMERGENCY_BUFFER(p)     NULL
1217 int
1218 set_emergency_buffer(char *b, IV size)
1219 {
1220     return -1;
1221 }
1222 #  endif
1223
1224 static Malloc_t
1225 emergency_sbrk(MEM_SIZE size)
1226 {
1227     MEM_SIZE rsize = (((size - 1)>>LOG_OF_MIN_ARENA) + 1)<<LOG_OF_MIN_ARENA;
1228
1229     if (size >= BIG_SIZE
1230         && (!emergency_buffer_last_req ||
1231             (size < (MEM_SIZE)emergency_buffer_last_req))) {
1232         /* Give the possibility to recover, but avoid an infinite cycle. */
1233         MALLOC_UNLOCK;
1234         emergency_buffer_last_req = size;
1235         emergency_sbrk_croak("Out of memory during \"large\" request for %"UVuf" bytes, total sbrk() is %"UVuf" bytes", (UV)size, (UV)(goodsbrk + sbrk_slack));
1236     }
1237
1238     if ((MEM_SIZE)emergency_buffer_size >= rsize) {
1239         char *old = emergency_buffer;
1240         
1241         emergency_buffer_size -= rsize;
1242         emergency_buffer += rsize;
1243         return old;
1244     } else {            
1245         /* First offense, give a possibility to recover by dieing. */
1246         /* No malloc involved here: */
1247         IV Size;
1248         char *pv = GET_EMERGENCY_BUFFER(&Size);
1249         int have = 0;
1250
1251         if (emergency_buffer_size) {
1252             add_to_chain(emergency_buffer, emergency_buffer_size, 0);
1253             emergency_buffer_size = 0;
1254             emergency_buffer = Nullch;
1255             have = 1;
1256         }
1257
1258         if (!pv)
1259             pv = PERL_GET_EMERGENCY_BUFFER(&Size);
1260         if (!pv) {
1261             if (have)
1262                 goto do_croak;
1263             return (char *)-1;          /* Now die die die... */
1264         }
1265
1266         /* Check alignment: */
1267         if (PTR2UV(pv) & (NEEDED_ALIGNMENT - 1)) {
1268             dTHX;
1269
1270             PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
1271             return (char *)-1;          /* die die die */
1272         }
1273
1274         emergency_buffer = pv;
1275         emergency_buffer_size = Size;
1276     }
1277   do_croak:
1278     MALLOC_UNLOCK;
1279     emergency_sbrk_croak("Out of memory during request for %"UVuf" bytes, total sbrk() is %"UVuf" bytes", (UV)size, (UV)(goodsbrk + sbrk_slack));
1280     /* NOTREACHED */
1281     return Nullch;
1282 }
1283
1284 #else /*  !defined(PERL_EMERGENCY_SBRK) */
1285 #  define emergency_sbrk(size)  -1
1286 #endif  /* defined PERL_EMERGENCY_SBRK */
1287
1288 static void
1289 write2(char *mess)
1290 {
1291   write(2, mess, strlen(mess));
1292 }
1293
1294 #ifdef DEBUGGING
1295 #undef ASSERT
1296 #define ASSERT(p,diag)   if (!(p)) botch(diag,STRINGIFY(p),__FILE__,__LINE__);  else
1297 static void
1298 botch(char *diag, char *s, char *file, int line)
1299 {
1300     if (!(PERL_MAYBE_ALIVE && PERL_GET_THX))
1301         goto do_write;
1302     else {
1303         dTHX;
1304         if (PerlIO_printf(PerlIO_stderr(),
1305                           "assertion botched (%s?): %s %s:%d\n",
1306                           diag, s, file, line) != 0) {
1307          do_write:              /* Can be initializing interpreter */
1308             write2("assertion botched (");
1309             write2(diag);
1310             write2("?): ");
1311             write2(s);
1312             write2(" (");
1313             write2(file);
1314             write2(":");
1315             {
1316               char linebuf[10];
1317               char *s = linebuf + sizeof(linebuf) - 1;
1318               int n = line;
1319               *s = 0;
1320               do {
1321                 *--s = '0' + (n % 10);
1322               } while (n /= 10);
1323               write2(s);
1324             }
1325             write2(")\n");
1326         }
1327         PerlProc_abort();
1328     }
1329 }
1330 #else
1331 #define ASSERT(p, diag)
1332 #endif
1333
1334 #ifdef MALLOC_FILL
1335 /* Fill should be long enough to cover long */
1336 static void
1337 fill_pat_4bytes(unsigned char *s, size_t nbytes, const unsigned char *fill)
1338 {
1339     unsigned char *e = s + nbytes;
1340     long *lp;
1341     long lfill = *(long*)fill;
1342
1343     if (PTR2UV(s) & (sizeof(long)-1)) {         /* Align the pattern */
1344         int shift = sizeof(long) - (PTR2UV(s) & (sizeof(long)-1));
1345         unsigned const char *f = fill + sizeof(long) - shift;
1346         unsigned char *e1 = s + shift;
1347
1348         while (s < e1)
1349             *s++ = *f++;
1350     }
1351     lp = (long*)s;
1352     while ((unsigned char*)(lp + 1) <= e)
1353         *lp++ = lfill;
1354     s = (unsigned char*)lp;
1355     while (s < e)
1356         *s++ = *fill++;
1357 }
1358 /* Just malloc()ed */
1359 static const unsigned char fill_feedadad[] =
1360  {0xFE, 0xED, 0xAD, 0xAD, 0xFE, 0xED, 0xAD, 0xAD,
1361   0xFE, 0xED, 0xAD, 0xAD, 0xFE, 0xED, 0xAD, 0xAD};
1362 /* Just free()ed */
1363 static const unsigned char fill_deadbeef[] =
1364  {0xDE, 0xAD, 0xBE, 0xEF, 0xDE, 0xAD, 0xBE, 0xEF,
1365   0xDE, 0xAD, 0xBE, 0xEF, 0xDE, 0xAD, 0xBE, 0xEF};
1366 #  define FILL_DEADBEEF(s, n)   \
1367         (void)(FILL_DEAD?  (fill_pat_4bytes((s), (n), fill_deadbeef), 0) : 0)
1368 #  define FILL_FEEDADAD(s, n)   \
1369         (void)(FILL_ALIVE? (fill_pat_4bytes((s), (n), fill_feedadad), 0) : 0)
1370 #else
1371 #  define FILL_DEADBEEF(s, n)   ((void)0)
1372 #  define FILL_FEEDADAD(s, n)   ((void)0)
1373 #  undef MALLOC_FILL_CHECK
1374 #endif
1375
1376 #ifdef MALLOC_FILL_CHECK
1377 static int
1378 cmp_pat_4bytes(unsigned char *s, size_t nbytes, const unsigned char *fill)
1379 {
1380     unsigned char *e = s + nbytes;
1381     long *lp;
1382     long lfill = *(long*)fill;
1383
1384     if (PTR2UV(s) & (sizeof(long)-1)) {         /* Align the pattern */
1385         int shift = sizeof(long) - (PTR2UV(s) & (sizeof(long)-1));
1386         unsigned const char *f = fill + sizeof(long) - shift;
1387         unsigned char *e1 = s + shift;
1388
1389         while (s < e1)
1390             if (*s++ != *f++)
1391                 return 1;
1392     }
1393     lp = (long*)s;
1394     while ((unsigned char*)(lp + 1) <= e)
1395         if (*lp++ != lfill)
1396             return 1;
1397     s = (unsigned char*)lp;
1398     while (s < e)
1399         if (*s++ != *fill++)
1400             return 1;
1401     return 0;
1402 }
1403 #  define FILLCHECK_DEADBEEF(s, n)                                      \
1404         ASSERT(!FILL_CHECK || !cmp_pat_4bytes(s, n, fill_deadbeef),     \
1405                "free()ed/realloc()ed-away memory was overwritten")
1406 #else
1407 #  define FILLCHECK_DEADBEEF(s, n)      ((void)0)
1408 #endif
1409
1410 Malloc_t
1411 Perl_malloc(register size_t nbytes)
1412 {
1413         register union overhead *p;
1414         register int bucket;
1415         register MEM_SIZE shiftr;
1416
1417 #if defined(DEBUGGING) || defined(RCHECK)
1418         MEM_SIZE size = nbytes;
1419 #endif
1420
1421         BARK_64K_LIMIT("Allocation",nbytes,nbytes);
1422 #ifdef DEBUGGING
1423         if ((long)nbytes < 0)
1424             croak("%s", "panic: malloc");
1425 #endif
1426
1427         /*
1428          * Convert amount of memory requested into
1429          * closest block size stored in hash buckets
1430          * which satisfies request.  Account for
1431          * space used per block for accounting.
1432          */
1433 #ifdef PACK_MALLOC
1434 #  ifdef SMALL_BUCKET_VIA_TABLE
1435         if (nbytes == 0)
1436             bucket = MIN_BUCKET;
1437         else if (nbytes <= SIZE_TABLE_MAX) {
1438             bucket = bucket_of[(nbytes - 1) >> BUCKET_TABLE_SHIFT];
1439         } else
1440 #  else
1441         if (nbytes == 0)
1442             nbytes = 1;
1443         if (nbytes <= MAX_POW2_ALGO) goto do_shifts;
1444         else
1445 #  endif
1446 #endif 
1447         {
1448             POW2_OPTIMIZE_ADJUST(nbytes);
1449             nbytes += M_OVERHEAD;
1450             nbytes = (nbytes + 3) &~ 3; 
1451 #if defined(PACK_MALLOC) && !defined(SMALL_BUCKET_VIA_TABLE)
1452           do_shifts:
1453 #endif
1454             shiftr = (nbytes - 1) >> START_SHIFT;
1455             bucket = START_SHIFTS_BUCKET;
1456             /* apart from this loop, this is O(1) */
1457             while (shiftr >>= 1)
1458                 bucket += BUCKETS_PER_POW2;
1459         }
1460         MALLOC_LOCK;
1461         /*
1462          * If nothing in hash bucket right now,
1463          * request more memory from the system.
1464          */
1465         if (nextf[bucket] == NULL)    
1466                 morecore(bucket);
1467         if ((p = nextf[bucket]) == NULL) {
1468                 MALLOC_UNLOCK;
1469 #ifdef PERL_CORE
1470                 {
1471                     dTHX;
1472                     if (!PL_nomemok) {
1473 #if defined(PLAIN_MALLOC) && defined(NO_FANCY_MALLOC)
1474                         PerlIO_puts(PerlIO_stderr(),"Out of memory!\n");
1475 #else
1476                         char buff[80];
1477                         char *eb = buff + sizeof(buff) - 1;
1478                         char *s = eb;
1479                         size_t n = nbytes;
1480
1481                         PerlIO_puts(PerlIO_stderr(),"Out of memory during request for ");
1482 #if defined(DEBUGGING) || defined(RCHECK)
1483                         n = size;
1484 #endif
1485                         *s = 0;                 
1486                         do {
1487                             *--s = '0' + (n % 10);
1488                         } while (n /= 10);
1489                         PerlIO_puts(PerlIO_stderr(),s);
1490                         PerlIO_puts(PerlIO_stderr()," bytes, total sbrk() is ");
1491                         s = eb;
1492                         n = goodsbrk + sbrk_slack;
1493                         do {
1494                             *--s = '0' + (n % 10);
1495                         } while (n /= 10);
1496                         PerlIO_puts(PerlIO_stderr(),s);
1497                         PerlIO_puts(PerlIO_stderr()," bytes!\n");
1498 #endif /* defined(PLAIN_MALLOC) && defined(NO_FANCY_MALLOC) */
1499                         my_exit(1);
1500                     }
1501                 }
1502 #endif
1503                 return (NULL);
1504         }
1505
1506         /* remove from linked list */
1507 #ifdef DEBUGGING
1508         if ( (PTR2UV(p) & (MEM_ALIGNBYTES - 1))
1509                                                 /* Can't get this low */
1510              || (p && PTR2UV(p) < (1<<LOG_OF_MIN_ARENA)) ) {
1511             dTHX;
1512             PerlIO_printf(PerlIO_stderr(),
1513                           "Unaligned pointer in the free chain 0x%"UVxf"\n",
1514                           PTR2UV(p));
1515         }
1516         if ( (PTR2UV(p->ov_next) & (MEM_ALIGNBYTES - 1))
1517              || (p->ov_next && PTR2UV(p->ov_next) < (1<<LOG_OF_MIN_ARENA)) ) {
1518             dTHX;
1519             PerlIO_printf(PerlIO_stderr(),
1520                           "Unaligned `next' pointer in the free "
1521                           "chain 0x%"UVxf" at 0x%"UVxf"\n",
1522                           PTR2UV(p->ov_next), PTR2UV(p));
1523         }
1524 #endif
1525         nextf[bucket] = p->ov_next;
1526
1527         MALLOC_UNLOCK;
1528
1529         DEBUG_m(PerlIO_printf(Perl_debug_log,
1530                               "0x%"UVxf": (%05lu) malloc %ld bytes\n",
1531                               PTR2UV((Malloc_t)(p + CHUNK_SHIFT)), (unsigned long)(PL_an++),
1532                               (long)size));
1533
1534         FILLCHECK_DEADBEEF((unsigned char*)(p + CHUNK_SHIFT),
1535                            BUCKET_SIZE_REAL(bucket) + RMAGIC_SZ);
1536
1537 #ifdef IGNORE_SMALL_BAD_FREE
1538         if (bucket >= FIRST_BUCKET_WITH_CHECK)
1539 #endif 
1540             OV_MAGIC(p, bucket) = MAGIC;
1541 #ifndef PACK_MALLOC
1542         OV_INDEX(p) = bucket;
1543 #endif
1544 #ifdef RCHECK
1545         /*
1546          * Record allocated size of block and
1547          * bound space with magic numbers.
1548          */
1549         p->ov_rmagic = RMAGIC;
1550         if (bucket <= MAX_SHORT_BUCKET) {
1551             int i;
1552             
1553             nbytes = size + M_OVERHEAD; 
1554             p->ov_size = nbytes - 1;
1555             if ((i = nbytes & (RMAGIC_SZ-1))) {
1556                 i = RMAGIC_SZ - i;
1557                 while (i--) /* nbytes - RMAGIC_SZ is end of alloced area */
1558                     ((caddr_t)p + nbytes - RMAGIC_SZ)[i] = RMAGIC_C;
1559             }
1560             /* Same at RMAGIC_SZ-aligned RMAGIC */
1561             nbytes = (nbytes + RMAGIC_SZ - 1) & ~(RMAGIC_SZ - 1);
1562             ((u_int *)((caddr_t)p + nbytes))[-1] = RMAGIC;
1563         }
1564         FILL_FEEDADAD((unsigned char *)(p + CHUNK_SHIFT), size);
1565 #endif
1566         return ((Malloc_t)(p + CHUNK_SHIFT));
1567 }
1568
1569 static char *last_sbrk_top;
1570 static char *last_op;                   /* This arena can be easily extended. */
1571 static MEM_SIZE sbrked_remains;
1572
1573 #ifdef DEBUGGING_MSTATS
1574 static int sbrks;
1575 #endif 
1576
1577 struct chunk_chain_s {
1578     struct chunk_chain_s *next;
1579     MEM_SIZE size;
1580 };
1581 static struct chunk_chain_s *chunk_chain;
1582 static int n_chunks;
1583 static char max_bucket;
1584
1585 /* Cutoff a piece of one of the chunks in the chain.  Prefer smaller chunk. */
1586 static void *
1587 get_from_chain(MEM_SIZE size)
1588 {
1589     struct chunk_chain_s *elt = chunk_chain, **oldp = &chunk_chain;
1590     struct chunk_chain_s **oldgoodp = NULL;
1591     long min_remain = LONG_MAX;
1592
1593     while (elt) {
1594         if (elt->size >= size) {
1595             long remains = elt->size - size;
1596             if (remains >= 0 && remains < min_remain) {
1597                 oldgoodp = oldp;
1598                 min_remain = remains;
1599             }
1600             if (remains == 0) {
1601                 break;
1602             }
1603         }
1604         oldp = &( elt->next );
1605         elt = elt->next;
1606     }
1607     if (!oldgoodp) return NULL;
1608     if (min_remain) {
1609         void *ret = *oldgoodp;
1610         struct chunk_chain_s *next = (*oldgoodp)->next;
1611         
1612         *oldgoodp = (struct chunk_chain_s *)((char*)ret + size);
1613         (*oldgoodp)->size = min_remain;
1614         (*oldgoodp)->next = next;
1615         return ret;
1616     } else {
1617         void *ret = *oldgoodp;
1618         *oldgoodp = (*oldgoodp)->next;
1619         n_chunks--;
1620         return ret;
1621     }
1622 }
1623
1624 static void
1625 add_to_chain(void *p, MEM_SIZE size, MEM_SIZE chip)
1626 {
1627     struct chunk_chain_s *next = chunk_chain;
1628     char *cp = (char*)p;
1629     
1630     cp += chip;
1631     chunk_chain = (struct chunk_chain_s *)cp;
1632     chunk_chain->size = size - chip;
1633     chunk_chain->next = next;
1634     n_chunks++;
1635 }
1636
1637 static void *
1638 get_from_bigger_buckets(int bucket, MEM_SIZE size)
1639 {
1640     int price = 1;
1641     static int bucketprice[NBUCKETS];
1642     while (bucket <= max_bucket) {
1643         /* We postpone stealing from bigger buckets until we want it
1644            often enough. */
1645         if (nextf[bucket] && bucketprice[bucket]++ >= price) {
1646             /* Steal it! */
1647             void *ret = (void*)(nextf[bucket] - 1 + CHUNK_SHIFT);
1648             bucketprice[bucket] = 0;
1649             if (((char*)nextf[bucket]) - M_OVERHEAD == last_op) {
1650                 last_op = NULL;         /* Disable optimization */
1651             }
1652             nextf[bucket] = nextf[bucket]->ov_next;
1653 #ifdef DEBUGGING_MSTATS
1654             nmalloc[bucket]--;
1655             start_slack -= M_OVERHEAD;
1656 #endif 
1657             add_to_chain(ret, (BUCKET_SIZE_NO_SURPLUS(bucket) +
1658                                POW2_OPTIMIZE_SURPLUS(bucket)), 
1659                          size);
1660             return ret;
1661         }
1662         bucket++;
1663     }
1664     return NULL;
1665 }
1666
1667 static union overhead *
1668 getpages(MEM_SIZE needed, int *nblksp, int bucket)
1669 {
1670     /* Need to do (possibly expensive) system call. Try to
1671        optimize it for rare calling. */
1672     MEM_SIZE require = needed - sbrked_remains;
1673     char *cp;
1674     union overhead *ovp;
1675     MEM_SIZE slack = 0;
1676
1677     if (sbrk_goodness > 0) {
1678         if (!last_sbrk_top && require < (MEM_SIZE)FIRST_SBRK) 
1679             require = FIRST_SBRK;
1680         else if (require < (MEM_SIZE)MIN_SBRK) require = MIN_SBRK;
1681
1682         if (require < goodsbrk * MIN_SBRK_FRAC1000 / 1000)
1683             require = goodsbrk * MIN_SBRK_FRAC1000 / 1000;
1684         require = ((require - 1 + MIN_SBRK) / MIN_SBRK) * MIN_SBRK;
1685     } else {
1686         require = needed;
1687         last_sbrk_top = 0;
1688         sbrked_remains = 0;
1689     }
1690
1691     DEBUG_m(PerlIO_printf(Perl_debug_log, 
1692                           "sbrk(%ld) for %ld-byte-long arena\n",
1693                           (long)require, (long) needed));
1694     cp = (char *)sbrk(require);
1695 #ifdef DEBUGGING_MSTATS
1696     sbrks++;
1697 #endif 
1698     if (cp == last_sbrk_top) {
1699         /* Common case, anything is fine. */
1700         sbrk_goodness++;
1701         ovp = (union overhead *) (cp - sbrked_remains);
1702         last_op = cp - sbrked_remains;
1703         sbrked_remains = require - (needed - sbrked_remains);
1704     } else if (cp == (char *)-1) { /* no more room! */
1705         ovp = (union overhead *)emergency_sbrk(needed);
1706         if (ovp == (union overhead *)-1)
1707             return 0;
1708         if (((char*)ovp) > last_op) {   /* Cannot happen with current emergency_sbrk() */
1709             last_op = 0;
1710         }
1711         return ovp;
1712     } else {                    /* Non-continuous or first sbrk(). */
1713         long add = sbrked_remains;
1714         char *newcp;
1715
1716         if (sbrked_remains) {   /* Put rest into chain, we
1717                                    cannot use it right now. */
1718             add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1719                          sbrked_remains, 0);
1720         }
1721
1722         /* Second, check alignment. */
1723         slack = 0;
1724
1725 #if !defined(atarist) && !defined(__MINT__) /* on the atari we dont have to worry about this */
1726 #  ifndef I286  /* The sbrk(0) call on the I286 always returns the next segment */
1727         /* WANTED_ALIGNMENT may be more than NEEDED_ALIGNMENT, but this may
1728            improve performance of memory access. */
1729         if (PTR2UV(cp) & (WANTED_ALIGNMENT - 1)) { /* Not aligned. */
1730             slack = WANTED_ALIGNMENT - (PTR2UV(cp) & (WANTED_ALIGNMENT - 1));
1731             add += slack;
1732         }
1733 #  endif
1734 #endif /* !atarist && !MINT */
1735                 
1736         if (add) {
1737             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1738                                   "sbrk(%ld) to fix non-continuous/off-page sbrk:\n\t%ld for alignement,\t%ld were assumed to come from the tail of the previous sbrk\n",
1739                                   (long)add, (long) slack,
1740                                   (long) sbrked_remains));
1741             newcp = (char *)sbrk(add);
1742 #if defined(DEBUGGING_MSTATS)
1743             sbrks++;
1744             sbrk_slack += add;
1745 #endif
1746             if (newcp != cp + require) {
1747                 /* Too bad: even rounding sbrk() is not continuous.*/
1748                 DEBUG_m(PerlIO_printf(Perl_debug_log, 
1749                                       "failed to fix bad sbrk()\n"));
1750 #ifdef PACK_MALLOC
1751                 if (slack) {
1752                     MALLOC_UNLOCK;
1753                     fatalcroak("panic: Off-page sbrk\n");
1754                 }
1755 #endif
1756                 if (sbrked_remains) {
1757                     /* Try again. */
1758 #if defined(DEBUGGING_MSTATS)
1759                     sbrk_slack += require;
1760 #endif
1761                     require = needed;
1762                     DEBUG_m(PerlIO_printf(Perl_debug_log, 
1763                                           "straight sbrk(%ld)\n",
1764                                           (long)require));
1765                     cp = (char *)sbrk(require);
1766 #ifdef DEBUGGING_MSTATS
1767                     sbrks++;
1768 #endif 
1769                     if (cp == (char *)-1)
1770                         return 0;
1771                 }
1772                 sbrk_goodness = -1;     /* Disable optimization!
1773                                    Continue with not-aligned... */
1774             } else {
1775                 cp += slack;
1776                 require += sbrked_remains;
1777             }
1778         }
1779
1780         if (last_sbrk_top) {
1781             sbrk_goodness -= SBRK_FAILURE_PRICE;
1782         }
1783
1784         ovp = (union overhead *) cp;
1785         /*
1786          * Round up to minimum allocation size boundary
1787          * and deduct from block count to reflect.
1788          */
1789
1790 #  if NEEDED_ALIGNMENT > MEM_ALIGNBYTES
1791         if (PTR2UV(ovp) & (NEEDED_ALIGNMENT - 1))
1792             fatalcroak("Misalignment of sbrk()\n");
1793         else
1794 #  endif
1795 #ifndef I286    /* Again, this should always be ok on an 80286 */
1796         if (PTR2UV(ovp) & (MEM_ALIGNBYTES - 1)) {
1797             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1798                                   "fixing sbrk(): %d bytes off machine alignement\n",
1799                                   (int)(PTR2UV(ovp) & (MEM_ALIGNBYTES - 1))));
1800             ovp = INT2PTR(union overhead *,(PTR2UV(ovp) + MEM_ALIGNBYTES) &
1801                                      (MEM_ALIGNBYTES - 1));
1802             (*nblksp)--;
1803 # if defined(DEBUGGING_MSTATS)
1804             /* This is only approx. if TWO_POT_OPTIMIZE: */
1805             sbrk_slack += (1 << (bucket >> BUCKET_POW2_SHIFT));
1806 # endif
1807         }
1808 #endif
1809         ;                               /* Finish `else' */
1810         sbrked_remains = require - needed;
1811         last_op = cp;
1812     }
1813 #if !defined(PLAIN_MALLOC) && !defined(NO_FANCY_MALLOC)
1814     emergency_buffer_last_req = 0;
1815 #endif
1816     last_sbrk_top = cp + require;
1817 #ifdef DEBUGGING_MSTATS
1818     goodsbrk += require;
1819 #endif  
1820     return ovp;
1821 }
1822
1823 static int
1824 getpages_adjacent(MEM_SIZE require)
1825 {           
1826     if (require <= sbrked_remains) {
1827         sbrked_remains -= require;
1828     } else {
1829         char *cp;
1830
1831         require -= sbrked_remains;
1832         /* We do not try to optimize sbrks here, we go for place. */
1833         cp = (char*) sbrk(require);
1834 #ifdef DEBUGGING_MSTATS
1835         sbrks++;
1836         goodsbrk += require;
1837 #endif 
1838         if (cp == last_sbrk_top) {
1839             sbrked_remains = 0;
1840             last_sbrk_top = cp + require;
1841         } else {
1842             if (cp == (char*)-1) {      /* Out of memory */
1843 #ifdef DEBUGGING_MSTATS
1844                 goodsbrk -= require;
1845 #endif
1846                 return 0;
1847             }
1848             /* Report the failure: */
1849             if (sbrked_remains)
1850                 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1851                              sbrked_remains, 0);
1852             add_to_chain((void*)cp, require, 0);
1853             sbrk_goodness -= SBRK_FAILURE_PRICE;
1854             sbrked_remains = 0;
1855             last_sbrk_top = 0;
1856             last_op = 0;
1857             return 0;
1858         }
1859     }
1860             
1861     return 1;
1862 }
1863
1864 /*
1865  * Allocate more memory to the indicated bucket.
1866  */
1867 static void
1868 morecore(register int bucket)
1869 {
1870         register union overhead *ovp;
1871         register int rnu;       /* 2^rnu bytes will be requested */
1872         int nblks;              /* become nblks blocks of the desired size */
1873         register MEM_SIZE siz, needed;
1874         static int were_called = 0;
1875
1876         if (nextf[bucket])
1877                 return;
1878 #ifndef NO_PERL_MALLOC_ENV
1879         if (!were_called) {
1880             /* It's the our first time.  Initialize ourselves */
1881             were_called = 1;    /* Avoid a loop */
1882             if (!MallocCfg[MallocCfg_skip_cfg_env]) {
1883                 char *s = getenv("PERL_MALLOC_OPT"), *t = s, *off;
1884                 const char *opts = PERL_MALLOC_OPT_CHARS;
1885                 int changed = 0;
1886
1887                 while ( t && t[0] && t[1] == '='
1888                         && ((off = strchr(opts, *t))) ) {
1889                     IV val = 0;
1890
1891                     t += 2;
1892                     while (*t <= '9' && *t >= '0')
1893                         val = 10*val + *t++ - '0';
1894                     if (!*t || *t == ';') {
1895                         if (MallocCfg[off - opts] != val)
1896                             changed = 1;
1897                         MallocCfg[off - opts] = val;
1898                         if (*t)
1899                             t++;
1900                     }
1901                 }
1902                 if (t && *t) {
1903                     write2("Unrecognized part of PERL_MALLOC_OPT: `");
1904                     write2(t);
1905                     write2("'\n");
1906                 }
1907                 if (changed)
1908                     MallocCfg[MallocCfg_cfg_env_read] = 1;
1909             }
1910         }
1911 #endif
1912         if (bucket == sizeof(MEM_SIZE)*8*BUCKETS_PER_POW2) {
1913             MALLOC_UNLOCK;
1914             croak("%s", "Out of memory during ridiculously large request");
1915         }
1916         if (bucket > max_bucket)
1917             max_bucket = bucket;
1918
1919         rnu = ( (bucket <= (LOG_OF_MIN_ARENA << BUCKET_POW2_SHIFT)) 
1920                 ? LOG_OF_MIN_ARENA 
1921                 : (bucket >> BUCKET_POW2_SHIFT) );
1922         /* This may be overwritten later: */
1923         nblks = 1 << (rnu - (bucket >> BUCKET_POW2_SHIFT)); /* how many blocks to get */
1924         needed = ((MEM_SIZE)1 << rnu) + POW2_OPTIMIZE_SURPLUS(bucket);
1925         if (nextf[rnu << BUCKET_POW2_SHIFT]) { /* 2048b bucket. */
1926             ovp = nextf[rnu << BUCKET_POW2_SHIFT] - 1 + CHUNK_SHIFT;
1927             nextf[rnu << BUCKET_POW2_SHIFT]
1928                 = nextf[rnu << BUCKET_POW2_SHIFT]->ov_next;
1929 #ifdef DEBUGGING_MSTATS
1930             nmalloc[rnu << BUCKET_POW2_SHIFT]--;
1931             start_slack -= M_OVERHEAD;
1932 #endif 
1933             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1934                                   "stealing %ld bytes from %ld arena\n",
1935                                   (long) needed, (long) rnu << BUCKET_POW2_SHIFT));
1936         } else if (chunk_chain 
1937                    && (ovp = (union overhead*) get_from_chain(needed))) {
1938             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1939                                   "stealing %ld bytes from chain\n",
1940                                   (long) needed));
1941         } else if ( (ovp = (union overhead*)
1942                      get_from_bigger_buckets((rnu << BUCKET_POW2_SHIFT) + 1,
1943                                              needed)) ) {
1944             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1945                                   "stealing %ld bytes from bigger buckets\n",
1946                                   (long) needed));
1947         } else if (needed <= sbrked_remains) {
1948             ovp = (union overhead *)(last_sbrk_top - sbrked_remains);
1949             sbrked_remains -= needed;
1950             last_op = (char*)ovp;
1951         } else 
1952             ovp = getpages(needed, &nblks, bucket);
1953
1954         if (!ovp)
1955             return;
1956         FILL_DEADBEEF((unsigned char*)ovp, needed);
1957
1958         /*
1959          * Add new memory allocated to that on
1960          * free list for this hash bucket.
1961          */
1962         siz = BUCKET_SIZE_NO_SURPLUS(bucket); /* No surplus if nblks > 1 */
1963 #ifdef PACK_MALLOC
1964         *(u_char*)ovp = bucket; /* Fill index. */
1965         if (bucket <= MAX_PACKED) {
1966             ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1967             nblks = N_BLKS(bucket);
1968 #  ifdef DEBUGGING_MSTATS
1969             start_slack += BLK_SHIFT(bucket);
1970 #  endif
1971         } else if (bucket < LOG_OF_MIN_ARENA * BUCKETS_PER_POW2) {
1972             ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1973             siz -= sizeof(union overhead);
1974         } else ovp++;           /* One chunk per block. */
1975 #endif /* PACK_MALLOC */
1976         nextf[bucket] = ovp;
1977 #ifdef DEBUGGING_MSTATS
1978         nmalloc[bucket] += nblks;
1979         if (bucket > MAX_PACKED) {
1980             start_slack += M_OVERHEAD * nblks;
1981         }
1982 #endif 
1983
1984         while (--nblks > 0) {
1985                 ovp->ov_next = (union overhead *)((caddr_t)ovp + siz);
1986                 ovp = (union overhead *)((caddr_t)ovp + siz);
1987         }
1988         /* Not all sbrks return zeroed memory.*/
1989         ovp->ov_next = (union overhead *)NULL;
1990 #ifdef PACK_MALLOC
1991         if (bucket == 7*BUCKETS_PER_POW2) { /* Special case, explanation is above. */
1992             union overhead *n_op = nextf[7*BUCKETS_PER_POW2]->ov_next;
1993             nextf[7*BUCKETS_PER_POW2] = 
1994                 (union overhead *)((caddr_t)nextf[7*BUCKETS_PER_POW2] 
1995                                    - sizeof(union overhead));
1996             nextf[7*BUCKETS_PER_POW2]->ov_next = n_op;
1997         }
1998 #endif /* !PACK_MALLOC */
1999 }
2000
2001 Free_t
2002 Perl_mfree(void *mp)
2003 {
2004         register MEM_SIZE size;
2005         register union overhead *ovp;
2006         char *cp = (char*)mp;
2007 #ifdef PACK_MALLOC
2008         u_char bucket;
2009 #endif 
2010
2011         DEBUG_m(PerlIO_printf(Perl_debug_log, 
2012                               "0x%"UVxf": (%05lu) free\n",
2013                               PTR2UV(cp), (unsigned long)(PL_an++)));
2014
2015         if (cp == NULL)
2016                 return;
2017 #ifdef DEBUGGING
2018         if (PTR2UV(cp) & (MEM_ALIGNBYTES - 1))
2019             croak("%s", "wrong alignment in free()");
2020 #endif
2021         ovp = (union overhead *)((caddr_t)cp 
2022                                 - sizeof (union overhead) * CHUNK_SHIFT);
2023 #ifdef PACK_MALLOC
2024         bucket = OV_INDEX(ovp);
2025 #endif 
2026 #ifdef IGNORE_SMALL_BAD_FREE
2027         if ((bucket >= FIRST_BUCKET_WITH_CHECK) 
2028             && (OV_MAGIC(ovp, bucket) != MAGIC))
2029 #else
2030         if (OV_MAGIC(ovp, bucket) != MAGIC)
2031 #endif 
2032             {
2033                 static int bad_free_warn = -1;
2034                 if (bad_free_warn == -1) {
2035                     dTHX;
2036                     char *pbf = PerlEnv_getenv("PERL_BADFREE");
2037                     bad_free_warn = (pbf) ? atoi(pbf) : 1;
2038                 }
2039                 if (!bad_free_warn)
2040                     return;
2041 #ifdef RCHECK
2042 #ifdef PERL_CORE
2043                 {
2044                     dTHX;
2045                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
2046                         Perl_warner(aTHX_ packWARN(WARN_MALLOC), "%s free() ignored (RMAGIC, PERL_CORE)",
2047                                     ovp->ov_rmagic == RMAGIC - 1 ?
2048                                     "Duplicate" : "Bad");
2049                 }
2050 #else
2051                 warn("%s free() ignored (RMAGIC)",
2052                     ovp->ov_rmagic == RMAGIC - 1 ? "Duplicate" : "Bad");
2053 #endif          
2054 #else
2055 #ifdef PERL_CORE
2056                 {
2057                     dTHX;
2058                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
2059                         Perl_warner(aTHX_ packWARN(WARN_MALLOC), "%s", "Bad free() ignored (PERL_CORE)");
2060                 }
2061 #else
2062                 warn("%s", "Bad free() ignored");
2063 #endif
2064 #endif
2065                 return;                         /* sanity */
2066             }
2067 #ifdef RCHECK
2068         ASSERT(ovp->ov_rmagic == RMAGIC, "chunk's head overwrite");
2069         if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
2070             int i;
2071             MEM_SIZE nbytes = ovp->ov_size + 1;
2072
2073             if ((i = nbytes & (RMAGIC_SZ-1))) {
2074                 i = RMAGIC_SZ - i;
2075                 while (i--) {   /* nbytes - RMAGIC_SZ is end of alloced area */
2076                     ASSERT(((caddr_t)ovp + nbytes - RMAGIC_SZ)[i] == RMAGIC_C,
2077                            "chunk's tail overwrite");
2078                 }
2079             }
2080             /* Same at RMAGIC_SZ-aligned RMAGIC */
2081             nbytes = (nbytes + (RMAGIC_SZ-1)) & ~(RMAGIC_SZ-1);
2082             ASSERT(((u_int *)((caddr_t)ovp + nbytes))[-1] == RMAGIC,
2083                    "chunk's tail overwrite");       
2084             FILLCHECK_DEADBEEF((unsigned char*)((caddr_t)ovp + nbytes),
2085                                BUCKET_SIZE(OV_INDEX(ovp)) - nbytes);
2086         }
2087         FILL_DEADBEEF((unsigned char*)(ovp+CHUNK_SHIFT),
2088                       BUCKET_SIZE_REAL(OV_INDEX(ovp)) + RMAGIC_SZ);
2089         ovp->ov_rmagic = RMAGIC - 1;
2090 #endif
2091         ASSERT(OV_INDEX(ovp) < NBUCKETS, "chunk's head overwrite");
2092         size = OV_INDEX(ovp);
2093
2094         MALLOC_LOCK;
2095         ovp->ov_next = nextf[size];
2096         nextf[size] = ovp;
2097         MALLOC_UNLOCK;
2098 }
2099
2100 /* There is no need to do any locking in realloc (with an exception of
2101    trying to grow in place if we are at the end of the chain).
2102    If somebody calls us from a different thread with the same address,
2103    we are sole anyway.  */
2104
2105 Malloc_t
2106 Perl_realloc(void *mp, size_t nbytes)
2107 {
2108         register MEM_SIZE onb;
2109         union overhead *ovp;
2110         char *res;
2111         int prev_bucket;
2112         register int bucket;
2113         int incr;               /* 1 if does not fit, -1 if "easily" fits in a
2114                                    smaller bucket, otherwise 0.  */
2115         char *cp = (char*)mp;
2116
2117 #if defined(DEBUGGING) || !defined(PERL_CORE)
2118         MEM_SIZE size = nbytes;
2119
2120         if ((long)nbytes < 0)
2121             croak("%s", "panic: realloc");
2122 #endif
2123
2124         BARK_64K_LIMIT("Reallocation",nbytes,size);
2125         if (!cp)
2126                 return Perl_malloc(nbytes);
2127
2128         ovp = (union overhead *)((caddr_t)cp 
2129                                 - sizeof (union overhead) * CHUNK_SHIFT);
2130         bucket = OV_INDEX(ovp);
2131
2132 #ifdef IGNORE_SMALL_BAD_FREE
2133         if ((bucket >= FIRST_BUCKET_WITH_CHECK) 
2134             && (OV_MAGIC(ovp, bucket) != MAGIC))
2135 #else
2136         if (OV_MAGIC(ovp, bucket) != MAGIC)
2137 #endif 
2138             {
2139                 static int bad_free_warn = -1;
2140                 if (bad_free_warn == -1) {
2141                     dTHX;
2142                     char *pbf = PerlEnv_getenv("PERL_BADFREE");
2143                     bad_free_warn = (pbf) ? atoi(pbf) : 1;
2144                 }
2145                 if (!bad_free_warn)
2146                     return Nullch;
2147 #ifdef RCHECK
2148 #ifdef PERL_CORE
2149                 {
2150                     dTHX;
2151                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
2152                         Perl_warner(aTHX_ packWARN(WARN_MALLOC), "%srealloc() %signored",
2153                                     (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
2154                                     ovp->ov_rmagic == RMAGIC - 1
2155                                     ? "of freed memory " : "");
2156                 }
2157 #else
2158                 warn2("%srealloc() %signored",
2159                       (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
2160                       ovp->ov_rmagic == RMAGIC - 1 ? "of freed memory " : "");
2161 #endif
2162 #else
2163 #ifdef PERL_CORE
2164                 {
2165                     dTHX;
2166                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
2167                         Perl_warner(aTHX_ packWARN(WARN_MALLOC), "%s",
2168                                     "Bad realloc() ignored");
2169                 }
2170 #else
2171                 warn("%s", "Bad realloc() ignored");
2172 #endif
2173 #endif
2174                 return Nullch;                  /* sanity */
2175             }
2176
2177         onb = BUCKET_SIZE_REAL(bucket);
2178         /* 
2179          *  avoid the copy if same size block.
2180          *  We are not agressive with boundary cases. Note that it might
2181          *  (for a small number of cases) give false negative if
2182          *  both new size and old one are in the bucket for
2183          *  FIRST_BIG_POW2, but the new one is near the lower end.
2184          *
2185          *  We do not try to go to 1.5 times smaller bucket so far.
2186          */
2187         if (nbytes > onb) incr = 1;
2188         else {
2189 #ifdef DO_NOT_TRY_HARDER_WHEN_SHRINKING
2190             if ( /* This is a little bit pessimal if PACK_MALLOC: */
2191                 nbytes > ( (onb >> 1) - M_OVERHEAD )
2192 #  ifdef TWO_POT_OPTIMIZE
2193                 || (bucket == FIRST_BIG_POW2 && nbytes >= LAST_SMALL_BOUND )
2194 #  endif        
2195                 )
2196 #else  /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
2197                 prev_bucket = ( (bucket > MAX_PACKED + 1) 
2198                                 ? bucket - BUCKETS_PER_POW2
2199                                 : bucket - 1);
2200              if (nbytes > BUCKET_SIZE_REAL(prev_bucket))
2201 #endif /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
2202                  incr = 0;
2203              else incr = -1;
2204         }
2205 #ifdef STRESS_REALLOC
2206         goto hard_way;
2207 #endif
2208         if (incr == 0) {
2209           inplace_label:
2210 #ifdef RCHECK
2211                 /*
2212                  * Record new allocated size of block and
2213                  * bound space with magic numbers.
2214                  */
2215                 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
2216                        int i, nb = ovp->ov_size + 1;
2217
2218                        if ((i = nb & (RMAGIC_SZ-1))) {
2219                            i = RMAGIC_SZ - i;
2220                            while (i--) { /* nb - RMAGIC_SZ is end of alloced area */
2221                                ASSERT(((caddr_t)ovp + nb - RMAGIC_SZ)[i] == RMAGIC_C, "chunk's tail overwrite");
2222                            }
2223                        }
2224                        /* Same at RMAGIC_SZ-aligned RMAGIC */
2225                        nb = (nb + (RMAGIC_SZ-1)) & ~(RMAGIC_SZ-1);
2226                        ASSERT(((u_int *)((caddr_t)ovp + nb))[-1] == RMAGIC,
2227                               "chunk's tail overwrite");
2228                        FILLCHECK_DEADBEEF((unsigned char*)((caddr_t)ovp + nb),
2229                                           BUCKET_SIZE(OV_INDEX(ovp)) - nb);
2230                        if (nbytes > ovp->ov_size + 1 - M_OVERHEAD)
2231                            FILL_FEEDADAD((unsigned char*)cp + ovp->ov_size + 1 - M_OVERHEAD,
2232                                      nbytes - (ovp->ov_size + 1 - M_OVERHEAD));
2233                        else
2234                            FILL_DEADBEEF((unsigned char*)cp + nbytes,
2235                                          nb - M_OVERHEAD + RMAGIC_SZ - nbytes);
2236                         /*
2237                          * Convert amount of memory requested into
2238                          * closest block size stored in hash buckets
2239                          * which satisfies request.  Account for
2240                          * space used per block for accounting.
2241                          */
2242                         nbytes += M_OVERHEAD;
2243                         ovp->ov_size = nbytes - 1;
2244                         if ((i = nbytes & (RMAGIC_SZ-1))) {
2245                             i = RMAGIC_SZ - i;
2246                             while (i--) /* nbytes - RMAGIC_SZ is end of alloced area */
2247                                 ((caddr_t)ovp + nbytes - RMAGIC_SZ)[i]
2248                                     = RMAGIC_C;
2249                         }
2250                         /* Same at RMAGIC_SZ-aligned RMAGIC */
2251                         nbytes = (nbytes + (RMAGIC_SZ-1)) & ~(RMAGIC_SZ - 1);
2252                         ((u_int *)((caddr_t)ovp + nbytes))[-1] = RMAGIC;
2253                 }
2254 #endif
2255                 res = cp;
2256                 DEBUG_m(PerlIO_printf(Perl_debug_log, 
2257                               "0x%"UVxf": (%05lu) realloc %ld bytes inplace\n",
2258                               PTR2UV(res),(unsigned long)(PL_an++),
2259                               (long)size));
2260         } else if (incr == 1 && (cp - M_OVERHEAD == last_op) 
2261                    && (onb > (1 << LOG_OF_MIN_ARENA))) {
2262             MEM_SIZE require, newarena = nbytes, pow;
2263             int shiftr;
2264
2265             POW2_OPTIMIZE_ADJUST(newarena);
2266             newarena = newarena + M_OVERHEAD;
2267             /* newarena = (newarena + 3) &~ 3; */
2268             shiftr = (newarena - 1) >> LOG_OF_MIN_ARENA;
2269             pow = LOG_OF_MIN_ARENA + 1;
2270             /* apart from this loop, this is O(1) */
2271             while (shiftr >>= 1)
2272                 pow++;
2273             newarena = (1 << pow) + POW2_OPTIMIZE_SURPLUS(pow * BUCKETS_PER_POW2);
2274             require = newarena - onb - M_OVERHEAD;
2275             
2276             MALLOC_LOCK;
2277             if (cp - M_OVERHEAD == last_op /* We *still* are the last chunk */
2278                 && getpages_adjacent(require)) {
2279 #ifdef DEBUGGING_MSTATS
2280                 nmalloc[bucket]--;
2281                 nmalloc[pow * BUCKETS_PER_POW2]++;
2282 #endif      
2283                 *(cp - M_OVERHEAD) = pow * BUCKETS_PER_POW2; /* Fill index. */
2284                 MALLOC_UNLOCK;
2285                 goto inplace_label;
2286             } else {
2287                 MALLOC_UNLOCK;          
2288                 goto hard_way;
2289             }
2290         } else {
2291           hard_way:
2292             DEBUG_m(PerlIO_printf(Perl_debug_log, 
2293                               "0x%"UVxf": (%05lu) realloc %ld bytes the hard way\n",
2294                               PTR2UV(cp),(unsigned long)(PL_an++),
2295                               (long)size));
2296             if ((res = (char*)Perl_malloc(nbytes)) == NULL)
2297                 return (NULL);
2298             if (cp != res)                      /* common optimization */
2299                 Copy(cp, res, (MEM_SIZE)(nbytes<onb?nbytes:onb), char);
2300             Perl_mfree(cp);
2301         }
2302         return ((Malloc_t)res);
2303 }
2304
2305 Malloc_t
2306 Perl_calloc(register size_t elements, register size_t size)
2307 {
2308     long sz = elements * size;
2309     Malloc_t p = Perl_malloc(sz);
2310
2311     if (p) {
2312         memset((void*)p, 0, sz);
2313     }
2314     return p;
2315 }
2316
2317 char *
2318 Perl_strdup(const char *s)
2319 {
2320     MEM_SIZE l = strlen(s);
2321     char *s1 = (char *)Perl_malloc(l+1);
2322
2323     return CopyD(s, s1, (MEM_SIZE)(l+1), char);
2324 }
2325
2326 #ifdef PERL_CORE
2327 int
2328 Perl_putenv(char *a)
2329 {
2330     /* Sometimes system's putenv conflicts with my_setenv() - this is system
2331        malloc vs Perl's free(). */
2332   dTHX;
2333   char *var;
2334   char *val = a;
2335   MEM_SIZE l;
2336   char buf[80];
2337
2338   while (*val && *val != '=')
2339       val++;
2340   if (!*val)
2341       return -1;
2342   l = val - a;
2343   if (l < sizeof(buf))
2344       var = buf;
2345   else
2346       var = Perl_malloc(l + 1);
2347   Copy(a, var, l, char);
2348   var[l + 1] = 0;
2349   my_setenv(var, val+1);
2350   if (var != buf)
2351       Perl_mfree(var);
2352   return 0;
2353 }
2354 #  endif
2355
2356 MEM_SIZE
2357 Perl_malloced_size(void *p)
2358 {
2359     union overhead *ovp = (union overhead *)
2360         ((caddr_t)p - sizeof (union overhead) * CHUNK_SHIFT);
2361     int bucket = OV_INDEX(ovp);
2362 #ifdef RCHECK
2363     /* The caller wants to have a complete control over the chunk,
2364        disable the memory checking inside the chunk.  */
2365     if (bucket <= MAX_SHORT_BUCKET) {
2366         MEM_SIZE size = BUCKET_SIZE_REAL(bucket);
2367         ovp->ov_size = size + M_OVERHEAD - 1;
2368         *((u_int *)((caddr_t)ovp + size + M_OVERHEAD - RMAGIC_SZ)) = RMAGIC;
2369     }
2370 #endif
2371     return BUCKET_SIZE_REAL(bucket);
2372 }
2373
2374 #  ifdef BUCKETS_ROOT2
2375 #    define MIN_EVEN_REPORT 6
2376 #  else
2377 #    define MIN_EVEN_REPORT MIN_BUCKET
2378 #  endif 
2379
2380 int
2381 Perl_get_mstats(pTHX_ perl_mstats_t *buf, int buflen, int level)
2382 {
2383 #ifdef DEBUGGING_MSTATS
2384         register int i, j;
2385         register union overhead *p;
2386         struct chunk_chain_s* nextchain;
2387
2388         buf->topbucket = buf->topbucket_ev = buf->topbucket_odd 
2389             = buf->totfree = buf->total = buf->total_chain = 0;
2390
2391         buf->minbucket = MIN_BUCKET;
2392         MALLOC_LOCK;
2393         for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
2394                 for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
2395                         ;
2396                 if (i < buflen) {
2397                     buf->nfree[i] = j;
2398                     buf->ntotal[i] = nmalloc[i];
2399                 }               
2400                 buf->totfree += j * BUCKET_SIZE_REAL(i);
2401                 buf->total += nmalloc[i] * BUCKET_SIZE_REAL(i);
2402                 if (nmalloc[i]) {
2403                     i % 2 ? (buf->topbucket_odd = i) : (buf->topbucket_ev = i);
2404                     buf->topbucket = i;
2405                 }
2406         }
2407         nextchain = chunk_chain;
2408         while (nextchain) {
2409             buf->total_chain += nextchain->size;
2410             nextchain = nextchain->next;
2411         }
2412         buf->total_sbrk = goodsbrk + sbrk_slack;
2413         buf->sbrks = sbrks;
2414         buf->sbrk_good = sbrk_goodness;
2415         buf->sbrk_slack = sbrk_slack;
2416         buf->start_slack = start_slack;
2417         buf->sbrked_remains = sbrked_remains;
2418         MALLOC_UNLOCK;
2419         buf->nbuckets = NBUCKETS;
2420         if (level) {
2421             for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
2422                 if (i >= buflen)
2423                     break;
2424                 buf->bucket_mem_size[i] = BUCKET_SIZE_NO_SURPLUS(i);
2425                 buf->bucket_available_size[i] = BUCKET_SIZE_REAL(i);
2426             }
2427         }
2428 #endif  /* defined DEBUGGING_MSTATS */
2429         return 0;               /* XXX unused */
2430 }
2431 /*
2432  * mstats - print out statistics about malloc
2433  * 
2434  * Prints two lines of numbers, one showing the length of the free list
2435  * for each size category, the second showing the number of mallocs -
2436  * frees for each size category.
2437  */
2438 void
2439 Perl_dump_mstats(pTHX_ char *s)
2440 {
2441 #ifdef DEBUGGING_MSTATS
2442         register int i;
2443         perl_mstats_t buffer;
2444         UV nf[NBUCKETS];
2445         UV nt[NBUCKETS];
2446
2447         buffer.nfree  = nf;
2448         buffer.ntotal = nt;
2449         get_mstats(&buffer, NBUCKETS, 0);
2450
2451         if (s)
2452             PerlIO_printf(Perl_error_log,
2453                           "Memory allocation statistics %s (buckets %"IVdf"(%"IVdf")..%"IVdf"(%"IVdf")\n",
2454                           s, 
2455                           (IV)BUCKET_SIZE_REAL(MIN_BUCKET), 
2456                           (IV)BUCKET_SIZE_NO_SURPLUS(MIN_BUCKET),
2457                           (IV)BUCKET_SIZE_REAL(buffer.topbucket), 
2458                           (IV)BUCKET_SIZE_NO_SURPLUS(buffer.topbucket));
2459         PerlIO_printf(Perl_error_log, "%8"IVdf" free:", buffer.totfree);
2460         for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
2461                 PerlIO_printf(Perl_error_log, 
2462                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2463                                ? " %5"UVuf 
2464                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"UVuf : " %"UVuf)),
2465                               buffer.nfree[i]);
2466         }
2467 #ifdef BUCKETS_ROOT2
2468         PerlIO_printf(Perl_error_log, "\n\t   ");
2469         for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
2470                 PerlIO_printf(Perl_error_log, 
2471                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2472                                ? " %5"UVuf 
2473                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"UVuf : " %"UVuf)),
2474                               buffer.nfree[i]);
2475         }
2476 #endif 
2477         PerlIO_printf(Perl_error_log, "\n%8"IVdf" used:", buffer.total - buffer.totfree);
2478         for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
2479                 PerlIO_printf(Perl_error_log, 
2480                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2481                                ? " %5"IVdf
2482                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"IVdf : " %"IVdf)), 
2483                               buffer.ntotal[i] - buffer.nfree[i]);
2484         }
2485 #ifdef BUCKETS_ROOT2
2486         PerlIO_printf(Perl_error_log, "\n\t   ");
2487         for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
2488                 PerlIO_printf(Perl_error_log, 
2489                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2490                                ? " %5"IVdf 
2491                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"IVdf : " %"IVdf)),
2492                               buffer.ntotal[i] - buffer.nfree[i]);
2493         }
2494 #endif 
2495         PerlIO_printf(Perl_error_log, "\nTotal sbrk(): %"IVdf"/%"IVdf":%"IVdf". Odd ends: pad+heads+chain+tail: %"IVdf"+%"IVdf"+%"IVdf"+%"IVdf".\n",
2496                       buffer.total_sbrk, buffer.sbrks, buffer.sbrk_good,
2497                       buffer.sbrk_slack, buffer.start_slack,
2498                       buffer.total_chain, buffer.sbrked_remains);
2499 #endif /* DEBUGGING_MSTATS */
2500 }
2501 #endif /* lint */
2502
2503 #ifdef USE_PERL_SBRK
2504
2505 #   if defined(__MACHTEN_PPC__) || defined(NeXT) || defined(__NeXT__) || defined(PURIFY)
2506 #      define PERL_SBRK_VIA_MALLOC
2507 #   endif
2508
2509 #   ifdef PERL_SBRK_VIA_MALLOC
2510
2511 /* it may seem schizophrenic to use perl's malloc and let it call system */
2512 /* malloc, the reason for that is only the 3.2 version of the OS that had */
2513 /* frequent core dumps within nxzonefreenolock. This sbrk routine put an */
2514 /* end to the cores */
2515
2516 #      ifndef SYSTEM_ALLOC
2517 #         define SYSTEM_ALLOC(a) malloc(a)
2518 #      endif
2519 #      ifndef SYSTEM_ALLOC_ALIGNMENT
2520 #         define SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
2521 #      endif
2522
2523 #   endif  /* PERL_SBRK_VIA_MALLOC */
2524
2525 static IV Perl_sbrk_oldchunk;
2526 static long Perl_sbrk_oldsize;
2527
2528 #   define PERLSBRK_32_K (1<<15)
2529 #   define PERLSBRK_64_K (1<<16)
2530
2531 Malloc_t
2532 Perl_sbrk(int size)
2533 {
2534     IV got;
2535     int small, reqsize;
2536
2537     if (!size) return 0;
2538 #ifdef PERL_CORE
2539     reqsize = size; /* just for the DEBUG_m statement */
2540 #endif
2541 #ifdef PACK_MALLOC
2542     size = (size + 0x7ff) & ~0x7ff;
2543 #endif
2544     if (size <= Perl_sbrk_oldsize) {
2545         got = Perl_sbrk_oldchunk;
2546         Perl_sbrk_oldchunk += size;
2547         Perl_sbrk_oldsize -= size;
2548     } else {
2549       if (size >= PERLSBRK_32_K) {
2550         small = 0;
2551       } else {
2552         size = PERLSBRK_64_K;
2553         small = 1;
2554       }
2555 #  if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2556       size += NEEDED_ALIGNMENT - SYSTEM_ALLOC_ALIGNMENT;
2557 #  endif
2558       got = (IV)SYSTEM_ALLOC(size);
2559 #  if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2560       got = (got + NEEDED_ALIGNMENT - 1) & ~(NEEDED_ALIGNMENT - 1);
2561 #  endif
2562       if (small) {
2563         /* Chunk is small, register the rest for future allocs. */
2564         Perl_sbrk_oldchunk = got + reqsize;
2565         Perl_sbrk_oldsize = size - reqsize;
2566       }
2567     }
2568
2569     DEBUG_m(PerlIO_printf(Perl_debug_log, "sbrk malloc size %ld (reqsize %ld), left size %ld, give addr 0x%"UVxf"\n",
2570                     size, reqsize, Perl_sbrk_oldsize, PTR2UV(got)));
2571
2572     return (void *)got;
2573 }
2574
2575 #endif /* ! defined USE_PERL_SBRK */
2576
2577 /*
2578  * Local variables:
2579  * c-indentation-style: bsd
2580  * c-basic-offset: 4
2581  * indent-tabs-mode: t
2582  * End:
2583  *
2584  * ex: set ts=8 sts=4 sw=4 noet:
2585  */