xref: /xnu-10002.81.5/osfmk/vm/memory_object.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
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/boolean.h>
63 #include <mach/mach_types.h>
64 #include <mach/memory_object_types.h>
65 #include <ipc/ipc_types.h>
66 
67 extern memory_object_default_t memory_manager_default;
68 
69 __private_extern__
70 memory_object_default_t memory_manager_default_reference(void);
71 
72 __private_extern__
73 kern_return_t           memory_manager_default_check(void);
74 
75 __private_extern__
76 memory_object_control_t memory_object_control_allocate(
77 	vm_object_t             object);
78 
79 __private_extern__
80 void                    memory_object_control_collapse(
81 	memory_object_control_t *control,
82 	vm_object_t             object);
83 
84 __private_extern__
85 vm_object_t             memory_object_control_to_vm_object(
86 	memory_object_control_t control);
87 __private_extern__
88 vm_object_t             memory_object_to_vm_object(
89 	memory_object_t mem_obj);
90 
91 extern void memory_object_control_disable(
92 	memory_object_control_t *control);
93 
94 extern mach_port_t convert_memory_object_to_port(
95 	memory_object_t         object);
96 
97 extern memory_object_t convert_port_to_memory_object(
98 	mach_port_t             port);
99 
100 extern upl_t convert_port_to_upl(
101 	ipc_port_t      port);
102 
103 extern ipc_port_t convert_upl_to_port( upl_t );
104 
105 extern kern_return_t    memory_object_pages_resident(
106 	memory_object_control_t         control,
107 	boolean_t                       *               has_pages_resident);
108 
109 extern kern_return_t    memory_object_signed(
110 	memory_object_control_t         control,
111 	boolean_t                       is_signed);
112 
113 extern boolean_t        memory_object_is_signed(
114 	memory_object_control_t control);
115 
116 extern boolean_t        memory_object_is_shared_cache(
117 	memory_object_control_t         control);
118 
119 extern void             memory_object_mark_used(
120 	memory_object_control_t         control);
121 
122 extern void             memory_object_mark_unused(
123 	memory_object_control_t         control,
124 	boolean_t                       rage);
125 
126 extern void             memory_object_mark_io_tracking(
127 	memory_object_control_t         control);
128 
129 extern void             memory_object_mark_trusted(
130 	memory_object_control_t         control);
131 
132 #if CONFIG_SECLUDED_MEMORY
133 extern void             memory_object_mark_eligible_for_secluded(
134 	memory_object_control_t         control,
135 	boolean_t                       eligible_for_secluded);
136 #endif /* CONFIG_SECLUDED_MEMORY */
137 
138 extern void             memory_object_mark_for_realtime(
139 	memory_object_control_t         control,
140 	bool                            for_realtime);
141 
142 #endif  /* _VM_MEMORY_OBJECT_H_ */
143