[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

#ifdef XNU_KERNEL_PRIVATE

#include <kern/locks.h>

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,
				vm_tag_t        tag);

/* 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
#define KMA_KSTACK	0x100
#define KMA_VAONLY	0x200
#define KMA_COMPRESSOR	0x400   /* Pages belonging to the compressor are not on the paging queues, nor are they counted as wired. */
#define KMA_ATOMIC 	0x800

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

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,
				vm_tag_t        tag);

extern kern_return_t	kmem_alloc_flags(
				vm_map_t	map,
				vm_offset_t	*addrp,
				vm_size_t	size,
				vm_tag_t        tag,
				int 		flags);

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

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

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,
				vm_tag_t        tag);

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,
				vm_tag_t        tag);

extern kern_return_t kernel_memory_populate(
	vm_map_t	map,
	vm_offset_t	addr,
	vm_size_t	size,
	int		flags,
	vm_tag_t        tag);

extern void kernel_memory_depopulate(
	vm_map_t	map,
	vm_offset_t	addr,
	vm_size_t	size,
	int		flags);

extern kern_return_t	memory_object_iopl_request(
	ipc_port_t		port,
	memory_object_offset_t	offset,
	upl_size_t		*upl_size,
	upl_t			*upl_ptr,
	upl_page_info_array_t	user_page_list,
	unsigned int		*page_list_count,
	upl_control_flags_t	*flags);

struct mach_memory_info;
extern kern_return_t	vm_page_diagnose(struct mach_memory_info * sites, 
					 unsigned int num_sites, uint64_t zones_collectable_bytes);

#if DEBUG || DEVELOPMENT
extern void kern_wired_diagnose(void);
#endif /* DEBUG || DEVELOPMENT */

extern vm_tag_t 	vm_tag_bt(void);

extern vm_tag_t		vm_tag_alloc(vm_allocation_site_t * site);

extern void		vm_tag_alloc_locked(vm_allocation_site_t * site);

extern vm_tag_t 	vm_tag_bt_debug(void);

extern uint32_t         vm_tag_get_kext(vm_tag_t tag, char * name, vm_size_t namelen);

#if DEBUG || DEVELOPMENT

struct vm_tag_set_entry
{
    vm_tag_t tag;
    uint32_t count;
};

struct vm_tag_set
{
    lck_spin_t              lock;
    struct vm_tag_set_entry entries[0];
};

typedef struct vm_tag_set * vm_tag_set_t;

extern void             vm_tag_set_init(vm_tag_set_t, uint32_t count);
extern kern_return_t    vm_tag_set_enter(vm_tag_set_t set, uint32_t count, vm_tag_t tag);
extern kern_return_t    vm_tag_set_remove(vm_tag_set_t set, uint32_t count, vm_tag_t tag, vm_tag_t * new_tag);

#endif /* DEBUG || DEVELOPMENT */

extern boolean_t	vm_kernel_map_is_kernel(vm_map_t map);

extern ppnum_t		kernel_pmap_present_mapping(uint64_t vaddr, uint64_t * pvincr, uintptr_t * pvphysaddr);
#if DEBUG || DEVELOPMENT
extern void		kernel_pmap_lock(void);
extern void		kernel_pmap_unlock(void);
#endif /* DEBUG || DEVELOPMENT */

#else /* XNU_KERNEL_PRIVATE */

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

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

#endif /* !XNU_KERNEL_PRIVATE */


#ifdef	MACH_KERNEL_PRIVATE

extern void		kmem_init(
					vm_offset_t	start,
					vm_offset_t	end);


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

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

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

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

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

#ifdef KERNEL

extern vm_offset_t vm_kernel_addrperm_ext;

extern void	vm_kernel_addrperm_external(
			vm_offset_t addr,
			vm_offset_t *perm_addr);

extern void	vm_kernel_unslide_or_perm_external(
		vm_offset_t addr,
		vm_offset_t *up_addr);
#endif /* KERNEL */
#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	74
3e170ce0 A	75	#ifdef XNU_KERNEL_PRIVATE
3e170ce0 A	76
39037602 A	77	#include <kern/locks.h>
39037602 A	78
1c79356b A	79	extern kern_return_t kernel_memory_allocate(
	80	vm_map_t map,
	81	vm_offset_t *addrp,
	82	vm_size_t size,
	83	vm_offset_t mask,
3e170ce0 A	84	int flags,
3e170ce0 A	85	vm_tag_t tag);
1c79356b A	86
	87	/* flags for kernel_memory_allocate */
	88	#define KMA_HERE 0x01
	89	#define KMA_NOPAGEWAIT 0x02
	90	#define KMA_KOBJECT 0x04
