xref: /freebsd/sys/vm/vm.h (revision ea825d02749f382c3f7e17f28247f20a48733eab)
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  * 3. 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 typedef char vm_inherit_t;	/* inheritance codes */
67 
68 #define	VM_INHERIT_SHARE	((vm_inherit_t) 0)
69 #define	VM_INHERIT_COPY		((vm_inherit_t) 1)
70 #define	VM_INHERIT_NONE		((vm_inherit_t) 2)
71 #define	VM_INHERIT_ZERO		((vm_inherit_t) 3)
72 #define	VM_INHERIT_DEFAULT	VM_INHERIT_COPY
73 
74 typedef u_char vm_prot_t;	/* protection codes */
75 
76 #define	VM_PROT_NONE		((vm_prot_t) 0x00)
77 #define	VM_PROT_READ		((vm_prot_t) 0x01)
78 #define	VM_PROT_WRITE		((vm_prot_t) 0x02)
79 #define	VM_PROT_EXECUTE		((vm_prot_t) 0x04)
80 #define	VM_PROT_COPY		((vm_prot_t) 0x08)	/* copy-on-read */
81 #define	VM_PROT_FAULT_LOOKUP	((vm_prot_t) 0x010)
82 
83 #define	VM_PROT_ALL		(VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
84 #define VM_PROT_RW		(VM_PROT_READ|VM_PROT_WRITE)
85 #define	VM_PROT_DEFAULT		VM_PROT_ALL
86 
87 enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
88 		OBJT_DEAD, OBJT_SG, OBJT_MGTDEVICE };
89 typedef u_char objtype_t;
90 
91 union vm_map_object;
92 typedef union vm_map_object vm_map_object_t;
93 
94 struct vm_map_entry;
95 typedef struct vm_map_entry *vm_map_entry_t;
96 
97 struct vm_map;
98 typedef struct vm_map *vm_map_t;
99 
100 struct vm_object;
101 typedef struct vm_object *vm_object_t;
102 
103 #ifndef _KERNEL
104 /*
105  * This is defined in <sys/types.h> for the kernel so that non-vm kernel
106  * sources (mainly Mach-derived ones such as ddb) don't have to include
107  * vm stuff.  Defining it there for applications might break things.
108  * Define it here for "applications" that include vm headers (e.g.,
109  * genassym).
110  */
111 typedef int boolean_t;
112 
113 /*
114  * The exact set of memory attributes is machine dependent.  However,
115  * every machine is required to define VM_MEMATTR_DEFAULT and
116  * VM_MEMATTR_UNCACHEABLE.
117  */
118 typedef	char vm_memattr_t;	/* memory attribute codes */
119 
120 /*
121  * This is defined in <sys/types.h> for the kernel so that vnode_if.h
122  * doesn't have to include <vm/vm.h>.
123  */
124 struct vm_page;
125 typedef struct vm_page *vm_page_t;
126 #endif				/* _KERNEL */
127 
128 struct vm_reserv;
129 typedef struct vm_reserv *vm_reserv_t;
130 
131 /*
132  * Information passed from the machine-independant VM initialization code
133  * for use by machine-dependant code (mainly for MMU support)
134  */
135 struct kva_md_info {
136 	vm_offset_t	buffer_sva;
137 	vm_offset_t	buffer_eva;
138 	vm_offset_t	clean_sva;
139 	vm_offset_t	clean_eva;
140 };
141 
142 extern struct kva_md_info	kmi;
143 extern void vm_ksubmap_init(struct kva_md_info *);
144 
145 extern int old_mlock;
146 
147 struct ucred;
148 int swap_reserve(vm_ooffset_t incr);
149 int swap_reserve_by_cred(vm_ooffset_t incr, struct ucred *cred);
150 void swap_reserve_force(vm_ooffset_t incr);
151 void swap_release(vm_ooffset_t decr);
152 void swap_release_by_cred(vm_ooffset_t decr, struct ucred *cred);
153 void swapper(void);
154 
155 #endif				/* VM_H */
156 
157