[apple/xnu.git] / osfmk / vm / vm_kern.h

/*
 * Copyright (c) 2000-2006 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.
 */
/*
 */
/*
 *	File:	vm/vm_kern.h
 *	Author:	Avadis Tevanian, Jr., Michael Wayne Young
 *	Date:	1985
 *
 *	Kernel memory management definitions.
 */

#ifndef	_VM_VM_KERN_H_
#define _VM_VM_KERN_H_

#include <mach/mach_types.h>
#include <mach/boolean.h>
#include <mach/kern_return.h>

#ifdef	KERNEL_PRIVATE

extern kern_return_t	kernel_memory_allocate(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size,
				vm_offset_t	mask,
				int		flags);

/* flags for kernel_memory_allocate */
#define KMA_HERE	0x01
#define KMA_NOPAGEWAIT	0x02
#define KMA_KOBJECT	0x04
#define KMA_LOMEM	0x08
#define KMA_GUARD_FIRST	0x10
#define KMA_GUARD_LAST	0x20
#define KMA_PERMANENT	0x40
#define KMA_NOENCRYPT	0x80

extern kern_return_t kmem_alloc_contig(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size,
				vm_offset_t 	mask,
				ppnum_t		max_pnum,
				ppnum_t		pnum_mask,
				int 		flags);

extern kern_return_t	kmem_alloc(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size);

extern kern_return_t	kmem_alloc_pageable(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size);

extern kern_return_t	kmem_alloc_aligned(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size);

extern kern_return_t	kmem_realloc(
				vm_map_t	map,
				vm_offset_t	oldaddr,
				vm_size_t	oldsize,
				vm_offset_t	*newaddrp,
				vm_size_t	newsize);

extern void		kmem_free(
				vm_map_t	map,
				vm_offset_t	addr,
				vm_size_t	size);

extern kern_return_t	kmem_suballoc(
				vm_map_t	parent,
				vm_offset_t	*addr,
				vm_size_t	size,
				boolean_t	pageable,
				int		flags,
				vm_map_t	*new_map);


extern kern_return_t	kmem_alloc_kobject(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size);

#ifdef	MACH_KERNEL_PRIVATE

extern void		kmem_init(
					vm_offset_t	start,
					vm_offset_t	end) __attribute__((section("__TEXT, initcode")));


extern kern_return_t	copyinmap(
				vm_map_t	map,
				vm_map_offset_t	fromaddr,
				void		*todata,
				vm_size_t	length);

extern kern_return_t	copyoutmap(
				vm_map_t	map,
				void		*fromdata,
				vm_map_offset_t	toaddr,
				vm_size_t	length);

extern kern_return_t	vm_conflict_check(
				vm_map_t		map,
				vm_map_offset_t		off,
				vm_map_size_t		len,
				memory_object_t		pager,
				vm_object_offset_t	file_off);

#endif	/* MACH_KERNEL_PRIVATE */

extern vm_map_t	kernel_map;
extern vm_map_t	kernel_pageable_map;
extern vm_map_t ipc_kernel_map;

#endif	/* KERNEL_PRIVATE */

#endif	/* _VM_VM_KERN_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	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.
8f6c56a5	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	*/
	56	/*
	57	*/
	58	/*
	59	* File: vm/vm_kern.h
	60	* Author: Avadis Tevanian, Jr., Michael Wayne Young
	61	* Date: 1985
	62	*
	63	* Kernel memory management definitions.
	64	*/
	65
	66	#ifndef _VM_VM_KERN_H_
	67	#define _VM_VM_KERN_H_
	68
91447636	69	#include <mach/mach_types.h>
1c79356b A	70	#include <mach/boolean.h>
1c79356b A	71	#include <mach/kern_return.h>
1c79356b	72
91447636	73	#ifdef KERNEL_PRIVATE
1c79356b A	74
	75	extern kern_return_t kernel_memory_allocate(
	76	vm_map_t map,
	77	vm_offset_t *addrp,
	78	vm_size_t size,
	79	vm_offset_t mask,
	80	int flags);
	81
	82	/* flags for kernel_memory_allocate */
	83	#define KMA_HERE 0x01
	84	#define KMA_NOPAGEWAIT 0x02
	85	#define KMA_KOBJECT 0x04
