FreeBSD virtual memory subsystem code
vm.h
Go to the documentation of this file.
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
68typedef 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
76typedef 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_PRIV_FLAG ((vm_prot_t) 0x10)
84#define VM_PROT_FAULT_LOOKUP VM_PROT_PRIV_FLAG
85#define VM_PROT_QUICK_NOFAULT VM_PROT_PRIV_FLAG /* same to save bits */
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
101};
102typedef u_char objtype_t;
103
104union vm_map_object;
106
107struct vm_map_entry;
109
110struct vm_map;
111typedef struct vm_map *vm_map_t;
112
113struct vm_object;
114typedef struct vm_object *vm_object_t;
115
116#ifndef _KERNEL
117/*
118 * This is defined in <sys/types.h> for the kernel so that non-vm kernel
119 * sources (mainly Mach-derived ones such as ddb) don't have to include
120 * vm stuff. Defining it there for applications might break things.
121 * Define it here for "applications" that include vm headers (e.g.,
122 * genassym).
123 */
124#ifndef HAVE_BOOLEAN
125typedef int boolean_t;
126#endif
127
128/*
129 * The exact set of memory attributes is machine dependent. However,
130 * every machine is required to define VM_MEMATTR_DEFAULT and
131 * VM_MEMATTR_UNCACHEABLE.
132 */
133typedef char vm_memattr_t; /* memory attribute codes */
134
135/*
136 * This is defined in <sys/types.h> for the kernel so that vnode_if.h
137 * doesn't have to include <vm/vm.h>.
138 */
139struct vm_page;
140typedef struct vm_page *vm_page_t;
141#endif /* _KERNEL */
142
143struct vm_reserv;
144typedef struct vm_reserv *vm_reserv_t;
145
146/*
147 * Information passed from the machine-independant VM initialization code
148 * for use by machine-dependant code (mainly for MMU support)
149 */
151 vm_offset_t buffer_sva;
152 vm_offset_t buffer_eva;
153 vm_offset_t clean_sva;
154 vm_offset_t clean_eva;
155};
156
157#define VA_IS_CLEANMAP(va) \
158 ((va) >= kmi.clean_sva && (va) < kmi.clean_eva)
159
160extern struct kva_md_info kmi;
161extern void vm_ksubmap_init(struct kva_md_info *);
162
163extern int old_mlock;
164
165extern int vm_ndomains;
166
167#ifdef _KERNEL
168struct ucred;
169bool swap_reserve(vm_ooffset_t incr);
170bool swap_reserve_by_cred(vm_ooffset_t incr, struct ucred *cred);
171void swap_reserve_force(vm_ooffset_t incr);
172void swap_release(vm_ooffset_t decr);
173void swap_release_by_cred(vm_ooffset_t decr, struct ucred *cred);
174void swapper(void);
175#endif
176
177#endif /* VM_H */
vm_offset_t clean_sva
Definition: vm.h:153
vm_offset_t clean_eva
Definition: vm.h:154
vm_offset_t buffer_sva
Definition: vm.h:151
vm_offset_t buffer_eva
Definition: vm.h:152
Definition: vm_map.h:101
Definition: vm_map.h:197
struct kva_md_info kmi
struct vm_map_entry * vm_map_entry_t
Definition: vm.h:108
bool swap_reserve(vm_ooffset_t incr)
Definition: swap_pager.c:255
u_char objtype_t
Definition: vm.h:102
int old_mlock
Definition: vm_mmap.c:101
void swapper(void)
Definition: vm_swapout.c:745
bool swap_reserve_by_cred(vm_ooffset_t incr, struct ucred *cred)
Definition: swap_pager.c:262
char vm_inherit_t
Definition: vm.h:68
struct vm_object * vm_object_t
Definition: vm.h:114
void swap_release_by_cred(vm_ooffset_t decr, struct ucred *cred)
Definition: swap_pager.c:357
u_char vm_prot_t
Definition: vm.h:76
void swap_reserve_force(vm_ooffset_t incr)
Definition: swap_pager.c:326
void vm_ksubmap_init(struct kva_md_info *)
Definition: vm_init.c:151
void swap_release(vm_ooffset_t decr)
Definition: swap_pager.c:346
struct vm_map * vm_map_t
Definition: vm.h:111
struct vm_reserv * vm_reserv_t
Definition: vm.h:144
obj_type
Definition: vm.h:91
@ OBJT_DEFAULT
Definition: vm.h:92
@ OBJT_SG
Definition: vm.h:98
@ OBJT_MGTDEVICE
Definition: vm.h:99
@ OBJT_VNODE
Definition: vm.h:94
@ OBJT_PHYS
Definition: vm.h:96
@ OBJT_DEAD
Definition: vm.h:97
@ OBJT_SWAP
Definition: vm.h:93
@ OBJT_FIRST_DYN
Definition: vm.h:100
@ OBJT_DEVICE
Definition: vm.h:95
int vm_ndomains
Definition: vm_phys.c:81