xref: /xnu-12377.41.6/osfmk/vm/vm_fault.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1 /*
2  * Copyright (c) 2000-2020 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,1990,1989,1988,1987 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 "AS IS"
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 Mellon
54  * the rights to redistribute these changes.
55  */
56 /*
57  */
58 /*
59  *	File:	vm/vm_fault.h
60  *
61  *	Page fault handling module declarations.
62  */
63 
64 #ifndef _VM_VM_FAULT_H_
65 #define _VM_VM_FAULT_H_
66 
67 #include <mach/mach_types.h>
68 #include <mach/kern_return.h>
69 #include <mach/boolean.h>
70 #include <mach/vm_prot.h>
71 #include <mach/vm_param.h>
72 #include <mach/vm_behavior.h>
73 
74 #if XNU_KERNEL_PRIVATE
75 
76 __enum_closed_decl(vm_fault_return_t, int, {
77 	VM_FAULT_SUCCESS            = 0,
78 	VM_FAULT_RETRY              = 1,
79 	VM_FAULT_INTERRUPTED        = 2,
80 	VM_FAULT_MEMORY_SHORTAGE    = 3,
81 	VM_FAULT_MEMORY_ERROR       = 5,
82 	/* success but no VM page */
83 	VM_FAULT_SUCCESS_NO_VM_PAGE = 6,
84 	VM_FAULT_BUSY               = 7,
85 });
86 
87 #endif /* XNU_KERNEL_PRIVATE */
88 
89 #if KERNEL_PRIVATE
90 /*
91  *	Page fault handling based on vm_map (or entries therein)
92  */
93 
94 extern kern_return_t vm_fault(
95 	vm_map_t        map,
96 	vm_map_offset_t vaddr,
97 	vm_prot_t       fault_type,
98 	boolean_t       change_wiring,
99 #if XNU_KERNEL_PRIVATE
100 	vm_tag_t        wire_tag,                   /* if wiring must pass tag != VM_KERN_MEMORY_NONE */
101 #endif
102 	int             interruptible,
103 	pmap_t          pmap,
104 	vm_map_offset_t pmap_addr)
105 #if XNU_KERNEL_PRIVATE
106 __XNU_INTERNAL(vm_fault)
107 #endif
108 ;
109 
110 extern kern_return_t vm_pre_fault(
111 	vm_map_offset_t offset,
112 	vm_prot_t       prot);
113 
114 #endif  /* KERNEL_PRIVATE */
115 
116 #endif  /* _VM_VM_FAULT_H_ */
117