0c530ab8	86	#define KMA_LOMEM 0x08
2d21ac55 A	87	#define KMA_GUARD_FIRST 0x10
2d21ac55 A	88	#define KMA_GUARD_LAST 0x20
b0d623f7	89	#define KMA_PERMANENT 0x40
0b4c1975	90	#define KMA_NOENCRYPT 0x80
1c79356b A	91
	92	extern kern_return_t kmem_alloc_contig(
	93	vm_map_t map,
	94	vm_offset_t *addrp,
	95	vm_size_t size,
	96	vm_offset_t mask,
2d21ac55	97	ppnum_t max_pnum,
b0d623f7	98	ppnum_t pnum_mask,
1c79356b A	99	int flags);
	100
	101	extern kern_return_t kmem_alloc(
	102	vm_map_t map,
	103	vm_offset_t *addrp,
	104	vm_size_t size);
	105
	106	extern kern_return_t kmem_alloc_pageable(
	107	vm_map_t map,
	108	vm_offset_t *addrp,
	109	vm_size_t size);
	110
1c79356b A	111	extern kern_return_t kmem_alloc_aligned(
	112	vm_map_t map,
	113	vm_offset_t *addrp,
	114	vm_size_t size);
	115
	116	extern kern_return_t kmem_realloc(
	117	vm_map_t map,
	118	vm_offset_t oldaddr,
	119	vm_size_t oldsize,
	120	vm_offset_t *newaddrp,
	121	vm_size_t newsize);
	122
	123	extern void kmem_free(
	124	vm_map_t map,
	125	vm_offset_t addr,
	126	vm_size_t size);
	127
	128	extern kern_return_t kmem_suballoc(
	129	vm_map_t parent,
	130	vm_offset_t *addr,
	131	vm_size_t size,
	132	boolean_t pageable,
b0d623f7	133	int flags,
1c79356b A	134	vm_map_t *new_map);
1c79356b A	135
2d21ac55	136
b0d623f7	137	extern kern_return_t kmem_alloc_kobject(
2d21ac55 A	138	vm_map_t map,
	139	vm_offset_t *addrp,
	140	vm_size_t size);
2d21ac55 A	141
	142	#ifdef MACH_KERNEL_PRIVATE
	143
	144	extern void kmem_init(
	145	vm_offset_t start,
	146	vm_offset_t end) __attribute__((section("__TEXT, initcode")));
	147
	148
91447636	149	extern kern_return_t copyinmap(
1c79356b	150	vm_map_t map,
91447636 A	151	vm_map_offset_t fromaddr,
91447636 A	152	void *todata,
1c79356b A	153	vm_size_t length);
1c79356b A	154
91447636	155	extern kern_return_t copyoutmap(
1c79356b	156	vm_map_t map,
91447636 A	157	void *fromdata,
91447636 A	158	vm_map_offset_t toaddr,
1c79356b A	159	vm_size_t length);
1c79356b A	160
9bccf70c A	161	extern kern_return_t vm_conflict_check(
9bccf70c A	162	vm_map_t map,
91447636 A	163	vm_map_offset_t off,
91447636 A	164	vm_map_size_t len,
9bccf70c A	165	memory_object_t pager,
	166	vm_object_offset_t file_off);
	167
91447636 A	168	#endif /* MACH_KERNEL_PRIVATE */
91447636 A	169
1c79356b A	170	extern vm_map_t kernel_map;
	171	extern vm_map_t kernel_pageable_map;
	172	extern vm_map_t ipc_kernel_map;
	173
91447636 A	174	#endif /* KERNEL_PRIVATE */
91447636 A	175
1c79356b	176	#endif /* _VM_VM_KERN_H_ */