[apple/xnu.git] / osfmk / kern / zalloc.c

/*
 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *      File:   kern/zalloc.c
 *      Author: Avadis Tevanian, Jr.
 *
 *      Zone-based memory allocator.  A zone is a collection of fixed size
 *      data blocks for which quick allocation/deallocation is possible.
 */
#include <zone_debug.h>
#include <zone_alias_addr.h>
#include <norma_vm.h>
#include <mach_kdb.h>

#include <mach/mach_types.h>
#include <mach/vm_param.h>
#include <mach/kern_return.h>
#include <mach/mach_host_server.h>
#include <mach/machine/vm_types.h>
#include <mach_debug/zone_info.h>

#include <kern/kern_types.h>
#include <kern/assert.h>
#include <kern/host.h>
#include <kern/macro_help.h>
#include <kern/sched.h>
#include <kern/lock.h>
#include <kern/sched_prim.h>
#include <kern/misc_protos.h>
#include <kern/thread_call.h>
#include <kern/zalloc.h>
#include <kern/kalloc.h>

#include <vm/pmap.h>
#include <vm/vm_map.h>
#include <vm/vm_kern.h>
#include <vm/vm_page.h>

#include <machine/machparam.h>

#include <libkern/OSDebug.h>
#include <sys/kdebug.h>

#if defined(__ppc__)
/* for fake zone stat routines */
#include <ppc/savearea.h>
#include <ppc/mappings.h>
#endif


/* 
 * Zone Corruption Debugging
 *
 * We provide three methods to detect use of a zone element after it's been freed.  These
 * checks are enabled by specifying "-zc" and/or "-zp" in the boot-args:
 *
 * (1) Range-check the free-list "next" ptr for sanity.
 * (2) Store the ptr in two different words, and compare them against
 *     each other when re-using the zone element, to detect modifications.
 * (3) poison the freed memory by overwriting it with 0xdeadbeef.
 *
 * The first two checks are farily light weight and are enabled by specifying "-zc" 
 * in the boot-args.  If you want more aggressive checking for use-after-free bugs
 * and you don't mind the additional overhead, then turn on poisoning by adding
 * "-zp" to the boot-args in addition to "-zc".  If you specify -zp without -zc,
 * it still poisons the memory when it's freed, but doesn't check if the memory
 * has been altered later when it's reallocated.
 */

boolean_t check_freed_element = FALSE;          /* enabled by -zc in boot-args */
boolean_t zfree_clear = FALSE;                  /* enabled by -zp in boot-args */

#define is_kernel_data_addr(a)  (!(a) || ((a) >= vm_min_kernel_address && !((a) & 0x3)))

#define ADD_TO_ZONE(zone, element)                                      \
MACRO_BEGIN                                                             \
        if (zfree_clear)                                                \
        {   unsigned int i;                                             \
            for (i=0;                                                   \
                 i < zone->elem_size/sizeof(uint32_t);                  \
                 i++)                                                   \
            ((uint32_t *)(element))[i] = 0xdeadbeef;                    \
        }                                                               \
        *((vm_offset_t *)(element)) = (zone)->free_elements;            \
        if (check_freed_element) {                                      \
                if ((zone)->elem_size >= (2 * sizeof(vm_offset_t)))     \
                        ((vm_offset_t *)(element))[((zone)->elem_size/sizeof(vm_offset_t))-1] = \
                                (zone)->free_elements;                  \
        }                                                               \
        (zone)->free_elements = (vm_offset_t) (element);                \
        (zone)->count--;                                                \
MACRO_END

#define REMOVE_FROM_ZONE(zone, ret, type)                                       \
MACRO_BEGIN                                                                     \
        (ret) = (type) (zone)->free_elements;                                   \
        if ((ret) != (type) 0) {                                                \
                if (check_freed_element) {                                      \
                        if (!is_kernel_data_addr(((vm_offset_t *)(ret))[0]) ||  \
                            ((zone)->elem_size >= (2 * sizeof(vm_offset_t)) &&  \
                            ((vm_offset_t *)(ret))[((zone)->elem_size/sizeof(vm_offset_t))-1] != \
                            ((vm_offset_t *)(ret))[0]))                         \
                                panic("a freed zone element has been modified");\
                        if (zfree_clear) {                                      \
                                unsigned int ii;                                \
                                for (ii = sizeof(vm_offset_t) / sizeof(uint32_t); \
                                         ii < zone->elem_size/sizeof(uint32_t) - sizeof(vm_offset_t) / sizeof(uint32_t); \
                                         ii++)                                  \
                                        if (((uint32_t *)(ret))[ii] != (uint32_t)0xdeadbeef) \
                                                panic("a freed zone element has been modified");\
                        }                                                       \
                }                                                               \
                (zone)->count++;                                                \
                (zone)->free_elements = *((vm_offset_t *)(ret));                \
        }                                                                       \
MACRO_END

#if     ZONE_DEBUG
#define zone_debug_enabled(z) z->active_zones.next
#define ROUNDUP(x,y)            ((((x)+(y)-1)/(y))*(y))
#define ZONE_DEBUG_OFFSET       ROUNDUP(sizeof(queue_chain_t),16) 
#endif  /* ZONE_DEBUG */

/*
 * Support for garbage collection of unused zone pages:
 */

struct zone_page_table_entry {
        struct zone_page_table_entry    *link;
        short   alloc_count;
        short   collect_count;
};

/* Forwards */
void            zone_page_init(
                                vm_offset_t     addr,
                                vm_size_t       size,
                                int             value);

void            zone_page_alloc(
                                vm_offset_t     addr,
                                vm_size_t       size);

void            zone_page_free_element(
                                struct zone_page_table_entry    **free_pages,
                                vm_offset_t     addr,
                                vm_size_t       size);

void            zone_page_collect(
                                vm_offset_t     addr,
                                vm_size_t       size);

boolean_t       zone_page_collectable(
                                vm_offset_t     addr,
                                vm_size_t       size);

void            zone_page_keep(
                                vm_offset_t     addr,
                                vm_size_t       size);

void            zalloc_async(
                                thread_call_param_t     p0,  
                                thread_call_param_t     p1);


#if     ZONE_DEBUG && MACH_KDB
int             zone_count(
                                zone_t          z,
                                int             tail);
#endif  /* ZONE_DEBUG && MACH_KDB */

vm_map_t        zone_map = VM_MAP_NULL;

zone_t          zone_zone = ZONE_NULL;  /* the zone containing other zones */

/*
 *      The VM system gives us an initial chunk of memory.
 *      It has to be big enough to allocate the zone_zone
 */

vm_offset_t     zdata;
vm_size_t       zdata_size;

#define lock_zone(zone)                                 \
MACRO_BEGIN                                             \
        lck_mtx_lock(&(zone)->lock);                    \
MACRO_END

#define unlock_zone(zone)                               \
MACRO_BEGIN                                             \
        lck_mtx_unlock(&(zone)->lock);                  \
MACRO_END

#define zone_wakeup(zone) thread_wakeup((event_t)(zone))
#define zone_sleep(zone)                                \
        (void) lck_mtx_sleep(&(zone)->lock, 0, (event_t)(zone), THREAD_UNINT);


#define lock_zone_init(zone)                            \
MACRO_BEGIN                                             \
        char _name[32];                                 \
        (void) snprintf(_name, sizeof (_name), "zone.%s", (zone)->zone_name); \
        lck_grp_attr_setdefault(&(zone)->lock_grp_attr);                \
        lck_grp_init(&(zone)->lock_grp, _name, &(zone)->lock_grp_attr); \
        lck_attr_setdefault(&(zone)->lock_attr);                        \
        lck_mtx_init_ext(&(zone)->lock, &(zone)->lock_ext,              \
            &(zone)->lock_grp, &(zone)->lock_attr);                     \
MACRO_END

#define lock_try_zone(zone)     lck_mtx_try_lock(&zone->lock)

kern_return_t           zget_space(
                                vm_offset_t size,
                                vm_offset_t *result);

decl_simple_lock_data(,zget_space_lock)
vm_offset_t     zalloc_next_space;
vm_offset_t     zalloc_end_of_space;
vm_size_t       zalloc_wasted_space;

/*
 *      Garbage collection map information
 */
struct zone_page_table_entry *  zone_page_table;
vm_offset_t                     zone_map_min_address;
vm_offset_t                     zone_map_max_address;
unsigned int                    zone_pages;

/*
 *      Exclude more than one concurrent garbage collection
 */
decl_mutex_data(,               zone_gc_lock)

#if     !ZONE_ALIAS_ADDR
#define from_zone_map(addr, size) \
        ((vm_offset_t)(addr) >= zone_map_min_address && \
         ((vm_offset_t)(addr) + size -1) <  zone_map_max_address)
