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  * $DragonFly: src/sys/vm/pmap.h,v 1.14 2004/05/31 17:06:41 dillon Exp $
  66  */
  67
  68 /*
  69  *      Machine address mapping definitions -- machine-independent
  70  *      section.  [For machine-dependent section, see "machine/pmap.h".]
  71  */
  72
  73 #ifndef _PMAP_VM_
  74 #define _PMAP_VM_
  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 #include <machine/pmap.h>
  89
  90 #ifdef _KERNEL
  91
  92 struct proc;
  93 struct thread;
  94
  95 #ifdef __alpha__
  96 void             pmap_page_is_free (vm_page_t m);
  97 #endif
  98 void             pmap_change_wiring (pmap_t, vm_offset_t, boolean_t);
  99 void             pmap_clear_modify (vm_page_t m);
 100 void             pmap_clear_reference (vm_page_t m);
 101 void             pmap_collect (void);
 102 void             pmap_copy (pmap_t, pmap_t, vm_offset_t, vm_size_t,
 103                     vm_offset_t);
 104 void             pmap_copy_page (vm_paddr_t, vm_paddr_t);
 105 void             pmap_copy_page_frag (vm_paddr_t, vm_paddr_t, size_t bytes);
 106 void             pmap_destroy (pmap_t);
 107 void             pmap_enter (pmap_t, vm_offset_t, vm_page_t, vm_prot_t,
 108                     boolean_t);
 109 vm_paddr_t       pmap_extract (pmap_t pmap, vm_offset_t va);
 110 vm_page_t        pmap_extract_vmpage (pmap_t pmap, vm_offset_t va, int prot);
 111 void             pmap_growkernel (vm_offset_t);
 112 void             pmap_init (void);
 113 boolean_t        pmap_is_modified (vm_page_t m);
 114 boolean_t        pmap_ts_referenced (vm_page_t m);
 115 vm_offset_t      pmap_map (vm_offset_t, vm_paddr_t, vm_paddr_t, int);
 116 void             pmap_object_init_pt (pmap_t pmap, vm_offset_t addr,
 117                     vm_prot_t prot, vm_object_t object, vm_pindex_t pindex,
 118                     vm_offset_t size, int pagelimit);
 119 boolean_t        pmap_page_exists_quick (pmap_t pmap, vm_page_t m);
 120 void             pmap_page_protect (vm_page_t m, vm_prot_t prot);
 121 vm_paddr_t       pmap_phys_address (int);
 122 void             pmap_pinit (pmap_t);
 123 void             pmap_pinit0 (pmap_t);
 124 void             pmap_pinit2 (pmap_t);
 125 void             pmap_protect (pmap_t, vm_offset_t, vm_offset_t,
 126                     vm_prot_t);
 127 void             pmap_qenter (vm_offset_t, vm_page_t *, int);
 128 void             pmap_qenter2 (vm_offset_t, vm_page_t *, int, cpumask_t *);
 129 void             pmap_qremove (vm_offset_t, int);
 130 void             pmap_kenter (vm_offset_t, vm_paddr_t);
 131 void             pmap_kenter_quick (vm_offset_t, vm_paddr_t);
 132 void             pmap_kenter_sync (vm_offset_t);
 133 void             pmap_kenter_sync_quick (vm_offset_t);
 134 void             pmap_kremove (vm_offset_t);
 135 void             pmap_kremove_quick (vm_offset_t);
 136 void             pmap_reference (pmap_t);
 137 void             pmap_release (pmap_t);
 138 void             pmap_remove (pmap_t, vm_offset_t, vm_offset_t);
 139 void             pmap_remove_pages (pmap_t, vm_offset_t, vm_offset_t);
 140 void             pmap_zero_page (vm_paddr_t);
 141 void             pmap_page_assertzero (vm_paddr_t);
 142 void             pmap_zero_page_area (vm_paddr_t, int off, int size);
 143 void             pmap_prefault (pmap_t, vm_offset_t, vm_map_entry_t);
 144 int              pmap_mincore (pmap_t pmap, vm_offset_t addr);
 145 void             pmap_init_proc (struct proc *p, struct thread *td);
 146 void             pmap_init_thread (struct thread *td);
 147 struct thread   *pmap_dispose_proc (struct proc *p);
 148 void             pmap_swapout_proc (struct proc *p);
 149 void             pmap_swapin_proc (struct proc *p);
 150 void             pmap_activate (struct proc *p);
 151 vm_offset_t      pmap_addr_hint (vm_object_t obj, vm_offset_t addr, vm_size_t size);
 152 void            *pmap_kenter_temporary (vm_paddr_t pa, int i);
 153 void             pmap_init2 (void);
 154
 155 #endif /* _KERNEL */
 156
 157 #endif /* _PMAP_VM_ */