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