#else
#define from_zone_map(addr, size) \
        ((vm_offset_t)(zone_virtual_addr((vm_map_address_t)addr)) >= zone_map_min_address && \
         ((vm_offset_t)(zone_virtual_addr((vm_map_address_t)addr)) + size -1) <  zone_map_max_address)
#endif

#define ZONE_PAGE_USED  0
#define ZONE_PAGE_UNUSED -1


/*
 *      Protects first_zone, last_zone, num_zones,
 *      and the next_zone field of zones.
 */
decl_simple_lock_data(, all_zones_lock)
zone_t                  first_zone;
zone_t                  *last_zone;
unsigned int            num_zones;

boolean_t zone_gc_allowed = TRUE;
boolean_t zone_gc_forced = FALSE;
boolean_t panic_include_zprint = FALSE;
unsigned zone_gc_last_tick = 0;
unsigned zone_gc_max_rate = 0;          /* in ticks */

/*
 * Zone leak debugging code
 *
 * When enabled, this code keeps a log to track allocations to a particular zone that have not
 * yet been freed.  Examining this log will reveal the source of a zone leak.  The log is allocated
 * only when logging is enabled, so there is no effect on the system when it's turned off.  Logging is
 * off by default.
 *
 * Enable the logging via the boot-args. Add the parameter "zlog=<zone>" to boot-args where <zone>
 * is the name of the zone you wish to log.  
 *
 * This code only tracks one zone, so you need to identify which one is leaking first.
 * Generally, you'll know you have a leak when you get a "zalloc retry failed 3" panic from the zone
 * garbage collector.  Note that the zone name printed in the panic message is not necessarily the one
 * containing the leak.  So do a zprint from gdb and locate the zone with the bloated size.  This
 * is most likely the problem zone, so set zlog in boot-args to this zone name, reboot and re-run the test.  The
 * next time it panics with this message, examine the log using the kgmacros zstack, findoldest and countpcs.
 * See the help in the kgmacros for usage info.
 *
 *
 * Zone corruption logging
 *
 * Logging can also be used to help identify the source of a zone corruption.  First, identify the zone
 * that is being corrupted, then add "-zc zlog=<zone name>" to the boot-args.  When -zc is used in conjunction
 * with zlog, it changes the logging style to track both allocations and frees to the zone.  So when the
 * corruption is detected, examining the log will show you the stack traces of the callers who last allocated
 * and freed any particular element in the zone.  Use the findelem kgmacro with the address of the element that's been
 * corrupted to examine its history.  This should lead to the source of the corruption.
 */

static int log_records; /* size of the log, expressed in number of records */

#define MAX_ZONE_NAME   32      /* max length of a zone name we can take from the boot-args */

static char zone_name_to_log[MAX_ZONE_NAME] = "";       /* the zone name we're logging, if any */

/*
 * The number of records in the log is configurable via the zrecs parameter in boot-args.  Set this to 
 * the number of records you want in the log.  For example, "zrecs=1000" sets it to 1000 records.  Note
 * that the larger the size of the log, the slower the system will run due to linear searching in the log,
 * but one doesn't generally care about performance when tracking down a leak.  The log is capped at 8000
 * records since going much larger than this tends to make the system unresponsive and unbootable on small
 * memory configurations.  The default value is 4000 records.
 *
 * MAX_DEPTH configures how deep of a stack trace is taken on each zalloc in the zone of interrest.  15
 * levels is usually enough to get past all the layers of code in kalloc and IOKit and see who the actual
 * caller is up above these lower levels.
 */

#define ZRECORDS_MAX            8000            /* Max records allowed in the log */
#define ZRECORDS_DEFAULT        4000            /* default records in log if zrecs is not specificed in boot-args */
#define MAX_DEPTH               15              /* number of levels of the stack trace to record */

/*
 * Each record in the log contains a pointer to the zone element it refers to, a "time" number that allows
 * the records to be ordered chronologically, and a small array to hold the pc's from the stack trace.  A
 * record is added to the log each time a zalloc() is done in the zone_of_interest.  For leak debugging,
 * the record is cleared when a zfree() is done.  For corruption debugging, the log tracks both allocs and frees.
 * If the log fills, old records are replaced as if it were a circular buffer.
 */

struct zrecord {
        void            *z_element;             /* the element that was zalloc'ed of zfree'ed */
        uint32_t        z_opcode:1,             /* whether it was a zalloc or zfree */
                        z_time:31;              /* time index when operation was done */
        void            *z_pc[MAX_DEPTH];       /* stack trace of caller */
};

/*
 * Opcodes for the z_opcode field:
 */

#define ZOP_ALLOC       1
#define ZOP_FREE        0

/*
 * The allocation log and all the related variables are protected by the zone lock for the zone_of_interest
 */

static struct zrecord *zrecords;                /* the log itself, dynamically allocated when logging is enabled  */
static int zcurrent  = 0;                       /* index of the next slot in the log to use */
static int zrecorded = 0;                       /* number of allocations recorded in the log */
static unsigned int ztime = 0;                  /* a timestamp of sorts */
static zone_t  zone_of_interest = NULL;         /* the zone being watched; corresponds to zone_name_to_log */

/*
 * Decide if we want to log this zone by doing a string compare between a zone name and the name
 * of the zone to log. Return true if the strings are equal, false otherwise.  Because it's not
 * possible to include spaces in strings passed in via the boot-args, a period in the logname will
 * match a space in the zone name.
 */

static int
log_this_zone(const char *zonename, const char *logname) 
{
        int len;
        const char *zc = zonename;
        const char *lc = logname;

        /*
         * Compare the strings.  We bound the compare by MAX_ZONE_NAME.
         */

        for (len = 1; len <= MAX_ZONE_NAME; zc++, lc++, len++) {

                /*
                 * If the current characters don't match, check for a space in
                 * in the zone name and a corresponding period in the log name.
                 * If that's not there, then the strings don't match.
                 */

                if (*zc != *lc && !(*zc == ' ' && *lc == '.')) 
                        break;

                /*
                 * The strings are equal so far.  If we're at the end, then it's a match.
                 */

                if (*zc == '\0')
                        return TRUE;
        }

        return FALSE;
}


/*
 * Test if we want to log this zalloc/zfree event.  We log if this is the zone we're interested in and
 * the buffer for the records has been allocated.
 */

#define DO_LOGGING(z)           (zrecords && (z) == zone_of_interest)

extern boolean_t zlog_ready;

        
/*
 *      zinit initializes a new zone.  The zone data structures themselves
 *      are stored in a zone, which is initially a static structure that
 *      is initialized by zone_init.
 */
zone_t
zinit(
        vm_size_t       size,           /* the size of an element */
        vm_size_t       max,            /* maximum memory to use */
        vm_size_t       alloc,          /* allocation size */
        const char      *name)          /* a name for the zone */
{
        zone_t          z;

        if (zone_zone == ZONE_NULL) {
                if (zget_space(sizeof(struct zone), (vm_offset_t *)&z)
                    != KERN_SUCCESS)
                        return(ZONE_NULL);
        } else
                z = (zone_t) zalloc(zone_zone);
        if (z == ZONE_NULL)
                return(ZONE_NULL);

        /*
         *      Round off all the parameters appropriately.
         */
        if (size < sizeof(z->free_elements))
                size = sizeof(z->free_elements);
        size = ((size-1)  + sizeof(z->free_elements)) -
                ((size-1) % sizeof(z->free_elements));
        if (alloc == 0)
                alloc = PAGE_SIZE;
        alloc = round_page(alloc);
        max   = round_page(max);
        /*
         * we look for an allocation size with less than 1% waste
         * up to 5 pages in size...
         * otherwise, we look for an allocation size with least fragmentation
         * in the range of 1 - 5 pages
         * This size will be used unless
         * the user suggestion is larger AND has less fragmentation
         */
#if     ZONE_ALIAS_ADDR
        if ((size < PAGE_SIZE) && (PAGE_SIZE % size <= PAGE_SIZE / 10))
                alloc = PAGE_SIZE;
        else
#endif
        {       vm_size_t best, waste; unsigned int i;
                best  = PAGE_SIZE;
                waste = best % size;

                for (i = 1; i <= 5; i++) {
                        vm_size_t tsize, twaste;

                        tsize = i * PAGE_SIZE;

                        if ((tsize % size) < (tsize / 100)) {
                                alloc = tsize;
                                goto use_this_allocation;
                        }
                        twaste = tsize % size;
                        if (twaste < waste)
                                best = tsize, waste = twaste;
                }
                if (alloc <= best || (alloc % size >= waste))
                        alloc = best;
        }
use_this_allocation:
        if (max && (max < alloc))
                max = alloc;

        z->free_elements = 0;
        z->cur_size = 0;
        z->max_size = max;
        z->elem_size = size;
        z->alloc_size = alloc;
        z->zone_name = name;
        z->count = 0;
        z->doing_alloc = FALSE;
        z->doing_gc = FALSE;
        z->exhaustible = FALSE;
        z->collectable = TRUE;
        z->allows_foreign = FALSE;
        z->expandable  = TRUE;
        z->waiting = FALSE;
        z->async_pending = FALSE;

#if     ZONE_DEBUG
        z->active_zones.next = z->active_zones.prev = NULL;     
        zone_debug_enable(z);
#endif  /* ZONE_DEBUG */
        lock_zone_init(z);

        /*
         *      Add the zone to the all-zones list.
         */

        z->next_zone = ZONE_NULL;
        thread_call_setup(&z->call_async_alloc, zalloc_async, z);
        simple_lock(&all_zones_lock);
        *last_zone = z;
        last_zone = &z->next_zone;
        num_zones++;
        simple_unlock(&all_zones_lock);

        /*
         * Check if we should be logging this zone.  If so, remember the zone pointer.
         */

         if (log_this_zone(z->zone_name, zone_name_to_log)) {
                zone_of_interest = z;
        }

        /*
         * If we want to log a zone, see if we need to allocate buffer space for the log.  Some vm related zones are
         * zinit'ed before we can do a kmem_alloc, so we have to defer allocation in that case.  zlog_ready is set to
         * TRUE once enough of the VM system is up and running to allow a kmem_alloc to work.  If we want to log one
         * of the VM related zones that's set up early on, we will skip allocation of the log until zinit is called again
         * later on some other zone.  So note we may be allocating a buffer to log a zone other than the one being initialized
         * right now.
         */

        if (zone_of_interest != NULL && zrecords == NULL && zlog_ready) {
                if (kmem_alloc(kernel_map, (vm_offset_t *)&zrecords, log_records * sizeof(struct zrecord)) == KERN_SUCCESS) {

                        /*
                         * We got the memory for the log.  Zero it out since the code needs this to identify unused records.
                         * At this point, everything is set up and we're ready to start logging this zone.
                         */
        
                        bzero((void *)zrecords, log_records * sizeof(struct zrecord));
                        printf("zone: logging started for zone %s (%p)\n", zone_of_interest->zone_name, zone_of_interest);

                } else {
                        printf("zone: couldn't allocate memory for zrecords, turning off zleak logging\n");
                        zone_of_interest = NULL;
                }
        }

        return(z);
}

