xref: /openbsd-src/sys/uvm/uvm.h (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1 /*	$OpenBSD: uvm.h,v 1.56 2014/07/11 16:35:40 jsg Exp $	*/
2 /*	$NetBSD: uvm.h,v 1.24 2000/11/27 08:40:02 chs Exp $	*/
3 
4 /*
5  * Copyright (c) 1997 Charles D. Cranor and Washington University.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * from: Id: uvm.h,v 1.1.2.14 1998/02/02 20:07:19 chuck Exp
29  */
30 
31 #ifndef _UVM_UVM_H_
32 #define _UVM_UVM_H_
33 
34 #include <uvm/uvm_extern.h>
35 #include <uvm/uvm_amap.h>
36 #include <uvm/uvm_aobj.h>
37 #include <uvm/uvm_fault.h>
38 #include <uvm/uvm_glue.h>
39 #include <uvm/uvm_km.h>
40 #include <uvm/uvm_swap.h>
41 #ifdef UVM_SWAP_ENCRYPT
42 #include <uvm/uvm_swap_encrypt.h>
43 #endif
44 
45 #include <uvm/uvm_pmemrange.h>
46 
47 /*
48  * uvm structure (vm global state: collected in one structure for ease
49  * of reference...)
50  */
51 
52 struct uvm {
53 	/* vm_page related parameters */
54 
55 	/* vm_page queues */
56 	struct pglist page_active;	/* allocated pages, in use */
57 	struct pglist page_inactive_swp;/* pages inactive (reclaim or free) */
58 	struct pglist page_inactive_obj;/* pages inactive (reclaim or free) */
59 	/* Lock order: pageqlock, then fpageqlock. */
60 	struct mutex fpageqlock;	/* lock for free page q  + pdaemon */
61 	boolean_t page_init_done;	/* TRUE if uvm_page_init() finished */
62 	boolean_t page_idle_zero;	/* TRUE if we should try to zero
63 					   pages in the idle loop */
64 	struct uvm_pmr_control pmr_control; /* pmemrange data */
65 
66 		/* page daemon trigger */
67 	int pagedaemon;			/* daemon sleeps on this */
68 	struct proc *pagedaemon_proc;	/* daemon's pid */
69 
70 		/* aiodone daemon trigger */
71 	int aiodoned;			/* daemon sleeps on this */
72 	struct proc *aiodoned_proc;	/* daemon's pid */
73 	struct mutex aiodoned_lock;
74 
75 	/* static kernel map entry pool */
76 	vm_map_entry_t kentry_free;	/* free page pool */
77 
78 	/* aio_done is locked by uvm.aiodoned_lock. */
79 	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
80 
81 	/* kernel object: to support anonymous pageable kernel memory */
82 	struct uvm_object *kernel_object;
83 };
84 
85 /*
86  * vm_map_entry etype bits:
87  */
88 
89 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
90 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
91 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
92 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
93 #define	UVM_ET_HOLE		0x10	/* no backend */
94 #define UVM_ET_FREEMAPPED	0x80	/* map entry is on free list (DEBUG) */
95 
96 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
97 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
98 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
99 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
100 #define UVM_ET_ISHOLE(E)	(((E)->etype & UVM_ET_HOLE) != 0)
101 
102 #ifdef _KERNEL
103 
104 /*
105  * holds all the internal UVM data
106  */
107 extern struct uvm uvm;
108 
109 /*
110  * UVM_WAIT: wait... wrapper around the tsleep() function.
111  */
112 
113 #define	UVM_WAIT(event, intr, msg, timo)				\
114 do {									\
115 	tsleep(event, PVM|(intr ? PCATCH : 0), msg, timo);		\
116 } while (0)
117 
118 /*
119  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
120  */
121 
122 #if defined(UVM_PAGE_TRKOWN)
123 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
124 #else
125 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
126 #endif /* UVM_PAGE_TRKOWN */
127 
128 /*
129  * uvm_map internal functions.
130  * Used by uvm_map address selectors.
131  */
132 struct vm_map_entry	*uvm_map_entrybyaddr(struct uvm_map_addr *, vaddr_t);
133 int			 uvm_map_isavail(struct vm_map *,
134 			    struct uvm_addr_state *,
135 			    struct vm_map_entry **, struct vm_map_entry**,
136 			    vaddr_t, vsize_t);
137 struct uvm_addr_state	*uvm_map_uaddr(struct vm_map *, vaddr_t);
138 struct uvm_addr_state	*uvm_map_uaddr_e(struct vm_map *, struct vm_map_entry *);
139 
140 #define VMMAP_FREE_START(_entry)	((_entry)->end + (_entry)->guard)
141 #define VMMAP_FREE_END(_entry)		((_entry)->end + (_entry)->guard + \
142 					    (_entry)->fspace)
143 
144 #endif /* _KERNEL */
145 
146 #endif /* _UVM_UVM_H_ */
147