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