xref: /openbsd-src/sys/uvm/uvm.h (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1 /*	$OpenBSD: uvm.h,v 1.46 2011/07/06 19:50:38 beck Exp $	*/
2 /*	$NetBSD: uvm.h,v 1.24 2000/11/27 08:40:02 chs 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 /*
44  * pull in prototypes
45  */
46 
47 #include <uvm/uvm_amap.h>
48 #include <uvm/uvm_aobj.h>
49 #include <uvm/uvm_fault.h>
50 #include <uvm/uvm_glue.h>
51 #include <uvm/uvm_km.h>
52 #include <uvm/uvm_loan.h>
53 #include <uvm/uvm_map.h>
54 #include <uvm/uvm_object.h>
55 #include <uvm/uvm_page.h>
56 #include <uvm/uvm_pager.h>
57 #include <uvm/uvm_swap.h>
58 #include <uvm/uvm_pmemrange.h>
59 #ifdef UVM_SWAP_ENCRYPT
60 #include <uvm/uvm_swap_encrypt.h>
61 #endif
62 
63 #include <machine/vmparam.h>
64 
65 /* Constraint ranges, set by MD code. */
66 extern struct uvm_constraint_range  isa_constraint;
67 extern struct uvm_constraint_range  dma_constraint;
68 extern struct uvm_constraint_range  no_constraint;
69 extern struct uvm_constraint_range *uvm_md_constraints[];
70 
71 /*
72  * uvm structure (vm global state: collected in one structure for ease
73  * of reference...)
74  */
75 
76 struct uvm {
77 	/* vm_page related parameters */
78 
79 	/* vm_page queues */
80 	struct pglist page_active;	/* allocated pages, in use */
81 	struct pglist page_inactive_swp;/* pages inactive (reclaim or free) */
82 	struct pglist page_inactive_obj;/* pages inactive (reclaim or free) */
83 	/* Lock order: object lock,  pageqlock, then fpageqlock. */
84 	simple_lock_data_t pageqlock;	/* lock for active/inactive page q */
85 	struct mutex fpageqlock;	/* lock for free page q  + pdaemon */
86 	boolean_t page_init_done;	/* TRUE if uvm_page_init() finished */
87 	boolean_t page_idle_zero;	/* TRUE if we should try to zero
88 					   pages in the idle loop */
89 	struct uvm_pmr_control pmr_control; /* pmemrange data */
90 
91 		/* page daemon trigger */
92 	int pagedaemon;			/* daemon sleeps on this */
93 	struct proc *pagedaemon_proc;	/* daemon's pid */
94 
95 		/* aiodone daemon trigger */
96 	int aiodoned;			/* daemon sleeps on this */
97 	struct proc *aiodoned_proc;	/* daemon's pid */
98 	struct mutex aiodoned_lock;
99 
100 	/* static kernel map entry pool */
101 	vm_map_entry_t kentry_free;	/* free page pool */
102 	simple_lock_data_t kentry_lock;
103 
104 	/* aio_done is locked by uvm.aiodoned_lock. */
105 	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
106 
107 	/* swap-related items */
108 	simple_lock_data_t swap_data_lock;
109 
110 	/* kernel object: to support anonymous pageable kernel memory */
111 	struct uvm_object *kernel_object;
112 };
113 
114 /*
115  * vm_map_entry etype bits:
116  */
117 
118 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
119 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
120 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
121 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
122 #define	UVM_ET_HOLE		0x10	/* no backend */
123 
124 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
125 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
126 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
127 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
128 #define UVM_ET_ISHOLE(E)	(((E)->etype & UVM_ET_HOLE) != 0)
129 
130 #ifdef _KERNEL
131 
132 /*
133  * holds all the internal UVM data
134  */
135 extern struct uvm uvm;
136 
137 /*
138  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
139  * interlocked tsleep() function.
140  */
141 
142 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
143 do {									\
144 	tsleep(event, PVM|PNORELOCK|(intr ? PCATCH : 0), msg, timo);	\
145 } while (0)
146 
147 /*
148  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
149  */
150 
151 #if defined(UVM_PAGE_TRKOWN)
152 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
153 #else
154 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
155 #endif /* UVM_PAGE_TRKOWN */
156 
157 #endif /* _KERNEL */
158 
159 #endif /* _UVM_UVM_H_ */
160