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