/*
 *      Cram the given memory into the specified zone.
 */
void
zcram(
        register zone_t         zone,
        void                    *newaddr,
        vm_size_t               size)
{
        register vm_size_t      elem_size;
        vm_offset_t             newmem = (vm_offset_t) newaddr;

        /* Basic sanity checks */
        assert(zone != ZONE_NULL && newmem != (vm_offset_t)0);
        assert(!zone->collectable || zone->allows_foreign
                || (from_zone_map(newmem, size)));

        elem_size = zone->elem_size;

        lock_zone(zone);
        while (size >= elem_size) {
                ADD_TO_ZONE(zone, newmem);
                if (from_zone_map(newmem, elem_size))
                        zone_page_alloc(newmem, elem_size);
                zone->count++;  /* compensate for ADD_TO_ZONE */
                size -= elem_size;
                newmem += elem_size;
                zone->cur_size += elem_size;
        }
        unlock_zone(zone);
}

/*
 * Contiguous space allocator for non-paged zones. Allocates "size" amount
 * of memory from zone_map.
 */

kern_return_t
zget_space(
        vm_offset_t size,
        vm_offset_t *result)
{
        vm_offset_t     new_space = 0;
        vm_size_t       space_to_add = 0;

        simple_lock(&zget_space_lock);
        while ((zalloc_next_space + size) > zalloc_end_of_space) {
                /*
                 *      Add at least one page to allocation area.
                 */

                space_to_add = round_page(size);

                if (new_space == 0) {
                        kern_return_t retval;
                        /*
                         *      Memory cannot be wired down while holding
                         *      any locks that the pageout daemon might
                         *      need to free up pages.  [Making the zget_space
                         *      lock a complex lock does not help in this
                         *      regard.]
                         *
                         *      Unlock and allocate memory.  Because several
                         *      threads might try to do this at once, don't
                         *      use the memory before checking for available
                         *      space again.
                         */

                        simple_unlock(&zget_space_lock);

                        retval = kernel_memory_allocate(zone_map, &new_space,
                                space_to_add, 0, KMA_KOBJECT|KMA_NOPAGEWAIT);
                        if (retval != KERN_SUCCESS)
                                return(retval);
#if     ZONE_ALIAS_ADDR
                        if (space_to_add == PAGE_SIZE)
                                new_space = zone_alias_addr(new_space);
#endif
                        zone_page_init(new_space, space_to_add,
                                                        ZONE_PAGE_USED);
                        simple_lock(&zget_space_lock);
                        continue;
                }

                
                /*
                 *      Memory was allocated in a previous iteration.
                 *
                 *      Check whether the new region is contiguous
                 *      with the old one.
                 */

                if (new_space != zalloc_end_of_space) {
                        /*
                         *      Throw away the remainder of the
                         *      old space, and start a new one.
                         */
                        zalloc_wasted_space +=
                                zalloc_end_of_space - zalloc_next_space;
                        zalloc_next_space = new_space;
                }

                zalloc_end_of_space = new_space + space_to_add;

                new_space = 0;
        }
        *result = zalloc_next_space;
        zalloc_next_space += size;              
        simple_unlock(&zget_space_lock);

        if (new_space != 0)
                kmem_free(zone_map, new_space, space_to_add);

        return(KERN_SUCCESS);
}


/*
 *      Steal memory for the zone package.  Called from
 *      vm_page_bootstrap().
 */
void
zone_steal_memory(void)
{
        zdata_size = round_page(128*sizeof(struct zone));
        zdata = (vm_offset_t)((char *)pmap_steal_memory(zdata_size) - (char *)0);
}


/*
 * Fill a zone with enough memory to contain at least nelem elements.
 * Memory is obtained with kmem_alloc_wired from the kernel_map.
 * Return the number of elements actually put into the zone, which may
 * be more than the caller asked for since the memory allocation is
 * rounded up to a full page.
 */
int
zfill(
        zone_t  zone,
        int     nelem)
{
        kern_return_t   kr;
        vm_size_t       size;
        vm_offset_t     memory;
        int             nalloc;

        assert(nelem > 0);
        if (nelem <= 0)
                return 0;
        size = nelem * zone->elem_size;
        size = round_page(size);
        kr = kmem_alloc_wired(kernel_map, &memory, size);
        if (kr != KERN_SUCCESS)
                return 0;

        zone_change(zone, Z_FOREIGN, TRUE);
        zcram(zone, (void *)memory, size);
        nalloc = size / zone->elem_size;
        assert(nalloc >= nelem);

        return nalloc;
}

/*
 *      Initialize the "zone of zones" which uses fixed memory allocated
 *      earlier in memory initialization.  zone_bootstrap is called
 *      before zone_init.
 */
void
zone_bootstrap(void)
{
        vm_size_t zone_zone_size;
        vm_offset_t zone_zone_space;
        char temp_buf[16];

        /* see if we want freed zone element checking and/or poisoning */
        if (PE_parse_boot_argn("-zc", temp_buf, sizeof (temp_buf))) {
                check_freed_element = TRUE;
        }

        if (PE_parse_boot_argn("-zp", temp_buf, sizeof (temp_buf))) {
                zfree_clear = TRUE;
        }

        /*
         * Check for and set up zone leak detection if requested via boot-args.  We recognized two
         * boot-args:
         *
         *      zlog=<zone_to_log>
         *      zrecs=<num_records_in_log>
         *
         * The zlog arg is used to specify the zone name that should be logged, and zrecs is used to
         * control the size of the log.  If zrecs is not specified, a default value is used.
         */

        if (PE_parse_boot_argn("zlog", zone_name_to_log, sizeof(zone_name_to_log)) == TRUE) {
                if (PE_parse_boot_argn("zrecs", &log_records, sizeof(log_records)) == TRUE) {

                        /*
                         * Don't allow more than ZRECORDS_MAX records even if the user asked for more.
                         * This prevents accidentally hogging too much kernel memory and making the system
                         * unusable.
                         */

                        log_records = MIN(ZRECORDS_MAX, log_records);

                } else {
                        log_records = ZRECORDS_DEFAULT;
                }
        }

        simple_lock_init(&all_zones_lock, 0);

        first_zone = ZONE_NULL;
        last_zone = &first_zone;
        num_zones = 0;

        simple_lock_init(&zget_space_lock, 0);
        zalloc_next_space = zdata;
        zalloc_end_of_space = zdata + zdata_size;
        zalloc_wasted_space = 0;

        /* assertion: nobody else called zinit before us */
        assert(zone_zone == ZONE_NULL);
        zone_zone = zinit(sizeof(struct zone), 128 * sizeof(struct zone),
                          sizeof(struct zone), "zones");
        zone_change(zone_zone, Z_COLLECT, FALSE);
        zone_zone_size = zalloc_end_of_space - zalloc_next_space;
        zget_space(zone_zone_size, &zone_zone_space);
        zcram(zone_zone, (void *)zone_zone_space, zone_zone_size);
}

