6111b3229afb755b2a4984d91e2481f673189ddf
[dragonfly.git] / 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  * $DragonFly: src/sys/platform/vkernel/include/pmap.h,v 1.3 2007/01/15 09:28:39 dillon Exp $
47  */
48
49 #ifndef _MACHINE_PMAP_H_
50 #define _MACHINE_PMAP_H_
51
52 #include <cpu/pmap.h>
53
54 /*
55  * Size of Kernel address space.  This is the number of page table pages
56  * (4MB each) to use for the kernel.  256 pages == 1 Gigabyte.
57  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
58  */
59 #ifndef KVA_PAGES
60 #define KVA_PAGES       256
61 #endif
62
63 /*
64  * Pte related macros
65  */
66 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
67
68 #ifndef LOCORE
69
70 #ifndef _SYS_TYPES_H_
71 #include <sys/types.h>
72 #endif
73 #ifndef _SYS_QUEUE_H_
74 #include <sys/queue.h>
75 #endif
76 #ifndef _SYS_VKERNEL_H_
77 #include <sys/vkernel.h>
78 #endif
79 #ifndef _MACHINE_TYPES_H_
80 #include <machine/types.h>
81 #endif
82 #ifndef _MACHINE_PARAM_H_
83 #include <machine/param.h>
84 #endif
85
86 #ifdef _KERNEL
87
88 vm_paddr_t pmap_kextract(vm_offset_t);
89
90 /*
91  * XXX
92  */
93 #define vtophys(va)     pmap_kextract(((vm_offset_t)(va)))
94 #define vtophys_pte(va) ((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
95
96 #endif
97
98 /*
99  * Pmap stuff
100  */
101 struct pv_entry;
102 struct vm_page;
103 struct vm_object;
104
105 struct md_page {
106         int pv_list_count;
107         TAILQ_HEAD(,pv_entry)   pv_list;
108 };
109
110 /*
111  * Each machine dependent implementation is expected to
112  * keep certain statistics.  They may do this anyway they
113  * so choose, but are expected to return the statistics
114  * in the following structure.
115  */
116 struct pmap_statistics {
117         long resident_count;    /* # of pages mapped (total) */
118         long wired_count;       /* # of pages wired */
119 };
120 typedef struct pmap_statistics *pmap_statistics_t;
121
122 struct pmap {
123         pd_entry_t              *pm_pdir;       /* KVA of page directory */
124         vpte_t                  pm_pdirpte;     /* pte mapping phys page */
125         struct vm_object        *pm_pteobj;     /* Container for pte's */
126         TAILQ_ENTRY(pmap)       pm_pmnode;      /* list of pmaps */
127         TAILQ_HEAD(,pv_entry)   pm_pvlist;      /* list of mappings in pmap */
128         int                     pm_count;       /* reference count */
129         cpumask_t               pm_active;      /* active on cpus */
130         int                     pm_pdindex;     /* page dir page in obj */
131         struct pmap_statistics  pm_stats;       /* pmap statistics */
132         struct  vm_page         *pm_ptphint;    /* pmap ptp hint */
133         int                     pm_generation;  /* detect pvlist deletions */
134 };
135
136 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
137
138 typedef struct pmap     *pmap_t;
139
140 #ifdef _KERNEL
141 extern struct pmap      kernel_pmap;
142 #endif
143
144 /*
145  * For each vm_page_t, there is a list of all currently valid virtual
146  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
147  */
148 typedef struct pv_entry {
149         pmap_t          pv_pmap;        /* pmap where mapping lies */
150         vm_offset_t     pv_va;          /* virtual address for mapping */
151         TAILQ_ENTRY(pv_entry)   pv_list;
152         TAILQ_ENTRY(pv_entry)   pv_plist;
153         struct vm_page  *pv_ptem;       /* VM page for pte */
154 } *pv_entry_t;
155
156 #ifdef  _KERNEL
157
158 extern caddr_t  CADDR1;
159 extern pt_entry_t *CMAP1;
160 extern char *ptvmmap;           /* poor name! */
161 extern vm_offset_t clean_sva;
162 extern vm_offset_t clean_eva;
163
164 void    pmap_bootstrap (void);
165 void    *pmap_mapdev (vm_paddr_t, vm_size_t);
166 void    pmap_unmapdev (vm_offset_t, vm_size_t);
167 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
168 #ifdef SMP
169 void    pmap_set_opt (void);
170 #endif
171
172 #endif /* _KERNEL */
173
174 #endif /* !LOCORE */
175
176 #endif /* !_MACHINE_PMAP_H_ */