xref: /netbsd/sys/uvm/uvm.h (revision c4a72b64)
1 /*	$NetBSD: uvm.h,v 1.35 2002/12/01 22:58:43 matt 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 	/* anon stuff */
110 	struct vm_anon *afree;		/* anon free list */
111 	struct simplelock afreelock; 	/* lock on anon free list */
112 
113 	/* static kernel map entry pool */
114 	struct vm_map_entry *kentry_free;	/* free page pool */
115 	struct simplelock kentry_lock;
116 
117 	/* aio_done is locked by uvm.pagedaemon_lock and splbio! */
118 	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
119 
120 	/* swap-related items */
121 	struct simplelock swap_data_lock;
122 
123 	/* kernel object: to support anonymous pageable kernel memory */
124 	struct uvm_object *kernel_object;
125 };
126 
127 #endif /* _KERNEL */
128 
129 /*
130  * vm_map_entry etype bits:
131  */
132 
133 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
134 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
135 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
136 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
137 
138 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
139 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
140 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
141 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
142 
143 #ifdef _KERNEL
144 
145 /*
146  * holds all the internal UVM data
147  */
148 extern struct uvm uvm;
149 
150 /*
151  * historys
152  */
153 
154 #ifdef UVMHIST
155 UVMHIST_DECL(maphist);
156 UVMHIST_DECL(pdhist);
157 UVMHIST_DECL(ubchist);
158 #endif
159 
160 /*
161  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
162  * interlocked tsleep() function.
163  */
164 
165 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
166 do {									\
167 	(void) ltsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
168 	    msg, timo, slock);						\
169 } while (/*CONSTCOND*/ 0)
170 
171 /*
172  * UVM_KICK_PDAEMON: perform checks to determine if we need to
173  * give the pagedaemon a nudge, and do so if necessary.
174  */
175 
176 #define	UVM_KICK_PDAEMON()						\
177 do {									\
178 	if (uvmexp.free + uvmexp.paging < uvmexp.freemin ||		\
179 	    (uvmexp.free + uvmexp.paging < uvmexp.freetarg &&		\
180 	     uvmexp.inactive < uvmexp.inactarg)) {			\
181 		wakeup(&uvm.pagedaemon);				\
182 	}								\
183 } while (/*CONSTCOND*/0)
184 
185 /*
186  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
187  */
188 
189 #if defined(UVM_PAGE_TRKOWN)
190 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
191 #else
192 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
193 #endif /* UVM_PAGE_TRKOWN */
194 
195 #endif /* _KERNEL */
196 
197 #endif /* _UVM_UVM_H_ */
198 
199 /*
200  * pull in inlines
201  */
202 
203 #ifdef _KERNEL
204 
205 #include <uvm/uvm_amap_i.h>
206 #include <uvm/uvm_fault_i.h>
207 #include <uvm/uvm_map_i.h>
208 #include <uvm/uvm_page_i.h>
209 #include <uvm/uvm_pager_i.h>
210 
211 #endif /* _KERNEL */
212 
213