1/* $NetBSD: uvm_param.h,v 1.42 2023/07/11 09:48:56 riastradh 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_modular.h"
72#include "opt_uvm.h"
73#endif
74#ifdef _KERNEL
75#include <sys/types.h>
76#include <machine/vmparam.h>
77#endif
78
79#if defined(_KERNEL)
80
81#if defined(PAGE_SIZE)
82
83/*
84 * If PAGE_SIZE is defined at this stage, it must be a constant.
85 */
86
87#if PAGE_SIZE == 0
88#error Invalid PAGE_SIZE definition
89#endif
90
91/*
92 * If the platform does not need to support a variable PAGE_SIZE,
93 * then provide default values for MIN_PAGE_SIZE and MAX_PAGE_SIZE.
94 */
95
96#if !defined(MIN_PAGE_SIZE)
97#define MIN_PAGE_SIZE PAGE_SIZE
98#endif /* ! MIN_PAGE_SIZE */
99
100#if !defined(MAX_PAGE_SIZE)
101#define MAX_PAGE_SIZE PAGE_SIZE
102#endif /* ! MAX_PAGE_SIZE */
103
104#else /* ! PAGE_SIZE */
105
106/*
107 * PAGE_SIZE is not a constant; MIN_PAGE_SIZE and MAX_PAGE_SIZE must
108 * be defined.
109 */
110
111#if !defined(MIN_PAGE_SIZE)
112#error MIN_PAGE_SIZE not defined
113#endif
114
115#if !defined(MAX_PAGE_SIZE)
116#error MAX_PAGE_SIZE not defined
117#endif
118
119#endif /* PAGE_SIZE */
120
121/*
122 * MIN_PAGE_SIZE and MAX_PAGE_SIZE must be constants.
123 */
124
125#if MIN_PAGE_SIZE == 0
126#error Invalid MIN_PAGE_SIZE definition
127#endif
128
129#if MAX_PAGE_SIZE == 0
130#error Invalid MAX_PAGE_SIZE definition
131#endif
132
133/*
134 * If MIN_PAGE_SIZE and MAX_PAGE_SIZE are not equal, then we must use
135 * non-constant PAGE_SIZE, et al for modules.
136 */
137#if (MIN_PAGE_SIZE != MAX_PAGE_SIZE)
138#define __uvmexp_pagesize
139#if defined(_MODULE)
140#undef PAGE_SIZE
141#undef PAGE_MASK
142#undef PAGE_SHIFT
143#endif
144#endif
145
146/*
147 * Now provide PAGE_SIZE, PAGE_MASK, and PAGE_SHIFT if we do not
148 * have ones that are compile-time constants.
149 */
150#if !defined(PAGE_SIZE)
151extern const int *const uvmexp_pagesize;
152extern const int *const uvmexp_pagemask;
153extern const int *const uvmexp_pageshift;
154#define PAGE_SIZE (*uvmexp_pagesize) /* size of page */
155#define PAGE_MASK (*uvmexp_pagemask) /* size of page - 1 */
156#define PAGE_SHIFT (*uvmexp_pageshift) /* bits to shift for pages */
157#endif /* PAGE_SIZE */
158
159#endif /* _KERNEL */
160
161/*
162 * CTL_VM identifiers
163 */
164#define VM_METER 1 /* struct vmmeter */
165#define VM_LOADAVG 2 /* struct loadavg */
166#define VM_UVMEXP 3 /* struct uvmexp */
167#define VM_NKMEMPAGES 4 /* kmem_map pages */
168#define VM_UVMEXP2 5 /* struct uvmexp_sysctl */
169#define VM_ANONMIN 6
170#define VM_EXECMIN 7
171#define VM_FILEMIN 8
172#define VM_MAXSLP 9
173#define VM_USPACE 10
174#define VM_ANONMAX 11
175#define VM_EXECMAX 12
176#define VM_FILEMAX 13
177#define VM_MINADDRESS 14
178#define VM_MAXADDRESS 15
179#define VM_PROC 16 /* process information */
180#define VM_GUARD_SIZE 17 /* guard size for main thread */
181#define VM_THREAD_GUARD_SIZE 18 /* default guard size for new threads */
182
183#define VM_PROC_MAP 1 /* struct kinfo_vmentry */
184
185#ifndef ASSEMBLER
186/*
187 * Convert addresses to pages and vice versa.
188 * No rounding is used.
189 */
190#ifdef _KERNEL
191#define atop(x) (((paddr_t)(x)) >> PAGE_SHIFT)
192#define ptoa(x) (((paddr_t)(x)) << PAGE_SHIFT)
193
194/*
195 * Round off or truncate to the nearest page. These will work
196 * for either addresses or counts (i.e., 1 byte rounds to 1 page).
197 */
198#define round_page(x) (((x) + PAGE_MASK) & ~PAGE_MASK)
199#define trunc_page(x) ((x) & ~PAGE_MASK)
200
201#ifndef VM_DEFAULT_ADDRESS_BOTTOMUP
202#define VM_DEFAULT_ADDRESS_BOTTOMUP(da, sz) \
203 round_page((vaddr_t)(da) + (vsize_t)maxdmap)
204#endif
205
206extern unsigned int user_stack_guard_size;
207extern unsigned int user_thread_stack_guard_size;
208#ifndef VM_DEFAULT_ADDRESS_TOPDOWN
209#define VM_DEFAULT_ADDRESS_TOPDOWN(da, sz) \
210 trunc_page(VM_MAXUSER_ADDRESS - MAXSSIZ - (sz) - user_stack_guard_size)
211#endif
212
213extern int ubc_nwins; /* number of UBC mapping windows */
214extern const int ubc_winshift; /* shift for a UBC mapping window */
215
216#else
217/* out-of-kernel versions of round_page and trunc_page */
218#define round_page(x) \
219 ((((vaddr_t)(x) + (vm_page_size - 1)) / vm_page_size) * \
220 vm_page_size)
221#define trunc_page(x) \
222 ((((vaddr_t)(x)) / vm_page_size) * vm_page_size)
223
224#endif /* _KERNEL */
225
226/*
227 * typedefs, necessary for standard UVM headers.
228 */
229
230typedef unsigned int uvm_flag_t;
231
232typedef int vm_inherit_t; /* XXX: inheritance codes */
233typedef off_t voff_t; /* XXX: offset within a uvm_object */
234typedef voff_t pgoff_t; /* XXX: number of pages within a uvm object */
235
236#endif /* ASSEMBLER */
237#endif /* _VM_PARAM_ */