sys/vm/pmap.h

   1 /*
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * The Mach Operating System project at Carnegie-Mellon University.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      from: @(#)pmap.h        8.1 (Berkeley) 6/11/93
  37  *
  38  *
  39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  40  * All rights reserved.
  41  *
  42  * Author: Avadis Tevanian, Jr.
  43  *
  44  * Permission to use, copy, modify and distribute this software and
  45  * its documentation is hereby granted, provided that both the copyright
  46  * notice and this permission notice appear in all copies of the
  47  * software, derivative works or modified versions, and any portions
  48  * thereof, and that both notices appear in supporting documentation.
  49  *
  50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  53  *
  54  * Carnegie Mellon requests users of this software to return to
  55  *
  56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  57  *  School of Computer Science
  58  *  Carnegie Mellon University
  59  *  Pittsburgh PA 15213-3890
  60  *
  61  * any improvements or extensions that they make and grant Carnegie the
  62  * rights to redistribute these changes.
  63  *
  64  * $FreeBSD: src/sys/vm/pmap.h,v 1.33.2.4 2002/03/06 22:44:24 silby Exp $
  65  */
  66
  67 /*
  68  *      Machine address mapping definitions -- machine-independent
  69  *      section.  [For machine-dependent section, see "machine/pmap.h".]
  70  */
  71
  72 #ifndef _VM_PMAP_H_
  73 #define _VM_PMAP_H_
  74
  75 #ifndef _SYS_TYPES_H_
  76 #include <sys/types.h>
  77 #endif
  78
  79 #ifndef _SYS_SPINLOCK_H_
  80 #include <sys/spinlock.h>
  81 #endif
  82
  83 #ifndef _MACHINE_PMAP_H_
  84 #include <machine/pmap.h>
  85 #endif
  86
  87 #ifdef _KERNEL
  88
  89 #ifndef _VM_VM_H_
  90 #include <vm/vm.h>
  91 #endif
  92
  93 struct lwp;
  94 struct proc;
  95 struct thread;
  96 struct vm_page;
  97 struct vmspace;
  98 struct vmspace_entry;
  99 struct vm_map_entry;
 100
 101 /*
 102  * Most of these variables represent parameters set up by low level MD kernel
 103  * boot code to be used by higher level MI initialization code to identify
 104  * the portions of kernel and physical memory which are free for allocation.
 105  *
 106  * KvaStart/KvaEnd/     - Reserved Kernel Virtual Memory address space.
 107  * KvaSize                This range represents the entire KVA space but
 108  *                        might omit certain special mapping areas.  It is
 109  *                        used to determine what kernel memory userland has
 110  *                        access to.
 111  *
 112  * virtual_{start,end}  - KVA space available for allocation, not including
 113  *                        KVA space reserved during MD startup.  Used by
 114  *                        the KMEM subsystem, used to initialize kernel_map.
 115  *
 116  * phys_avail[]         - Array of {start,end} physical addresses, not
 117  *                        including physical memory allocated by MD startup
 118  *                        code.  Used to initialize the VM subsystem.
 119  */
 120 extern vm_offset_t KvaStart;
 121 extern vm_offset_t KvaEnd;
 122 extern vm_offset_t KvaSize;
 123 extern vm_offset_t virtual_start;
 124 extern vm_offset_t virtual_end;
 125 extern vm_offset_t virtual2_start;
 126 extern vm_offset_t virtual2_end;
 127 extern vm_paddr_t phys_avail[];
 128
 129 /*
 130  * Return true if the passed address is in the kernel address space.
 131  * This is mainly a check that the address is NOT in the user address space.
 132  *
 133  * For a vkernels all addresses are in the kernel address space.
 134  */
 135 static inline int
 136 kva_p(const void *addr)
 137 {
 138 #ifdef _KERNEL_VIRTUAL
 139         return (addr != NULL);
 140 #else
 141         return ((unsigned long)KvaStart <= (unsigned long)addr) &&
 142                 ((unsigned long)addr < (unsigned long)KvaEnd);
 143 #endif
 144 }
 145
 146 void             pmap_change_wiring (pmap_t, vm_offset_t, boolean_t,
 147                         vm_map_entry_t);
 148 void             pmap_clear_modify (struct vm_page *m);
 149 void             pmap_clear_reference (struct vm_page *m);
 150 void             pmap_collect (void);
 151 void             pmap_copy (pmap_t, pmap_t, vm_offset_t, vm_size_t,
 152                         vm_offset_t);
 153 void             pmap_copy_page (vm_paddr_t, vm_paddr_t);
 154 void             pmap_copy_page_frag (vm_paddr_t, vm_paddr_t, size_t bytes);
 155 void             pmap_enter (pmap_t, vm_offset_t, struct vm_page *,
 156                         vm_prot_t, boolean_t, struct vm_map_entry *);
 157 void             pmap_enter_quick (pmap_t, vm_offset_t, struct vm_page *);
 158 vm_page_t        pmap_fault_page_quick(pmap_t, vm_offset_t, vm_prot_t);
 159 vm_paddr_t       pmap_extract (pmap_t pmap, vm_offset_t va);
 160 void             pmap_growkernel (vm_offset_t, vm_offset_t);
 161 void             pmap_init (void);
 162 boolean_t        pmap_is_modified (struct vm_page *m);
 163 int              pmap_ts_referenced (struct vm_page *m);
 164 vm_offset_t      pmap_map (vm_offset_t *, vm_paddr_t, vm_paddr_t, int);
 165 void             pmap_object_init_pt (pmap_t pmap, vm_offset_t addr,
 166                     vm_prot_t prot, vm_object_t object, vm_pindex_t pindex,
 167                     vm_offset_t size, int pagelimit);
 168 boolean_t        pmap_page_exists_quick (pmap_t pmap, struct vm_page *m);
 169 void             pmap_page_protect (struct vm_page *m, vm_prot_t prot);
 170 void             pmap_page_init (struct vm_page *m);
 171 vm_paddr_t       pmap_phys_address (vm_pindex_t);
 172 void             pmap_pinit (pmap_t);
 173 void             pmap_puninit (pmap_t);
 174 void             pmap_pinit0 (pmap_t);
 175 void             pmap_pinit2 (pmap_t);
 176 void             pmap_protect (pmap_t, vm_offset_t, vm_offset_t, vm_prot_t);
 177 void             pmap_qenter (vm_offset_t, struct vm_page **, int);
 178 void             pmap_qremove (vm_offset_t, int);
 179 void             pmap_kenter (vm_offset_t, vm_paddr_t);
 180 void             pmap_kenter_quick (vm_offset_t, vm_paddr_t);
 181 void             pmap_kenter_sync (vm_offset_t);
 182 void             pmap_kenter_sync_quick (vm_offset_t);
 183 void             pmap_kmodify_rw(vm_offset_t va);
 184 void             pmap_kmodify_nc(vm_offset_t va);
 185 void             pmap_kremove (vm_offset_t);
 186 void             pmap_kremove_quick (vm_offset_t);
 187 void             pmap_reference (pmap_t);
 188 void             pmap_remove (pmap_t, vm_offset_t, vm_offset_t);
 189 void             pmap_remove_pages (pmap_t, vm_offset_t, vm_offset_t);
 190 void             pmap_zero_page (vm_paddr_t);
 191 void             pmap_page_assertzero (vm_paddr_t);
 192 void             pmap_zero_page_area (vm_paddr_t, int off, int size);
 193 int              pmap_prefault_ok (pmap_t, vm_offset_t);
 194 void             pmap_change_attr(vm_offset_t va, vm_size_t count, int mode);
 195 int              pmap_mincore (pmap_t pmap, vm_offset_t addr);
 196 void             pmap_init_proc (struct proc *);
 197 void             pmap_init_thread (struct thread *td);
 198 void             pmap_replacevm (struct proc *, struct vmspace *, int);
 199 void             pmap_setlwpvm (struct lwp *, struct vmspace *);
 200
 201 vm_offset_t      pmap_addr_hint (vm_object_t obj, vm_offset_t addr, vm_size_t size);
 202 void            *pmap_kenter_temporary (vm_paddr_t pa, long i);
 203 void             pmap_init2 (void);
 204 struct vm_page  *pmap_kvtom(vm_offset_t va);
 205 void             pmap_object_init(vm_object_t object);
 206 void             pmap_object_free(vm_object_t object);
 207
 208
 209 #endif /* _KERNEL */
 210
 211 #endif /* _VM_PMAP_H_ */