xref: /freebsd/sys/vm/vm.h (revision 7850fa71f55a16f414bb21163d80a03a5ab34522)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)vm.h	8.2 (Berkeley) 12/13/93
30  *	@(#)vm_prot.h	8.1 (Berkeley) 6/11/93
31  *	@(#)vm_inherit.h	8.1 (Berkeley) 6/11/93
32  *
33  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
34  * All rights reserved.
35  *
36  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
37  *
38  * Permission to use, copy, modify and distribute this software and
39  * its documentation is hereby granted, provided that both the copyright
40  * notice and this permission notice appear in all copies of the
41  * software, derivative works or modified versions, and any portions
42  * thereof, and that both notices appear in supporting documentation.
43  *
44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
46  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
47  *
48  * Carnegie Mellon requests users of this software to return to
49  *
50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
51  *  School of Computer Science
52  *  Carnegie Mellon University
53  *  Pittsburgh PA 15213-3890
54  *
55  * any improvements or extensions that they make and grant Carnegie the
56  * rights to redistribute these changes.
57  *
58  * $FreeBSD$
59  */
60 
61 #ifndef VM_H
62 #define VM_H
63 
64 #include <machine/vm.h>
65 
66 /*
67  * The exact set of cache control codes is machine dependent.  However, every
68  * machine is required to define VM_CACHE_DEFAULT.
69  */
70 typedef	char vm_cache_mode_t;	/* cache control codes */
71 
72 typedef char vm_inherit_t;	/* inheritance codes */
73 
74 #define	VM_INHERIT_SHARE	((vm_inherit_t) 0)
75 #define	VM_INHERIT_COPY		((vm_inherit_t) 1)
76 #define	VM_INHERIT_NONE		((vm_inherit_t) 2)
77 #define	VM_INHERIT_DEFAULT	VM_INHERIT_COPY
78 
79 typedef u_char vm_prot_t;	/* protection codes */
80 
81 #define	VM_PROT_NONE		((vm_prot_t) 0x00)
82 #define	VM_PROT_READ		((vm_prot_t) 0x01)
83 #define	VM_PROT_WRITE		((vm_prot_t) 0x02)
84 #define	VM_PROT_EXECUTE		((vm_prot_t) 0x04)
85 #define	VM_PROT_OVERRIDE_WRITE	((vm_prot_t) 0x08)	/* copy-on-write */
86 
87 #define	VM_PROT_ALL		(VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
88 #define VM_PROT_RW		(VM_PROT_READ|VM_PROT_WRITE)
89 #define	VM_PROT_DEFAULT		VM_PROT_ALL
90 
91 enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
92 		OBJT_DEAD };
93 typedef u_char objtype_t;
94 
95 union vm_map_object;
96 typedef union vm_map_object vm_map_object_t;
97 
98 struct vm_map_entry;
99 typedef struct vm_map_entry *vm_map_entry_t;
100 
101 struct vm_map;
102 typedef struct vm_map *vm_map_t;
103 
104 struct vm_object;
105 typedef struct vm_object *vm_object_t;
106 
107 #ifndef _KERNEL
108 /*
109  * This is defined in <sys/types.h> for the kernel so that non-vm kernel
110  * sources (mainly Mach-derived ones such as ddb) don't have to include
111  * vm stuff.  Defining it there for applications might break things.
112  * Define it here for "applications" that include vm headers (e.g.,
113  * genassym).
114  */
115 typedef int boolean_t;
116 
117 /*
118  * This is defined in <sys/types.h> for the kernel so that vnode_if.h
119  * doesn't have to include <vm/vm.h>.
120  */
121 struct vm_page;
122 typedef struct vm_page *vm_page_t;
123 #endif				/* _KERNEL */
124 
125 struct vm_reserv;
126 typedef struct vm_reserv *vm_reserv_t;
127 
128 /*
129  * Information passed from the machine-independant VM initialization code
130  * for use by machine-dependant code (mainly for MMU support)
131  */
132 struct kva_md_info {
133 	vm_offset_t	buffer_sva;
134 	vm_offset_t	buffer_eva;
135 	vm_offset_t	clean_sva;
136 	vm_offset_t	clean_eva;
137 	vm_offset_t	pager_sva;
138 	vm_offset_t	pager_eva;
139 };
140 
141 extern struct kva_md_info	kmi;
142 extern void vm_ksubmap_init(struct kva_md_info *);
143 
144 struct uidinfo;
145 int swap_reserve(vm_ooffset_t incr);
146 int swap_reserve_by_uid(vm_ooffset_t incr, struct uidinfo *uip);
147 void swap_reserve_force(vm_ooffset_t incr);
148 void swap_release(vm_ooffset_t decr);
149 void swap_release_by_uid(vm_ooffset_t decr, struct uidinfo *uip);
150 
151 #endif				/* VM_H */
152 
153