xref: /dragonfly/sys/vm/vm.h (revision 0ca59c34)
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)vm.h	8.2 (Berkeley) 12/13/93
34  *	@(#)vm_prot.h	8.1 (Berkeley) 6/11/93
35  *	@(#)vm_inherit.h	8.1 (Berkeley) 6/11/93
36  *
37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
38  * All rights reserved.
39  *
40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
41  *
42  * Permission to use, copy, modify and distribute this software and
43  * its documentation is hereby granted, provided that both the copyright
44  * notice and this permission notice appear in all copies of the
45  * software, derivative works or modified versions, and any portions
46  * thereof, and that both notices appear in supporting documentation.
47  *
48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
51  *
52  * Carnegie Mellon requests users of this software to return to
53  *
54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
55  *  School of Computer Science
56  *  Carnegie Mellon University
57  *  Pittsburgh PA 15213-3890
58  *
59  * any improvements or extensions that they make and grant Carnegie the
60  * rights to redistribute these changes.
61  *
62  * $FreeBSD: src/sys/vm/vm.h,v 1.16.2.1 2002/12/28 19:49:41 dillon Exp $
63  */
64 
65 #ifndef _VM_VM_H_
66 #define _VM_VM_H_
67 
68 #ifndef _SYS_TYPES_H_
69 #include <sys/types.h>
70 #endif
71 #include <machine/specialreg.h>
72 
73 typedef char vm_inherit_t;	/* inheritance codes */
74 
75 #define	VM_INHERIT_SHARE	((vm_inherit_t) 0)
76 #define	VM_INHERIT_COPY		((vm_inherit_t) 1)
77 #define	VM_INHERIT_NONE		((vm_inherit_t) 2)
78 #define	VM_INHERIT_DEFAULT	VM_INHERIT_COPY
79 
80 typedef u_char vm_prot_t;	/* protection codes */
81 
82 #define	VM_PROT_NONE		((vm_prot_t) 0x00)
83 #define	VM_PROT_READ		((vm_prot_t) 0x01)
84 #define	VM_PROT_WRITE		((vm_prot_t) 0x02)
85 #define	VM_PROT_EXECUTE		((vm_prot_t) 0x04)
86 #define	VM_PROT_OVERRIDE_WRITE	((vm_prot_t) 0x08)	/* copy-on-write */
87 #define VM_PROT_NOSYNC		((vm_prot_t) 0x10)
88 
89 #define VM_PROT_RW		(VM_PROT_READ|VM_PROT_WRITE)
90 #define	VM_PROT_ALL		(VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
91 #define	VM_PROT_DEFAULT		VM_PROT_ALL
92 
93 typedef u_char vm_maptype_t;	/* type of vm_map_entry */
94 
95 /*
96  * NOTE: UKSMAPs are unmanaged.  The underlying kernel memory must not be
97  *	 freed until all related mappings are gone.  There is no object.
98  *	 The device can map different things for the same UKS mapping even
99  *	 when inherited via fork().
100  */
101 #define VM_MAPTYPE_UNSPECIFIED	0
102 #define VM_MAPTYPE_NORMAL	1
103 #define VM_MAPTYPE_VPAGETABLE	2
104 #define VM_MAPTYPE_SUBMAP	3
105 #define VM_MAPTYPE_UKSMAP	4	/* user-kernel shared memory */
106 
107 union vm_map_object;
108 typedef union vm_map_object vm_map_object_t;
109 
110 struct vm_map_entry;
111 typedef struct vm_map_entry *vm_map_entry_t;
112 
113 struct vm_map;
114 typedef struct vm_map *vm_map_t;
115 
116 struct vm_object;
117 typedef struct vm_object *vm_object_t;
118 
119 /*
120  * This is also defined in vm/vm_page.h.
121  */
122 #ifndef __VM_PAGE_T_DEFINED__
123 #define __VM_PAGE_T_DEFINED__
124 struct vm_page;
125 typedef struct vm_page *vm_page_t;
126 #endif
127 
128 
129 /* Memory attributes. */
130 
131 #ifndef __VM_MEMATTR_T_DEFINED__
132 #define __VM_MEMATTR_T_DEFINED__
133 typedef char vm_memattr_t;
134 #endif
135 
136 #define VM_MEMATTR_UNCACHEABLE		((vm_memattr_t)PAT_UNCACHEABLE)
137 #define VM_MEMATTR_WRITE_COMBINING	((vm_memattr_t)PAT_WRITE_COMBINING)
138 #define VM_MEMATTR_WRITE_THROUGH	((vm_memattr_t)PAT_WRITE_THROUGH)
139 #define VM_MEMATTR_WRITE_PROTECTED	((vm_memattr_t)PAT_WRITE_PROTECTED)
140 #define VM_MEMATTR_WRITE_BACK		((vm_memattr_t)PAT_WRITE_BACK)
141 #define VM_MEMATTR_WEAK_UNCACHEABLE	((vm_memattr_t)PAT_UNCACHED)
142 
143 #define VM_MEMATTR_DEFAULT	VM_MEMATTR_WRITE_BACK
144 
145 #endif				/* _VM_VM_H_ */
146