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