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

/*
 * 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:	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

extern kern_return_t kmem_alloc_contig(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size,
				vm_offset_t 	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);

#ifdef	MACH_KERNEL_PRIVATE

extern void		kmem_init(
					vm_offset_t	start,
					vm_offset_t	end);

extern kern_return_t	kmem_alloc_wired(
				vm_map_t	map,
				vm_offset_t	*addrp,
				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,
				boolean_t	anywhere,
				vm_map_t	*new_map);

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	/*
91447636	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b A	29	*/
	30	/*
	31	* @OSF_COPYRIGHT@
	32	*/
	33	/*
	34	* Mach Operating System
	35	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	36	* All Rights Reserved.
	37	*
	38	* Permission to use, copy, modify and distribute this software and its
	39	* documentation is hereby granted, provided that both the copyright
	40	* notice and this permission notice appear in all copies of the
	41	* software, derivative works or modified versions, and any portions
	42	* thereof, and that both notices appear in supporting documentation.
	43	*
	44	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	45	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	46	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	47	*
	48	* Carnegie Mellon requests users of this software to return to
	49	*
	50	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	51	* School of Computer Science
	52	* Carnegie Mellon University
	53	* Pittsburgh PA 15213-3890
	54	*
	55	* any improvements or extensions that they make and grant Carnegie Mellon
	56	* the rights to redistribute these changes.
	57	*/
	58	/*
	59	*/
	60	/*
	61	* File: vm/vm_kern.h
	62	* Author: Avadis Tevanian, Jr., Michael Wayne Young
	63	* Date: 1985
	64	*
	65	* Kernel memory management definitions.
	66	*/
	67
	68	#ifndef _VM_VM_KERN_H_
	69	#define _VM_VM_KERN_H_
	70
91447636	71	#include <mach/mach_types.h>
1c79356b A	72	#include <mach/boolean.h>
1c79356b A	73	#include <mach/kern_return.h>
1c79356b	74
91447636	75	#ifdef KERNEL_PRIVATE
1c79356b A	76
	77	extern kern_return_t kernel_memory_allocate(
	78	vm_map_t map,
	79	vm_offset_t *addrp,
	80	vm_size_t size,
	81	vm_offset_t mask,
	82	int flags);
	83
	84	/* flags for kernel_memory_allocate */
	85	#define KMA_HERE 0x01
	86	#define KMA_NOPAGEWAIT 0x02
	87	#define KMA_KOBJECT 0x04
5d5c5d0d	88	#define KMA_LOMEM 0x08
1c79356b A	89
	90	extern kern_return_t kmem_alloc_contig(
	91	vm_map_t map,
	92	vm_offset_t *addrp,
	93	vm_size_t size,
	94	vm_offset_t mask,
	95	int flags);
	96
	97	extern kern_return_t kmem_alloc(
	98	vm_map_t map,
	99	vm_offset_t *addrp,
	100	vm_size_t size);
	101
	102	extern kern_return_t kmem_alloc_pageable(
	103	vm_map_t map,
	104	vm_offset_t *addrp,
	105	vm_size_t size);
	106
1c79356b A	107	extern kern_return_t kmem_alloc_aligned(
	108	vm_map_t map,
	109	vm_offset_t *addrp,
	110	vm_size_t size);
	111
	112	extern kern_return_t kmem_realloc(
	113	vm_map_t map,
	114	vm_offset_t oldaddr,
	115	vm_size_t oldsize,
	116	vm_offset_t *newaddrp,
	117	vm_size_t newsize);
	118
	119	extern void kmem_free(
	120	vm_map_t map,
	121	vm_offset_t addr,
	122	vm_size_t size);
	123
91447636 A	124	#ifdef MACH_KERNEL_PRIVATE
	125
	126	extern void kmem_init(
	127	vm_offset_t start,
	128	vm_offset_t end);
	129
	130	extern kern_return_t kmem_alloc_wired(
	131	vm_map_t map,
	132	vm_offset_t *addrp,
	133	vm_size_t size);
	134
1c79356b A	135	extern kern_return_t kmem_suballoc(
	136	vm_map_t parent,
	137	vm_offset_t *addr,
	138	vm_size_t size,
	139	boolean_t pageable,
	140	boolean_t anywhere,
	141	vm_map_t *new_map);
	142
91447636	143	extern kern_return_t copyinmap(
1c79356b	144	vm_map_t map,
91447636 A	145	vm_map_offset_t fromaddr,
91447636 A	146	void *todata,
1c79356b A	147	vm_size_t length);
1c79356b A	148
91447636	149	extern kern_return_t copyoutmap(
1c79356b	150	vm_map_t map,
91447636 A	151	void *fromdata,
91447636 A	152	vm_map_offset_t toaddr,
1c79356b A	153	vm_size_t length);
1c79356b A	154
9bccf70c A	155	extern kern_return_t vm_conflict_check(
9bccf70c A	156	vm_map_t map,
91447636 A	157	vm_map_offset_t off,
91447636 A	158	vm_map_size_t len,
9bccf70c A	159	memory_object_t pager,
	160	vm_object_offset_t file_off);
	161
91447636 A	162	#endif /* MACH_KERNEL_PRIVATE */
91447636 A	163
1c79356b A	164	extern vm_map_t kernel_map;
	165	extern vm_map_t kernel_pageable_map;
	166	extern vm_map_t ipc_kernel_map;
	167
91447636 A	168	#endif /* KERNEL_PRIVATE */
91447636 A	169
1c79356b	170	#endif /* _VM_VM_KERN_H_ */