[apple/xnu.git] / osfmk / vm / memory_object.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 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 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 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
	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 the
	48	* rights to redistribute these changes.
	49	*/
	50	/*
	51	*/
	52
	53	#ifndef _VM_MEMORY_OBJECT_H_
	54	#define _VM_MEMORY_OBJECT_H_
	55
	56	#include <mach_pagemap.h>
	57
	58	#include <mach/boolean.h>
0b4e3aa0 A	59	#include <mach/mach_types.h>
0b4e3aa0 A	60	#include <mach/memory_object_types.h>
1c79356b A	61	#include <ipc/ipc_types.h>
1c79356b A	62
0b4e3aa0 A	63	__private_extern__
	64	memory_object_default_t memory_manager_default_reference(
	65	vm_size_t *cluster_size);
1c79356b	66
0b4e3aa0 A	67	__private_extern__
0b4e3aa0 A	68	kern_return_t memory_manager_default_check(void);
1c79356b	69
0b4e3aa0 A	70	__private_extern__
0b4e3aa0 A	71	void memory_manager_default_init(void);
1c79356b	72
0b4e3aa0 A	73	__private_extern__
	74	void memory_object_control_bootstrap(void);
	75	__private_extern__
	76	memory_object_control_t memory_object_control_allocate(
	77	vm_object_t object);
1c79356b	78
0b4e3aa0 A	79	__private_extern__
	80	void memory_object_control_collapse(
	81	memory_object_control_t control,
	82	vm_object_t object);
1c79356b	83
0b4e3aa0 A	84	__private_extern__
	85	vm_object_t memory_object_control_to_vm_object(
	86	memory_object_control_t control);
1c79356b	87
0b4e3aa0 A	88	extern
	89	mach_port_t convert_mo_control_to_port(
	90	memory_object_control_t control);
	91
91447636 A	92	extern void memory_object_control_disable(
	93	memory_object_control_t control);
	94
0b4e3aa0 A	95	extern
	96	memory_object_control_t convert_port_to_mo_control(
	97	mach_port_t port);
	98
	99	extern
	100	mach_port_t convert_memory_object_to_port(
	101	memory_object_t object);
	102
	103	extern
	104	memory_object_t convert_port_to_memory_object(
	105	mach_port_t port);
1c79356b	106
91447636 A	107	extern upl_t convert_port_to_upl(
	108	ipc_port_t port);
	109
	110	extern ipc_port_t convert_upl_to_port( upl_t );
	111
	112	__private_extern__ void upl_no_senders(ipc_port_t, mach_port_mscount_t);
	113
1c79356b A	114	extern kern_return_t memory_object_free_from_cache(
1c79356b A	115	host_t host,
0b4e3aa0	116	int *pager_id,
1c79356b A	117	int *count);
1c79356b A	118
91447636 A	119	extern kern_return_t memory_object_iopl_request(
	120	ipc_port_t port,
	121	memory_object_offset_t offset,
	122	vm_size_t *upl_size,
	123	upl_t *upl_ptr,
	124	upl_page_info_array_t user_page_list,
	125	unsigned int *page_list_count,
	126	int *flags);
	127
	128
	129	extern kern_return_t memory_object_pages_resident(
	130	memory_object_control_t control,
	131	boolean_t * has_pages_resident);
	132
1c79356b	133	#endif /* _VM_MEMORY_OBJECT_H_ */