Home | History | Annotate | Line # | Download | only in uvm
uvm_pmap.h revision 1.26
      1 /*	$NetBSD: uvm_pmap.h,v 1.26 2009/04/18 08:48:47 cegger 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 (at) 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 extern struct pmap	*const kernel_pmap_ptr;
     77 #define pmap_kernel()	kernel_pmap_ptr
     78 
     79 /*
     80  * Each machine dependent implementation is expected to
     81  * keep certain statistics.  They may do this anyway they
     82  * so choose, but are expected to return the statistics
     83  * in the following structure.
     84  */
     85 struct pmap_statistics {
     86 	long		resident_count;	/* # of pages mapped (total)*/
     87 	long		wired_count;	/* # of pages wired */
     88 };
     89 typedef struct pmap_statistics	*pmap_statistics_t;
     90 
     91 #ifdef _KERNEL
     92 #include <machine/pmap.h>
     93 #endif
     94 
     95 /*
     96  * Flags passed to pmap_enter().  Note the bottom 3 bits are VM_PROT_*
     97  * bits, used to indicate the access type that was made (to seed modified
     98  * and referenced information).
     99  */
    100 #define	PMAP_WIRED	0x00000010	/* wired mapping */
    101 #define	PMAP_CANFAIL	0x00000020	/* can fail if resource shortage */
    102 
    103 #define	PMAP_MD_MASK	0x0000ff00	/* Machine-dependent bits */
    104 
    105 /*
    106  * Flags passed to pmap_kenter_pa().  Note the bottom 3 bits are VM_PROT_*
    107  * bits, used to indicate the access type.
    108  */
    109 #ifndef PMAP_KMPAGE
    110 #define	PMAP_KMPAGE	0x00000000	/* this is from the kmem allocator */
    111 #endif
    112 
    113 #ifndef PMAP_EXCLUDE_DECLS	/* Used in Sparc port to virtualize pmap mod */
    114 #ifdef _KERNEL
    115 __BEGIN_DECLS
    116 void		pmap_activate(struct lwp *);
    117 void		pmap_deactivate(struct lwp *);
    118 void		pmap_unwire(pmap_t, vaddr_t);
    119 
    120 #if !defined(pmap_clear_modify)
    121 bool		pmap_clear_modify(struct vm_page *);
    122 #endif
    123 #if !defined(pmap_clear_reference)
    124 bool		pmap_clear_reference(struct vm_page *);
    125 #endif
    126 
    127 #if !defined(pmap_collect)
    128 void		pmap_collect(pmap_t);
    129 #endif
    130 #if !defined(pmap_copy)
    131 void		pmap_copy(pmap_t, pmap_t, vaddr_t, vsize_t, vaddr_t);
    132 #endif
    133 #if !defined(pmap_copy_page)
    134 void		pmap_copy_page(paddr_t, paddr_t);
    135 #endif
    136 struct pmap	*pmap_create(void);
    137 void		pmap_destroy(pmap_t);
    138 int		pmap_enter(pmap_t, vaddr_t, paddr_t, vm_prot_t, int);
    139 bool		pmap_extract(pmap_t, vaddr_t, paddr_t *);
    140 #if defined(PMAP_GROWKERNEL)
    141 vaddr_t		pmap_growkernel(vaddr_t);
    142 #endif
    143 
    144 void		pmap_init(void);
    145 
    146 void		pmap_kenter_pa(vaddr_t, paddr_t, vm_prot_t);
    147 void		pmap_kremove(vaddr_t, vsize_t);
    148 #if !defined(pmap_is_modified)
    149 bool		pmap_is_modified(struct vm_page *);
    150 #endif
    151 #if !defined(pmap_is_referenced)
    152 bool		pmap_is_referenced(struct vm_page *);
    153 #endif
    154 
    155 void		pmap_page_protect(struct vm_page *, vm_prot_t);
    156 
    157 #if !defined(pmap_phys_address)
    158 paddr_t		pmap_phys_address(paddr_t);
    159 #endif
    160 void		pmap_protect(pmap_t, vaddr_t, vaddr_t, vm_prot_t);
    161 #if !defined(pmap_reference)
    162 void		pmap_reference(pmap_t);
    163 #endif
    164 #if !defined(pmap_remove)
    165 void		pmap_remove(pmap_t, vaddr_t, vaddr_t);
    166 #endif
    167 void		pmap_remove_all(struct pmap *);
    168 #if !defined(pmap_update)
    169 void		pmap_update(pmap_t);
    170 #endif
    171 #if !defined(pmap_resident_count)
    172 long		pmap_resident_count(pmap_t);
    173 #endif
    174 #if !defined(pmap_wired_count)
    175 long		pmap_wired_count(pmap_t);
    176 #endif
    177 #if !defined(pmap_zero_page)
    178 void		pmap_zero_page(paddr_t);
    179 #endif
    180 
    181 void		pmap_virtual_space(vaddr_t *, vaddr_t *);
    182 #if defined(PMAP_STEAL_MEMORY)
    183 vaddr_t		pmap_steal_memory(vsize_t, vaddr_t *, vaddr_t *);
    184 #endif
    185 
    186 #if defined(PMAP_FORK)
    187 void		pmap_fork(pmap_t, pmap_t);
    188 #endif
    189 __END_DECLS
    190 #endif	/* kernel*/
    191 #endif  /* PMAP_EXCLUDE_DECLS */
    192 
    193 #endif /* _PMAP_VM_ */
    194