malloc.c

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