void
zone_init(
        vm_size_t max_zonemap_size)
{
        kern_return_t   retval;
        vm_offset_t     zone_min;
        vm_offset_t     zone_max;
        vm_size_t       zone_table_size;

        retval = kmem_suballoc(kernel_map, &zone_min, max_zonemap_size,
                                                FALSE, VM_FLAGS_ANYWHERE, &zone_map);

        if (retval != KERN_SUCCESS)
                panic("zone_init: kmem_suballoc failed");
        zone_max = zone_min + round_page(max_zonemap_size);
        /*
         * Setup garbage collection information:
         */
        zone_table_size = atop_32(zone_max - zone_min) * 
                                sizeof(struct zone_page_table_entry);
        if (kmem_alloc_wired(zone_map, (vm_offset_t *) &zone_page_table,
                             zone_table_size) != KERN_SUCCESS)
                panic("zone_init");
        zone_min = (vm_offset_t)zone_page_table + round_page(zone_table_size);
        zone_pages = atop_32(zone_max - zone_min);
        zone_map_min_address = zone_min;
        zone_map_max_address = zone_max;
        mutex_init(&zone_gc_lock, 0);
        zone_page_init(zone_min, zone_max - zone_min, ZONE_PAGE_UNUSED);
}


/*
 *      zalloc returns an element from the specified zone.
 */
void *
zalloc_canblock(
        register zone_t zone,
        boolean_t canblock)
{
        vm_offset_t     addr;
        kern_return_t retval;
        void            *bt[MAX_DEPTH];         /* only used if zone logging is enabled */
        int             numsaved = 0;
        int             i;

        assert(zone != ZONE_NULL);

        /*
         * If zone logging is turned on and this is the zone we're tracking, grab a backtrace.
         */

        if (DO_LOGGING(zone))
                numsaved = OSBacktrace(&bt[0], MAX_DEPTH);

        lock_zone(zone);

        REMOVE_FROM_ZONE(zone, addr, vm_offset_t);

        while ((addr == 0) && canblock && (zone->doing_gc)) {
                zone->waiting = TRUE;
                zone_sleep(zone);
                REMOVE_FROM_ZONE(zone, addr, vm_offset_t);
        }

        while ((addr == 0) && canblock) {
                /*
                 *      If nothing was there, try to get more
                 */
                if (zone->doing_alloc) {
                        /*
                         *      Someone is allocating memory for this zone.
                         *      Wait for it to show up, then try again.
                         */
                        zone->waiting = TRUE;
                        zone_sleep(zone);
                }
                else {
                        if ((zone->cur_size + zone->elem_size) >
                            zone->max_size) {
                                if (zone->exhaustible)
                                        break;
                                if (zone->expandable) {
                                        /*
                                         * We're willing to overflow certain
                                         * zones, but not without complaining.
                                         *
                                         * This is best used in conjunction
                                         * with the collectable flag. What we
                                         * want is an assurance we can get the
                                         * memory back, assuming there's no
                                         * leak. 
                                         */
                                        zone->max_size += (zone->max_size >> 1);
                                } else {
                                        unlock_zone(zone);

                                        panic("zalloc: zone \"%s\" empty.", zone->zone_name);
                                }
                        }
                        zone->doing_alloc = TRUE;
                        unlock_zone(zone);

                        if (zone->collectable) {
                                vm_offset_t space;
                                vm_size_t alloc_size;
                                int retry = 0;

                                for (;;) {

                                        if (vm_pool_low() || retry >= 1)
                                                alloc_size = 
                                                  round_page(zone->elem_size);
                                        else
                                                alloc_size = zone->alloc_size;

                                        retval = kernel_memory_allocate(zone_map,
                                                                        &space, alloc_size, 0,
                                                                        KMA_KOBJECT|KMA_NOPAGEWAIT);
                                        if (retval == KERN_SUCCESS) {
#if     ZONE_ALIAS_ADDR
                                                if (alloc_size == PAGE_SIZE)
                                                        space = zone_alias_addr(space);
#endif
                                                zone_page_init(space, alloc_size,
                                                               ZONE_PAGE_USED);
                                                zcram(zone, (void *)space, alloc_size);

                                                break;
                                        } else if (retval != KERN_RESOURCE_SHORTAGE) {
                                                retry++;

                                                if (retry == 2) {
                                                        zone_gc();
                                                        printf("zalloc did gc\n");
                                                }
                                                if (retry == 3) {
                                                        panic_include_zprint = TRUE;
                                                        panic("zalloc: \"%s\" (%d elements) retry fail %d", zone->zone_name, zone->count, retval);
                                                }
                                        } else {
                                                break;
                                        }
                                }
                                lock_zone(zone);
                                zone->doing_alloc = FALSE; 
                                if (zone->waiting) {
                                        zone->waiting = FALSE;
                                        zone_wakeup(zone);
                                }
                                REMOVE_FROM_ZONE(zone, addr, vm_offset_t);
                                if (addr == 0 &&
                                        retval == KERN_RESOURCE_SHORTAGE) {
                                        unlock_zone(zone);
                                        
                                        VM_PAGE_WAIT();
                                        lock_zone(zone);
                                }
                        } else {
                                vm_offset_t space;
                                retval = zget_space(zone->elem_size, &space);

                                lock_zone(zone);
                                zone->doing_alloc = FALSE; 
                                if (zone->waiting) {
                                        zone->waiting = FALSE;
                                        thread_wakeup((event_t)zone);
                                }
                                if (retval == KERN_SUCCESS) {
                                        zone->count++;
                                        zone->cur_size += zone->elem_size;
#if     ZONE_DEBUG
                                        if (zone_debug_enabled(zone)) {
                                            enqueue_tail(&zone->active_zones, (queue_entry_t)space);
                                        }
#endif
                                        unlock_zone(zone);
                                        zone_page_alloc(space, zone->elem_size);
#if     ZONE_DEBUG
                                        if (zone_debug_enabled(zone))
                                                space += ZONE_DEBUG_OFFSET;
#endif
                                        addr = space;
                                        goto success;
                                }
                                if (retval == KERN_RESOURCE_SHORTAGE) {
                                        unlock_zone(zone);
                                        
                                        VM_PAGE_WAIT();
                                        lock_zone(zone);
                                } else {
                                        panic("zalloc: \"%s\" (%d elements) zget_space returned %d", zone->zone_name, zone->count, retval);
                                }
                        }
                }
                if (addr == 0)
                        REMOVE_FROM_ZONE(zone, addr, vm_offset_t);
        }

        /*
         * See if we should be logging allocations in this zone.  Logging is rarely done except when a leak is
         * suspected, so this code rarely executes.  We need to do this code while still holding the zone lock
         * since it protects the various log related data structures.
         */

        if (DO_LOGGING(zone) && addr) {

                /*
                 * Look for a place to record this new allocation.  We implement two different logging strategies
                 * depending on whether we're looking for the source of a zone leak or a zone corruption.  When looking
                 * for a leak, we want to log as many allocations as possible in order to clearly identify the leaker
                 * among all the records.  So we look for an unused slot in the log and fill that in before overwriting
                 * an old entry.  When looking for a corrution however, it's better to have a chronological log of all
                 * the allocations and frees done in the zone so that the history of operations for a specific zone 
                 * element can be inspected.  So in this case, we treat the log as a circular buffer and overwrite the
                 * oldest entry whenever a new one needs to be added.
                 *
                 * The check_freed_element flag tells us what style of logging to do.  It's set if we're supposed to be
                 * doing corruption style logging (indicated via -zc in the boot-args).
                 */

                if (!check_freed_element && zrecords[zcurrent].z_element && zrecorded < log_records) {

                        /*
                         * If we get here, we're doing leak style logging and there's still some unused entries in
                         * the log (since zrecorded is smaller than the size of the log).  Look for an unused slot
                         * starting at zcurrent and wrap-around if we reach the end of the buffer.  If the buffer
                         * is already full, we just fall through and overwrite the element indexed by zcurrent.
                         */
        
                       for (i = zcurrent; i < log_records; i++) {
                                if (zrecords[i].z_element == NULL) {
                                        zcurrent = i;
                                        goto empty_slot;
                                }
                        }

                        for (i = 0; i < zcurrent; i++) {
                                if (zrecords[i].z_element == NULL) {
                                        zcurrent = i;
                                        goto empty_slot;
                                }
                        }
                 }
        
                /*
                 * Save a record of this allocation
                 */
        
empty_slot:
                  if (zrecords[zcurrent].z_element == NULL)
                        zrecorded++;
        
                  zrecords[zcurrent].z_element = (void *)addr;
                  zrecords[zcurrent].z_time = ztime++;
                  zrecords[zcurrent].z_opcode = ZOP_ALLOC;
                        
                  for (i = 0; i < numsaved; i++)
                        zrecords[zcurrent].z_pc[i] = bt[i];

                  for (; i < MAX_DEPTH; i++)
                        zrecords[zcurrent].z_pc[i] = 0;
        
                  zcurrent++;
        
                  if (zcurrent >= log_records)
                          zcurrent = 0;
        }

        if ((addr == 0) && !canblock && (zone->async_pending == FALSE) && (zone->exhaustible == FALSE) && (!vm_pool_low())) {
                zone->async_pending = TRUE;
                unlock_zone(zone);
                thread_call_enter(&zone->call_async_alloc);
                lock_zone(zone);
                REMOVE_FROM_ZONE(zone, addr, vm_offset_t);
        }

#if     ZONE_DEBUG
        if (addr && zone_debug_enabled(zone)) {
                enqueue_tail(&zone->active_zones, (queue_entry_t)addr);
                addr += ZONE_DEBUG_OFFSET;
        }
#endif

        unlock_zone(zone);

success:
        TRACE_MACHLEAKS(ZALLOC_CODE, ZALLOC_CODE_2, zone->elem_size, addr);

        return((void *)addr);
}


