sys/platform/vkernel/include/pmap.h

   1 /*
   2  * Copyright (c) 1991 Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * the Systems Programming Group of the University of Utah Computer
   7  * Science Department and William Jolitz of UUNET Technologies Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the University of
  20  *      California, Berkeley and its contributors.
  21  * 4. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  * Derived from hp300 version by Mike Hibler, this version by William
  38  * Jolitz uses a recursive map [a pde points to the page directory] to
  39  * map the page tables using the pagetables themselves. This is done to
  40  * reduce the impact on kernel virtual memory for lots of sparse address
  41  * space, and to reduce the cost of memory to each process.
  42  *
  43  * from: hp300: @(#)pmap.h      7.2 (Berkeley) 12/16/90
  44  * from: @(#)pmap.h     7.4 (Berkeley) 5/12/91
  45  * $FreeBSD: src/sys/i386/include/pmap.h,v 1.65.2.3 2001/10/03 07:15:37 peter Exp $
  46  */
  47
  48 #ifndef _MACHINE_PMAP_H_
  49 #define _MACHINE_PMAP_H_
  50
  51 #include <cpu/pmap.h>
  52
  53 /*
  54  * Size of Kernel address space.  This is the number of page table pages
  55  * (4MB each) to use for the kernel.  256 pages == 1 Gigabyte.
  56  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
  57  */
  58 #ifndef KVA_PAGES
  59 #define KVA_PAGES       256
  60 #endif
  61
  62 /*
  63  * Pte related macros
  64  */
  65 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
  66
  67 #ifndef LOCORE
  68
  69 #ifndef _SYS_TYPES_H_
  70 #include <sys/types.h>
  71 #endif
  72 #ifndef _SYS_QUEUE_H_
  73 #include <sys/queue.h>
  74 #endif
  75 #ifndef _SYS_SPINLOCK_H_
  76 #include <sys/spinlock.h>
  77 #endif
  78 #ifndef _SYS_THREAD_H_
  79 #include <sys/thread.h>
  80 #endif
  81 #ifndef _SYS_VKERNEL_H_
  82 #include <sys/vkernel.h>
  83 #endif
  84 #ifndef _MACHINE_TYPES_H_
  85 #include <machine/types.h>
  86 #endif
  87 #ifndef _MACHINE_PARAM_H_
  88 #include <machine/param.h>
  89 #endif
  90
  91 #ifdef _KERNEL
  92
  93 vm_paddr_t pmap_kextract(vm_offset_t);
  94
  95 /*
  96  * XXX
  97  */
  98 #define vtophys(va)     pmap_kextract(((vm_offset_t)(va)))
  99 #define vtophys_pte(va) ((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
 100
 101 #endif
 102
 103 /*
 104  * Pmap stuff
 105  */
 106 struct pv_entry;
 107 struct vm_page;
 108 struct vm_object;
 109
 110 struct md_page {
 111         int pv_list_count;
 112         TAILQ_HEAD(,pv_entry)   pv_list;
 113 };
 114
 115 struct md_object {
 116 };
 117
 118 /*
 119  * Each machine dependent implementation is expected to
 120  * keep certain statistics.  They may do this anyway they
 121  * so choose, but are expected to return the statistics
 122  * in the following structure.
 123  */
 124 struct pmap_statistics {
 125         long resident_count;    /* # of pages mapped (total) */
 126         long wired_count;       /* # of pages wired */
 127 };
 128 typedef struct pmap_statistics *pmap_statistics_t;
 129
 130 struct pmap {
 131         vpte_t                  *pm_pdir;       /* KVA of page directory */
 132         vpte_t                  pm_pdirpte;     /* pte mapping phys page */
 133         struct vm_object        *pm_pteobj;     /* Container for pte's */
 134         cpumask_t               pm_cpucachemask;/* Invalidate cpu mappings */
 135         TAILQ_ENTRY(pmap)       pm_pmnode;      /* list of pmaps */
 136         TAILQ_HEAD(,pv_entry)   pm_pvlist;      /* list of mappings in pmap */
 137         TAILQ_HEAD(,pv_entry)   pm_pvlist_free; /* free mappings */
 138         int                     pm_count;       /* reference count */
 139         cpumask_t               pm_active;      /* active on cpus */
 140         int                     pm_pdindex;     /* page dir page in obj */
 141         struct pmap_statistics  pm_stats;       /* pmap statistics */
 142         struct  vm_page         *pm_ptphint;    /* pmap ptp hint */
 143         int                     pm_generation;  /* detect pvlist deletions */
 144         struct spinlock         pm_spin;
 145         struct lwkt_token       pm_token;
 146 };
 147
 148 #define CPUMASK_LOCK            CPUMASK(SMP_MAXCPU)
 149 #define CPUMASK_BIT             SMP_MAXCPU      /* 1 << SMP_MAXCPU */
 150
 151 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
 152
 153 typedef struct pmap     *pmap_t;
 154
 155 #ifdef _KERNEL
 156 extern struct pmap      kernel_pmap;
 157 #endif
 158
 159 /*
 160  * For each vm_page_t, there is a list of all currently valid virtual
 161  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
 162  */
 163 typedef struct pv_entry {
 164         pmap_t          pv_pmap;        /* pmap where mapping lies */
 165         vm_offset_t     pv_va;          /* virtual address for mapping */
 166         TAILQ_ENTRY(pv_entry)   pv_list;
 167         TAILQ_ENTRY(pv_entry)   pv_plist;
 168         struct vm_page  *pv_ptem;       /* VM page for pte */
 169 } *pv_entry_t;
 170
 171 #ifdef  _KERNEL
 172
 173 extern caddr_t  CADDR1;
 174 extern pt_entry_t *CMAP1;
 175 extern char *ptvmmap;           /* poor name! */
 176 extern vm_offset_t clean_sva;
 177 extern vm_offset_t clean_eva;
 178
 179 void    pmap_bootstrap (void);
 180 void    *pmap_mapdev (vm_paddr_t, vm_size_t);
 181 void    pmap_unmapdev (vm_offset_t, vm_size_t);
 182 void    pmap_release(struct pmap *pmap);
 183 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
 184 void    pmap_set_opt (void);
 185
 186 #endif /* _KERNEL */
 187
 188 #endif /* !LOCORE */
 189
 190 #endif /* !_MACHINE_PMAP_H_ */