0c530ab8	91	#define KMA_LOMEM 0x08
2d21ac55 A	92	#define KMA_GUARD_FIRST 0x10
2d21ac55 A	93	#define KMA_GUARD_LAST 0x20
b0d623f7	94	#define KMA_PERMANENT 0x40
0b4c1975	95	#define KMA_NOENCRYPT 0x80
316670eb	96	#define KMA_KSTACK 0x100
39236c6e A	97	#define KMA_VAONLY 0x200
39236c6e A	98	#define KMA_COMPRESSOR 0x400 /* Pages belonging to the compressor are not on the paging queues, nor are they counted as wired. */
39037602 A	99	#define KMA_ATOMIC 0x800
	100
	101	extern kern_return_t kmem_alloc(
	102	vm_map_t map,
	103	vm_offset_t *addrp,
	104	vm_size_t size,
	105	vm_tag_t tag);
1c79356b A	106
	107	extern kern_return_t kmem_alloc_contig(
	108	vm_map_t map,
	109	vm_offset_t *addrp,
	110	vm_size_t size,
	111	vm_offset_t mask,
2d21ac55	112	ppnum_t max_pnum,
b0d623f7	113	ppnum_t pnum_mask,
3e170ce0 A	114	int flags,
3e170ce0 A	115	vm_tag_t tag);
1c79356b	116
39037602	117	extern kern_return_t kmem_alloc_flags(
1c79356b A	118	vm_map_t map,
1c79356b A	119	vm_offset_t *addrp,
3e170ce0	120	vm_size_t size,
39037602 A	121	vm_tag_t tag,
39037602 A	122	int flags);
1c79356b A	123
	124	extern kern_return_t kmem_alloc_pageable(
	125	vm_map_t map,
	126	vm_offset_t *addrp,
3e170ce0 A	127	vm_size_t size,
3e170ce0 A	128	vm_tag_t tag);
1c79356b	129
1c79356b A	130	extern kern_return_t kmem_alloc_aligned(
	131	vm_map_t map,
	132	vm_offset_t *addrp,
3e170ce0 A	133	vm_size_t size,
3e170ce0 A	134	vm_tag_t tag);
1c79356b A	135
	136	extern kern_return_t kmem_realloc(
	137	vm_map_t map,
	138	vm_offset_t oldaddr,
	139	vm_size_t oldsize,
	140	vm_offset_t *newaddrp,
3e170ce0 A	141	vm_size_t newsize,
3e170ce0 A	142	vm_tag_t tag);
1c79356b A	143
	144	extern void kmem_free(
	145	vm_map_t map,
	146	vm_offset_t addr,
	147	vm_size_t size);
	148
	149	extern kern_return_t kmem_suballoc(
	150	vm_map_t parent,
	151	vm_offset_t *addr,
	152	vm_size_t size,
	153	boolean_t pageable,
b0d623f7	154	int flags,
1c79356b A	155	vm_map_t *new_map);
1c79356b A	156
b0d623f7	157	extern kern_return_t kmem_alloc_kobject(
2d21ac55 A	158	vm_map_t map,
2d21ac55 A	159	vm_offset_t *addrp,
3e170ce0 A	160	vm_size_t size,
3e170ce0 A	161	vm_tag_t tag);
2d21ac55	162
39236c6e A	163	extern kern_return_t kernel_memory_populate(
	164	vm_map_t map,
	165	vm_offset_t addr,
	166	vm_size_t size,
3e170ce0 A	167	int flags,
	168	vm_tag_t tag);
	169
39236c6e A	170	extern void kernel_memory_depopulate(
	171	vm_map_t map,
	172	vm_offset_t addr,
	173	vm_size_t size,
	174	int flags);
	175
3e170ce0 A	176	extern kern_return_t memory_object_iopl_request(
	177	ipc_port_t port,
	178	memory_object_offset_t offset,
	179	upl_size_t *upl_size,
	180	upl_t *upl_ptr,
	181	upl_page_info_array_t user_page_list,
	182	unsigned int *page_list_count,
	183	upl_control_flags_t *flags);
	184
	185	struct mach_memory_info;
	186	extern kern_return_t vm_page_diagnose(struct mach_memory_info * sites,
39037602 A	187	unsigned int num_sites, uint64_t zones_collectable_bytes);
	188
	189	#if DEBUG \|\| DEVELOPMENT
	190	extern void kern_wired_diagnose(void);
	191	#endif /* DEBUG \|\| DEVELOPMENT */
3e170ce0 A	192
	193	extern vm_tag_t vm_tag_bt(void);
	194
	195	extern vm_tag_t vm_tag_alloc(vm_allocation_site_t * site);
	196
	197	extern void vm_tag_alloc_locked(vm_allocation_site_t * site);
	198
	199	extern vm_tag_t vm_tag_bt_debug(void);
	200
