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