void *
zalloc(
       register zone_t zone)
{
  return( zalloc_canblock(zone, TRUE) );
}

void *
zalloc_noblock(
               register zone_t zone)
{
  return( zalloc_canblock(zone, FALSE) );
}

void
zalloc_async(
        thread_call_param_t          p0,
        __unused thread_call_param_t p1)
{
        void *elt;

        elt = zalloc_canblock((zone_t)p0, TRUE);
        zfree((zone_t)p0, elt);
        lock_zone(((zone_t)p0));
        ((zone_t)p0)->async_pending = FALSE;
        unlock_zone(((zone_t)p0));
}


/*
 *      zget returns an element from the specified zone
 *      and immediately returns nothing if there is nothing there.
 *
 *      This form should be used when you can not block (like when
 *      processing an interrupt).
 */
void *
zget(
        register zone_t zone)
{
        register vm_offset_t    addr;

        assert( zone != ZONE_NULL );

        if (!lock_try_zone(zone))
                return NULL;

        REMOVE_FROM_ZONE(zone, addr, vm_offset_t);
#if     ZONE_DEBUG
        if (addr && zone_debug_enabled(zone)) {
                enqueue_tail(&zone->active_zones, (queue_entry_t)addr);
                addr += ZONE_DEBUG_OFFSET;
        }
#endif  /* ZONE_DEBUG */
        unlock_zone(zone);

        return((void *) addr);
}

/* Keep this FALSE by default.  Large memory machine run orders of magnitude
   slower in debug mode when true.  Use debugger to enable if needed */
/* static */ boolean_t zone_check = FALSE;

static zone_t zone_last_bogus_zone = ZONE_NULL;
static vm_offset_t zone_last_bogus_elem = 0;

void
zfree(
        register zone_t zone,
        void            *addr)
{
        vm_offset_t     elem = (vm_offset_t) addr;
        void            *bt[MAX_DEPTH];                 /* only used if zone logging is enable via boot-args */
        int             numsaved = 0;

        assert(zone != ZONE_NULL);

        /*
         * If zone logging is turned on and this is the zone we're tracking, grab a backtrace.
         */

        if (DO_LOGGING(zone))
                numsaved = OSBacktrace(&bt[0], MAX_DEPTH);

#if MACH_ASSERT
        /* Basic sanity checks */
        if (zone == ZONE_NULL || elem == (vm_offset_t)0)
                panic("zfree: NULL");
        /* zone_gc assumes zones are never freed */
        if (zone == zone_zone)
                panic("zfree: freeing to zone_zone breaks zone_gc!");
#endif

        TRACE_MACHLEAKS(ZFREE_CODE, ZFREE_CODE_2, zone->elem_size, (int)addr);

        if (zone->collectable && !zone->allows_foreign &&
            !from_zone_map(elem, zone->elem_size)) {
#if MACH_ASSERT
                panic("zfree: non-allocated memory in collectable zone!");
#endif
                zone_last_bogus_zone = zone;
                zone_last_bogus_elem = elem;
                return;
        }

        lock_zone(zone);

        /*
         * See if we're doing logging on this zone.  There are two styles of logging used depending on
         * whether we're trying to catch a leak or corruption.  See comments above in zalloc for details.
         */

        if (DO_LOGGING(zone)) {
                int  i;

                if (check_freed_element) {

                        /*
                         * We're logging to catch a corruption.  Add a record of this zfree operation
                         * to log.
                         */

                        if (zrecords[zcurrent].z_element == NULL)
                                zrecorded++;

                        zrecords[zcurrent].z_element = (void *)addr;
                        zrecords[zcurrent].z_time = ztime++;
                        zrecords[zcurrent].z_opcode = ZOP_FREE;

                        for (i = 0; i < numsaved; i++)
                                zrecords[zcurrent].z_pc[i] = bt[i];

                        for (; i < MAX_DEPTH; i++)
                                zrecords[zcurrent].z_pc[i] = 0;

                        zcurrent++;

                        if (zcurrent >= log_records)
                                zcurrent = 0;

                } else {

                        /*
                         * We're logging to catch a leak. Remove any record we might have for this
                         * element since it's being freed.  Note that we may not find it if the buffer
                         * overflowed and that's OK.  Since the log is of a limited size, old records
                         * get overwritten if there are more zallocs than zfrees.
                         */
        
                        for (i = 0; i < log_records; i++) {
                                if (zrecords[i].z_element == addr) {
                                        zrecords[i].z_element = NULL;
                                        zcurrent = i;
                                        zrecorded--;
                                        break;
                                }
                        }
                }
        }


#if     ZONE_DEBUG
        if (zone_debug_enabled(zone)) {
                queue_t tmp_elem;

                elem -= ZONE_DEBUG_OFFSET;
                if (zone_check) {
                        /* check the zone's consistency */

                        for (tmp_elem = queue_first(&zone->active_zones);
                             !queue_end(tmp_elem, &zone->active_zones);
                             tmp_elem = queue_next(tmp_elem))
                                if (elem == (vm_offset_t)tmp_elem)
                                        break;
                        if (elem != (vm_offset_t)tmp_elem)
                                panic("zfree()ing element from wrong zone");
                }
                remqueue(&zone->active_zones, (queue_t) elem);
        }
#endif  /* ZONE_DEBUG */
        if (zone_check) {
                vm_offset_t this;

                /* check the zone's consistency */

                for (this = zone->free_elements;
                     this != 0;
                     this = * (vm_offset_t *) this)
                        if (!pmap_kernel_va(this) || this == elem)
                                panic("zfree");
        }
        ADD_TO_ZONE(zone, elem);

        /*
         * If elements have one or more pages, and memory is low,
         * request to run the garbage collection in the zone  the next 
         * time the pageout thread runs.
         */
        if (zone->elem_size >= PAGE_SIZE && 
            vm_pool_low()){
                zone_gc_forced = TRUE;
        }
        unlock_zone(zone);
}


/*      Change a zone's flags.
 *      This routine must be called immediately after zinit.
 */
void
zone_change(
        zone_t          zone,
        unsigned int    item,
        boolean_t       value)
{
        assert( zone != ZONE_NULL );
        assert( value == TRUE || value == FALSE );

        switch(item){
                case Z_EXHAUST:
                        zone->exhaustible = value;
                        break;
                case Z_COLLECT:
                        zone->collectable = value;
                        break;
                case Z_EXPAND:
                        zone->expandable = value;
                        break;
                case Z_FOREIGN:
                        zone->allows_foreign = value;
                        break;
#if MACH_ASSERT
                default:
                        panic("Zone_change: Wrong Item Type!");
                        /* break; */
#endif
        }
}

/*
 * Return the expected number of free elements in the zone.
 * This calculation will be incorrect if items are zfree'd that
 * were never zalloc'd/zget'd. The correct way to stuff memory
 * into a zone is by zcram.
 */

integer_t
zone_free_count(zone_t zone)
{
        integer_t free_count;

        lock_zone(zone);
        free_count = zone->cur_size/zone->elem_size - zone->count;
        unlock_zone(zone);

        assert(free_count >= 0);

        return(free_count);
}

/*
 *      zprealloc preallocates wired memory, exanding the specified
 *      zone to the specified size
 */
void
zprealloc(
        zone_t  zone,
        vm_size_t size)
{
        vm_offset_t addr;

        if (size != 0) {
                if (kmem_alloc_wired(zone_map, &addr, size) != KERN_SUCCESS)
                  panic("zprealloc");
                zone_page_init(addr, size, ZONE_PAGE_USED);
                zcram(zone, (void *)addr, size);
        }
}

