gen/scalable_malloc.h

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #import <malloc/malloc.h>
  25
  26 #define SCALABLE_MALLOC_ADD_GUARD_PAGES         (1 << 0)
  27     // add a guard page before and after each VM region to help debug
  28 #define SCALABLE_MALLOC_DONT_PROTECT_PRELUDE    (1 << 1)
  29     // do not protect prelude page
  30 #define SCALABLE_MALLOC_DONT_PROTECT_POSTLUDE   (1 << 2)
  31     // do not protect postlude page
  32 #define SCALABLE_MALLOC_DO_SCRIBBLE             (1 << 3)
  33     // write 0x55 onto free blocks
  34 #define SCALABLE_MALLOC_ABORT_ON_ERROR (1 << 4)
  35     // call abort() on a malloc or free error, such as a double free
  36
  37 extern malloc_zone_t *create_scalable_zone(size_t initial_size, unsigned debug_flags);
  38     /* Create a new zone that scales for small objects or large objects */
  39
  40 /*****  Private API for debug and performance tools     ********/
  41
  42 extern boolean_t scalable_zone_statistics(malloc_zone_t *zone, malloc_statistics_t *stats, unsigned subzone);
  43     /* Fills stats with some statistics;
  44     1 is returned on success; else 0 is returned
  45     Currently: subzone=0 => tiny; subzone=1 => small; subzone=2 => large; subzone=3 => huge; any other subzone => returns 0
  46     */
  47