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_QUICK_NOFAULT VM_PROT_PRIV_FLAG /* same to save bits */ 80 81 #define VM_PROT_ALL (VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE) 82 #define VM_PROT_RW (VM_PROT_READ|VM_PROT_WRITE) 83 #define VM_PROT_DEFAULT VM_PROT_ALL 84 85 enum obj_type { 86 OBJT_RESERVED = 0, /* was OBJT_DEFAULT */ 87 OBJT_SWAP, 88 OBJT_DEFAULT = OBJT_SWAP, 89 OBJT_VNODE, 90 OBJT_DEVICE, 91 OBJT_PHYS, 92 OBJT_DEAD, 93 OBJT_SG, 94 OBJT_MGTDEVICE, 95 OBJT_FIRST_DYN, 96 }; 97 typedef u_char objtype_t; 98 99 union vm_map_object; 100 typedef union vm_map_object vm_map_object_t; 101 102 struct vm_map_entry; 103 typedef struct vm_map_entry *vm_map_entry_t; 104 105 struct vm_map; 106 typedef struct vm_map *vm_map_t; 107 108 struct vm_object; 109 typedef struct vm_object *vm_object_t; 110 111 #ifndef _KERNEL 112 /* 113 * This is defined in <sys/types.h> for the kernel so that non-vm kernel 114 * sources (mainly Mach-derived ones such as ddb) don't have to include 115 * vm stuff. Defining it there for applications might break things. 116 * Define it here for "applications" that include vm headers (e.g., 117 * genassym). 118 */ 119 #ifndef HAVE_BOOLEAN 120 typedef int boolean_t; 121 #endif 122 123 /* 124 * The exact set of memory attributes is machine dependent. However, 125 * every machine is required to define VM_MEMATTR_DEFAULT and 126 * VM_MEMATTR_UNCACHEABLE. 127 */ 128 typedef char vm_memattr_t; /* memory attribute codes */ 129 130 /* 131 * This is defined in <sys/types.h> for the kernel so that vnode_if.h 132 * doesn't have to include <vm/vm.h>. 133 */ 134 struct vm_page; 135 typedef struct vm_page *vm_page_t; 136 #endif /* _KERNEL */ 137 138 struct vm_reserv; 139 typedef struct vm_reserv *vm_reserv_t; 140 141 /* 142 * Information passed from the machine-independent VM initialization code 143 * for use by machine-dependant code (mainly for MMU support) 144 */ 145 struct kva_md_info { 146 vm_offset_t buffer_sva; 147 vm_offset_t buffer_eva; 148 vm_offset_t clean_sva; 149 vm_offset_t clean_eva; 150 }; 151 152 /* bits from overcommit */ 153 #define SWAP_RESERVE_FORCE_ON (1 << 0) 154 #define SWAP_RESERVE_RLIMIT_ON (1 << 1) 155 #define SWAP_RESERVE_ALLOW_NONWIRED (1 << 2) 156 157 #ifdef _KERNEL 158 struct ucred; 159 160 void vm_ksubmap_init(struct kva_md_info *); 161 bool swap_reserve(vm_ooffset_t incr); 162 bool swap_reserve_by_cred(vm_ooffset_t incr, struct ucred *cred); 163 void swap_reserve_force(vm_ooffset_t incr); 164 void swap_release(vm_ooffset_t decr); 165 void swap_release_by_cred(vm_ooffset_t decr, struct ucred *cred); 166 void swapper(void); 167 168 extern struct kva_md_info kmi; 169 #define VA_IS_CLEANMAP(va) \ 170 ((va) >= kmi.clean_sva && (va) < kmi.clean_eva) 171 172 extern int old_mlock; 173 extern int vm_ndomains; 174 extern int vm_overcommit; 175 #endif /* _KERNEL */ 176 177 #endif /* VM_H */ 178