osfmk/vm/vm_fault.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * @OSF_COPYRIGHT@
  25  */
  26 /*
  27  * Mach Operating System
  28  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  29  * All Rights Reserved.
  30  *
  31  * Permission to use, copy, modify and distribute this software and its
  32  * documentation is hereby granted, provided that both the copyright
  33  * notice and this permission notice appear in all copies of the
  34  * software, derivative works or modified versions, and any portions
  35  * thereof, and that both notices appear in supporting documentation.
  36  *
  37  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  38  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  39  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  40  *
  41  * Carnegie Mellon requests users of this software to return to
  42  *
  43  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  44  *  School of Computer Science
  45  *  Carnegie Mellon University
  46  *  Pittsburgh PA 15213-3890
  47  *
  48  * any improvements or extensions that they make and grant Carnegie Mellon
  49  * the rights to redistribute these changes.
  50  */
  51 /*
  52  */
  53 /*
  54  *      File:   vm/vm_fault.h
  55  *
  56  *      Page fault handling module declarations.
  57  */
  58
  59 #ifndef _VM_VM_FAULT_H_
  60 #define _VM_VM_FAULT_H_
  61
  62 #include <mach/mach_types.h>
  63 #include <mach/kern_return.h>
  64 #include <mach/boolean.h>
  65 #include <mach/vm_prot.h>
  66 #include <mach/vm_param.h>
  67 #include <mach/vm_behavior.h>
  68
  69 #ifdef  KERNEL_PRIVATE
  70
  71 typedef kern_return_t   vm_fault_return_t;
  72
  73 #define VM_FAULT_SUCCESS                0
  74 #define VM_FAULT_RETRY                  1
  75 #define VM_FAULT_INTERRUPTED            2
  76 #define VM_FAULT_MEMORY_SHORTAGE        3
  77 #define VM_FAULT_FICTITIOUS_SHORTAGE    4
  78 #define VM_FAULT_MEMORY_ERROR           5
  79
  80 /*
  81  *      Page fault handling based on vm_map (or entries therein)
  82  */
  83
  84 extern kern_return_t vm_fault(
  85                 vm_map_t        map,
  86                 vm_map_offset_t vaddr,
  87                 vm_prot_t       fault_type,
  88                 boolean_t       change_wiring,
  89                 int             interruptible,
  90                 pmap_t          pmap,
  91                 vm_map_offset_t pmap_addr);
  92
  93 #ifdef  MACH_KERNEL_PRIVATE
  94
  95 #include <vm/vm_page.h>
  96 #include <vm/vm_object.h>
  97 #include <vm/vm_map.h>
  98
  99 extern void vm_fault_init(void);
 100
 101 /*
 102  *      Page fault handling based on vm_object only.
 103  */
 104
 105 extern vm_fault_return_t vm_fault_page(
 106                 /* Arguments: */
 107                 vm_object_t     first_object,   /* Object to begin search */
 108                 vm_object_offset_t first_offset,/* Offset into object */
 109                 vm_prot_t       fault_type,     /* What access is requested */
 110                 boolean_t       must_be_resident,/* Must page be resident? */
 111                 int             interruptible,/* how may fault be interrupted */
 112                 vm_map_offset_t lo_offset,      /* Map entry start */
 113                 vm_map_offset_t hi_offset,      /* Map entry end */
 114                 vm_behavior_t   behavior,       /* Expected paging behavior */
 115                 /* Modifies in place: */
 116                 vm_prot_t       *protection,    /* Protection for mapping */
 117                 /* Returns: */
 118                 vm_page_t       *result_page,   /* Page found, if successful */
 119                 vm_page_t       *top_page,      /* Page in top object, if
 120                                                  * not result_page.  */
 121                 int             *type_of_fault, /* if non-zero, return COW, zero-filled, etc...
 122                                                  * used by kernel trace point in vm_fault */
 123                 /* More arguments: */
 124                 kern_return_t   *error_code,    /* code if page is in error */
 125                 boolean_t       no_zero_fill,   /* don't fill absent pages */
 126                 boolean_t       data_supply,    /* treat as data_supply */
 127                 vm_map_t        map,
 128                 vm_map_offset_t vaddr);
 129
 130 extern void vm_fault_cleanup(
 131                 vm_object_t     object,
 132                 vm_page_t       top_page);
 133
 134 extern kern_return_t vm_fault_wire(
 135                 vm_map_t        map,
 136                 vm_map_entry_t  entry,
 137                 pmap_t          pmap,
 138                 vm_map_offset_t pmap_addr);
 139
 140 extern void vm_fault_unwire(
 141                 vm_map_t        map,
 142                 vm_map_entry_t  entry,
 143                 boolean_t       deallocate,
 144                 pmap_t          pmap,
 145                 vm_map_offset_t pmap_addr);
 146
 147 extern kern_return_t    vm_fault_copy(
 148                 vm_object_t             src_object,
 149                 vm_object_offset_t      src_offset,
 150                 vm_map_size_t           *copy_size,     /* INOUT */
 151                 vm_object_t             dst_object,
 152                 vm_object_offset_t      dst_offset,
 153                 vm_map_t                dst_map,
 154                 vm_map_version_t         *dst_version,
 155                 int                     interruptible);
 156
 157 #endif  /* MACH_KERNEL_PRIVATE */
 158
 159 #endif  /* KERNEL_PRIVATE */
 160
 161 #endif  /* _VM_VM_FAULT_H_ */