vm_param.h revision 1542 
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 *	@(#)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
65/*
66 *	Machine independent virtual memory parameters.
67 */
68
69#ifndef	_VM_PARAM_
70#define	_VM_PARAM_
71
72#include <machine/vmparam.h>
73
74/*
75 * This belongs in types.h, but breaks too many existing programs.
76 */
77typedef int	boolean_t;
78#define	TRUE	1
79#define	FALSE	0
80
81/*
82 *	The machine independent pages are refered to as PAGES.  A page
83 *	is some number of hardware pages, depending on the target machine.
84 */
85#define DEFAULT_PAGE_SIZE	4096
86
87/*
88 *	All references to the size of a page should be done with PAGE_SIZE
89 *	or PAGE_SHIFT.  The fact they are variables is hidden here so that
90 *	we can easily make them constant if we so desire.
91 */
92#define	PAGE_SIZE	cnt.v_page_size		/* size of page */
93#define PAGE_MASK	page_mask		/* size of page - 1 */
94#define PAGE_SHIFT	page_shift		/* bits to shift for pages */
95#ifdef KERNEL
96extern vm_size_t	page_mask;
97extern int		page_shift;
98#endif
99
100/*
101 * CTL_VM identifiers
102 */
103#define	VM_METER	 1		/* struct vmmeter */
104#define	VM_LOADAVG	 2		/* struct loadavg */
105#define	VM_MAXID	 3		/* number of valid vm ids */
106
107#define CTL_VM_NAMES { \
108	{ 0, 0 }, \
109	{ "vmmeter", CTLTYPE_STRUCT }, \
110	{ "loadavg", CTLTYPE_STRUCT }, \
111}
112
113/*
114 *	Return values from the VM routines.
115 */
116#define	KERN_SUCCESS		0
117#define	KERN_INVALID_ADDRESS	1
118#define	KERN_PROTECTION_FAILURE	2
119#define	KERN_NO_SPACE		3
120#define	KERN_INVALID_ARGUMENT	4
121#define	KERN_FAILURE		5
122#define	KERN_RESOURCE_SHORTAGE	6
123#define	KERN_NOT_RECEIVER	7
124#define	KERN_NO_ACCESS		8
125
126#ifndef ASSEMBLER
127/*
128 *	Convert addresses to pages and vice versa.
129 *	No rounding is used.
130 */
131#ifdef KERNEL
132#define	atop(x)		(((unsigned)(x)) >> PAGE_SHIFT)
133#define	ptoa(x)		((vm_offset_t)((x) << PAGE_SHIFT))
134
135/*
136 * Round off or truncate to the nearest page.  These will work
137 * for either addresses or counts (i.e., 1 byte rounds to 1 page).
138 */
139#define round_page(x) \
140	((vm_offset_t)((((vm_offset_t)(x)) + PAGE_MASK) & ~PAGE_MASK))
141#define trunc_page(x) \
142	((vm_offset_t)(((vm_offset_t)(x)) & ~PAGE_MASK))
143#define num_pages(x) \
144	((vm_offset_t)((((vm_offset_t)(x)) + PAGE_MASK) >> PAGE_SHIFT))
145
146extern vm_size_t	mem_size;	/* size of physical memory (bytes) */
147extern vm_offset_t	first_addr;	/* first physical page */
148extern vm_offset_t	last_addr;	/* last physical page */
149
150#else
151/* out-of-kernel versions of round_page and trunc_page */
152#define	round_page(x) \
153       ((((vm_offset_t)(x) + (vm_page_size - 1)) / vm_page_size) * vm_page_size)
154#define	trunc_page(x) \
155	((((vm_offset_t)(x)) / vm_page_size) * vm_page_size)
156
157#endif /* KERNEL */
158#endif /* ASSEMBLER */
159#endif /* _VM_PARAM_ */
160