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

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_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/kalloc.c
 *      Author: Avadis Tevanian, Jr.
 *      Date:   1985
 *
 *      General kernel memory allocator.  This allocator is designed
 *      to be used by the kernel to manage dynamic memory fast.
 */

#include <zone_debug.h>

#include <mach/boolean.h>
#include <mach/machine/vm_types.h>
#include <mach/vm_param.h>
#include <kern/misc_protos.h>
#include <kern/zalloc.h>
#include <kern/kalloc.h>
#include <kern/lock.h>
#include <vm/vm_kern.h>
#include <vm/vm_object.h>
#include <vm/vm_map.h>
#include <libkern/OSMalloc.h>

#ifdef MACH_BSD
zone_t kalloc_zone(vm_size_t);
#endif

vm_map_t kalloc_map;
vm_size_t kalloc_map_size = 16 * 1024 * 1024;
vm_size_t kalloc_max;
vm_size_t kalloc_max_prerounded;
vm_size_t kalloc_kernmap_size;  /* size of kallocs that can come from kernel map */

unsigned int kalloc_large_inuse;
vm_size_t    kalloc_large_total;
vm_size_t    kalloc_large_max;
vm_size_t    kalloc_largest_allocated = 0;

/*
 *      All allocations of size less than kalloc_max are rounded to the
 *      next highest power of 2.  This allocator is built on top of
 *      the zone allocator.  A zone is created for each potential size
 *      that we are willing to get in small blocks.
 *
 *      We assume that kalloc_max is not greater than 64K;
 *      thus 16 is a safe array size for k_zone and k_zone_name.
 *
 *      Note that kalloc_max is somewhat confusingly named.
 *      It represents the first power of two for which no zone exists.
 *      kalloc_max_prerounded is the smallest allocation size, before
 *      rounding, for which no zone exists.
 *  Also if the allocation size is more than kalloc_kernmap_size 
 *  then allocate from kernel map rather than kalloc_map.
 */

int first_k_zone = -1;
struct zone *k_zone[16];
static const char *k_zone_name[16] = {
        "kalloc.1",             "kalloc.2",
        "kalloc.4",             "kalloc.8",
        "kalloc.16",            "kalloc.32",
        "kalloc.64",            "kalloc.128",
        "kalloc.256",           "kalloc.512",
        "kalloc.1024",          "kalloc.2048",
        "kalloc.4096",          "kalloc.8192",
        "kalloc.16384",         "kalloc.32768"
};

/*
 *  Max number of elements per zone.  zinit rounds things up correctly
 *  Doing things this way permits each zone to have a different maximum size
 *  based on need, rather than just guessing; it also
 *  means its patchable in case you're wrong!
 */
unsigned long k_zone_max[16] = {
      1024,             /*      1 Byte  */
      1024,             /*      2 Byte  */
      1024,             /*      4 Byte  */
      1024,             /*      8 Byte  */
      1024,             /*     16 Byte  */
      4096,             /*     32 Byte  */
      4096,             /*     64 Byte  */
      4096,             /*    128 Byte  */
      4096,             /*    256 Byte  */
      1024,             /*    512 Byte  */
      1024,             /*   1024 Byte  */
      1024,             /*   2048 Byte  */
      1024,             /*   4096 Byte  */
      4096,             /*   8192 Byte  */
      64,               /*  16384 Byte  */
      64,               /*  32768 Byte  */
};

/* forward declarations */
void * kalloc_canblock(
                vm_size_t       size,
                boolean_t       canblock);


/* OSMalloc local data declarations */
static
queue_head_t    OSMalloc_tag_list;

decl_simple_lock_data(static,OSMalloc_tag_lock)

/* OSMalloc forward declarations */
void OSMalloc_init(void);
void OSMalloc_Tagref(OSMallocTag        tag);
void OSMalloc_Tagrele(OSMallocTag       tag);

/*
 *      Initialize the memory allocator.  This should be called only
 *      once on a system wide basis (i.e. first processor to get here
 *      does the initialization).
 *
 *      This initializes all of the zones.
 */

