6 Here are some notes on configuring Perl's malloc. (For non-perl
9 There are two macros which serve as bulk disablers of advanced
10 features of this malloc: NO_FANCY_MALLOC, PLAIN_MALLOC (undef by
11 default). Look in the list of default values below to understand
12 their exact effect. Defining NO_FANCY_MALLOC returns malloc.c to the
13 state of the malloc in Perl 5.004. Additionally defining PLAIN_MALLOC
14 returns it to the state as of Perl 5.000.
16 Note that some of the settings below may be ignored in the code based
17 on values of other macros. The PERL_CORE symbol is only defined when
18 perl itself is being compiled (so malloc can make some assumptions
19 about perl's facilities being available to it).
21 Each config option has a short description, followed by its name,
22 default value, and a comment about the default (if applicable). Some
23 options take a precise value, while the others are just boolean.
24 The boolean ones are listed first.
26 # Enable code for an emergency memory pool in $^M. See perlvar.pod
27 # for a description of $^M.
28 PERL_EMERGENCY_SBRK (!PLAIN_MALLOC && PERL_CORE)
30 # Enable code for printing memory statistics.
31 DEBUGGING_MSTATS (!PLAIN_MALLOC && PERL_CORE)
33 # Move allocation info for small buckets into separate areas.
34 # Memory optimization (especially for small allocations, of the
35 # less than 64 bytes). Since perl usually makes a large number
36 # of small allocations, this is usually a win.
37 PACK_MALLOC (!PLAIN_MALLOC && !RCHECK)
39 # Add one page to big powers of two when calculating bucket size.
40 # This is targeted at big allocations, as are common in image
42 TWO_POT_OPTIMIZE !PLAIN_MALLOC
44 # Use intermediate bucket sizes between powers-of-two. This is
45 # generally a memory optimization, and a (small) speed pessimization.
46 BUCKETS_ROOT2 !NO_FANCY_MALLOC
48 # Do not check small deallocations for bad free(). Memory
49 # and speed optimization, error reporting pessimization.
50 IGNORE_SMALL_BAD_FREE (!NO_FANCY_MALLOC && !RCHECK)
52 # Use table lookup to decide in which bucket a given allocation will go.
53 SMALL_BUCKET_VIA_TABLE !NO_FANCY_MALLOC
55 # Use a perl-defined sbrk() instead of the (presumably broken or
56 # missing) system-supplied sbrk().
59 # Use system malloc() (or calloc() etc.) to emulate sbrk(). Normally
60 # only used with broken sbrk()s.
61 PERL_SBRK_VIA_MALLOC undef
63 # Which allocator to use if PERL_SBRK_VIA_MALLOC
64 SYSTEM_ALLOC(a) malloc(a)
66 # Minimal alignment (in bytes, should be a power of 2) of SYSTEM_ALLOC
67 SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
69 # Disable memory overwrite checking with DEBUGGING. Memory and speed
70 # optimization, error reporting pessimization.
73 # Enable memory overwrite checking with DEBUGGING. Memory and speed
74 # pessimization, error reporting optimization
75 RCHECK (DEBUGGING && !NO_RCHECK)
77 # Failed allocations bigger than this size croak (if
78 # PERL_EMERGENCY_SBRK is enabled) without touching $^M. See
79 # perlvar.pod for a description of $^M.
80 BIG_SIZE (1<<16) # 64K
82 # Starting from this power of two, add an extra page to the
83 # size of the bucket. This enables optimized allocations of sizes
84 # close to powers of 2. Note that the value is indexed at 0.
85 FIRST_BIG_POW2 15 # 32K, 16K is used too often
87 # Estimate of minimal memory footprint. malloc uses this value to
88 # request the most reasonable largest blocks of memory from the system.
91 # Round up sbrk()s to multiples of this.
94 # Round up sbrk()s to multiples of this percent of footprint.
97 # Add this much memory to big powers of two to get the bucket size.
100 # This many sbrk() discontinuities should be tolerated even
101 # from the start without deciding that sbrk() is usually
103 SBRK_ALLOW_FAILURES 3
105 # This many continuous sbrk()s compensate for one discontinuous one.
106 SBRK_FAILURE_PRICE 50
108 # Some configurations may ask for 12-byte-or-so allocations which
109 # require 8-byte alignment (?!). In such situation one needs to
110 # define this to disable 12-byte bucket (will increase memory footprint)
111 STRICT_ALIGNMENT undef
113 This implementation assumes that calling PerlIO_printf() does not
114 result in any memory allocation calls (used during a panic).
119 If used outside of Perl environment, it may be useful to redefine
120 the following macros (listed below with defaults):
122 # Type of address returned by allocation functions
125 # Type of size argument for allocation functions
126 MEM_SIZE unsigned long
128 # Maximal value in LONG
131 # Unsigned integer type big enough to keep a pointer
134 # Type of pointer with 1-byte granularity
137 # Type returned by free()
140 # Very fatal condition reporting function (cannot call any )
141 fatalcroak(arg) write(2,arg,strlen(arg)) + exit(2)
143 # Fatal error reporting function
144 croak(format, arg) warn(idem) + exit(1)
146 # Error reporting function
147 warn(format, arg) fprintf(stderr, idem)
149 # Locking/unlocking for MT operation
150 MALLOC_LOCK MUTEX_LOCK_NOCONTEXT(&PL_malloc_mutex)
151 MALLOC_UNLOCK MUTEX_UNLOCK_NOCONTEXT(&PL_malloc_mutex)
153 # Locking/unlocking mutex for MT operation
158 #ifndef NO_FANCY_MALLOC
159 # ifndef SMALL_BUCKET_VIA_TABLE
160 # define SMALL_BUCKET_VIA_TABLE
162 # ifndef BUCKETS_ROOT2
163 # define BUCKETS_ROOT2
165 # ifndef IGNORE_SMALL_BAD_FREE
166 # define IGNORE_SMALL_BAD_FREE
170 #ifndef PLAIN_MALLOC /* Bulk enable features */
174 # ifndef TWO_POT_OPTIMIZE
175 # define TWO_POT_OPTIMIZE
177 # if defined(PERL_CORE) && !defined(PERL_EMERGENCY_SBRK)
178 # define PERL_EMERGENCY_SBRK
180 # if defined(PERL_CORE) && !defined(DEBUGGING_MSTATS)
181 # define DEBUGGING_MSTATS
185 #define MIN_BUC_POW2 (sizeof(void*) > 4 ? 3 : 2) /* Allow for 4-byte arena. */
186 #define MIN_BUCKET (MIN_BUC_POW2 * BUCKETS_PER_POW2)
188 #if !(defined(I286) || defined(atarist) || defined(__MINT__))
189 /* take 2k unless the block is bigger than that */
190 # define LOG_OF_MIN_ARENA 11
192 /* take 16k unless the block is bigger than that
193 (80286s like large segments!), probably good on the atari too */
194 # define LOG_OF_MIN_ARENA 14
198 # if defined(DEBUGGING) && !defined(NO_RCHECK)
201 # if defined(RCHECK) && defined(IGNORE_SMALL_BAD_FREE)
202 # undef IGNORE_SMALL_BAD_FREE
205 * malloc.c (Caltech) 2/21/82
206 * Chris Kingsley, kingsley@cit-20.
208 * This is a very fast storage allocator. It allocates blocks of a small
209 * number of different sizes, and keeps free lists of each size. Blocks that
210 * don't exactly fit are passed up to the next larger size. In this
211 * implementation, the available sizes are 2^n-4 (or 2^n-12) bytes long.
212 * If PACK_MALLOC is defined, small blocks are 2^n bytes long.
213 * This is designed for use in a program that uses vast quantities of memory,
214 * but bombs when it runs out.
216 * Modifications Copyright Ilya Zakharevich 1996-99.
218 * Still very quick, but much more thrifty. (Std config is 10% slower
219 * than it was, and takes 67% of old heap size for typical usage.)
221 * Allocations of small blocks are now table-driven to many different
222 * buckets. Sizes of really big buckets are increased to accomodata
223 * common size=power-of-2 blocks. Running-out-of-memory is made into
224 * an exception. Deeply configurable and thread-safe.
230 # define PERL_IN_MALLOC_C
232 # if defined(PERL_IMPLICIT_CONTEXT)
233 # define croak Perl_croak_nocontext
234 # define warn Perl_warn_nocontext
238 # include "../EXTERN.h"
239 # include "../perl.h"
246 # define Malloc_t void *
249 # define MEM_SIZE unsigned long
252 # define LONG_MAX 0x7FFFFFFF
255 # define UV unsigned long
258 # define caddr_t char *
263 # define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
264 # define PerlEnv_getenv getenv
265 # define PerlIO_printf fprintf
266 # define PerlIO_stderr() stderr
268 # ifndef croak /* make depend */
269 # define croak(mess, arg) (warn((mess), (arg)), exit(1))
272 # define warn(mess, arg) fprintf(stderr, (mess), (arg))
284 # define dTHX extern int Perl___notused
285 # define WITH_THX(s) s
287 # ifndef PERL_GET_INTERP
288 # define PERL_GET_INTERP PL_curinterp
291 # define Perl_malloc malloc
294 # define Perl_mfree free
296 # ifndef Perl_realloc
297 # define Perl_realloc realloc
300 # define Perl_calloc calloc
303 # define Perl_strdup strdup
308 # define MUTEX_LOCK(l)
312 # define MUTEX_UNLOCK(l)
316 # define MALLOC_LOCK MUTEX_LOCK_NOCONTEXT(&PL_malloc_mutex)
319 #ifndef MALLOC_UNLOCK
320 # define MALLOC_UNLOCK MUTEX_UNLOCK_NOCONTEXT(&PL_malloc_mutex)
323 # ifndef fatalcroak /* make depend */
324 # define fatalcroak(mess) (write(2, (mess), strlen(mess)), exit(2))
329 # define DEBUG_m(a) \
331 if (PERL_GET_INTERP) { dTHX; if (PL_debug & 128) { a; } } \
338 * The memory is broken into "blocks" which occupy multiples of 2K (and
339 * generally speaking, have size "close" to a power of 2). The addresses
340 * of such *unused* blocks are kept in nextf[i] with big enough i. (nextf
341 * is an array of linked lists.) (Addresses of used blocks are not known.)
343 * Moreover, since the algorithm may try to "bite" smaller blocks out
344 * of unused bigger ones, there are also regions of "irregular" size,
345 * managed separately, by a linked list chunk_chain.
347 * The third type of storage is the sbrk()ed-but-not-yet-used space, its
348 * end and size are kept in last_sbrk_top and sbrked_remains.
350 * Growing blocks "in place":
351 * ~~~~~~~~~~~~~~~~~~~~~~~~~
352 * The address of the block with the greatest address is kept in last_op
353 * (if not known, last_op is 0). If it is known that the memory above
354 * last_op is not continuous, or contains a chunk from chunk_chain,
355 * last_op is set to 0.
357 * The chunk with address last_op may be grown by expanding into
358 * sbrk()ed-but-not-yet-used space, or trying to sbrk() more continuous
361 * Management of last_op:
362 * ~~~~~~~~~~~~~~~~~~~~~
364 * free() never changes the boundaries of blocks, so is not relevant.
366 * The only way realloc() may change the boundaries of blocks is if it
367 * grows a block "in place". However, in the case of success such a
368 * chunk is automatically last_op, and it remains last_op. In the case
369 * of failure getpages_adjacent() clears last_op.
371 * malloc() may change blocks by calling morecore() only.
373 * morecore() may create new blocks by:
374 * a) biting pieces from chunk_chain (cannot create one above last_op);
375 * b) biting a piece from an unused block (if block was last_op, this
376 * may create a chunk from chain above last_op, thus last_op is
377 * invalidated in such a case).
378 * c) biting of sbrk()ed-but-not-yet-used space. This creates
379 * a block which is last_op.
380 * d) Allocating new pages by calling getpages();
382 * getpages() creates a new block. It marks last_op at the bottom of
383 * the chunk of memory it returns.
385 * Active pages footprint:
386 * ~~~~~~~~~~~~~~~~~~~~~~
387 * Note that we do not need to traverse the lists in nextf[i], just take
388 * the first element of this list. However, we *need* to traverse the
389 * list in chunk_chain, but most the time it should be a very short one,
390 * so we do not step on a lot of pages we are not going to use.
394 * get_from_bigger_buckets(): forget to increment price => Quite
398 /* I don't much care whether these are defined in sys/types.h--LAW */
400 #define u_char unsigned char
401 #define u_int unsigned int
403 * I removed the definition of u_bigint which appeared to be u_bigint = UV
404 * u_bigint was only used in TWOK_MASKED and TWOK_SHIFT
405 * where I have used PTR2UV. RMB
407 #define u_short unsigned short
409 /* 286 and atarist like big chunks, which gives too much overhead. */
410 #if (defined(RCHECK) || defined(I286) || defined(atarist) || defined(__MINT__)) && defined(PACK_MALLOC)
415 * The description below is applicable if PACK_MALLOC is not defined.
417 * The overhead on a block is at least 4 bytes. When free, this space
418 * contains a pointer to the next free block, and the bottom two bits must
419 * be zero. When in use, the first byte is set to MAGIC, and the second
420 * byte is the size index. The remaining bytes are for alignment.
421 * If range checking is enabled and the size of the block fits
422 * in two bytes, then the top two bytes hold the size of the requested block
423 * plus the range checking words, and the header word MINUS ONE.
426 union overhead *ov_next; /* when free */
427 #if MEM_ALIGNBYTES > 4
428 double strut; /* alignment problems */
431 u_char ovu_magic; /* magic number */
432 u_char ovu_index; /* bucket # */
434 u_short ovu_size; /* actual block size */
435 u_int ovu_rmagic; /* range magic number */
438 #define ov_magic ovu.ovu_magic
439 #define ov_index ovu.ovu_index
440 #define ov_size ovu.ovu_size
441 #define ov_rmagic ovu.ovu_rmagic
444 #define MAGIC 0xff /* magic # on accounting info */
445 #define RMAGIC 0x55555555 /* magic # on range info */
446 #define RMAGIC_C 0x55 /* magic # on range info */
449 # define RSLOP sizeof (u_int)
450 # ifdef TWO_POT_OPTIMIZE
451 # define MAX_SHORT_BUCKET (12 * BUCKETS_PER_POW2)
453 # define MAX_SHORT_BUCKET (13 * BUCKETS_PER_POW2)
459 #if !defined(PACK_MALLOC) && defined(BUCKETS_ROOT2)
460 # undef BUCKETS_ROOT2
464 # define BUCKET_TABLE_SHIFT 2
465 # define BUCKET_POW2_SHIFT 1
466 # define BUCKETS_PER_POW2 2
468 # define BUCKET_TABLE_SHIFT MIN_BUC_POW2
469 # define BUCKET_POW2_SHIFT 0
470 # define BUCKETS_PER_POW2 1
473 #if !defined(MEM_ALIGNBYTES) || ((MEM_ALIGNBYTES > 4) && !defined(STRICT_ALIGNMENT))
474 /* Figure out the alignment of void*. */
479 # define ALIGN_SMALL ((int)((caddr_t)&(((struct aligner*)0)->p)))
481 # define ALIGN_SMALL MEM_ALIGNBYTES
484 #define IF_ALIGN_8(yes,no) ((ALIGN_SMALL>4) ? (yes) : (no))
487 # define MAX_BUCKET_BY_TABLE 13
488 static u_short buck_size[MAX_BUCKET_BY_TABLE + 1] =
490 0, 0, 0, 0, 4, 4, 8, 12, 16, 24, 32, 48, 64, 80,
492 # define BUCKET_SIZE(i) ((i) % 2 ? buck_size[i] : (1 << ((i) >> BUCKET_POW2_SHIFT)))
493 # define BUCKET_SIZE_REAL(i) ((i) <= MAX_BUCKET_BY_TABLE \
495 : ((1 << ((i) >> BUCKET_POW2_SHIFT)) \
497 + POW2_OPTIMIZE_SURPLUS(i)))
499 # define BUCKET_SIZE(i) (1 << ((i) >> BUCKET_POW2_SHIFT))
500 # define BUCKET_SIZE_REAL(i) (BUCKET_SIZE(i) - MEM_OVERHEAD(i) + POW2_OPTIMIZE_SURPLUS(i))
505 /* In this case there are several possible layout of arenas depending
506 * on the size. Arenas are of sizes multiple to 2K, 2K-aligned, and
507 * have a size close to a power of 2.
509 * Arenas of the size >= 4K keep one chunk only. Arenas of size 2K
510 * may keep one chunk or multiple chunks. Here are the possible
513 * # One chunk only, chunksize 2^k + SOMETHING - ALIGN, k >= 11
515 * INDEX MAGIC1 UNUSED CHUNK1
517 * # Multichunk with sanity checking and chunksize 2^k-ALIGN, k>7
519 * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 CHUNK2 CHUNK3 ...
521 * # Multichunk with sanity checking and size 2^k-ALIGN, k=7
523 * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 UNUSED CHUNK2 CHUNK3 ...
525 * # Multichunk with sanity checking and size up to 80
527 * INDEX UNUSED MAGIC1 UNUSED MAGIC2 UNUSED ... CHUNK1 CHUNK2 CHUNK3 ...
529 * # No sanity check (usually up to 48=byte-long buckets)
530 * INDEX UNUSED CHUNK1 CHUNK2 ...
532 * Above INDEX and MAGIC are one-byte-long. Sizes of UNUSED are
533 * appropriate to keep algorithms simple and memory aligned. INDEX
534 * encodes the size of the chunk, while MAGICn encodes state (used,
535 * free or non-managed-by-us-so-it-indicates-a-bug) of CHUNKn. MAGIC
536 * is used for sanity checking purposes only. SOMETHING is 0 or 4K
537 * (to make size of big CHUNK accomodate allocations for powers of two
540 * [There is no need to alignment between chunks, since C rules ensure
541 * that structs which need 2^k alignment have sizeof which is
542 * divisible by 2^k. Thus as far as the last chunk is aligned at the
543 * end of the arena, and 2K-alignment does not contradict things,
544 * everything is going to be OK for sizes of chunks 2^n and 2^n +
545 * 2^k. Say, 80-bit buckets will be 16-bit aligned, and as far as we
546 * put allocations for requests in 65..80 range, all is fine.
548 * Note, however, that standard malloc() puts more strict
549 * requirements than the above C rules. Moreover, our algorithms of
550 * realloc() may break this idyll, but we suppose that realloc() does
551 * need not change alignment.]
553 * Is very important to make calculation of the offset of MAGICm as
554 * quick as possible, since it is done on each malloc()/free(). In
555 * fact it is so quick that it has quite little effect on the speed of
556 * doing malloc()/free(). [By default] We forego such calculations
557 * for small chunks, but only to save extra 3% of memory, not because
558 * of speed considerations.
560 * Here is the algorithm [which is the same for all the allocations
561 * schemes above], see OV_MAGIC(block,bucket). Let OFFSETm be the
562 * offset of the CHUNKm from the start of ARENA. Then offset of
563 * MAGICm is (OFFSET1 >> SHIFT) + ADDOFFSET. Here SHIFT and ADDOFFSET
564 * are numbers which depend on the size of the chunks only.
566 * Let as check some sanity conditions. Numbers OFFSETm>>SHIFT are
567 * different for all the chunks in the arena if 2^SHIFT is not greater
568 * than size of the chunks in the arena. MAGIC1 will not overwrite
569 * INDEX provided ADDOFFSET is >0 if OFFSET1 < 2^SHIFT. MAGIClast
570 * will not overwrite CHUNK1 if OFFSET1 > (OFFSETlast >> SHIFT) +
573 * Make SHIFT the maximal possible (there is no point in making it
574 * smaller). Since OFFSETlast is 2K - CHUNKSIZE, above restrictions
575 * give restrictions on OFFSET1 and on ADDOFFSET.
577 * In particular, for chunks of size 2^k with k>=6 we can put
578 * ADDOFFSET to be from 0 to 2^k - 2^(11-k), and have
579 * OFFSET1==chunksize. For chunks of size 80 OFFSET1 of 2K%80=48 is
580 * large enough to have ADDOFFSET between 1 and 16 (similarly for 96,
581 * when ADDOFFSET should be 1). In particular, keeping MAGICs for
582 * these sizes gives no additional size penalty.
584 * However, for chunks of size 2^k with k<=5 this gives OFFSET1 >=
585 * ADDOFSET + 2^(11-k). Keeping ADDOFFSET 0 allows for 2^(11-k)-2^(11-2k)
586 * chunks per arena. This is smaller than 2^(11-k) - 1 which are
587 * needed if no MAGIC is kept. [In fact, having a negative ADDOFFSET
588 * would allow for slightly more buckets per arena for k=2,3.]
590 * Similarly, for chunks of size 3/2*2^k with k<=5 MAGICs would span
591 * the area up to 2^(11-k)+ADDOFFSET. For k=4 this give optimal
592 * ADDOFFSET as -7..0. For k=3 ADDOFFSET can go up to 4 (with tiny
593 * savings for negative ADDOFFSET). For k=5 ADDOFFSET can go -1..16
594 * (with no savings for negative values).
596 * In particular, keeping ADDOFFSET 0 for sizes of chunks up to 2^6
597 * leads to tiny pessimizations in case of sizes 4, 8, 12, 24, and
598 * leads to no contradictions except for size=80 (or 96.)
600 * However, it also makes sense to keep no magic for sizes 48 or less.
601 * This is what we do. In this case one needs ADDOFFSET>=1 also for
602 * chunksizes 12, 24, and 48, unless one gets one less chunk per
605 * The algo of OV_MAGIC(block,bucket) keeps ADDOFFSET 0 until
606 * chunksize of 64, then makes it 1.
608 * This allows for an additional optimization: the above scheme leads
609 * to giant overheads for sizes 128 or more (one whole chunk needs to
610 * be sacrifised to keep INDEX). Instead we use chunks not of size
611 * 2^k, but of size 2^k-ALIGN. If we pack these chunks at the end of
612 * the arena, then the beginnings are still in different 2^k-long
613 * sections of the arena if k>=7 for ALIGN==4, and k>=8 if ALIGN=8.
614 * Thus for k>7 the above algo of calculating the offset of the magic
615 * will still give different answers for different chunks. And to
616 * avoid the overrun of MAGIC1 into INDEX, one needs ADDOFFSET of >=1.
617 * In the case k=7 we just move the first chunk an extra ALIGN
618 * backward inside the ARENA (this is done once per arena lifetime,
619 * thus is not a big overhead). */
620 # define MAX_PACKED_POW2 6
621 # define MAX_PACKED (MAX_PACKED_POW2 * BUCKETS_PER_POW2 + BUCKET_POW2_SHIFT)
622 # define MAX_POW2_ALGO ((1<<(MAX_PACKED_POW2 + 1)) - M_OVERHEAD)
623 # define TWOK_MASK ((1<<LOG_OF_MIN_ARENA) - 1)
624 # define TWOK_MASKED(x) (PTR2UV(x) & ~TWOK_MASK)
625 # define TWOK_SHIFT(x) (PTR2UV(x) & TWOK_MASK)
626 # define OV_INDEXp(block) (INT2PTR(u_char*,TWOK_MASKED(block)))
627 # define OV_INDEX(block) (*OV_INDEXp(block))
628 # define OV_MAGIC(block,bucket) (*(OV_INDEXp(block) + \
629 (TWOK_SHIFT(block)>> \
630 (bucket>>BUCKET_POW2_SHIFT)) + \
631 (bucket >= MIN_NEEDS_SHIFT ? 1 : 0)))
632 /* A bucket can have a shift smaller than it size, we need to
633 shift its magic number so it will not overwrite index: */
634 # ifdef BUCKETS_ROOT2
635 # define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2 - 1) /* Shift 80 greater than chunk 64. */
637 # define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2) /* Shift 128 greater than chunk 32. */
639 # define CHUNK_SHIFT 0
641 /* Number of active buckets of given ordinal. */
642 #ifdef IGNORE_SMALL_BAD_FREE
643 #define FIRST_BUCKET_WITH_CHECK (6 * BUCKETS_PER_POW2) /* 64 */
644 # define N_BLKS(bucket) ( (bucket) < FIRST_BUCKET_WITH_CHECK \
645 ? ((1<<LOG_OF_MIN_ARENA) - 1)/BUCKET_SIZE(bucket) \
648 # define N_BLKS(bucket) n_blks[bucket]
651 static u_short n_blks[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] =
653 # if BUCKETS_PER_POW2==1
655 (MIN_BUC_POW2==2 ? 384 : 0),
656 224, 120, 62, 31, 16, 8, 4, 2
659 (MIN_BUC_POW2==2 ? 384 : 0), (MIN_BUC_POW2==2 ? 384 : 0), /* 4, 4 */
660 224, 149, 120, 80, 62, 41, 31, 25, 16, 16, 8, 8, 4, 4, 2, 2
664 /* Shift of the first bucket with the given ordinal inside 2K chunk. */
665 #ifdef IGNORE_SMALL_BAD_FREE
666 # define BLK_SHIFT(bucket) ( (bucket) < FIRST_BUCKET_WITH_CHECK \
667 ? ((1<<LOG_OF_MIN_ARENA) \
668 - BUCKET_SIZE(bucket) * N_BLKS(bucket)) \
671 # define BLK_SHIFT(bucket) blk_shift[bucket]
674 static u_short blk_shift[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] =
676 # if BUCKETS_PER_POW2==1
678 (MIN_BUC_POW2==2 ? 512 : 0),
679 256, 128, 64, 64, /* 8 to 64 */
680 16*sizeof(union overhead),
681 8*sizeof(union overhead),
682 4*sizeof(union overhead),
683 2*sizeof(union overhead),
686 (MIN_BUC_POW2==2 ? 512 : 0), (MIN_BUC_POW2==2 ? 512 : 0),
687 256, 260, 128, 128, 64, 80, 64, 48, /* 8 to 96 */
688 16*sizeof(union overhead), 16*sizeof(union overhead),
689 8*sizeof(union overhead), 8*sizeof(union overhead),
690 4*sizeof(union overhead), 4*sizeof(union overhead),
691 2*sizeof(union overhead), 2*sizeof(union overhead),
695 # define NEEDED_ALIGNMENT 0x800 /* 2k boundaries */
696 # define WANTED_ALIGNMENT 0x800 /* 2k boundaries */
698 #else /* !PACK_MALLOC */
700 # define OV_MAGIC(block,bucket) (block)->ov_magic
701 # define OV_INDEX(block) (block)->ov_index
702 # define CHUNK_SHIFT 1
703 # define MAX_PACKED -1
704 # define NEEDED_ALIGNMENT MEM_ALIGNBYTES
705 # define WANTED_ALIGNMENT 0x400 /* 1k boundaries */
707 #endif /* !PACK_MALLOC */
709 #define M_OVERHEAD (sizeof(union overhead) + RSLOP)
712 # define MEM_OVERHEAD(bucket) \
713 (bucket <= MAX_PACKED ? 0 : M_OVERHEAD)
714 # ifdef SMALL_BUCKET_VIA_TABLE
715 # define START_SHIFTS_BUCKET ((MAX_PACKED_POW2 + 1) * BUCKETS_PER_POW2)
716 # define START_SHIFT MAX_PACKED_POW2
717 # ifdef BUCKETS_ROOT2 /* Chunks of size 3*2^n. */
718 # define SIZE_TABLE_MAX 80
720 # define SIZE_TABLE_MAX 64
722 static char bucket_of[] =
724 # ifdef BUCKETS_ROOT2 /* Chunks of size 3*2^n. */
725 /* 0 to 15 in 4-byte increments. */
726 (sizeof(void*) > 4 ? 6 : 5), /* 4/8, 5-th bucket for better reports */
728 IF_ALIGN_8(8,7), 8, /* 16/12, 16 */
729 9, 9, 10, 10, /* 24, 32 */
730 11, 11, 11, 11, /* 48 */
731 12, 12, 12, 12, /* 64 */
732 13, 13, 13, 13, /* 80 */
733 13, 13, 13, 13 /* 80 */
734 # else /* !BUCKETS_ROOT2 */
735 /* 0 to 15 in 4-byte increments. */
736 (sizeof(void*) > 4 ? 3 : 2),
742 # endif /* !BUCKETS_ROOT2 */
744 # else /* !SMALL_BUCKET_VIA_TABLE */
745 # define START_SHIFTS_BUCKET MIN_BUCKET
746 # define START_SHIFT (MIN_BUC_POW2 - 1)
747 # endif /* !SMALL_BUCKET_VIA_TABLE */
748 #else /* !PACK_MALLOC */
749 # define MEM_OVERHEAD(bucket) M_OVERHEAD
750 # ifdef SMALL_BUCKET_VIA_TABLE
751 # undef SMALL_BUCKET_VIA_TABLE
753 # define START_SHIFTS_BUCKET MIN_BUCKET
754 # define START_SHIFT (MIN_BUC_POW2 - 1)
755 #endif /* !PACK_MALLOC */
758 * Big allocations are often of the size 2^n bytes. To make them a
759 * little bit better, make blocks of size 2^n+pagesize for big n.
762 #ifdef TWO_POT_OPTIMIZE
764 # ifndef PERL_PAGESIZE
765 # define PERL_PAGESIZE 4096
767 # ifndef FIRST_BIG_POW2
768 # define FIRST_BIG_POW2 15 /* 32K, 16K is used too often. */
770 # define FIRST_BIG_BLOCK (1<<FIRST_BIG_POW2)
771 /* If this value or more, check against bigger blocks. */
772 # define FIRST_BIG_BOUND (FIRST_BIG_BLOCK - M_OVERHEAD)
773 /* If less than this value, goes into 2^n-overhead-block. */
774 # define LAST_SMALL_BOUND ((FIRST_BIG_BLOCK>>1) - M_OVERHEAD)
776 # define POW2_OPTIMIZE_ADJUST(nbytes) \
777 ((nbytes >= FIRST_BIG_BOUND) ? nbytes -= PERL_PAGESIZE : 0)
778 # define POW2_OPTIMIZE_SURPLUS(bucket) \
779 ((bucket >= FIRST_BIG_POW2 * BUCKETS_PER_POW2) ? PERL_PAGESIZE : 0)
781 #else /* !TWO_POT_OPTIMIZE */
782 # define POW2_OPTIMIZE_ADJUST(nbytes)
783 # define POW2_OPTIMIZE_SURPLUS(bucket) 0
784 #endif /* !TWO_POT_OPTIMIZE */
786 #if defined(HAS_64K_LIMIT) && defined(PERL_CORE)
787 # define BARK_64K_LIMIT(what,nbytes,size) \
788 if (nbytes > 0xffff) { \
789 PerlIO_printf(PerlIO_stderr(), \
790 "%s too large: %lx\n", what, size); \
793 #else /* !HAS_64K_LIMIT || !PERL_CORE */
794 # define BARK_64K_LIMIT(what,nbytes,size)
795 #endif /* !HAS_64K_LIMIT || !PERL_CORE */
798 # define MIN_SBRK 2048
802 # define FIRST_SBRK (48*1024)
805 /* Minimal sbrk in percents of what is already alloced. */
806 #ifndef MIN_SBRK_FRAC
807 # define MIN_SBRK_FRAC 3
810 #ifndef SBRK_ALLOW_FAILURES
811 # define SBRK_ALLOW_FAILURES 3
814 #ifndef SBRK_FAILURE_PRICE
815 # define SBRK_FAILURE_PRICE 50
818 #if defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)
821 # define BIG_SIZE (1<<16) /* 64K */
824 #ifdef I_MACH_CTHREADS
826 # define MUTEX_LOCK(m) STMT_START { if (*m) mutex_lock(*m); } STMT_END
828 # define MUTEX_UNLOCK(m) STMT_START { if (*m) mutex_unlock(*m); } STMT_END
831 static char *emergency_buffer;
832 static MEM_SIZE emergency_buffer_size;
834 static int findbucket (union overhead *freep, int srchlen);
835 static void morecore (register int bucket);
836 # if defined(DEBUGGING)
837 static void botch (char *diag, char *s);
839 static void add_to_chain (void *p, MEM_SIZE size, MEM_SIZE chip);
840 static Malloc_t emergency_sbrk (MEM_SIZE size);
841 static void* get_from_chain (MEM_SIZE size);
842 static void* get_from_bigger_buckets(int bucket, MEM_SIZE size);
843 static union overhead *getpages (int needed, int *nblksp, int bucket);
844 static int getpages_adjacent(int require);
847 emergency_sbrk(MEM_SIZE size)
849 MEM_SIZE rsize = (((size - 1)>>LOG_OF_MIN_ARENA) + 1)<<LOG_OF_MIN_ARENA;
851 if (size >= BIG_SIZE) {
852 /* Give the possibility to recover: */
854 croak("Out of memory during \"large\" request for %i bytes", size);
857 if (emergency_buffer_size >= rsize) {
858 char *old = emergency_buffer;
860 emergency_buffer_size -= rsize;
861 emergency_buffer += rsize;
865 /* First offense, give a possibility to recover by dieing. */
866 /* No malloc involved here: */
867 GV **gvp = (GV**)hv_fetch(PL_defstash, "^M", 2, 0);
873 if (emergency_buffer_size) {
874 add_to_chain(emergency_buffer, emergency_buffer_size, 0);
875 emergency_buffer_size = 0;
876 emergency_buffer = Nullch;
879 if (!gvp) gvp = (GV**)hv_fetch(PL_defstash, "\015", 1, 0);
880 if (!gvp || !(sv = GvSV(*gvp)) || !SvPOK(sv)
881 || (SvLEN(sv) < (1<<LOG_OF_MIN_ARENA) - M_OVERHEAD)) {
884 return (char *)-1; /* Now die die die... */
886 /* Got it, now detach SvPV: */
888 /* Check alignment: */
889 if ((PTR2UV(pv) - sizeof(union overhead)) & (NEEDED_ALIGNMENT - 1)) {
890 PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
891 return (char *)-1; /* die die die */
894 emergency_buffer = pv - sizeof(union overhead);
895 emergency_buffer_size = malloced_size(pv) + M_OVERHEAD;
898 SvCUR(sv) = SvLEN(sv) = 0;
902 croak("Out of memory during request for %i bytes", size);
907 #else /* !(defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)) */
908 # define emergency_sbrk(size) -1
909 #endif /* !(defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)) */
912 * nextf[i] is the pointer to the next free block of size 2^i. The
913 * smallest allocatable block is 8 bytes. The overhead information
914 * precedes the data area returned to the user.
916 #define NBUCKETS (32*BUCKETS_PER_POW2 + 1)
917 static union overhead *nextf[NBUCKETS];
919 #if defined(PURIFY) && !defined(USE_PERL_SBRK)
920 # define USE_PERL_SBRK
924 #define sbrk(a) Perl_sbrk(a)
925 Malloc_t Perl_sbrk (int size);
927 #ifdef DONT_DECLARE_STD
932 extern Malloc_t sbrk(int);
936 #ifdef DEBUGGING_MSTATS
938 * nmalloc[i] is the difference between the number of mallocs and frees
939 * for a given block size.
941 static u_int nmalloc[NBUCKETS];
942 static u_int sbrk_slack;
943 static u_int start_slack;
946 static u_int goodsbrk;
950 #define ASSERT(p,diag) if (!(p)) botch(diag,STRINGIFY(p)); else
952 botch(char *diag, char *s)
955 PerlIO_printf(PerlIO_stderr(), "assertion botched (%s?): %s\n", diag, s);
959 #define ASSERT(p, diag)
963 Perl_malloc(register size_t nbytes)
965 register union overhead *p;
967 register MEM_SIZE shiftr;
969 #if defined(DEBUGGING) || defined(RCHECK)
970 MEM_SIZE size = nbytes;
973 BARK_64K_LIMIT("Allocation",nbytes,nbytes);
975 if ((long)nbytes < 0)
976 croak("%s", "panic: malloc");
980 * Convert amount of memory requested into
981 * closest block size stored in hash buckets
982 * which satisfies request. Account for
983 * space used per block for accounting.
986 # ifdef SMALL_BUCKET_VIA_TABLE
989 else if (nbytes <= SIZE_TABLE_MAX) {
990 bucket = bucket_of[(nbytes - 1) >> BUCKET_TABLE_SHIFT];
995 if (nbytes <= MAX_POW2_ALGO) goto do_shifts;
1000 POW2_OPTIMIZE_ADJUST(nbytes);
1001 nbytes += M_OVERHEAD;
1002 nbytes = (nbytes + 3) &~ 3;
1004 shiftr = (nbytes - 1) >> START_SHIFT;
1005 bucket = START_SHIFTS_BUCKET;
1006 /* apart from this loop, this is O(1) */
1007 while (shiftr >>= 1)
1008 bucket += BUCKETS_PER_POW2;
1012 * If nothing in hash bucket right now,
1013 * request more memory from the system.
1015 if (nextf[bucket] == NULL)
1017 if ((p = nextf[bucket]) == NULL) {
1023 PerlIO_puts(PerlIO_stderr(),"Out of memory!\n");
1031 DEBUG_m(PerlIO_printf(Perl_debug_log,
1032 "0x%"UVxf": (%05lu) malloc %ld bytes\n",
1033 PTR2UV(p+1), (unsigned long)(PL_an++),
1036 /* remove from linked list */
1038 if ((PTR2UV(p)) & (MEM_ALIGNBYTES - 1)) {
1040 PerlIO_printf(PerlIO_stderr(),
1041 "Unaligned pointer in the free chain 0x%"UVxf"\n",
1044 if ((PTR2UV(p->ov_next)) & (MEM_ALIGNBYTES - 1)) {
1046 PerlIO_printf(PerlIO_stderr(),
1047 "Unaligned `next' pointer in the free "
1048 "chain 0x"UVxf" at 0x%"UVxf"\n",
1049 PTR2UV(p->ov_next), PTR2UV(p));
1052 nextf[bucket] = p->ov_next;
1056 #ifdef IGNORE_SMALL_BAD_FREE
1057 if (bucket >= FIRST_BUCKET_WITH_CHECK)
1059 OV_MAGIC(p, bucket) = MAGIC;
1061 OV_INDEX(p) = bucket;
1065 * Record allocated size of block and
1066 * bound space with magic numbers.
1068 p->ov_rmagic = RMAGIC;
1069 if (bucket <= MAX_SHORT_BUCKET) {
1072 nbytes = size + M_OVERHEAD;
1073 p->ov_size = nbytes - 1;
1074 if ((i = nbytes & 3)) {
1077 *((char *)((caddr_t)p + nbytes - RSLOP + i)) = RMAGIC_C;
1079 nbytes = (nbytes + 3) &~ 3;
1080 *((u_int *)((caddr_t)p + nbytes - RSLOP)) = RMAGIC;
1083 return ((Malloc_t)(p + CHUNK_SHIFT));
1086 static char *last_sbrk_top;
1087 static char *last_op; /* This arena can be easily extended. */
1088 static int sbrked_remains;
1089 static int sbrk_good = SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE;
1091 #ifdef DEBUGGING_MSTATS
1095 struct chunk_chain_s {
1096 struct chunk_chain_s *next;
1099 static struct chunk_chain_s *chunk_chain;
1100 static int n_chunks;
1101 static char max_bucket;
1103 /* Cutoff a piece of one of the chunks in the chain. Prefer smaller chunk. */
1105 get_from_chain(MEM_SIZE size)
1107 struct chunk_chain_s *elt = chunk_chain, **oldp = &chunk_chain;
1108 struct chunk_chain_s **oldgoodp = NULL;
1109 long min_remain = LONG_MAX;
1112 if (elt->size >= size) {
1113 long remains = elt->size - size;
1114 if (remains >= 0 && remains < min_remain) {
1116 min_remain = remains;
1122 oldp = &( elt->next );
1125 if (!oldgoodp) return NULL;
1127 void *ret = *oldgoodp;
1128 struct chunk_chain_s *next = (*oldgoodp)->next;
1130 *oldgoodp = (struct chunk_chain_s *)((char*)ret + size);
1131 (*oldgoodp)->size = min_remain;
1132 (*oldgoodp)->next = next;
1135 void *ret = *oldgoodp;
1136 *oldgoodp = (*oldgoodp)->next;
1143 add_to_chain(void *p, MEM_SIZE size, MEM_SIZE chip)
1145 struct chunk_chain_s *next = chunk_chain;
1146 char *cp = (char*)p;
1149 chunk_chain = (struct chunk_chain_s *)cp;
1150 chunk_chain->size = size - chip;
1151 chunk_chain->next = next;
1156 get_from_bigger_buckets(int bucket, MEM_SIZE size)
1159 static int bucketprice[NBUCKETS];
1160 while (bucket <= max_bucket) {
1161 /* We postpone stealing from bigger buckets until we want it
1163 if (nextf[bucket] && bucketprice[bucket]++ >= price) {
1165 void *ret = (void*)(nextf[bucket] - 1 + CHUNK_SHIFT);
1166 bucketprice[bucket] = 0;
1167 if (((char*)nextf[bucket]) - M_OVERHEAD == last_op) {
1168 last_op = NULL; /* Disable optimization */
1170 nextf[bucket] = nextf[bucket]->ov_next;
1171 #ifdef DEBUGGING_MSTATS
1173 start_slack -= M_OVERHEAD;
1175 add_to_chain(ret, (BUCKET_SIZE(bucket) +
1176 POW2_OPTIMIZE_SURPLUS(bucket)),
1185 static union overhead *
1186 getpages(int needed, int *nblksp, int bucket)
1188 /* Need to do (possibly expensive) system call. Try to
1189 optimize it for rare calling. */
1190 MEM_SIZE require = needed - sbrked_remains;
1192 union overhead *ovp;
1195 if (sbrk_good > 0) {
1196 if (!last_sbrk_top && require < FIRST_SBRK)
1197 require = FIRST_SBRK;
1198 else if (require < MIN_SBRK) require = MIN_SBRK;
1200 if (require < goodsbrk * MIN_SBRK_FRAC / 100)
1201 require = goodsbrk * MIN_SBRK_FRAC / 100;
1202 require = ((require - 1 + MIN_SBRK) / MIN_SBRK) * MIN_SBRK;
1209 DEBUG_m(PerlIO_printf(Perl_debug_log,
1210 "sbrk(%ld) for %ld-byte-long arena\n",
1211 (long)require, (long) needed));
1212 cp = (char *)sbrk(require);
1213 #ifdef DEBUGGING_MSTATS
1216 if (cp == last_sbrk_top) {
1217 /* Common case, anything is fine. */
1219 ovp = (union overhead *) (cp - sbrked_remains);
1220 last_op = cp - sbrked_remains;
1221 sbrked_remains = require - (needed - sbrked_remains);
1222 } else if (cp == (char *)-1) { /* no more room! */
1223 ovp = (union overhead *)emergency_sbrk(needed);
1224 if (ovp == (union overhead *)-1)
1226 if (((char*)ovp) > last_op) { /* Cannot happen with current emergency_sbrk() */
1230 } else { /* Non-continuous or first sbrk(). */
1231 long add = sbrked_remains;
1234 if (sbrked_remains) { /* Put rest into chain, we
1235 cannot use it right now. */
1236 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1240 /* Second, check alignment. */
1243 #if !defined(atarist) && !defined(__MINT__) /* on the atari we dont have to worry about this */
1244 # ifndef I286 /* The sbrk(0) call on the I286 always returns the next segment */
1245 /* WANTED_ALIGNMENT may be more than NEEDED_ALIGNMENT, but this may
1246 improve performance of memory access. */
1247 if (PTR2UV(cp) & (WANTED_ALIGNMENT - 1)) { /* Not aligned. */
1248 slack = WANTED_ALIGNMENT - (PTR2UV(cp) & (WANTED_ALIGNMENT - 1));
1252 #endif /* !atarist && !MINT */
1255 DEBUG_m(PerlIO_printf(Perl_debug_log,
1256 "sbrk(%ld) to fix non-continuous/off-page sbrk:\n\t%ld for alignement,\t%ld were assumed to come from the tail of the previous sbrk\n",
1257 (long)add, (long) slack,
1258 (long) sbrked_remains));
1259 newcp = (char *)sbrk(add);
1260 #if defined(DEBUGGING_MSTATS)
1264 if (newcp != cp + require) {
1265 /* Too bad: even rounding sbrk() is not continuous.*/
1266 DEBUG_m(PerlIO_printf(Perl_debug_log,
1267 "failed to fix bad sbrk()\n"));
1271 fatalcroak("panic: Off-page sbrk\n");
1274 if (sbrked_remains) {
1276 #if defined(DEBUGGING_MSTATS)
1277 sbrk_slack += require;
1280 DEBUG_m(PerlIO_printf(Perl_debug_log,
1281 "straight sbrk(%ld)\n",
1283 cp = (char *)sbrk(require);
1284 #ifdef DEBUGGING_MSTATS
1287 if (cp == (char *)-1)
1290 sbrk_good = -1; /* Disable optimization!
1291 Continue with not-aligned... */
1294 require += sbrked_remains;
1298 if (last_sbrk_top) {
1299 sbrk_good -= SBRK_FAILURE_PRICE;
1302 ovp = (union overhead *) cp;
1304 * Round up to minimum allocation size boundary
1305 * and deduct from block count to reflect.
1308 # if NEEDED_ALIGNMENT > MEM_ALIGNBYTES
1309 if (PTR2UV(ovp) & (NEEDED_ALIGNMENT - 1))
1310 fatalcroak("Misalignment of sbrk()\n");
1313 #ifndef I286 /* Again, this should always be ok on an 80286 */
1314 if (PTR2UV(ovp) & (MEM_ALIGNBYTES - 1)) {
1315 DEBUG_m(PerlIO_printf(Perl_debug_log,
1316 "fixing sbrk(): %d bytes off machine alignement\n",
1317 (int)(PTR2UV(ovp) & (MEM_ALIGNBYTES - 1))));
1318 ovp = INT2PTR(union overhead *,(PTR2UV(ovp) + MEM_ALIGNBYTES) &
1319 (MEM_ALIGNBYTES - 1));
1321 # if defined(DEBUGGING_MSTATS)
1322 /* This is only approx. if TWO_POT_OPTIMIZE: */
1323 sbrk_slack += (1 << (bucket >> BUCKET_POW2_SHIFT));
1327 ; /* Finish `else' */
1328 sbrked_remains = require - needed;
1331 last_sbrk_top = cp + require;
1332 #ifdef DEBUGGING_MSTATS
1333 goodsbrk += require;
1339 getpages_adjacent(int require)
1341 if (require <= sbrked_remains) {
1342 sbrked_remains -= require;
1346 require -= sbrked_remains;
1347 /* We do not try to optimize sbrks here, we go for place. */
1348 cp = (char*) sbrk(require);
1349 #ifdef DEBUGGING_MSTATS
1351 goodsbrk += require;
1353 if (cp == last_sbrk_top) {
1355 last_sbrk_top = cp + require;
1357 if (cp == (char*)-1) { /* Out of memory */
1358 #ifdef DEBUGGING_MSTATS
1359 goodsbrk -= require;
1363 /* Report the failure: */
1365 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1367 add_to_chain((void*)cp, require, 0);
1368 sbrk_good -= SBRK_FAILURE_PRICE;
1380 * Allocate more memory to the indicated bucket.
1383 morecore(register int bucket)
1385 register union overhead *ovp;
1386 register int rnu; /* 2^rnu bytes will be requested */
1387 int nblks; /* become nblks blocks of the desired size */
1388 register MEM_SIZE siz, needed;
1392 if (bucket == sizeof(MEM_SIZE)*8*BUCKETS_PER_POW2) {
1394 croak("%s", "Out of memory during ridiculously large request");
1396 if (bucket > max_bucket)
1397 max_bucket = bucket;
1399 rnu = ( (bucket <= (LOG_OF_MIN_ARENA << BUCKET_POW2_SHIFT))
1401 : (bucket >> BUCKET_POW2_SHIFT) );
1402 /* This may be overwritten later: */
1403 nblks = 1 << (rnu - (bucket >> BUCKET_POW2_SHIFT)); /* how many blocks to get */
1404 needed = ((MEM_SIZE)1 << rnu) + POW2_OPTIMIZE_SURPLUS(bucket);
1405 if (nextf[rnu << BUCKET_POW2_SHIFT]) { /* 2048b bucket. */
1406 ovp = nextf[rnu << BUCKET_POW2_SHIFT] - 1 + CHUNK_SHIFT;
1407 nextf[rnu << BUCKET_POW2_SHIFT]
1408 = nextf[rnu << BUCKET_POW2_SHIFT]->ov_next;
1409 #ifdef DEBUGGING_MSTATS
1410 nmalloc[rnu << BUCKET_POW2_SHIFT]--;
1411 start_slack -= M_OVERHEAD;
1413 DEBUG_m(PerlIO_printf(Perl_debug_log,
1414 "stealing %ld bytes from %ld arena\n",
1415 (long) needed, (long) rnu << BUCKET_POW2_SHIFT));
1416 } else if (chunk_chain
1417 && (ovp = (union overhead*) get_from_chain(needed))) {
1418 DEBUG_m(PerlIO_printf(Perl_debug_log,
1419 "stealing %ld bytes from chain\n",
1421 } else if ( (ovp = (union overhead*)
1422 get_from_bigger_buckets((rnu << BUCKET_POW2_SHIFT) + 1,
1424 DEBUG_m(PerlIO_printf(Perl_debug_log,
1425 "stealing %ld bytes from bigger buckets\n",
1427 } else if (needed <= sbrked_remains) {
1428 ovp = (union overhead *)(last_sbrk_top - sbrked_remains);
1429 sbrked_remains -= needed;
1430 last_op = (char*)ovp;
1432 ovp = getpages(needed, &nblks, bucket);
1438 * Add new memory allocated to that on
1439 * free list for this hash bucket.
1441 siz = BUCKET_SIZE(bucket);
1443 *(u_char*)ovp = bucket; /* Fill index. */
1444 if (bucket <= MAX_PACKED) {
1445 ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1446 nblks = N_BLKS(bucket);
1447 # ifdef DEBUGGING_MSTATS
1448 start_slack += BLK_SHIFT(bucket);
1450 } else if (bucket < LOG_OF_MIN_ARENA * BUCKETS_PER_POW2) {
1451 ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1452 siz -= sizeof(union overhead);
1453 } else ovp++; /* One chunk per block. */
1454 #endif /* PACK_MALLOC */
1455 nextf[bucket] = ovp;
1456 #ifdef DEBUGGING_MSTATS
1457 nmalloc[bucket] += nblks;
1458 if (bucket > MAX_PACKED) {
1459 start_slack += M_OVERHEAD * nblks;
1462 while (--nblks > 0) {
1463 ovp->ov_next = (union overhead *)((caddr_t)ovp + siz);
1464 ovp = (union overhead *)((caddr_t)ovp + siz);
1466 /* Not all sbrks return zeroed memory.*/
1467 ovp->ov_next = (union overhead *)NULL;
1469 if (bucket == 7*BUCKETS_PER_POW2) { /* Special case, explanation is above. */
1470 union overhead *n_op = nextf[7*BUCKETS_PER_POW2]->ov_next;
1471 nextf[7*BUCKETS_PER_POW2] =
1472 (union overhead *)((caddr_t)nextf[7*BUCKETS_PER_POW2]
1473 - sizeof(union overhead));
1474 nextf[7*BUCKETS_PER_POW2]->ov_next = n_op;
1476 #endif /* !PACK_MALLOC */
1480 Perl_mfree(void *mp)
1482 register MEM_SIZE size;
1483 register union overhead *ovp;
1484 char *cp = (char*)mp;
1489 DEBUG_m(PerlIO_printf(Perl_debug_log,
1490 "0x%"UVxf": (%05lu) free\n",
1491 PTR2UV(cp), (unsigned long)(PL_an++)));
1495 ovp = (union overhead *)((caddr_t)cp
1496 - sizeof (union overhead) * CHUNK_SHIFT);
1498 bucket = OV_INDEX(ovp);
1500 #ifdef IGNORE_SMALL_BAD_FREE
1501 if ((bucket >= FIRST_BUCKET_WITH_CHECK)
1502 && (OV_MAGIC(ovp, bucket) != MAGIC))
1504 if (OV_MAGIC(ovp, bucket) != MAGIC)
1507 static int bad_free_warn = -1;
1508 if (bad_free_warn == -1) {
1510 char *pbf = PerlEnv_getenv("PERL_BADFREE");
1511 bad_free_warn = (pbf) ? atoi(pbf) : 1;
1516 warn("%s free() ignored",
1517 ovp->ov_rmagic == RMAGIC - 1 ? "Duplicate" : "Bad");
1519 warn("%s", "Bad free() ignored");
1521 return; /* sanity */
1524 ASSERT(ovp->ov_rmagic == RMAGIC, "chunk's head overwrite");
1525 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1527 MEM_SIZE nbytes = ovp->ov_size + 1;
1529 if ((i = nbytes & 3)) {
1532 ASSERT(*((char *)((caddr_t)ovp + nbytes - RSLOP + i))
1533 == RMAGIC_C, "chunk's tail overwrite");
1536 nbytes = (nbytes + 3) &~ 3;
1537 ASSERT(*(u_int *)((caddr_t)ovp + nbytes - RSLOP) == RMAGIC, "chunk's tail overwrite");
1539 ovp->ov_rmagic = RMAGIC - 1;
1541 ASSERT(OV_INDEX(ovp) < NBUCKETS, "chunk's head overwrite");
1542 size = OV_INDEX(ovp);
1545 ovp->ov_next = nextf[size];
1550 /* There is no need to do any locking in realloc (with an exception of
1551 trying to grow in place if we are at the end of the chain).
1552 If somebody calls us from a different thread with the same address,
1553 we are sole anyway. */
1556 Perl_realloc(void *mp, size_t nbytes)
1558 register MEM_SIZE onb;
1559 union overhead *ovp;
1562 register int bucket;
1563 int incr; /* 1 if does not fit, -1 if "easily" fits in a
1564 smaller bucket, otherwise 0. */
1565 char *cp = (char*)mp;
1567 #if defined(DEBUGGING) || !defined(PERL_CORE)
1568 MEM_SIZE size = nbytes;
1570 if ((long)nbytes < 0)
1571 croak("%s", "panic: realloc");
1574 BARK_64K_LIMIT("Reallocation",nbytes,size);
1576 return Perl_malloc(nbytes);
1578 ovp = (union overhead *)((caddr_t)cp
1579 - sizeof (union overhead) * CHUNK_SHIFT);
1580 bucket = OV_INDEX(ovp);
1582 #ifdef IGNORE_SMALL_BAD_FREE
1583 if ((bucket >= FIRST_BUCKET_WITH_CHECK)
1584 && (OV_MAGIC(ovp, bucket) != MAGIC))
1586 if (OV_MAGIC(ovp, bucket) != MAGIC)
1589 static int bad_free_warn = -1;
1590 if (bad_free_warn == -1) {
1592 char *pbf = PerlEnv_getenv("PERL_BADFREE");
1593 bad_free_warn = (pbf) ? atoi(pbf) : 1;
1598 warn("%srealloc() %signored",
1599 (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
1600 ovp->ov_rmagic == RMAGIC - 1 ? "of freed memory " : "");
1602 warn("%s", "Bad realloc() ignored");
1604 return Nullch; /* sanity */
1607 onb = BUCKET_SIZE_REAL(bucket);
1609 * avoid the copy if same size block.
1610 * We are not agressive with boundary cases. Note that it might
1611 * (for a small number of cases) give false negative if
1612 * both new size and old one are in the bucket for
1613 * FIRST_BIG_POW2, but the new one is near the lower end.
1615 * We do not try to go to 1.5 times smaller bucket so far.
1617 if (nbytes > onb) incr = 1;
1619 #ifdef DO_NOT_TRY_HARDER_WHEN_SHRINKING
1620 if ( /* This is a little bit pessimal if PACK_MALLOC: */
1621 nbytes > ( (onb >> 1) - M_OVERHEAD )
1622 # ifdef TWO_POT_OPTIMIZE
1623 || (bucket == FIRST_BIG_POW2 && nbytes >= LAST_SMALL_BOUND )
1626 #else /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1627 prev_bucket = ( (bucket > MAX_PACKED + 1)
1628 ? bucket - BUCKETS_PER_POW2
1630 if (nbytes > BUCKET_SIZE_REAL(prev_bucket))
1631 #endif /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1635 #ifdef STRESS_REALLOC
1642 * Record new allocated size of block and
1643 * bound space with magic numbers.
1645 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1646 int i, nb = ovp->ov_size + 1;
1651 ASSERT(*((char *)((caddr_t)ovp + nb - RSLOP + i)) == RMAGIC_C, "chunk's tail overwrite");
1655 ASSERT(*(u_int *)((caddr_t)ovp + nb - RSLOP) == RMAGIC, "chunk's tail overwrite");
1657 * Convert amount of memory requested into
1658 * closest block size stored in hash buckets
1659 * which satisfies request. Account for
1660 * space used per block for accounting.
1662 nbytes += M_OVERHEAD;
1663 ovp->ov_size = nbytes - 1;
1664 if ((i = nbytes & 3)) {
1667 *((char *)((caddr_t)ovp + nbytes - RSLOP + i))
1670 nbytes = (nbytes + 3) &~ 3;
1671 *((u_int *)((caddr_t)ovp + nbytes - RSLOP)) = RMAGIC;
1675 DEBUG_m(PerlIO_printf(Perl_debug_log,
1676 "0x%"UVxf": (%05lu) realloc %ld bytes inplace\n",
1677 PTR2UV(res),(unsigned long)(PL_an++),
1679 } else if (incr == 1 && (cp - M_OVERHEAD == last_op)
1680 && (onb > (1 << LOG_OF_MIN_ARENA))) {
1681 MEM_SIZE require, newarena = nbytes, pow;
1684 POW2_OPTIMIZE_ADJUST(newarena);
1685 newarena = newarena + M_OVERHEAD;
1686 /* newarena = (newarena + 3) &~ 3; */
1687 shiftr = (newarena - 1) >> LOG_OF_MIN_ARENA;
1688 pow = LOG_OF_MIN_ARENA + 1;
1689 /* apart from this loop, this is O(1) */
1690 while (shiftr >>= 1)
1692 newarena = (1 << pow) + POW2_OPTIMIZE_SURPLUS(pow * BUCKETS_PER_POW2);
1693 require = newarena - onb - M_OVERHEAD;
1696 if (cp - M_OVERHEAD == last_op /* We *still* are the last chunk */
1697 && getpages_adjacent(require)) {
1698 #ifdef DEBUGGING_MSTATS
1700 nmalloc[pow * BUCKETS_PER_POW2]++;
1702 *(cp - M_OVERHEAD) = pow * BUCKETS_PER_POW2; /* Fill index. */
1711 DEBUG_m(PerlIO_printf(Perl_debug_log,
1712 "0x%"UVxf": (%05lu) realloc %ld bytes the hard way\n",
1713 PTR2UV(cp),(unsigned long)(PL_an++),
1715 if ((res = (char*)Perl_malloc(nbytes)) == NULL)
1717 if (cp != res) /* common optimization */
1718 Copy(cp, res, (MEM_SIZE)(nbytes<onb?nbytes:onb), char);
1721 return ((Malloc_t)res);
1725 * Search ``srchlen'' elements of each free list for a block whose
1726 * header starts at ``freep''. If srchlen is -1 search the whole list.
1727 * Return bucket number, or -1 if not found.
1730 findbucket(union overhead *freep, int srchlen)
1732 register union overhead *p;
1735 for (i = 0; i < NBUCKETS; i++) {
1737 for (p = nextf[i]; p && j != srchlen; p = p->ov_next) {
1747 Perl_calloc(register size_t elements, register size_t size)
1749 long sz = elements * size;
1750 Malloc_t p = Perl_malloc(sz);
1753 memset((void*)p, 0, sz);
1759 Perl_strdup(const char *s)
1761 MEM_SIZE l = strlen(s);
1762 char *s1 = (char *)Perl_malloc(l+1);
1764 Copy(s, s1, (MEM_SIZE)(l+1), char);
1770 Perl_putenv(char *a)
1772 /* Sometimes system's putenv conflicts with my_setenv() - this is system
1773 malloc vs Perl's free(). */
1780 while (*val && *val != '=')
1785 if (l < sizeof(buf))
1788 var = Perl_malloc(l + 1);
1789 Copy(a, var, l, char);
1791 my_setenv(var, val+1);
1799 Perl_malloced_size(void *p)
1801 union overhead *ovp = (union overhead *)
1802 ((caddr_t)p - sizeof (union overhead) * CHUNK_SHIFT);
1803 int bucket = OV_INDEX(ovp);
1805 /* The caller wants to have a complete control over the chunk,
1806 disable the memory checking inside the chunk. */
1807 if (bucket <= MAX_SHORT_BUCKET) {
1808 MEM_SIZE size = BUCKET_SIZE_REAL(bucket);
1809 ovp->ov_size = size + M_OVERHEAD - 1;
1810 *((u_int *)((caddr_t)ovp + size + M_OVERHEAD - RSLOP)) = RMAGIC;
1813 return BUCKET_SIZE_REAL(bucket);
1816 # ifdef BUCKETS_ROOT2
1817 # define MIN_EVEN_REPORT 6
1819 # define MIN_EVEN_REPORT MIN_BUCKET
1823 Perl_get_mstats(pTHX_ perl_mstats_t *buf, int buflen, int level)
1825 #ifdef DEBUGGING_MSTATS
1827 register union overhead *p;
1828 struct chunk_chain_s* nextchain;
1830 buf->topbucket = buf->topbucket_ev = buf->topbucket_odd
1831 = buf->totfree = buf->total = buf->total_chain = 0;
1833 buf->minbucket = MIN_BUCKET;
1835 for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
1836 for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
1840 buf->ntotal[i] = nmalloc[i];
1842 buf->totfree += j * BUCKET_SIZE_REAL(i);
1843 buf->total += nmalloc[i] * BUCKET_SIZE_REAL(i);
1845 i % 2 ? (buf->topbucket_odd = i) : (buf->topbucket_ev = i);
1849 nextchain = chunk_chain;
1851 buf->total_chain += nextchain->size;
1852 nextchain = nextchain->next;
1854 buf->total_sbrk = goodsbrk + sbrk_slack;
1856 buf->sbrk_good = sbrk_good;
1857 buf->sbrk_slack = sbrk_slack;
1858 buf->start_slack = start_slack;
1859 buf->sbrked_remains = sbrked_remains;
1862 for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
1865 buf->bucket_mem_size[i] = BUCKET_SIZE(i);
1866 buf->bucket_available_size[i] = BUCKET_SIZE_REAL(i);
1869 #endif /* defined DEBUGGING_MSTATS */
1872 * mstats - print out statistics about malloc
1874 * Prints two lines of numbers, one showing the length of the free list
1875 * for each size category, the second showing the number of mallocs -
1876 * frees for each size category.
1879 Perl_dump_mstats(pTHX_ char *s)
1881 #ifdef DEBUGGING_MSTATS
1883 register union overhead *p;
1884 perl_mstats_t buffer;
1885 unsigned long nf[NBUCKETS];
1886 unsigned long nt[NBUCKETS];
1887 struct chunk_chain_s* nextchain;
1891 get_mstats(&buffer, NBUCKETS, 0);
1894 PerlIO_printf(Perl_error_log,
1895 "Memory allocation statistics %s (buckets %ld(%ld)..%ld(%ld)\n",
1897 (long)BUCKET_SIZE_REAL(MIN_BUCKET),
1898 (long)BUCKET_SIZE(MIN_BUCKET),
1899 (long)BUCKET_SIZE_REAL(buffer.topbucket),
1900 (long)BUCKET_SIZE(buffer.topbucket));
1901 PerlIO_printf(Perl_error_log, "%8d free:", buffer.totfree);
1902 for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
1903 PerlIO_printf(Perl_error_log,
1904 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1906 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1909 #ifdef BUCKETS_ROOT2
1910 PerlIO_printf(Perl_error_log, "\n\t ");
1911 for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
1912 PerlIO_printf(Perl_error_log,
1913 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1915 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1919 PerlIO_printf(Perl_error_log, "\n%8d used:", buffer.total - buffer.totfree);
1920 for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
1921 PerlIO_printf(Perl_error_log,
1922 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1924 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1925 buffer.ntotal[i] - buffer.nfree[i]);
1927 #ifdef BUCKETS_ROOT2
1928 PerlIO_printf(Perl_error_log, "\n\t ");
1929 for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
1930 PerlIO_printf(Perl_error_log,
1931 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1933 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1934 buffer.ntotal[i] - buffer.nfree[i]);
1937 PerlIO_printf(Perl_error_log, "\nTotal sbrk(): %d/%d:%d. Odd ends: pad+heads+chain+tail: %d+%d+%d+%d.\n",
1938 buffer.total_sbrk, buffer.sbrks, buffer.sbrk_good,
1939 buffer.sbrk_slack, buffer.start_slack,
1940 buffer.total_chain, buffer.sbrked_remains);
1941 #endif /* DEBUGGING_MSTATS */
1945 #ifdef USE_PERL_SBRK
1947 # if defined(__MACHTEN_PPC__) || defined(NeXT) || defined(__NeXT__) || defined(PURIFY)
1948 # define PERL_SBRK_VIA_MALLOC
1950 * MachTen's malloc() returns a buffer aligned on a two-byte boundary.
1951 * While this is adequate, it may slow down access to longer data
1952 * types by forcing multiple memory accesses. It also causes
1953 * complaints when RCHECK is in force. So we allocate six bytes
1954 * more than we need to, and return an address rounded up to an
1955 * eight-byte boundary.
1957 * 980701 Dominic Dunlop <domo@computer.org>
1959 # define SYSTEM_ALLOC_ALIGNMENT 2
1962 # ifdef PERL_SBRK_VIA_MALLOC
1964 /* it may seem schizophrenic to use perl's malloc and let it call system */
1965 /* malloc, the reason for that is only the 3.2 version of the OS that had */
1966 /* frequent core dumps within nxzonefreenolock. This sbrk routine put an */
1967 /* end to the cores */
1969 # ifndef SYSTEM_ALLOC
1970 # define SYSTEM_ALLOC(a) malloc(a)
1972 # ifndef SYSTEM_ALLOC_ALIGNMENT
1973 # define SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
1976 # endif /* PERL_SBRK_VIA_MALLOC */
1978 static IV Perl_sbrk_oldchunk;
1979 static long Perl_sbrk_oldsize;
1981 # define PERLSBRK_32_K (1<<15)
1982 # define PERLSBRK_64_K (1<<16)
1990 if (!size) return 0;
1992 reqsize = size; /* just for the DEBUG_m statement */
1995 size = (size + 0x7ff) & ~0x7ff;
1997 if (size <= Perl_sbrk_oldsize) {
1998 got = Perl_sbrk_oldchunk;
1999 Perl_sbrk_oldchunk += size;
2000 Perl_sbrk_oldsize -= size;
2002 if (size >= PERLSBRK_32_K) {
2005 size = PERLSBRK_64_K;
2008 # if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2009 size += NEEDED_ALIGNMENT - SYSTEM_ALLOC_ALIGNMENT;
2011 got = (IV)SYSTEM_ALLOC(size);
2012 # if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2013 got = (got + NEEDED_ALIGNMENT - 1) & ~(NEEDED_ALIGNMENT - 1);
2016 /* Chunk is small, register the rest for future allocs. */
2017 Perl_sbrk_oldchunk = got + reqsize;
2018 Perl_sbrk_oldsize = size - reqsize;
2022 DEBUG_m(PerlIO_printf(Perl_debug_log, "sbrk malloc size %ld (reqsize %ld), left size %ld, give addr 0x%"UVxf"\n",
2023 size, reqsize, Perl_sbrk_oldsize, PTR2UV(got)));
2028 #endif /* ! defined USE_PERL_SBRK */