This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
The new tests are valid only for IEEE 754 64-bit doubles.
[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                                ? buck_size[i]                           \
470                                : ((1 << ((i) >> BUCKET_POW2_SHIFT))     \
471                                   - MEM_OVERHEAD(i)                     \
472                                   + POW2_OPTIMIZE_SURPLUS(i)))
473 #else
474 #  define BUCKET_SIZE_NO_SURPLUS(i) (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 ? 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    ((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) 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 #else
826 # ifndef HAS_SBRK_PROTO /* <unistd.h> usually takes care of this */
827 extern  Malloc_t sbrk(int);
828 # endif
829 #endif
830
831 #ifndef MIN_SBRK_FRAC1000       /* Backward compatibility */
832 #  define MIN_SBRK_FRAC1000     (MIN_SBRK_FRAC * 10)
833 #endif
834
835 #ifndef START_EXTERN_C
836 #  ifdef __cplusplus
837 #    define START_EXTERN_C      extern "C" {
838 #  else
839 #    define START_EXTERN_C
840 #  endif
841 #endif
842
843 #ifndef END_EXTERN_C
844 #  ifdef __cplusplus
845 #    define END_EXTERN_C                };
846 #  else
847 #    define END_EXTERN_C
848 #  endif
849 #endif
850
851 #include "malloc_ctl.h"
852
853 #ifndef NO_MALLOC_DYNAMIC_CFG
854 #  define PERL_MALLOC_OPT_CHARS "FMfAPGdac"
855
856 #  ifndef FILL_DEAD_DEFAULT
857 #    define FILL_DEAD_DEFAULT   1
858 #  endif
859 #  ifndef FILL_ALIVE_DEFAULT
860 #    define FILL_ALIVE_DEFAULT  1
861 #  endif
862 #  ifndef FILL_CHECK_DEFAULT
863 #    define FILL_CHECK_DEFAULT  1
864 #  endif
865
866 static IV MallocCfg[MallocCfg_last] = {
867   FIRST_SBRK,
868   MIN_SBRK,
869   MIN_SBRK_FRAC,
870   SBRK_ALLOW_FAILURES,
871   SBRK_FAILURE_PRICE,
872   SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE,     /* sbrk_goodness */
873   FILL_DEAD_DEFAULT,    /* FILL_DEAD */
874   FILL_ALIVE_DEFAULT,   /* FILL_ALIVE */
875   FILL_CHECK_DEFAULT,   /* FILL_CHECK */
876   0,                    /* MallocCfg_skip_cfg_env */
877   0,                    /* MallocCfg_cfg_env_read */
878   0,                    /* MallocCfg_emergency_buffer_size */
879   0,                    /* MallocCfg_emergency_buffer_prepared_size */
880   0                     /* MallocCfg_emergency_buffer_last_req */
881 };
882 IV *MallocCfg_ptr = MallocCfg;
883
884 static char* MallocCfgP[MallocCfg_last] = {
885   0,                    /* MallocCfgP_emergency_buffer */
886   0,                    /* MallocCfgP_emergency_buffer_prepared */
887 };
888 char **MallocCfgP_ptr = MallocCfgP;
889
890 #  undef MIN_SBRK
891 #  undef FIRST_SBRK
892 #  undef MIN_SBRK_FRAC1000
893 #  undef SBRK_ALLOW_FAILURES
894 #  undef SBRK_FAILURE_PRICE
895
896 #  define MIN_SBRK              MallocCfg[MallocCfg_MIN_SBRK]
897 #  define FIRST_SBRK            MallocCfg[MallocCfg_FIRST_SBRK]
898 #  define MIN_SBRK_FRAC1000     MallocCfg[MallocCfg_MIN_SBRK_FRAC1000]
899 #  define SBRK_ALLOW_FAILURES   MallocCfg[MallocCfg_SBRK_ALLOW_FAILURES]
900 #  define SBRK_FAILURE_PRICE    MallocCfg[MallocCfg_SBRK_FAILURE_PRICE]
901
902 #  define sbrk_goodness         MallocCfg[MallocCfg_sbrk_goodness]
903
904 #  define emergency_buffer_size MallocCfg[MallocCfg_emergency_buffer_size]
905 #  define emergency_buffer_last_req     MallocCfg[MallocCfg_emergency_buffer_last_req]
906
907 #  define FILL_DEAD             MallocCfg[MallocCfg_filldead]
908 #  define FILL_ALIVE            MallocCfg[MallocCfg_fillalive]
909 #  define FILL_CHECK_CFG        MallocCfg[MallocCfg_fillcheck]
910 #  define FILL_CHECK            (FILL_DEAD && FILL_CHECK_CFG)
911
912 #  define emergency_buffer      MallocCfgP[MallocCfgP_emergency_buffer]
913 #  define emergency_buffer_prepared     MallocCfgP[MallocCfgP_emergency_buffer_prepared]
914
915 #else   /* defined(NO_MALLOC_DYNAMIC_CFG) */
916
917 #  define FILL_DEAD     1
918 #  define FILL_ALIVE    1
919 #  define FILL_CHECK    1
920 static int sbrk_goodness = SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE;
921
922 #  define NO_PERL_MALLOC_ENV
923
924 #endif
925
926 #ifdef DEBUGGING_MSTATS
927 /*
928  * nmalloc[i] is the difference between the number of mallocs and frees
929  * for a given block size.
930  */
931 static  u_int nmalloc[NBUCKETS];
932 static  u_int sbrk_slack;
933 static  u_int start_slack;
934 #else   /* !( defined DEBUGGING_MSTATS ) */
935 #  define sbrk_slack    0
936 #endif
937
938 static  u_int goodsbrk;
939
940 #ifdef PERL_EMERGENCY_SBRK
941
942 #  ifndef BIG_SIZE
943 #    define BIG_SIZE (1<<16)            /* 64K */
944 #  endif
945
946 #  ifdef NO_MALLOC_DYNAMIC_CFG
947 static MEM_SIZE emergency_buffer_size;
948         /* 0 if the last request for more memory succeeded.
949            Otherwise the size of the failing request. */
950 static MEM_SIZE emergency_buffer_last_req;
951 static char *emergency_buffer;
952 static char *emergency_buffer_prepared;
953 #  endif
954
955 #  ifndef emergency_sbrk_croak
956 #    define emergency_sbrk_croak        croak2
957 #  endif
958
959 static char *
960 perl_get_emergency_buffer(IV *size)
961 {
962     dTHX;
963     /* First offense, give a possibility to recover by dieing. */
964     /* No malloc involved here: */
965     SV *sv;
966     char *pv;
967     GV **gvp = (GV**)hv_fetchs(PL_defstash, "^M", FALSE);
968
969     if (!gvp) gvp = (GV**)hv_fetchs(PL_defstash, "\015", FALSE);
970     if (!gvp || !(sv = GvSV(*gvp)) || !SvPOK(sv) 
971         || (SvLEN(sv) < (1<<LOG_OF_MIN_ARENA) - M_OVERHEAD))
972         return NULL;            /* Now die die die... */
973     /* Got it, now detach SvPV: */
974     pv = SvPV_nolen(sv);
975     /* Check alignment: */
976     if ((PTR2UV(pv) - sizeof(union overhead)) & (NEEDED_ALIGNMENT - 1)) {
977         PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
978         return NULL;            /* die die die */
979     }
980
981     SvPOK_off(sv);
982     SvPV_set(sv, NULL);
983     SvCUR_set(sv, 0);
984     SvLEN_set(sv, 0);
985     *size = malloced_size(pv) + M_OVERHEAD;
986     return pv - sizeof(union overhead);
987 }
988 #  define PERL_GET_EMERGENCY_BUFFER(p)  perl_get_emergency_buffer(p)
989
990 #  ifndef NO_MALLOC_DYNAMIC_CFG
991 static char *
992 get_emergency_buffer(IV *size)
993 {
994     char *pv = emergency_buffer_prepared;
995
996     *size = MallocCfg[MallocCfg_emergency_buffer_prepared_size];
997     emergency_buffer_prepared = 0;
998     MallocCfg[MallocCfg_emergency_buffer_prepared_size] = 0;
999     return pv;
1000 }
1001
1002 #    define GET_EMERGENCY_BUFFER(p)     get_emergency_buffer(p)
1003 #  else         /* NO_MALLOC_DYNAMIC_CFG */
1004 #    define GET_EMERGENCY_BUFFER(p)     NULL
1005 #  endif
1006
1007 static Malloc_t
1008 emergency_sbrk(MEM_SIZE size)
1009 {
1010     MEM_SIZE rsize = (((size - 1)>>LOG_OF_MIN_ARENA) + 1)<<LOG_OF_MIN_ARENA;
1011
1012     if (size >= BIG_SIZE
1013         && (!emergency_buffer_last_req ||
1014             (size < (MEM_SIZE)emergency_buffer_last_req))) {
1015         /* Give the possibility to recover, but avoid an infinite cycle. */
1016         MALLOC_UNLOCK;
1017         emergency_buffer_last_req = size;
1018         emergency_sbrk_croak("Out of memory during \"large\" request for %"UVuf" bytes, total sbrk() is %"UVuf" bytes", (UV)size, (UV)(goodsbrk + sbrk_slack));
1019     }
1020
1021     if ((MEM_SIZE)emergency_buffer_size >= rsize) {
1022         char *old = emergency_buffer;
1023         
1024         emergency_buffer_size -= rsize;
1025         emergency_buffer += rsize;
1026         return old;
1027     } else {            
1028         /* First offense, give a possibility to recover by dieing. */
1029         /* No malloc involved here: */
1030         IV Size;
1031         char *pv = GET_EMERGENCY_BUFFER(&Size);
1032         int have = 0;
1033
1034         if (emergency_buffer_size) {
1035             add_to_chain(emergency_buffer, emergency_buffer_size, 0);
1036             emergency_buffer_size = 0;
1037             emergency_buffer = NULL;
1038             have = 1;
1039         }
1040
1041         if (!pv)
1042             pv = PERL_GET_EMERGENCY_BUFFER(&Size);
1043         if (!pv) {
1044             if (have)
1045                 goto do_croak;
1046             return (char *)-1;          /* Now die die die... */
1047         }
1048
1049         /* Check alignment: */
1050         if (PTR2UV(pv) & (NEEDED_ALIGNMENT - 1)) {
1051             dTHX;
1052
1053             PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
1054             return (char *)-1;          /* die die die */
1055         }
1056
1057         emergency_buffer = pv;
1058         emergency_buffer_size = Size;
1059     }
1060   do_croak:
1061     MALLOC_UNLOCK;
1062     emergency_sbrk_croak("Out of memory during request for %"UVuf" bytes, total sbrk() is %"UVuf" bytes", (UV)size, (UV)(goodsbrk + sbrk_slack));
1063     NOT_REACHED; /* NOTREACHED */
1064     return NULL;
1065 }
1066
1067 #else /*  !defined(PERL_EMERGENCY_SBRK) */
1068 #  define emergency_sbrk(size)  -1
1069 #endif  /* defined PERL_EMERGENCY_SBRK */
1070
1071 /* Don't use PerlIO buffered writes as they allocate memory. */
1072 #define MYMALLOC_WRITE2STDERR(s) PERL_UNUSED_RESULT(PerlLIO_write(PerlIO_fileno(PerlIO_stderr()),s,strlen(s)))
1073
1074 #ifdef DEBUGGING
1075 #undef ASSERT
1076 #define ASSERT(p,diag)   if (!(p)) botch(diag,STRINGIFY(p),__FILE__,__LINE__);
1077
1078 static void
1079 botch(const char *diag, const char *s, const char *file, int line)
1080 {
1081     dVAR;
1082     dTHX;
1083     if (!(PERL_MAYBE_ALIVE && PERL_GET_THX))
1084         goto do_write;
1085     else {
1086         if (PerlIO_printf(PerlIO_stderr(),
1087                           "assertion botched (%s?): %s %s:%d\n",
1088                           diag, s, file, line) != 0) {
1089          do_write:              /* Can be initializing interpreter */
1090             MYMALLOC_WRITE2STDERR("assertion botched (");
1091             MYMALLOC_WRITE2STDERR(diag);
1092             MYMALLOC_WRITE2STDERR("?): ");
1093             MYMALLOC_WRITE2STDERR(s);
1094             MYMALLOC_WRITE2STDERR(" (");
1095             MYMALLOC_WRITE2STDERR(file);
1096             MYMALLOC_WRITE2STDERR(":");
1097             {
1098               char linebuf[10];
1099               char *s = linebuf + sizeof(linebuf) - 1;
1100               int n = line;
1101               *s = 0;
1102               do {
1103                 *--s = '0' + (n % 10);
1104               } while (n /= 10);
1105               MYMALLOC_WRITE2STDERR(s);
1106             }
1107             MYMALLOC_WRITE2STDERR(")\n");
1108         }
1109         PerlProc_abort();
1110     }
1111 }
1112 #else
1113 #define ASSERT(p, diag)
1114 #endif
1115
1116 #ifdef MALLOC_FILL
1117 /* Fill should be long enough to cover long */
1118 static void
1119 fill_pat_4bytes(unsigned char *s, size_t nbytes, const unsigned char *fill)
1120 {
1121     unsigned char *e = s + nbytes;
1122     long *lp;
1123     const long lfill = *(long*)fill;
1124
1125     if (PTR2UV(s) & (sizeof(long)-1)) {         /* Align the pattern */
1126         int shift = sizeof(long) - (PTR2UV(s) & (sizeof(long)-1));
1127         unsigned const char *f = fill + sizeof(long) - shift;
1128         unsigned char *e1 = s + shift;
1129
1130         while (s < e1)
1131             *s++ = *f++;
1132     }
1133     lp = (long*)s;
1134     while ((unsigned char*)(lp + 1) <= e)
1135         *lp++ = lfill;
1136     s = (unsigned char*)lp;
1137     while (s < e)
1138         *s++ = *fill++;
1139 }
1140 /* Just malloc()ed */
1141 static const unsigned char fill_feedadad[] =
1142  {0xFE, 0xED, 0xAD, 0xAD, 0xFE, 0xED, 0xAD, 0xAD,
1143   0xFE, 0xED, 0xAD, 0xAD, 0xFE, 0xED, 0xAD, 0xAD};
1144 /* Just free()ed */
1145 static const unsigned char fill_deadbeef[] =
1146  {0xDE, 0xAD, 0xBE, 0xEF, 0xDE, 0xAD, 0xBE, 0xEF,
1147   0xDE, 0xAD, 0xBE, 0xEF, 0xDE, 0xAD, 0xBE, 0xEF};
1148 #  define FILL_DEADBEEF(s, n)   \
1149         (void)(FILL_DEAD?  (fill_pat_4bytes((s), (n), fill_deadbeef), 0) : 0)
1150 #  define FILL_FEEDADAD(s, n)   \
1151         (void)(FILL_ALIVE? (fill_pat_4bytes((s), (n), fill_feedadad), 0) : 0)
1152 #else
1153 #  define FILL_DEADBEEF(s, n)   ((void)0)
1154 #  define FILL_FEEDADAD(s, n)   ((void)0)
1155 #  undef MALLOC_FILL_CHECK
1156 #endif
1157
1158 #ifdef MALLOC_FILL_CHECK
1159 static int
1160 cmp_pat_4bytes(unsigned char *s, size_t nbytes, const unsigned char *fill)
1161 {
1162     unsigned char *e = s + nbytes;
1163     long *lp;
1164     const long lfill = *(long*)fill;
1165
1166     if (PTR2UV(s) & (sizeof(long)-1)) {         /* Align the pattern */
1167         int shift = sizeof(long) - (PTR2UV(s) & (sizeof(long)-1));
1168         unsigned const char *f = fill + sizeof(long) - shift;
1169         unsigned char *e1 = s + shift;
1170
1171         while (s < e1)
1172             if (*s++ != *f++)
1173                 return 1;
1174     }
1175     lp = (long*)s;
1176     while ((unsigned char*)(lp + 1) <= e)
1177         if (*lp++ != lfill)
1178             return 1;
1179     s = (unsigned char*)lp;
1180     while (s < e)
1181         if (*s++ != *fill++)
1182             return 1;
1183     return 0;
1184 }
1185 #  define FILLCHECK_DEADBEEF(s, n)                                      \
1186         ASSERT(!FILL_CHECK || !cmp_pat_4bytes(s, n, fill_deadbeef),     \
1187                "free()ed/realloc()ed-away memory was overwritten")
1188 #else
1189 #  define FILLCHECK_DEADBEEF(s, n)      ((void)0)
1190 #endif
1191
1192 STATIC int
1193 S_adjust_size_and_find_bucket(size_t *nbytes_p)
1194 {
1195         MEM_SIZE shiftr;
1196         int bucket;
1197         size_t nbytes;
1198
1199         PERL_ARGS_ASSERT_ADJUST_SIZE_AND_FIND_BUCKET;
1200
1201         nbytes = *nbytes_p;
1202
1203         /*
1204          * Convert amount of memory requested into
1205          * closest block size stored in hash buckets
1206          * which satisfies request.  Account for
1207          * space used per block for accounting.
1208          */
1209 #ifdef PACK_MALLOC
1210 #  ifdef SMALL_BUCKET_VIA_TABLE
1211         if (nbytes == 0)
1212             bucket = MIN_BUCKET;
1213         else if (nbytes <= SIZE_TABLE_MAX) {
1214             bucket = bucket_of[(nbytes - 1) >> BUCKET_TABLE_SHIFT];
1215         } else
1216 #  else
1217         if (nbytes == 0)
1218             nbytes = 1;
1219         if (nbytes <= MAX_POW2_ALGO) goto do_shifts;
1220         else
1221 #  endif
1222 #endif 
1223         {
1224             POW2_OPTIMIZE_ADJUST(nbytes);
1225             nbytes += M_OVERHEAD;
1226             nbytes = (nbytes + 3) &~ 3; 
1227 #if defined(PACK_MALLOC) && !defined(SMALL_BUCKET_VIA_TABLE)
1228           do_shifts:
1229 #endif
1230             shiftr = (nbytes - 1) >> START_SHIFT;
1231             bucket = START_SHIFTS_BUCKET;
1232             /* apart from this loop, this is O(1) */
1233             while (shiftr >>= 1)
1234                 bucket += BUCKETS_PER_POW2;
1235         }
1236         *nbytes_p = nbytes;
1237         return bucket;
1238 }
1239
1240 Malloc_t
1241 Perl_malloc(size_t nbytes)
1242 {
1243         dVAR;
1244         union overhead *p;
1245         int bucket;
1246
1247 #if defined(DEBUGGING) || defined(RCHECK)
1248         MEM_SIZE size = nbytes;
1249 #endif
1250
1251         BARK_64K_LIMIT("Allocation",nbytes,nbytes);
1252 #ifdef DEBUGGING
1253         if ((long)nbytes < 0)
1254             croak("%s", "panic: malloc");
1255 #endif
1256
1257         bucket = adjust_size_and_find_bucket(&nbytes);
1258         MALLOC_LOCK;
1259         /*
1260          * If nothing in hash bucket right now,
1261          * request more memory from the system.
1262          */
1263         if (nextf[bucket] == NULL)    
1264                 morecore(bucket);
1265         if ((p = nextf[bucket]) == NULL) {
1266                 MALLOC_UNLOCK;
1267                 {
1268                     dTHX;
1269                     if (!PL_nomemok) {
1270 #if defined(PLAIN_MALLOC) && defined(NO_FANCY_MALLOC)
1271                         MYMALLOC_WRITE2STDERR("Out of memory!\n");
1272 #else
1273                         char buff[80];
1274                         char *eb = buff + sizeof(buff) - 1;
1275                         char *s = eb;
1276                         size_t n = nbytes;
1277
1278                         MYMALLOC_WRITE2STDERR("Out of memory during request for ");
1279 #if defined(DEBUGGING) || defined(RCHECK)
1280                         n = size;
1281 #endif
1282                         *s = 0;                 
1283                         do {
1284                             *--s = '0' + (n % 10);
1285                         } while (n /= 10);
1286                         MYMALLOC_WRITE2STDERR(s);
1287                         MYMALLOC_WRITE2STDERR(" bytes, total sbrk() is ");
1288                         s = eb;
1289                         n = goodsbrk + sbrk_slack;
1290                         do {
1291                             *--s = '0' + (n % 10);
1292                         } while (n /= 10);
1293                         MYMALLOC_WRITE2STDERR(s);
1294                         MYMALLOC_WRITE2STDERR(" bytes!\n");
1295 #endif /* defined(PLAIN_MALLOC) && defined(NO_FANCY_MALLOC) */
1296                         my_exit(1);
1297                     }
1298                 }
1299                 return (NULL);
1300         }
1301
1302         /* remove from linked list */
1303 #ifdef DEBUGGING
1304         if ( (PTR2UV(p) & (MEM_ALIGNBYTES - 1))
1305                                                 /* Can't get this low */
1306              || (p && PTR2UV(p) < (1<<LOG_OF_MIN_ARENA)) ) {
1307             dTHX;
1308             PerlIO_printf(PerlIO_stderr(),
1309                           "Unaligned pointer in the free chain 0x%"UVxf"\n",
1310                           PTR2UV(p));
1311         }
1312         if ( (PTR2UV(p->ov_next) & (MEM_ALIGNBYTES - 1))
1313              || (p->ov_next && PTR2UV(p->ov_next) < (1<<LOG_OF_MIN_ARENA)) ) {
1314             dTHX;
1315             PerlIO_printf(PerlIO_stderr(),
1316                           "Unaligned \"next\" pointer in the free "
1317                           "chain 0x%"UVxf" at 0x%"UVxf"\n",
1318                           PTR2UV(p->ov_next), PTR2UV(p));
1319         }
1320 #endif
1321         nextf[bucket] = p->ov_next;
1322
1323         MALLOC_UNLOCK;
1324
1325         DEBUG_m(PerlIO_printf(Perl_debug_log,
1326                               "0x%"UVxf": (%05lu) malloc %ld bytes\n",
1327                               PTR2UV((Malloc_t)(p + CHUNK_SHIFT)), (unsigned long)(PL_an++),
1328                               (long)size));
1329
1330         FILLCHECK_DEADBEEF((unsigned char*)(p + CHUNK_SHIFT),
1331                            BUCKET_SIZE_REAL(bucket) + RMAGIC_SZ);
1332
1333 #ifdef IGNORE_SMALL_BAD_FREE
1334         if (bucket >= FIRST_BUCKET_WITH_CHECK)
1335 #endif 
1336             OV_MAGIC(p, bucket) = MAGIC;
1337 #ifndef PACK_MALLOC
1338         OV_INDEX(p) = bucket;
1339 #endif
1340 #ifdef RCHECK
1341         /*
1342          * Record allocated size of block and
1343          * bound space with magic numbers.
1344          */
1345         p->ov_rmagic = RMAGIC;
1346         if (bucket <= MAX_SHORT_BUCKET) {
1347             int i;
1348             
1349             nbytes = size + M_OVERHEAD; 
1350             p->ov_size = nbytes - 1;
1351             if ((i = nbytes & (RMAGIC_SZ-1))) {
1352                 i = RMAGIC_SZ - i;
1353                 while (i--) /* nbytes - RMAGIC_SZ is end of alloced area */
1354                     ((caddr_t)p + nbytes - RMAGIC_SZ)[i] = RMAGIC_C;
1355             }
1356             /* Same at RMAGIC_SZ-aligned RMAGIC */
1357             nbytes = (nbytes + RMAGIC_SZ - 1) & ~(RMAGIC_SZ - 1);
1358             ((u_int *)((caddr_t)p + nbytes))[-1] = RMAGIC;
1359         }
1360         FILL_FEEDADAD((unsigned char *)(p + CHUNK_SHIFT), size);
1361 #endif
1362         return ((Malloc_t)(p + CHUNK_SHIFT));
1363 }
1364
1365 static char *last_sbrk_top;
1366 static char *last_op;                   /* This arena can be easily extended. */
1367 static MEM_SIZE sbrked_remains;
1368
1369 #ifdef DEBUGGING_MSTATS
1370 static int sbrks;
1371 #endif 
1372
1373 struct chunk_chain_s {
1374     struct chunk_chain_s *next;
1375     MEM_SIZE size;
1376 };
1377 static struct chunk_chain_s *chunk_chain;
1378 static int n_chunks;
1379 static char max_bucket;
1380
1381 /* Cutoff a piece of one of the chunks in the chain.  Prefer smaller chunk. */
1382 static void *
1383 get_from_chain(MEM_SIZE size)
1384 {
1385     struct chunk_chain_s *elt = chunk_chain, **oldp = &chunk_chain;
1386     struct chunk_chain_s **oldgoodp = NULL;
1387     long min_remain = LONG_MAX;
1388
1389     while (elt) {
1390         if (elt->size >= size) {
1391             long remains = elt->size - size;
1392             if (remains >= 0 && remains < min_remain) {
1393                 oldgoodp = oldp;
1394                 min_remain = remains;
1395             }
1396             if (remains == 0) {
1397                 break;
1398             }
1399         }
1400         oldp = &( elt->next );
1401         elt = elt->next;
1402     }
1403     if (!oldgoodp) return NULL;
1404     if (min_remain) {
1405         void *ret = *oldgoodp;
1406         struct chunk_chain_s *next = (*oldgoodp)->next;
1407         
1408         *oldgoodp = (struct chunk_chain_s *)((char*)ret + size);
1409         (*oldgoodp)->size = min_remain;
1410         (*oldgoodp)->next = next;
1411         return ret;
1412     } else {
1413         void *ret = *oldgoodp;
1414         *oldgoodp = (*oldgoodp)->next;
1415         n_chunks--;
1416         return ret;
1417     }
1418 }
1419
1420 static void
1421 add_to_chain(void *p, MEM_SIZE size, MEM_SIZE chip)
1422 {
1423     struct chunk_chain_s *next = chunk_chain;
1424     char *cp = (char*)p;
1425     
1426     cp += chip;
1427     chunk_chain = (struct chunk_chain_s *)cp;
1428     chunk_chain->size = size - chip;
1429     chunk_chain->next = next;
1430     n_chunks++;
1431 }
1432
1433 static void *
1434 get_from_bigger_buckets(int bucket, MEM_SIZE size)
1435 {
1436     int price = 1;
1437     static int bucketprice[NBUCKETS];
1438     while (bucket <= max_bucket) {
1439         /* We postpone stealing from bigger buckets until we want it
1440            often enough. */
1441         if (nextf[bucket] && bucketprice[bucket]++ >= price) {
1442             /* Steal it! */
1443             void *ret = (void*)(nextf[bucket] - 1 + CHUNK_SHIFT);
1444             bucketprice[bucket] = 0;
1445             if (((char*)nextf[bucket]) - M_OVERHEAD == last_op) {
1446                 last_op = NULL;         /* Disable optimization */
1447             }
1448             nextf[bucket] = nextf[bucket]->ov_next;
1449 #ifdef DEBUGGING_MSTATS
1450             nmalloc[bucket]--;
1451             start_slack -= M_OVERHEAD;
1452 #endif 
1453             add_to_chain(ret, (BUCKET_SIZE_NO_SURPLUS(bucket) +
1454                                POW2_OPTIMIZE_SURPLUS(bucket)), 
1455                          size);
1456             return ret;
1457         }
1458         bucket++;
1459     }
1460     return NULL;
1461 }
1462
1463 static union overhead *
1464 getpages(MEM_SIZE needed, int *nblksp, int bucket)
1465 {
1466     dVAR;
1467     /* Need to do (possibly expensive) system call. Try to
1468        optimize it for rare calling. */
1469     MEM_SIZE require = needed - sbrked_remains;
1470     char *cp;
1471     union overhead *ovp;
1472     MEM_SIZE slack = 0;
1473
1474     if (sbrk_goodness > 0) {
1475         if (!last_sbrk_top && require < (MEM_SIZE)FIRST_SBRK) 
1476             require = FIRST_SBRK;
1477         else if (require < (MEM_SIZE)MIN_SBRK) require = MIN_SBRK;
1478
1479         if (require < (Size_t)(goodsbrk * MIN_SBRK_FRAC1000 / 1000))
1480             require = goodsbrk * MIN_SBRK_FRAC1000 / 1000;
1481         require = ((require - 1 + MIN_SBRK) / MIN_SBRK) * MIN_SBRK;
1482     } else {
1483         require = needed;
1484         last_sbrk_top = 0;
1485         sbrked_remains = 0;
1486     }
1487
1488     DEBUG_m(PerlIO_printf(Perl_debug_log, 
1489                           "sbrk(%ld) for %ld-byte-long arena\n",
1490                           (long)require, (long) needed));
1491     cp = (char *)sbrk(require);
1492 #ifdef DEBUGGING_MSTATS
1493     sbrks++;
1494 #endif 
1495     if (cp == last_sbrk_top) {
1496         /* Common case, anything is fine. */
1497         sbrk_goodness++;
1498         ovp = (union overhead *) (cp - sbrked_remains);
1499         last_op = cp - sbrked_remains;
1500         sbrked_remains = require - (needed - sbrked_remains);
1501     } else if (cp == (char *)-1) { /* no more room! */
1502         ovp = (union overhead *)emergency_sbrk(needed);
1503         if (ovp == (union overhead *)-1)
1504             return 0;
1505         if (((char*)ovp) > last_op) {   /* Cannot happen with current emergency_sbrk() */
1506             last_op = 0;
1507         }
1508         return ovp;
1509     } else {                    /* Non-continuous or first sbrk(). */
1510         long add = sbrked_remains;
1511         char *newcp;
1512
1513         if (sbrked_remains) {   /* Put rest into chain, we
1514                                    cannot use it right now. */
1515             add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1516                          sbrked_remains, 0);
1517         }
1518
1519         /* Second, check alignment. */
1520         slack = 0;
1521
1522         /* WANTED_ALIGNMENT may be more than NEEDED_ALIGNMENT, but this may
1523            improve performance of memory access. */
1524         if (PTR2UV(cp) & (WANTED_ALIGNMENT - 1)) { /* Not aligned. */
1525             slack = WANTED_ALIGNMENT - (PTR2UV(cp) & (WANTED_ALIGNMENT - 1));
1526             add += slack;
1527         }
1528                 
1529         if (add) {
1530             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1531                                   "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",
1532                                   (long)add, (long) slack,
1533                                   (long) sbrked_remains));
1534             newcp = (char *)sbrk(add);
1535 #if defined(DEBUGGING_MSTATS)
1536             sbrks++;
1537             sbrk_slack += add;
1538 #endif
1539             if (newcp != cp + require) {
1540                 /* Too bad: even rounding sbrk() is not continuous.*/
1541                 DEBUG_m(PerlIO_printf(Perl_debug_log, 
1542                                       "failed to fix bad sbrk()\n"));
1543 #ifdef PACK_MALLOC
1544                 if (slack) {
1545                     MALLOC_UNLOCK;
1546                     fatalcroak("panic: Off-page sbrk\n");
1547                 }
1548 #endif
1549                 if (sbrked_remains) {
1550                     /* Try again. */
1551 #if defined(DEBUGGING_MSTATS)
1552                     sbrk_slack += require;
1553 #endif
1554                     require = needed;
1555                     DEBUG_m(PerlIO_printf(Perl_debug_log, 
1556                                           "straight sbrk(%ld)\n",
1557                                           (long)require));
1558                     cp = (char *)sbrk(require);
1559 #ifdef DEBUGGING_MSTATS
1560                     sbrks++;
1561 #endif 
1562                     if (cp == (char *)-1)
1563                         return 0;
1564                 }
1565                 sbrk_goodness = -1;     /* Disable optimization!
1566                                    Continue with not-aligned... */
1567             } else {
1568                 cp += slack;
1569                 require += sbrked_remains;
1570             }
1571         }
1572
1573         if (last_sbrk_top) {
1574             sbrk_goodness -= SBRK_FAILURE_PRICE;
1575         }
1576
1577         ovp = (union overhead *) cp;
1578         /*
1579          * Round up to minimum allocation size boundary
1580          * and deduct from block count to reflect.
1581          */
1582
1583 #  if NEEDED_ALIGNMENT > MEM_ALIGNBYTES
1584         if (PTR2UV(ovp) & (NEEDED_ALIGNMENT - 1))
1585             fatalcroak("Misalignment of sbrk()\n");
1586         else
1587 #  endif
1588         if (PTR2UV(ovp) & (MEM_ALIGNBYTES - 1)) {
1589             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1590                                   "fixing sbrk(): %d bytes off machine alignment\n",
1591                                   (int)(PTR2UV(ovp) & (MEM_ALIGNBYTES - 1))));
1592             ovp = INT2PTR(union overhead *,(PTR2UV(ovp) + MEM_ALIGNBYTES) &
1593                                      (MEM_ALIGNBYTES - 1));
1594             (*nblksp)--;
1595 # if defined(DEBUGGING_MSTATS)
1596             /* This is only approx. if TWO_POT_OPTIMIZE: */
1597             sbrk_slack += (1 << (bucket >> BUCKET_POW2_SHIFT));
1598 # endif
1599         }
1600         ;                               /* Finish "else" */
1601         sbrked_remains = require - needed;
1602         last_op = cp;
1603     }
1604 #if !defined(PLAIN_MALLOC) && !defined(NO_FANCY_MALLOC)
1605     emergency_buffer_last_req = 0;
1606 #endif
1607     last_sbrk_top = cp + require;
1608 #ifdef DEBUGGING_MSTATS
1609     goodsbrk += require;
1610 #endif  
1611     return ovp;
1612 }
1613
1614 static int
1615 getpages_adjacent(MEM_SIZE require)
1616 {           
1617     if (require <= sbrked_remains) {
1618         sbrked_remains -= require;
1619     } else {
1620         char *cp;
1621
1622         require -= sbrked_remains;
1623         /* We do not try to optimize sbrks here, we go for place. */
1624         cp = (char*) sbrk(require);
1625 #ifdef DEBUGGING_MSTATS
1626         sbrks++;
1627         goodsbrk += require;
1628 #endif 
1629         if (cp == last_sbrk_top) {
1630             sbrked_remains = 0;
1631             last_sbrk_top = cp + require;
1632         } else {
1633             if (cp == (char*)-1) {      /* Out of memory */
1634 #ifdef DEBUGGING_MSTATS
1635                 goodsbrk -= require;
1636 #endif
1637                 return 0;
1638             }
1639             /* Report the failure: */
1640             if (sbrked_remains)
1641                 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1642                              sbrked_remains, 0);
1643             add_to_chain((void*)cp, require, 0);
1644             sbrk_goodness -= SBRK_FAILURE_PRICE;
1645             sbrked_remains = 0;
1646             last_sbrk_top = 0;
1647             last_op = 0;
1648             return 0;
1649         }
1650     }
1651             
1652     return 1;
1653 }
1654
1655 /*
1656  * Allocate more memory to the indicated bucket.
1657  */
1658 static void
1659 morecore(int bucket)
1660 {
1661         dVAR;
1662         union overhead *ovp;
1663         int rnu;       /* 2^rnu bytes will be requested */
1664         int nblks;              /* become nblks blocks of the desired size */
1665         MEM_SIZE siz, needed;
1666         static int were_called = 0;
1667
1668         if (nextf[bucket])
1669                 return;
1670 #ifndef NO_PERL_MALLOC_ENV
1671         if (!were_called) {
1672             /* It's the our first time.  Initialize ourselves */
1673             were_called = 1;    /* Avoid a loop */
1674             if (!MallocCfg[MallocCfg_skip_cfg_env]) {
1675                 char *s = getenv("PERL_MALLOC_OPT"), *t = s, *off;
1676                 const char *opts = PERL_MALLOC_OPT_CHARS;
1677                 int changed = 0;
1678
1679                 while ( t && t[0] && t[1] == '='
1680                         && ((off = strchr(opts, *t))) ) {
1681                     IV val = 0;
1682
1683                     t += 2;
1684                     while (*t <= '9' && *t >= '0')
1685                         val = 10*val + *t++ - '0';
1686                     if (!*t || *t == ';') {
1687                         if (MallocCfg[off - opts] != val)
1688                             changed = 1;
1689                         MallocCfg[off - opts] = val;
1690                         if (*t)
1691                             t++;
1692                     }
1693                 }
1694                 if (t && *t) {
1695                     dTHX;
1696                     MYMALLOC_WRITE2STDERR("Unrecognized part of PERL_MALLOC_OPT: \"");
1697                     MYMALLOC_WRITE2STDERR(t);
1698                     MYMALLOC_WRITE2STDERR("\"\n");
1699                 }
1700                 if (changed)
1701                     MallocCfg[MallocCfg_cfg_env_read] = 1;
1702             }
1703         }
1704 #endif
1705         if (bucket == sizeof(MEM_SIZE)*8*BUCKETS_PER_POW2) {
1706             MALLOC_UNLOCK;
1707             croak("%s", "Out of memory during ridiculously large request");
1708         }
1709         if (bucket > max_bucket)
1710             max_bucket = bucket;
1711
1712         rnu = ( (bucket <= (LOG_OF_MIN_ARENA << BUCKET_POW2_SHIFT)) 
1713                 ? LOG_OF_MIN_ARENA 
1714                 : (bucket >> BUCKET_POW2_SHIFT) );
1715         /* This may be overwritten later: */
1716         nblks = 1 << (rnu - (bucket >> BUCKET_POW2_SHIFT)); /* how many blocks to get */
1717         needed = ((MEM_SIZE)1 << rnu) + POW2_OPTIMIZE_SURPLUS(bucket);
1718         if (nextf[rnu << BUCKET_POW2_SHIFT]) { /* 2048b bucket. */
1719             ovp = nextf[rnu << BUCKET_POW2_SHIFT] - 1 + CHUNK_SHIFT;
1720             nextf[rnu << BUCKET_POW2_SHIFT]
1721                 = nextf[rnu << BUCKET_POW2_SHIFT]->ov_next;
1722 #ifdef DEBUGGING_MSTATS
1723             nmalloc[rnu << BUCKET_POW2_SHIFT]--;
1724             start_slack -= M_OVERHEAD;
1725 #endif 
1726             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1727                                   "stealing %ld bytes from %ld arena\n",
1728                                   (long) needed, (long) rnu << BUCKET_POW2_SHIFT));
1729         } else if (chunk_chain 
1730                    && (ovp = (union overhead*) get_from_chain(needed))) {
1731             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1732                                   "stealing %ld bytes from chain\n",
1733                                   (long) needed));
1734         } else if ( (ovp = (union overhead*)
1735                      get_from_bigger_buckets((rnu << BUCKET_POW2_SHIFT) + 1,
1736                                              needed)) ) {
1737             DEBUG_m(PerlIO_printf(Perl_debug_log, 
1738                                   "stealing %ld bytes from bigger buckets\n",
1739                                   (long) needed));
1740         } else if (needed <= sbrked_remains) {
1741             ovp = (union overhead *)(last_sbrk_top - sbrked_remains);
1742             sbrked_remains -= needed;
1743             last_op = (char*)ovp;
1744         } else 
1745             ovp = getpages(needed, &nblks, bucket);
1746
1747         if (!ovp)
1748             return;
1749         FILL_DEADBEEF((unsigned char*)ovp, needed);
1750
1751         /*
1752          * Add new memory allocated to that on
1753          * free list for this hash bucket.
1754          */
1755         siz = BUCKET_SIZE_NO_SURPLUS(bucket); /* No surplus if nblks > 1 */
1756 #ifdef PACK_MALLOC
1757         *(u_char*)ovp = bucket; /* Fill index. */
1758         if (bucket <= MAX_PACKED) {
1759             ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1760             nblks = N_BLKS(bucket);
1761 #  ifdef DEBUGGING_MSTATS
1762             start_slack += BLK_SHIFT(bucket);
1763 #  endif
1764         } else if (bucket < LOG_OF_MIN_ARENA * BUCKETS_PER_POW2) {
1765             ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1766             siz -= sizeof(union overhead);
1767         } else ovp++;           /* One chunk per block. */
1768 #endif /* PACK_MALLOC */
1769         nextf[bucket] = ovp;
1770 #ifdef DEBUGGING_MSTATS
1771         nmalloc[bucket] += nblks;
1772         if (bucket > MAX_PACKED) {
1773             start_slack += M_OVERHEAD * nblks;
1774         }
1775 #endif 
1776
1777         while (--nblks > 0) {
1778                 ovp->ov_next = (union overhead *)((caddr_t)ovp + siz);
1779                 ovp = (union overhead *)((caddr_t)ovp + siz);
1780         }
1781         /* Not all sbrks return zeroed memory.*/
1782         ovp->ov_next = (union overhead *)NULL;
1783 #ifdef PACK_MALLOC
1784         if (bucket == 7*BUCKETS_PER_POW2) { /* Special case, explanation is above. */
1785             union overhead *n_op = nextf[7*BUCKETS_PER_POW2]->ov_next;
1786             nextf[7*BUCKETS_PER_POW2] = 
1787                 (union overhead *)((caddr_t)nextf[7*BUCKETS_PER_POW2] 
1788                                    - sizeof(union overhead));
1789             nextf[7*BUCKETS_PER_POW2]->ov_next = n_op;
1790         }
1791 #endif /* !PACK_MALLOC */
1792 }
1793
1794 Free_t
1795 Perl_mfree(Malloc_t where)
1796 {
1797         dVAR;
1798         MEM_SIZE size;
1799         union overhead *ovp;
1800         char *cp = (char*)where;
1801 #ifdef PACK_MALLOC
1802         u_char bucket;
1803 #endif 
1804
1805         DEBUG_m(PerlIO_printf(Perl_debug_log, 
1806                               "0x%"UVxf": (%05lu) free\n",
1807                               PTR2UV(cp), (unsigned long)(PL_an++)));
1808
1809         if (cp == NULL)
1810                 return;
1811 #ifdef DEBUGGING
1812         if (PTR2UV(cp) & (MEM_ALIGNBYTES - 1))
1813             croak("%s", "wrong alignment in free()");
1814 #endif
1815         ovp = (union overhead *)((caddr_t)cp 
1816                                 - sizeof (union overhead) * CHUNK_SHIFT);
1817 #ifdef PACK_MALLOC
1818         bucket = OV_INDEX(ovp);
1819 #endif 
1820 #ifdef IGNORE_SMALL_BAD_FREE
1821         if ((bucket >= FIRST_BUCKET_WITH_CHECK) 
1822             && (OV_MAGIC(ovp, bucket) != MAGIC))
1823 #else
1824         if (OV_MAGIC(ovp, bucket) != MAGIC)
1825 #endif 
1826             {
1827                 static int bad_free_warn = -1;
1828                 if (bad_free_warn == -1) {
1829                     dTHX;
1830                     char *pbf = PerlEnv_getenv("PERL_BADFREE");
1831                     bad_free_warn = (pbf) ? strNE("0", pbf) : 1;
1832                 }
1833                 if (!bad_free_warn)
1834                     return;
1835 #ifdef RCHECK
1836                 {
1837                     dTHX;
1838                     if (!PERL_IS_ALIVE || !PL_curcop)
1839                         Perl_ck_warner_d(aTHX_ packWARN(WARN_MALLOC), "%s free() ignored (RMAGIC, PERL_CORE)",
1840                                          ovp->ov_rmagic == RMAGIC - 1 ?
1841                                          "Duplicate" : "Bad");
1842                 }
1843 #else
1844                 {
1845                     dTHX;
1846                     if (!PERL_IS_ALIVE || !PL_curcop)
1847                         Perl_ck_warner_d(aTHX_ packWARN(WARN_MALLOC), "%s", "Bad free() ignored (PERL_CORE)");
1848                 }
1849 #endif
1850                 return;                         /* sanity */
1851             }
1852 #ifdef RCHECK
1853         ASSERT(ovp->ov_rmagic == RMAGIC, "chunk's head overwrite");
1854         if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1855             int i;
1856             MEM_SIZE nbytes = ovp->ov_size + 1;
1857
1858             if ((i = nbytes & (RMAGIC_SZ-1))) {
1859                 i = RMAGIC_SZ - i;
1860                 while (i--) {   /* nbytes - RMAGIC_SZ is end of alloced area */
1861                     ASSERT(((caddr_t)ovp + nbytes - RMAGIC_SZ)[i] == RMAGIC_C,
1862                            "chunk's tail overwrite");
1863                 }
1864             }
1865             /* Same at RMAGIC_SZ-aligned RMAGIC */
1866             nbytes = (nbytes + (RMAGIC_SZ-1)) & ~(RMAGIC_SZ-1);
1867             ASSERT(((u_int *)((caddr_t)ovp + nbytes))[-1] == RMAGIC,
1868                    "chunk's tail overwrite");       
1869             FILLCHECK_DEADBEEF((unsigned char*)((caddr_t)ovp + nbytes),
1870                                BUCKET_SIZE(OV_INDEX(ovp)) - nbytes);
1871         }
1872         FILL_DEADBEEF((unsigned char*)(ovp+CHUNK_SHIFT),
1873                       BUCKET_SIZE_REAL(OV_INDEX(ovp)) + RMAGIC_SZ);
1874         ovp->ov_rmagic = RMAGIC - 1;
1875 #endif
1876         ASSERT(OV_INDEX(ovp) < NBUCKETS, "chunk's head overwrite");
1877         size = OV_INDEX(ovp);
1878
1879         MALLOC_LOCK;
1880         ovp->ov_next = nextf[size];
1881         nextf[size] = ovp;
1882         MALLOC_UNLOCK;
1883 }
1884
1885 /* There is no need to do any locking in realloc (with an exception of
1886    trying to grow in place if we are at the end of the chain).
1887    If somebody calls us from a different thread with the same address,
1888    we are sole anyway.  */
1889
1890 Malloc_t
1891 Perl_realloc(void *mp, size_t nbytes)
1892 {
1893         dVAR;
1894         MEM_SIZE onb;
1895         union overhead *ovp;
1896         char *res;
1897         int prev_bucket;
1898         int bucket;
1899         int incr;               /* 1 if does not fit, -1 if "easily" fits in a
1900                                    smaller bucket, otherwise 0.  */
1901         char *cp = (char*)mp;
1902
1903 #ifdef DEBUGGING
1904         MEM_SIZE size = nbytes;
1905
1906         if ((long)nbytes < 0)
1907             croak("%s", "panic: realloc");
1908 #endif
1909
1910         BARK_64K_LIMIT("Reallocation",nbytes,size);
1911         if (!cp)
1912                 return Perl_malloc(nbytes);
1913
1914         ovp = (union overhead *)((caddr_t)cp 
1915                                 - sizeof (union overhead) * CHUNK_SHIFT);
1916         bucket = OV_INDEX(ovp);
1917
1918 #ifdef IGNORE_SMALL_BAD_FREE
1919         if ((bucket >= FIRST_BUCKET_WITH_CHECK) 
1920             && (OV_MAGIC(ovp, bucket) != MAGIC))
1921 #else
1922         if (OV_MAGIC(ovp, bucket) != MAGIC)
1923 #endif 
1924             {
1925                 static int bad_free_warn = -1;
1926                 if (bad_free_warn == -1) {
1927                     dTHX;
1928                     char *pbf = PerlEnv_getenv("PERL_BADFREE");
1929                     bad_free_warn = (pbf) ? strNE("0", pbf) : 1;
1930                 }
1931                 if (!bad_free_warn)
1932                     return NULL;
1933 #ifdef RCHECK
1934                 {
1935                     dTHX;
1936                     if (!PERL_IS_ALIVE || !PL_curcop)
1937                         Perl_ck_warner_d(aTHX_ packWARN(WARN_MALLOC), "%srealloc() %signored",
1938                                          (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
1939                                          ovp->ov_rmagic == RMAGIC - 1
1940                                          ? "of freed memory " : "");
1941                 }
1942 #else
1943                 {
1944                     dTHX;
1945                     if (!PERL_IS_ALIVE || !PL_curcop)
1946                         Perl_ck_warner_d(aTHX_ packWARN(WARN_MALLOC), "%s",
1947                                          "Bad realloc() ignored");
1948                 }
1949 #endif
1950                 return NULL;                    /* sanity */
1951             }
1952
1953         onb = BUCKET_SIZE_REAL(bucket);
1954         /* 
1955          *  avoid the copy if same size block.
1956          *  We are not aggressive with boundary cases. Note that it might
1957          *  (for a small number of cases) give false negative if
1958          *  both new size and old one are in the bucket for
1959          *  FIRST_BIG_POW2, but the new one is near the lower end.
1960          *
1961          *  We do not try to go to 1.5 times smaller bucket so far.
1962          */
1963         if (nbytes > onb) incr = 1;
1964         else {
1965 #ifdef DO_NOT_TRY_HARDER_WHEN_SHRINKING
1966             if ( /* This is a little bit pessimal if PACK_MALLOC: */
1967                 nbytes > ( (onb >> 1) - M_OVERHEAD )
1968 #  ifdef TWO_POT_OPTIMIZE
1969                 || (bucket == FIRST_BIG_POW2 && nbytes >= LAST_SMALL_BOUND )
1970 #  endif        
1971                 )
1972 #else  /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1973                 prev_bucket = ( (bucket > MAX_PACKED + 1) 
1974                                 ? bucket - BUCKETS_PER_POW2
1975                                 : bucket - 1);
1976              if (nbytes > BUCKET_SIZE_REAL(prev_bucket))
1977 #endif /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1978                  incr = 0;
1979              else incr = -1;
1980         }
1981 #ifdef STRESS_REALLOC
1982         goto hard_way;
1983 #endif
1984         if (incr == 0) {
1985           inplace_label:
1986 #ifdef RCHECK
1987                 /*
1988                  * Record new allocated size of block and
1989                  * bound space with magic numbers.
1990                  */
1991                 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1992                        int i, nb = ovp->ov_size + 1;
1993
1994                        if ((i = nb & (RMAGIC_SZ-1))) {
1995                            i = RMAGIC_SZ - i;
1996                            while (i--) { /* nb - RMAGIC_SZ is end of alloced area */
1997                                ASSERT(((caddr_t)ovp + nb - RMAGIC_SZ)[i] == RMAGIC_C, "chunk's tail overwrite");
1998                            }
1999                        }
2000                        /* Same at RMAGIC_SZ-aligned RMAGIC */
2001                        nb = (nb + (RMAGIC_SZ-1)) & ~(RMAGIC_SZ-1);
2002                        ASSERT(((u_int *)((caddr_t)ovp + nb))[-1] == RMAGIC,
2003                               "chunk's tail overwrite");
2004                        FILLCHECK_DEADBEEF((unsigned char*)((caddr_t)ovp + nb),
2005                                           BUCKET_SIZE(OV_INDEX(ovp)) - nb);
2006                        if (nbytes > ovp->ov_size + 1 - M_OVERHEAD)
2007                            FILL_FEEDADAD((unsigned char*)cp + ovp->ov_size + 1 - M_OVERHEAD,
2008                                      nbytes - (ovp->ov_size + 1 - M_OVERHEAD));
2009                        else
2010                            FILL_DEADBEEF((unsigned char*)cp + nbytes,
2011                                          nb - M_OVERHEAD + RMAGIC_SZ - nbytes);
2012                         /*
2013                          * Convert amount of memory requested into
2014                          * closest block size stored in hash buckets
2015                          * which satisfies request.  Account for
2016                          * space used per block for accounting.
2017                          */
2018                         nbytes += M_OVERHEAD;
2019                         ovp->ov_size = nbytes - 1;
2020                         if ((i = nbytes & (RMAGIC_SZ-1))) {
2021                             i = RMAGIC_SZ - i;
2022                             while (i--) /* nbytes - RMAGIC_SZ is end of alloced area */
2023                                 ((caddr_t)ovp + nbytes - RMAGIC_SZ)[i]
2024                                     = RMAGIC_C;
2025                         }
2026                         /* Same at RMAGIC_SZ-aligned RMAGIC */
2027                         nbytes = (nbytes + (RMAGIC_SZ-1)) & ~(RMAGIC_SZ - 1);
2028                         ((u_int *)((caddr_t)ovp + nbytes))[-1] = RMAGIC;
2029                 }
2030 #endif
2031                 res = cp;
2032                 DEBUG_m(PerlIO_printf(Perl_debug_log, 
2033                               "0x%"UVxf": (%05lu) realloc %ld bytes inplace\n",
2034                               PTR2UV(res),(unsigned long)(PL_an++),
2035                               (long)size));
2036         } else if (incr == 1 && (cp - M_OVERHEAD == last_op) 
2037                    && (onb > (1 << LOG_OF_MIN_ARENA))) {
2038             MEM_SIZE require, newarena = nbytes, pow;
2039             int shiftr;
2040
2041             POW2_OPTIMIZE_ADJUST(newarena);
2042             newarena = newarena + M_OVERHEAD;
2043             /* newarena = (newarena + 3) &~ 3; */
2044             shiftr = (newarena - 1) >> LOG_OF_MIN_ARENA;
2045             pow = LOG_OF_MIN_ARENA + 1;
2046             /* apart from this loop, this is O(1) */
2047             while (shiftr >>= 1)
2048                 pow++;
2049             newarena = (1 << pow) + POW2_OPTIMIZE_SURPLUS(pow * BUCKETS_PER_POW2);
2050             require = newarena - onb - M_OVERHEAD;
2051             
2052             MALLOC_LOCK;
2053             if (cp - M_OVERHEAD == last_op /* We *still* are the last chunk */
2054                 && getpages_adjacent(require)) {
2055 #ifdef DEBUGGING_MSTATS
2056                 nmalloc[bucket]--;
2057                 nmalloc[pow * BUCKETS_PER_POW2]++;
2058 #endif      
2059                 if (pow * BUCKETS_PER_POW2 > (MEM_SIZE)max_bucket)
2060                     max_bucket = pow * BUCKETS_PER_POW2;
2061                 *(cp - M_OVERHEAD) = pow * BUCKETS_PER_POW2; /* Fill index. */
2062                 MALLOC_UNLOCK;
2063                 goto inplace_label;
2064             } else {
2065                 MALLOC_UNLOCK;          
2066                 goto hard_way;
2067             }
2068         } else {
2069           hard_way:
2070             DEBUG_m(PerlIO_printf(Perl_debug_log, 
2071                               "0x%"UVxf": (%05lu) realloc %ld bytes the hard way\n",
2072                               PTR2UV(cp),(unsigned long)(PL_an++),
2073                               (long)size));
2074             if ((res = (char*)Perl_malloc(nbytes)) == NULL)
2075                 return (NULL);
2076             if (cp != res)                      /* common optimization */
2077                 Copy(cp, res, (MEM_SIZE)(nbytes<onb?nbytes:onb), char);
2078             Perl_mfree(cp);
2079         }
2080         return ((Malloc_t)res);
2081 }
2082
2083 Malloc_t
2084 Perl_calloc(size_t elements, size_t size)
2085 {
2086     long sz = elements * size;
2087     Malloc_t p = Perl_malloc(sz);
2088
2089     if (p) {
2090         memset((void*)p, 0, sz);
2091     }
2092     return p;
2093 }
2094
2095 char *
2096 Perl_strdup(const char *s)
2097 {
2098     MEM_SIZE l = strlen(s);
2099     char *s1 = (char *)Perl_malloc(l+1);
2100
2101     return (char *)CopyD(s, s1, (MEM_SIZE)(l+1), char);
2102 }
2103
2104 int
2105 Perl_putenv(char *a)
2106 {
2107     /* Sometimes system's putenv conflicts with my_setenv() - this is system
2108        malloc vs Perl's free(). */
2109   dTHX;
2110   char *var;
2111   char *val = a;
2112   MEM_SIZE l;
2113   char buf[80];
2114
2115   while (*val && *val != '=')
2116       val++;
2117   if (!*val)
2118       return -1;
2119   l = val - a;
2120   if (l < sizeof(buf))
2121       var = buf;
2122   else
2123       var = (char *)Perl_malloc(l + 1);
2124   Copy(a, var, l, char);
2125   var[l + 1] = 0;
2126   my_setenv(var, val+1);
2127   if (var != buf)
2128       Perl_mfree(var);
2129   return 0;
2130 }
2131
2132 MEM_SIZE
2133 Perl_malloced_size(void *p)
2134 {
2135     union overhead * const ovp = (union overhead *)
2136         ((caddr_t)p - sizeof (union overhead) * CHUNK_SHIFT);
2137     const int bucket = OV_INDEX(ovp);
2138
2139     PERL_ARGS_ASSERT_MALLOCED_SIZE;
2140
2141 #ifdef RCHECK
2142     /* The caller wants to have a complete control over the chunk,
2143        disable the memory checking inside the chunk.  */
2144     if (bucket <= MAX_SHORT_BUCKET) {
2145         const MEM_SIZE size = BUCKET_SIZE_REAL(bucket);
2146         ovp->ov_size = size + M_OVERHEAD - 1;
2147         *((u_int *)((caddr_t)ovp + size + M_OVERHEAD - RMAGIC_SZ)) = RMAGIC;
2148     }
2149 #endif
2150     return BUCKET_SIZE_REAL(bucket);
2151 }
2152
2153
2154 MEM_SIZE
2155 Perl_malloc_good_size(size_t wanted)
2156 {
2157     return BUCKET_SIZE_REAL(adjust_size_and_find_bucket(&wanted));
2158 }
2159
2160 #  ifdef BUCKETS_ROOT2
2161 #    define MIN_EVEN_REPORT 6
2162 #  else
2163 #    define MIN_EVEN_REPORT MIN_BUCKET
2164 #  endif 
2165
2166 int
2167 Perl_get_mstats(pTHX_ perl_mstats_t *buf, int buflen, int level)
2168 {
2169 #ifdef DEBUGGING_MSTATS
2170         int i, j;
2171         union overhead *p;
2172         struct chunk_chain_s* nextchain;
2173
2174         PERL_ARGS_ASSERT_GET_MSTATS;
2175
2176         buf->topbucket = buf->topbucket_ev = buf->topbucket_odd 
2177             = buf->totfree = buf->total = buf->total_chain = 0;
2178
2179         buf->minbucket = MIN_BUCKET;
2180         MALLOC_LOCK;
2181         for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
2182                 for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
2183                         ;
2184                 if (i < buflen) {
2185                     buf->nfree[i] = j;
2186                     buf->ntotal[i] = nmalloc[i];
2187                 }               
2188                 buf->totfree += j * BUCKET_SIZE_REAL(i);
2189                 buf->total += nmalloc[i] * BUCKET_SIZE_REAL(i);
2190                 if (nmalloc[i]) {
2191                     i % 2 ? (buf->topbucket_odd = i) : (buf->topbucket_ev = i);
2192                     buf->topbucket = i;
2193                 }
2194         }
2195         nextchain = chunk_chain;
2196         while (nextchain) {
2197             buf->total_chain += nextchain->size;
2198             nextchain = nextchain->next;
2199         }
2200         buf->total_sbrk = goodsbrk + sbrk_slack;
2201         buf->sbrks = sbrks;
2202         buf->sbrk_good = sbrk_goodness;
2203         buf->sbrk_slack = sbrk_slack;
2204         buf->start_slack = start_slack;
2205         buf->sbrked_remains = sbrked_remains;
2206         MALLOC_UNLOCK;
2207         buf->nbuckets = NBUCKETS;
2208         if (level) {
2209             for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
2210                 if (i >= buflen)
2211                     break;
2212                 buf->bucket_mem_size[i] = BUCKET_SIZE_NO_SURPLUS(i);
2213                 buf->bucket_available_size[i] = BUCKET_SIZE_REAL(i);
2214             }
2215         }
2216 #else /* defined DEBUGGING_MSTATS */
2217         PerlIO_printf(Perl_error_log, "perl not compiled with DEBUGGING_MSTATS\n");
2218 #endif  /* defined DEBUGGING_MSTATS */
2219         return 0;               /* XXX unused */
2220 }
2221 /*
2222  * mstats - print out statistics about malloc
2223  * 
2224  * Prints two lines of numbers, one showing the length of the free list
2225  * for each size category, the second showing the number of mallocs -
2226  * frees for each size category.
2227  */
2228 void
2229 Perl_dump_mstats(pTHX_ const char *s)
2230 {
2231 #ifdef DEBUGGING_MSTATS
2232         int i;
2233         perl_mstats_t buffer;
2234         UV nf[NBUCKETS];
2235         UV nt[NBUCKETS];
2236
2237         PERL_ARGS_ASSERT_DUMP_MSTATS;
2238
2239         buffer.nfree  = nf;
2240         buffer.ntotal = nt;
2241         get_mstats(&buffer, NBUCKETS, 0);
2242
2243         if (s)
2244             PerlIO_printf(Perl_error_log,
2245                           "Memory allocation statistics %s (buckets %"IVdf"(%"IVdf")..%"IVdf"(%"IVdf")\n",
2246                           s, 
2247                           (IV)BUCKET_SIZE_REAL(MIN_BUCKET), 
2248                           (IV)BUCKET_SIZE_NO_SURPLUS(MIN_BUCKET),
2249                           (IV)BUCKET_SIZE_REAL(buffer.topbucket), 
2250                           (IV)BUCKET_SIZE_NO_SURPLUS(buffer.topbucket));
2251         PerlIO_printf(Perl_error_log, "%8"IVdf" free:", buffer.totfree);
2252         for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
2253                 PerlIO_printf(Perl_error_log, 
2254                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2255                                ? " %5"UVuf 
2256                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"UVuf : " %"UVuf)),
2257                               buffer.nfree[i]);
2258         }
2259 #ifdef BUCKETS_ROOT2
2260         PerlIO_printf(Perl_error_log, "\n\t   ");
2261         for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
2262                 PerlIO_printf(Perl_error_log, 
2263                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2264                                ? " %5"UVuf 
2265                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"UVuf : " %"UVuf)),
2266                               buffer.nfree[i]);
2267         }
2268 #endif 
2269         PerlIO_printf(Perl_error_log, "\n%8"IVdf" used:", buffer.total - buffer.totfree);
2270         for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
2271                 PerlIO_printf(Perl_error_log, 
2272                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
2273                                ? " %5"IVdf
2274                                : ((i < 12*BUCKETS_PER_POW2) ? " %3"IVdf : " %"IVdf)), 
2275                               buffer.ntotal[i] - buffer.nfree[i]);
2276         }
2277 #ifdef BUCKETS_ROOT2
2278         PerlIO_printf(Perl_error_log, "\n\t   ");
2279         for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; 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 #endif 
2287         PerlIO_printf(Perl_error_log, "\nTotal sbrk(): %"IVdf"/%"IVdf":%"IVdf". Odd ends: pad+heads+chain+tail: %"IVdf"+%"IVdf"+%"IVdf"+%"IVdf".\n",
2288                       buffer.total_sbrk, buffer.sbrks, buffer.sbrk_good,
2289                       buffer.sbrk_slack, buffer.start_slack,
2290                       buffer.total_chain, buffer.sbrked_remains);
2291 #else /* DEBUGGING_MSTATS */
2292         PerlIO_printf(Perl_error_log, "%s: perl not compiled with DEBUGGING_MSTATS\n",s);
2293 #endif /* DEBUGGING_MSTATS */
2294 }
2295
2296 #ifdef USE_PERL_SBRK
2297
2298 #   if defined(PURIFY)
2299 #      define PERL_SBRK_VIA_MALLOC
2300 #   endif
2301
2302 #   ifdef PERL_SBRK_VIA_MALLOC
2303
2304 /* it may seem schizophrenic to use perl's malloc and let it call system */
2305 /* malloc, the reason for that is only the 3.2 version of the OS that had */
2306 /* frequent core dumps within nxzonefreenolock. This sbrk routine put an */
2307 /* end to the cores */
2308
2309 #      ifndef SYSTEM_ALLOC
2310 #         define SYSTEM_ALLOC(a) malloc(a)
2311 #      endif
2312 #      ifndef SYSTEM_ALLOC_ALIGNMENT
2313 #         define SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
2314 #      endif
2315
2316 #   endif  /* PERL_SBRK_VIA_MALLOC */
2317
2318 static IV Perl_sbrk_oldchunk;
2319 static long Perl_sbrk_oldsize;
2320
2321 #   define PERLSBRK_32_K (1<<15)
2322 #   define PERLSBRK_64_K (1<<16)
2323
2324 Malloc_t
2325 Perl_sbrk(int size)
2326 {
2327     IV got;
2328     int small, reqsize;
2329
2330     if (!size) return 0;
2331     reqsize = size; /* just for the DEBUG_m statement */
2332 #ifdef PACK_MALLOC
2333     size = (size + 0x7ff) & ~0x7ff;
2334 #endif
2335     if (size <= Perl_sbrk_oldsize) {
2336         got = Perl_sbrk_oldchunk;
2337         Perl_sbrk_oldchunk += size;
2338         Perl_sbrk_oldsize -= size;
2339     } else {
2340       if (size >= PERLSBRK_32_K) {
2341         small = 0;
2342       } else {
2343         size = PERLSBRK_64_K;
2344         small = 1;
2345       }
2346 #  if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2347       size += NEEDED_ALIGNMENT - SYSTEM_ALLOC_ALIGNMENT;
2348 #  endif
2349       got = (IV)SYSTEM_ALLOC(size);
2350 #  if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2351       got = (got + NEEDED_ALIGNMENT - 1) & ~(NEEDED_ALIGNMENT - 1);
2352 #  endif
2353       if (small) {
2354         /* Chunk is small, register the rest for future allocs. */
2355         Perl_sbrk_oldchunk = got + reqsize;
2356         Perl_sbrk_oldsize = size - reqsize;
2357       }
2358     }
2359
2360     DEBUG_m(PerlIO_printf(Perl_debug_log, "sbrk malloc size %ld (reqsize %ld), left size %ld, give addr 0x%"UVxf"\n",
2361                     size, reqsize, Perl_sbrk_oldsize, PTR2UV(got)));
2362
2363     return (void *)got;
2364 }
2365
2366 #endif /* ! defined USE_PERL_SBRK */
2367
2368 /*
2369  * ex: set ts=8 sts=4 sw=4 et:
2370  */