xref: /xnu-8020.140.41/osfmk/vm/memory_object.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1 /*
2  * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
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
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
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  [email protected]
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>
65 #include <mach/mach_types.h>
66 #include <mach/memory_object_types.h>
67 #include <ipc/ipc_types.h>
68 
69 extern memory_object_default_t memory_manager_default;
70 
71 __private_extern__
72 memory_object_default_t memory_manager_default_reference(void);
73 
74 __private_extern__
75 kern_return_t           memory_manager_default_check(void);
76 
77 __private_extern__
78 memory_object_control_t memory_object_control_allocate(
79 	vm_object_t             object);
80 
81 __private_extern__
82 void                    memory_object_control_collapse(
83 	memory_object_control_t *control,
84 	vm_object_t             object);
85 
86 __private_extern__
87 vm_object_t             memory_object_control_to_vm_object(
88 	memory_object_control_t control);
89 __private_extern__
90 vm_object_t             memory_object_to_vm_object(
91 	memory_object_t mem_obj);
92 
93 extern
94 mach_port_t             convert_mo_control_to_port(
95 	memory_object_control_t control);
96 
97 extern void memory_object_control_disable(
98 	memory_object_control_t *control);
99 
100 extern
101 memory_object_control_t convert_port_to_mo_control(
102 	mach_port_t             port);
103 
104 extern
105 mach_port_t             convert_memory_object_to_port(
106 	memory_object_t         object);
107 
108 extern
109 memory_object_t         convert_port_to_memory_object(
110 	mach_port_t             port);
111 
112 extern upl_t convert_port_to_upl(
113 	ipc_port_t      port);
114 
115 extern ipc_port_t convert_upl_to_port( upl_t );
116 
117 extern kern_return_t    memory_object_pages_resident(
118 	memory_object_control_t         control,
119 	boolean_t                       *               has_pages_resident);
120 
121 extern kern_return_t    memory_object_signed(
122 	memory_object_control_t         control,
123 	boolean_t                       is_signed);
124 
125 extern boolean_t        memory_object_is_signed(
126 	memory_object_control_t control);
127 
128 extern boolean_t        memory_object_is_shared_cache(
129 	memory_object_control_t         control);
130 
131 extern void             memory_object_mark_used(
132 	memory_object_control_t         control);
133 
134 extern void             memory_object_mark_unused(
135 	memory_object_control_t         control,
136 	boolean_t                       rage);
137 
138 extern void             memory_object_mark_io_tracking(
139 	memory_object_control_t         control);
140 
141 extern void             memory_object_mark_trusted(
142 	memory_object_control_t         control);
143 
144 #if CONFIG_SECLUDED_MEMORY
145 extern void             memory_object_mark_eligible_for_secluded(
146 	memory_object_control_t         control,
147 	boolean_t                       eligible_for_secluded);
148 #endif /* CONFIG_SECLUDED_MEMORY */
149 
150 #endif  /* _VM_MEMORY_OBJECT_H_ */
151