osfmk/vm/vm_fault.h

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