malloc.c

   1 /*    malloc.c
   2  *
   3  */
   4
   5 /*
   6   Here are some notes on configuring Perl's malloc.  (For non-perl
   7   usage see below.)
   8
   9   There are two macros which serve as bulk disablers of advanced
  10   features of this malloc: NO_FANCY_MALLOC, PLAIN_MALLOC (undef by
  11   default).  Look in the list of default values below to understand
  12   their exact effect.  Defining NO_FANCY_MALLOC returns malloc.c to the
  13   state of the malloc in Perl 5.004.  Additionally defining PLAIN_MALLOC
  14   returns it to the state as of Perl 5.000.
  15
  16   Note that some of the settings below may be ignored in the code based
  17   on values of other macros.  The PERL_CORE symbol is only defined when
  18   perl itself is being compiled (so malloc can make some assumptions
  19   about perl's facilities being available to it).
  20
  21   Each config option has a short description, followed by its name,
  22   default value, and a comment about the default (if applicable).  Some
  23   options take a precise value, while the others are just boolean.
  24   The boolean ones are listed first.
  25
  26     # Enable code for an emergency memory pool in $^M.  See perlvar.pod
  27     # for a description of $^M.
  28     PERL_EMERGENCY_SBRK         (!PLAIN_MALLOC && PERL_CORE)
  29
  30     # Enable code for printing memory statistics.
  31     DEBUGGING_MSTATS            (!PLAIN_MALLOC && PERL_CORE)
  32
  33     # Move allocation info for small buckets into separate areas.
  34     # Memory optimization (especially for small allocations, of the
  35     # less than 64 bytes).  Since perl usually makes a large number
  36     # of small allocations, this is usually a win.
  37     PACK_MALLOC                 (!PLAIN_MALLOC && !RCHECK)
  38
  39     # Add one page to big powers of two when calculating bucket size.
  40     # This is targeted at big allocations, as are common in image
  41     # processing.
  42     TWO_POT_OPTIMIZE            !PLAIN_MALLOC
  43
  44     # Use intermediate bucket sizes between powers-of-two.  This is
  45     # generally a memory optimization, and a (small) speed pessimization.
  46     BUCKETS_ROOT2               !NO_FANCY_MALLOC
  47
  48     # Do not check small deallocations for bad free().  Memory
  49     # and speed optimization, error reporting pessimization.
  50     IGNORE_SMALL_BAD_FREE       (!NO_FANCY_MALLOC && !RCHECK)
  51
  52     # Use table lookup to decide in which bucket a given allocation will go.
  53     SMALL_BUCKET_VIA_TABLE      !NO_FANCY_MALLOC
  54
  55     # Use a perl-defined sbrk() instead of the (presumably broken or
  56     # missing) system-supplied sbrk().
  57     USE_PERL_SBRK               undef
  58
  59     # Use system malloc() (or calloc() etc.) to emulate sbrk(). Normally
  60     # only used with broken sbrk()s.
  61     PERL_SBRK_VIA_MALLOC        undef
  62
  63     # Which allocator to use if PERL_SBRK_VIA_MALLOC
  64     SYSTEM_ALLOC(a)             malloc(a)
  65
  66     # Minimal alignment (in bytes, should be a power of 2) of SYSTEM_ALLOC
  67     SYSTEM_ALLOC_ALIGNMENT      MEM_ALIGNBYTES
  68
  69     # Disable memory overwrite checking with DEBUGGING.  Memory and speed
  70     # optimization, error reporting pessimization.
  71     NO_RCHECK                   undef
  72
  73     # Enable memory overwrite checking with DEBUGGING.  Memory and speed
  74     # pessimization, error reporting optimization
  75     RCHECK                      (DEBUGGING && !NO_RCHECK)
  76
  77     # Failed allocations bigger than this size croak (if
  78     # PERL_EMERGENCY_SBRK is enabled) without touching $^M.  See
  79     # perlvar.pod for a description of $^M.
  80     BIG_SIZE                     (1<<16)        # 64K
  81
  82     # Starting from this power of two, add an extra page to the
  83     # size of the bucket. This enables optimized allocations of sizes
  84     # close to powers of 2.  Note that the value is indexed at 0.
  85     FIRST_BIG_POW2              15              # 32K, 16K is used too often
  86
  87     # Estimate of minimal memory footprint.  malloc uses this value to
  88     # request the most reasonable largest blocks of memory from the system.
  89     FIRST_SBRK                  (48*1024)
  90
  91     # Round up sbrk()s to multiples of this.
  92     MIN_SBRK                    2048
  93
  94     # Round up sbrk()s to multiples of this percent of footprint.
  95     MIN_SBRK_FRAC               3
  96
  97     # Add this much memory to big powers of two to get the bucket size.
  98     PERL_PAGESIZE               4096
  99
 100     # This many sbrk() discontinuities should be tolerated even
 101     # from the start without deciding that sbrk() is usually
 102     # discontinuous.
 103     SBRK_ALLOW_FAILURES         3
 104
 105     # This many continuous sbrk()s compensate for one discontinuous one.
 106     SBRK_FAILURE_PRICE          50
 107
 108     # Some configurations may ask for 12-byte-or-so allocations which
 109     # require 8-byte alignment (?!).  In such situation one needs to
 110     # define this to disable 12-byte bucket (will increase memory footprint)
 111     STRICT_ALIGNMENT            undef
 112
 113   This implementation assumes that calling PerlIO_printf() does not
 114   result in any memory allocation calls (used during a panic).
 115
 116  */
 117
 118 /*
 119    If used outside of Perl environment, it may be useful to redefine
 120    the following macros (listed below with defaults):
 121
 122      # Type of address returned by allocation functions
 123      Malloc_t                           void *
 124
 125      # Type of size argument for allocation functions
 126      MEM_SIZE                           unsigned long
 127
 128      # Maximal value in LONG
 129      LONG_MAX                           0x7FFFFFFF
 130
 131      # Unsigned integer type big enough to keep a pointer
 132      UV                                 unsigned long
 133
 134      # Type of pointer with 1-byte granularity
 135      caddr_t                            char *
 136
 137      # Type returned by free()
 138      Free_t                             void
 139
 140      # Very fatal condition reporting function (cannot call any )
 141      fatalcroak(arg)                    write(2,arg,strlen(arg)) + exit(2)
 142
 143      # Fatal error reporting function
 144      croak(format, arg)                 warn(idem) + exit(1)
 145
 146      # Error reporting function
 147      warn(format, arg)                  fprintf(stderr, idem)
 148
 149      # Locking/unlocking for MT operation
 150      MALLOC_LOCK                        MUTEX_LOCK_NOCONTEXT(&PL_malloc_mutex)
 151      MALLOC_UNLOCK                      MUTEX_UNLOCK_NOCONTEXT(&PL_malloc_mutex)
 152
 153      # Locking/unlocking mutex for MT operation
 154      MUTEX_LOCK(l)                      void
 155      MUTEX_UNLOCK(l)                    void
 156  */
 157
 158 #ifndef NO_FANCY_MALLOC
 159 #  ifndef SMALL_BUCKET_VIA_TABLE
 160 #    define SMALL_BUCKET_VIA_TABLE
 161 #  endif
 162 #  ifndef BUCKETS_ROOT2
 163 #    define BUCKETS_ROOT2
 164 #  endif
 165 #  ifndef IGNORE_SMALL_BAD_FREE
 166 #    define IGNORE_SMALL_BAD_FREE
 167 #  endif
 168 #endif
 169
 170 #ifndef PLAIN_MALLOC                    /* Bulk enable features */
 171 #  ifndef PACK_MALLOC
 172 #      define PACK_MALLOC
 173 #  endif
 174 #  ifndef TWO_POT_OPTIMIZE
 175 #    define TWO_POT_OPTIMIZE
 176 #  endif
 177 #  if defined(PERL_CORE) && !defined(PERL_EMERGENCY_SBRK)
 178 #    define PERL_EMERGENCY_SBRK
 179 #  endif
 180 #  if defined(PERL_CORE) && !defined(DEBUGGING_MSTATS)
 181 #    define DEBUGGING_MSTATS
 182 #  endif
 183 #endif
 184
 185 #define MIN_BUC_POW2 (sizeof(void*) > 4 ? 3 : 2) /* Allow for 4-byte arena. */
 186 #define MIN_BUCKET (MIN_BUC_POW2 * BUCKETS_PER_POW2)
 187
 188 #if !(defined(I286) || defined(atarist) || defined(__MINT__))
 189         /* take 2k unless the block is bigger than that */
 190 #  define LOG_OF_MIN_ARENA 11
 191 #else
 192         /* take 16k unless the block is bigger than that
 193            (80286s like large segments!), probably good on the atari too */
 194 #  define LOG_OF_MIN_ARENA 14
 195 #endif
 196
 197 #ifndef lint
 198 #  if defined(DEBUGGING) && !defined(NO_RCHECK)
 199 #    define RCHECK
 200 #  endif
 201 #  if defined(RCHECK) && defined(IGNORE_SMALL_BAD_FREE)
 202 #    undef IGNORE_SMALL_BAD_FREE
 203 #  endif
 204 /*
 205  * malloc.c (Caltech) 2/21/82
 206  * Chris Kingsley, kingsley@cit-20.
 207  *
 208  * This is a very fast storage allocator.  It allocates blocks of a small
 209  * number of different sizes, and keeps free lists of each size.  Blocks that
 210  * don't exactly fit are passed up to the next larger size.  In this
 211  * implementation, the available sizes are 2^n-4 (or 2^n-12) bytes long.
 212  * If PACK_MALLOC is defined, small blocks are 2^n bytes long.
 213  * This is designed for use in a program that uses vast quantities of memory,
 214  * but bombs when it runs out.
 215  *
 216  * Modifications Copyright Ilya Zakharevich 1996-99.
 217  *
 218  * Still very quick, but much more thrifty.  (Std config is 10% slower
 219  * than it was, and takes 67% of old heap size for typical usage.)
 220  *
 221  * Allocations of small blocks are now table-driven to many different
 222  * buckets.  Sizes of really big buckets are increased to accomodata
 223  * common size=power-of-2 blocks.  Running-out-of-memory is made into
 224  * an exception.  Deeply configurable and thread-safe.
 225  *
 226  */
 227
 228 #ifdef PERL_CORE
 229 #  include "EXTERN.h"
 230 #  define PERL_IN_MALLOC_C
 231 #  include "perl.h"
 232 #  if defined(PERL_IMPLICIT_CONTEXT)
 233 #    define croak       Perl_croak_nocontext
 234 #    define warn        Perl_warn_nocontext
 235 #  endif
 236 #else
 237 #  ifdef PERL_FOR_X2P
 238 #    include "../EXTERN.h"
 239 #    include "../perl.h"
 240 #  else
 241 #    include <stdlib.h>
 242 #    include <stdio.h>
 243 #    include <memory.h>
 244 #    define _(arg) arg
 245 #    ifndef Malloc_t
 246 #      define Malloc_t void *
 247 #    endif
 248 #    ifndef MEM_SIZE
 249 #      define MEM_SIZE unsigned long
 250 #    endif
 251 #    ifndef LONG_MAX
 252 #      define LONG_MAX 0x7FFFFFFF
 253 #    endif
 254 #    ifndef UV
 255 #      define UV unsigned long
 256 #    endif
 257 #    ifndef caddr_t
 258 #      define caddr_t char *
 259 #    endif
 260 #    ifndef Free_t
 261 #      define Free_t void
 262 #    endif
 263 #    define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
 264 #    define PerlEnv_getenv getenv
 265 #    define PerlIO_printf fprintf
 266 #    define PerlIO_stderr() stderr
 267 #  endif
 268 #  ifndef croak                         /* make depend */
 269 #    define croak(mess, arg) (warn((mess), (arg)), exit(1))
 270 #  endif
 271 #  ifndef warn
 272 #    define warn(mess, arg) fprintf(stderr, (mess), (arg))
 273 #  endif
 274 #  ifdef DEBUG_m
 275 #    undef DEBUG_m
 276 #  endif
 277 #  define DEBUG_m(a)
 278 #  ifdef DEBUGGING
 279 #     undef DEBUGGING
 280 #  endif
 281 #  ifndef pTHX
 282 #     define pTHX               void
 283 #     define pTHX_
 284 #     define dTHX               extern int Perl___notused
 285 #     define WITH_THX(s)        s
 286 #  endif
 287 #  ifndef PERL_GET_INTERP
 288 #     define PERL_GET_INTERP    PL_curinterp
 289 #  endif
 290 #  ifndef Perl_malloc
 291 #     define Perl_malloc malloc
 292 #  endif
 293 #  ifndef Perl_mfree
 294 #     define Perl_mfree free
 295 #  endif
 296 #  ifndef Perl_realloc
 297 #     define Perl_realloc realloc
 298 #  endif
 299 #  ifndef Perl_calloc
 300 #     define Perl_calloc calloc
 301 #  endif
 302 #  ifndef Perl_strdup
 303 #     define Perl_strdup strdup
 304 #  endif
 305 #endif
 306
 307 #ifndef MUTEX_LOCK
 308 #  define MUTEX_LOCK(l)
 309 #endif
 310
 311 #ifndef MUTEX_UNLOCK
 312 #  define MUTEX_UNLOCK(l)
 313 #endif
 314
 315 #ifndef MALLOC_LOCK
 316 #  define MALLOC_LOCK           MUTEX_LOCK_NOCONTEXT(&PL_malloc_mutex)
 317 #endif
 318
 319 #ifndef MALLOC_UNLOCK
 320 #  define MALLOC_UNLOCK         MUTEX_UNLOCK_NOCONTEXT(&PL_malloc_mutex)
 321 #endif
 322
 323 #  ifndef fatalcroak                            /* make depend */
 324 #    define fatalcroak(mess)    (write(2, (mess), strlen(mess)), exit(2))
 325 #  endif
 326
 327 #ifdef DEBUGGING
 328 #  undef DEBUG_m
 329 #  define DEBUG_m(a)  \
 330     STMT_START {                                                        \
 331         if (PERL_GET_INTERP) { dTHX; if (PL_debug & 128) { a; } }       \
 332     } STMT_END
 333 #endif
 334
 335 #ifdef PERL_IMPLICIT_CONTEXT
 336 #  define PERL_IS_ALIVE         aTHX
 337 #else
 338 #  define PERL_IS_ALIVE         TRUE
 339 #endif
 340
 341
 342 /*
 343  * Layout of memory:
 344  * ~~~~~~~~~~~~~~~~
 345  * The memory is broken into "blocks" which occupy multiples of 2K (and
 346  * generally speaking, have size "close" to a power of 2).  The addresses
 347  * of such *unused* blocks are kept in nextf[i] with big enough i.  (nextf
 348  * is an array of linked lists.)  (Addresses of used blocks are not known.)
 349  *
 350  * Moreover, since the algorithm may try to "bite" smaller blocks out
 351  * of unused bigger ones, there are also regions of "irregular" size,
 352  * managed separately, by a linked list chunk_chain.
 353  *
 354  * The third type of storage is the sbrk()ed-but-not-yet-used space, its
 355  * end and size are kept in last_sbrk_top and sbrked_remains.
 356  *
 357  * Growing blocks "in place":
 358  * ~~~~~~~~~~~~~~~~~~~~~~~~~
 359  * The address of the block with the greatest address is kept in last_op
 360  * (if not known, last_op is 0).  If it is known that the memory above
 361  * last_op is not continuous, or contains a chunk from chunk_chain,
 362  * last_op is set to 0.
 363  *
 364  * The chunk with address last_op may be grown by expanding into
 365  * sbrk()ed-but-not-yet-used space, or trying to sbrk() more continuous
 366  * memory.
 367  *
 368  * Management of last_op:
 369  * ~~~~~~~~~~~~~~~~~~~~~
 370  *
 371  * free() never changes the boundaries of blocks, so is not relevant.
 372  *
 373  * The only way realloc() may change the boundaries of blocks is if it
 374  * grows a block "in place".  However, in the case of success such a
 375  * chunk is automatically last_op, and it remains last_op.  In the case
 376  * of failure getpages_adjacent() clears last_op.
 377  *
 378  * malloc() may change blocks by calling morecore() only.
 379  *
 380  * morecore() may create new blocks by:
 381  *   a) biting pieces from chunk_chain (cannot create one above last_op);
 382  *   b) biting a piece from an unused block (if block was last_op, this
 383  *      may create a chunk from chain above last_op, thus last_op is
 384  *      invalidated in such a case).
 385  *   c) biting of sbrk()ed-but-not-yet-used space.  This creates
 386  *      a block which is last_op.
 387  *   d) Allocating new pages by calling getpages();
 388  *
 389  * getpages() creates a new block.  It marks last_op at the bottom of
 390  * the chunk of memory it returns.
 391  *
 392  * Active pages footprint:
 393  * ~~~~~~~~~~~~~~~~~~~~~~
 394  * Note that we do not need to traverse the lists in nextf[i], just take
 395  * the first element of this list.  However, we *need* to traverse the
 396  * list in chunk_chain, but most the time it should be a very short one,
 397  * so we do not step on a lot of pages we are not going to use.
 398  *
 399  * Flaws:
 400  * ~~~~~
 401  * get_from_bigger_buckets(): forget to increment price => Quite
 402  * aggressive.
 403  */
 404
 405 /* I don't much care whether these are defined in sys/types.h--LAW */
 406
 407 #define u_char unsigned char
 408 #define u_int unsigned int
 409 /*
 410  * I removed the definition of u_bigint which appeared to be u_bigint = UV
 411  * u_bigint was only used in TWOK_MASKED and TWOK_SHIFT
 412  * where I have used PTR2UV.  RMB
 413  */
 414 #define u_short unsigned short
 415
 416 /* 286 and atarist like big chunks, which gives too much overhead. */
 417 #if (defined(RCHECK) || defined(I286) || defined(atarist) || defined(__MINT__)) && defined(PACK_MALLOC)
 418 #  undef PACK_MALLOC
 419 #endif
 420
 421 /*
 422  * The description below is applicable if PACK_MALLOC is not defined.
 423  *
 424  * The overhead on a block is at least 4 bytes.  When free, this space
 425  * contains a pointer to the next free block, and the bottom two bits must
 426  * be zero.  When in use, the first byte is set to MAGIC, and the second
 427  * byte is the size index.  The remaining bytes are for alignment.
 428  * If range checking is enabled and the size of the block fits
 429  * in two bytes, then the top two bytes hold the size of the requested block
 430  * plus the range checking words, and the header word MINUS ONE.
 431  */
 432 union   overhead {
 433         union   overhead *ov_next;      /* when free */
 434 #if MEM_ALIGNBYTES > 4
 435         double  strut;                  /* alignment problems */
 436 #endif
 437         struct {
 438                 u_char  ovu_magic;      /* magic number */
 439                 u_char  ovu_index;      /* bucket # */
 440 #ifdef RCHECK
 441                 u_short ovu_size;       /* actual block size */
 442                 u_int   ovu_rmagic;     /* range magic number */
 443 #endif
 444         } ovu;
 445 #define ov_magic        ovu.ovu_magic
 446 #define ov_index        ovu.ovu_index
 447 #define ov_size         ovu.ovu_size
 448 #define ov_rmagic       ovu.ovu_rmagic
 449 };
 450
 451 #define MAGIC           0xff            /* magic # on accounting info */
 452 #define RMAGIC          0x55555555      /* magic # on range info */
 453 #define RMAGIC_C        0x55            /* magic # on range info */
 454
 455 #ifdef RCHECK
 456 #  define       RSLOP           sizeof (u_int)
 457 #  ifdef TWO_POT_OPTIMIZE
 458 #    define MAX_SHORT_BUCKET (12 * BUCKETS_PER_POW2)
 459 #  else
 460 #    define MAX_SHORT_BUCKET (13 * BUCKETS_PER_POW2)
 461 #  endif
 462 #else
 463 #  define       RSLOP           0
 464 #endif
 465
 466 #if !defined(PACK_MALLOC) && defined(BUCKETS_ROOT2)
 467 #  undef BUCKETS_ROOT2
 468 #endif
 469
 470 #ifdef BUCKETS_ROOT2
 471 #  define BUCKET_TABLE_SHIFT 2
 472 #  define BUCKET_POW2_SHIFT 1
 473 #  define BUCKETS_PER_POW2 2
 474 #else
 475 #  define BUCKET_TABLE_SHIFT MIN_BUC_POW2
 476 #  define BUCKET_POW2_SHIFT 0
 477 #  define BUCKETS_PER_POW2 1
 478 #endif
 479
 480 #if !defined(MEM_ALIGNBYTES) || ((MEM_ALIGNBYTES > 4) && !defined(STRICT_ALIGNMENT))
 481 /* Figure out the alignment of void*. */
 482 struct aligner {
 483   char c;
 484   void *p;
 485 };
 486 #  define ALIGN_SMALL ((int)((caddr_t)&(((struct aligner*)0)->p)))
 487 #else
 488 #  define ALIGN_SMALL MEM_ALIGNBYTES
 489 #endif
 490
 491 #define IF_ALIGN_8(yes,no)      ((ALIGN_SMALL>4) ? (yes) : (no))
 492
 493 #ifdef BUCKETS_ROOT2
 494 #  define MAX_BUCKET_BY_TABLE 13
 495 static u_short buck_size[MAX_BUCKET_BY_TABLE + 1] =
 496   {
 497       0, 0, 0, 0, 4, 4, 8, 12, 16, 24, 32, 48, 64, 80,
 498   };
 499 #  define BUCKET_SIZE(i) ((i) % 2 ? buck_size[i] : (1 << ((i) >> BUCKET_POW2_SHIFT)))
 500 #  define BUCKET_SIZE_REAL(i) ((i) <= MAX_BUCKET_BY_TABLE               \
 501                                ? buck_size[i]                           \
 502                                : ((1 << ((i) >> BUCKET_POW2_SHIFT))     \
 503                                   - MEM_OVERHEAD(i)                     \
 504                                   + POW2_OPTIMIZE_SURPLUS(i)))
 505 #else
 506 #  define BUCKET_SIZE(i) (1 << ((i) >> BUCKET_POW2_SHIFT))
 507 #  define BUCKET_SIZE_REAL(i) (BUCKET_SIZE(i) - MEM_OVERHEAD(i) + POW2_OPTIMIZE_SURPLUS(i))
 508 #endif
 509
 510
 511 #ifdef PACK_MALLOC
 512 /* In this case there are several possible layout of arenas depending
 513  * on the size.  Arenas are of sizes multiple to 2K, 2K-aligned, and
 514  * have a size close to a power of 2.
 515  *
 516  * Arenas of the size >= 4K keep one chunk only.  Arenas of size 2K
 517  * may keep one chunk or multiple chunks.  Here are the possible
 518  * layouts of arenas:
 519  *
 520  *      # One chunk only, chunksize 2^k + SOMETHING - ALIGN, k >= 11
 521  *
 522  * INDEX MAGIC1 UNUSED CHUNK1
 523  *
 524  *      # Multichunk with sanity checking and chunksize 2^k-ALIGN, k>7
 525  *
 526  * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 CHUNK2 CHUNK3 ...
 527  *
 528  *      # Multichunk with sanity checking and size 2^k-ALIGN, k=7
 529  *
 530  * INDEX MAGIC1 MAGIC2 MAGIC3 UNUSED CHUNK1 UNUSED CHUNK2 CHUNK3 ...
 531  *
 532  *      # Multichunk with sanity checking and size up to 80
 533  *
 534  * INDEX UNUSED MAGIC1 UNUSED MAGIC2 UNUSED ... CHUNK1 CHUNK2 CHUNK3 ...
 535  *
 536  *      # No sanity check (usually up to 48=byte-long buckets)
 537  * INDEX UNUSED CHUNK1 CHUNK2 ...
 538  *
 539  * Above INDEX and MAGIC are one-byte-long.  Sizes of UNUSED are
 540  * appropriate to keep algorithms simple and memory aligned.  INDEX
 541  * encodes the size of the chunk, while MAGICn encodes state (used,
 542  * free or non-managed-by-us-so-it-indicates-a-bug) of CHUNKn.  MAGIC
 543  * is used for sanity checking purposes only.  SOMETHING is 0 or 4K
 544  * (to make size of big CHUNK accomodate allocations for powers of two
 545  * better).
 546  *
 547  * [There is no need to alignment between chunks, since C rules ensure
 548  *  that structs which need 2^k alignment have sizeof which is
 549  *  divisible by 2^k.  Thus as far as the last chunk is aligned at the
 550  *  end of the arena, and 2K-alignment does not contradict things,
 551  *  everything is going to be OK for sizes of chunks 2^n and 2^n +
 552  *  2^k.  Say, 80-bit buckets will be 16-bit aligned, and as far as we
 553  *  put allocations for requests in 65..80 range, all is fine.
 554  *
 555  *  Note, however, that standard malloc() puts more strict
 556  *  requirements than the above C rules.  Moreover, our algorithms of
 557  *  realloc() may break this idyll, but we suppose that realloc() does
 558  *  need not change alignment.]
 559  *
 560  * Is very important to make calculation of the offset of MAGICm as
 561  * quick as possible, since it is done on each malloc()/free().  In
 562  * fact it is so quick that it has quite little effect on the speed of
 563  * doing malloc()/free().  [By default] We forego such calculations
 564  * for small chunks, but only to save extra 3% of memory, not because
 565  * of speed considerations.
 566  *
 567  * Here is the algorithm [which is the same for all the allocations
 568  * schemes above], see OV_MAGIC(block,bucket).  Let OFFSETm be the
 569  * offset of the CHUNKm from the start of ARENA.  Then offset of
 570  * MAGICm is (OFFSET1 >> SHIFT) + ADDOFFSET.  Here SHIFT and ADDOFFSET
 571  * are numbers which depend on the size of the chunks only.
 572  *
 573  * Let as check some sanity conditions.  Numbers OFFSETm>>SHIFT are
 574  * different for all the chunks in the arena if 2^SHIFT is not greater
 575  * than size of the chunks in the arena.  MAGIC1 will not overwrite
 576  * INDEX provided ADDOFFSET is >0 if OFFSET1 < 2^SHIFT.  MAGIClast
 577  * will not overwrite CHUNK1 if OFFSET1 > (OFFSETlast >> SHIFT) +
 578  * ADDOFFSET.
 579  *
 580  * Make SHIFT the maximal possible (there is no point in making it
 581  * smaller).  Since OFFSETlast is 2K - CHUNKSIZE, above restrictions
 582  * give restrictions on OFFSET1 and on ADDOFFSET.
 583  *
 584  * In particular, for chunks of size 2^k with k>=6 we can put
 585  * ADDOFFSET to be from 0 to 2^k - 2^(11-k), and have
 586  * OFFSET1==chunksize.  For chunks of size 80 OFFSET1 of 2K%80=48 is
 587  * large enough to have ADDOFFSET between 1 and 16 (similarly for 96,
 588  * when ADDOFFSET should be 1).  In particular, keeping MAGICs for
 589  * these sizes gives no additional size penalty.
 590  *
 591  * However, for chunks of size 2^k with k<=5 this gives OFFSET1 >=
 592  * ADDOFSET + 2^(11-k).  Keeping ADDOFFSET 0 allows for 2^(11-k)-2^(11-2k)
 593  * chunks per arena.  This is smaller than 2^(11-k) - 1 which are
 594  * needed if no MAGIC is kept.  [In fact, having a negative ADDOFFSET
 595  * would allow for slightly more buckets per arena for k=2,3.]
 596  *
 597  * Similarly, for chunks of size 3/2*2^k with k<=5 MAGICs would span
 598  * the area up to 2^(11-k)+ADDOFFSET.  For k=4 this give optimal
 599  * ADDOFFSET as -7..0.  For k=3 ADDOFFSET can go up to 4 (with tiny
 600  * savings for negative ADDOFFSET).  For k=5 ADDOFFSET can go -1..16
 601  * (with no savings for negative values).
 602  *
 603  * In particular, keeping ADDOFFSET 0 for sizes of chunks up to 2^6
 604  * leads to tiny pessimizations in case of sizes 4, 8, 12, 24, and
 605  * leads to no contradictions except for size=80 (or 96.)
 606  *
 607  * However, it also makes sense to keep no magic for sizes 48 or less.
 608  * This is what we do.  In this case one needs ADDOFFSET>=1 also for
 609  * chunksizes 12, 24, and 48, unless one gets one less chunk per
 610  * arena.
 611  *
 612  * The algo of OV_MAGIC(block,bucket) keeps ADDOFFSET 0 until
 613  * chunksize of 64, then makes it 1.
 614  *
 615  * This allows for an additional optimization: the above scheme leads
 616  * to giant overheads for sizes 128 or more (one whole chunk needs to
 617  * be sacrifised to keep INDEX).  Instead we use chunks not of size
 618  * 2^k, but of size 2^k-ALIGN.  If we pack these chunks at the end of
 619  * the arena, then the beginnings are still in different 2^k-long
 620  * sections of the arena if k>=7 for ALIGN==4, and k>=8 if ALIGN=8.
 621  * Thus for k>7 the above algo of calculating the offset of the magic
 622  * will still give different answers for different chunks.  And to
 623  * avoid the overrun of MAGIC1 into INDEX, one needs ADDOFFSET of >=1.
 624  * In the case k=7 we just move the first chunk an extra ALIGN
 625  * backward inside the ARENA (this is done once per arena lifetime,
 626  * thus is not a big overhead).  */
 627 #  define MAX_PACKED_POW2 6
 628 #  define MAX_PACKED (MAX_PACKED_POW2 * BUCKETS_PER_POW2 + BUCKET_POW2_SHIFT)
 629 #  define MAX_POW2_ALGO ((1<<(MAX_PACKED_POW2 + 1)) - M_OVERHEAD)
 630 #  define TWOK_MASK ((1<<LOG_OF_MIN_ARENA) - 1)
 631 #  define TWOK_MASKED(x) (PTR2UV(x) & ~TWOK_MASK)
 632 #  define TWOK_SHIFT(x) (PTR2UV(x) & TWOK_MASK)
 633 #  define OV_INDEXp(block) (INT2PTR(u_char*,TWOK_MASKED(block)))
 634 #  define OV_INDEX(block) (*OV_INDEXp(block))
 635 #  define OV_MAGIC(block,bucket) (*(OV_INDEXp(block) +                  \
 636                                     (TWOK_SHIFT(block)>>                \
 637                                      (bucket>>BUCKET_POW2_SHIFT)) +     \
 638                                     (bucket >= MIN_NEEDS_SHIFT ? 1 : 0)))
 639     /* A bucket can have a shift smaller than it size, we need to
 640        shift its magic number so it will not overwrite index: */
 641 #  ifdef BUCKETS_ROOT2
 642 #    define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2 - 1) /* Shift 80 greater than chunk 64. */
 643 #  else
 644 #    define MIN_NEEDS_SHIFT (7*BUCKETS_PER_POW2) /* Shift 128 greater than chunk 32. */
 645 #  endif
 646 #  define CHUNK_SHIFT 0
 647
 648 /* Number of active buckets of given ordinal. */
 649 #ifdef IGNORE_SMALL_BAD_FREE
 650 #define FIRST_BUCKET_WITH_CHECK (6 * BUCKETS_PER_POW2) /* 64 */
 651 #  define N_BLKS(bucket) ( (bucket) < FIRST_BUCKET_WITH_CHECK           \
 652                          ? ((1<<LOG_OF_MIN_ARENA) - 1)/BUCKET_SIZE(bucket) \
 653                          : n_blks[bucket] )
 654 #else
 655 #  define N_BLKS(bucket) n_blks[bucket]
 656 #endif
 657
 658 static u_short n_blks[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] =
 659   {
 660 #  if BUCKETS_PER_POW2==1
 661       0, 0,
 662       (MIN_BUC_POW2==2 ? 384 : 0),
 663       224, 120, 62, 31, 16, 8, 4, 2
 664 #  else
 665       0, 0, 0, 0,
 666       (MIN_BUC_POW2==2 ? 384 : 0), (MIN_BUC_POW2==2 ? 384 : 0), /* 4, 4 */
 667       224, 149, 120, 80, 62, 41, 31, 25, 16, 16, 8, 8, 4, 4, 2, 2
 668 #  endif
 669   };
 670
 671 /* Shift of the first bucket with the given ordinal inside 2K chunk. */
 672 #ifdef IGNORE_SMALL_BAD_FREE
 673 #  define BLK_SHIFT(bucket) ( (bucket) < FIRST_BUCKET_WITH_CHECK        \
 674                               ? ((1<<LOG_OF_MIN_ARENA)                  \
 675                                  - BUCKET_SIZE(bucket) * N_BLKS(bucket)) \
 676                               : blk_shift[bucket])
 677 #else
 678 #  define BLK_SHIFT(bucket) blk_shift[bucket]
 679 #endif
 680
 681 static u_short blk_shift[LOG_OF_MIN_ARENA * BUCKETS_PER_POW2] =
 682   {
 683 #  if BUCKETS_PER_POW2==1
 684       0, 0,
 685       (MIN_BUC_POW2==2 ? 512 : 0),
 686       256, 128, 64, 64,                 /* 8 to 64 */
 687       16*sizeof(union overhead),
 688       8*sizeof(union overhead),
 689       4*sizeof(union overhead),
 690       2*sizeof(union overhead),
 691 #  else
 692       0, 0, 0, 0,
 693       (MIN_BUC_POW2==2 ? 512 : 0), (MIN_BUC_POW2==2 ? 512 : 0),
 694       256, 260, 128, 128, 64, 80, 64, 48, /* 8 to 96 */
 695       16*sizeof(union overhead), 16*sizeof(union overhead),
 696       8*sizeof(union overhead), 8*sizeof(union overhead),
 697       4*sizeof(union overhead), 4*sizeof(union overhead),
 698       2*sizeof(union overhead), 2*sizeof(union overhead),
 699 #  endif
 700   };
 701
 702 #  define NEEDED_ALIGNMENT 0x800        /* 2k boundaries */
 703 #  define WANTED_ALIGNMENT 0x800        /* 2k boundaries */
 704
 705 #else  /* !PACK_MALLOC */
 706
 707 #  define OV_MAGIC(block,bucket) (block)->ov_magic
 708 #  define OV_INDEX(block) (block)->ov_index
 709 #  define CHUNK_SHIFT 1
 710 #  define MAX_PACKED -1
 711 #  define NEEDED_ALIGNMENT MEM_ALIGNBYTES
 712 #  define WANTED_ALIGNMENT 0x400        /* 1k boundaries */
 713
 714 #endif /* !PACK_MALLOC */
 715
 716 #define M_OVERHEAD (sizeof(union overhead) + RSLOP)
 717
 718 #ifdef PACK_MALLOC
 719 #  define MEM_OVERHEAD(bucket) \
 720   (bucket <= MAX_PACKED ? 0 : M_OVERHEAD)
 721 #  ifdef SMALL_BUCKET_VIA_TABLE
 722 #    define START_SHIFTS_BUCKET ((MAX_PACKED_POW2 + 1) * BUCKETS_PER_POW2)
 723 #    define START_SHIFT MAX_PACKED_POW2
 724 #    ifdef BUCKETS_ROOT2                /* Chunks of size 3*2^n. */
 725 #      define SIZE_TABLE_MAX 80
 726 #    else
 727 #      define SIZE_TABLE_MAX 64
 728 #    endif
 729 static char bucket_of[] =
 730   {
 731 #    ifdef BUCKETS_ROOT2                /* Chunks of size 3*2^n. */
 732       /* 0 to 15 in 4-byte increments. */
 733       (sizeof(void*) > 4 ? 6 : 5),      /* 4/8, 5-th bucket for better reports */
 734       6,                                /* 8 */
 735       IF_ALIGN_8(8,7), 8,               /* 16/12, 16 */
 736       9, 9, 10, 10,                     /* 24, 32 */
 737       11, 11, 11, 11,                   /* 48 */
 738       12, 12, 12, 12,                   /* 64 */
 739       13, 13, 13, 13,                   /* 80 */
 740       13, 13, 13, 13                    /* 80 */
 741 #    else /* !BUCKETS_ROOT2 */
 742       /* 0 to 15 in 4-byte increments. */
 743       (sizeof(void*) > 4 ? 3 : 2),
 744       3,
 745       4, 4,
 746       5, 5, 5, 5,
 747       6, 6, 6, 6,
 748       6, 6, 6, 6
 749 #    endif /* !BUCKETS_ROOT2 */
 750   };
 751 #  else  /* !SMALL_BUCKET_VIA_TABLE */
 752 #    define START_SHIFTS_BUCKET MIN_BUCKET
 753 #    define START_SHIFT (MIN_BUC_POW2 - 1)
 754 #  endif /* !SMALL_BUCKET_VIA_TABLE */
 755 #else  /* !PACK_MALLOC */
 756 #  define MEM_OVERHEAD(bucket) M_OVERHEAD
 757 #  ifdef SMALL_BUCKET_VIA_TABLE
 758 #    undef SMALL_BUCKET_VIA_TABLE
 759 #  endif
 760 #  define START_SHIFTS_BUCKET MIN_BUCKET
 761 #  define START_SHIFT (MIN_BUC_POW2 - 1)
 762 #endif /* !PACK_MALLOC */
 763
 764 /*
 765  * Big allocations are often of the size 2^n bytes. To make them a
 766  * little bit better, make blocks of size 2^n+pagesize for big n.
 767  */
 768
 769 #ifdef TWO_POT_OPTIMIZE
 770
 771 #  ifndef PERL_PAGESIZE
 772 #    define PERL_PAGESIZE 4096
 773 #  endif
 774 #  ifndef FIRST_BIG_POW2
 775 #    define FIRST_BIG_POW2 15   /* 32K, 16K is used too often. */
 776 #  endif
 777 #  define FIRST_BIG_BLOCK (1<<FIRST_BIG_POW2)
 778 /* If this value or more, check against bigger blocks. */
 779 #  define FIRST_BIG_BOUND (FIRST_BIG_BLOCK - M_OVERHEAD)
 780 /* If less than this value, goes into 2^n-overhead-block. */
 781 #  define LAST_SMALL_BOUND ((FIRST_BIG_BLOCK>>1) - M_OVERHEAD)
 782
 783 #  define POW2_OPTIMIZE_ADJUST(nbytes)                          \
 784    ((nbytes >= FIRST_BIG_BOUND) ? nbytes -= PERL_PAGESIZE : 0)
 785 #  define POW2_OPTIMIZE_SURPLUS(bucket)                         \
 786    ((bucket >= FIRST_BIG_POW2 * BUCKETS_PER_POW2) ? PERL_PAGESIZE : 0)
 787
 788 #else  /* !TWO_POT_OPTIMIZE */
 789 #  define POW2_OPTIMIZE_ADJUST(nbytes)
 790 #  define POW2_OPTIMIZE_SURPLUS(bucket) 0
 791 #endif /* !TWO_POT_OPTIMIZE */
 792
 793 #if defined(HAS_64K_LIMIT) && defined(PERL_CORE)
 794 #  define BARK_64K_LIMIT(what,nbytes,size)                              \
 795         if (nbytes > 0xffff) {                                          \
 796                 PerlIO_printf(PerlIO_stderr(),                          \
 797                               "%s too large: %lx\n", what, size);       \
 798                 my_exit(1);                                             \
 799         }
 800 #else /* !HAS_64K_LIMIT || !PERL_CORE */
 801 #  define BARK_64K_LIMIT(what,nbytes,size)
 802 #endif /* !HAS_64K_LIMIT || !PERL_CORE */
 803
 804 #ifndef MIN_SBRK
 805 #  define MIN_SBRK 2048
 806 #endif
 807
 808 #ifndef FIRST_SBRK
 809 #  define FIRST_SBRK (48*1024)
 810 #endif
 811
 812 /* Minimal sbrk in percents of what is already alloced. */
 813 #ifndef MIN_SBRK_FRAC
 814 #  define MIN_SBRK_FRAC 3
 815 #endif
 816
 817 #ifndef SBRK_ALLOW_FAILURES
 818 #  define SBRK_ALLOW_FAILURES 3
 819 #endif
 820
 821 #ifndef SBRK_FAILURE_PRICE
 822 #  define SBRK_FAILURE_PRICE 50
 823 #endif
 824
 825 #if defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)
 826
 827 #  ifndef BIG_SIZE
 828 #    define BIG_SIZE (1<<16)            /* 64K */
 829 #  endif
 830
 831 #ifdef I_MACH_CTHREADS
 832 #  undef  MUTEX_LOCK
 833 #  define MUTEX_LOCK(m)   STMT_START { if (*m) mutex_lock(*m);   } STMT_END
 834 #  undef  MUTEX_UNLOCK
 835 #  define MUTEX_UNLOCK(m) STMT_START { if (*m) mutex_unlock(*m); } STMT_END
 836 #endif
 837
 838 static char *emergency_buffer;
 839 static MEM_SIZE emergency_buffer_size;
 840
 841 static int      findbucket      (union overhead *freep, int srchlen);
 842 static void     morecore        (register int bucket);
 843 #  if defined(DEBUGGING)
 844 static void     botch           (char *diag, char *s);
 845 #  endif
 846 static void     add_to_chain    (void *p, MEM_SIZE size, MEM_SIZE chip);
 847 static Malloc_t emergency_sbrk  (MEM_SIZE size);
 848 static void*    get_from_chain  (MEM_SIZE size);
 849 static void*    get_from_bigger_buckets(int bucket, MEM_SIZE size);
 850 static union overhead *getpages (int needed, int *nblksp, int bucket);
 851 static int      getpages_adjacent(int require);
 852
 853 static Malloc_t
 854 emergency_sbrk(MEM_SIZE size)
 855 {
 856     MEM_SIZE rsize = (((size - 1)>>LOG_OF_MIN_ARENA) + 1)<<LOG_OF_MIN_ARENA;
 857
 858     if (size >= BIG_SIZE) {
 859         /* Give the possibility to recover: */
 860         MALLOC_UNLOCK;
 861         croak("Out of memory during \"large\" request for %i bytes", size);
 862     }
 863
 864     if (emergency_buffer_size >= rsize) {
 865         char *old = emergency_buffer;
 866
 867         emergency_buffer_size -= rsize;
 868         emergency_buffer += rsize;
 869         return old;
 870     } else {
 871         dTHX;
 872         /* First offense, give a possibility to recover by dieing. */
 873         /* No malloc involved here: */
 874         GV **gvp = (GV**)hv_fetch(PL_defstash, "^M", 2, 0);
 875         SV *sv;
 876         char *pv;
 877         int have = 0;
 878         STRLEN n_a;
 879
 880         if (emergency_buffer_size) {
 881             add_to_chain(emergency_buffer, emergency_buffer_size, 0);
 882             emergency_buffer_size = 0;
 883             emergency_buffer = Nullch;
 884             have = 1;
 885         }
 886         if (!gvp) gvp = (GV**)hv_fetch(PL_defstash, "\015", 1, 0);
 887         if (!gvp || !(sv = GvSV(*gvp)) || !SvPOK(sv)
 888             || (SvLEN(sv) < (1<<LOG_OF_MIN_ARENA) - M_OVERHEAD)) {
 889             if (have)
 890                 goto do_croak;
 891             return (char *)-1;          /* Now die die die... */
 892         }
 893         /* Got it, now detach SvPV: */
 894         pv = SvPV(sv, n_a);
 895         /* Check alignment: */
 896         if ((PTR2UV(pv) - sizeof(union overhead)) & (NEEDED_ALIGNMENT - 1)) {
 897             PerlIO_puts(PerlIO_stderr(),"Bad alignment of $^M!\n");
 898             return (char *)-1;          /* die die die */
 899         }
 900
 901         emergency_buffer = pv - sizeof(union overhead);
 902         emergency_buffer_size = malloced_size(pv) + M_OVERHEAD;
 903         SvPOK_off(sv);
 904         SvPVX(sv) = Nullch;
 905         SvCUR(sv) = SvLEN(sv) = 0;
 906     }
 907   do_croak:
 908     MALLOC_UNLOCK;
 909     croak("Out of memory during request for %i bytes", size);
 910     /* NOTREACHED */
 911     return Nullch;
 912 }
 913
 914 #else /* !(defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)) */
 915 #  define emergency_sbrk(size)  -1
 916 #endif /* !(defined(PERL_EMERGENCY_SBRK) && defined(PERL_CORE)) */
 917
 918 /*
 919  * nextf[i] is the pointer to the next free block of size 2^i.  The
 920  * smallest allocatable block is 8 bytes.  The overhead information
 921  * precedes the data area returned to the user.
 922  */
 923 #define NBUCKETS (32*BUCKETS_PER_POW2 + 1)
 924 static  union overhead *nextf[NBUCKETS];
 925
 926 #if defined(PURIFY) && !defined(USE_PERL_SBRK)
 927 #  define USE_PERL_SBRK
 928 #endif
 929
 930 #ifdef USE_PERL_SBRK
 931 #define sbrk(a) Perl_sbrk(a)
 932 Malloc_t Perl_sbrk (int size);
 933 #else
 934 #ifdef DONT_DECLARE_STD
 935 #ifdef I_UNISTD
 936 #include <unistd.h>
 937 #endif
 938 #else
 939 extern  Malloc_t sbrk(int);
 940 #endif
 941 #endif
 942
 943 #ifdef DEBUGGING_MSTATS
 944 /*
 945  * nmalloc[i] is the difference between the number of mallocs and frees
 946  * for a given block size.
 947  */
 948 static  u_int nmalloc[NBUCKETS];
 949 static  u_int sbrk_slack;
 950 static  u_int start_slack;
 951 #endif
 952
 953 static  u_int goodsbrk;
 954
 955 #ifdef DEBUGGING
 956 #undef ASSERT
 957 #define ASSERT(p,diag)   if (!(p)) botch(diag,STRINGIFY(p));  else
 958 static void
 959 botch(char *diag, char *s)
 960 {
 961         dTHX;
 962         PerlIO_printf(PerlIO_stderr(), "assertion botched (%s?): %s\n", diag, s);
 963         PerlProc_abort();
 964 }
 965 #else
 966 #define ASSERT(p, diag)
 967 #endif
 968
 969 Malloc_t
 970 Perl_malloc(register size_t nbytes)
 971 {
 972         register union overhead *p;
 973         register int bucket;
 974         register MEM_SIZE shiftr;
 975
 976 #if defined(DEBUGGING) || defined(RCHECK)
 977         MEM_SIZE size = nbytes;
 978 #endif
 979
 980         BARK_64K_LIMIT("Allocation",nbytes,nbytes);
 981 #ifdef DEBUGGING
 982         if ((long)nbytes < 0)
 983             croak("%s", "panic: malloc");
 984 #endif
 985
 986         /*
 987          * Convert amount of memory requested into
 988          * closest block size stored in hash buckets
 989          * which satisfies request.  Account for
 990          * space used per block for accounting.
 991          */
 992 #ifdef PACK_MALLOC
 993 #  ifdef SMALL_BUCKET_VIA_TABLE
 994         if (nbytes == 0)
 995             bucket = MIN_BUCKET;
 996         else if (nbytes <= SIZE_TABLE_MAX) {
 997             bucket = bucket_of[(nbytes - 1) >> BUCKET_TABLE_SHIFT];
 998         } else
 999 #  else
1000         if (nbytes == 0)
1001             nbytes = 1;
1002         if (nbytes <= MAX_POW2_ALGO) goto do_shifts;
1003         else
1004 #  endif
1005 #endif
1006         {
1007             POW2_OPTIMIZE_ADJUST(nbytes);
1008             nbytes += M_OVERHEAD;
1009             nbytes = (nbytes + 3) &~ 3;
1010           do_shifts:
1011             shiftr = (nbytes - 1) >> START_SHIFT;
1012             bucket = START_SHIFTS_BUCKET;
1013             /* apart from this loop, this is O(1) */
1014             while (shiftr >>= 1)
1015                 bucket += BUCKETS_PER_POW2;
1016         }
1017         MALLOC_LOCK;
1018         /*
1019          * If nothing in hash bucket right now,
1020          * request more memory from the system.
1021          */
1022         if (nextf[bucket] == NULL)
1023                 morecore(bucket);
1024         if ((p = nextf[bucket]) == NULL) {
1025                 MALLOC_UNLOCK;
1026 #ifdef PERL_CORE
1027                 {
1028                     dTHX;
1029                     if (!PL_nomemok) {
1030                         PerlIO_puts(PerlIO_stderr(),"Out of memory!\n");
1031                         my_exit(1);
1032                     }
1033                 }
1034 #endif
1035                 return (NULL);
1036         }
1037
1038         DEBUG_m(PerlIO_printf(Perl_debug_log,
1039                               "0x%"UVxf": (%05lu) malloc %ld bytes\n",
1040                               PTR2UV(p+1), (unsigned long)(PL_an++),
1041                               (long)size));
1042
1043         /* remove from linked list */
1044 #if defined(RCHECK)
1045         if ((PTR2UV(p)) & (MEM_ALIGNBYTES - 1)) {
1046             dTHX;
1047             PerlIO_printf(PerlIO_stderr(),
1048                           "Unaligned pointer in the free chain 0x%"UVxf"\n",
1049                           PTR2UV(p));
1050         }
1051         if ((PTR2UV(p->ov_next)) & (MEM_ALIGNBYTES - 1)) {
1052             dTHX;
1053             PerlIO_printf(PerlIO_stderr(),
1054                           "Unaligned `next' pointer in the free "
1055                           "chain 0x"UVxf" at 0x%"UVxf"\n",
1056                           PTR2UV(p->ov_next), PTR2UV(p));
1057         }
1058 #endif
1059         nextf[bucket] = p->ov_next;
1060
1061         MALLOC_UNLOCK;
1062
1063 #ifdef IGNORE_SMALL_BAD_FREE
1064         if (bucket >= FIRST_BUCKET_WITH_CHECK)
1065 #endif
1066             OV_MAGIC(p, bucket) = MAGIC;
1067 #ifndef PACK_MALLOC
1068         OV_INDEX(p) = bucket;
1069 #endif
1070 #ifdef RCHECK
1071         /*
1072          * Record allocated size of block and
1073          * bound space with magic numbers.
1074          */
1075         p->ov_rmagic = RMAGIC;
1076         if (bucket <= MAX_SHORT_BUCKET) {
1077             int i;
1078
1079             nbytes = size + M_OVERHEAD;
1080             p->ov_size = nbytes - 1;
1081             if ((i = nbytes & 3)) {
1082                 i = 4 - i;
1083                 while (i--)
1084                     *((char *)((caddr_t)p + nbytes - RSLOP + i)) = RMAGIC_C;
1085             }
1086             nbytes = (nbytes + 3) &~ 3;
1087             *((u_int *)((caddr_t)p + nbytes - RSLOP)) = RMAGIC;
1088         }
1089 #endif
1090         return ((Malloc_t)(p + CHUNK_SHIFT));
1091 }
1092
1093 static char *last_sbrk_top;
1094 static char *last_op;                   /* This arena can be easily extended. */
1095 static int sbrked_remains;
1096 static int sbrk_good = SBRK_ALLOW_FAILURES * SBRK_FAILURE_PRICE;
1097
1098 #ifdef DEBUGGING_MSTATS
1099 static int sbrks;
1100 #endif
1101
1102 struct chunk_chain_s {
1103     struct chunk_chain_s *next;
1104     MEM_SIZE size;
1105 };
1106 static struct chunk_chain_s *chunk_chain;
1107 static int n_chunks;
1108 static char max_bucket;
1109
1110 /* Cutoff a piece of one of the chunks in the chain.  Prefer smaller chunk. */
1111 static void *
1112 get_from_chain(MEM_SIZE size)
1113 {
1114     struct chunk_chain_s *elt = chunk_chain, **oldp = &chunk_chain;
1115     struct chunk_chain_s **oldgoodp = NULL;
1116     long min_remain = LONG_MAX;
1117
1118     while (elt) {
1119         if (elt->size >= size) {
1120             long remains = elt->size - size;
1121             if (remains >= 0 && remains < min_remain) {
1122                 oldgoodp = oldp;
1123                 min_remain = remains;
1124             }
1125             if (remains == 0) {
1126                 break;
1127             }
1128         }
1129         oldp = &( elt->next );
1130         elt = elt->next;
1131     }
1132     if (!oldgoodp) return NULL;
1133     if (min_remain) {
1134         void *ret = *oldgoodp;
1135         struct chunk_chain_s *next = (*oldgoodp)->next;
1136
1137         *oldgoodp = (struct chunk_chain_s *)((char*)ret + size);
1138         (*oldgoodp)->size = min_remain;
1139         (*oldgoodp)->next = next;
1140         return ret;
1141     } else {
1142         void *ret = *oldgoodp;
1143         *oldgoodp = (*oldgoodp)->next;
1144         n_chunks--;
1145         return ret;
1146     }
1147 }
1148
1149 static void
1150 add_to_chain(void *p, MEM_SIZE size, MEM_SIZE chip)
1151 {
1152     struct chunk_chain_s *next = chunk_chain;
1153     char *cp = (char*)p;
1154
1155     cp += chip;
1156     chunk_chain = (struct chunk_chain_s *)cp;
1157     chunk_chain->size = size - chip;
1158     chunk_chain->next = next;
1159     n_chunks++;
1160 }
1161
1162 static void *
1163 get_from_bigger_buckets(int bucket, MEM_SIZE size)
1164 {
1165     int price = 1;
1166     static int bucketprice[NBUCKETS];
1167     while (bucket <= max_bucket) {
1168         /* We postpone stealing from bigger buckets until we want it
1169            often enough. */
1170         if (nextf[bucket] && bucketprice[bucket]++ >= price) {
1171             /* Steal it! */
1172             void *ret = (void*)(nextf[bucket] - 1 + CHUNK_SHIFT);
1173             bucketprice[bucket] = 0;
1174             if (((char*)nextf[bucket]) - M_OVERHEAD == last_op) {
1175                 last_op = NULL;         /* Disable optimization */
1176             }
1177             nextf[bucket] = nextf[bucket]->ov_next;
1178 #ifdef DEBUGGING_MSTATS
1179             nmalloc[bucket]--;
1180             start_slack -= M_OVERHEAD;
1181 #endif
1182             add_to_chain(ret, (BUCKET_SIZE(bucket) +
1183                                POW2_OPTIMIZE_SURPLUS(bucket)),
1184                          size);
1185             return ret;
1186         }
1187         bucket++;
1188     }
1189     return NULL;
1190 }
1191
1192 static union overhead *
1193 getpages(int needed, int *nblksp, int bucket)
1194 {
1195     /* Need to do (possibly expensive) system call. Try to
1196        optimize it for rare calling. */
1197     MEM_SIZE require = needed - sbrked_remains;
1198     char *cp;
1199     union overhead *ovp;
1200     int slack = 0;
1201
1202     if (sbrk_good > 0) {
1203         if (!last_sbrk_top && require < FIRST_SBRK)
1204             require = FIRST_SBRK;
1205         else if (require < MIN_SBRK) require = MIN_SBRK;
1206
1207         if (require < goodsbrk * MIN_SBRK_FRAC / 100)
1208             require = goodsbrk * MIN_SBRK_FRAC / 100;
1209         require = ((require - 1 + MIN_SBRK) / MIN_SBRK) * MIN_SBRK;
1210     } else {
1211         require = needed;
1212         last_sbrk_top = 0;
1213         sbrked_remains = 0;
1214     }
1215
1216     DEBUG_m(PerlIO_printf(Perl_debug_log,
1217                           "sbrk(%ld) for %ld-byte-long arena\n",
1218                           (long)require, (long) needed));
1219     cp = (char *)sbrk(require);
1220 #ifdef DEBUGGING_MSTATS
1221     sbrks++;
1222 #endif
1223     if (cp == last_sbrk_top) {
1224         /* Common case, anything is fine. */
1225         sbrk_good++;
1226         ovp = (union overhead *) (cp - sbrked_remains);
1227         last_op = cp - sbrked_remains;
1228         sbrked_remains = require - (needed - sbrked_remains);
1229     } else if (cp == (char *)-1) { /* no more room! */
1230         ovp = (union overhead *)emergency_sbrk(needed);
1231         if (ovp == (union overhead *)-1)
1232             return 0;
1233         if (((char*)ovp) > last_op) {   /* Cannot happen with current emergency_sbrk() */
1234             last_op = 0;
1235         }
1236         return ovp;
1237     } else {                    /* Non-continuous or first sbrk(). */
1238         long add = sbrked_remains;
1239         char *newcp;
1240
1241         if (sbrked_remains) {   /* Put rest into chain, we
1242                                    cannot use it right now. */
1243             add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1244                          sbrked_remains, 0);
1245         }
1246
1247         /* Second, check alignment. */
1248         slack = 0;
1249
1250 #if !defined(atarist) && !defined(__MINT__) /* on the atari we dont have to worry about this */
1251 #  ifndef I286  /* The sbrk(0) call on the I286 always returns the next segment */
1252         /* WANTED_ALIGNMENT may be more than NEEDED_ALIGNMENT, but this may
1253            improve performance of memory access. */
1254         if (PTR2UV(cp) & (WANTED_ALIGNMENT - 1)) { /* Not aligned. */
1255             slack = WANTED_ALIGNMENT - (PTR2UV(cp) & (WANTED_ALIGNMENT - 1));
1256             add += slack;
1257         }
1258 #  endif
1259 #endif /* !atarist && !MINT */
1260
1261         if (add) {
1262             DEBUG_m(PerlIO_printf(Perl_debug_log,
1263                                   "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",
1264                                   (long)add, (long) slack,
1265                                   (long) sbrked_remains));
1266             newcp = (char *)sbrk(add);
1267 #if defined(DEBUGGING_MSTATS)
1268             sbrks++;
1269             sbrk_slack += add;
1270 #endif
1271             if (newcp != cp + require) {
1272                 /* Too bad: even rounding sbrk() is not continuous.*/
1273                 DEBUG_m(PerlIO_printf(Perl_debug_log,
1274                                       "failed to fix bad sbrk()\n"));
1275 #ifdef PACK_MALLOC
1276                 if (slack) {
1277                     MALLOC_UNLOCK;
1278                     fatalcroak("panic: Off-page sbrk\n");
1279                 }
1280 #endif
1281                 if (sbrked_remains) {
1282                     /* Try again. */
1283 #if defined(DEBUGGING_MSTATS)
1284                     sbrk_slack += require;
1285 #endif
1286                     require = needed;
1287                     DEBUG_m(PerlIO_printf(Perl_debug_log,
1288                                           "straight sbrk(%ld)\n",
1289                                           (long)require));
1290                     cp = (char *)sbrk(require);
1291 #ifdef DEBUGGING_MSTATS
1292                     sbrks++;
1293 #endif
1294                     if (cp == (char *)-1)
1295                         return 0;
1296                 }
1297                 sbrk_good = -1; /* Disable optimization!
1298                                    Continue with not-aligned... */
1299             } else {
1300                 cp += slack;
1301                 require += sbrked_remains;
1302             }
1303         }
1304
1305         if (last_sbrk_top) {
1306             sbrk_good -= SBRK_FAILURE_PRICE;
1307         }
1308
1309         ovp = (union overhead *) cp;
1310         /*
1311          * Round up to minimum allocation size boundary
1312          * and deduct from block count to reflect.
1313          */
1314
1315 #  if NEEDED_ALIGNMENT > MEM_ALIGNBYTES
1316         if (PTR2UV(ovp) & (NEEDED_ALIGNMENT - 1))
1317             fatalcroak("Misalignment of sbrk()\n");
1318         else
1319 #  endif
1320 #ifndef I286    /* Again, this should always be ok on an 80286 */
1321         if (PTR2UV(ovp) & (MEM_ALIGNBYTES - 1)) {
1322             DEBUG_m(PerlIO_printf(Perl_debug_log,
1323                                   "fixing sbrk(): %d bytes off machine alignement\n",
1324                                   (int)(PTR2UV(ovp) & (MEM_ALIGNBYTES - 1))));
1325             ovp = INT2PTR(union overhead *,(PTR2UV(ovp) + MEM_ALIGNBYTES) &
1326                                      (MEM_ALIGNBYTES - 1));
1327             (*nblksp)--;
1328 # if defined(DEBUGGING_MSTATS)
1329             /* This is only approx. if TWO_POT_OPTIMIZE: */
1330             sbrk_slack += (1 << (bucket >> BUCKET_POW2_SHIFT));
1331 # endif
1332         }
1333 #endif
1334         ;                               /* Finish `else' */
1335         sbrked_remains = require - needed;
1336         last_op = cp;
1337     }
1338     last_sbrk_top = cp + require;
1339 #ifdef DEBUGGING_MSTATS
1340     goodsbrk += require;
1341 #endif
1342     return ovp;
1343 }
1344
1345 static int
1346 getpages_adjacent(int require)
1347 {
1348     if (require <= sbrked_remains) {
1349         sbrked_remains -= require;
1350     } else {
1351         char *cp;
1352
1353         require -= sbrked_remains;
1354         /* We do not try to optimize sbrks here, we go for place. */
1355         cp = (char*) sbrk(require);
1356 #ifdef DEBUGGING_MSTATS
1357         sbrks++;
1358         goodsbrk += require;
1359 #endif
1360         if (cp == last_sbrk_top) {
1361             sbrked_remains = 0;
1362             last_sbrk_top = cp + require;
1363         } else {
1364             if (cp == (char*)-1) {      /* Out of memory */
1365 #ifdef DEBUGGING_MSTATS
1366                 goodsbrk -= require;
1367 #endif
1368                 return 0;
1369             }
1370             /* Report the failure: */
1371             if (sbrked_remains)
1372                 add_to_chain((void*)(last_sbrk_top - sbrked_remains),
1373                              sbrked_remains, 0);
1374             add_to_chain((void*)cp, require, 0);
1375             sbrk_good -= SBRK_FAILURE_PRICE;
1376             sbrked_remains = 0;
1377             last_sbrk_top = 0;
1378             last_op = 0;
1379             return 0;
1380         }
1381     }
1382
1383     return 1;
1384 }
1385
1386 /*
1387  * Allocate more memory to the indicated bucket.
1388  */
1389 static void
1390 morecore(register int bucket)
1391 {
1392         register union overhead *ovp;
1393         register int rnu;       /* 2^rnu bytes will be requested */
1394         int nblks;              /* become nblks blocks of the desired size */
1395         register MEM_SIZE siz, needed;
1396
1397         if (nextf[bucket])
1398                 return;
1399         if (bucket == sizeof(MEM_SIZE)*8*BUCKETS_PER_POW2) {
1400             MALLOC_UNLOCK;
1401             croak("%s", "Out of memory during ridiculously large request");
1402         }
1403         if (bucket > max_bucket)
1404             max_bucket = bucket;
1405
1406         rnu = ( (bucket <= (LOG_OF_MIN_ARENA << BUCKET_POW2_SHIFT))
1407                 ? LOG_OF_MIN_ARENA
1408                 : (bucket >> BUCKET_POW2_SHIFT) );
1409         /* This may be overwritten later: */
1410         nblks = 1 << (rnu - (bucket >> BUCKET_POW2_SHIFT)); /* how many blocks to get */
1411         needed = ((MEM_SIZE)1 << rnu) + POW2_OPTIMIZE_SURPLUS(bucket);
1412         if (nextf[rnu << BUCKET_POW2_SHIFT]) { /* 2048b bucket. */
1413             ovp = nextf[rnu << BUCKET_POW2_SHIFT] - 1 + CHUNK_SHIFT;
1414             nextf[rnu << BUCKET_POW2_SHIFT]
1415                 = nextf[rnu << BUCKET_POW2_SHIFT]->ov_next;
1416 #ifdef DEBUGGING_MSTATS
1417             nmalloc[rnu << BUCKET_POW2_SHIFT]--;
1418             start_slack -= M_OVERHEAD;
1419 #endif
1420             DEBUG_m(PerlIO_printf(Perl_debug_log,
1421                                   "stealing %ld bytes from %ld arena\n",
1422                                   (long) needed, (long) rnu << BUCKET_POW2_SHIFT));
1423         } else if (chunk_chain
1424                    && (ovp = (union overhead*) get_from_chain(needed))) {
1425             DEBUG_m(PerlIO_printf(Perl_debug_log,
1426                                   "stealing %ld bytes from chain\n",
1427                                   (long) needed));
1428         } else if ( (ovp = (union overhead*)
1429                      get_from_bigger_buckets((rnu << BUCKET_POW2_SHIFT) + 1,
1430                                              needed)) ) {
1431             DEBUG_m(PerlIO_printf(Perl_debug_log,
1432                                   "stealing %ld bytes from bigger buckets\n",
1433                                   (long) needed));
1434         } else if (needed <= sbrked_remains) {
1435             ovp = (union overhead *)(last_sbrk_top - sbrked_remains);
1436             sbrked_remains -= needed;
1437             last_op = (char*)ovp;
1438         } else
1439             ovp = getpages(needed, &nblks, bucket);
1440
1441         if (!ovp)
1442             return;
1443
1444         /*
1445          * Add new memory allocated to that on
1446          * free list for this hash bucket.
1447          */
1448         siz = BUCKET_SIZE(bucket);
1449 #ifdef PACK_MALLOC
1450         *(u_char*)ovp = bucket; /* Fill index. */
1451         if (bucket <= MAX_PACKED) {
1452             ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1453             nblks = N_BLKS(bucket);
1454 #  ifdef DEBUGGING_MSTATS
1455             start_slack += BLK_SHIFT(bucket);
1456 #  endif
1457         } else if (bucket < LOG_OF_MIN_ARENA * BUCKETS_PER_POW2) {
1458             ovp = (union overhead *) ((char*)ovp + BLK_SHIFT(bucket));
1459             siz -= sizeof(union overhead);
1460         } else ovp++;           /* One chunk per block. */
1461 #endif /* PACK_MALLOC */
1462         nextf[bucket] = ovp;
1463 #ifdef DEBUGGING_MSTATS
1464         nmalloc[bucket] += nblks;
1465         if (bucket > MAX_PACKED) {
1466             start_slack += M_OVERHEAD * nblks;
1467         }
1468 #endif
1469         while (--nblks > 0) {
1470                 ovp->ov_next = (union overhead *)((caddr_t)ovp + siz);
1471                 ovp = (union overhead *)((caddr_t)ovp + siz);
1472         }
1473         /* Not all sbrks return zeroed memory.*/
1474         ovp->ov_next = (union overhead *)NULL;
1475 #ifdef PACK_MALLOC
1476         if (bucket == 7*BUCKETS_PER_POW2) { /* Special case, explanation is above. */
1477             union overhead *n_op = nextf[7*BUCKETS_PER_POW2]->ov_next;
1478             nextf[7*BUCKETS_PER_POW2] =
1479                 (union overhead *)((caddr_t)nextf[7*BUCKETS_PER_POW2]
1480                                    - sizeof(union overhead));
1481             nextf[7*BUCKETS_PER_POW2]->ov_next = n_op;
1482         }
1483 #endif /* !PACK_MALLOC */
1484 }
1485
1486 Free_t
1487 Perl_mfree(void *mp)
1488 {
1489         register MEM_SIZE size;
1490         register union overhead *ovp;
1491         char *cp = (char*)mp;
1492 #ifdef PACK_MALLOC
1493         u_char bucket;
1494 #endif
1495
1496         DEBUG_m(PerlIO_printf(Perl_debug_log,
1497                               "0x%"UVxf": (%05lu) free\n",
1498                               PTR2UV(cp), (unsigned long)(PL_an++)));
1499
1500         if (cp == NULL)
1501                 return;
1502         ovp = (union overhead *)((caddr_t)cp
1503                                 - sizeof (union overhead) * CHUNK_SHIFT);
1504 #ifdef PACK_MALLOC
1505         bucket = OV_INDEX(ovp);
1506 #endif
1507 #ifdef IGNORE_SMALL_BAD_FREE
1508         if ((bucket >= FIRST_BUCKET_WITH_CHECK)
1509             && (OV_MAGIC(ovp, bucket) != MAGIC))
1510 #else
1511         if (OV_MAGIC(ovp, bucket) != MAGIC)
1512 #endif
1513             {
1514                 static int bad_free_warn = -1;
1515                 if (bad_free_warn == -1) {
1516                     dTHX;
1517                     char *pbf = PerlEnv_getenv("PERL_BADFREE");
1518                     bad_free_warn = (pbf) ? atoi(pbf) : 1;
1519                 }
1520                 if (!bad_free_warn)
1521                     return;
1522 #ifdef RCHECK
1523                 {
1524                     dTHX;
1525 #ifdef PERL_CORE
1526                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
1527                         Perl_warner(aTHX_ WARN_MALLOC, "%s free() ignored",
1528                                     ovp->ov_rmagic == RMAGIC - 1 ?
1529                                     "Duplicate" : "Bad");
1530 #else
1531                     warn("%s free() ignored",
1532                         ovp->ov_rmagic == RMAGIC - 1 ? "Duplicate" : "Bad");
1533 #endif
1534 #else
1535 #ifdef PERL_CORE
1536                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
1537                         Perl_warner(aTHX_ WARN_MALLOC, "%s", "Bad free() ignored");
1538 #else
1539                     warn("%s", "Bad free() ignored");
1540 #endif
1541                 }
1542 #endif
1543                 return;                         /* sanity */
1544             }
1545 #ifdef RCHECK
1546         ASSERT(ovp->ov_rmagic == RMAGIC, "chunk's head overwrite");
1547         if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1548             int i;
1549             MEM_SIZE nbytes = ovp->ov_size + 1;
1550
1551             if ((i = nbytes & 3)) {
1552                 i = 4 - i;
1553                 while (i--) {
1554                     ASSERT(*((char *)((caddr_t)ovp + nbytes - RSLOP + i))
1555                            == RMAGIC_C, "chunk's tail overwrite");
1556                 }
1557             }
1558             nbytes = (nbytes + 3) &~ 3;
1559             ASSERT(*(u_int *)((caddr_t)ovp + nbytes - RSLOP) == RMAGIC, "chunk's tail overwrite");
1560         }
1561         ovp->ov_rmagic = RMAGIC - 1;
1562 #endif
1563         ASSERT(OV_INDEX(ovp) < NBUCKETS, "chunk's head overwrite");
1564         size = OV_INDEX(ovp);
1565
1566         MALLOC_LOCK;
1567         ovp->ov_next = nextf[size];
1568         nextf[size] = ovp;
1569         MALLOC_UNLOCK;
1570 }
1571
1572 /* There is no need to do any locking in realloc (with an exception of
1573    trying to grow in place if we are at the end of the chain).
1574    If somebody calls us from a different thread with the same address,
1575    we are sole anyway.  */
1576
1577 Malloc_t
1578 Perl_realloc(void *mp, size_t nbytes)
1579 {
1580         register MEM_SIZE onb;
1581         union overhead *ovp;
1582         char *res;
1583         int prev_bucket;
1584         register int bucket;
1585         int incr;               /* 1 if does not fit, -1 if "easily" fits in a
1586                                    smaller bucket, otherwise 0.  */
1587         char *cp = (char*)mp;
1588
1589 #if defined(DEBUGGING) || !defined(PERL_CORE)
1590         MEM_SIZE size = nbytes;
1591
1592         if ((long)nbytes < 0)
1593             croak("%s", "panic: realloc");
1594 #endif
1595
1596         BARK_64K_LIMIT("Reallocation",nbytes,size);
1597         if (!cp)
1598                 return Perl_malloc(nbytes);
1599
1600         ovp = (union overhead *)((caddr_t)cp
1601                                 - sizeof (union overhead) * CHUNK_SHIFT);
1602         bucket = OV_INDEX(ovp);
1603
1604 #ifdef IGNORE_SMALL_BAD_FREE
1605         if ((bucket >= FIRST_BUCKET_WITH_CHECK)
1606             && (OV_MAGIC(ovp, bucket) != MAGIC))
1607 #else
1608         if (OV_MAGIC(ovp, bucket) != MAGIC)
1609 #endif
1610             {
1611                 static int bad_free_warn = -1;
1612                 if (bad_free_warn == -1) {
1613                     dTHX;
1614                     char *pbf = PerlEnv_getenv("PERL_BADFREE");
1615                     bad_free_warn = (pbf) ? atoi(pbf) : 1;
1616                 }
1617                 if (!bad_free_warn)
1618                     return Nullch;
1619 #ifdef RCHECK
1620                 {
1621                     dTHX;
1622 #ifdef PERL_CORE
1623                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
1624                         Perl_warner(aTHX_ WARN_MALLOC, "%srealloc() %signored",
1625                                     (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
1626                                     ovp->ov_rmagic == RMAGIC - 1
1627                                     ? "of freed memory " : "");
1628 #else
1629                     warn("%srealloc() %signored",
1630                         (ovp->ov_rmagic == RMAGIC - 1 ? "" : "Bad "),
1631                          ovp->ov_rmagic == RMAGIC - 1 ? "of freed memory " : "");
1632 #endif
1633 #else
1634 #ifdef PERL_CORE
1635                     if (!PERL_IS_ALIVE || !PL_curcop || ckWARN_d(WARN_MALLOC))
1636                         Perl_warner(aTHX_ WARN_MALLOC, "%s",
1637                                     "Bad realloc() ignored");
1638 #else
1639                     warn("%s", "Bad realloc() ignored");
1640 #endif
1641                 }
1642 #endif
1643                 return Nullch;                  /* sanity */
1644             }
1645
1646         onb = BUCKET_SIZE_REAL(bucket);
1647         /*
1648          *  avoid the copy if same size block.
1649          *  We are not agressive with boundary cases. Note that it might
1650          *  (for a small number of cases) give false negative if
1651          *  both new size and old one are in the bucket for
1652          *  FIRST_BIG_POW2, but the new one is near the lower end.
1653          *
1654          *  We do not try to go to 1.5 times smaller bucket so far.
1655          */
1656         if (nbytes > onb) incr = 1;
1657         else {
1658 #ifdef DO_NOT_TRY_HARDER_WHEN_SHRINKING
1659             if ( /* This is a little bit pessimal if PACK_MALLOC: */
1660                 nbytes > ( (onb >> 1) - M_OVERHEAD )
1661 #  ifdef TWO_POT_OPTIMIZE
1662                 || (bucket == FIRST_BIG_POW2 && nbytes >= LAST_SMALL_BOUND )
1663 #  endif
1664                 )
1665 #else  /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1666                 prev_bucket = ( (bucket > MAX_PACKED + 1)
1667                                 ? bucket - BUCKETS_PER_POW2
1668                                 : bucket - 1);
1669              if (nbytes > BUCKET_SIZE_REAL(prev_bucket))
1670 #endif /* !DO_NOT_TRY_HARDER_WHEN_SHRINKING */
1671                  incr = 0;
1672              else incr = -1;
1673         }
1674 #ifdef STRESS_REALLOC
1675         goto hard_way;
1676 #endif
1677         if (incr == 0) {
1678           inplace_label:
1679 #ifdef RCHECK
1680                 /*
1681                  * Record new allocated size of block and
1682                  * bound space with magic numbers.
1683                  */
1684                 if (OV_INDEX(ovp) <= MAX_SHORT_BUCKET) {
1685                        int i, nb = ovp->ov_size + 1;
1686
1687                        if ((i = nb & 3)) {
1688                            i = 4 - i;
1689                            while (i--) {
1690                                ASSERT(*((char *)((caddr_t)ovp + nb - RSLOP + i)) == RMAGIC_C, "chunk's tail overwrite");
1691                            }
1692                        }
1693                        nb = (nb + 3) &~ 3;
1694                        ASSERT(*(u_int *)((caddr_t)ovp + nb - RSLOP) == RMAGIC, "chunk's tail overwrite");
1695                         /*
1696                          * Convert amount of memory requested into
1697                          * closest block size stored in hash buckets
1698                          * which satisfies request.  Account for
1699                          * space used per block for accounting.
1700                          */
1701                         nbytes += M_OVERHEAD;
1702                         ovp->ov_size = nbytes - 1;
1703                         if ((i = nbytes & 3)) {
1704                             i = 4 - i;
1705                             while (i--)
1706                                 *((char *)((caddr_t)ovp + nbytes - RSLOP + i))
1707                                     = RMAGIC_C;
1708                         }
1709                         nbytes = (nbytes + 3) &~ 3;
1710                         *((u_int *)((caddr_t)ovp + nbytes - RSLOP)) = RMAGIC;
1711                 }
1712 #endif
1713                 res = cp;
1714                 DEBUG_m(PerlIO_printf(Perl_debug_log,
1715                               "0x%"UVxf": (%05lu) realloc %ld bytes inplace\n",
1716                               PTR2UV(res),(unsigned long)(PL_an++),
1717                               (long)size));
1718         } else if (incr == 1 && (cp - M_OVERHEAD == last_op)
1719                    && (onb > (1 << LOG_OF_MIN_ARENA))) {
1720             MEM_SIZE require, newarena = nbytes, pow;
1721             int shiftr;
1722
1723             POW2_OPTIMIZE_ADJUST(newarena);
1724             newarena = newarena + M_OVERHEAD;
1725             /* newarena = (newarena + 3) &~ 3; */
1726             shiftr = (newarena - 1) >> LOG_OF_MIN_ARENA;
1727             pow = LOG_OF_MIN_ARENA + 1;
1728             /* apart from this loop, this is O(1) */
1729             while (shiftr >>= 1)
1730                 pow++;
1731             newarena = (1 << pow) + POW2_OPTIMIZE_SURPLUS(pow * BUCKETS_PER_POW2);
1732             require = newarena - onb - M_OVERHEAD;
1733
1734             MALLOC_LOCK;
1735             if (cp - M_OVERHEAD == last_op /* We *still* are the last chunk */
1736                 && getpages_adjacent(require)) {
1737 #ifdef DEBUGGING_MSTATS
1738                 nmalloc[bucket]--;
1739                 nmalloc[pow * BUCKETS_PER_POW2]++;
1740 #endif
1741                 *(cp - M_OVERHEAD) = pow * BUCKETS_PER_POW2; /* Fill index. */
1742                 MALLOC_UNLOCK;
1743                 goto inplace_label;
1744             } else {
1745                 MALLOC_UNLOCK;
1746                 goto hard_way;
1747             }
1748         } else {
1749           hard_way:
1750             DEBUG_m(PerlIO_printf(Perl_debug_log,
1751                               "0x%"UVxf": (%05lu) realloc %ld bytes the hard way\n",
1752                               PTR2UV(cp),(unsigned long)(PL_an++),
1753                               (long)size));
1754             if ((res = (char*)Perl_malloc(nbytes)) == NULL)
1755                 return (NULL);
1756             if (cp != res)                      /* common optimization */
1757                 Copy(cp, res, (MEM_SIZE)(nbytes<onb?nbytes:onb), char);
1758             Perl_mfree(cp);
1759         }
1760         return ((Malloc_t)res);
1761 }
1762
1763 /*
1764  * Search ``srchlen'' elements of each free list for a block whose
1765  * header starts at ``freep''.  If srchlen is -1 search the whole list.
1766  * Return bucket number, or -1 if not found.
1767  */
1768 static int
1769 findbucket(union overhead *freep, int srchlen)
1770 {
1771         register union overhead *p;
1772         register int i, j;
1773
1774         for (i = 0; i < NBUCKETS; i++) {
1775                 j = 0;
1776                 for (p = nextf[i]; p && j != srchlen; p = p->ov_next) {
1777                         if (p == freep)
1778                                 return (i);
1779                         j++;
1780                 }
1781         }
1782         return (-1);
1783 }
1784
1785 Malloc_t
1786 Perl_calloc(register size_t elements, register size_t size)
1787 {
1788     long sz = elements * size;
1789     Malloc_t p = Perl_malloc(sz);
1790
1791     if (p) {
1792         memset((void*)p, 0, sz);
1793     }
1794     return p;
1795 }
1796
1797 char *
1798 Perl_strdup(const char *s)
1799 {
1800     MEM_SIZE l = strlen(s);
1801     char *s1 = (char *)Perl_malloc(l+1);
1802
1803     Copy(s, s1, (MEM_SIZE)(l+1), char);
1804     return s1;
1805 }
1806
1807 #ifdef PERL_CORE
1808 int
1809 Perl_putenv(char *a)
1810 {
1811     /* Sometimes system's putenv conflicts with my_setenv() - this is system
1812        malloc vs Perl's free(). */
1813   dTHX;
1814   char *var;
1815   char *val = a;
1816   MEM_SIZE l;
1817   char buf[80];
1818
1819   while (*val && *val != '=')
1820       val++;
1821   if (!*val)
1822       return -1;
1823   l = val - a;
1824   if (l < sizeof(buf))
1825       var = buf;
1826   else
1827       var = Perl_malloc(l + 1);
1828   Copy(a, var, l, char);
1829   var[l + 1] = 0;
1830   my_setenv(var, val+1);
1831   if (var != buf)
1832       Perl_mfree(var);
1833   return 0;
1834 }
1835 #  endif
1836
1837 MEM_SIZE
1838 Perl_malloced_size(void *p)
1839 {
1840     union overhead *ovp = (union overhead *)
1841         ((caddr_t)p - sizeof (union overhead) * CHUNK_SHIFT);
1842     int bucket = OV_INDEX(ovp);
1843 #ifdef RCHECK
1844     /* The caller wants to have a complete control over the chunk,
1845        disable the memory checking inside the chunk.  */
1846     if (bucket <= MAX_SHORT_BUCKET) {
1847         MEM_SIZE size = BUCKET_SIZE_REAL(bucket);
1848         ovp->ov_size = size + M_OVERHEAD - 1;
1849         *((u_int *)((caddr_t)ovp + size + M_OVERHEAD - RSLOP)) = RMAGIC;
1850     }
1851 #endif
1852     return BUCKET_SIZE_REAL(bucket);
1853 }
1854
1855 #  ifdef BUCKETS_ROOT2
1856 #    define MIN_EVEN_REPORT 6
1857 #  else
1858 #    define MIN_EVEN_REPORT MIN_BUCKET
1859 #  endif
1860
1861 int
1862 Perl_get_mstats(pTHX_ perl_mstats_t *buf, int buflen, int level)
1863 {
1864 #ifdef DEBUGGING_MSTATS
1865         register int i, j;
1866         register union overhead *p;
1867         struct chunk_chain_s* nextchain;
1868
1869         buf->topbucket = buf->topbucket_ev = buf->topbucket_odd
1870             = buf->totfree = buf->total = buf->total_chain = 0;
1871
1872         buf->minbucket = MIN_BUCKET;
1873         MALLOC_LOCK;
1874         for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
1875                 for (j = 0, p = nextf[i]; p; p = p->ov_next, j++)
1876                         ;
1877                 if (i < buflen) {
1878                     buf->nfree[i] = j;
1879                     buf->ntotal[i] = nmalloc[i];
1880                 }
1881                 buf->totfree += j * BUCKET_SIZE_REAL(i);
1882                 buf->total += nmalloc[i] * BUCKET_SIZE_REAL(i);
1883                 if (nmalloc[i]) {
1884                     i % 2 ? (buf->topbucket_odd = i) : (buf->topbucket_ev = i);
1885                     buf->topbucket = i;
1886                 }
1887         }
1888         nextchain = chunk_chain;
1889         while (nextchain) {
1890             buf->total_chain += nextchain->size;
1891             nextchain = nextchain->next;
1892         }
1893         buf->total_sbrk = goodsbrk + sbrk_slack;
1894         buf->sbrks = sbrks;
1895         buf->sbrk_good = sbrk_good;
1896         buf->sbrk_slack = sbrk_slack;
1897         buf->start_slack = start_slack;
1898         buf->sbrked_remains = sbrked_remains;
1899         MALLOC_UNLOCK;
1900         if (level) {
1901             for (i = MIN_BUCKET ; i < NBUCKETS; i++) {
1902                 if (i >= buflen)
1903                     break;
1904                 buf->bucket_mem_size[i] = BUCKET_SIZE(i);
1905                 buf->bucket_available_size[i] = BUCKET_SIZE_REAL(i);
1906             }
1907         }
1908 #endif  /* defined DEBUGGING_MSTATS */
1909         return 0;               /* XXX unused */
1910 }
1911 /*
1912  * mstats - print out statistics about malloc
1913  *
1914  * Prints two lines of numbers, one showing the length of the free list
1915  * for each size category, the second showing the number of mallocs -
1916  * frees for each size category.
1917  */
1918 void
1919 Perl_dump_mstats(pTHX_ char *s)
1920 {
1921 #ifdef DEBUGGING_MSTATS
1922         register int i, j;
1923         register union overhead *p;
1924         perl_mstats_t buffer;
1925         unsigned long nf[NBUCKETS];
1926         unsigned long nt[NBUCKETS];
1927         struct chunk_chain_s* nextchain;
1928
1929         buffer.nfree  = nf;
1930         buffer.ntotal = nt;
1931         get_mstats(&buffer, NBUCKETS, 0);
1932
1933         if (s)
1934             PerlIO_printf(Perl_error_log,
1935                           "Memory allocation statistics %s (buckets %ld(%ld)..%ld(%ld)\n",
1936                           s,
1937                           (long)BUCKET_SIZE_REAL(MIN_BUCKET),
1938                           (long)BUCKET_SIZE(MIN_BUCKET),
1939                           (long)BUCKET_SIZE_REAL(buffer.topbucket),
1940                           (long)BUCKET_SIZE(buffer.topbucket));
1941         PerlIO_printf(Perl_error_log, "%8d free:", buffer.totfree);
1942         for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
1943                 PerlIO_printf(Perl_error_log,
1944                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1945                                ? " %5d"
1946                                : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1947                               buffer.nfree[i]);
1948         }
1949 #ifdef BUCKETS_ROOT2
1950         PerlIO_printf(Perl_error_log, "\n\t   ");
1951         for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
1952                 PerlIO_printf(Perl_error_log,
1953                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1954                                ? " %5d"
1955                                : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1956                               buffer.nfree[i]);
1957         }
1958 #endif
1959         PerlIO_printf(Perl_error_log, "\n%8d used:", buffer.total - buffer.totfree);
1960         for (i = MIN_EVEN_REPORT; i <= buffer.topbucket; i += BUCKETS_PER_POW2) {
1961                 PerlIO_printf(Perl_error_log,
1962                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1963                                ? " %5d"
1964                                : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1965                               buffer.ntotal[i] - buffer.nfree[i]);
1966         }
1967 #ifdef BUCKETS_ROOT2
1968         PerlIO_printf(Perl_error_log, "\n\t   ");
1969         for (i = MIN_BUCKET + 1; i <= buffer.topbucket_odd; i += BUCKETS_PER_POW2) {
1970                 PerlIO_printf(Perl_error_log,
1971                               ((i < 8*BUCKETS_PER_POW2 || i == 10*BUCKETS_PER_POW2)
1972                                ? " %5d"
1973                                : ((i < 12*BUCKETS_PER_POW2) ? " %3d" : " %d")),
1974                               buffer.ntotal[i] - buffer.nfree[i]);
1975         }
1976 #endif
1977         PerlIO_printf(Perl_error_log, "\nTotal sbrk(): %d/%d:%d. Odd ends: pad+heads+chain+tail: %d+%d+%d+%d.\n",
1978                       buffer.total_sbrk, buffer.sbrks, buffer.sbrk_good,
1979                       buffer.sbrk_slack, buffer.start_slack,
1980                       buffer.total_chain, buffer.sbrked_remains);
1981 #endif /* DEBUGGING_MSTATS */
1982 }
1983 #endif /* lint */
1984
1985 #ifdef USE_PERL_SBRK
1986
1987 #   if defined(__MACHTEN_PPC__) || defined(NeXT) || defined(__NeXT__) || defined(PURIFY)
1988 #      define PERL_SBRK_VIA_MALLOC
1989 /*
1990  * MachTen's malloc() returns a buffer aligned on a two-byte boundary.
1991  * While this is adequate, it may slow down access to longer data
1992  * types by forcing multiple memory accesses.  It also causes
1993  * complaints when RCHECK is in force.  So we allocate six bytes
1994  * more than we need to, and return an address rounded up to an
1995  * eight-byte boundary.
1996  *
1997  * 980701 Dominic Dunlop <domo@computer.org>
1998  */
1999 #      define SYSTEM_ALLOC_ALIGNMENT 2
2000 #   endif
2001
2002 #   ifdef PERL_SBRK_VIA_MALLOC
2003
2004 /* it may seem schizophrenic to use perl's malloc and let it call system */
2005 /* malloc, the reason for that is only the 3.2 version of the OS that had */
2006 /* frequent core dumps within nxzonefreenolock. This sbrk routine put an */
2007 /* end to the cores */
2008
2009 #      ifndef SYSTEM_ALLOC
2010 #         define SYSTEM_ALLOC(a) malloc(a)
2011 #      endif
2012 #      ifndef SYSTEM_ALLOC_ALIGNMENT
2013 #         define SYSTEM_ALLOC_ALIGNMENT MEM_ALIGNBYTES
2014 #      endif
2015
2016 #   endif  /* PERL_SBRK_VIA_MALLOC */
2017
2018 static IV Perl_sbrk_oldchunk;
2019 static long Perl_sbrk_oldsize;
2020
2021 #   define PERLSBRK_32_K (1<<15)
2022 #   define PERLSBRK_64_K (1<<16)
2023
2024 Malloc_t
2025 Perl_sbrk(int size)
2026 {
2027     IV got;
2028     int small, reqsize;
2029
2030     if (!size) return 0;
2031 #ifdef PERL_CORE
2032     reqsize = size; /* just for the DEBUG_m statement */
2033 #endif
2034 #ifdef PACK_MALLOC
2035     size = (size + 0x7ff) & ~0x7ff;
2036 #endif
2037     if (size <= Perl_sbrk_oldsize) {
2038         got = Perl_sbrk_oldchunk;
2039         Perl_sbrk_oldchunk += size;
2040         Perl_sbrk_oldsize -= size;
2041     } else {
2042       if (size >= PERLSBRK_32_K) {
2043         small = 0;
2044       } else {
2045         size = PERLSBRK_64_K;
2046         small = 1;
2047       }
2048 #  if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2049       size += NEEDED_ALIGNMENT - SYSTEM_ALLOC_ALIGNMENT;
2050 #  endif
2051       got = (IV)SYSTEM_ALLOC(size);
2052 #  if NEEDED_ALIGNMENT > SYSTEM_ALLOC_ALIGNMENT
2053       got = (got + NEEDED_ALIGNMENT - 1) & ~(NEEDED_ALIGNMENT - 1);
2054 #  endif
2055       if (small) {
2056         /* Chunk is small, register the rest for future allocs. */
2057         Perl_sbrk_oldchunk = got + reqsize;
2058         Perl_sbrk_oldsize = size - reqsize;
2059       }
2060     }
2061
2062     DEBUG_m(PerlIO_printf(Perl_debug_log, "sbrk malloc size %ld (reqsize %ld), left size %ld, give addr 0x%"UVxf"\n",
2063                     size, reqsize, Perl_sbrk_oldsize, PTR2UV(got)));
2064
2065     return (void *)got;
2066 }
2067
2068 #endif /* ! defined USE_PERL_SBRK */