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