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

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_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

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