xref: /netbsd-src/sys/uvm/uvm.h (revision 1ad9454efb13a65cd7535ccf867508cb14d9d30e)
1 /*	$NetBSD: uvm.h,v 1.44 2006/09/15 15:51:12 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 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 	struct simplelock kentry_lock;
108 
109 	/* aio_done is locked by uvm.pagedaemon_lock and splbio! */
110 	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
111 
112 	/* swap-related items */
113 	struct simplelock swap_data_lock;
114 
115 	/* kernel object: to support anonymous pageable kernel memory */
116 	struct uvm_object *kernel_object;
117 };
118 
119 #endif /* _KERNEL */
120 
121 /*
122  * vm_map_entry etype bits:
123  */
124 
125 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
126 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
127 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
128 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
129 
130 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
131 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
132 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
133 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
134 
135 #ifdef _KERNEL
136 
137 /*
138  * holds all the internal UVM data
139  */
140 extern struct uvm uvm;
141 
142 /*
143  * historys
144  */
145 
146 #ifdef UVMHIST
147 UVMHIST_DECL(maphist);
148 UVMHIST_DECL(pdhist);
149 UVMHIST_DECL(ubchist);
150 UVMHIST_DECL(loanhist);
151 #endif
152 
153 extern struct evcnt uvm_ra_total;
154 extern struct evcnt uvm_ra_hit;
155 extern struct evcnt uvm_ra_miss;
156 
157 /*
158  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
159  * interlocked tsleep() function.
160  */
161 
162 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
163 do {									\
164 	(void) ltsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
165 	    msg, timo, slock);						\
166 } while (/*CONSTCOND*/ 0)
167 
168 void uvm_kick_pdaemon(void);
169 
170 /*
171  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
172  */
173 
174 #if defined(UVM_PAGE_TRKOWN)
175 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
176 #else
177 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
178 #endif /* UVM_PAGE_TRKOWN */
179 
180 #include <uvm/uvm_fault_i.h>
181 
182 #endif /* _KERNEL */
183 
184 #endif /* _UVM_UVM_H_ */
185