This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
update perldelta for change#4356
[perl5.git] / malloc.c
CommitLineData
a0d0e21e 1/* malloc.c
8d063cd8 2 *
8d063cd8
LW
3 */
4
87c6202a 5/*
741df71a
IZ
6 Here are some notes on configuring Perl's malloc. (For non-perl
7 usage see below.)
87c6202a
IZ
8
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.
15
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).
20
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.
25
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)
29
30 # Enable code for printing memory statistics.
31 DEBUGGING_MSTATS (!PLAIN_MALLOC && PERL_CORE)
32
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)
38
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
41 # processing.
42 TWO_POT_OPTIMIZE !PLAIN_MALLOC
43
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
47
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)
51
52 # Use table lookup to decide in which bucket a given allocation will go.
53 SMALL_BUCKET_VIA_TABLE !NO_FANCY_MALLOC
54
38ac2dc8
DD
55 # Use a perl-defined sbrk() instead of the (presumably broken or
56 # missing) system-supplied sbrk().
57 USE_PERL_SBRK undef
58
59 # Use system malloc() (or calloc() etc.) to emulate sbrk(). Normally
60 # only used with broken sbrk()s.
87c6202a
IZ
61 PERL_SBRK_VIA_MALLOC undef
62
38ac2dc8
DD
63 # Which allocator to use if PERL_SBRK_VIA_MALLOC
64 SYSTEM_ALLOC(a) malloc(a)
65
9ee81ef6 66 # Minimal alignment (in bytes, should be a power of 2) of SYSTEM_ALLOC
5bbd1ef5
IZ
67 SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
68
87c6202a
IZ
69 # Disable memory overwrite checking with DEBUGGING. Memory and speed
70 # optimization, error reporting pessimization.
71 NO_RCHECK undef
72
73 # Enable memory overwrite checking with DEBUGGING. Memory and speed
74 # pessimization, error reporting optimization
75 RCHECK (DEBUGGING && !NO_RCHECK)
76
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
81
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
86
87 # Estimate of minimal memory footprint. malloc uses this value to
88 # request the most reasonable largest blocks of memory from the system.
89 FIRST_SBRK (48*1024)
90
91 # Round up sbrk()s to multiples of this.
92 MIN_SBRK 2048
93
94 # Round up sbrk()s to multiples of this percent of footprint.
95 MIN_SBRK_FRAC 3
96
97 # Add this much memory to big powers of two to get the bucket size.
98 PERL_PAGESIZE 4096
99
100 # This many sbrk() discontinuities should be tolerated even
101 # from the start without deciding that sbrk() is usually
102 # discontinuous.
103 SBRK_ALLOW_FAILURES 3
104
105 # This many continuous sbrk()s compensate for one discontinuous one.
106 SBRK_FAILURE_PRICE 50
107
28ac10b1
IZ
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
112
87c6202a
IZ
113 This implementation assumes that calling PerlIO_printf() does not
114 result in any memory allocation calls (used during a panic).
115
116 */
117
741df71a
IZ
118/*
119 If used outside of Perl environment, it may be useful to redefine
120 the following macros (listed below with defaults):
121
122 # Type of address returned by allocation functions
123 Malloc_t void *
124
125 # Type of size argument for allocation functions
126 MEM_SIZE unsigned long
127
128 # Maximal value in LONG
129 LONG_MAX 0x7FFFFFFF
130
131 # Unsigned integer type big enough to keep a pointer
132 UV unsigned long
133
134 # Type of pointer with 1-byte granularity
135 caddr_t char *
136
137 # Type returned by free()
138 Free_t void
139
5bbd1ef5
IZ
140 # Very fatal condition reporting function (cannot call any )
141 fatalcroak(arg) write(2,arg,strlen(arg)) + exit(2)
142
741df71a
IZ
143 # Fatal error reporting function
144 croak(format, arg) warn(idem) + exit(1)
145
146 # Error reporting function
147 warn(format, arg) fprintf(stderr, idem)
148
149 # Locking/unlocking for MT operation
cea2e8a9
GS
150 MALLOC_LOCK MUTEX_LOCK_NOCONTEXT(&PL_malloc_mutex)
151 MALLOC_UNLOCK MUTEX_UNLOCK_NOCONTEXT(&PL_malloc_mutex)
741df71a
IZ
152
153 # Locking/unlocking mutex for MT operation
154 MUTEX_LOCK(l) void
155 MUTEX_UNLOCK(l) void
156 */
157
e8bc2b5c
GS
158#ifndef NO_FANCY_MALLOC
159# ifndef SMALL_BUCKET_VIA_TABLE
160# define SMALL_BUCKET_VIA_TABLE
161# endif
162# ifndef BUCKETS_ROOT2
163# define BUCKETS_ROOT2
164# endif
165# ifndef IGNORE_SMALL_BAD_FREE
166# define IGNORE_SMALL_BAD_FREE
167# endif
3562ef9b
IZ
168#endif
169
e8bc2b5c
GS
170#ifndef PLAIN_MALLOC /* Bulk enable features */
171# ifndef PACK_MALLOC
172# define PACK_MALLOC
173# endif
174# ifndef TWO_POT_OPTIMIZE
175# define TWO_POT_OPTIMIZE
176# endif
d720c441
IZ
177# if defined(PERL_CORE) && !defined(PERL_EMERGENCY_SBRK)
178# define PERL_EMERGENCY_SBRK
e8bc2b5c
GS
179# endif
180# if defined(PERL_CORE) && !defined(DEBUGGING_MSTATS)
181# define DEBUGGING_MSTATS
182# endif
183#endif
184
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)
187
61ae2fbf 188#if !(defined(I286) || defined(atarist) || defined(__MINT__))
e8bc2b5c
GS
189 /* take 2k unless the block is bigger than that */
190# define LOG_OF_MIN_ARENA 11
191#else
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
195#endif
196
8d063cd8 197#ifndef lint
1944739a
IZ
198# if defined(DEBUGGING) && !defined(NO_RCHECK)
199# define RCHECK
200# endif
e8bc2b5c
GS
201# if defined(RCHECK) && defined(IGNORE_SMALL_BAD_FREE)
202# undef IGNORE_SMALL_BAD_FREE
203# endif
8d063cd8
LW
204/*
205 * malloc.c (Caltech) 2/21/82
206 * Chris Kingsley, kingsley@cit-20.
207 *
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.
cf5c4ad8 212 * If PACK_MALLOC is defined, small blocks are 2^n bytes long.
8d063cd8 213 * This is designed for use in a program that uses vast quantities of memory,
741df71a
IZ
214 * but bombs when it runs out.
215 *
4eb8286e 216 * Modifications Copyright Ilya Zakharevich 1996-99.
741df71a
IZ
217 *
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.)
220 *
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.
225 *
8d063cd8
LW
226 */
227
d720c441
IZ
228#ifdef PERL_CORE
229# include "EXTERN.h"
4ad56ec9 230# define PERL_IN_MALLOC_C
d720c441 231# include "perl.h"
cea2e8a9
GS
232# if defined(PERL_IMPLICIT_CONTEXT)
233# define croak Perl_croak_nocontext
234# define warn Perl_warn_nocontext
235# endif
d720c441
IZ
236#else
237# ifdef PERL_FOR_X2P
238# include "../EXTERN.h"
239# include "../perl.h"
240# else
241# include <stdlib.h>
242# include <stdio.h>
243# include <memory.h>
244# define _(arg) arg
245# ifndef Malloc_t
246# define Malloc_t void *
247# endif
248# ifndef MEM_SIZE
249# define MEM_SIZE unsigned long
250# endif
251# ifndef LONG_MAX
252# define LONG_MAX 0x7FFFFFFF
253# endif
254# ifndef UV
255# define UV unsigned long
256# endif
257# ifndef caddr_t
258# define caddr_t char *
259# endif
260# ifndef Free_t
261# define Free_t void
262# endif
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
267# endif
e8bc2b5c 268# ifndef croak /* make depend */
741df71a 269# define croak(mess, arg) (warn((mess), (arg)), exit(1))
d720c441
IZ
270# endif
271# ifndef warn
741df71a 272# define warn(mess, arg) fprintf(stderr, (mess), (arg))
e8bc2b5c
GS
273# endif
274# ifdef DEBUG_m
275# undef DEBUG_m
276# endif
277# define DEBUG_m(a)
278# ifdef DEBUGGING
279# undef DEBUGGING
280# endif
cea2e8a9
GS
281# ifndef pTHX
282# define pTHX void
283# define pTHX_
284# define dTHX extern int Perl___notused
285# define WITH_THX(s) s
286# endif
c5be433b
GS
287# ifndef PERL_GET_INTERP
288# define PERL_GET_INTERP PL_curinterp
289# endif
4ad56ec9
IZ
290# ifndef Perl_malloc
291# define Perl_malloc malloc
292# endif
293# ifndef Perl_mfree
294# define Perl_mfree free
295# endif
296# ifndef Perl_realloc
297# define Perl_realloc realloc
298# endif
299# ifndef Perl_calloc
300# define Perl_calloc calloc
301# endif
302# ifndef Perl_strdup
303# define Perl_strdup strdup
304# endif
e8bc2b5c
GS
305#endif
306
307#ifndef MUTEX_LOCK
308# define MUTEX_LOCK(l)
309#endif
310
311#ifndef MUTEX_UNLOCK
312# define MUTEX_UNLOCK(l)
313#endif
314
741df71a 315#ifndef MALLOC_LOCK
cea2e8a9 316# define MALLOC_LOCK MUTEX_LOCK_NOCONTEXT(&PL_malloc_mutex)
741df71a
IZ
317#endif
318
319#ifndef MALLOC_UNLOCK
cea2e8a9 320# define MALLOC_UNLOCK MUTEX_UNLOCK_NOCONTEXT(&PL_malloc_mutex)
741df71a
IZ
321#endif
322
5bbd1ef5
IZ
323# ifndef fatalcroak /* make depend */
324# define fatalcroak(mess) (write(2, (mess), strlen(mess)), exit(2))
325# endif
326
760ac839 327#ifdef DEBUGGING
e8bc2b5c 328# undef DEBUG_m
0b250b9e
GS
329# define DEBUG_m(a) \
330 STMT_START { \
331 if (PERL_GET_INTERP) { dTHX; if (PL_debug & 128) { a; } } \
332 } STMT_END
760ac839
LW
333#endif
334
e9397286
GS
335/*
336 * Layout of memory:
337 * ~~~~~~~~~~~~~~~~
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.)
342 *
4ad56ec9 343 * Moreover, since the algorithm may try to "bite" smaller blocks out
e9397286
GS
344 * of unused bigger ones, there are also regions of "irregular" size,
345 * managed separately, by a linked list chunk_chain.
346 *
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.
349 *
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.
356 *
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
359 * memory.
360 *
361 * Management of last_op:
362 * ~~~~~~~~~~~~~~~~~~~~~
363 *
364 * free() never changes the boundaries of blocks, so is not relevant.
365 *
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.
370 *
371 * malloc() may change blocks by calling morecore() only.
372 *
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();
381 *
382 * getpages() creates a new block. It marks last_op at the bottom of
383 * the chunk of memory it returns.
384 *
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.
391 *
392 * Flaws:
393 * ~~~~~
394 * get_from_bigger_buckets(): forget to increment price => Quite
395 * aggressive.
396 */
397
135863df
AB
398/* I don't much care whether these are defined in sys/types.h--LAW */
399
400#define u_char unsigned char
401#define u_int unsigned int
56431972
RB
402/*
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
406 */
135863df 407#define u_short unsigned short
8d063cd8 408
cf5c4ad8 409/* 286 and atarist like big chunks, which gives too much overhead. */
61ae2fbf 410#if (defined(RCHECK) || defined(I286) || defined(atarist) || defined(__MINT__)) && defined(PACK_MALLOC)
e8bc2b5c 411# undef PACK_MALLOC
cf5c4ad8 412#endif
413
8d063cd8 414/*
cf5c4ad8 415 * The description below is applicable if PACK_MALLOC is not defined.
416 *
8d063cd8
LW
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.
424 */
425union overhead {
426 union overhead *ov_next; /* when free */
85e6fe83 427#if MEM_ALIGNBYTES > 4
c623bd54 428 double strut; /* alignment problems */
a687059c 429#endif
8d063cd8
LW
430 struct {
431 u_char ovu_magic; /* magic number */
432 u_char ovu_index; /* bucket # */
433#ifdef RCHECK
434 u_short ovu_size; /* actual block size */
435 u_int ovu_rmagic; /* range magic number */
436#endif
437 } ovu;
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
442};
443
444#define MAGIC 0xff /* magic # on accounting info */
445#define RMAGIC 0x55555555 /* magic # on range info */
e8bc2b5c
GS
446#define RMAGIC_C 0x55 /* magic # on range info */
447
8d063cd8 448#ifdef RCHECK
c2a5c2d2
IZ
449# define RSLOP sizeof (u_int)
450# ifdef TWO_POT_OPTIMIZE
e8bc2b5c 451# define MAX_SHORT_BUCKET (12 * BUCKETS_PER_POW2)
c2a5c2d2 452# else
e8bc2b5c 453# define MAX_SHORT_BUCKET (13 * BUCKETS_PER_POW2)
c2a5c2d2 454# endif
8d063cd8 455#else
c2a5c2d2 456# define RSLOP 0
8d063cd8
LW
457#endif
458
e8bc2b5c
GS
459#if !defined(PACK_MALLOC) && defined(BUCKETS_ROOT2)
460# undef BUCKETS_ROOT2
461#endif
462
463#ifdef BUCKETS_ROOT2
464# define BUCKET_TABLE_SHIFT 2
465# define BUCKET_POW2_SHIFT 1
466# define BUCKETS_PER_POW2 2
467#else
468# define BUCKET_TABLE_SHIFT MIN_BUC_POW2
469# define BUCKET_POW2_SHIFT 0
470# define BUCKETS_PER_POW2 1
471#endif
472
274c7500
IZ
473#if !defined(MEM_ALIGNBYTES) || ((MEM_ALIGNBYTES > 4) && !defined(STRICT_ALIGNMENT))
474/* Figure out the alignment of void*. */
475struct aligner {
476 char c;
477 void *p;
478};
479# define ALIGN_SMALL ((int)((caddr_t)&(((struct aligner*)0)->p)))
480#else
481# define ALIGN_SMALL MEM_ALIGNBYTES
482#endif
483
484#define IF_ALIGN_8(yes,no) ((ALIGN_SMALL>4) ? (yes) : (no))
485
e8bc2b5c
GS
486#ifdef BUCKETS_ROOT2
487# define MAX_BUCKET_BY_TABLE 13
488static u_short buck_size[MAX_BUCKET_BY_TABLE + 1] =
489 {
490 0, 0, 0, 0, 4, 4, 8, 12, 16, 24, 32, 48, 64, 80,
491 };
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 \
494 ? buck_size[i] \
495 : ((1 << ((i) >> BUCKET_POW2_SHIFT)) \
496 - MEM_OVERHEAD(i) \
497 + POW2_OPTIMIZE_SURPLUS(i)))
498#else
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))
501#endif
502
503
cf5c4ad8 504#ifdef PACK_MALLOC
4ad56ec9
IZ
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.
508 *
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
511 * layouts of arenas:
512 *
513 * # One chunk only, chunksize 2^k + SOMETHING - ALIGN, k >= 11
514 *
515 * INDEX MAGIC1 UNUSED CHUNK1
516 *
517 * # Multichunk with sanity checking and chunksize 2^k-ALIGN, k>7
518 *
519 * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 CHUNK2 CHUNK3 ...
520 *
521 * # Multichunk with sanity checking and size 2^k-ALIGN, k=7
522 *
523 * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 UNUSED CHUNK2 CHUNK3 ...
524 *
525 * # Multichunk with sanity checking and size up to 80
526 *
527 * INDEX UNUSED MAGIC1 UNUSED MAGIC2 UNUSED ... CHUNK1 CHUNK2 CHUNK3 ...
528 *
529 * # No sanity check (usually up to 48=byte-long buckets)
530 * INDEX UNUSED CHUNK1 CHUNK2 ...
531 *
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
538 * better).
539 *
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.
547 *
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.]
552 *
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.
559 *
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.
565 *
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) +
571 * ADDOFFSET.
572 *
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.
576 *
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.
583 *
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.]
589 *
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).
cf5c4ad8 595 *
4ad56ec9
IZ
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.)
cf5c4ad8 599 *
4ad56ec9
IZ
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
603 * arena.
604 *
605 * The algo of OV_MAGIC(block,bucket) keeps ADDOFFSET 0 until
606 * chunksize of 64, then makes it 1.
cf5c4ad8 607 *
4ad56ec9
IZ
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). */
e8bc2b5c
GS
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)
56431972
RB
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)))
cf5c4ad8 627# define OV_INDEX(block) (*OV_INDEXp(block))
628# define OV_MAGIC(block,bucket) (*(OV_INDEXp(block) + \
e8bc2b5c
GS
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. */
636# else
637# define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2) /* Shift 128 greater than chunk 32. */
638# endif
cf5c4ad8 639# define CHUNK_SHIFT 0
640
e8bc2b5c
GS
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) \
646 : n_blks[bucket] )
647#else
648# define N_BLKS(bucket) n_blks[bucket]
649#endif
650
651static u_short n_blks[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] =
652 {
653# if BUCKETS_PER_POW2==1
654 0, 0,
655 (MIN_BUC_POW2==2 ? 384 : 0),
656 224, 120, 62, 31, 16, 8, 4, 2
657# else
658 0, 0, 0, 0,
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
661# endif
662 };
663
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)) \
669 : blk_shift[bucket])
670#else
671# define BLK_SHIFT(bucket) blk_shift[bucket]
672#endif
673
674static u_short blk_shift[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] =
675 {
676# if BUCKETS_PER_POW2==1
677 0, 0,
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),
684# else
685 0, 0, 0, 0,
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),
692# endif
693 };
cf5c4ad8 694
5bbd1ef5
IZ
695# define NEEDED_ALIGNMENT 0x800 /* 2k boundaries */
696# define WANTED_ALIGNMENT 0x800 /* 2k boundaries */
697
cf5c4ad8 698#else /* !PACK_MALLOC */
699
700# define OV_MAGIC(block,bucket) (block)->ov_magic
701# define OV_INDEX(block) (block)->ov_index
702# define CHUNK_SHIFT 1
e8bc2b5c 703# define MAX_PACKED -1
5bbd1ef5
IZ
704# define NEEDED_ALIGNMENT MEM_ALIGNBYTES
705# define WANTED_ALIGNMENT 0x400 /* 1k boundaries */
706
cf5c4ad8 707#endif /* !PACK_MALLOC */
708
e8bc2b5c
GS
709#define M_OVERHEAD (sizeof(union overhead) + RSLOP)
710
711#ifdef PACK_MALLOC
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
719# else
720# define SIZE_TABLE_MAX 64
721# endif
722static char bucket_of[] =
723 {
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 */
727 6, /* 8 */
274c7500 728 IF_ALIGN_8(8,7), 8, /* 16/12, 16 */
e8bc2b5c
GS
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),
737 3,
738 4, 4,
739 5, 5, 5, 5,
740 6, 6, 6, 6,
741 6, 6, 6, 6
742# endif /* !BUCKETS_ROOT2 */
743 };
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
752# endif
753# define START_SHIFTS_BUCKET MIN_BUCKET
754# define START_SHIFT (MIN_BUC_POW2 - 1)
755#endif /* !PACK_MALLOC */
cf5c4ad8 756
8d063cd8 757/*
55497cff 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.
760 */
761
762#ifdef TWO_POT_OPTIMIZE
763
5f05dabc 764# ifndef PERL_PAGESIZE
765# define PERL_PAGESIZE 4096
766# endif
e8bc2b5c
GS
767# ifndef FIRST_BIG_POW2
768# define FIRST_BIG_POW2 15 /* 32K, 16K is used too often. */
5f05dabc 769# endif
e8bc2b5c 770# define FIRST_BIG_BLOCK (1<<FIRST_BIG_POW2)
55497cff 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)
775
e8bc2b5c
GS
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)
780
781#else /* !TWO_POT_OPTIMIZE */
782# define POW2_OPTIMIZE_ADJUST(nbytes)
783# define POW2_OPTIMIZE_SURPLUS(bucket) 0
784#endif /* !TWO_POT_OPTIMIZE */
785
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); \
791 my_exit(1); \
792 }
793#else /* !HAS_64K_LIMIT || !PERL_CORE */
794# define BARK_64K_LIMIT(what,nbytes,size)
795#endif /* !HAS_64K_LIMIT || !PERL_CORE */
55497cff 796
e8bc2b5c
GS
797#ifndef MIN_SBRK
798# define MIN_SBRK 2048
799#endif
800
801#ifndef FIRST_SBRK
d720c441 802# define FIRST_SBRK (48*1024)
e8bc2b5c
GS
803#endif
804
805/* Minimal sbrk in percents of what is already alloced. */
806#ifndef MIN_SBRK_FRAC
807# define MIN_SBRK_FRAC 3
808#endif
809
810#ifndef SBRK_ALLOW_FAILURES
811# define SBRK_ALLOW_FAILURES 3
812#endif
55497cff 813
e8bc2b5c
GS
814#ifndef SBRK_FAILURE_PRICE
815# define SBRK_FAILURE_PRICE 50
55497cff 816#endif
817
e8bc2b5c
GS
818#if defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)
819
820# ifndef BIG_SIZE
821# define BIG_SIZE (1<<16) /* 64K */
822# endif
823
3541dd58 824#ifdef I_MACH_CTHREADS
772fe5b3
HM
825# undef MUTEX_LOCK
826# define MUTEX_LOCK(m) STMT_START { if (*m) mutex_lock(*m); } STMT_END
827# undef MUTEX_UNLOCK
828# define MUTEX_UNLOCK(m) STMT_START { if (*m) mutex_unlock(*m); } STMT_END
3541dd58
HM
829#endif
830
55497cff 831static char *emergency_buffer;
832static MEM_SIZE emergency_buffer_size;
833
cea2e8a9
GS
834static int findbucket (union overhead *freep, int srchlen);
835static void morecore (register int bucket);
836# if defined(DEBUGGING)
837static void botch (char *diag, char *s);
838# endif
839static void add_to_chain (void *p, MEM_SIZE size, MEM_SIZE chip);
840static Malloc_t emergency_sbrk (MEM_SIZE size);
841static void* get_from_chain (MEM_SIZE size);
842static void* get_from_bigger_buckets(int bucket, MEM_SIZE size);
843static union overhead *getpages (int needed, int *nblksp, int bucket);
844static int getpages_adjacent(int require);
845
846static Malloc_t
847emergency_sbrk(MEM_SIZE size)
55497cff 848{
28ac10b1
IZ
849 MEM_SIZE rsize = (((size - 1)>>LOG_OF_MIN_ARENA) + 1)<<LOG_OF_MIN_ARENA;
850
55497cff 851 if (size >= BIG_SIZE) {
852 /* Give the possibility to recover: */
741df71a 853 MALLOC_UNLOCK;
1b979e0a 854 croak("Out of memory during \"large\" request for %i bytes", size);
55497cff 855 }
856
28ac10b1
IZ
857 if (emergency_buffer_size >= rsize) {
858 char *old = emergency_buffer;
859
860 emergency_buffer_size -= rsize;
861 emergency_buffer += rsize;
862 return old;
863 } else {
cea2e8a9 864 dTHX;
55497cff 865 /* First offense, give a possibility to recover by dieing. */
866 /* No malloc involved here: */
4a33f861 867 GV **gvp = (GV**)hv_fetch(PL_defstash, "^M", 2, 0);
55497cff 868 SV *sv;
869 char *pv;
28ac10b1 870 int have = 0;
2d8e6c8d 871 STRLEN n_a;
55497cff 872
28ac10b1
IZ
873 if (emergency_buffer_size) {
874 add_to_chain(emergency_buffer, emergency_buffer_size, 0);
875 emergency_buffer_size = 0;
876 emergency_buffer = Nullch;
877 have = 1;
878 }
4a33f861 879 if (!gvp) gvp = (GV**)hv_fetch(PL_defstash, "\015", 1, 0);
55497cff 880 if (!gvp || !(sv = GvSV(*gvp)) || !SvPOK(sv)
28ac10b1
IZ
881 || (SvLEN(sv) < (1<<LOG_OF_MIN_ARENA) - M_OVERHEAD)) {
882 if (have)
883 goto do_croak;
55497cff 884 return (char *)-1; /* Now die die die... */
28ac10b1 885 }
55497cff 886 /* Got it, now detach SvPV: */
2d8e6c8d 887 pv = SvPV(sv, n_a);
55497cff 888 /* Check alignment: */
56431972 889 if ((PTR2UV(pv) - sizeof(union overhead)) & (NEEDED_ALIGNMENT - 1)) {
55497cff 890 PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
bbce6d69 891 return (char *)-1; /* die die die */
55497cff 892 }
893
28ac10b1
IZ
894 emergency_buffer = pv - sizeof(union overhead);
895 emergency_buffer_size = malloced_size(pv) + M_OVERHEAD;
55497cff 896 SvPOK_off(sv);
28ac10b1
IZ
897 SvPVX(sv) = Nullch;
898 SvCUR(sv) = SvLEN(sv) = 0;
55497cff 899 }
28ac10b1 900 do_croak:
741df71a 901 MALLOC_UNLOCK;
28ac10b1 902 croak("Out of memory during request for %i bytes", size);
ce70748c
GS
903 /* NOTREACHED */
904 return Nullch;
55497cff 905}
906
e8bc2b5c 907#else /* !(defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)) */
55497cff 908# define emergency_sbrk(size) -1
e8bc2b5c 909#endif /* !(defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)) */
55497cff 910
911/*
e8bc2b5c 912 * nextf[i] is the pointer to the next free block of size 2^i. The
8d063cd8
LW
913 * smallest allocatable block is 8 bytes. The overhead information
914 * precedes the data area returned to the user.
915 */
e8bc2b5c 916#define NBUCKETS (32*BUCKETS_PER_POW2 + 1)
8d063cd8 917static union overhead *nextf[NBUCKETS];
cf5c4ad8 918
919#ifdef USE_PERL_SBRK
920#define sbrk(a) Perl_sbrk(a)
20ce7b12 921Malloc_t Perl_sbrk (int size);
8ac85365
NIS
922#else
923#ifdef DONT_DECLARE_STD
924#ifdef I_UNISTD
925#include <unistd.h>
926#endif
cf5c4ad8 927#else
52082926 928extern Malloc_t sbrk(int);
8ac85365 929#endif
cf5c4ad8 930#endif
8d063cd8 931
c07a80fd 932#ifdef DEBUGGING_MSTATS
8d063cd8
LW
933/*
934 * nmalloc[i] is the difference between the number of mallocs and frees
935 * for a given block size.
936 */
937static u_int nmalloc[NBUCKETS];
5f05dabc 938static u_int sbrk_slack;
939static u_int start_slack;
8d063cd8
LW
940#endif
941
e8bc2b5c
GS
942static u_int goodsbrk;
943
760ac839 944#ifdef DEBUGGING
3541dd58
HM
945#undef ASSERT
946#define ASSERT(p,diag) if (!(p)) botch(diag,STRINGIFY(p)); else
cea2e8a9
GS
947static void
948botch(char *diag, char *s)
8d063cd8 949{
d720c441 950 PerlIO_printf(PerlIO_stderr(), "assertion botched (%s?): %s\n", diag, s);
3028581b 951 PerlProc_abort();
8d063cd8
LW
952}
953#else
3541dd58 954#define ASSERT(p, diag)
8d063cd8
LW
955#endif
956
2304df62 957Malloc_t
86058a2d 958Perl_malloc(register size_t nbytes)
8d063cd8
LW
959{
960 register union overhead *p;
e8bc2b5c 961 register int bucket;
ee0007ab 962 register MEM_SIZE shiftr;
8d063cd8 963
c2a5c2d2 964#if defined(DEBUGGING) || defined(RCHECK)
ee0007ab 965 MEM_SIZE size = nbytes;
45d8adaa
LW
966#endif
967
e8bc2b5c 968 BARK_64K_LIMIT("Allocation",nbytes,nbytes);
45d8adaa
LW
969#ifdef DEBUGGING
970 if ((long)nbytes < 0)
cea2e8a9 971 croak("%s", "panic: malloc");
45d8adaa 972#endif
45d8adaa 973
8d063cd8
LW
974 /*
975 * Convert amount of memory requested into
976 * closest block size stored in hash buckets
977 * which satisfies request. Account for
978 * space used per block for accounting.
979 */
cf5c4ad8 980#ifdef PACK_MALLOC
e8bc2b5c
GS
981# ifdef SMALL_BUCKET_VIA_TABLE
982 if (nbytes == 0)
983 bucket = MIN_BUCKET;
984 else if (nbytes <= SIZE_TABLE_MAX) {
985 bucket = bucket_of[(nbytes - 1) >> BUCKET_TABLE_SHIFT];
986 } else
987# else
043bf814
RB
988 if (nbytes == 0)
989 nbytes = 1;
e8bc2b5c
GS
990 if (nbytes <= MAX_POW2_ALGO) goto do_shifts;
991 else
992# endif
55497cff 993#endif
e8bc2b5c
GS
994 {
995 POW2_OPTIMIZE_ADJUST(nbytes);
996 nbytes += M_OVERHEAD;
997 nbytes = (nbytes + 3) &~ 3;
998 do_shifts:
999 shiftr = (nbytes - 1) >> START_SHIFT;
1000 bucket = START_SHIFTS_BUCKET;
1001 /* apart from this loop, this is O(1) */
1002 while (shiftr >>= 1)
1003 bucket += BUCKETS_PER_POW2;
cf5c4ad8 1004 }
4ad56ec9 1005 MALLOC_LOCK;
8d063cd8
LW
1006 /*
1007 * If nothing in hash bucket right now,
1008 * request more memory from the system.
1009 */
1010 if (nextf[bucket] == NULL)
1011 morecore(bucket);
e8bc2b5c 1012 if ((p = nextf[bucket]) == NULL) {
741df71a 1013 MALLOC_UNLOCK;
55497cff 1014#ifdef PERL_CORE
0b250b9e
GS
1015 {
1016 dTHX;
1017 if (!PL_nomemok) {
1018 PerlIO_puts(PerlIO_stderr(),"Out of memory!\n");
1019 my_exit(1);
1020 }
ee0007ab 1021 }
45d8adaa 1022#endif
4ad56ec9 1023 return (NULL);
45d8adaa
LW
1024 }
1025
e8bc2b5c
GS
1026 DEBUG_m(PerlIO_printf(Perl_debug_log,
1027 "0x%lx: (%05lu) malloc %ld bytes\n",
4a33f861 1028 (unsigned long)(p+1), (unsigned long)(PL_an++),
e8bc2b5c 1029 (long)size));
45d8adaa 1030
8d063cd8 1031 /* remove from linked list */
802004fa 1032#if defined(RCHECK)
56431972 1033 if ((PTR2UV(p)) & (MEM_ALIGNBYTES - 1))
760ac839 1034 PerlIO_printf(PerlIO_stderr(), "Corrupt malloc ptr 0x%lx at 0x%lx\n",
a0d0e21e 1035 (unsigned long)*((int*)p),(unsigned long)p);
bf38876a
LW
1036#endif
1037 nextf[bucket] = p->ov_next;
4ad56ec9
IZ
1038
1039 MALLOC_UNLOCK;
1040
e8bc2b5c
GS
1041#ifdef IGNORE_SMALL_BAD_FREE
1042 if (bucket >= FIRST_BUCKET_WITH_CHECK)
1043#endif
1044 OV_MAGIC(p, bucket) = MAGIC;
cf5c4ad8 1045#ifndef PACK_MALLOC
1046 OV_INDEX(p) = bucket;
1047#endif
8d063cd8
LW
1048#ifdef RCHECK
1049 /*
1050 * Record allocated size of block and
1051 * bound space with magic numbers.
1052 */
8d063cd8 1053 p->ov_rmagic = RMAGIC;
e8bc2b5c
GS
1054 if (bucket <= MAX_SHORT_BUCKET) {
1055 int i;
1056
1057 nbytes = size + M_OVERHEAD;
1058 p->ov_size = nbytes - 1;
1059 if ((i = nbytes & 3)) {
1060 i = 4 - i;
1061 while (i--)
1062 *((char *)((caddr_t)p + nbytes - RSLOP + i)) = RMAGIC_C;
1063 }
1064 nbytes = (nbytes + 3) &~ 3;
1065 *((u_int *)((caddr_t)p + nbytes - RSLOP)) = RMAGIC;
1066 }
8d063cd8 1067#endif
cf5c4ad8 1068 return ((Malloc_t)(p + CHUNK_SHIFT));
8d063cd8
LW
1069}
1070
e8bc2b5c
GS
1071static char *last_sbrk_top;
1072static char *last_op; /* This arena can be easily extended. */
1073static int sbrked_remains;
1074static int sbrk_good = SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE;
1075
1076#ifdef DEBUGGING_MSTATS
1077static int sbrks;
1078#endif
1079
1080struct chunk_chain_s {
1081 struct chunk_chain_s *next;
1082 MEM_SIZE size;
1083};
1084static struct chunk_chain_s *chunk_chain;
1085static int n_chunks;
1086static char max_bucket;
1087
1088/* Cutoff a piece of one of the chunks in the chain. Prefer smaller chunk. */
cea2e8a9
GS
1089static void *
1090get_from_chain(MEM_SIZE size)
e8bc2b5c
GS
1091{
1092 struct chunk_chain_s *elt = chunk_chain, **oldp = &chunk_chain;
1093 struct chunk_chain_s **oldgoodp = NULL;
1094 long min_remain = LONG_MAX;
1095
1096 while (elt) {
1097 if (elt->size >= size) {
1098 long remains = elt->size - size;
1099 if (remains >= 0 && remains < min_remain) {
1100 oldgoodp = oldp;
1101 min_remain = remains;
1102 }
1103 if (remains == 0) {
1104 break;
1105 }
1106 }
1107 oldp = &( elt->next );
1108 elt = elt->next;
1109 }
1110 if (!oldgoodp) return NULL;
1111 if (min_remain) {
1112 void *ret = *oldgoodp;
1113 struct chunk_chain_s *next = (*oldgoodp)->next;
1114
1115 *oldgoodp = (struct chunk_chain_s *)((char*)ret + size);
1116 (*oldgoodp)->size = min_remain;
1117 (*oldgoodp)->next = next;
1118 return ret;
1119 } else {
1120 void *ret = *oldgoodp;
1121 *oldgoodp = (*oldgoodp)->next;
1122 n_chunks--;
1123 return ret;
1124 }
1125}
1126
cea2e8a9
GS
1127static void
1128add_to_chain(void *p, MEM_SIZE size, MEM_SIZE chip)
e8bc2b5c
GS
1129{
1130 struct chunk_chain_s *next = chunk_chain;
1131 char *cp = (char*)p;
1132
1133 cp += chip;
1134 chunk_chain = (struct chunk_chain_s *)cp;
1135 chunk_chain->size = size - chip;
1136 chunk_chain->next = next;
1137 n_chunks++;
1138}
1139
cea2e8a9
GS
1140static void *
1141get_from_bigger_buckets(int bucket, MEM_SIZE size)
e8bc2b5c
GS
1142{
1143 int price = 1;
1144 static int bucketprice[NBUCKETS];
1145 while (bucket <= max_bucket) {
1146 /* We postpone stealing from bigger buckets until we want it
1147 often enough. */
1148 if (nextf[bucket] && bucketprice[bucket]++ >= price) {
1149 /* Steal it! */
1150 void *ret = (void*)(nextf[bucket] - 1 + CHUNK_SHIFT);
1151 bucketprice[bucket] = 0;
1152 if (((char*)nextf[bucket]) - M_OVERHEAD == last_op) {
1153 last_op = NULL; /* Disable optimization */
1154 }
1155 nextf[bucket] = nextf[bucket]->ov_next;
1156#ifdef DEBUGGING_MSTATS
1157 nmalloc[bucket]--;
1158 start_slack -= M_OVERHEAD;
1159#endif
1160 add_to_chain(ret, (BUCKET_SIZE(bucket) +
1161 POW2_OPTIMIZE_SURPLUS(bucket)),
1162 size);
1163 return ret;
1164 }
1165 bucket++;
1166 }
1167 return NULL;
1168}
1169
cea2e8a9
GS
1170static union overhead *
1171getpages(int needed, int *nblksp, int bucket)
fa423c5b
IZ
1172{
1173 /* Need to do (possibly expensive) system call. Try to
1174 optimize it for rare calling. */
1175 MEM_SIZE require = needed - sbrked_remains;
1176 char *cp;
1177 union overhead *ovp;
1178 int slack = 0;
1179
1180 if (sbrk_good > 0) {
1181 if (!last_sbrk_top && require < FIRST_SBRK)
1182 require = FIRST_SBRK;
1183 else if (require < MIN_SBRK) require = MIN_SBRK;
1184
1185 if (require < goodsbrk * MIN_SBRK_FRAC / 100)
1186 require = goodsbrk * MIN_SBRK_FRAC / 100;
1187 require = ((require - 1 + MIN_SBRK) / MIN_SBRK) * MIN_SBRK;
1188 } else {
1189 require = needed;
1190 last_sbrk_top = 0;
1191 sbrked_remains = 0;
1192 }
1193
1194 DEBUG_m(PerlIO_printf(Perl_debug_log,
1195 "sbrk(%ld) for %ld-byte-long arena\n",
1196 (long)require, (long) needed));
1197 cp = (char *)sbrk(require);
1198#ifdef DEBUGGING_MSTATS
1199 sbrks++;
1200#endif
1201 if (cp == last_sbrk_top) {
1202 /* Common case, anything is fine. */
1203 sbrk_good++;
1204 ovp = (union overhead *) (cp - sbrked_remains);
e9397286 1205 last_op = cp - sbrked_remains;
fa423c5b
IZ
1206 sbrked_remains = require - (needed - sbrked_remains);
1207 } else if (cp == (char *)-1) { /* no more room! */
1208 ovp = (union overhead *)emergency_sbrk(needed);
1209 if (ovp == (union overhead *)-1)
1210 return 0;
e9397286
GS
1211 if (((char*)ovp) > last_op) { /* Cannot happen with current emergency_sbrk() */
1212 last_op = 0;
1213 }
fa423c5b
IZ
1214 return ovp;
1215 } else { /* Non-continuous or first sbrk(). */
1216 long add = sbrked_remains;
1217 char *newcp;
1218
1219 if (sbrked_remains) { /* Put rest into chain, we
1220 cannot use it right now. */
1221 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1222 sbrked_remains, 0);
1223 }
1224
1225 /* Second, check alignment. */
1226 slack = 0;
1227
61ae2fbf 1228#if !defined(atarist) && !defined(__MINT__) /* on the atari we dont have to worry about this */
fa423c5b 1229# ifndef I286 /* The sbrk(0) call on the I286 always returns the next segment */
5bbd1ef5
IZ
1230 /* WANTED_ALIGNMENT may be more than NEEDED_ALIGNMENT, but this may
1231 improve performance of memory access. */
56431972
RB
1232 if (PTR2UV(cp) & (WANTED_ALIGNMENT - 1)) { /* Not aligned. */
1233 slack = WANTED_ALIGNMENT - (PTR2UV(cp) & (WANTED_ALIGNMENT - 1));
fa423c5b
IZ
1234 add += slack;
1235 }
1236# endif
61ae2fbf 1237#endif /* !atarist && !MINT */
fa423c5b
IZ
1238
1239 if (add) {
1240 DEBUG_m(PerlIO_printf(Perl_debug_log,
1241 "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",
1242 (long)add, (long) slack,
1243 (long) sbrked_remains));
1244 newcp = (char *)sbrk(add);
1245#if defined(DEBUGGING_MSTATS)
1246 sbrks++;
1247 sbrk_slack += add;
1248#endif
1249 if (newcp != cp + require) {
1250 /* Too bad: even rounding sbrk() is not continuous.*/
1251 DEBUG_m(PerlIO_printf(Perl_debug_log,
1252 "failed to fix bad sbrk()\n"));
1253#ifdef PACK_MALLOC
1254 if (slack) {
741df71a 1255 MALLOC_UNLOCK;
5bbd1ef5 1256 fatalcroak("panic: Off-page sbrk\n");
fa423c5b
IZ
1257 }
1258#endif
1259 if (sbrked_remains) {
1260 /* Try again. */
1261#if defined(DEBUGGING_MSTATS)
1262 sbrk_slack += require;
1263#endif
1264 require = needed;
1265 DEBUG_m(PerlIO_printf(Perl_debug_log,
1266 "straight sbrk(%ld)\n",
1267 (long)require));
1268 cp = (char *)sbrk(require);
1269#ifdef DEBUGGING_MSTATS
1270 sbrks++;
1271#endif
1272 if (cp == (char *)-1)
1273 return 0;
1274 }
1275 sbrk_good = -1; /* Disable optimization!
1276 Continue with not-aligned... */
1277 } else {
1278 cp += slack;
1279 require += sbrked_remains;
1280 }
1281 }
1282
1283 if (last_sbrk_top) {
1284 sbrk_good -= SBRK_FAILURE_PRICE;
1285 }
1286
1287 ovp = (union overhead *) cp;
1288 /*
1289 * Round up to minimum allocation size boundary
1290 * and deduct from block count to reflect.
1291 */
1292
5bbd1ef5 1293# if NEEDED_ALIGNMENT > MEM_ALIGNBYTES
56431972 1294 if (PTR2UV(ovp) & (NEEDED_ALIGNMENT - 1))
5bbd1ef5
IZ
1295 fatalcroak("Misalignment of sbrk()\n");
1296 else
1297# endif
fa423c5b 1298#ifndef I286 /* Again, this should always be ok on an 80286 */
56431972 1299 if (PTR2UV(ovp) & (MEM_ALIGNBYTES - 1)) {
fa423c5b
IZ
1300 DEBUG_m(PerlIO_printf(Perl_debug_log,
1301 "fixing sbrk(): %d bytes off machine alignement\n",
56431972
RB
1302 (int)(PTR2UV(ovp) & (MEM_ALIGNBYTES - 1))));
1303 ovp = INT2PTR(union overhead *,(PTR2UV(ovp) + MEM_ALIGNBYTES) &
5bbd1ef5 1304 (MEM_ALIGNBYTES - 1));
fa423c5b
IZ
1305 (*nblksp)--;
1306# if defined(DEBUGGING_MSTATS)
1307 /* This is only approx. if TWO_POT_OPTIMIZE: */
5bbd1ef5 1308 sbrk_slack += (1 << (bucket >> BUCKET_POW2_SHIFT));
fa423c5b
IZ
1309# endif
1310 }
1311#endif
5bbd1ef5 1312 ; /* Finish `else' */
fa423c5b 1313 sbrked_remains = require - needed;
e9397286 1314 last_op = cp;
fa423c5b
IZ
1315 }
1316 last_sbrk_top = cp + require;
fa423c5b
IZ
1317#ifdef DEBUGGING_MSTATS
1318 goodsbrk += require;
1319#endif
1320 return ovp;
1321}
1322
cea2e8a9
GS
1323static int
1324getpages_adjacent(int require)
fa423c5b
IZ
1325{
1326 if (require <= sbrked_remains) {
1327 sbrked_remains -= require;
1328 } else {
1329 char *cp;
1330
1331 require -= sbrked_remains;
1332 /* We do not try to optimize sbrks here, we go for place. */
1333 cp = (char*) sbrk(require);
1334#ifdef DEBUGGING_MSTATS
1335 sbrks++;
1336 goodsbrk += require;
1337#endif
1338 if (cp == last_sbrk_top) {
1339 sbrked_remains = 0;
1340 last_sbrk_top = cp + require;
1341 } else {
28ac10b1
IZ
1342 if (cp == (char*)-1) { /* Out of memory */
1343#ifdef DEBUGGING_MSTATS
1344 goodsbrk -= require;
1345#endif
1346 return 0;
1347 }
fa423c5b
IZ
1348 /* Report the failure: */
1349 if (sbrked_remains)
1350 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1351 sbrked_remains, 0);
1352 add_to_chain((void*)cp, require, 0);
1353 sbrk_good -= SBRK_FAILURE_PRICE;
1354 sbrked_remains = 0;
1355 last_sbrk_top = 0;
1356 last_op = 0;
1357 return 0;
1358 }
1359 }
1360
1361 return 1;
1362}
1363
8d063cd8
LW
1364/*
1365 * Allocate more memory to the indicated bucket.
1366 */
cea2e8a9
GS
1367static void
1368morecore(register int bucket)
8d063cd8 1369{
72aaf631 1370 register union overhead *ovp;
8d063cd8 1371 register int rnu; /* 2^rnu bytes will be requested */
fa423c5b 1372 int nblks; /* become nblks blocks of the desired size */
bbce6d69 1373 register MEM_SIZE siz, needed;
8d063cd8
LW
1374
1375 if (nextf[bucket])
1376 return;
e8bc2b5c 1377 if (bucket == sizeof(MEM_SIZE)*8*BUCKETS_PER_POW2) {
741df71a 1378 MALLOC_UNLOCK;
d720c441 1379 croak("%s", "Out of memory during ridiculously large request");
55497cff 1380 }
d720c441 1381 if (bucket > max_bucket)
e8bc2b5c 1382 max_bucket = bucket;
d720c441 1383
e8bc2b5c
GS
1384 rnu = ( (bucket <= (LOG_OF_MIN_ARENA << BUCKET_POW2_SHIFT))
1385 ? LOG_OF_MIN_ARENA
1386 : (bucket >> BUCKET_POW2_SHIFT) );
1387 /* This may be overwritten later: */
1388 nblks = 1 << (rnu - (bucket >> BUCKET_POW2_SHIFT)); /* how many blocks to get */
1389 needed = ((MEM_SIZE)1 << rnu) + POW2_OPTIMIZE_SURPLUS(bucket);
1390 if (nextf[rnu << BUCKET_POW2_SHIFT]) { /* 2048b bucket. */
1391 ovp = nextf[rnu << BUCKET_POW2_SHIFT] - 1 + CHUNK_SHIFT;
1392 nextf[rnu << BUCKET_POW2_SHIFT]
1393 = nextf[rnu << BUCKET_POW2_SHIFT]->ov_next;
1394#ifdef DEBUGGING_MSTATS
1395 nmalloc[rnu << BUCKET_POW2_SHIFT]--;
1396 start_slack -= M_OVERHEAD;
1397#endif
1398 DEBUG_m(PerlIO_printf(Perl_debug_log,
1399 "stealing %ld bytes from %ld arena\n",
1400 (long) needed, (long) rnu << BUCKET_POW2_SHIFT));
1401 } else if (chunk_chain
1402 && (ovp = (union overhead*) get_from_chain(needed))) {
1403 DEBUG_m(PerlIO_printf(Perl_debug_log,
1404 "stealing %ld bytes from chain\n",
1405 (long) needed));
d720c441
IZ
1406 } else if ( (ovp = (union overhead*)
1407 get_from_bigger_buckets((rnu << BUCKET_POW2_SHIFT) + 1,
1408 needed)) ) {
e8bc2b5c
GS
1409 DEBUG_m(PerlIO_printf(Perl_debug_log,
1410 "stealing %ld bytes from bigger buckets\n",
1411 (long) needed));
1412 } else if (needed <= sbrked_remains) {
1413 ovp = (union overhead *)(last_sbrk_top - sbrked_remains);
1414 sbrked_remains -= needed;
1415 last_op = (char*)ovp;
fa423c5b
IZ
1416 } else
1417 ovp = getpages(needed, &nblks, bucket);
e8bc2b5c 1418
fa423c5b
IZ
1419 if (!ovp)
1420 return;
e8bc2b5c 1421
8d063cd8
LW
1422 /*
1423 * Add new memory allocated to that on
1424 * free list for this hash bucket.
1425 */
e8bc2b5c 1426 siz = BUCKET_SIZE(bucket);
cf5c4ad8 1427#ifdef PACK_MALLOC
72aaf631 1428 *(u_char*)ovp = bucket; /* Fill index. */
e8bc2b5c
GS
1429 if (bucket <= MAX_PACKED) {
1430 ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1431 nblks = N_BLKS(bucket);
cf5c4ad8 1432# ifdef DEBUGGING_MSTATS
e8bc2b5c 1433 start_slack += BLK_SHIFT(bucket);
cf5c4ad8 1434# endif
e8bc2b5c
GS
1435 } else if (bucket < LOG_OF_MIN_ARENA * BUCKETS_PER_POW2) {
1436 ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
cf5c4ad8 1437 siz -= sizeof(union overhead);
72aaf631 1438 } else ovp++; /* One chunk per block. */
e8bc2b5c 1439#endif /* PACK_MALLOC */
72aaf631 1440 nextf[bucket] = ovp;
5f05dabc 1441#ifdef DEBUGGING_MSTATS
1442 nmalloc[bucket] += nblks;
e8bc2b5c
GS
1443 if (bucket > MAX_PACKED) {
1444 start_slack += M_OVERHEAD * nblks;
1445 }
5f05dabc 1446#endif
8d063cd8 1447 while (--nblks > 0) {
72aaf631
MB
1448 ovp->ov_next = (union overhead *)((caddr_t)ovp + siz);
1449 ovp = (union overhead *)((caddr_t)ovp + siz);
8d063cd8 1450 }
8595d6f1 1451 /* Not all sbrks return zeroed memory.*/
72aaf631 1452 ovp->ov_next = (union overhead *)NULL;
cf5c4ad8 1453#ifdef PACK_MALLOC
e8bc2b5c
GS
1454 if (bucket == 7*BUCKETS_PER_POW2) { /* Special case, explanation is above. */
1455 union overhead *n_op = nextf[7*BUCKETS_PER_POW2]->ov_next;
1456 nextf[7*BUCKETS_PER_POW2] =
1457 (union overhead *)((caddr_t)nextf[7*BUCKETS_PER_POW2]
1458 - sizeof(union overhead));
1459 nextf[7*BUCKETS_PER_POW2]->ov_next = n_op;
cf5c4ad8 1460 }
1461#endif /* !PACK_MALLOC */
8d063cd8
LW
1462}
1463
94b6baf5 1464Free_t
86058a2d 1465Perl_mfree(void *mp)
cea2e8a9 1466{
ee0007ab 1467 register MEM_SIZE size;
72aaf631 1468 register union overhead *ovp;
352d5a3a 1469 char *cp = (char*)mp;
cf5c4ad8 1470#ifdef PACK_MALLOC
1471 u_char bucket;
1472#endif
8d063cd8 1473
e8bc2b5c
GS
1474 DEBUG_m(PerlIO_printf(Perl_debug_log,
1475 "0x%lx: (%05lu) free\n",
4a33f861 1476 (unsigned long)cp, (unsigned long)(PL_an++)));
45d8adaa 1477
cf5c4ad8 1478 if (cp == NULL)
1479 return;
72aaf631 1480 ovp = (union overhead *)((caddr_t)cp
e8bc2b5c 1481 - sizeof (union overhead) * CHUNK_SHIFT);
cf5c4ad8 1482#ifdef PACK_MALLOC
72aaf631 1483 bucket = OV_INDEX(ovp);
cf5c4ad8 1484#endif
e8bc2b5c
GS
1485#ifdef IGNORE_SMALL_BAD_FREE
1486 if ((bucket >= FIRST_BUCKET_WITH_CHECK)
1487 && (OV_MAGIC(ovp, bucket) != MAGIC))
1488#else
1489 if (OV_MAGIC(ovp, bucket) != MAGIC)
1490#endif
1491 {
68dc0745 1492 static int bad_free_warn = -1;
cf5c4ad8 1493 if (bad_free_warn == -1) {
5fd9e9a4 1494 char *pbf = PerlEnv_getenv("PERL_BADFREE");
cf5c4ad8 1495 bad_free_warn = (pbf) ? atoi(pbf) : 1;
1496 }
1497 if (!bad_free_warn)
1498 return;
8990e307 1499#ifdef RCHECK
a687059c 1500 warn("%s free() ignored",
72aaf631 1501 ovp->ov_rmagic == RMAGIC - 1 ? "Duplicate" : "Bad");
8990e307 1502#else
d720c441 1503 warn("%s", "Bad free() ignored");
8990e307 1504#endif
8d063cd8 1505 return; /* sanity */
e8bc2b5c 1506 }
8d063cd8 1507#ifdef RCHECK
3541dd58 1508 ASSERT(ovp->ov_rmagic == RMAGIC, "chunk's head overwrite");
e8bc2b5c
GS
1509 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1510 int i;
1511 MEM_SIZE nbytes = ovp->ov_size + 1;
1512
1513 if ((i = nbytes & 3)) {
1514 i = 4 - i;
1515 while (i--) {
3541dd58 1516 ASSERT(*((char *)((caddr_t)ovp + nbytes - RSLOP + i))
d720c441 1517 == RMAGIC_C, "chunk's tail overwrite");
e8bc2b5c
GS
1518 }
1519 }
1520 nbytes = (nbytes + 3) &~ 3;
3541dd58 1521 ASSERT(*(u_int *)((caddr_t)ovp + nbytes - RSLOP) == RMAGIC, "chunk's tail overwrite");
e8bc2b5c 1522 }
72aaf631 1523 ovp->ov_rmagic = RMAGIC - 1;
8d063cd8 1524#endif
3541dd58 1525 ASSERT(OV_INDEX(ovp) < NBUCKETS, "chunk's head overwrite");
72aaf631 1526 size = OV_INDEX(ovp);
4ad56ec9
IZ
1527
1528 MALLOC_LOCK;
72aaf631
MB
1529 ovp->ov_next = nextf[size];
1530 nextf[size] = ovp;
741df71a 1531 MALLOC_UNLOCK;
8d063cd8
LW
1532}
1533
4ad56ec9
IZ
1534/* There is no need to do any locking in realloc (with an exception of
1535 trying to grow in place if we are at the end of the chain).
1536 If somebody calls us from a different thread with the same address,
1537 we are sole anyway. */
8d063cd8 1538
2304df62 1539Malloc_t
86058a2d 1540Perl_realloc(void *mp, size_t nbytes)
cea2e8a9 1541{
ee0007ab 1542 register MEM_SIZE onb;
72aaf631 1543 union overhead *ovp;
d720c441
IZ
1544 char *res;
1545 int prev_bucket;
e8bc2b5c 1546 register int bucket;
4ad56ec9
IZ
1547 int incr; /* 1 if does not fit, -1 if "easily" fits in a
1548 smaller bucket, otherwise 0. */
352d5a3a 1549 char *cp = (char*)mp;
8d063cd8 1550
e8bc2b5c 1551#if defined(DEBUGGING) || !defined(PERL_CORE)
ee0007ab 1552 MEM_SIZE size = nbytes;
45d8adaa 1553
45d8adaa 1554 if ((long)nbytes < 0)
cea2e8a9 1555 croak("%s", "panic: realloc");
45d8adaa 1556#endif
e8bc2b5c
GS
1557
1558 BARK_64K_LIMIT("Reallocation",nbytes,size);
1559 if (!cp)
86058a2d 1560 return Perl_malloc(nbytes);
45d8adaa 1561
72aaf631 1562 ovp = (union overhead *)((caddr_t)cp
e8bc2b5c
GS
1563 - sizeof (union overhead) * CHUNK_SHIFT);
1564 bucket = OV_INDEX(ovp);
4ad56ec9 1565
e8bc2b5c 1566#ifdef IGNORE_SMALL_BAD_FREE
4ad56ec9
IZ
1567 if ((bucket >= FIRST_BUCKET_WITH_CHECK)
1568 && (OV_MAGIC(ovp, bucket) != MAGIC))
e8bc2b5c 1569#else
4ad56ec9 1570 if (OV_MAGIC(ovp, bucket) != MAGIC)
e8bc2b5c 1571#endif
4ad56ec9
IZ
1572 {
1573 static int bad_free_warn = -1;
1574 if (bad_free_warn == -1) {
1575 char *pbf = PerlEnv_getenv("PERL_BADFREE");
1576 bad_free_warn = (pbf) ? atoi(pbf) : 1;
1577 }
1578 if (!bad_free_warn)
ce70748c 1579 return Nullch;
4ad56ec9
IZ
1580#ifdef RCHECK
1581 warn("%srealloc() %signored",
1582 (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
1583 ovp->ov_rmagic == RMAGIC - 1 ? "of freed memory " : "");
1584#else
1585 warn("%s", "Bad realloc() ignored");
1586#endif
ce70748c 1587 return Nullch; /* sanity */
4ad56ec9
IZ
1588 }
1589
e8bc2b5c 1590 onb = BUCKET_SIZE_REAL(bucket);
55497cff 1591 /*
1592 * avoid the copy if same size block.
e8bc2b5c
GS
1593 * We are not agressive with boundary cases. Note that it might
1594 * (for a small number of cases) give false negative if
55497cff 1595 * both new size and old one are in the bucket for
e8bc2b5c
GS
1596 * FIRST_BIG_POW2, but the new one is near the lower end.
1597 *
1598 * We do not try to go to 1.5 times smaller bucket so far.
55497cff 1599 */
e8bc2b5c
GS
1600 if (nbytes > onb) incr = 1;
1601 else {
1602#ifdef DO_NOT_TRY_HARDER_WHEN_SHRINKING
1603 if ( /* This is a little bit pessimal if PACK_MALLOC: */
1604 nbytes > ( (onb >> 1) - M_OVERHEAD )
1605# ifdef TWO_POT_OPTIMIZE
1606 || (bucket == FIRST_BIG_POW2 && nbytes >= LAST_SMALL_BOUND )
1607# endif
1608 )
1609#else /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1610 prev_bucket = ( (bucket > MAX_PACKED + 1)
1611 ? bucket - BUCKETS_PER_POW2
1612 : bucket - 1);
1613 if (nbytes > BUCKET_SIZE_REAL(prev_bucket))
1614#endif /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1615 incr = 0;
1616 else incr = -1;
1617 }
2ce36478 1618#ifdef STRESS_REALLOC
4ad56ec9 1619 goto hard_way;
2ce36478 1620#endif
4ad56ec9 1621 if (incr == 0) {
852c2e52 1622 inplace_label:
a687059c
LW
1623#ifdef RCHECK
1624 /*
1625 * Record new allocated size of block and
1626 * bound space with magic numbers.
1627 */
72aaf631 1628 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
e8bc2b5c
GS
1629 int i, nb = ovp->ov_size + 1;
1630
1631 if ((i = nb & 3)) {
1632 i = 4 - i;
1633 while (i--) {
3541dd58 1634 ASSERT(*((char *)((caddr_t)ovp + nb - RSLOP + i)) == RMAGIC_C, "chunk's tail overwrite");
e8bc2b5c
GS
1635 }
1636 }
1637 nb = (nb + 3) &~ 3;
3541dd58 1638 ASSERT(*(u_int *)((caddr_t)ovp + nb - RSLOP) == RMAGIC, "chunk's tail overwrite");
a687059c
LW
1639 /*
1640 * Convert amount of memory requested into
1641 * closest block size stored in hash buckets
1642 * which satisfies request. Account for
1643 * space used per block for accounting.
1644 */
cf5c4ad8 1645 nbytes += M_OVERHEAD;
72aaf631 1646 ovp->ov_size = nbytes - 1;
e8bc2b5c
GS
1647 if ((i = nbytes & 3)) {
1648 i = 4 - i;
1649 while (i--)
1650 *((char *)((caddr_t)ovp + nbytes - RSLOP + i))
1651 = RMAGIC_C;
1652 }
1653 nbytes = (nbytes + 3) &~ 3;
72aaf631 1654 *((u_int *)((caddr_t)ovp + nbytes - RSLOP)) = RMAGIC;
a687059c
LW
1655 }
1656#endif
45d8adaa 1657 res = cp;
42ac124e
IZ
1658 DEBUG_m(PerlIO_printf(Perl_debug_log,
1659 "0x%lx: (%05lu) realloc %ld bytes inplace\n",
1660 (unsigned long)res,(unsigned long)(PL_an++),
1661 (long)size));
e8bc2b5c
GS
1662 } else if (incr == 1 && (cp - M_OVERHEAD == last_op)
1663 && (onb > (1 << LOG_OF_MIN_ARENA))) {
1664 MEM_SIZE require, newarena = nbytes, pow;
1665 int shiftr;
1666
1667 POW2_OPTIMIZE_ADJUST(newarena);
1668 newarena = newarena + M_OVERHEAD;
1669 /* newarena = (newarena + 3) &~ 3; */
1670 shiftr = (newarena - 1) >> LOG_OF_MIN_ARENA;
1671 pow = LOG_OF_MIN_ARENA + 1;
1672 /* apart from this loop, this is O(1) */
1673 while (shiftr >>= 1)
1674 pow++;
1675 newarena = (1 << pow) + POW2_OPTIMIZE_SURPLUS(pow * BUCKETS_PER_POW2);
1676 require = newarena - onb - M_OVERHEAD;
1677
4ad56ec9
IZ
1678 MALLOC_LOCK;
1679 if (cp - M_OVERHEAD == last_op /* We *still* are the last chunk */
1680 && getpages_adjacent(require)) {
e8bc2b5c 1681#ifdef DEBUGGING_MSTATS
fa423c5b
IZ
1682 nmalloc[bucket]--;
1683 nmalloc[pow * BUCKETS_PER_POW2]++;
e8bc2b5c 1684#endif
fa423c5b 1685 *(cp - M_OVERHEAD) = pow * BUCKETS_PER_POW2; /* Fill index. */
4ad56ec9 1686 MALLOC_UNLOCK;
fa423c5b 1687 goto inplace_label;
4ad56ec9
IZ
1688 } else {
1689 MALLOC_UNLOCK;
fa423c5b 1690 goto hard_way;
4ad56ec9 1691 }
e8bc2b5c
GS
1692 } else {
1693 hard_way:
42ac124e
IZ
1694 DEBUG_m(PerlIO_printf(Perl_debug_log,
1695 "0x%lx: (%05lu) realloc %ld bytes the hard way\n",
1696 (unsigned long)cp,(unsigned long)(PL_an++),
1697 (long)size));
86058a2d 1698 if ((res = (char*)Perl_malloc(nbytes)) == NULL)
e8bc2b5c
GS
1699 return (NULL);
1700 if (cp != res) /* common optimization */
1701 Copy(cp, res, (MEM_SIZE)(nbytes<onb?nbytes:onb), char);
4ad56ec9 1702 Perl_mfree(cp);
45d8adaa 1703 }
2304df62 1704 return ((Malloc_t)res);
8d063cd8
LW
1705}
1706
1707/*
1708 * Search ``srchlen'' elements of each free list for a block whose
1709 * header starts at ``freep''. If srchlen is -1 search the whole list.
1710 * Return bucket number, or -1 if not found.
1711 */
ee0007ab 1712static int
8ac85365 1713findbucket(union overhead *freep, int srchlen)
8d063cd8
LW
1714{
1715 register union overhead *p;
1716 register int i, j;
1717
1718 for (i = 0; i < NBUCKETS; i++) {
1719 j = 0;
1720 for (p = nextf[i]; p && j != srchlen; p = p->ov_next) {
1721 if (p == freep)
1722 return (i);
1723 j++;
1724 }
1725 }
1726 return (-1);
1727}
1728
cf5c4ad8 1729Malloc_t
86058a2d 1730Perl_calloc(register size_t elements, register size_t size)
cf5c4ad8 1731{
1732 long sz = elements * size;
86058a2d 1733 Malloc_t p = Perl_malloc(sz);
cf5c4ad8 1734
1735 if (p) {
1736 memset((void*)p, 0, sz);
1737 }
1738 return p;
1739}
1740
4ad56ec9
IZ
1741char *
1742Perl_strdup(const char *s)
1743{
1744 MEM_SIZE l = strlen(s);
1745 char *s1 = (char *)Perl_malloc(l);
1746
1747 Copy(s, s1, (MEM_SIZE)l, char);
1748 return s1;
1749}
1750
1751#ifdef PERL_CORE
1752int
1753Perl_putenv(char *a)
1754{
1755 /* Sometimes system's putenv conflicts with my_setenv() - this is system
1756 malloc vs Perl's free(). */
1757 dTHX;
1758 char *var;
1759 char *val = a;
1760 MEM_SIZE l;
1761 char buf[80];
1762
1763 while (*val && *val != '=')
1764 val++;
1765 if (!*val)
1766 return -1;
1767 l = val - a;
1768 if (l < sizeof(buf))
1769 var = buf;
1770 else
1771 var = Perl_malloc(l + 1);
1772 Copy(a, var, l, char);
1773 val++;
1774 my_setenv(var,val);
1775 if (var != buf)
1776 Perl_mfree(var);
1777 return 0;
1778}
1779# endif
1780
e8bc2b5c 1781MEM_SIZE
cea2e8a9 1782Perl_malloced_size(void *p)
e8bc2b5c 1783{
8d6dde3e
IZ
1784 union overhead *ovp = (union overhead *)
1785 ((caddr_t)p - sizeof (union overhead) * CHUNK_SHIFT);
1786 int bucket = OV_INDEX(ovp);
1787#ifdef RCHECK
1788 /* The caller wants to have a complete control over the chunk,
1789 disable the memory checking inside the chunk. */
1790 if (bucket <= MAX_SHORT_BUCKET) {
1791 MEM_SIZE size = BUCKET_SIZE_REAL(bucket);
1792 ovp->ov_size = size + M_OVERHEAD - 1;
1793 *((u_int *)((caddr_t)ovp + size + M_OVERHEAD - RSLOP)) = RMAGIC;
1794 }
1795#endif
e8bc2b5c
GS
1796 return BUCKET_SIZE_REAL(bucket);
1797}
1798
e8bc2b5c
GS
1799# ifdef BUCKETS_ROOT2
1800# define MIN_EVEN_REPORT 6
1801# else
1802# define MIN_EVEN_REPORT MIN_BUCKET
1803# endif
8d063cd8
LW
1804/*
1805 * mstats - print out statistics about malloc
1806 *
1807 * Prints two lines of numbers, one showing the length of the free list
1808 * for each size category, the second showing the number of mallocs -
1809 * frees for each size category.
1810 */
ee0007ab 1811void
864dbfa3 1812Perl_dump_mstats(pTHX_ char *s)
8d063cd8 1813{
df31f264 1814#ifdef DEBUGGING_MSTATS
8d063cd8
LW
1815 register int i, j;
1816 register union overhead *p;
e8bc2b5c 1817 int topbucket=0, topbucket_ev=0, topbucket_odd=0, totfree=0, total=0;
c07a80fd 1818 u_int nfree[NBUCKETS];
e8bc2b5c 1819 int total_chain = 0;
4ad56ec9 1820 struct chunk_chain_s* nextchain;
8d063cd8 1821
4ad56ec9 1822 MALLOC_LOCK;
e8bc2b5c 1823 for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
8d063cd8
LW
1824 for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
1825 ;
c07a80fd 1826 nfree[i] = j;
e8bc2b5c
GS
1827 totfree += nfree[i] * BUCKET_SIZE_REAL(i);
1828 total += nmalloc[i] * BUCKET_SIZE_REAL(i);
1829 if (nmalloc[i]) {
1830 i % 2 ? (topbucket_odd = i) : (topbucket_ev = i);
1831 topbucket = i;
1832 }
c07a80fd 1833 }
4ad56ec9
IZ
1834 nextchain = chunk_chain;
1835 while (nextchain) {
1836 total_chain += nextchain->size;
1837 nextchain = nextchain->next;
1838 }
1839 MALLOC_UNLOCK;
c07a80fd 1840 if (s)
bf49b057 1841 PerlIO_printf(Perl_error_log,
d720c441 1842 "Memory allocation statistics %s (buckets %ld(%ld)..%ld(%ld)\n",
e8bc2b5c 1843 s,
d720c441
IZ
1844 (long)BUCKET_SIZE_REAL(MIN_BUCKET),
1845 (long)BUCKET_SIZE(MIN_BUCKET),
1846 (long)BUCKET_SIZE_REAL(topbucket), (long)BUCKET_SIZE(topbucket));
bf49b057 1847 PerlIO_printf(Perl_error_log, "%8d free:", totfree);
e8bc2b5c 1848 for (i = MIN_EVEN_REPORT; i <= topbucket; i += BUCKETS_PER_POW2) {
bf49b057 1849 PerlIO_printf(Perl_error_log,
e8bc2b5c
GS
1850 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1851 ? " %5d"
1852 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1853 nfree[i]);
1854 }
1855#ifdef BUCKETS_ROOT2
bf49b057 1856 PerlIO_printf(Perl_error_log, "\n\t ");
e8bc2b5c 1857 for (i = MIN_BUCKET + 1; i <= topbucket_odd; i += BUCKETS_PER_POW2) {
bf49b057 1858 PerlIO_printf(Perl_error_log,
e8bc2b5c
GS
1859 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1860 ? " %5d"
1861 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1862 nfree[i]);
8d063cd8 1863 }
e8bc2b5c 1864#endif
bf49b057 1865 PerlIO_printf(Perl_error_log, "\n%8d used:", total - totfree);
e8bc2b5c 1866 for (i = MIN_EVEN_REPORT; i <= topbucket; i += BUCKETS_PER_POW2) {
bf49b057 1867 PerlIO_printf(Perl_error_log,
e8bc2b5c
GS
1868 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1869 ? " %5d"
1870 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1871 nmalloc[i] - nfree[i]);
c07a80fd 1872 }
e8bc2b5c 1873#ifdef BUCKETS_ROOT2
bf49b057 1874 PerlIO_printf(Perl_error_log, "\n\t ");
e8bc2b5c 1875 for (i = MIN_BUCKET + 1; i <= topbucket_odd; i += BUCKETS_PER_POW2) {
bf49b057 1876 PerlIO_printf(Perl_error_log,
e8bc2b5c
GS
1877 ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1878 ? " %5d"
1879 : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1880 nmalloc[i] - nfree[i]);
1881 }
1882#endif
bf49b057 1883 PerlIO_printf(Perl_error_log, "\nTotal sbrk(): %d/%d:%d. Odd ends: pad+heads+chain+tail: %d+%d+%d+%d.\n",
e8bc2b5c
GS
1884 goodsbrk + sbrk_slack, sbrks, sbrk_good, sbrk_slack,
1885 start_slack, total_chain, sbrked_remains);
df31f264 1886#endif /* DEBUGGING_MSTATS */
c07a80fd 1887}
a687059c 1888#endif /* lint */
cf5c4ad8 1889
cf5c4ad8 1890#ifdef USE_PERL_SBRK
1891
8f1f23e8 1892# if defined(__MACHTEN_PPC__) || defined(NeXT) || defined(__NeXT__)
38ac2dc8
DD
1893# define PERL_SBRK_VIA_MALLOC
1894/*
1895 * MachTen's malloc() returns a buffer aligned on a two-byte boundary.
1896 * While this is adequate, it may slow down access to longer data
1897 * types by forcing multiple memory accesses. It also causes
1898 * complaints when RCHECK is in force. So we allocate six bytes
1899 * more than we need to, and return an address rounded up to an
1900 * eight-byte boundary.
1901 *
1902 * 980701 Dominic Dunlop <domo@computer.org>
1903 */
5bbd1ef5 1904# define SYSTEM_ALLOC_ALIGNMENT 2
38ac2dc8
DD
1905# endif
1906
760ac839 1907# ifdef PERL_SBRK_VIA_MALLOC
cf5c4ad8 1908
1909/* it may seem schizophrenic to use perl's malloc and let it call system */
1910/* malloc, the reason for that is only the 3.2 version of the OS that had */
1911/* frequent core dumps within nxzonefreenolock. This sbrk routine put an */
1912/* end to the cores */
1913
38ac2dc8
DD
1914# ifndef SYSTEM_ALLOC
1915# define SYSTEM_ALLOC(a) malloc(a)
1916# endif
5bbd1ef5
IZ
1917# ifndef SYSTEM_ALLOC_ALIGNMENT
1918# define SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
1919# endif
cf5c4ad8 1920
760ac839 1921# endif /* PERL_SBRK_VIA_MALLOC */
cf5c4ad8 1922
1923static IV Perl_sbrk_oldchunk;
1924static long Perl_sbrk_oldsize;
1925
760ac839
LW
1926# define PERLSBRK_32_K (1<<15)
1927# define PERLSBRK_64_K (1<<16)
cf5c4ad8 1928
b63effbb 1929Malloc_t
df0003d4 1930Perl_sbrk(int size)
cf5c4ad8 1931{
1932 IV got;
1933 int small, reqsize;
1934
1935 if (!size) return 0;
55497cff 1936#ifdef PERL_CORE
cf5c4ad8 1937 reqsize = size; /* just for the DEBUG_m statement */
1938#endif
57569e04
HM
1939#ifdef PACK_MALLOC
1940 size = (size + 0x7ff) & ~0x7ff;
1941#endif
cf5c4ad8 1942 if (size <= Perl_sbrk_oldsize) {
1943 got = Perl_sbrk_oldchunk;
1944 Perl_sbrk_oldchunk += size;
1945 Perl_sbrk_oldsize -= size;
1946 } else {
1947 if (size >= PERLSBRK_32_K) {
1948 small = 0;
1949 } else {
cf5c4ad8 1950 size = PERLSBRK_64_K;
1951 small = 1;
1952 }
5bbd1ef5
IZ
1953# if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
1954 size += NEEDED_ALIGNMENT - SYSTEM_ALLOC_ALIGNMENT;
1955# endif
cf5c4ad8 1956 got = (IV)SYSTEM_ALLOC(size);
5bbd1ef5 1957# if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
5a7d6335 1958 got = (got + NEEDED_ALIGNMENT - 1) & ~(NEEDED_ALIGNMENT - 1);
5bbd1ef5 1959# endif
cf5c4ad8 1960 if (small) {
1961 /* Chunk is small, register the rest for future allocs. */
1962 Perl_sbrk_oldchunk = got + reqsize;
1963 Perl_sbrk_oldsize = size - reqsize;
1964 }
1965 }
1966
fb73857a 1967 DEBUG_m(PerlIO_printf(Perl_debug_log, "sbrk malloc size %ld (reqsize %ld), left size %ld, give addr 0x%lx\n",
cf5c4ad8 1968 size, reqsize, Perl_sbrk_oldsize, got));
cf5c4ad8 1969
1970 return (void *)got;
1971}
1972
1973#endif /* ! defined USE_PERL_SBRK */