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