xref: /freebsd/sys/vm/vm.h (revision d8a0fe102c0cfdfcd5b818f850eff09d8536c9bc)
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  *	@(#)vm.h	8.2 (Berkeley) 12/13/93
32  *	@(#)vm_prot.h	8.1 (Berkeley) 6/11/93
33  *	@(#)vm_inherit.h	8.1 (Berkeley) 6/11/93
34  *
35  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36  * All rights reserved.
37  *
38  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
39  *
40  * Permission to use, copy, modify and distribute this software and
41  * its documentation is hereby granted, provided that both the copyright
42  * notice and this permission notice appear in all copies of the
43  * software, derivative works or modified versions, and any portions
44  * thereof, and that both notices appear in supporting documentation.
45  *
46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
49  *
50  * Carnegie Mellon requests users of this software to return to
51  *
52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
53  *  School of Computer Science
54  *  Carnegie Mellon University
55  *  Pittsburgh PA 15213-3890
56  *
57  * any improvements or extensions that they make and grant Carnegie the
58  * rights to redistribute these changes.
59  *
60  * $FreeBSD$
61  */
62 
63 #ifndef VM_H
64 #define VM_H
65 
66 #include <machine/vm.h>
67 
68 typedef char vm_inherit_t;	/* inheritance codes */
69 
70 #define	VM_INHERIT_SHARE	((vm_inherit_t) 0)
71 #define	VM_INHERIT_COPY		((vm_inherit_t) 1)
72 #define	VM_INHERIT_NONE		((vm_inherit_t) 2)
73 #define	VM_INHERIT_ZERO		((vm_inherit_t) 3)
74 #define	VM_INHERIT_DEFAULT	VM_INHERIT_COPY
75 
76 typedef u_char vm_prot_t;	/* protection codes */
77 
78 #define	VM_PROT_NONE		((vm_prot_t) 0x00)
79 #define	VM_PROT_READ		((vm_prot_t) 0x01)
80 #define	VM_PROT_WRITE		((vm_prot_t) 0x02)
81 #define	VM_PROT_EXECUTE		((vm_prot_t) 0x04)
82 #define	VM_PROT_COPY		((vm_prot_t) 0x08)	/* copy-on-read */
83 #define	VM_PROT_FAULT_LOOKUP	((vm_prot_t) 0x010)
84 
85 #define	VM_PROT_ALL		(VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
86 #define VM_PROT_RW		(VM_PROT_READ|VM_PROT_WRITE)
87 #define	VM_PROT_DEFAULT		VM_PROT_ALL
88 
89 enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
90 		OBJT_DEAD, OBJT_SG, OBJT_MGTDEVICE };
91 typedef u_char objtype_t;
92 
93 union vm_map_object;
94 typedef union vm_map_object vm_map_object_t;
95 
96 struct vm_map_entry;
97 typedef struct vm_map_entry *vm_map_entry_t;
98 
99 struct vm_map;
100 typedef struct vm_map *vm_map_t;
101 
102 struct vm_object;
103 typedef struct vm_object *vm_object_t;
104 
105 #ifndef _KERNEL
106 /*
107  * This is defined in <sys/types.h> for the kernel so that non-vm kernel
108  * sources (mainly Mach-derived ones such as ddb) don't have to include
109  * vm stuff.  Defining it there for applications might break things.
110  * Define it here for "applications" that include vm headers (e.g.,
111  * genassym).
112  */
113 typedef int boolean_t;
114 
115 /*
116  * The exact set of memory attributes is machine dependent.  However,
117  * every machine is required to define VM_MEMATTR_DEFAULT and
118  * VM_MEMATTR_UNCACHEABLE.
119  */
120 typedef	char vm_memattr_t;	/* memory attribute codes */
121 
122 /*
123  * This is defined in <sys/types.h> for the kernel so that vnode_if.h
124  * doesn't have to include <vm/vm.h>.
125  */
126 struct vm_page;
127 typedef struct vm_page *vm_page_t;
128 #endif				/* _KERNEL */
129 
130 struct vm_reserv;
131 typedef struct vm_reserv *vm_reserv_t;
132 
133 /*
134  * Information passed from the machine-independant VM initialization code
135  * for use by machine-dependant code (mainly for MMU support)
136  */
137 struct kva_md_info {
138 	vm_offset_t	buffer_sva;
139 	vm_offset_t	buffer_eva;
140 	vm_offset_t	clean_sva;
141 	vm_offset_t	clean_eva;
142 };
143 
144 extern struct kva_md_info	kmi;
145 extern void vm_ksubmap_init(struct kva_md_info *);
146 
147 extern int old_mlock;
148 
149 struct ucred;
150 int swap_reserve(vm_ooffset_t incr);
151 int swap_reserve_by_cred(vm_ooffset_t incr, struct ucred *cred);
152 void swap_reserve_force(vm_ooffset_t incr);
153 void swap_release(vm_ooffset_t decr);
154 void swap_release_by_cred(vm_ooffset_t decr, struct ucred *cred);
155 void swapper(void);
156 
157 #endif				/* VM_H */
158 
159