39037602 A	201	extern uint32_t vm_tag_get_kext(vm_tag_t tag, char * name, vm_size_t namelen);
	202
	203	#if DEBUG \|\| DEVELOPMENT
	204
	205	struct vm_tag_set_entry
	206	{
	207	vm_tag_t tag;
	208	uint32_t count;
	209	};
	210
	211	struct vm_tag_set
	212	{
	213	lck_spin_t lock;
	214	struct vm_tag_set_entry entries[0];
	215	};
	216
	217	typedef struct vm_tag_set * vm_tag_set_t;
	218
	219	extern void vm_tag_set_init(vm_tag_set_t, uint32_t count);
	220	extern kern_return_t vm_tag_set_enter(vm_tag_set_t set, uint32_t count, vm_tag_t tag);
	221	extern kern_return_t vm_tag_set_remove(vm_tag_set_t set, uint32_t count, vm_tag_t tag, vm_tag_t * new_tag);
	222
	223	#endif /* DEBUG \|\| DEVELOPMENT */
	224
3e170ce0 A	225	extern boolean_t vm_kernel_map_is_kernel(vm_map_t map);
3e170ce0 A	226
39037602 A	227	extern ppnum_t kernel_pmap_present_mapping(uint64_t vaddr, uint64_t * pvincr, uintptr_t * pvphysaddr);
	228	#if DEBUG \|\| DEVELOPMENT
	229	extern void kernel_pmap_lock(void);
	230	extern void kernel_pmap_unlock(void);
	231	#endif /* DEBUG \|\| DEVELOPMENT */
3e170ce0 A	232
	233	#else /* XNU_KERNEL_PRIVATE */
	234
	235	extern kern_return_t kmem_alloc(
	236	vm_map_t map,
	237	vm_offset_t *addrp,
	238	vm_size_t size);
	239
	240	extern kern_return_t kmem_alloc_pageable(
	241	vm_map_t map,
	242	vm_offset_t *addrp,
	243	vm_size_t size);
	244
	245	extern kern_return_t kmem_alloc_kobject(
	246	vm_map_t map,
	247	vm_offset_t *addrp,
	248	vm_size_t size);
	249
	250	extern void kmem_free(
	251	vm_map_t map,
	252	vm_offset_t addr,
	253	vm_size_t size);
	254
	255	#endif /* !XNU_KERNEL_PRIVATE */
	256
	257
2d21ac55 A	258	#ifdef MACH_KERNEL_PRIVATE
	259
	260	extern void kmem_init(
	261	vm_offset_t start,
39236c6e	262	vm_offset_t end);
2d21ac55 A	263
2d21ac55 A	264
91447636	265	extern kern_return_t copyinmap(
1c79356b	266	vm_map_t map,
91447636 A	267	vm_map_offset_t fromaddr,
91447636 A	268	void *todata,
1c79356b A	269	vm_size_t length);
1c79356b A	270
91447636	271	extern kern_return_t copyoutmap(
1c79356b	272	vm_map_t map,
91447636 A	273	void *fromdata,
91447636 A	274	vm_map_offset_t toaddr,
1c79356b A	275	vm_size_t length);
1c79356b A	276
9bccf70c A	277	extern kern_return_t vm_conflict_check(
9bccf70c A	278	vm_map_t map,
91447636 A	279	vm_map_offset_t off,
91447636 A	280	vm_map_size_t len,
9bccf70c A	281	memory_object_t pager,
	282	vm_object_offset_t file_off);
	283
3e170ce0 A	284	extern kern_return_t kmem_alloc_external(
	285	vm_map_t map,
	286	vm_offset_t *addrp,
	287	vm_size_t size);
	288
	289	extern kern_return_t kmem_alloc_kobject_external(
	290	vm_map_t map,
	291	vm_offset_t *addrp,
	292	vm_size_t size);
	293
	294	extern kern_return_t kmem_alloc_pageable_external(
	295	vm_map_t map,
	296	vm_offset_t *addrp,
	297	vm_size_t size);
	298
91447636 A	299	#endif /* MACH_KERNEL_PRIVATE */
91447636 A	300
1c79356b A	301	extern vm_map_t kernel_map;
	302	extern vm_map_t kernel_pageable_map;
	303	extern vm_map_t ipc_kernel_map;
	304
91447636 A	305	#endif /* KERNEL_PRIVATE */
91447636 A	306
3e170ce0 A	307	#ifdef KERNEL
	308
	309	extern vm_offset_t vm_kernel_addrperm_ext;
	310
	311	extern void vm_kernel_addrperm_external(
	312	vm_offset_t addr,
	313	vm_offset_t *perm_addr);
	314
	315	extern void vm_kernel_unslide_or_perm_external(
	316	vm_offset_t addr,
	317	vm_offset_t *up_addr);
	318	#endif /* KERNEL */
1c79356b	319	#endif /* _VM_VM_KERN_H_ */