/*
 *  Zone garbage collection subroutines
 */

boolean_t
zone_page_collectable(
        vm_offset_t     addr,
        vm_size_t       size)
{
        struct zone_page_table_entry    *zp;
        natural_t i, j;

#if     ZONE_ALIAS_ADDR
        addr = zone_virtual_addr(addr);
#endif
#if MACH_ASSERT
        if (!from_zone_map(addr, size))
                panic("zone_page_collectable");
#endif

        i = atop_32(addr-zone_map_min_address);
        j = atop_32((addr+size-1) - zone_map_min_address);

        for (zp = zone_page_table + i; i <= j; zp++, i++)
                if (zp->collect_count == zp->alloc_count)
                        return (TRUE);

        return (FALSE);
}

void
zone_page_keep(
        vm_offset_t     addr,
        vm_size_t       size)
{
        struct zone_page_table_entry    *zp;
        natural_t i, j;

#if     ZONE_ALIAS_ADDR
        addr = zone_virtual_addr(addr);
#endif
#if MACH_ASSERT
        if (!from_zone_map(addr, size))
                panic("zone_page_keep");
#endif

        i = atop_32(addr-zone_map_min_address);
        j = atop_32((addr+size-1) - zone_map_min_address);

        for (zp = zone_page_table + i; i <= j; zp++, i++)
                zp->collect_count = 0;
}

void
zone_page_collect(
        vm_offset_t     addr,
        vm_size_t       size)
{
        struct zone_page_table_entry    *zp;
        natural_t i, j;

#if     ZONE_ALIAS_ADDR
        addr = zone_virtual_addr(addr);
#endif
#if MACH_ASSERT
        if (!from_zone_map(addr, size))
                panic("zone_page_collect");
#endif

        i = atop_32(addr-zone_map_min_address);
        j = atop_32((addr+size-1) - zone_map_min_address);

        for (zp = zone_page_table + i; i <= j; zp++, i++)
                ++zp->collect_count;
}

void
zone_page_init(
        vm_offset_t     addr,
        vm_size_t       size,
        int             value)
{
        struct zone_page_table_entry    *zp;
        natural_t i, j;

#if     ZONE_ALIAS_ADDR
        addr = zone_virtual_addr(addr);
#endif
#if MACH_ASSERT
        if (!from_zone_map(addr, size))
                panic("zone_page_init");
#endif

        i = atop_32(addr-zone_map_min_address);
        j = atop_32((addr+size-1) - zone_map_min_address);

        for (zp = zone_page_table + i; i <= j; zp++, i++) {
                zp->alloc_count = value;
                zp->collect_count = 0;
        }
}

void
zone_page_alloc(
        vm_offset_t     addr,
        vm_size_t       size)
{
        struct zone_page_table_entry    *zp;
        natural_t i, j;

#if     ZONE_ALIAS_ADDR
        addr = zone_virtual_addr(addr);
#endif
#if MACH_ASSERT
        if (!from_zone_map(addr, size))
                panic("zone_page_alloc");
#endif

        i = atop_32(addr-zone_map_min_address);
        j = atop_32((addr+size-1) - zone_map_min_address);

        for (zp = zone_page_table + i; i <= j; zp++, i++) {
                /*
                 * Set alloc_count to (ZONE_PAGE_USED + 1) if
                 * it was previously set to ZONE_PAGE_UNUSED.
                 */
                if (zp->alloc_count == ZONE_PAGE_UNUSED)
                        zp->alloc_count = 1;
                else
                        ++zp->alloc_count;
        }
}

void
zone_page_free_element(
        struct zone_page_table_entry    **free_pages,
        vm_offset_t     addr,
        vm_size_t       size)
{
        struct zone_page_table_entry    *zp;
        natural_t i, j;

#if     ZONE_ALIAS_ADDR
        addr = zone_virtual_addr(addr);
#endif
#if MACH_ASSERT
        if (!from_zone_map(addr, size))
                panic("zone_page_free_element");
#endif

        i = atop_32(addr-zone_map_min_address);
        j = atop_32((addr+size-1) - zone_map_min_address);

        for (zp = zone_page_table + i; i <= j; zp++, i++) {
                if (zp->collect_count > 0)
                        --zp->collect_count;
                if (--zp->alloc_count == 0) {
                        zp->alloc_count  = ZONE_PAGE_UNUSED;
                        zp->collect_count = 0;

                        zp->link = *free_pages;
                        *free_pages = zp;
                }
        }
}


/* This is used for walking through a zone's free element list.
 */
struct zone_free_element {
        struct zone_free_element * next;
};

/*
 * Add a linked list of pages starting at base back into the zone
 * free list. Tail points to the last element on the list.
 */

#define ADD_LIST_TO_ZONE(zone, base, tail)                              \
MACRO_BEGIN                                                             \
        (tail)->next = (void *)((zone)->free_elements);                 \
        if (check_freed_element) {                                      \
                if ((zone)->elem_size >= (2 * sizeof(vm_offset_t)))     \
                        ((vm_offset_t *)(tail))[((zone)->elem_size/sizeof(vm_offset_t))-1] = \
                                        (zone)->free_elements;          \
        }                                                               \
        (zone)->free_elements = (unsigned long)(base);                  \
MACRO_END

/*
 * Add an element to the chain pointed to by prev.
 */

#define ADD_ELEMENT(zone, prev, elem)                                           \
MACRO_BEGIN                                                             \
        (prev)->next = (elem);                                          \
        if (check_freed_element) {                                      \
                if ((zone)->elem_size >= (2 * sizeof(vm_offset_t)))     \
                        ((vm_offset_t *)(prev))[((zone)->elem_size/sizeof(vm_offset_t))-1] = \
                                        (vm_offset_t)(elem);            \
        }                                                               \
MACRO_END

struct {
        uint32_t        pgs_freed;

        uint32_t        elems_collected,
                                elems_freed,
                                elems_kept;
} zgc_stats;

/*      Zone garbage collection
 *
 *      zone_gc will walk through all the free elements in all the
 *      zones that are marked collectable looking for reclaimable
 *      pages.  zone_gc is called by consider_zone_gc when the system
 *      begins to run out of memory.
 */
