5 #if defined(PERL_CORE) && !defined(DEBUGGING_MSTATS)
6 # define DEBUGGING_MSTATS
10 # if defined(DEBUGGING) && !defined(NO_RCHECK)
14 * malloc.c (Caltech) 2/21/82
15 * Chris Kingsley, kingsley@cit-20.
17 * This is a very fast storage allocator. It allocates blocks of a small
18 * number of different sizes, and keeps free lists of each size. Blocks that
19 * don't exactly fit are passed up to the next larger size. In this
20 * implementation, the available sizes are 2^n-4 (or 2^n-12) bytes long.
21 * If PACK_MALLOC is defined, small blocks are 2^n bytes long.
22 * This is designed for use in a program that uses vast quantities of memory,
23 * but bombs when it runs out.
31 #define DEBUG_m(a) if (debug & 128) a
34 /* I don't much care whether these are defined in sys/types.h--LAW */
36 #define u_char unsigned char
37 #define u_int unsigned int
38 #define u_short unsigned short
40 /* 286 and atarist like big chunks, which gives too much overhead. */
41 #if (defined(RCHECK) || defined(I286) || defined(atarist)) && defined(PACK_MALLOC)
47 * The description below is applicable if PACK_MALLOC is not defined.
49 * The overhead on a block is at least 4 bytes. When free, this space
50 * contains a pointer to the next free block, and the bottom two bits must
51 * be zero. When in use, the first byte is set to MAGIC, and the second
52 * byte is the size index. The remaining bytes are for alignment.
53 * If range checking is enabled and the size of the block fits
54 * in two bytes, then the top two bytes hold the size of the requested block
55 * plus the range checking words, and the header word MINUS ONE.
58 union overhead *ov_next; /* when free */
59 #if MEM_ALIGNBYTES > 4
60 double strut; /* alignment problems */
63 u_char ovu_magic; /* magic number */
64 u_char ovu_index; /* bucket # */
66 u_short ovu_size; /* actual block size */
67 u_int ovu_rmagic; /* range magic number */
70 #define ov_magic ovu.ovu_magic
71 #define ov_index ovu.ovu_index
72 #define ov_size ovu.ovu_size
73 #define ov_rmagic ovu.ovu_rmagic
77 static void botch _((char *s));
79 static void morecore _((int bucket));
80 static int findbucket _((union overhead *freep, int srchlen));
82 #define MAGIC 0xff /* magic # on accounting info */
83 #define RMAGIC 0x55555555 /* magic # on range info */
85 # define RSLOP sizeof (u_int)
86 # ifdef TWO_POT_OPTIMIZE
87 # define MAX_SHORT_BUCKET 12
89 # define MAX_SHORT_BUCKET 13
97 * In this case it is assumed that if we do sbrk() in 2K units, we
98 * will get 2K aligned blocks. The bucket number of the given subblock is
99 * on the boundary of 2K block which contains the subblock.
100 * Several following bytes contain the magic numbers for the subblocks
103 * Sizes of chunks are powers of 2 for chunks in buckets <=
104 * MAX_PACKED, after this they are (2^n - sizeof(union overhead)) (to
105 * get alignment right).
107 * We suppose that starts of all the chunks in a 2K block are in
108 * different 2^n-byte-long chunks. If the top of the last chunk is
109 * aligned on a boundary of 2K block, this means that
110 * sizeof(union overhead)*"number of chunks" < 2^n, or
111 * sizeof(union overhead)*2K < 4^n, or n > 6 + log2(sizeof()/2)/2, if a
112 * chunk of size 2^n - overhead is used. Since this rules out n = 7
113 * for 8 byte alignment, we specialcase allocation of the first of 16
114 * 128-byte-long chunks.
116 * Note that with the above assumption we automatically have enough
117 * place for MAGIC at the start of 2K block. Note also that we
118 * overlay union overhead over the chunk, thus the start of the chunk
119 * is immediately overwritten after freeing.
121 # define MAX_PACKED 6
122 # define MAX_2_POT_ALGO ((1<<(MAX_PACKED + 1)) - M_OVERHEAD)
123 # define TWOK_MASK ((1<<11) - 1)
124 # define TWOK_MASKED(x) ((u_int)(x) & ~TWOK_MASK)
125 # define TWOK_SHIFT(x) ((u_int)(x) & TWOK_MASK)
126 # define OV_INDEXp(block) ((u_char*)(TWOK_MASKED(block)))
127 # define OV_INDEX(block) (*OV_INDEXp(block))
128 # define OV_MAGIC(block,bucket) (*(OV_INDEXp(block) + \
129 (TWOK_SHIFT(block)>>(bucket + 3)) + \
130 (bucket > MAX_NONSHIFT ? 1 : 0)))
131 # define CHUNK_SHIFT 0
133 static u_char n_blks[11 - 3] = {224, 120, 62, 31, 16, 8, 4, 2};
134 static u_short blk_shift[11 - 3] = {256, 128, 64, 32,
135 16*sizeof(union overhead),
136 8*sizeof(union overhead),
137 4*sizeof(union overhead),
138 2*sizeof(union overhead),
139 # define MAX_NONSHIFT 2 /* Shift 64 greater than chunk 32. */
142 #else /* !PACK_MALLOC */
144 # define OV_MAGIC(block,bucket) (block)->ov_magic
145 # define OV_INDEX(block) (block)->ov_index
146 # define CHUNK_SHIFT 1
147 #endif /* !PACK_MALLOC */
149 # define M_OVERHEAD (sizeof(union overhead) + RSLOP)
152 * Big allocations are often of the size 2^n bytes. To make them a
153 * little bit better, make blocks of size 2^n+pagesize for big n.
156 #ifdef TWO_POT_OPTIMIZE
158 # ifndef PERL_PAGESIZE
159 # define PERL_PAGESIZE 4096
161 # ifndef FIRST_BIG_TWO_POT
162 # define FIRST_BIG_TWO_POT 14 /* 16K */
164 # define FIRST_BIG_BLOCK (1<<FIRST_BIG_TWO_POT) /* 16K */
165 /* If this value or more, check against bigger blocks. */
166 # define FIRST_BIG_BOUND (FIRST_BIG_BLOCK - M_OVERHEAD)
167 /* If less than this value, goes into 2^n-overhead-block. */
168 # define LAST_SMALL_BOUND ((FIRST_BIG_BLOCK>>1) - M_OVERHEAD)
170 #endif /* TWO_POT_OPTIMIZE */
172 #if defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)
175 # define BIG_SIZE (1<<16) /* 64K */
178 static char *emergency_buffer;
179 static MEM_SIZE emergency_buffer_size;
185 if (size >= BIG_SIZE) {
186 /* Give the possibility to recover: */
187 die("Out of memory during request for %i bytes", size);
188 /* croak may eat too much memory. */
191 if (!emergency_buffer) {
193 /* First offense, give a possibility to recover by dieing. */
194 /* No malloc involved here: */
195 GV **gvp = (GV**)hv_fetch(defstash, "^M", 2, 0);
199 if (!gvp) gvp = (GV**)hv_fetch(defstash, "\015", 1, 0);
200 if (!gvp || !(sv = GvSV(*gvp)) || !SvPOK(sv)
201 || (SvLEN(sv) < (1<<11) - M_OVERHEAD))
202 return (char *)-1; /* Now die die die... */
204 /* Got it, now detach SvPV: */
206 /* Check alignment: */
207 if (((u_int)(pv - M_OVERHEAD)) & ((1<<11) - 1)) {
208 PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
209 return (char *)-1; /* die die die */
212 emergency_buffer = pv - M_OVERHEAD;
213 emergency_buffer_size = SvLEN(sv) + M_OVERHEAD;
216 die("Out of memory!"); /* croak may eat too much memory. */
218 else if (emergency_buffer_size >= size) {
219 emergency_buffer_size -= size;
220 return emergency_buffer + emergency_buffer_size;
223 return (char *)-1; /* poor guy... */
226 #else /* !(defined(TWO_POT_OPTIMIZE) && defined(PERL_CORE)) */
227 # define emergency_sbrk(size) -1
228 #endif /* !(defined(TWO_POT_OPTIMIZE) && defined(PERL_CORE)) */
231 * nextf[i] is the pointer to the next free block of size 2^(i+3). The
232 * smallest allocatable block is 8 bytes. The overhead information
233 * precedes the data area returned to the user.
236 static union overhead *nextf[NBUCKETS];
239 #define sbrk(a) Perl_sbrk(a)
240 Malloc_t Perl_sbrk _((int size));
242 #ifdef DONT_DECLARE_STD
247 extern Malloc_t sbrk(int);
251 #ifdef DEBUGGING_MSTATS
253 * nmalloc[i] is the difference between the number of mallocs and frees
254 * for a given block size.
256 static u_int nmalloc[NBUCKETS];
257 static u_int goodsbrk;
258 static u_int sbrk_slack;
259 static u_int start_slack;
263 #define ASSERT(p) if (!(p)) botch(STRINGIFY(p)); else
267 PerlIO_printf(PerlIO_stderr(), "assertion botched: %s\n", s);
275 malloc(register size_t nbytes)
277 register union overhead *p;
278 register int bucket = 0;
279 register MEM_SIZE shiftr;
281 #if defined(DEBUGGING) || defined(RCHECK)
282 MEM_SIZE size = nbytes;
287 if (nbytes > 0xffff) {
288 PerlIO_printf(PerlIO_stderr(),
289 "Allocation too large: %lx\n", (long)nbytes);
292 #endif /* HAS_64K_LIMIT */
294 if ((long)nbytes < 0)
295 croak("panic: malloc");
297 #endif /* PERL_CORE */
299 MUTEX_LOCK(&malloc_mutex);
301 * Convert amount of memory requested into
302 * closest block size stored in hash buckets
303 * which satisfies request. Account for
304 * space used per block for accounting.
309 else if (nbytes > MAX_2_POT_ALGO)
312 #ifdef TWO_POT_OPTIMIZE
313 if (nbytes >= FIRST_BIG_BOUND)
314 nbytes -= PERL_PAGESIZE;
316 nbytes += M_OVERHEAD;
317 nbytes = (nbytes + 3) &~ 3;
319 shiftr = (nbytes - 1) >> 2;
320 /* apart from this loop, this is O(1) */
324 * If nothing in hash bucket right now,
325 * request more memory from the system.
327 if (nextf[bucket] == NULL)
329 if ((p = (union overhead *)nextf[bucket]) == NULL) {
330 MUTEX_UNLOCK(&malloc_mutex);
333 PerlIO_puts(PerlIO_stderr(),"Out of memory!\n");
342 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%lx: (%05lu) malloc %ld bytes\n",
343 (unsigned long)(p+1),(unsigned long)(an++),(long)size));
344 #endif /* PERL_CORE */
346 /* remove from linked list */
348 if (*((int*)p) & (sizeof(union overhead) - 1))
349 PerlIO_printf(PerlIO_stderr(), "Corrupt malloc ptr 0x%lx at 0x%lx\n",
350 (unsigned long)*((int*)p),(unsigned long)p);
352 nextf[bucket] = p->ov_next;
353 OV_MAGIC(p, bucket) = MAGIC;
355 OV_INDEX(p) = bucket;
359 * Record allocated size of block and
360 * bound space with magic numbers.
362 nbytes = (size + M_OVERHEAD + 3) &~ 3;
363 if (nbytes <= 0x10000)
364 p->ov_size = nbytes - 1;
365 p->ov_rmagic = RMAGIC;
366 *((u_int *)((caddr_t)p + nbytes - RSLOP)) = RMAGIC;
368 MUTEX_UNLOCK(&malloc_mutex);
369 return ((Malloc_t)(p + CHUNK_SHIFT));
373 * Allocate more memory to the indicated bucket.
376 morecore(register int bucket)
378 register union overhead *ovp;
379 register int rnu; /* 2^rnu bytes will be requested */
380 register int nblks; /* become nblks blocks of the desired size */
381 register MEM_SIZE siz, needed;
386 if (bucket == (sizeof(MEM_SIZE)*8 - 3)) {
387 croak("Allocation too large");
390 * Insure memory is allocated
391 * on a page boundary. Should
392 * make getpageize call?
394 #ifndef atarist /* on the atari we dont have to worry about this */
395 ovp = (union overhead *)sbrk(0);
397 if ((UV)ovp & (0x7FF >> CHUNK_SHIFT)) {
398 slack = (0x800 >> CHUNK_SHIFT) - ((UV)ovp & (0x7FF >> CHUNK_SHIFT));
400 # if defined(DEBUGGING_MSTATS)
405 /* The sbrk(0) call on the I286 always returns the next segment */
409 #if !(defined(I286) || defined(atarist))
410 /* take 2k unless the block is bigger than that */
411 rnu = (bucket <= 8) ? 11 : bucket + 3;
413 /* take 16k unless the block is bigger than that
414 (80286s like large segments!), probably good on the atari too */
415 rnu = (bucket <= 11) ? 14 : bucket + 3;
417 nblks = 1 << (rnu - (bucket + 3)); /* how many blocks to get */
418 needed = (MEM_SIZE)1 << rnu;
419 #ifdef TWO_POT_OPTIMIZE
420 needed += (bucket >= (FIRST_BIG_TWO_POT - 3) ? PERL_PAGESIZE : 0);
422 ovp = (union overhead *)sbrk(needed);
424 if (ovp == (union overhead *)-1) {
425 ovp = (union overhead *)emergency_sbrk(needed);
426 if (ovp == (union overhead *)-1)
429 #ifdef DEBUGGING_MSTATS
433 * Round up to minimum allocation size boundary
434 * and deduct from block count to reflect.
439 croak("panic: Off-page sbrk");
442 ovp = (union overhead *)(((UV)ovp + 8) & ~7);
446 /* Again, this should always be ok on an 80286 */
449 * Add new memory allocated to that on
450 * free list for this hash bucket.
452 siz = 1 << (bucket + 3);
454 *(u_char*)ovp = bucket; /* Fill index. */
455 if (bucket <= MAX_PACKED - 3) {
456 ovp = (union overhead *) ((char*)ovp + blk_shift[bucket]);
457 nblks = n_blks[bucket];
458 # ifdef DEBUGGING_MSTATS
459 start_slack += blk_shift[bucket];
461 } else if (bucket <= 11 - 1 - 3) {
462 ovp = (union overhead *) ((char*)ovp + blk_shift[bucket]);
463 /* nblks = n_blks[bucket]; */
464 siz -= sizeof(union overhead);
465 } else ovp++; /* One chunk per block. */
466 #endif /* !PACK_MALLOC */
468 #ifdef DEBUGGING_MSTATS
469 nmalloc[bucket] += nblks;
471 while (--nblks > 0) {
472 ovp->ov_next = (union overhead *)((caddr_t)ovp + siz);
473 ovp = (union overhead *)((caddr_t)ovp + siz);
475 /* Not all sbrks return zeroed memory.*/
476 ovp->ov_next = (union overhead *)NULL;
478 if (bucket == 7 - 3) { /* Special case, explanation is above. */
479 union overhead *n_op = nextf[7 - 3]->ov_next;
480 nextf[7 - 3] = (union overhead *)((caddr_t)nextf[7 - 3]
481 - sizeof(union overhead));
482 nextf[7 - 3]->ov_next = n_op;
484 #endif /* !PACK_MALLOC */
490 register MEM_SIZE size;
491 register union overhead *ovp;
492 char *cp = (char*)mp;
498 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%lx: (%05lu) free\n",(unsigned long)cp,(unsigned long)(an++)));
499 #endif /* PERL_CORE */
503 ovp = (union overhead *)((caddr_t)cp
504 - sizeof (union overhead) * CHUNK_SHIFT);
506 bucket = OV_INDEX(ovp);
508 if (OV_MAGIC(ovp, bucket) != MAGIC) {
509 static int bad_free_warn = -1;
510 if (bad_free_warn == -1) {
511 char *pbf = PerlEnv_getenv("PERL_BADFREE");
512 bad_free_warn = (pbf) ? atoi(pbf) : 1;
517 warn("%s free() ignored",
518 ovp->ov_rmagic == RMAGIC - 1 ? "Duplicate" : "Bad");
520 warn("Bad free() ignored");
524 MUTEX_LOCK(&malloc_mutex);
526 ASSERT(ovp->ov_rmagic == RMAGIC);
527 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET)
528 ASSERT(*(u_int *)((caddr_t)ovp + ovp->ov_size + 1 - RSLOP) == RMAGIC);
529 ovp->ov_rmagic = RMAGIC - 1;
531 ASSERT(OV_INDEX(ovp) < NBUCKETS);
532 size = OV_INDEX(ovp);
533 ovp->ov_next = nextf[size];
535 MUTEX_UNLOCK(&malloc_mutex);
539 * When a program attempts "storage compaction" as mentioned in the
540 * old malloc man page, it realloc's an already freed block. Usually
541 * this is the last block it freed; occasionally it might be farther
542 * back. We have to search all the free lists for the block in order
543 * to determine its bucket: 1st we make one pass thru the lists
544 * checking only the first block in each; if that fails we search
545 * ``reall_srchlen'' blocks in each list for a match (the variable
546 * is extern so the caller can modify it). If that fails we just copy
547 * however many bytes was given to realloc() and hope it's not huge.
549 int reall_srchlen = 4; /* 4 should be plenty, -1 =>'s whole list */
552 realloc(void *mp, size_t nbytes)
554 register MEM_SIZE onb;
559 char *cp = (char*)mp;
562 MEM_SIZE size = nbytes;
567 if (nbytes > 0xffff) {
568 PerlIO_printf(PerlIO_stderr(),
569 "Reallocation too large: %lx\n", size);
572 #endif /* HAS_64K_LIMIT */
574 return malloc(nbytes);
576 if ((long)nbytes < 0)
577 croak("panic: realloc");
579 #endif /* PERL_CORE */
581 MUTEX_LOCK(&malloc_mutex);
582 ovp = (union overhead *)((caddr_t)cp
583 - sizeof (union overhead) * CHUNK_SHIFT);
585 if (OV_MAGIC(ovp, i) == MAGIC) {
589 * Already free, doing "compaction".
591 * Search for the old block of memory on the
592 * free list. First, check the most common
593 * case (last element free'd), then (this failing)
594 * the last ``reall_srchlen'' items free'd.
595 * If all lookups fail, then assume the size of
596 * the memory block being realloc'd is the
599 if ((i = findbucket(ovp, 1)) < 0 &&
600 (i = findbucket(ovp, reall_srchlen)) < 0)
603 onb = (1L << (i + 3)) -
605 (i <= (MAX_PACKED - 3) ? 0 : M_OVERHEAD)
609 #ifdef TWO_POT_OPTIMIZE
610 + (i >= (FIRST_BIG_TWO_POT - 3) ? PERL_PAGESIZE : 0)
614 * avoid the copy if same size block.
615 * We are not agressive with boundary cases. Note that it is
616 * possible for small number of cases give false negative if
617 * both new size and old one are in the bucket for
618 * FIRST_BIG_TWO_POT, but the new one is near the lower end.
621 nbytes <= onb && (nbytes > ( (onb >> 1) - M_OVERHEAD )
622 #ifdef TWO_POT_OPTIMIZE
623 || (i == (FIRST_BIG_TWO_POT - 3)
624 && nbytes >= LAST_SMALL_BOUND )
629 * Record new allocated size of block and
630 * bound space with magic numbers.
632 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
634 * Convert amount of memory requested into
635 * closest block size stored in hash buckets
636 * which satisfies request. Account for
637 * space used per block for accounting.
639 nbytes += M_OVERHEAD;
640 nbytes = (nbytes + 3) &~ 3;
641 ovp->ov_size = nbytes - 1;
642 *((u_int *)((caddr_t)ovp + nbytes - RSLOP)) = RMAGIC;
646 MUTEX_UNLOCK(&malloc_mutex);
649 MUTEX_UNLOCK(&malloc_mutex);
650 if ((res = (char*)malloc(nbytes)) == NULL)
652 if (cp != res) /* common optimization */
653 Copy(cp, res, (MEM_SIZE)(nbytes<onb?nbytes:onb), char);
661 PerlIO_printf(Perl_debug_log, "0x%lx: (%05lu) rfree\n",(unsigned long)res,(unsigned long)(an++));
662 PerlIO_printf(Perl_debug_log, "0x%lx: (%05lu) realloc %ld bytes\n",
663 (unsigned long)res,(unsigned long)(an++),(long)size);
666 #endif /* PERL_CORE */
667 return ((Malloc_t)res);
671 * Search ``srchlen'' elements of each free list for a block whose
672 * header starts at ``freep''. If srchlen is -1 search the whole list.
673 * Return bucket number, or -1 if not found.
676 findbucket(union overhead *freep, int srchlen)
678 register union overhead *p;
681 for (i = 0; i < NBUCKETS; i++) {
683 for (p = nextf[i]; p && j != srchlen; p = p->ov_next) {
693 calloc(register size_t elements, register size_t size)
695 long sz = elements * size;
696 Malloc_t p = malloc(sz);
699 memset((void*)p, 0, sz);
704 #ifdef DEBUGGING_MSTATS
706 * mstats - print out statistics about malloc
708 * Prints two lines of numbers, one showing the length of the free list
709 * for each size category, the second showing the number of mallocs -
710 * frees for each size category.
716 register union overhead *p;
717 int topbucket=0, totfree=0, total=0;
718 u_int nfree[NBUCKETS];
720 for (i=0; i < NBUCKETS; i++) {
721 for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
724 totfree += nfree[i] * (1 << (i + 3));
725 total += nmalloc[i] * (1 << (i + 3));
730 PerlIO_printf(PerlIO_stderr(), "Memory allocation statistics %s (buckets 8..%d)\n",
731 s, (1 << (topbucket + 3)) );
732 PerlIO_printf(PerlIO_stderr(), "%8d free:", totfree);
733 for (i=0; i <= topbucket; i++) {
734 PerlIO_printf(PerlIO_stderr(), (i<5 || i==7)?" %5d": (i<9)?" %3d":" %d", nfree[i]);
736 PerlIO_printf(PerlIO_stderr(), "\n%8d used:", total - totfree);
737 for (i=0; i <= topbucket; i++) {
738 PerlIO_printf(PerlIO_stderr(), (i<5 || i==7)?" %5d": (i<9)?" %3d":" %d", nmalloc[i] - nfree[i]);
740 PerlIO_printf(PerlIO_stderr(), "\nTotal sbrk(): %8d. Odd ends: sbrk(): %7d, malloc(): %7d bytes.\n",
741 goodsbrk + sbrk_slack, sbrk_slack, start_slack);
755 # define PERL_SBRK_VIA_MALLOC
758 # ifdef PERL_SBRK_VIA_MALLOC
759 # if defined(HIDEMYMALLOC) || defined(EMBEDMYMALLOC)
762 # include "Error: -DPERL_SBRK_VIA_MALLOC needs -D(HIDE|EMBED)MYMALLOC"
765 /* it may seem schizophrenic to use perl's malloc and let it call system */
766 /* malloc, the reason for that is only the 3.2 version of the OS that had */
767 /* frequent core dumps within nxzonefreenolock. This sbrk routine put an */
768 /* end to the cores */
770 # define SYSTEM_ALLOC(a) malloc(a)
772 # endif /* PERL_SBRK_VIA_MALLOC */
774 static IV Perl_sbrk_oldchunk;
775 static long Perl_sbrk_oldsize;
777 # define PERLSBRK_32_K (1<<15)
778 # define PERLSBRK_64_K (1<<16)
789 reqsize = size; /* just for the DEBUG_m statement */
792 size = (size + 0x7ff) & ~0x7ff;
794 if (size <= Perl_sbrk_oldsize) {
795 got = Perl_sbrk_oldchunk;
796 Perl_sbrk_oldchunk += size;
797 Perl_sbrk_oldsize -= size;
799 if (size >= PERLSBRK_32_K) {
805 size = PERLSBRK_64_K;
808 got = (IV)SYSTEM_ALLOC(size);
810 got = (got + 0x7ff) & ~0x7ff;
813 /* Chunk is small, register the rest for future allocs. */
814 Perl_sbrk_oldchunk = got + reqsize;
815 Perl_sbrk_oldsize = size - reqsize;
820 DEBUG_m(PerlIO_printf(Perl_debug_log, "sbrk malloc size %ld (reqsize %ld), left size %ld, give addr 0x%lx\n",
821 size, reqsize, Perl_sbrk_oldsize, got));
827 #endif /* ! defined USE_PERL_SBRK */