void
kalloc_init(
        void)
{
        kern_return_t retval;
        vm_offset_t min;
        vm_size_t size;
        register int i;

        retval = kmem_suballoc(kernel_map, &min, kalloc_map_size,
                               FALSE, VM_FLAGS_ANYWHERE, &kalloc_map);

        if (retval != KERN_SUCCESS)
                panic("kalloc_init: kmem_suballoc failed");

        /*
         *      Ensure that zones up to size 8192 bytes exist.
         *      This is desirable because messages are allocated
         *      with kalloc, and messages up through size 8192 are common.
         */

        if (PAGE_SIZE < 16*1024)
                kalloc_max = 16*1024;
        else
                kalloc_max = PAGE_SIZE;
        kalloc_max_prerounded = kalloc_max / 2 + 1;
        /* size it to be more than 16 times kalloc_max (256k) for allocations from kernel map */
        kalloc_kernmap_size = (kalloc_max * 16) + 1;

        /*
         *      Allocate a zone for each size we are going to handle.
         *      We specify non-paged memory.
         */
        for (i = 0, size = 1; size < kalloc_max; i++, size <<= 1) {
                if (size < KALLOC_MINSIZE) {
                        k_zone[i] = 0;
                        continue;
                }
                if (size == KALLOC_MINSIZE) {
                        first_k_zone = i;
                }
                k_zone[i] = zinit(size, k_zone_max[i] * size, size,
                                  k_zone_name[i]);
        }
        OSMalloc_init();
}

void *
kalloc_canblock(
                vm_size_t       size,
                boolean_t       canblock)
{
        register int zindex;
        register vm_size_t allocsize;
        vm_map_t alloc_map = VM_MAP_NULL;

        /*
         * If size is too large for a zone, then use kmem_alloc.
         * (We use kmem_alloc instead of kmem_alloc_wired so that
         * krealloc can use kmem_realloc.)
         */

        if (size >= kalloc_max_prerounded) {
                void *addr;

                /* kmem_alloc could block so we return if noblock */
                if (!canblock) {
                  return(0);
                }

                if (size >=  kalloc_kernmap_size) {
                        alloc_map = kernel_map;

                        if (size > kalloc_largest_allocated)
                                kalloc_largest_allocated = size;
                } else
                        alloc_map = kalloc_map;

                if (kmem_alloc(alloc_map, (vm_offset_t *)&addr, size) != KERN_SUCCESS) 
                        addr = 0;

                if (addr) {
                        kalloc_large_inuse++;
                        kalloc_large_total += size;

                        if (kalloc_large_total > kalloc_large_max)
                                kalloc_large_max = kalloc_large_total;
                }
                return(addr);
        }

        /* compute the size of the block that we will actually allocate */

        allocsize = KALLOC_MINSIZE;
        zindex = first_k_zone;
        while (allocsize < size) {
                allocsize <<= 1;
                zindex++;
        }

        /* allocate from the appropriate zone */
        assert(allocsize < kalloc_max);
        return(zalloc_canblock(k_zone[zindex], canblock));
}

void *
kalloc(
       vm_size_t size)
{
        return( kalloc_canblock(size, TRUE) );
}

void *
kalloc_noblock(
               vm_size_t size)
{
        return( kalloc_canblock(size, FALSE) );
}


void
krealloc(
        void            **addrp,
        vm_size_t       old_size,
        vm_size_t       new_size,
        simple_lock_t   lock)
{
        register int zindex;
        register vm_size_t allocsize;
        void *naddr;
        vm_map_t alloc_map = VM_MAP_NULL;

        /* can only be used for increasing allocation size */

        assert(new_size > old_size);

        /* if old_size is zero, then we are simply allocating */

        if (old_size == 0) {
                simple_unlock(lock);
                naddr = kalloc(new_size);
                simple_lock(lock);
                *addrp = naddr;
                return;
        }

        /* if old block was kmem_alloc'd, then use kmem_realloc if necessary */

        if (old_size >= kalloc_max_prerounded) {
                if (old_size >=  kalloc_kernmap_size) 
                        alloc_map = kernel_map;
                else
                        alloc_map = kalloc_map;

                old_size = round_page(old_size);
                new_size = round_page(new_size);
                if (new_size > old_size) {

                        if (KERN_SUCCESS != kmem_realloc(alloc_map, 
                            (vm_offset_t)*addrp, old_size,
                            (vm_offset_t *)&naddr, new_size)) {
                                panic("krealloc: kmem_realloc");
                                naddr = 0;
                        }

                        simple_lock(lock);
                        *addrp = (void *) naddr;

                        /* kmem_realloc() doesn't free old page range. */
                        kmem_free(alloc_map, (vm_offset_t)*addrp, old_size);

                        kalloc_large_total += (new_size - old_size);

                        if (kalloc_large_total > kalloc_large_max)
                                kalloc_large_max = kalloc_large_total;

                }
                return;
        }

        /* compute the size of the block that we actually allocated */

        allocsize = KALLOC_MINSIZE;
        zindex = first_k_zone;
        while (allocsize < old_size) {
                allocsize <<= 1;
                zindex++;
        }

        /* if new size fits in old block, then return */

        if (new_size <= allocsize) {
                return;
        }

        /* if new size does not fit in zone, kmem_alloc it, else zalloc it */

        simple_unlock(lock);
        if (new_size >= kalloc_max_prerounded) {
                if (new_size >=  kalloc_kernmap_size) 
                        alloc_map = kernel_map;
                else
                        alloc_map = kalloc_map;
                if (KERN_SUCCESS != kmem_alloc(alloc_map, 
                    (vm_offset_t *)&naddr, new_size)) {
                        panic("krealloc: kmem_alloc");
                        simple_lock(lock);
                        *addrp = NULL;
                        return;
                }
                kalloc_large_inuse++;
                kalloc_large_total += new_size;

                if (kalloc_large_total > kalloc_large_max)
                        kalloc_large_max = kalloc_large_total;
        } else {
                register int new_zindex;

                allocsize <<= 1;
                new_zindex = zindex + 1;
                while (allocsize < new_size) {
                        allocsize <<= 1;
                        new_zindex++;
                }
                naddr = zalloc(k_zone[new_zindex]);
        }
        simple_lock(lock);

        /* copy existing data */

        bcopy((const char *)*addrp, (char *)naddr, old_size);

        /* free old block, and return */

        zfree(k_zone[zindex], *addrp);

        /* set up new address */

        *addrp = (void *) naddr;
}


