xref: /netbsd/sys/uvm/uvm.h (revision bd9f53c8)
1 /*	$NetBSD: uvm.h,v 1.78 2023/07/17 12:55:37 riastradh Exp $	*/
2 
3 /*
4  * Copyright (c) 1997 Charles D. Cranor and Washington University.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * from: Id: uvm.h,v 1.1.2.14 1998/02/02 20:07:19 chuck Exp
28  */
29 
30 #ifndef _UVM_UVM_H_
31 #define _UVM_UVM_H_
32 
33 #if defined(_KERNEL_OPT)
34 #include "opt_lockdebug.h"
35 #include "opt_multiprocessor.h"
36 #include "opt_uvmhist.h"
37 #include "opt_uvm_page_trkown.h"
38 #endif
39 
40 #include <uvm/uvm_extern.h>
41 
42 #ifdef _KERNEL
43 #include <uvm/uvm_stat.h>
44 #endif
45 
46 /*
47  * pull in prototypes
48  */
49 
50 #include <uvm/uvm_amap.h>
51 #include <uvm/uvm_aobj.h>
52 #include <uvm/uvm_fault.h>
53 #include <uvm/uvm_glue.h>
54 #include <uvm/uvm_km.h>
55 #include <uvm/uvm_loan.h>
56 #include <uvm/uvm_map.h>
57 #include <uvm/uvm_object.h>
58 #include <uvm/uvm_page.h>
59 #include <uvm/uvm_pager.h>
60 #include <uvm/uvm_pdaemon.h>
61 #include <uvm/uvm_swap.h>
62 
63 #ifdef _KERNEL
64 
65 #include <uvm/uvm_physseg.h>
66 
67 /*
68  * pull in VM_NFREELIST
69  */
70 #include <machine/vmparam.h>
71 
72 struct workqueue;
73 struct pgflcache;
74 
75 /*
76  * per-cpu data
77  */
78 
79 struct uvm_cpu {
80 	/* allocator */
81 	struct pgflcache *pgflcache[VM_NFREELIST];/* cpu-local cached pages */
82 	void		*pgflcachemem;		/* pointer to allocated mem */
83 	size_t		pgflcachememsz;		/* size of allocated memory */
84 	u_int		pgflcolor;		/* next color to allocate */
85 	u_int		pgflbucket;		/* where to send our pages */
86 
87 	/* uvmpdpol: queue of intended page status changes. */
88 	struct vm_page	**pdq;			/* queue entries */
89 	u_int		pdqhead;		/* current queue head */
90 	u_int		pdqtail;		/* maximum number entries */
91 	int		pdqtime;		/* last time queue cleared */
92 };
93 
94 /*
95  * uvm structure (vm global state: collected in one structure for ease
96  * of reference...)
97  */
98 
99 struct uvm {
100 	/* vm_page related parameters */
101 
102 		/* vm_page queues */
103 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
104 	u_int	bucketcount;
105 	bool	page_init_done;		/* true if uvm_page_init() finished */
106 
107 		/* page daemon trigger */
108 	int pagedaemon;			/* daemon sleeps on this */
109 	struct lwp *pagedaemon_lwp;	/* daemon's lid */
110 };
111 
112 /*
113  * kernel object: to support anonymous pageable kernel memory
114  */
115 extern struct uvm_object *uvm_kernel_object;
116 
117 /*
118  * locks (made globals for lockstat).
119  */
120 
121 extern kmutex_t uvm_kentry_lock;
122 
123 #endif /* _KERNEL */
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 #ifdef UVMHIST
151 UVMHIST_DECL(maphist);
152 UVMHIST_DECL(pdhist);
153 UVMHIST_DECL(ubchist);
154 UVMHIST_DECL(loanhist);
155 #endif
156 
157 extern struct evcnt uvm_ra_total;
158 extern struct evcnt uvm_ra_hit;
159 extern struct evcnt uvm_ra_miss;
160 
161 /*
162  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
163  * interlocked tsleep() function.
164  */
165 
166 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
167 do {									\
168 	(void) mtsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
169 	    msg, timo, slock);						\
170 } while (/*CONSTCOND*/ 0)
171 
172 void uvm_kick_pdaemon(void);
173 
174 /*
175  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
176  */
177 
178 #if defined(UVM_PAGE_TRKOWN)
179 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
180 #else
181 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
182 #endif /* UVM_PAGE_TRKOWN */
183 
184 #include <uvm/uvm_fault_i.h>
185 
186 #endif /* _KERNEL */
187 
188 #endif /* _UVM_UVM_H_ */
189