xref: /netbsd-src/sys/uvm/uvm.h (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: uvm.h,v 1.55 2008/06/04 15:06:04 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  * per-cpu data
78  */
79 
80 struct uvm_cpu {
81 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
82 	int page_free_nextcolor;	/* next color to allocate from */
83 	int page_idlezero_next;		/* which color to zero next */
84 	bool page_idle_zero;		/* TRUE if we should try to zero
85 					   pages in the idle loop */
86 	int pages[PGFL_NQUEUES];	/* total of pages in page_free */
87 };
88 
89 /*
90  * uvm structure (vm global state: collected in one structure for ease
91  * of reference...)
92  */
93 
94 struct uvm {
95 	/* vm_page related parameters */
96 
97 		/* vm_page queues */
98 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
99 	bool page_init_done;		/* TRUE if uvm_page_init() finished */
100 
101 		/* page daemon trigger */
102 	int pagedaemon;			/* daemon sleeps on this */
103 	struct lwp *pagedaemon_lwp;	/* daemon's lid */
104 
105 		/* aiodone daemon */
106 	struct workqueue *aiodone_queue;
107 
108 	/* aio_done is locked by uvm.pagedaemon_lock and splbio! */
109 	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
110 
111 	/* swap-related items */
112 	bool swap_running;
113 	kcondvar_t scheduler_cv;
114 	bool scheduler_kicked;
115 	int swapout_enabled;
116 
117 	/* per-cpu data */
118 	struct uvm_cpu cpus[MAXCPUS];
119 };
120 
121 /*
122  * kernel object: to support anonymous pageable kernel memory
123  */
124 extern struct uvm_object *uvm_kernel_object;
125 
126 /*
127  * locks (made globals for lockstat).
128  */
129 
130 extern kmutex_t uvm_pageqlock;		/* lock for active/inactive page q */
131 extern kmutex_t uvm_fpageqlock;		/* lock for free page q */
132 extern kmutex_t uvm_kentry_lock;
133 extern kmutex_t uvm_swap_data_lock;
134 extern kmutex_t uvm_scheduler_mutex;
135 
136 #endif /* _KERNEL */
137 
138 /*
139  * vm_map_entry etype bits:
140  */
141 
142 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
143 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
144 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
145 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
146 
147 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
148 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
149 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
150 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
151 
152 #ifdef _KERNEL
153 
154 /*
155  * holds all the internal UVM data
156  */
157 extern struct uvm uvm;
158 
159 /*
160  * historys
161  */
162 
163 #ifdef UVMHIST
164 UVMHIST_DECL(maphist);
165 UVMHIST_DECL(pdhist);
166 UVMHIST_DECL(ubchist);
167 UVMHIST_DECL(loanhist);
168 #endif
169 
170 extern struct evcnt uvm_ra_total;
171 extern struct evcnt uvm_ra_hit;
172 extern struct evcnt uvm_ra_miss;
173 
174 /*
175  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
176  * interlocked tsleep() function.
177  */
178 
179 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
180 do {									\
181 	(void) mtsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
182 	    msg, timo, slock);						\
183 } while (/*CONSTCOND*/ 0)
184 
185 void uvm_kick_pdaemon(void);
186 
187 /*
188  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
189  */
190 
191 #if defined(UVM_PAGE_TRKOWN)
192 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
193 #else
194 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
195 #endif /* UVM_PAGE_TRKOWN */
196 
197 #include <uvm/uvm_fault_i.h>
198 
199 #endif /* _KERNEL */
200 
201 #endif /* _UVM_UVM_H_ */
202