void *
kget(
        vm_size_t       size)
{
        register int zindex;
        register vm_size_t allocsize;

        /* size must not be too large for a zone */

        if (size >= kalloc_max_prerounded) {
                /* This will never work, so we might as well panic */
                panic("kget");
        }

        /* compute the size of the block that we will actually allocate */

        allocsize = KALLOC_MINSIZE;
        zindex = first_k_zone;
        while (allocsize < size) {
                allocsize <<= 1;
                zindex++;
        }

        /* allocate from the appropriate zone */

        assert(allocsize < kalloc_max);
        return(zget(k_zone[zindex]));
}

void
kfree(
        void            *data,
        vm_size_t       size)
{
        register int zindex;
        register vm_size_t freesize;
        vm_map_t alloc_map = VM_MAP_NULL;

        /* if size was too large for a zone, then use kmem_free */

        if (size >= kalloc_max_prerounded) {
                if (size >=  kalloc_kernmap_size) {
                        alloc_map = kernel_map;

                        if (size > kalloc_largest_allocated)
                                /*
                                 * work around double FREEs of small MALLOCs
                                 * this used to end up being a nop
                                 * since the pointer being freed from an
                                 * alloc backed by the zalloc world could
                                 * never show up in the kalloc_map... however,
                                 * the kernel_map is a different issue... since it
                                 * was released back into the zalloc pool, a pointer
                                 * would have gotten written over the 'size' that 
                                 * the MALLOC was retaining in the first 4 bytes of
                                 * the underlying allocation... that pointer ends up 
                                 * looking like a really big size on the 2nd FREE and
                                 * pushes the kfree into the kernel_map...  we
                                 * end up removing a ton of virutal space before we panic
                                 * this check causes us to ignore the kfree for a size
                                 * that must be 'bogus'... note that it might not be due
                                 * to the above scenario, but it would still be wrong and
                                 * cause serious damage.
                                 */
                                return;
                } else
                        alloc_map = kalloc_map;
                kmem_free(alloc_map, (vm_offset_t)data, size);

                kalloc_large_total -= size;
                kalloc_large_inuse--;

                return;
        }

        /* compute the size of the block that we actually allocated from */

        freesize = KALLOC_MINSIZE;
        zindex = first_k_zone;
        while (freesize < size) {
                freesize <<= 1;
                zindex++;
        }

        /* free to the appropriate zone */

        assert(freesize < kalloc_max);
        zfree(k_zone[zindex], data);
}

#ifdef MACH_BSD
zone_t
kalloc_zone(
        vm_size_t       size)
{
        register int zindex = 0;
        register vm_size_t allocsize;

        /* compute the size of the block that we will actually allocate */

        allocsize = size;
        if (size <= kalloc_max) {
                allocsize = KALLOC_MINSIZE;
                zindex = first_k_zone;
                while (allocsize < size) {
                        allocsize <<= 1;
                        zindex++;
                }
                return (k_zone[zindex]);
        }
        return (ZONE_NULL);
}
#endif


void
kalloc_fake_zone_info(int *count, vm_size_t *cur_size, vm_size_t *max_size, vm_size_t *elem_size,
                     vm_size_t *alloc_size, int *collectable, int *exhaustable)
{
        *count      = kalloc_large_inuse;
        *cur_size   = kalloc_large_total;
        *max_size   = kalloc_large_max;
        *elem_size  = kalloc_large_total / kalloc_large_inuse;
        *alloc_size = kalloc_large_total / kalloc_large_inuse;
        *collectable = 0;
        *exhaustable = 0;
}


void
OSMalloc_init(
        void)
{
        queue_init(&OSMalloc_tag_list);
        simple_lock_init(&OSMalloc_tag_lock, 0);
}

