]> git.saurik.com Git - apple/xnu.git/blame - osfmk/vm/vm_protos.h
xnu-1699.26.8.tar.gz
[apple/xnu.git] / osfmk / vm / vm_protos.h
CommitLineData
91447636 1/*
2d21ac55 2 * Copyright (c) 2004-2007 Apple Inc. All rights reserved.
91447636 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636 5 *
2d21ac55
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.
8f6c56a5 14 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636
A
27 */
28
29#ifdef XNU_KERNEL_PRIVATE
30
31#ifndef _VM_VM_PROTOS_H_
32#define _VM_VM_PROTOS_H_
33
34#include <mach/mach_types.h>
35#include <kern/kern_types.h>
36
37/*
38 * This file contains various type definitions and routine prototypes
39 * that are needed to avoid compilation warnings for VM code (in osfmk,
40 * default_pager and bsd).
41 * Most of these should eventually go into more appropriate header files.
42 *
43 * Include it after all other header files since it doesn't include any
44 * type definitions and it works around some conflicts with other header
45 * files.
46 */
47
48/*
49 * iokit
50 */
51extern kern_return_t device_data_action(
b0d623f7 52 uintptr_t device_handle,
91447636
A
53 ipc_port_t device_pager,
54 vm_prot_t protection,
55 vm_object_offset_t offset,
56 vm_size_t size);
57
58extern kern_return_t device_close(
b0d623f7 59 uintptr_t device_handle);
91447636
A
60
61/*
62 * default_pager
63 */
64extern int start_def_pager(
65 char *bs_device);
0c530ab8 66extern int default_pager_init_flag;
91447636
A
67
68/*
69 * osfmk
70 */
71#ifndef _KERN_IPC_TT_H_ /* XXX FBDP */
72/* these should be exported cleanly from OSFMK since BSD needs them */
73extern ipc_port_t convert_task_to_port(
74 task_t task);
2d21ac55
A
75extern ipc_port_t convert_thread_to_port(
76 thread_t thread);
0c530ab8
A
77extern ipc_port_t convert_task_name_to_port(
78 task_name_t task_name);
91447636
A
79#endif /* _KERN_IPC_TT_H_ */
80#ifndef _IPC_IPC_PORT_H_
81extern mach_port_name_t ipc_port_copyout_send(
82 ipc_port_t sright,
83 ipc_space_t space);
84extern task_t port_name_to_task(
85 mach_port_name_t name);
86#endif /* _IPC_IPC_PORT_H_ */
87
88extern ipc_space_t get_task_ipcspace(
89 task_t t);
90
91/* Some loose-ends VM stuff */
92
93extern vm_map_t kalloc_map;
94extern vm_size_t msg_ool_size_small;
95extern vm_map_t zone_map;
96
97extern void consider_machine_adjust(void);
98extern pmap_t get_map_pmap(vm_map_t);
99extern vm_map_offset_t get_map_min(vm_map_t);
100extern vm_map_offset_t get_map_max(vm_map_t);
101extern vm_map_size_t get_vmmap_size(vm_map_t);
102extern int get_vmmap_entries(vm_map_t);
103
104extern boolean_t coredumpok(vm_map_t map, vm_offset_t va);
105
106/*
107 * VM routines that used to be published to
108 * user space, and are now restricted to the kernel.
109 *
110 * They should eventually go away entirely -
111 * to be replaced with standard vm_map() and
112 * vm_deallocate() calls.
113 */
114
115extern kern_return_t vm_upl_map
116(
117 vm_map_t target_task,
118 upl_t upl,
119 vm_address_t *address
120);
121
122extern kern_return_t vm_upl_unmap
123(
124 vm_map_t target_task,
125 upl_t upl
126);
127
128extern kern_return_t vm_region_object_create
129(
130 vm_map_t target_task,
131 vm_size_t size,
132 ipc_port_t *object_handle
133);
134
135extern mach_vm_offset_t mach_get_vm_start(vm_map_t);
136extern mach_vm_offset_t mach_get_vm_end(vm_map_t);
137
593a1d5f
A
138#if CONFIG_CODE_DECRYPTION
139struct pager_crypt_info;
0c530ab8 140extern kern_return_t vm_map_apple_protected(
593a1d5f
A
141 vm_map_t map,
142 vm_map_offset_t start,
143 vm_map_offset_t end,
144 struct pager_crypt_info *crypt_info);
0c530ab8 145extern void apple_protect_pager_bootstrap(void);
593a1d5f
A
146extern memory_object_t apple_protect_pager_setup(vm_object_t backing_object,
147 struct pager_crypt_info *crypt_info);
148#endif /* CONFIG_CODE_DECRYPTION */
0c530ab8 149
b0d623f7
A
150struct vnode;
151extern void swapfile_pager_bootstrap(void);
152extern memory_object_t swapfile_pager_setup(struct vnode *vp);
153extern memory_object_control_t swapfile_pager_control(memory_object_t mem_obj);
154
91447636
A
155
156/*
157 * bsd
158 */
159struct vnode;
91447636
A
160extern void vnode_pager_shutdown(void);
161extern void *upl_get_internal_page_list(
162 upl_t upl);
b0d623f7 163
91447636
A
164typedef int pager_return_t;
165extern pager_return_t vnode_pagein(
166 struct vnode *, upl_t,
b0d623f7
A
167 upl_offset_t, vm_object_offset_t,
168 upl_size_t, int, int *);
91447636
A
169extern pager_return_t vnode_pageout(
170 struct vnode *, upl_t,
b0d623f7
A
171 upl_offset_t, vm_object_offset_t,
172 upl_size_t, int, int *);
6d2010ae 173extern uint32_t vnode_trim (struct vnode *, int64_t offset, unsigned long len);
91447636
A
174extern memory_object_t vnode_pager_setup(
175 struct vnode *, memory_object_t);
176extern vm_object_offset_t vnode_pager_get_filesize(
177 struct vnode *);
b0d623f7
A
178extern uint32_t vnode_pager_isinuse(
179 struct vnode *);
6d2010ae
A
180extern boolean_t vnode_pager_isSSD(
181 struct vnode *);
182extern void vnode_pager_throttle(
183 void);
b0d623f7
A
184extern uint32_t vnode_pager_return_hard_throttle_limit(
185 struct vnode *,
186 uint32_t *,
187 uint32_t);
0c530ab8
A
188extern kern_return_t vnode_pager_get_pathname(
189 struct vnode *vp,
190 char *pathname,
191 vm_size_t *length_p);
192extern kern_return_t vnode_pager_get_filename(
193 struct vnode *vp,
2d21ac55
A
194 const char **filename);
195extern kern_return_t vnode_pager_get_cs_blobs(
196 struct vnode *vp,
197 void **blobs);
6d2010ae
A
198
199#if CHECK_CS_VALIDATION_BITMAP
200/* used by the vnode_pager_cs_validation_bitmap routine*/
201#define CS_BITMAP_SET 1
202#define CS_BITMAP_CLEAR 2
203#define CS_BITMAP_CHECK 3
204
205#endif /* CHECK_CS_VALIDATION_BITMAP */
b0d623f7 206
2d21ac55 207extern void vnode_pager_bootstrap(void) __attribute__((section("__TEXT, initcode")));
91447636
A
208extern kern_return_t
209vnode_pager_data_unlock(
210 memory_object_t mem_obj,
211 memory_object_offset_t offset,
b0d623f7 212 memory_object_size_t size,
91447636
A
213 vm_prot_t desired_access);
214extern kern_return_t vnode_pager_init(
215 memory_object_t,
216 memory_object_control_t,
b0d623f7 217 memory_object_cluster_size_t);
91447636
A
218extern kern_return_t vnode_pager_get_object_size(
219 memory_object_t,
220 memory_object_offset_t *);
b0d623f7
A
221extern kern_return_t vnode_pager_get_isinuse(
222 memory_object_t,
223 uint32_t *);
6d2010ae
A
224extern kern_return_t vnode_pager_get_isSSD(
225 memory_object_t,
226 boolean_t *);
b0d623f7
A
227extern kern_return_t vnode_pager_check_hard_throttle(
228 memory_object_t,
229 uint32_t *,
230 uint32_t);
0c530ab8
A
231extern kern_return_t vnode_pager_get_object_pathname(
232 memory_object_t mem_obj,
233 char *pathname,
234 vm_size_t *length_p);
235extern kern_return_t vnode_pager_get_object_filename(
236 memory_object_t mem_obj,
2d21ac55
A
237 const char **filename);
238extern kern_return_t vnode_pager_get_object_cs_blobs(
239 memory_object_t mem_obj,
240 void **blobs);
6d2010ae
A
241
242#if CHECK_CS_VALIDATION_BITMAP
243extern kern_return_t vnode_pager_cs_check_validation_bitmap(
244 memory_object_t mem_obj,
245 memory_object_offset_t offset,
246 int optype);
247#endif /*CHECK_CS_VALIDATION_BITMAP*/
248
249extern kern_return_t ubc_cs_check_validation_bitmap (
250 struct vnode *vp,
251 memory_object_offset_t offset,
252 int optype);
253
91447636
A
254extern kern_return_t vnode_pager_data_request(
255 memory_object_t,
2d21ac55 256 memory_object_offset_t,
b0d623f7 257 memory_object_cluster_size_t,
2d21ac55
A
258 vm_prot_t,
259 memory_object_fault_info_t);
91447636
A
260extern kern_return_t vnode_pager_data_return(
261 memory_object_t,
262 memory_object_offset_t,
b0d623f7 263 memory_object_cluster_size_t,
91447636
A
264 memory_object_offset_t *,
265 int *,
266 boolean_t,
267 boolean_t,
268 int);
269extern kern_return_t vnode_pager_data_initialize(
270 memory_object_t,
271 memory_object_offset_t,
b0d623f7 272 memory_object_cluster_size_t);
91447636
A
273extern void vnode_pager_reference(
274 memory_object_t mem_obj);
275extern kern_return_t vnode_pager_synchronize(
276 memory_object_t mem_obj,
277 memory_object_offset_t offset,
b0d623f7 278 memory_object_size_t length,
91447636 279 vm_sync_t sync_flags);
593a1d5f
A
280extern kern_return_t vnode_pager_map(
281 memory_object_t mem_obj,
282 vm_prot_t prot);
283extern kern_return_t vnode_pager_last_unmap(
91447636
A
284 memory_object_t mem_obj);
285extern void vnode_pager_deallocate(
286 memory_object_t);
287extern kern_return_t vnode_pager_terminate(
288 memory_object_t);
289extern void vnode_pager_vrele(
290 struct vnode *vp);
291extern void vnode_pager_release_from_cache(
292 int *);
593a1d5f
A
293extern int ubc_map(
294 struct vnode *vp,
295 int flags);
91447636
A
296extern void ubc_unmap(
297 struct vnode *vp);
298
b0d623f7
A
299struct vm_map_entry;
300extern struct vm_object *find_vnode_object(struct vm_map_entry *entry);
301
91447636
A
302extern void dp_memory_object_reference(memory_object_t);
303extern void dp_memory_object_deallocate(memory_object_t);
304#ifndef _memory_object_server_
305extern kern_return_t dp_memory_object_init(memory_object_t,
306 memory_object_control_t,
b0d623f7 307 memory_object_cluster_size_t);
91447636
A
308extern kern_return_t dp_memory_object_terminate(memory_object_t);
309extern kern_return_t dp_memory_object_data_request(memory_object_t,
2d21ac55 310 memory_object_offset_t,
b0d623f7 311 memory_object_cluster_size_t,
2d21ac55
A
312 vm_prot_t,
313 memory_object_fault_info_t);
91447636
A
314extern kern_return_t dp_memory_object_data_return(memory_object_t,
315 memory_object_offset_t,
b0d623f7
A
316 memory_object_cluster_size_t,
317 memory_object_offset_t *,
91447636
A
318 int *,
319 boolean_t,
320 boolean_t,
321 int);
322extern kern_return_t dp_memory_object_data_initialize(memory_object_t,
323 memory_object_offset_t,
b0d623f7 324 memory_object_cluster_size_t);
91447636
A
325extern kern_return_t dp_memory_object_data_unlock(memory_object_t,
326 memory_object_offset_t,
b0d623f7 327 memory_object_size_t,
91447636
A
328 vm_prot_t);
329extern kern_return_t dp_memory_object_synchronize(memory_object_t,
330 memory_object_offset_t,
b0d623f7 331 memory_object_size_t,
91447636 332 vm_sync_t);
593a1d5f
A
333extern kern_return_t dp_memory_object_map(memory_object_t,
334 vm_prot_t);
335extern kern_return_t dp_memory_object_last_unmap(memory_object_t);
91447636
A
336#endif /* _memory_object_server_ */
337#ifndef _memory_object_default_server_
338extern kern_return_t default_pager_memory_object_create(
339 memory_object_default_t,
340 vm_size_t,
341 memory_object_t *);
342#endif /* _memory_object_default_server_ */
343
6d2010ae
A
344#if CONFIG_FREEZE
345extern unsigned int default_pager_swap_pages_free(void);
346#endif
347
91447636
A
348extern void device_pager_reference(memory_object_t);
349extern void device_pager_deallocate(memory_object_t);
350extern kern_return_t device_pager_init(memory_object_t,
351 memory_object_control_t,
b0d623f7 352 memory_object_cluster_size_t);
91447636
A
353extern kern_return_t device_pager_terminate(memory_object_t);
354extern kern_return_t device_pager_data_request(memory_object_t,
355 memory_object_offset_t,
b0d623f7 356 memory_object_cluster_size_t,
2d21ac55
A
357 vm_prot_t,
358 memory_object_fault_info_t);
91447636
A
359extern kern_return_t device_pager_data_return(memory_object_t,
360 memory_object_offset_t,
b0d623f7 361 memory_object_cluster_size_t,
0c530ab8
A
362 memory_object_offset_t *,
363 int *,
91447636
A
364 boolean_t,
365 boolean_t,
366 int);
367extern kern_return_t device_pager_data_initialize(memory_object_t,
368 memory_object_offset_t,
b0d623f7 369 memory_object_cluster_size_t);
91447636
A
370extern kern_return_t device_pager_data_unlock(memory_object_t,
371 memory_object_offset_t,
b0d623f7 372 memory_object_size_t,
91447636
A
373 vm_prot_t);
374extern kern_return_t device_pager_synchronize(memory_object_t,
375 memory_object_offset_t,
b0d623f7 376 memory_object_size_t,
91447636 377 vm_sync_t);
593a1d5f
A
378extern kern_return_t device_pager_map(memory_object_t, vm_prot_t);
379extern kern_return_t device_pager_last_unmap(memory_object_t);
91447636
A
380extern kern_return_t device_pager_populate_object(
381 memory_object_t device,
382 memory_object_offset_t offset,
383 ppnum_t page_num,
384 vm_size_t size);
385extern memory_object_t device_pager_setup(
386 memory_object_t,
b0d623f7 387 uintptr_t,
91447636
A
388 vm_size_t,
389 int);
2d21ac55 390extern void device_pager_bootstrap(void) __attribute__((section("__TEXT, initcode")));
91447636
A
391
392extern kern_return_t memory_object_create_named(
393 memory_object_t pager,
394 memory_object_offset_t size,
395 memory_object_control_t *control);
396
b0d623f7
A
397struct macx_triggers_args;
398extern int mach_macx_triggers(
399 struct macx_triggers_args *args);
91447636
A
400
401extern int macx_swapinfo(
402 memory_object_size_t *total_p,
403 memory_object_size_t *avail_p,
404 vm_size_t *pagesize_p,
405 boolean_t *encrypted_p);
406
2d21ac55 407extern void log_stack_execution_failure(addr64_t vaddr, vm_prot_t prot);
b0d623f7
A
408extern void log_unnest_badness(vm_map_t, vm_map_offset_t, vm_map_offset_t);
409
410extern int cs_allow_invalid(struct proc *p);
593a1d5f 411extern int cs_invalid_page(addr64_t vaddr);
2d21ac55
A
412extern boolean_t cs_validate_page(void *blobs,
413 memory_object_offset_t offset,
414 const void *data,
415 boolean_t *tainted);
416
417extern kern_return_t mach_memory_entry_purgable_control(
418 ipc_port_t entry_port,
419 vm_purgable_t control,
420 int *state);
421
422extern kern_return_t mach_memory_entry_page_op(
423 ipc_port_t entry_port,
424 vm_object_offset_t offset,
425 int ops,
426 ppnum_t *phys_entry,
427 int *flags);
428
429extern kern_return_t mach_memory_entry_range_op(
430 ipc_port_t entry_port,
431 vm_object_offset_t offset_beg,
432 vm_object_offset_t offset_end,
433 int ops,
434 int *range);
435
436extern void mach_memory_entry_port_release(ipc_port_t port);
437extern void mach_destroy_memory_entry(ipc_port_t port);
438extern kern_return_t mach_memory_entry_allocate(
439 struct vm_named_entry **user_entry_p,
440 ipc_port_t *user_handle_p);
441
442extern void vm_paging_map_init(void);
0c530ab8 443
b0d623f7
A
444extern int macx_backing_store_compaction(int flags);
445extern unsigned int mach_vm_ctl_page_free_wanted(void);
446
447extern void no_paging_space_action(void);
6d2010ae
A
448
449#define VM_TOGGLE_CLEAR 0
450#define VM_TOGGLE_SET 1
451#define VM_TOGGLE_GETVALUE 999
452int vm_toggle_entry_reuse(int, int*);
91447636
A
453#endif /* _VM_VM_PROTOS_H_ */
454
455#endif /* XNU_KERNEL_PRIVATE */