void
zone_gc(void)
{
        unsigned int    max_zones;
        zone_t                  z;
        unsigned int    i;
        struct zone_page_table_entry    *zp, *zone_free_pages;

        mutex_lock(&zone_gc_lock);

        simple_lock(&all_zones_lock);
        max_zones = num_zones;
        z = first_zone;
        simple_unlock(&all_zones_lock);

#if MACH_ASSERT
        for (i = 0; i < zone_pages; i++)
                assert(zone_page_table[i].collect_count == 0);
#endif /* MACH_ASSERT */

        zone_free_pages = NULL;

        for (i = 0; i < max_zones; i++, z = z->next_zone) {
                unsigned int                            n, m;
                vm_size_t                                       elt_size, size_freed;
                struct zone_free_element        *elt, *base_elt, *base_prev, *prev, *scan, *keep, *tail;

                assert(z != ZONE_NULL);

                if (!z->collectable)
                        continue;

                lock_zone(z);

                elt_size = z->elem_size;

                /*
                 * Do a quick feasability check before we scan the zone: 
                 * skip unless there is likelihood of getting pages back
                 * (i.e we need a whole allocation block's worth of free
                 * elements before we can garbage collect) and
                 * the zone has more than 10 percent of it's elements free
                 * or the element size is a multiple of the PAGE_SIZE 
                 */
                if ((elt_size & PAGE_MASK) && 
                     (((z->cur_size - z->count * elt_size) <= (2 * z->alloc_size)) ||
                      ((z->cur_size - z->count * elt_size) <= (z->cur_size / 10)))) {
                        unlock_zone(z);         
                        continue;
                }

                z->doing_gc = TRUE;

                /*
                 * Snatch all of the free elements away from the zone.
                 */

                scan = (void *)z->free_elements;
                z->free_elements = 0;

                unlock_zone(z);

                /*
                 * Pass 1:
                 *
                 * Determine which elements we can attempt to collect
                 * and count them up in the page table.  Foreign elements
                 * are returned to the zone.
                 */

                prev = (void *)&scan;
                elt = scan;
                n = 0; tail = keep = NULL;
                while (elt != NULL) {
                        if (from_zone_map(elt, elt_size)) {
                                zone_page_collect((vm_offset_t)elt, elt_size);

                                prev = elt;
                                elt = elt->next;

                                ++zgc_stats.elems_collected;
                        }
                        else {
                                if (keep == NULL)
                                        keep = tail = elt;
                                else {
                                        ADD_ELEMENT(z, tail, elt);
                                        tail = elt;
                                }

                                ADD_ELEMENT(z, prev, elt->next);
                                elt = elt->next;
                                ADD_ELEMENT(z, tail, NULL);
                        }

                        /*
                         * Dribble back the elements we are keeping.
                         */

                        if (++n >= 50) {
                                if (z->waiting == TRUE) {
                                        lock_zone(z);

                                        if (keep != NULL) {
                                                ADD_LIST_TO_ZONE(z, keep, tail);
                                                tail = keep = NULL;
                                        } else {
                                                m =0;
                                                base_elt = elt;
                                                base_prev = prev;
                                                while ((elt != NULL) && (++m < 50)) { 
                                                        prev = elt;
                                                        elt = elt->next;
                                                }
                                                if (m !=0 ) {
                                                        ADD_LIST_TO_ZONE(z, base_elt, prev);
                                                        ADD_ELEMENT(z, base_prev, elt);
                                                        prev = base_prev;
                                                }
                                        }

                                        if (z->waiting) {
                                                z->waiting = FALSE;
                                                zone_wakeup(z);
                                        }

                                        unlock_zone(z);
                                }
                                n =0;
                        }
                }

                /*
                 * Return any remaining elements.
                 */

                if (keep != NULL) {
                        lock_zone(z);

                        ADD_LIST_TO_ZONE(z, keep, tail);

                        unlock_zone(z);
                }

                /*
                 * Pass 2:
                 *
                 * Determine which pages we can reclaim and
                 * free those elements.
                 */

                size_freed = 0;
                elt = scan;
                n = 0; tail = keep = NULL;
                while (elt != NULL) {
                        if (zone_page_collectable((vm_offset_t)elt, elt_size)) {
                                size_freed += elt_size;
                                zone_page_free_element(&zone_free_pages,
                                                                                (vm_offset_t)elt, elt_size);

                                elt = elt->next;

                                ++zgc_stats.elems_freed;
                        }
                        else {
                                zone_page_keep((vm_offset_t)elt, elt_size);

                                if (keep == NULL)
                                        keep = tail = elt;
                                else {
                                        ADD_ELEMENT(z, tail, elt);
                                        tail = elt;
                                }

                                elt = elt->next;
                                ADD_ELEMENT(z, tail, NULL);

                                ++zgc_stats.elems_kept;
                        }

                        /*
                         * Dribble back the elements we are keeping,
                         * and update the zone size info.
                         */

                        if (++n >= 50) {
                                lock_zone(z);

                                z->cur_size -= size_freed;
                                size_freed = 0;

                                if (keep != NULL) {
                                        ADD_LIST_TO_ZONE(z, keep, tail);
                                }

                                if (z->waiting) {
                                        z->waiting = FALSE;
                                        zone_wakeup(z);
                                }

                                unlock_zone(z);

                                n = 0; tail = keep = NULL;
                        }
                }

                /*
                 * Return any remaining elements, and update
                 * the zone size info.
                 */

                lock_zone(z);

                if (size_freed > 0 || keep != NULL) {

                        z->cur_size -= size_freed;

                        if (keep != NULL) {
                                ADD_LIST_TO_ZONE(z, keep, tail);
                        }

                }

                z->doing_gc = FALSE;
                if (z->waiting) {
                        z->waiting = FALSE;
                        zone_wakeup(z);
                }
                unlock_zone(z);
        }

        /*
         * Reclaim the pages we are freeing.
         */

        while ((zp = zone_free_pages) != NULL) {
                zone_free_pages = zp->link;
#if     ZONE_ALIAS_ADDR
                z = zone_virtual_addr((vm_map_address_t)z);
#endif
                kmem_free(zone_map, zone_map_min_address + PAGE_SIZE *
                                                                                (zp - zone_page_table), PAGE_SIZE);
                ++zgc_stats.pgs_freed;
        }

        mutex_unlock(&zone_gc_lock);
}

/*
 *      consider_zone_gc:
 *
 *      Called by the pageout daemon when the system needs more free pages.
 */

void
consider_zone_gc(void)
{
        /*
         *      By default, don't attempt zone GC more frequently
         *      than once / 1 minutes.
         */

        if (zone_gc_max_rate == 0)
                zone_gc_max_rate = (60 << SCHED_TICK_SHIFT) + 1;

        if (zone_gc_allowed &&
            ((sched_tick > (zone_gc_last_tick + zone_gc_max_rate)) ||
             zone_gc_forced)) {
                zone_gc_forced = FALSE;
                zone_gc_last_tick = sched_tick;
                zone_gc();
        }
}

struct fake_zone_info {
        const char* name;
        void (*func)(int *, vm_size_t *, vm_size_t *, vm_size_t *, vm_size_t *,
                    int *, int *);
};

static struct fake_zone_info fake_zones[] = {
        {
                .name = "kernel_stacks",
                .func = stack_fake_zone_info,
        },
#ifdef ppc
        {
                .name = "save_areas",
                .func = save_fake_zone_info,
        },
        {
                .name = "pmap_mappings",
                .func = mapping_fake_zone_info,
        },
#endif /* ppc */
#ifdef i386
        {
                .name = "page_tables",
                .func = pt_fake_zone_info,
        },
#endif /* i386 */
        {
                .name = "kalloc.large",
                .func = kalloc_fake_zone_info,
        },
};

kern_return_t
host_zone_info(
        host_t                  host,
        zone_name_array_t       *namesp,
        mach_msg_type_number_t  *namesCntp,
        zone_info_array_t       *infop,
        mach_msg_type_number_t  *infoCntp)
{
        zone_name_t     *names;
        vm_offset_t     names_addr;
        vm_size_t       names_size;
        zone_info_t     *info;
        vm_offset_t     info_addr;
        vm_size_t       info_size;
        unsigned int    max_zones, i;
        zone_t          z;
        zone_name_t    *zn;
        zone_info_t    *zi;
        kern_return_t   kr;
        size_t          num_fake_zones;

        if (host == HOST_NULL)
                return KERN_INVALID_HOST;

        num_fake_zones = sizeof fake_zones / sizeof fake_zones[0];

        /*
         *      We assume that zones aren't freed once allocated.
         *      We won't pick up any zones that are allocated later.
         */

        simple_lock(&all_zones_lock);
        max_zones = num_zones + num_fake_zones;
        z = first_zone;
        simple_unlock(&all_zones_lock);

        if (max_zones <= *namesCntp) {
                /* use in-line memory */
                names_size = *namesCntp * sizeof *names;
                names = *namesp;
        } else {
                names_size = round_page(max_zones * sizeof *names);
                kr = kmem_alloc_pageable(ipc_kernel_map,
                                         &names_addr, names_size);
                if (kr != KERN_SUCCESS)
                        return kr;
                names = (zone_name_t *) names_addr;
        }

        if (max_zones <= *infoCntp) {
                /* use in-line memory */
                info_size = *infoCntp * sizeof *info;
                info = *infop;
        } else {
                info_size = round_page(max_zones * sizeof *info);
                kr = kmem_alloc_pageable(ipc_kernel_map,
                                         &info_addr, info_size);
                if (kr != KERN_SUCCESS) {
                        if (names != *namesp)
                                kmem_free(ipc_kernel_map,
                                          names_addr, names_size);
                        return kr;
                }

                info = (zone_info_t *) info_addr;
        }
        zn = &names[0];
        zi = &info[0];

        for (i = 0; i < num_zones; i++) {
                struct zone zcopy;

                assert(z != ZONE_NULL);

                lock_zone(z);
                zcopy = *z;
                unlock_zone(z);

                simple_lock(&all_zones_lock);
                z = z->next_zone;
                simple_unlock(&all_zones_lock);

                /* assuming here the name data is static */
                (void) strncpy(zn->zn_name, zcopy.zone_name,
                               sizeof zn->zn_name);
                zn->zn_name[sizeof zn->zn_name - 1] = '\0';

                zi->zi_count = zcopy.count;
                zi->zi_cur_size = zcopy.cur_size;
                zi->zi_max_size = zcopy.max_size;
                zi->zi_elem_size = zcopy.elem_size;
                zi->zi_alloc_size = zcopy.alloc_size;
                zi->zi_exhaustible = zcopy.exhaustible;
                zi->zi_collectable = zcopy.collectable;

                zn++;
                zi++;
        }

        /*
         * loop through the fake zones and fill them using the specialized
         * functions
         */
        for (i = 0; i < num_fake_zones; i++) {
                strncpy(zn->zn_name, fake_zones[i].name, sizeof zn->zn_name);
                zn->zn_name[sizeof zn->zn_name - 1] = '\0';
                fake_zones[i].func(&zi->zi_count, &zi->zi_cur_size,
                                   &zi->zi_max_size, &zi->zi_elem_size,
                                   &zi->zi_alloc_size, &zi->zi_collectable,
                                   &zi->zi_exhaustible);
                zn++;
                zi++;
        }

        if (names != *namesp) {
                vm_size_t used;
                vm_map_copy_t copy;

                used = max_zones * sizeof *names;

                if (used != names_size)
                        bzero((char *) (names_addr + used), names_size - used);

                kr = vm_map_copyin(ipc_kernel_map, (vm_map_address_t)names_addr,
                                   (vm_map_size_t)names_size, TRUE, &copy);
                assert(kr == KERN_SUCCESS);

                *namesp = (zone_name_t *) copy;
        }
        *namesCntp = max_zones;

        if (info != *infop) {
                vm_size_t used;
                vm_map_copy_t copy;

                used = max_zones * sizeof *info;

                if (used != info_size)
                        bzero((char *) (info_addr + used), info_size - used);

                kr = vm_map_copyin(ipc_kernel_map, (vm_map_address_t)info_addr,
                                   (vm_map_size_t)info_size, TRUE, &copy);
                assert(kr == KERN_SUCCESS);

                *infop = (zone_info_t *) copy;
        }
        *infoCntp = max_zones;

        return KERN_SUCCESS;
}

