uvm.h revision 1.52 1 /* $NetBSD: uvm.h,v 1.52 2007/07/21 19:21:53 ad Exp $ */
2
3 /*
4 *
5 * Copyright (c) 1997 Charles D. Cranor and Washington University.
6 * All rights reserved.
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 Charles D. Cranor and
19 * Washington University.
20 * 4. The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 * from: Id: uvm.h,v 1.1.2.14 1998/02/02 20:07:19 chuck Exp
35 */
36
37 #ifndef _UVM_UVM_H_
38 #define _UVM_UVM_H_
39
40 #if defined(_KERNEL_OPT)
41 #include "opt_lockdebug.h"
42 #include "opt_multiprocessor.h"
43 #include "opt_uvmhist.h"
44 #endif
45
46 #include <uvm/uvm_extern.h>
47
48 #include <uvm/uvm_stat.h>
49
50 /*
51 * pull in prototypes
52 */
53
54 #include <uvm/uvm_amap.h>
55 #include <uvm/uvm_aobj.h>
56 #include <uvm/uvm_fault.h>
57 #include <uvm/uvm_glue.h>
58 #include <uvm/uvm_km.h>
59 #include <uvm/uvm_loan.h>
60 #include <uvm/uvm_map.h>
61 #include <uvm/uvm_object.h>
62 #include <uvm/uvm_page.h>
63 #include <uvm/uvm_pager.h>
64 #include <uvm/uvm_pdaemon.h>
65 #include <uvm/uvm_swap.h>
66
67 #ifdef _KERNEL
68
69 /*
70 * pull in VM_NFREELIST
71 */
72 #include <machine/vmparam.h>
73
74 struct workqueue;
75
76 /*
77 * uvm structure (vm global state: collected in one structure for ease
78 * of reference...)
79 */
80
81 struct uvm {
82 /* vm_page related parameters */
83
84 /* vm_page queues */
85 struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
86 int page_free_nextcolor; /* next color to allocate from */
87 struct simplelock pageqlock; /* lock for active/inactive page q */
88 bool page_init_done; /* TRUE if uvm_page_init() finished */
89 bool page_idle_zero; /* TRUE if we should try to zero
90 pages in the idle loop */
91
92 /* page daemon trigger */
93 int pagedaemon; /* daemon sleeps on this */
94 struct lwp *pagedaemon_lwp; /* daemon's lid */
95
96 /* aiodone daemon */
97 struct workqueue *aiodone_queue;
98
99 /* page hash */
100 struct pglist *page_hash; /* page hash table (vp/off->page) */
101 int page_nhash; /* number of buckets */
102 int page_hashmask; /* hash mask */
103
104 /* aio_done is locked by uvm.pagedaemon_lock and splbio! */
105 TAILQ_HEAD(, buf) aio_done; /* done async i/o reqs */
106
107 /* swap-related items */
108 bool swap_running;
109 kcondvar_t scheduler_cv;
110 bool scheduler_kicked;
111 int swapout_enabled;
112 };
113
114 /*
115 * kernel object: to support anonymous pageable kernel memory
116 */
117 extern struct uvm_object *uvm_kernel_object;
118
119 /*
120 * locks (made globals for lockstat).
121 */
122
123 extern kmutex_t uvm_fpageqlock; /* lock for free page q */
124 extern kmutex_t uvm_pagedaemon_lock;
125 extern kmutex_t uvm_kentry_lock;
126 extern kmutex_t uvm_swap_data_lock;
127 extern kmutex_t uvm_scheduler_mutex;
128
129 #endif /* _KERNEL */
130
131 /*
132 * vm_map_entry etype bits:
133 */
134
135 #define UVM_ET_OBJ 0x01 /* it is a uvm_object */
136 #define UVM_ET_SUBMAP 0x02 /* it is a vm_map submap */
137 #define UVM_ET_COPYONWRITE 0x04 /* copy_on_write */
138 #define UVM_ET_NEEDSCOPY 0x08 /* needs_copy */
139
140 #define UVM_ET_ISOBJ(E) (((E)->etype & UVM_ET_OBJ) != 0)
141 #define UVM_ET_ISSUBMAP(E) (((E)->etype & UVM_ET_SUBMAP) != 0)
142 #define UVM_ET_ISCOPYONWRITE(E) (((E)->etype & UVM_ET_COPYONWRITE) != 0)
143 #define UVM_ET_ISNEEDSCOPY(E) (((E)->etype & UVM_ET_NEEDSCOPY) != 0)
144
145 #ifdef _KERNEL
146
147 /*
148 * holds all the internal UVM data
149 */
150 extern struct uvm uvm;
151
152 /*
153 * historys
154 */
155
156 #ifdef UVMHIST
157 UVMHIST_DECL(maphist);
158 UVMHIST_DECL(pdhist);
159 UVMHIST_DECL(ubchist);
160 UVMHIST_DECL(loanhist);
161 #endif
162
163 extern struct evcnt uvm_ra_total;
164 extern struct evcnt uvm_ra_hit;
165 extern struct evcnt uvm_ra_miss;
166
167 /*
168 * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
169 * interlocked tsleep() function.
170 */
171
172 #define UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo) \
173 do { \
174 (void) ltsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0), \
175 msg, timo, slock); \
176 } while (/*CONSTCOND*/ 0)
177
178 void uvm_kick_pdaemon(void);
179
180 /*
181 * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
182 */
183
184 #if defined(UVM_PAGE_TRKOWN)
185 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
186 #else
187 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
188 #endif /* UVM_PAGE_TRKOWN */
189
190 #include <uvm/uvm_fault_i.h>
191
192 #endif /* _KERNEL */
193
194 #endif /* _UVM_UVM_H_ */
195