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