]> git.saurik.com Git - apple/xnu.git/blame - osfmk/vm/vm_protos.h
xnu-2782.1.97.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 */
91447636
A
71#ifndef _IPC_IPC_PORT_H_
72extern mach_port_name_t ipc_port_copyout_send(
73 ipc_port_t sright,
74 ipc_space_t space);
75extern task_t port_name_to_task(
76 mach_port_name_t name);
77#endif /* _IPC_IPC_PORT_H_ */
78
79extern ipc_space_t get_task_ipcspace(
80 task_t t);
81
82/* Some loose-ends VM stuff */
83
84extern vm_map_t kalloc_map;
85extern vm_size_t msg_ool_size_small;
86extern vm_map_t zone_map;
87
88extern void consider_machine_adjust(void);
89extern pmap_t get_map_pmap(vm_map_t);
90extern vm_map_offset_t get_map_min(vm_map_t);
91extern vm_map_offset_t get_map_max(vm_map_t);
92extern vm_map_size_t get_vmmap_size(vm_map_t);
93extern int get_vmmap_entries(vm_map_t);
94
39236c6e
A
95int vm_map_page_mask(vm_map_t);
96
91447636
A
97extern boolean_t coredumpok(vm_map_t map, vm_offset_t va);
98
99/*
100 * VM routines that used to be published to
101 * user space, and are now restricted to the kernel.
102 *
103 * They should eventually go away entirely -
104 * to be replaced with standard vm_map() and
105 * vm_deallocate() calls.
106 */
107
108extern kern_return_t vm_upl_map
109(
110 vm_map_t target_task,
111 upl_t upl,
112 vm_address_t *address
113);
114
115extern kern_return_t vm_upl_unmap
116(
117 vm_map_t target_task,
118 upl_t upl
119);
120
121extern kern_return_t vm_region_object_create
122(
123 vm_map_t target_task,
124 vm_size_t size,
125 ipc_port_t *object_handle
126);
127
128extern mach_vm_offset_t mach_get_vm_start(vm_map_t);
129extern mach_vm_offset_t mach_get_vm_end(vm_map_t);
130
593a1d5f
A
131#if CONFIG_CODE_DECRYPTION
132struct pager_crypt_info;
0c530ab8 133extern kern_return_t vm_map_apple_protected(
593a1d5f
A
134 vm_map_t map,
135 vm_map_offset_t start,
136 vm_map_offset_t end,
137 struct pager_crypt_info *crypt_info);
0c530ab8 138extern void apple_protect_pager_bootstrap(void);
593a1d5f
A
139extern memory_object_t apple_protect_pager_setup(vm_object_t backing_object,
140 struct pager_crypt_info *crypt_info);
141#endif /* CONFIG_CODE_DECRYPTION */
0c530ab8 142
b0d623f7
A
143struct vnode;
144extern void swapfile_pager_bootstrap(void);
145extern memory_object_t swapfile_pager_setup(struct vnode *vp);
146extern memory_object_control_t swapfile_pager_control(memory_object_t mem_obj);
147
91447636
A
148
149/*
150 * bsd
151 */
152struct vnode;
91447636
A
153extern void vnode_pager_shutdown(void);
154extern void *upl_get_internal_page_list(
155 upl_t upl);
b0d623f7 156
fe8ab488
A
157extern void vnode_setswapmount(struct vnode *);
158
91447636
A
159typedef int pager_return_t;
160extern pager_return_t vnode_pagein(
161 struct vnode *, upl_t,
b0d623f7
A
162 upl_offset_t, vm_object_offset_t,
163 upl_size_t, int, int *);
91447636
A
164extern pager_return_t vnode_pageout(
165 struct vnode *, upl_t,
b0d623f7
A
166 upl_offset_t, vm_object_offset_t,
167 upl_size_t, int, int *);
6d2010ae 168extern uint32_t vnode_trim (struct vnode *, int64_t offset, unsigned long len);
91447636
A
169extern memory_object_t vnode_pager_setup(
170 struct vnode *, memory_object_t);
171extern vm_object_offset_t vnode_pager_get_filesize(
172 struct vnode *);
b0d623f7
A
173extern uint32_t vnode_pager_isinuse(
174 struct vnode *);
6d2010ae
A
175extern boolean_t vnode_pager_isSSD(
176 struct vnode *);
177extern void vnode_pager_throttle(
178 void);
39236c6e 179extern uint32_t vnode_pager_return_throttle_io_limit(
b0d623f7 180 struct vnode *,
39236c6e 181 uint32_t *);
15129b1c 182extern kern_return_t vnode_pager_get_name(
0c530ab8
A
183 struct vnode *vp,
184 char *pathname,
15129b1c
A
185 vm_size_t pathname_len,
186 char *filename,
187 vm_size_t filename_len,
188 boolean_t *truncated_path_p);
189struct timespec;
190extern kern_return_t vnode_pager_get_mtime(
0c530ab8 191 struct vnode *vp,
15129b1c
A
192 struct timespec *mtime,
193 struct timespec *cs_mtime);
2d21ac55
A
194extern kern_return_t vnode_pager_get_cs_blobs(
195 struct vnode *vp,
196 void **blobs);
6d2010ae 197
fe8ab488
A
198#if CONFIG_IOSCHED
199void vnode_pager_issue_reprioritize_io(
200 struct vnode *devvp,
201 uint64_t blkno,
202 uint32_t len,
203 int priority);
204#endif
205
6d2010ae
A
206#if CHECK_CS_VALIDATION_BITMAP
207/* used by the vnode_pager_cs_validation_bitmap routine*/
208#define CS_BITMAP_SET 1
209#define CS_BITMAP_CLEAR 2
210#define CS_BITMAP_CHECK 3
211
212#endif /* CHECK_CS_VALIDATION_BITMAP */
b0d623f7 213
39236c6e 214extern void vnode_pager_bootstrap(void);
91447636
A
215extern kern_return_t
216vnode_pager_data_unlock(
217 memory_object_t mem_obj,
218 memory_object_offset_t offset,
b0d623f7 219 memory_object_size_t size,
91447636
A
220 vm_prot_t desired_access);
221extern kern_return_t vnode_pager_init(
222 memory_object_t,
223 memory_object_control_t,
b0d623f7 224 memory_object_cluster_size_t);
91447636
A
225extern kern_return_t vnode_pager_get_object_size(
226 memory_object_t,
227 memory_object_offset_t *);
fe8ab488
A
228
229#if CONFIG_IOSCHED
230extern kern_return_t vnode_pager_get_object_devvp(
231 memory_object_t,
232 uintptr_t *);
233#endif
234
b0d623f7
A
235extern kern_return_t vnode_pager_get_isinuse(
236 memory_object_t,
237 uint32_t *);
6d2010ae
A
238extern kern_return_t vnode_pager_get_isSSD(
239 memory_object_t,
240 boolean_t *);
39236c6e 241extern kern_return_t vnode_pager_get_throttle_io_limit(
b0d623f7 242 memory_object_t,
39236c6e 243 uint32_t *);
15129b1c 244extern kern_return_t vnode_pager_get_object_name(
0c530ab8
A
245 memory_object_t mem_obj,
246 char *pathname,
15129b1c
A
247 vm_size_t pathname_len,
248 char *filename,
249 vm_size_t filename_len,
250 boolean_t *truncated_path_p);
251extern kern_return_t vnode_pager_get_object_mtime(
0c530ab8 252 memory_object_t mem_obj,
15129b1c
A
253 struct timespec *mtime,
254 struct timespec *cs_mtime);
2d21ac55
A
255extern kern_return_t vnode_pager_get_object_cs_blobs(
256 memory_object_t mem_obj,
257 void **blobs);
6d2010ae
A
258
259#if CHECK_CS_VALIDATION_BITMAP
260extern kern_return_t vnode_pager_cs_check_validation_bitmap(
261 memory_object_t mem_obj,
262 memory_object_offset_t offset,
263 int optype);
264#endif /*CHECK_CS_VALIDATION_BITMAP*/
265
266extern kern_return_t ubc_cs_check_validation_bitmap (
267 struct vnode *vp,
268 memory_object_offset_t offset,
269 int optype);
270
91447636
A
271extern kern_return_t vnode_pager_data_request(
272 memory_object_t,
2d21ac55 273 memory_object_offset_t,
b0d623f7 274 memory_object_cluster_size_t,
2d21ac55
A
275 vm_prot_t,
276 memory_object_fault_info_t);
91447636
A
277extern kern_return_t vnode_pager_data_return(
278 memory_object_t,
279 memory_object_offset_t,
b0d623f7 280 memory_object_cluster_size_t,
91447636
A
281 memory_object_offset_t *,
282 int *,
283 boolean_t,
284 boolean_t,
285 int);
286extern kern_return_t vnode_pager_data_initialize(
287 memory_object_t,
288 memory_object_offset_t,
b0d623f7 289 memory_object_cluster_size_t);
91447636
A
290extern void vnode_pager_reference(
291 memory_object_t mem_obj);
292extern kern_return_t vnode_pager_synchronize(
293 memory_object_t mem_obj,
294 memory_object_offset_t offset,
b0d623f7 295 memory_object_size_t length,
91447636 296 vm_sync_t sync_flags);
593a1d5f
A
297extern kern_return_t vnode_pager_map(
298 memory_object_t mem_obj,
299 vm_prot_t prot);
300extern kern_return_t vnode_pager_last_unmap(
91447636
A
301 memory_object_t mem_obj);
302extern void vnode_pager_deallocate(
303 memory_object_t);
304extern kern_return_t vnode_pager_terminate(
305 memory_object_t);
306extern void vnode_pager_vrele(
307 struct vnode *vp);
308extern void vnode_pager_release_from_cache(
309 int *);
593a1d5f
A
310extern int ubc_map(
311 struct vnode *vp,
312 int flags);
91447636
A
313extern void ubc_unmap(
314 struct vnode *vp);
315
b0d623f7
A
316struct vm_map_entry;
317extern struct vm_object *find_vnode_object(struct vm_map_entry *entry);
318
91447636
A
319extern void dp_memory_object_reference(memory_object_t);
320extern void dp_memory_object_deallocate(memory_object_t);
321#ifndef _memory_object_server_
322extern kern_return_t dp_memory_object_init(memory_object_t,
323 memory_object_control_t,
b0d623f7 324 memory_object_cluster_size_t);
91447636
A
325extern kern_return_t dp_memory_object_terminate(memory_object_t);
326extern kern_return_t dp_memory_object_data_request(memory_object_t,
2d21ac55 327 memory_object_offset_t,
b0d623f7 328 memory_object_cluster_size_t,
2d21ac55
A
329 vm_prot_t,
330 memory_object_fault_info_t);
91447636
A
331extern kern_return_t dp_memory_object_data_return(memory_object_t,
332 memory_object_offset_t,
b0d623f7
A
333 memory_object_cluster_size_t,
334 memory_object_offset_t *,
91447636
A
335 int *,
336 boolean_t,
337 boolean_t,
338 int);
339extern kern_return_t dp_memory_object_data_initialize(memory_object_t,
340 memory_object_offset_t,
b0d623f7 341 memory_object_cluster_size_t);
91447636
A
342extern kern_return_t dp_memory_object_data_unlock(memory_object_t,
343 memory_object_offset_t,
b0d623f7 344 memory_object_size_t,
91447636
A
345 vm_prot_t);
346extern kern_return_t dp_memory_object_synchronize(memory_object_t,
347 memory_object_offset_t,
b0d623f7 348 memory_object_size_t,
91447636 349 vm_sync_t);
593a1d5f
A
350extern kern_return_t dp_memory_object_map(memory_object_t,
351 vm_prot_t);
352extern kern_return_t dp_memory_object_last_unmap(memory_object_t);
91447636
A
353#endif /* _memory_object_server_ */
354#ifndef _memory_object_default_server_
355extern kern_return_t default_pager_memory_object_create(
356 memory_object_default_t,
357 vm_size_t,
358 memory_object_t *);
359#endif /* _memory_object_default_server_ */
360
6d2010ae
A
361#if CONFIG_FREEZE
362extern unsigned int default_pager_swap_pages_free(void);
316670eb
A
363struct default_freezer_handle;
364struct vm_page;
365__private_extern__ void default_freezer_init(void);
366__private_extern__ struct default_freezer_handle* default_freezer_handle_allocate(void);
367__private_extern__ kern_return_t
368default_freezer_handle_init(
369 struct default_freezer_handle *df_handle);
370__private_extern__ void
371default_freezer_handle_deallocate(
372 struct default_freezer_handle *df_handle);
373__private_extern__ void
374default_freezer_pageout(
375 struct default_freezer_handle *df_handle);
376__private_extern__ kern_return_t
377default_freezer_pack(
378 unsigned int *purgeable_count,
379 unsigned int *wired_count,
380 unsigned int *clean_count,
381 unsigned int *dirty_count,
382 unsigned int dirty_budget,
383 boolean_t *shared,
384 vm_object_t src_object,
385 struct default_freezer_handle *df_handle);
39236c6e 386__private_extern__ kern_return_t
316670eb
A
387default_freezer_unpack(
388 struct default_freezer_handle *df_handle);
389__private_extern__ void
390default_freezer_pack_page(
391 struct vm_page* p,
392 struct default_freezer_handle *df_handle);
393
394#endif /* CONFIG_FREEZE */
6d2010ae 395
91447636
A
396extern void device_pager_reference(memory_object_t);
397extern void device_pager_deallocate(memory_object_t);
398extern kern_return_t device_pager_init(memory_object_t,
399 memory_object_control_t,
b0d623f7 400 memory_object_cluster_size_t);
91447636
A
401extern kern_return_t device_pager_terminate(memory_object_t);
402extern kern_return_t device_pager_data_request(memory_object_t,
403 memory_object_offset_t,
b0d623f7 404 memory_object_cluster_size_t,
2d21ac55
A
405 vm_prot_t,
406 memory_object_fault_info_t);
91447636
A
407extern kern_return_t device_pager_data_return(memory_object_t,
408 memory_object_offset_t,
b0d623f7 409 memory_object_cluster_size_t,
0c530ab8
A
410 memory_object_offset_t *,
411 int *,
91447636
A
412 boolean_t,
413 boolean_t,
414 int);
415extern kern_return_t device_pager_data_initialize(memory_object_t,
416 memory_object_offset_t,
b0d623f7 417 memory_object_cluster_size_t);
91447636
A
418extern kern_return_t device_pager_data_unlock(memory_object_t,
419 memory_object_offset_t,
b0d623f7 420 memory_object_size_t,
91447636
A
421 vm_prot_t);
422extern kern_return_t device_pager_synchronize(memory_object_t,
423 memory_object_offset_t,
b0d623f7 424 memory_object_size_t,
91447636 425 vm_sync_t);
593a1d5f
A
426extern kern_return_t device_pager_map(memory_object_t, vm_prot_t);
427extern kern_return_t device_pager_last_unmap(memory_object_t);
91447636
A
428extern kern_return_t device_pager_populate_object(
429 memory_object_t device,
430 memory_object_offset_t offset,
431 ppnum_t page_num,
432 vm_size_t size);
433extern memory_object_t device_pager_setup(
434 memory_object_t,
b0d623f7 435 uintptr_t,
91447636
A
436 vm_size_t,
437 int);
39236c6e
A
438extern void device_pager_bootstrap(void);
439
440extern kern_return_t pager_map_to_phys_contiguous(
441 memory_object_control_t object,
442 memory_object_offset_t offset,
443 addr64_t base_vaddr,
444 vm_size_t size);
91447636
A
445
446extern kern_return_t memory_object_create_named(
447 memory_object_t pager,
448 memory_object_offset_t size,
449 memory_object_control_t *control);
450
b0d623f7
A
451struct macx_triggers_args;
452extern int mach_macx_triggers(
453 struct macx_triggers_args *args);
91447636
A
454
455extern int macx_swapinfo(
456 memory_object_size_t *total_p,
457 memory_object_size_t *avail_p,
458 vm_size_t *pagesize_p,
459 boolean_t *encrypted_p);
460
2d21ac55 461extern void log_stack_execution_failure(addr64_t vaddr, vm_prot_t prot);
b0d623f7
A
462extern void log_unnest_badness(vm_map_t, vm_map_offset_t, vm_map_offset_t);
463
39236c6e 464struct proc;
b0d623f7 465extern int cs_allow_invalid(struct proc *p);
593a1d5f 466extern int cs_invalid_page(addr64_t vaddr);
2d21ac55 467extern boolean_t cs_validate_page(void *blobs,
316670eb 468 memory_object_t pager,
2d21ac55
A
469 memory_object_offset_t offset,
470 const void *data,
471 boolean_t *tainted);
472
473extern kern_return_t mach_memory_entry_purgable_control(
474 ipc_port_t entry_port,
475 vm_purgable_t control,
476 int *state);
477
39236c6e
A
478extern kern_return_t mach_memory_entry_get_page_counts(
479 ipc_port_t entry_port,
480 unsigned int *resident_page_count,
481 unsigned int *dirty_page_count);
482
2d21ac55
A
483extern kern_return_t mach_memory_entry_page_op(
484 ipc_port_t entry_port,
485 vm_object_offset_t offset,
486 int ops,
487 ppnum_t *phys_entry,
488 int *flags);
489
490extern kern_return_t mach_memory_entry_range_op(
491 ipc_port_t entry_port,
492 vm_object_offset_t offset_beg,
493 vm_object_offset_t offset_end,
494 int ops,
495 int *range);
496
497extern void mach_memory_entry_port_release(ipc_port_t port);
498extern void mach_destroy_memory_entry(ipc_port_t port);
499extern kern_return_t mach_memory_entry_allocate(
500 struct vm_named_entry **user_entry_p,
501 ipc_port_t *user_handle_p);
502
503extern void vm_paging_map_init(void);
0c530ab8 504
b0d623f7
A
505extern int macx_backing_store_compaction(int flags);
506extern unsigned int mach_vm_ctl_page_free_wanted(void);
507
fe8ab488 508extern int no_paging_space_action(void);
6d2010ae
A
509
510#define VM_TOGGLE_CLEAR 0
511#define VM_TOGGLE_SET 1
512#define VM_TOGGLE_GETVALUE 999
513int vm_toggle_entry_reuse(int, int*);
39236c6e
A
514
515#define SWAP_WRITE 0x00000000 /* Write buffer (pseudo flag). */
516#define SWAP_READ 0x00000001 /* Read buffer. */
517#define SWAP_ASYNC 0x00000002 /* Start I/O, do not wait. */
518
519extern void vm_compressor_pager_init(void);
520extern kern_return_t compressor_memory_object_create(
22ba694c 521 memory_object_size_t,
39236c6e
A
522 memory_object_t *);
523
fe8ab488
A
524#if CONFIG_JETSAM
525extern int proc_get_memstat_priority(struct proc*, boolean_t);
526#endif /* CONFIG_JETSAM */
527
39236c6e
A
528/* the object purger. purges the next eligible object from memory. */
529/* returns TRUE if an object was purged, otherwise FALSE. */
530boolean_t vm_purgeable_object_purge_one_unlocked(int force_purge_below_group);
fe8ab488 531void vm_purgeable_disown(task_t task);
39236c6e
A
532
533struct trim_list {
534 uint64_t tl_offset;
535 uint64_t tl_length;
536 struct trim_list *tl_next;
537};
538
fe8ab488
A
539u_int32_t vnode_trim_list(struct vnode *vp, struct trim_list *tl, boolean_t route_only);
540
541#define MAX_SWAPFILENAME_LEN 1024
542#define SWAPFILENAME_INDEX_LEN 2 /* Doesn't include the terminating NULL character */
543
544extern char swapfilename[MAX_SWAPFILENAME_LEN + 1];
545
546struct vm_counters {
547 unsigned int do_collapse_compressor;
548 unsigned int do_collapse_compressor_pages;
549 unsigned int do_collapse_terminate;
550 unsigned int do_collapse_terminate_failure;
551 unsigned int should_cow_but_wired;
552 unsigned int create_upl_extra_cow;
553 unsigned int create_upl_extra_cow_pages;
554 unsigned int create_upl_lookup_failure_write;
555 unsigned int create_upl_lookup_failure_copy;
556};
557extern struct vm_counters vm_counters;
39236c6e 558
91447636
A
559#endif /* _VM_VM_PROTOS_H_ */
560
561#endif /* XNU_KERNEL_PRIVATE */