xref: /netbsd-src/sys/uvm/uvm.h (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: uvm.h,v 1.42 2005/11/29 15:45:28 yamt 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 /*
75  * uvm structure (vm global state: collected in one structure for ease
76  * of reference...)
77  */
78 
79 struct uvm {
80 	/* vm_page related parameters */
81 
82 		/* vm_page queues */
83 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
84 	int page_free_nextcolor;	/* next color to allocate from */
85 	struct pglist page_active;	/* allocated pages, in use */
86 	struct pglist page_inactive;	/* pages between the clock hands */
87 	struct simplelock pageqlock;	/* lock for active/inactive page q */
88 	struct simplelock fpageqlock;	/* lock for free page q */
89 	boolean_t page_init_done;	/* TRUE if uvm_page_init() finished */
90 	boolean_t page_idle_zero;	/* TRUE if we should try to zero
91 					   pages in the idle loop */
92 
93 		/* page daemon trigger */
94 	int pagedaemon;			/* daemon sleeps on this */
95 	struct proc *pagedaemon_proc;	/* daemon's pid */
96 	struct simplelock pagedaemon_lock;
97 
98 		/* aiodone daemon trigger */
99 	int aiodoned;			/* daemon sleeps on this */
100 	struct proc *aiodoned_proc;	/* daemon's pid */
101 	struct simplelock aiodoned_lock;
102 
103 		/* page hash */
104 	struct pglist *page_hash;	/* page hash table (vp/off->page) */
105 	int page_nhash;			/* number of buckets */
106 	int page_hashmask;		/* hash mask */
107 	struct simplelock hashlock;	/* lock on page_hash array */
108 
109 	struct simplelock kentry_lock;
110 
111 	/* aio_done is locked by uvm.pagedaemon_lock and splbio! */
112 	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
113 
114 	/* swap-related items */
115 	struct simplelock swap_data_lock;
116 
117 	/* kernel object: to support anonymous pageable kernel memory */
118 	struct uvm_object *kernel_object;
119 };
120 
121 #endif /* _KERNEL */
122 
123 /*
124  * vm_map_entry etype bits:
125  */
126 
127 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
128 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
129 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
130 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
131 
132 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
133 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
134 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
135 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
136 
137 #ifdef _KERNEL
138 
139 /*
140  * holds all the internal UVM data
141  */
142 extern struct uvm uvm;
143 
144 /*
145  * historys
146  */
147 
148 #ifdef UVMHIST
149 UVMHIST_DECL(maphist);
150 UVMHIST_DECL(pdhist);
151 UVMHIST_DECL(ubchist);
152 UVMHIST_DECL(loanhist);
153 #endif
154 
155 extern struct evcnt uvm_ra_total;
156 extern struct evcnt uvm_ra_hit;
157 extern struct evcnt uvm_ra_miss;
158 
159 /*
160  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
161  * interlocked tsleep() function.
162  */
163 
164 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
165 do {									\
166 	(void) ltsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
167 	    msg, timo, slock);						\
168 } while (/*CONSTCOND*/ 0)
169 
170 /*
171  * UVM_KICK_PDAEMON: perform checks to determine if we need to
172  * give the pagedaemon a nudge, and do so if necessary.
173  */
174 
175 #define	UVM_KICK_PDAEMON()						\
176 do {									\
177 	if (uvmexp.free + uvmexp.paging < uvmexp.freemin ||		\
178 	    (uvmexp.free + uvmexp.paging < uvmexp.freetarg &&		\
179 	     uvmexp.inactive < uvmexp.inactarg)) {			\
180 		wakeup(&uvm.pagedaemon);				\
181 	}								\
182 } while (/*CONSTCOND*/0)
183 
184 /*
185  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
186  */
187 
188 #if defined(UVM_PAGE_TRKOWN)
189 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
190 #else
191 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
192 #endif /* UVM_PAGE_TRKOWN */
193 
194 #endif /* _KERNEL */
195 
196 #endif /* _UVM_UVM_H_ */
197 
198 /*
199  * pull in inlines
200  */
201 
202 #ifdef _KERNEL
203 
204 #if defined(UVM_AMAP_INLINE) || defined(UVM_AMAP_C)
205 #include <uvm/uvm_amap_i.h>
206 #endif
207 
208 #include <uvm/uvm_fault_i.h>
209 
210 #if defined(UVM_MAP_INLINE) || defined(UVM_MAP_C)
211 #include <uvm/uvm_map_i.h>
212 #endif
213 
214 #if defined(UVM_PAGE_INLINE) || defined(UVM_PAGE_C)
215 #include <uvm/uvm_page_i.h>
216 #endif
217 
218 #if defined(UVM_PAGER_INLINE) || defined(UVM_PAGER_C)
219 #include <uvm/uvm_pager_i.h>
220 #endif
221 
222 #endif /* _KERNEL */
223 
224