xref: /freebsd/sys/vm/vm_param.h (revision 953a3198a35204535cc9d450f04da982a4fea59b)
1 /*
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * The Mach Operating System project at Carnegie-Mellon University.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	from: @(#)vm_param.h	8.1 (Berkeley) 6/11/93
37  *
38  *
39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40  * All rights reserved.
41  *
42  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43  *
44  * Permission to use, copy, modify and distribute this software and
45  * its documentation is hereby granted, provided that both the copyright
46  * notice and this permission notice appear in all copies of the
47  * software, derivative works or modified versions, and any portions
48  * thereof, and that both notices appear in supporting documentation.
49  *
50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53  *
54  * Carnegie Mellon requests users of this software to return to
55  *
56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
57  *  School of Computer Science
58  *  Carnegie Mellon University
59  *  Pittsburgh PA 15213-3890
60  *
61  * any improvements or extensions that they make and grant Carnegie the
62  * rights to redistribute these changes.
63  *
64  * $Id: vm_param.h,v 1.3 1994/08/02 07:55:37 davidg Exp $
65  */
66 
67 /*
68  *	Machine independent virtual memory parameters.
69  */
70 
71 #ifndef	_VM_PARAM_
72 #define	_VM_PARAM_
73 
74 #include <machine/vmparam.h>
75 
76 /*
77  * This belongs in types.h, but breaks too many existing programs.
78  */
79 typedef int boolean_t;
80 
81 #define	TRUE	1
82 #define	FALSE	0
83 
84 /*
85  *	The machine independent pages are refered to as PAGES.  A page
86  *	is some number of hardware pages, depending on the target machine.
87  */
88 #define DEFAULT_PAGE_SIZE	4096
89 
90 #if 0
91 
92 /*
93  *	All references to the size of a page should be done with PAGE_SIZE
94  *	or PAGE_SHIFT.  The fact they are variables is hidden here so that
95  *	we can easily make them constant if we so desire.
96  */
97 #ifndef PAGE_SIZE
98 #define	PAGE_SIZE	cnt.v_page_size	/* size of page */
99 #endif
100 #ifndef PAGE_MASK
101 #define PAGE_MASK	page_mask	/* size of page - 1 */
102 #endif
103 #ifndef PAGE_SHIFT
104 #define PAGE_SHIFT	page_shift	/* bits to shift for pages */
105 #endif
106 
107 #endif
108 
109 #ifdef KERNEL
110 extern vm_size_t page_mask;
111 extern int page_shift;
112 
113 #endif
114 
115 /*
116  * CTL_VM identifiers
117  */
118 #define	VM_METER		1	/* struct vmmeter */
119 #define	VM_LOADAVG	 	2	/* struct loadavg */
120 #define VM_V_FREE_MIN		3	/* cnt.v_free_min */
121 #define VM_V_FREE_TARGET	4	/* cnt.v_free_target */
122 #define VM_V_FREE_RESERVED	5	/* cnt.v_free_reserved */
123 #define VM_V_INACTIVE_TARGET	6	/* cnt.v_inactive_target */
124 #define VM_V_CACHE_MIN		7	/* cnt.v_cache_max */
125 #define VM_V_CACHE_MAX		8	/* cnt.v_cache_min */
126 #define VM_V_PAGEOUT_FREE_MIN	9	/* cnt.v_pageout_free_min */
127 #define	VM_MAXID		10	/* number of valid vm ids */
128 
129 #define CTL_VM_NAMES { \
130 	{ 0, 0 }, \
131 	{ "vmmeter", CTLTYPE_STRUCT }, \
132 	{ "loadavg", CTLTYPE_STRUCT }, \
133 	{ "v_free_min", CTLTYPE_INT }, \
134 	{ "v_free_target", CTLTYPE_INT }, \
135 	{ "v_free_reserved", CTLTYPE_INT }, \
136 	{ "v_inactive_target", CTLTYPE_INT }, \
137 	{ "v_cache_min", CTLTYPE_INT }, \
138 	{ "v_cache_max", CTLTYPE_INT }, \
139 	{ "v_pageout_free_min", CTLTYPE_INT}, \
140 }
141 
142 /*
143  *	Return values from the VM routines.
144  */
145 #define	KERN_SUCCESS		0
146 #define	KERN_INVALID_ADDRESS	1
147 #define	KERN_PROTECTION_FAILURE	2
148 #define	KERN_NO_SPACE		3
149 #define	KERN_INVALID_ARGUMENT	4
150 #define	KERN_FAILURE		5
151 #define	KERN_RESOURCE_SHORTAGE	6
152 #define	KERN_NOT_RECEIVER	7
153 #define	KERN_NO_ACCESS		8
154 
155 #ifndef ASSEMBLER
156 /*
157  *	Convert addresses to pages and vice versa.
158  *	No rounding is used.
159  */
160 #ifdef KERNEL
161 #define num_pages(x) \
162 	((vm_offset_t)((((vm_offset_t)(x)) + PAGE_MASK) >> PAGE_SHIFT))
163 
164 extern vm_size_t mem_size;	/* size of physical memory (bytes) */
165 extern vm_offset_t first_addr;	/* first physical page */
166 extern vm_offset_t last_addr;	/* last physical page */
167 #endif				/* KERNEL */
168 #endif				/* ASSEMBLER */
169 #endif				/* _VM_PARAM_ */
170