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 any malloc error, such as double free or out of memory.
36#define SCALABLE_MALLOC_PURGEABLE (1 << 5)
37    // allocate objects such that they may be used with VM purgability APIs
38#define SCALABLE_MALLOC_ABORT_ON_CORRUPTION (1 << 6)
39    // call abort() on malloc errors, but not on out of memory.
40
41extern malloc_zone_t *create_scalable_zone(size_t initial_size, unsigned debug_flags);
42    /* Create a new zone that scales for small objects or large objects */
43
44extern malloc_zone_t *create_purgeable_zone(size_t initial_size, malloc_zone_t *malloc_default_zone, unsigned debug_flags);
45    /* Create a new zone that supports malloc_make{un}purgeable() discipline. */
46
47extern malloc_zone_t *create_legacy_scalable_zone(size_t initial_size, unsigned debug_flags);
48    /*
49     * For use by CheckFix: create a new zone whose behavior is, apart from
50     * the use of death-row and per-CPU magazines, that of Leopard.
51     */
52
53/*****	Private API for debug and performance tools	********/
54
55extern boolean_t scalable_zone_statistics(malloc_zone_t *zone, malloc_statistics_t *stats, unsigned subzone);
56    /* Fills stats with some statistics;
57    1 is returned on success; else 0 is returned
58    Currently: subzone=0 => tiny; subzone=1 => small; subzone=2 => large; subzone=3 => huge; any other subzone => returns 0
59    */
60
61