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

/*
 * Copyright (c) 2000-2004 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 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 
 * 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 the
 * rights to redistribute these changes.
 */
/*
 */

#ifndef	_VM_MEMORY_OBJECT_H_
#define	_VM_MEMORY_OBJECT_H_

#include <mach_pagemap.h>

#include <mach/boolean.h>
#include <mach/mach_types.h>
#include <mach/memory_object_types.h>
#include <ipc/ipc_types.h>

__private_extern__
memory_object_default_t	memory_manager_default_reference(
				vm_size_t		*cluster_size);

__private_extern__
kern_return_t		memory_manager_default_check(void);

__private_extern__
void			memory_manager_default_init(void);

__private_extern__
void			memory_object_control_bootstrap(void);
__private_extern__
memory_object_control_t memory_object_control_allocate(
				vm_object_t		object);

__private_extern__
void			memory_object_control_collapse(
				memory_object_control_t control,
				vm_object_t		object);

__private_extern__
vm_object_t 		memory_object_control_to_vm_object(
				memory_object_control_t control);

extern
mach_port_t		convert_mo_control_to_port(
				memory_object_control_t	control);

extern void memory_object_control_disable(
	memory_object_control_t	control);

extern
memory_object_control_t convert_port_to_mo_control(
				mach_port_t		port);

extern
mach_port_t		convert_memory_object_to_port(
				memory_object_t		object);

extern
memory_object_t		convert_port_to_memory_object(
				mach_port_t		port);

extern upl_t convert_port_to_upl(
				ipc_port_t	port);

extern ipc_port_t convert_upl_to_port( upl_t );

__private_extern__ void upl_no_senders(ipc_port_t, mach_port_mscount_t);

extern kern_return_t	memory_object_free_from_cache(
				host_t		host,
				int		*pager_id,
				int		*count);

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

extern kern_return_t	memory_object_pages_resident(
	memory_object_control_t		control,
	boolean_t			*		has_pages_resident);

#endif	/* _VM_MEMORY_OBJECT_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 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.
	14	*
	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991 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
	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 the
	54	* rights to redistribute these changes.
	55	*/
	56	/*
	57	*/
	58
	59	#ifndef _VM_MEMORY_OBJECT_H_
	60	#define _VM_MEMORY_OBJECT_H_
	61
	62	#include <mach_pagemap.h>
	63
	64	#include <mach/boolean.h>
0b4e3aa0 A	65	#include <mach/mach_types.h>
0b4e3aa0 A	66	#include <mach/memory_object_types.h>
1c79356b A	67	#include <ipc/ipc_types.h>
1c79356b A	68
0b4e3aa0 A	69	__private_extern__
	70	memory_object_default_t memory_manager_default_reference(
	71	vm_size_t *cluster_size);
1c79356b	72
0b4e3aa0 A	73	__private_extern__
0b4e3aa0 A	74	kern_return_t memory_manager_default_check(void);
1c79356b	75
0b4e3aa0 A	76	__private_extern__
0b4e3aa0 A	77	void memory_manager_default_init(void);
1c79356b	78
0b4e3aa0 A	79	__private_extern__
	80	void memory_object_control_bootstrap(void);
	81	__private_extern__
	82	memory_object_control_t memory_object_control_allocate(
	83	vm_object_t object);
1c79356b	84
0b4e3aa0 A	85	__private_extern__
	86	void memory_object_control_collapse(
	87	memory_object_control_t control,
	88	vm_object_t object);
1c79356b	89
0b4e3aa0 A	90	__private_extern__
	91	vm_object_t memory_object_control_to_vm_object(
	92	memory_object_control_t control);
1c79356b	93
0b4e3aa0 A	94	extern
	95	mach_port_t convert_mo_control_to_port(
	96	memory_object_control_t control);
	97
91447636 A	98	extern void memory_object_control_disable(
	99	memory_object_control_t control);
	100
0b4e3aa0 A	101	extern
	102	memory_object_control_t convert_port_to_mo_control(
	103	mach_port_t port);
	104
	105	extern
	106	mach_port_t convert_memory_object_to_port(
	107	memory_object_t object);
	108
	109	extern
	110	memory_object_t convert_port_to_memory_object(
	111	mach_port_t port);
1c79356b	112
91447636 A	113	extern upl_t convert_port_to_upl(
	114	ipc_port_t port);
	115
	116	extern ipc_port_t convert_upl_to_port( upl_t );
	117
	118	__private_extern__ void upl_no_senders(ipc_port_t, mach_port_mscount_t);
	119
1c79356b	120	extern kern_return_t memory_object_free_from_cache(
8f6c56a5 A	121	host_t host,
	122	int *pager_id,
	123	int *count);
1c79356b	124
91447636 A	125	extern kern_return_t memory_object_iopl_request(
	126	ipc_port_t port,
	127	memory_object_offset_t offset,
	128	vm_size_t *upl_size,
	129	upl_t *upl_ptr,
	130	upl_page_info_array_t user_page_list,
	131	unsigned int *page_list_count,
	132	int *flags);
	133
	134
	135	extern kern_return_t memory_object_pages_resident(
	136	memory_object_control_t control,
	137	boolean_t * has_pages_resident);
	138
1c79356b	139	#endif /* _VM_MEMORY_OBJECT_H_ */