xnu-6153.11.26.tar.gz

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

/*
 * Copyright (c) 2000-2005 Apple Computer, 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.
 */

#ifdef  KERNEL_PRIVATE

#ifndef _KERN_KALLOC_H_
#define _KERN_KALLOC_H_

#include <mach/machine/vm_types.h>
#include <mach/boolean.h>
#include <sys/cdefs.h>
#include <mach/vm_types.h>

__BEGIN_DECLS

#if XNU_KERNEL_PRIVATE

extern void *
kalloc_canblock(
	vm_size_t                * size,
	boolean_t              canblock,
	vm_allocation_site_t * site);

extern vm_size_t
kalloc_size(
	void                             * addr);

extern vm_size_t
kfree_addr(
	void                             * addr);

extern vm_size_t
kalloc_bucket_size(
	vm_size_t                          size);

#define kalloc(size)                                \
	({ VM_ALLOC_SITE_STATIC(0, 0);                  \
	vm_size_t tsize = (size);                       \
	kalloc_canblock(&tsize, TRUE, &site); })

#define kalloc_tag(size, itag)                      \
	({ VM_ALLOC_SITE_STATIC(0, (itag));             \
	vm_size_t tsize = (size);                       \
	kalloc_canblock(&tsize, TRUE, &site); })

#define kalloc_tag_bt(size, itag)                   \
	({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
	vm_size_t tsize = (size);                       \
	kalloc_canblock(&tsize, TRUE, &site); })

#define kalloc_noblock(size)                        \
	({ VM_ALLOC_SITE_STATIC(0, 0);                  \
	vm_size_t tsize = (size);                       \
	kalloc_canblock(&tsize, FALSE, &site); })

#define kalloc_noblock_tag(size, itag)              \
	({ VM_ALLOC_SITE_STATIC(0, (itag));             \
	vm_size_t tsize = (size);                       \
	kalloc_canblock(&tsize, FALSE, &site); })

#define kalloc_noblock_tag_bt(size, itag)           \
	({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
	vm_size_t tsize = (size);                       \
	kalloc_canblock(&tsize, FALSE, &site); })


/* these versions update the size reference with the actual size allocated */

#define kallocp(size)                               \
	({ VM_ALLOC_SITE_STATIC(0, 0);                  \
	kalloc_canblock((size), TRUE, &site); })

#define kallocp_tag(size, itag)                     \
	({ VM_ALLOC_SITE_STATIC(0, (itag));             \
	kalloc_canblock((size), TRUE, &site); })

#define kallocp_tag_bt(size, itag)                  \
	({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
	kalloc_canblock((size), TRUE, &site); })

#define kallocp_noblock(size)                       \
	({ VM_ALLOC_SITE_STATIC(0, 0);                  \
	kalloc_canblock((size), FALSE, &site); })

#define kallocp_noblock_tag_bt(size, itag)          \
	({ VM_ALLOC_SITE_STATIC(VM_TAG_BT, (itag));     \
	kalloc_canblock((size), FALSE, &site); })



extern void kfree(void          *data,
    vm_size_t     size);

#define kfree(data, size) \
_Pragma("clang diagnostic push") \
_Pragma("clang diagnostic ignored \"-Wshadow\"") \
	do { \
	        _Static_assert(sizeof (data) == sizeof (void *) || sizeof (data) == sizeof (mach_vm_address_t), "data is not a pointer"); \
	        void *__tmp_addr = (void *) data; \
	        vm_size_t __tmp_size = size; \
	        data = (__typeof__(data)) NULL; \
	        (kfree)(__tmp_addr, __tmp_size); \
	} while (0) \
_Pragma("clang diagnostic pop")

#define kfree_addr(addr) \
_Pragma("clang diagnostic push") \
_Pragma("clang diagnostic ignored \"-Wshadow\"") \
	do { \
	        _Static_assert(sizeof (addr) == sizeof (void *) || sizeof (addr) == sizeof (mach_vm_address_t), "addr is not a pointer"); \
	        void *__tmp_addr = (void *) addr; \
	        addr = (__typeof__(addr)) NULL; \
	        (kfree_addr)(__tmp_addr); \
	} while (0) \
_Pragma("clang diagnostic pop")

#else /* XNU_KERNEL_PRIVATE */

extern void *kalloc(vm_size_t   size) __attribute__((alloc_size(1)));

extern void *kalloc_noblock(vm_size_t   size) __attribute__((alloc_size(1)));

extern void kfree(void          *data,
    vm_size_t     size);

#endif /* !XNU_KERNEL_PRIVATE */

__END_DECLS

#ifdef  MACH_KERNEL_PRIVATE

extern void             kalloc_init(void);

extern void             kalloc_fake_zone_init( int );

extern 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,
	uint64_t        *sum_size,
	int             *collectable,
	int             *exhaustable,
	int             *caller_acct);

extern vm_size_t kalloc_max_prerounded;
extern vm_size_t kalloc_large_total;

#endif  /* MACH_KERNEL_PRIVATE */

#endif  /* _KERN_KALLOC_H_ */

#endif  /* KERNEL_PRIVATE */