1/* 2 * Copyright (c) 2000-2004 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 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 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#ifdef KERNEL_PRIVATE 75 76typedef kern_return_t vm_fault_return_t; 77 78#define VM_FAULT_SUCCESS 0 79#define VM_FAULT_RETRY 1 80#define VM_FAULT_INTERRUPTED 2 81#define VM_FAULT_MEMORY_SHORTAGE 3 82#define VM_FAULT_MEMORY_ERROR 5 83#define VM_FAULT_SUCCESS_NO_VM_PAGE 6 /* success but no VM page */ 84 85/* 86 * Page fault handling based on vm_map (or entries therein) 87 */ 88 89extern kern_return_t vm_fault( 90 vm_map_t map, 91 vm_map_offset_t vaddr, 92 vm_prot_t fault_type, 93 boolean_t change_wiring, 94 int interruptible, 95 pmap_t pmap, 96 vm_map_offset_t pmap_addr); 97 98extern void vm_pre_fault(vm_map_offset_t); 99 100#ifdef MACH_KERNEL_PRIVATE 101 102#include <vm/vm_page.h> 103#include <vm/vm_object.h> 104#include <vm/vm_map.h> 105 106extern void vm_fault_init(void); 107 108extern kern_return_t vm_fault_internal( 109 vm_map_t map, 110 vm_map_offset_t vaddr, 111 vm_prot_t fault_type, 112 boolean_t change_wiring, 113 int interruptible, 114 pmap_t pmap, 115 vm_map_offset_t pmap_addr, 116 ppnum_t *physpage_p); 117 118/* 119 * Page fault handling based on vm_object only. 120 */ 121 122extern vm_fault_return_t vm_fault_page( 123 /* Arguments: */ 124 vm_object_t first_object, /* Object to begin search */ 125 vm_object_offset_t first_offset,/* Offset into object */ 126 vm_prot_t fault_type, /* What access is requested */ 127 boolean_t must_be_resident,/* Must page be resident? */ 128 boolean_t caller_lookup, /* caller looked up page */ 129 /* Modifies in place: */ 130 vm_prot_t *protection, /* Protection for mapping */ 131 vm_page_t *result_page, /* Page found, if successful */ 132 /* Returns: */ 133 vm_page_t *top_page, /* Page in top object, if 134 * not result_page. */ 135 int *type_of_fault, /* if non-zero, return COW, zero-filled, etc... 136 * used by kernel trace point in vm_fault */ 137 /* More arguments: */ 138 kern_return_t *error_code, /* code if page is in error */ 139 boolean_t no_zero_fill, /* don't fill absent pages */ 140 boolean_t data_supply, /* treat as data_supply */ 141 vm_object_fault_info_t fault_info); 142 143extern void vm_fault_cleanup( 144 vm_object_t object, 145 vm_page_t top_page); 146 147extern kern_return_t vm_fault_wire( 148 vm_map_t map, 149 vm_map_entry_t entry, 150 pmap_t pmap, 151 vm_map_offset_t pmap_addr, 152 ppnum_t *physpage_p); 153 154extern void vm_fault_unwire( 155 vm_map_t map, 156 vm_map_entry_t entry, 157 boolean_t deallocate, 158 pmap_t pmap, 159 vm_map_offset_t pmap_addr); 160 161extern kern_return_t vm_fault_copy( 162 vm_object_t src_object, 163 vm_object_offset_t src_offset, 164 vm_map_size_t *copy_size, /* INOUT */ 165 vm_object_t dst_object, 166 vm_object_offset_t dst_offset, 167 vm_map_t dst_map, 168 vm_map_version_t *dst_version, 169 int interruptible); 170 171extern kern_return_t vm_fault_enter( 172 vm_page_t m, 173 pmap_t pmap, 174 vm_map_offset_t vaddr, 175 vm_prot_t prot, 176 vm_prot_t fault_type, 177 boolean_t wired, 178 boolean_t change_wiring, 179 boolean_t no_cache, 180 boolean_t cs_bypass, 181 int user_tag, 182 int pmap_options, 183 boolean_t *need_retry, 184 int *type_of_fault); 185 186#endif /* MACH_KERNEL_PRIVATE */ 187 188#endif /* KERNEL_PRIVATE */ 189 190#endif /* _VM_VM_FAULT_H_ */ 191