#if     MACH_KDB
#include <ddb/db_command.h>
#include <ddb/db_output.h>
#include <kern/kern_print.h>

const char *zone_labels =
"ENTRY       COUNT   TOT_SZ   MAX_SZ ELT_SZ ALLOC_SZ NAME";

/* Forwards */
void    db_print_zone(
                zone_t          addr);

#if     ZONE_DEBUG
void    db_zone_check_active(
                zone_t          zone);
void    db_zone_print_active(
                zone_t          zone);
#endif  /* ZONE_DEBUG */
void    db_zone_print_free(
                zone_t          zone);
void
db_print_zone(
        zone_t          addr)
{
        struct zone zcopy;

        zcopy = *addr;

        db_printf("%8x %8x %8x %8x %6x %8x %s ",
                  addr, zcopy.count, zcopy.cur_size,
                  zcopy.max_size, zcopy.elem_size,
                  zcopy.alloc_size, zcopy.zone_name);
        if (zcopy.exhaustible)
                db_printf("H");
        if (zcopy.collectable)
                db_printf("C");
        if (zcopy.expandable)
                db_printf("X");
        db_printf("\n");
}

/*ARGSUSED*/
void
db_show_one_zone(db_expr_t addr, boolean_t have_addr,
                 __unused db_expr_t count, __unused char *modif)
{
        struct zone *z = (zone_t)((char *)0 + addr);

        if (z == ZONE_NULL || !have_addr){
                db_error("No Zone\n");
                /*NOTREACHED*/
        }

        db_printf("%s\n", zone_labels);
        db_print_zone(z);
}

/*ARGSUSED*/
void
db_show_all_zones(__unused db_expr_t addr, boolean_t have_addr, db_expr_t count,
                  __unused char *modif)
{
        zone_t          z;
        unsigned total = 0;

        /*
         * Don't risk hanging by unconditionally locking,
         * risk of incoherent data is small (zones aren't freed).
         */
        have_addr = simple_lock_try(&all_zones_lock);
        count = num_zones;
        z = first_zone;
        if (have_addr) {
                simple_unlock(&all_zones_lock);
        }

        db_printf("%s\n", zone_labels);
        for (  ; count > 0; count--) {
                if (!z) {
                        db_error("Mangled Zone List\n");
                        /*NOTREACHED*/
                }
                db_print_zone(z);
                total += z->cur_size,

                have_addr = simple_lock_try(&all_zones_lock);
                z = z->next_zone;
                if (have_addr) {
                        simple_unlock(&all_zones_lock);
                }
        }
        db_printf("\nTotal              %8x", total);
        db_printf("\n\nzone_gc() has reclaimed %d pages\n", zgc_stats.pgs_freed);
}

#if     ZONE_DEBUG
void
db_zone_check_active(
        zone_t  zone)
{
        int count = 0;
        queue_t tmp_elem;

        if (!zone_debug_enabled(zone) || !zone_check)
                return;
        tmp_elem = queue_first(&zone->active_zones);
        while (count < zone->count) {
                count++;
                if (tmp_elem == 0) {
                        printf("unexpected zero element, zone=%p, count=%d\n",
                                zone, count);
                        assert(FALSE);
                        break;
                }
                if (queue_end(tmp_elem, &zone->active_zones)) {
                        printf("unexpected queue_end, zone=%p, count=%d\n",
                                zone, count);
                        assert(FALSE);
                        break;
                }
                tmp_elem = queue_next(tmp_elem);
        }
        if (!queue_end(tmp_elem, &zone->active_zones)) {
                printf("not at queue_end, zone=%p, tmp_elem=%p\n",
                        zone, tmp_elem);
                assert(FALSE);
        }
}

void
db_zone_print_active(
        zone_t  zone)
{
        int count = 0;
        queue_t tmp_elem;

        if (!zone_debug_enabled(zone)) {
                printf("zone %p debug not enabled\n", zone);
                return;
        }
        if (!zone_check) {
                printf("zone_check FALSE\n");
                return;
        }

        printf("zone %p, active elements %d\n", zone, zone->count);
        printf("active list:\n");
        tmp_elem = queue_first(&zone->active_zones);
        while (count < zone->count) {
                printf("  %p", tmp_elem);
                count++;
                if ((count % 6) == 0)
                        printf("\n");
                if (tmp_elem == 0) {
                        printf("\nunexpected zero element, count=%d\n", count);
                        break;
                }
                if (queue_end(tmp_elem, &zone->active_zones)) {
                        printf("\nunexpected queue_end, count=%d\n", count);
                        break;
                }
                tmp_elem = queue_next(tmp_elem);
        }
        if (!queue_end(tmp_elem, &zone->active_zones))
                printf("\nnot at queue_end, tmp_elem=%p\n", tmp_elem);
        else
                printf("\n");
}
#endif  /* ZONE_DEBUG */

void
db_zone_print_free(
        zone_t  zone)
{
        int count = 0;
        int freecount;
        vm_offset_t elem;

        freecount = zone_free_count(zone);
        printf("zone %p, free elements %d\n", zone, freecount);
        printf("free list:\n");
        elem = zone->free_elements;
        while (count < freecount) {
                printf("  0x%x", elem);
                count++;
                if ((count % 6) == 0)
                        printf("\n");
                if (elem == 0) {
                        printf("\nunexpected zero element, count=%d\n", count);
                        break;
                }
                elem = *((vm_offset_t *)elem);
        }
        if (elem != 0)
                printf("\nnot at end of free list, elem=0x%x\n", elem);
        else
                printf("\n");
}

#endif /* MACH_KDB */


#if     ZONE_DEBUG

/* should we care about locks here ? */

#if     MACH_KDB
void *
next_element(
        zone_t          z,
        void            *prev)
{
        char            *elt = (char *)prev;

        if (!zone_debug_enabled(z))
                return(NULL);
        elt -= ZONE_DEBUG_OFFSET;
        elt = (char *) queue_next((queue_t) elt);
        if ((queue_t) elt == &z->active_zones)
                return(NULL);
        elt += ZONE_DEBUG_OFFSET;
        return(elt);
}

void *
first_element(
        zone_t          z)
{
        char            *elt;

        if (!zone_debug_enabled(z))
                return(NULL);
        if (queue_empty(&z->active_zones))
                return(NULL);
        elt = (char *)queue_first(&z->active_zones);
        elt += ZONE_DEBUG_OFFSET;
        return(elt);
}

/*
 * Second arg controls how many zone elements are printed:
 *   0 => none
 *   n, n < 0 => all
 *   n, n > 0 => last n on active list
 */
int
zone_count(
        zone_t          z,
        int             tail)
{
        void            *elt;
        int             count = 0;
        boolean_t       print = (tail != 0);

        if (tail < 0)
                tail = z->count;
        if (z->count < tail)
                tail = 0;
        tail = z->count - tail;
        for (elt = first_element(z); elt; elt = next_element(z, elt)) {
                if (print && tail <= count)
                        db_printf("%8x\n", elt);
                count++;
        }
        assert(count == z->count);
        return(count);
}
#endif /* MACH_KDB */

#define zone_in_use(z)  ( z->count || z->free_elements )

void
zone_debug_enable(
        zone_t          z)
{
        if (zone_debug_enabled(z) || zone_in_use(z) ||
            z->alloc_size < (z->elem_size + ZONE_DEBUG_OFFSET))
                return;
        queue_init(&z->active_zones);
        z->elem_size += ZONE_DEBUG_OFFSET;
}

void
zone_debug_disable(
        zone_t          z)
{
        if (!zone_debug_enabled(z) || zone_in_use(z))
                return;
        z->elem_size -= ZONE_DEBUG_OFFSET;
        z->active_zones.next = z->active_zones.prev = NULL;
}
#endif  /* ZONE_DEBUG */