xref: /netbsd-src/sys/uvm/uvm_param.h (revision d20841bb642898112fe68f0ad3f7b26dddf56f07)
1 /*	$NetBSD: uvm_param.h,v 1.18 2003/08/07 16:34:50 agc Exp $	*/
2 
3 /*
4  * Copyright (c) 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * The Mach Operating System project at Carnegie-Mellon University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)vm_param.h	8.2 (Berkeley) 1/9/95
35  *
36  *
37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
38  * All rights reserved.
39  *
40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
41  *
42  * Permission to use, copy, modify and distribute this software and
43  * its documentation is hereby granted, provided that both the copyright
44  * notice and this permission notice appear in all copies of the
45  * software, derivative works or modified versions, and any portions
46  * thereof, and that both notices appear in supporting documentation.
47  *
48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
51  *
52  * Carnegie Mellon requests users of this software to return to
53  *
54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
55  *  School of Computer Science
56  *  Carnegie Mellon University
57  *  Pittsburgh PA 15213-3890
58  *
59  * any improvements or extensions that they make and grant Carnegie the
60  * rights to redistribute these changes.
61  */
62 
63 /*
64  *	Machine independent virtual memory parameters.
65  */
66 
67 #ifndef	_VM_PARAM_
68 #define	_VM_PARAM_
69 
70 #ifdef _KERNEL_OPT
71 #include "opt_uvm.h"
72 #endif
73 #ifdef _KERNEL
74 #include <machine/vmparam.h>
75 #endif
76 
77 #if defined(_KERNEL)
78 
79 #if defined(PAGE_SIZE)
80 
81 /*
82  * If PAGE_SIZE is defined at this stage, it must be a constant.
83  */
84 
85 #if PAGE_SIZE == 0
86 #error Invalid PAGE_SIZE definition
87 #endif
88 
89 /*
90  * If the platform does not need to support a variable PAGE_SIZE,
91  * then provide default values for MIN_PAGE_SIZE and MAX_PAGE_SIZE.
92  */
93 
94 #if !defined(MIN_PAGE_SIZE)
95 #define	MIN_PAGE_SIZE	PAGE_SIZE
96 #endif /* ! MIN_PAGE_SIZE */
97 
98 #if !defined(MAX_PAGE_SIZE)
99 #define	MAX_PAGE_SIZE	PAGE_SIZE
100 #endif /* ! MAX_PAGE_SIZE */
101 
102 #else /* ! PAGE_SIZE */
103 
104 /*
105  * PAGE_SIZE is not a constant; MIN_PAGE_SIZE and MAX_PAGE_SIZE must
106  * be defined.
107  */
108 
109 #if !defined(MIN_PAGE_SIZE)
110 #error MIN_PAGE_SIZE not defined
111 #endif
112 
113 #if !defined(MAX_PAGE_SIZE)
114 #error MAX_PAGE_SIZE not defined
115 #endif
116 
117 #endif /* PAGE_SIZE */
118 
119 /*
120  * MIN_PAGE_SIZE and MAX_PAGE_SIZE must be constants.
121  */
122 
123 #if MIN_PAGE_SIZE == 0
124 #error Invalid MIN_PAGE_SIZE definition
125 #endif
126 
127 #if MAX_PAGE_SIZE == 0
128 #error Invalid MAX_PAGE_SIZE definition
129 #endif
130 
131 /*
132  * If MIN_PAGE_SIZE and MAX_PAGE_SIZE are not equal, then we must use
133  * non-constant PAGE_SIZE, et al for LKMs.
134  */
135 #if (MIN_PAGE_SIZE != MAX_PAGE_SIZE) && defined(_LKM)
136 #undef PAGE_SIZE
137 #undef PAGE_MASK
138 #undef PAGE_SHIFT
139 #endif
140 
141 /*
142  * Now provide PAGE_SIZE, PAGE_MASK, and PAGE_SHIFT if we do not
143  * have ones that are compile-time constants.
144  */
145 #if !defined(PAGE_SIZE)
146 #define	PAGE_SIZE	uvmexp.pagesize		/* size of page */
147 #define	PAGE_MASK	uvmexp.pagemask		/* size of page - 1 */
148 #define	PAGE_SHIFT	uvmexp.pageshift	/* bits to shift for pages */
149 #endif /* PAGE_SIZE */
150 
151 #endif /* _KERNEL */
152 
153 /*
154  * CTL_VM identifiers
155  */
156 #define	VM_METER	1		/* struct vmmeter */
157 #define	VM_LOADAVG	2		/* struct loadavg */
158 #define	VM_UVMEXP	3		/* struct uvmexp */
159 #define	VM_NKMEMPAGES	4		/* kmem_map pages */
160 #define	VM_UVMEXP2	5		/* struct uvmexp_sysctl */
161 #define	VM_ANONMIN	6
162 #define	VM_EXECMIN	7
163 #define	VM_FILEMIN	8
164 #define	VM_MAXSLP	9
165 #define	VM_USPACE	10
166 #define	VM_ANONMAX	11
167 #define	VM_EXECMAX	12
168 #define	VM_FILEMAX	13
169 
170 #define	VM_MAXID	14		/* number of valid vm ids */
171 
172 #define	CTL_VM_NAMES { \
173 	{ 0, 0 }, \
174 	{ "vmmeter", CTLTYPE_STRUCT }, \
175 	{ "loadavg", CTLTYPE_STRUCT }, \
176 	{ "uvmexp", CTLTYPE_STRUCT }, \
177 	{ "nkmempages", CTLTYPE_INT }, \
178 	{ "uvmexp2", CTLTYPE_STRUCT }, \
179 	{ "anonmin", CTLTYPE_INT }, \
180 	{ "execmin", CTLTYPE_INT }, \
181 	{ "filemin", CTLTYPE_INT }, \
182 	{ "maxslp", CTLTYPE_INT }, \
183 	{ "uspace", CTLTYPE_INT }, \
184 	{ "anonmax", CTLTYPE_INT }, \
185 	{ "execmax", CTLTYPE_INT }, \
186 	{ "filemax", CTLTYPE_INT }, \
187 }
188 
189 #ifndef ASSEMBLER
190 /*
191  *	Convert addresses to pages and vice versa.
192  *	No rounding is used.
193  */
194 #ifdef _KERNEL
195 #define	atop(x)		(((paddr_t)(x)) >> PAGE_SHIFT)
196 #define	ptoa(x)		((vaddr_t)((vaddr_t)(x) << PAGE_SHIFT))
197 
198 /*
199  * Round off or truncate to the nearest page.  These will work
200  * for either addresses or counts (i.e., 1 byte rounds to 1 page).
201  */
202 #define	round_page(x)	(((x) + PAGE_MASK) & ~PAGE_MASK)
203 #define	trunc_page(x)	((x) & ~PAGE_MASK)
204 
205 /*
206  * Set up the default mapping address (VM_DEFAULT_ADDRESS) according to:
207  *
208  * USE_TOPDOWN_VM:	a kernel option to enable on a per-kernel basis
209  *			which only be used on ports that define...
210  * __HAVE_TOPDOWN_VM:	a per-port option to offer the topdown option
211  *
212  * __USE_TOPDOWN_VM:	a per-port option to unconditionally use it
213  *
214  * if __USE_TOPDOWN_VM is defined, the port can specify a default vm
215  * address, or we will use the topdown default from below.  If it is
216  * NOT defined, then the port can offer topdown as an option, but it
217  * MUST define the VM_DEFAULT_ADDRESS macro itself.
218  */
219 #if defined(USE_TOPDOWN_VM) || defined(__USE_TOPDOWN_VM)
220 # if !defined(__HAVE_TOPDOWN_VM) && !defined(__USE_TOPDOWN_VM)
221 #  error "Top down memory allocation not enabled for this system"
222 # else /* !__HAVE_TOPDOWN_VM && !__USE_TOPDOWN_VM */
223 #  define __USING_TOPDOWN_VM
224 #  if !defined(VM_DEFAULT_ADDRESS)
225 #   if !defined(__USE_TOPDOWN_VM)
226 #    error "Top down memory allocation not configured for this system"
227 #   else /* !__USE_TOPDOWN_VM */
228 #    define VM_DEFAULT_ADDRESS(da, sz) \
229 	trunc_page(VM_MAXUSER_ADDRESS - MAXSSIZ - (sz))
230 #   endif /* !__USE_TOPDOWN_VM */
231 #  endif /* !VM_DEFAULT_ADDRESS */
232 # endif /* !__HAVE_TOPDOWN_VM && !__USE_TOPDOWN_VM */
233 #endif /* USE_TOPDOWN_VM || __USE_TOPDOWN_VM */
234 
235 #if !defined(__USING_TOPDOWN_VM)
236 # if defined(VM_DEFAULT_ADDRESS)
237 #  error "Default vm address should not be defined here"
238 # else /* VM_DEFAULT_ADDRESS */
239 #  define VM_DEFAULT_ADDRESS(da, sz) round_page((vaddr_t)(da) + MAXDSIZ)
240 # endif /* VM_DEFAULT_ADDRESS */
241 #endif /* !__USING_TOPDOWN_VM */
242 
243 extern int		ubc_nwins;	/* number of UBC mapping windows */
244 extern int		ubc_winshift;	/* shift for a UBC mapping window */
245 
246 #else
247 /* out-of-kernel versions of round_page and trunc_page */
248 #define	round_page(x) \
249 	((((vaddr_t)(x) + (vm_page_size - 1)) / vm_page_size) * \
250 	    vm_page_size)
251 #define	trunc_page(x) \
252 	((((vaddr_t)(x)) / vm_page_size) * vm_page_size)
253 
254 #endif /* _KERNEL */
255 #endif /* ASSEMBLER */
256 #endif /* _VM_PARAM_ */
257