kernel -- vm locking: Add vm_page_(un)lock and vm_object_(un)lock.
[dragonfly.git] / sys / vm / vm_object.h
1 /*
2  * Copyright (c) 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * The Mach Operating System project at Carnegie-Mellon University.
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  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      from: @(#)vm_object.h   8.3 (Berkeley) 1/12/94
37  *
38  *
39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40  * All rights reserved.
41  *
42  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43  *
44  * Permission to use, copy, modify and distribute this software and
45  * its documentation is hereby granted, provided that both the copyright
46  * notice and this permission notice appear in all copies of the
47  * software, derivative works or modified versions, and any portions
48  * thereof, and that both notices appear in supporting documentation.
49  *
50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53  *
54  * Carnegie Mellon requests users of this software to return to
55  *
56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
57  *  School of Computer Science
58  *  Carnegie Mellon University
59  *  Pittsburgh PA 15213-3890
60  *
61  * any improvements or extensions that they make and grant Carnegie the
62  * rights to redistribute these changes.
63  *
64  * $FreeBSD: src/sys/vm/vm_object.h,v 1.63.2.3 2003/05/26 19:17:56 alc Exp $
65  */
66
67 /*
68  *      Virtual memory object module definitions.
69  */
70
71 #ifndef _VM_VM_OBJECT_H_
72 #define _VM_VM_OBJECT_H_
73
74 #ifndef _SYS_TYPES_H_
75 #include <sys/types.h>
76 #endif
77 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
78 #include <sys/systm.h>
79 #endif
80 #ifndef _SYS_QUEUE_H_
81 #include <sys/queue.h>
82 #endif
83 #ifndef _SYS_TREE_H_
84 #include <sys/tree.h>
85 #endif
86 #ifndef _SYS_THREAD_H_
87 #include <sys/thread.h>
88 #endif
89 #include <machine/atomic.h>
90 #ifndef _VM_VM_H_
91 #include <vm/vm.h>
92 #endif
93 #ifndef _VM_VM_PAGE_H_
94 #include <vm/vm_page.h>
95 #endif
96
97 #ifdef _KERNEL
98
99 #ifndef _SYS_THREAD_H
100 #include <sys/thread.h>
101 #endif
102
103 #ifndef _SYS_THREAD2_H_
104 #include <sys/thread2.h>
105 #endif
106
107 #endif
108
109 struct swblock;
110 struct swblock_rb_tree;
111 int rb_swblock_compare(struct swblock *, struct swblock *);
112
113 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare,
114               vm_pindex_t);
115
116 enum obj_type { 
117         OBJT_DEFAULT,
118         OBJT_SWAP,      /* object backed by swap blocks */
119         OBJT_VNODE,     /* object backed by file pages (vnode) */
120         OBJT_DEVICE,    /* object backed by device pages */
121         OBJT_PHYS,      /* object backed by physical pages */
122         OBJT_DEAD,      /* dead object */
123         OBJT_MARKER     /* marker object */
124 };
125 typedef u_char objtype_t;
126
127 /*
128  * vm_object            A VM object which represents an arbitrarily sized
129  *                      data store.
130  *
131  * Locking requirements: vmobj_token for ref_count and object_list, and
132  * vm_token for everything else.
133  */
134 struct vm_object {
135         TAILQ_ENTRY(vm_object) object_list; /* vmobj_token */
136         LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
137         LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
138         RB_HEAD(vm_page_rb_tree, vm_page) rb_memq;      /* resident pages */
139         int generation;                 /* generation ID */
140         vm_pindex_t size;               /* Object size */
141         int ref_count;                  /* vmobj_token */
142         int shadow_count;               /* how many objects that this is a shadow for */
143         int hash_rand;                  /* vm hash table randomizer     */
144         objtype_t type;                 /* type of pager */
145         u_short flags;                  /* see below */
146         u_short pg_color;               /* color of first page in obj */
147         u_short unused01;
148         int paging_in_progress;         /* Paging (in or out) so don't collapse or destroy */
149         int resident_page_count;        /* number of resident pages */
150         u_int agg_pv_list_count;        /* aggregate pv list count */
151         struct vm_object *backing_object; /* object that I'm a shadow of */
152         vm_ooffset_t backing_object_offset;/* Offset in backing object */
153         TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
154         void *handle;
155         struct lwkt_token tok;
156         
157         union {
158                 /*
159                  * Device pager
160                  *
161                  *      devp_pglist - list of allocated pages
162                  */
163                 struct {
164                         TAILQ_HEAD(, vm_page) devp_pglist;
165                 } devp;
166         } un_pager;
167
168         /*
169          * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing
170          * store.  For vnodes the swap backing store acts as a fast
171          * data cache but the vnode contains the official data.
172          */
173         RB_HEAD(swblock_rb_tree, swblock) swblock_root;
174         int     swblock_count;
175 };
176
177 /*
178  * Flags
179  */
180 #define OBJ_ACTIVE      0x0004          /* active objects */
181 #define OBJ_DEAD        0x0008          /* dead objects (during rundown) */
182 #define OBJ_NOSPLIT     0x0010          /* dont split this object */
183 #define OBJ_PIPWNT      0x0040          /* paging in progress wanted */
184 #define OBJ_WRITEABLE   0x0080          /* object has been made writable */
185 #define OBJ_MIGHTBEDIRTY 0x0100         /* object might be dirty */
186 #define OBJ_CLEANING    0x0200
187 #define OBJ_DEADWNT     0x1000          /* waiting because object is dead */
188 #define OBJ_ONEMAPPING  0x2000          /* One USE (a single, non-forked) mapping flag */
189 #define OBJ_NOMSYNC     0x4000          /* disable msync() system call */
190
191 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
192 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
193
194 #ifdef  _KERNEL
195
196 #define OBJPC_SYNC      0x1                     /* sync I/O */
197 #define OBJPC_INVAL     0x2                     /* invalidate */
198 #define OBJPC_NOSYNC    0x4                     /* skip if PG_NOSYNC */
199
200 TAILQ_HEAD(object_q, vm_object);
201
202 extern struct object_q vm_object_list;  /* list of allocated objects */
203
204  /* lock for object list and count */
205
206 extern struct vm_object kernel_object;  /* the single kernel object */
207
208 #endif                          /* _KERNEL */
209
210 #ifdef _KERNEL
211
212 static __inline void
213 vm_object_set_flag(vm_object_t object, u_int bits)
214 {
215         atomic_set_short(&object->flags, bits);
216 }
217
218 static __inline void
219 vm_object_clear_flag(vm_object_t object, u_int bits)
220 {
221         atomic_clear_short(&object->flags, bits);
222 }
223
224 static __inline void
225 vm_object_pip_add(vm_object_t object, int i)
226 {
227         atomic_add_int(&object->paging_in_progress, i);
228 }
229
230 static __inline void
231 vm_object_pip_subtract(vm_object_t object, int i)
232 {
233         atomic_subtract_int(&object->paging_in_progress, i);
234 }
235
236 static __inline void
237 vm_object_pip_wakeup(vm_object_t object)
238 {
239         atomic_subtract_int(&object->paging_in_progress, 1);
240         if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
241                 vm_object_clear_flag(object, OBJ_PIPWNT);
242                 wakeup(object);
243         }
244 }
245
246 static __inline void
247 vm_object_pip_wakeupn(vm_object_t object, int i)
248 {
249         if (i)
250                 atomic_subtract_int(&object->paging_in_progress, i);
251         if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
252                 vm_object_clear_flag(object, OBJ_PIPWNT);
253                 wakeup(object);
254         }
255 }
256
257 static __inline void
258 vm_object_pip_sleep(vm_object_t object, char *waitid)
259 {
260         if (object->paging_in_progress) {
261                 crit_enter();
262                 if (object->paging_in_progress) {
263                         vm_object_set_flag(object, OBJ_PIPWNT);
264                         tsleep(object, 0, waitid, 0);
265                 }
266                 crit_exit();
267         }
268 }
269
270 static __inline void
271 vm_object_pip_wait(vm_object_t object, char *waitid)
272 {
273         while (object->paging_in_progress)
274                 vm_object_pip_sleep(object, waitid);
275 }
276
277 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
278 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
279 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
280 void vm_object_collapse (vm_object_t);
281 void vm_object_deallocate (vm_object_t);
282 void vm_object_deallocate_locked (vm_object_t);
283 void vm_object_terminate (vm_object_t);
284 void vm_object_set_writeable_dirty (vm_object_t);
285 void vm_object_init (void);
286 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
287 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
288 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
289 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
290 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
291 void vm_object_reference (vm_object_t);
292 void vm_object_reference_locked (vm_object_t);
293 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
294 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
295 void vm_object_init2 (void);
296 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t, vm_prot_t, int, int *);
297 void vm_object_dead_sleep(vm_object_t, const char *);
298 void vm_object_dead_wakeup(vm_object_t);
299 void vm_object_lock(vm_object_t);
300 void vm_object_unlock(vm_object_t);
301
302 #endif                          /* _KERNEL */
303
304 #endif                          /* _VM_VM_OBJECT_H_ */