OSMallocTag
OSMalloc_Tagalloc(
        const char                      *str,
        uint32_t                        flags)
{
        OSMallocTag       OSMTag;

        OSMTag = (OSMallocTag)kalloc(sizeof(*OSMTag));

        bzero((void *)OSMTag, sizeof(*OSMTag));

        if (flags & OSMT_PAGEABLE)
                OSMTag->OSMT_attr = OSMT_ATTR_PAGEABLE;

        OSMTag->OSMT_refcnt = 1;

        strncpy(OSMTag->OSMT_name, str, OSMT_MAX_NAME);

        simple_lock(&OSMalloc_tag_lock);
        enqueue_tail(&OSMalloc_tag_list, (queue_entry_t)OSMTag);
        simple_unlock(&OSMalloc_tag_lock);
        OSMTag->OSMT_state = OSMT_VALID;
        return(OSMTag);
}

void
OSMalloc_Tagref(
         OSMallocTag            tag)
{
        if (!((tag->OSMT_state & OSMT_VALID_MASK) == OSMT_VALID)) 
                panic("OSMalloc_Tagref(): bad state 0x%08X\n",tag->OSMT_state);

        (void)hw_atomic_add((uint32_t *)(&tag->OSMT_refcnt), 1);
}

void
OSMalloc_Tagrele(
         OSMallocTag            tag)
{
        if (!((tag->OSMT_state & OSMT_VALID_MASK) == OSMT_VALID))
                panic("OSMalloc_Tagref(): bad state 0x%08X\n",tag->OSMT_state);

        if (hw_atomic_sub((uint32_t *)(&tag->OSMT_refcnt), 1) == 0) {
                if (hw_compare_and_store(OSMT_VALID|OSMT_RELEASED, OSMT_VALID|OSMT_RELEASED, &tag->OSMT_state)) {
                        simple_lock(&OSMalloc_tag_lock);
                        (void)remque((queue_entry_t)tag);
                        simple_unlock(&OSMalloc_tag_lock);
                        kfree((void*)tag, sizeof(*tag));
                } else
                        panic("OSMalloc_Tagrele(): refcnt 0\n");
        }
}

void
OSMalloc_Tagfree(
         OSMallocTag            tag)
{
        if (!hw_compare_and_store(OSMT_VALID, OSMT_VALID|OSMT_RELEASED, &tag->OSMT_state))
                panic("OSMalloc_Tagfree(): bad state 0x%08X\n", tag->OSMT_state);

        if (hw_atomic_sub((uint32_t *)(&tag->OSMT_refcnt), 1) == 0) {
                simple_lock(&OSMalloc_tag_lock);
                (void)remque((queue_entry_t)tag);
                simple_unlock(&OSMalloc_tag_lock);
                kfree((void*)tag, sizeof(*tag));
        }
}

void *
OSMalloc(
        uint32_t                        size,
        OSMallocTag                     tag)
{
        void                    *addr=NULL;
        kern_return_t   kr;

        OSMalloc_Tagref(tag);
        if ((tag->OSMT_attr & OSMT_PAGEABLE)
            && (size & ~PAGE_MASK)) {

                if ((kr = kmem_alloc_pageable(kernel_map, (vm_offset_t *)&addr, size)) != KERN_SUCCESS)
                        panic("OSMalloc(): kmem_alloc_pageable() failed 0x%08X\n", kr);
        } else 
                addr = kalloc((vm_size_t)size);

        return(addr);
}

void *
OSMalloc_nowait(
        uint32_t                        size,
        OSMallocTag                     tag)
{
        void    *addr=NULL;

        if (tag->OSMT_attr & OSMT_PAGEABLE)
                return(NULL);

        OSMalloc_Tagref(tag);
        /* XXX: use non-blocking kalloc for now */
        addr = kalloc_noblock((vm_size_t)size);
        if (addr == NULL)
                OSMalloc_Tagrele(tag);

        return(addr);
}

void *
OSMalloc_noblock(
        uint32_t                        size,
        OSMallocTag                     tag)
{
        void    *addr=NULL;

        if (tag->OSMT_attr & OSMT_PAGEABLE)
                return(NULL);

        OSMalloc_Tagref(tag);
        addr = kalloc_noblock((vm_size_t)size);
        if (addr == NULL)
                OSMalloc_Tagrele(tag);

        return(addr);
}

void
OSFree(
        void                            *addr,
        uint32_t                        size,
        OSMallocTag                     tag) 
{
        if ((tag->OSMT_attr & OSMT_PAGEABLE)
            && (size & ~PAGE_MASK)) {
                kmem_free(kernel_map, (vm_offset_t)addr, size);
        } else
                kfree((void*)addr, size);

        OSMalloc_Tagrele(tag);
}