sys/uvm/uvm_pmap.h

   1 /*      $NetBSD: uvm_pmap.h,v 1.38 2013/02/02 14:06:58 matt Exp $       */
   2
   3 /*
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * The Mach Operating System project at Carnegie-Mellon University.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)pmap.h      8.1 (Berkeley) 6/11/93
  35  *
  36  *
  37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  38  * All rights reserved.
  39  *
  40  * Author: Avadis Tevanian, Jr.
  41  *
  42  * Permission to use, copy, modify and distribute this software and
  43  * its documentation is hereby granted, provided that both the copyright
  44  * notice and this permission notice appear in all copies of the
  45  * software, derivative works or modified versions, and any portions
  46  * thereof, and that both notices appear in supporting documentation.
  47  *
  48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  51  *
  52  * Carnegie Mellon requests users of this software to return to
  53  *
  54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  55  *  School of Computer Science
  56  *  Carnegie Mellon University
  57  *  Pittsburgh PA 15213-3890
  58  *
  59  * any improvements or extensions that they make and grant Carnegie the
  60  * rights to redistribute these changes.
  61  */
  62
  63 /*
  64  *      Machine address mapping definitions -- machine-independent
  65  *      section.  [For machine-dependent section, see "machine/pmap.h".]
  66  */
  67
  68 #ifndef _PMAP_VM_
  69 #define _PMAP_VM_
  70
  71 struct lwp;             /* for pmap_activate()/pmap_deactivate() proto */
  72
  73 struct pmap;
  74 typedef struct pmap *pmap_t;
  75
  76 /*
  77  * Each machine dependent implementation is expected to
  78  * keep certain statistics.  They may do this anyway they
  79  * so choose, but are expected to return the statistics
  80  * in the following structure.
  81  */
  82 struct pmap_statistics {
  83         long            resident_count; /* # of pages mapped (total)*/
  84         long            wired_count;    /* # of pages wired */
  85 };
  86 typedef struct pmap_statistics  *pmap_statistics_t;
  87
  88 #ifdef _KERNEL
  89
  90 extern struct pmap      *const kernel_pmap_ptr;
  91 #define pmap_kernel()   kernel_pmap_ptr
  92
  93 #endif
  94
  95 /*
  96  * Cache Type Encodings
  97  */
  98 #define PMAP_CACHE_MASK         0x00000f00
  99
 100 /* All accesses are uncacheable. No speculative accesses. */
 101 #define PMAP_NOCACHE            0x00000100      /* [BOTH] */
 102
 103 /* All accesses are uncacheable. No speculative accesses.
 104  * Writes are combined. */
 105 #define PMAP_WRITE_COMBINE      0x00000200      /* [BOTH] */
 106
 107 /* On reads, cachelines become shared or exclusive if allocated on cache miss.
 108  * On writes, cachelines become modified on a cache miss.  */
 109 #define PMAP_WRITE_BACK         0x00000300      /* [BOTH] */
 110
 111 /* = PMAP_NOCACHE but overrideable (e.g. on x86 by MTRRs) */
 112 #define PMAP_NOCACHE_OVR        0x00000400      /* [BOTH] */
 113
 114 #ifdef _KERNEL
 115 #include <machine/pmap.h>
 116 #endif
 117
 118 /*
 119  * Flags passed to pmap_enter().  Note the bottom 3 bits are VM_PROT_*
 120  * bits, used to indicate the access type that was made (to seed modified
 121  * and referenced information).
 122  *
 123  * Flags marked [PA] are for pmap_kenter_pa() only.  Flags marked [BOTH]
 124  * apply to pmap_kenter_pa() and pmap_enter().  All other flags are valid
 125  * for pmap_enter() only.
 126  */
 127 #define PMAP_WIRED      0x00000010      /* wired mapping */
 128 #define PMAP_CANFAIL    0x00000020      /* can fail if resource shortage */
 129 #if defined(PMAP_ENABLE_PMAP_KMPAGE)
 130 #define PMAP_KMPAGE     0x00000040      /* [PA] page used for kernel memory */
 131 #else
 132 #define PMAP_KMPAGE     0x00000000
 133 #endif /* PMAP_ENABLE_PMAP_KMPAGE */
 134
 135 #define PMAP_MD_MASK    0xff000000      /* [BOTH] Machine-dependent bits */
 136 #define PMAP_PROT_MASK  0x0000000f      /* [BOTH] VM_PROT_* bit mask */
 137
 138 #ifndef PMAP_EXCLUDE_DECLS      /* Used in Sparc port to virtualize pmap mod */
 139 #ifdef _KERNEL
 140 void            pmap_activate(struct lwp *);
 141 void            pmap_deactivate(struct lwp *);
 142 void            pmap_unwire(pmap_t, vaddr_t);
 143
 144 #if !defined(pmap_clear_modify)
 145 bool            pmap_clear_modify(struct vm_page *);
 146 #endif
 147 #if !defined(pmap_clear_reference)
 148 bool            pmap_clear_reference(struct vm_page *);
 149 #endif
 150
 151 #if !defined(pmap_copy)
 152 void            pmap_copy(pmap_t, pmap_t, vaddr_t, vsize_t, vaddr_t);
 153 #endif
 154 #if !defined(pmap_copy_page)
 155 void            pmap_copy_page(paddr_t, paddr_t);
 156 #endif
 157 struct pmap     *pmap_create(void);
 158 void            pmap_destroy(pmap_t);
 159 int             pmap_enter(pmap_t, vaddr_t, paddr_t, vm_prot_t, u_int);
 160 bool            pmap_extract(pmap_t, vaddr_t, paddr_t *);
 161 #if defined(PMAP_GROWKERNEL)
 162 vaddr_t         pmap_growkernel(vaddr_t);
 163 #endif
 164
 165 void            pmap_init(void);
 166
 167 #if !defined(pmap_kenter_pa)
 168 void            pmap_kenter_pa(vaddr_t, paddr_t, vm_prot_t, u_int);
 169 #endif
 170 void            pmap_kremove(vaddr_t, vsize_t);
 171 #if !defined(pmap_is_modified)
 172 bool            pmap_is_modified(struct vm_page *);
 173 #endif
 174 #if !defined(pmap_is_referenced)
 175 bool            pmap_is_referenced(struct vm_page *);
 176 #endif
 177
 178 void            pmap_page_protect(struct vm_page *, vm_prot_t);
 179
 180 #if !defined(pmap_phys_address)
 181 paddr_t         pmap_phys_address(paddr_t);
 182 #endif
 183 #if !defined(pmap_mmap_flags)
 184 #define pmap_mmap_flags(x)      0
 185 #endif
 186 void            pmap_protect(pmap_t, vaddr_t, vaddr_t, vm_prot_t);
 187 #if !defined(pmap_reference)
 188 void            pmap_reference(pmap_t);
 189 #endif
 190 #if !defined(pmap_remove)
 191 void            pmap_remove(pmap_t, vaddr_t, vaddr_t);
 192 #endif
 193 void            pmap_remove_all(struct pmap *);
 194 #if !defined(pmap_update)
 195 void            pmap_update(pmap_t);
 196 #endif
 197 #if !defined(pmap_resident_count)
 198 long            pmap_resident_count(pmap_t);
 199 #endif
 200 #if !defined(pmap_wired_count)
 201 long            pmap_wired_count(pmap_t);
 202 #endif
 203 #if !defined(pmap_zero_page)
 204 void            pmap_zero_page(paddr_t);
 205 #endif
 206
 207 void            pmap_virtual_space(vaddr_t *, vaddr_t *);
 208 #if defined(PMAP_STEAL_MEMORY)
 209 vaddr_t         pmap_steal_memory(vsize_t, vaddr_t *, vaddr_t *);
 210 #endif
 211
 212 #if defined(PMAP_FORK)
 213 void            pmap_fork(pmap_t, pmap_t);
 214 #endif
 215 #endif  /* kernel*/
 216 #endif  /* PMAP_EXCLUDE_DECLS */
 217
 218 #endif /* _PMAP_VM_ */