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