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