xref: /openbsd-src/sys/uvm/uvm.h (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1 /*	$OpenBSD: uvm.h,v 1.12 2001/08/11 10:57:22 art Exp $	*/
2 /*	$NetBSD: uvm.h,v 1.22 2000/06/08 05:52:34 thorpej Exp $	*/
3 
4 /*
5  *
6  * Copyright (c) 1997 Charles D. Cranor and Washington University.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by Charles D. Cranor and
20  *      Washington University.
21  * 4. The name of the author may not be used to endorse or promote products
22  *    derived from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  * from: Id: uvm.h,v 1.1.2.14 1998/02/02 20:07:19 chuck Exp
36  */
37 
38 #ifndef _UVM_UVM_H_
39 #define _UVM_UVM_H_
40 
41 #include <uvm/uvm_extern.h>
42 
43 #include <uvm/uvm_stat.h>
44 
45 /*
46  * pull in prototypes
47  */
48 
49 #include <uvm/uvm_amap.h>
50 #include <uvm/uvm_aobj.h>
51 #include <uvm/uvm_fault.h>
52 #include <uvm/uvm_glue.h>
53 #include <uvm/uvm_km.h>
54 #include <uvm/uvm_loan.h>
55 #include <uvm/uvm_map.h>
56 #include <uvm/uvm_object.h>
57 #include <uvm/uvm_page.h>
58 #include <uvm/uvm_pager.h>
59 #include <uvm/uvm_pdaemon.h>
60 #include <uvm/uvm_swap.h>
61 #ifdef UVM_SWAP_ENCRYPT
62 #include <uvm/uvm_swap_encrypt.h>
63 #endif
64 
65 /*
66  * pull in VM_NFREELIST
67  */
68 #include <machine/vmparam.h>
69 
70 /*
71  * uvm structure (vm global state: collected in one structure for ease
72  * of reference...)
73  */
74 
75 struct uvm {
76 	/* vm_page related parameters */
77 		/* vm_page queues */
78 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
79 	struct pglist page_active;	/* allocated pages, in use */
80 	struct pglist page_inactive_swp;/* pages inactive (reclaim or free) */
81 	struct pglist page_inactive_obj;/* pages inactive (reclaim or free) */
82 	simple_lock_data_t pageqlock;	/* lock for active/inactive page q */
83 	simple_lock_data_t fpageqlock;	/* lock for free page q */
84 	boolean_t page_init_done;	/* TRUE if uvm_page_init() finished */
85 	boolean_t page_idle_zero;	/* TRUE if we should try to zero
86 					   pages in the idle loop */
87 		/* page daemon trigger */
88 	int pagedaemon;			/* daemon sleeps on this */
89 	struct proc *pagedaemon_proc;	/* daemon's pid */
90 	simple_lock_data_t pagedaemon_lock;
91 		/* page hash */
92 	struct pglist *page_hash;	/* page hash table (vp/off->page) */
93 	int page_nhash;			/* number of buckets */
94 	int page_hashmask;		/* hash mask */
95 	simple_lock_data_t hashlock;	/* lock on page_hash array */
96 
97 	/* anon stuff */
98 	struct vm_anon *afree;		/* anon free list */
99 	simple_lock_data_t afreelock; 	/* lock on anon free list */
100 
101 	/* static kernel map entry pool */
102 	vm_map_entry_t kentry_free;	/* free page pool */
103 	simple_lock_data_t kentry_lock;
104 
105 	/* aio_done is locked by uvm.pagedaemon_lock and splbio! */
106 	struct uvm_aiohead aio_done;	/* done async i/o reqs */
107 
108 	/* pager VM area bounds */
109 	vaddr_t pager_sva;		/* start of pager VA area */
110 	vaddr_t pager_eva;		/* end of pager VA area */
111 
112 	/* swap-related items */
113 	simple_lock_data_t swap_data_lock;
114 
115 	/* kernel object: to support anonymous pageable kernel memory */
116 	struct uvm_object *kernel_object;
117 };
118 
119 /*
120  * vm_map_entry etype bits:
121  */
122 
123 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
124 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
125 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
126 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
127 
128 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
129 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
130 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
131 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
132 
133 /*
134  * macros
135  */
136 
137 #ifdef _KERNEL
138 
139 extern struct uvm uvm;
140 
141 /*
142  * historys
143  */
144 
145 UVMHIST_DECL(maphist);
146 UVMHIST_DECL(pdhist);
147 
148 /*
149  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
150  * interlocked tsleep() function.
151  */
152 
153 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
154 do {									\
155 	(void) ltsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
156 	    msg, timo, slock);						\
157 } while (0)
158 
159 /*
160  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
161  */
162 
163 #if defined(UVM_PAGE_TRKOWN)
164 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
165 #else
166 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
167 #endif /* UVM_PAGE_TRKOWN */
168 
169 /*
170  * pull in inlines
171  */
172 
173 #include <uvm/uvm_amap_i.h>
174 #include <uvm/uvm_fault_i.h>
175 #include <uvm/uvm_map_i.h>
176 #include <uvm/uvm_page_i.h>
177 #include <uvm/uvm_pager_i.h>
178 
179 #endif /* _KERNEL */
180 
181 #endif /* _UVM_UVM_H_ */
182