[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);

#define kalloc(size)				\
	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
	kalloc_canblock((size), TRUE, &site); })

#define kalloc_tag(size, tag)			\
	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
		= { (tag), 0 } ; \
	kalloc_canblock((size), TRUE, &site); })

#define kalloc_tag_bt(size, tag)		\
	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
		= { (tag), VM_TAG_BT }; \
	kalloc_canblock((size), TRUE, &site); })

#define kalloc_noblock(size)			\
	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
	kalloc_canblock((size), FALSE, &site); })

#define kalloc_noblock_tag_bt(size, tag)	\
	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
		= { (tag), VM_TAG_BT }; \
	kalloc_canblock((size), FALSE, &site); })

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

#else /* XNU_KERNEL_PRIVATE */

extern void *kalloc(vm_size_t	size);

extern void *kalloc_noblock(vm_size_t	size);

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 */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6601e61a	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
6601e61a	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	36	* Permission to use, copy, modify and distribute this software and its
	37	* documentation is hereby granted, provided that both the copyright
	38	* notice and this permission notice appear in all copies of the
	39	* software, derivative works or modified versions, and any portions
	40	* thereof, and that both notices appear in supporting documentation.
	41	*
	42	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	43	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	44	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
1c79356b	56
91447636 A	57	#ifdef KERNEL_PRIVATE
91447636 A	58
1c79356b A	59	#ifndef _KERN_KALLOC_H_
	60	#define _KERN_KALLOC_H_
	61
1c79356b	62	#include <mach/machine/vm_types.h>
3e170ce0	63	#include <mach/boolean.h>
91447636	64	#include <sys/cdefs.h>
3e170ce0	65	#include <mach/vm_types.h>
1c79356b	66
91447636	67	__BEGIN_DECLS
1c79356b	68
3e170ce0 A	69	#if XNU_KERNEL_PRIVATE
	70
	71	extern void *
	72	kalloc_canblock(
	73	vm_size_t size,
	74	boolean_t canblock,
	75	vm_allocation_site_t * site);
	76
	77	#define kalloc(size) \
	78	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
	79	kalloc_canblock((size), TRUE, &site); })
	80
	81	#define kalloc_tag(size, tag) \
	82	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
	83	= { (tag), 0 } ; \
	84	kalloc_canblock((size), TRUE, &site); })
	85
	86	#define kalloc_tag_bt(size, tag) \
	87	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
	88	= { (tag), VM_TAG_BT }; \
	89	kalloc_canblock((size), TRUE, &site); })
	90
	91	#define kalloc_noblock(size) \
	92	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))); \
	93	kalloc_canblock((size), FALSE, &site); })
	94
	95	#define kalloc_noblock_tag_bt(size, tag) \
	96	({ static vm_allocation_site_t site __attribute__((section("__DATA, __data"))) \
	97	= { (tag), VM_TAG_BT }; \
	98	kalloc_canblock((size), FALSE, &site); })
	99
	100	extern void kfree(void *data,
	101	vm_size_t size);
	102
	103	#else /* XNU_KERNEL_PRIVATE */
	104
91447636	105	extern void *kalloc(vm_size_t size);
1c79356b	106
91447636	107	extern void *kalloc_noblock(vm_size_t size);
1c79356b	108
91447636 A	109	extern void kfree(void *data,
91447636 A	110	vm_size_t size);
9bccf70c	111
3e170ce0 A	112	#endif /* !XNU_KERNEL_PRIVATE */
3e170ce0 A	113
91447636	114	__END_DECLS
9bccf70c	115
91447636	116	#ifdef MACH_KERNEL_PRIVATE
1c79356b	117
39236c6e	118	extern void kalloc_init(void);
1c79356b	119
6d2010ae A	120	extern void kalloc_fake_zone_init( int );
6d2010ae A	121
91447636 A	122	extern void kalloc_fake_zone_info(
	123	int *count,
	124	vm_size_t *cur_size,
	125	vm_size_t *max_size,
	126	vm_size_t *elem_size,
	127	vm_size_t *alloc_size,
6d2010ae	128	uint64_t *sum_size,
91447636	129	int *collectable,
6d2010ae A	130	int *exhaustable,
6d2010ae A	131	int *caller_acct);
1c79356b	132
91447636	133	extern vm_size_t kalloc_max_prerounded;
b0d623f7	134	extern vm_size_t kalloc_large_total;
1c79356b	135
91447636	136	#endif /* MACH_KERNEL_PRIVATE */
9bccf70c	137
1c79356b	138	#endif /* _KERN_KALLOC_H_ */
91447636 A	139
91447636 A	140	#endif /* KERNEL_PRIVATE */