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  * $DragonFly: src/sys/vm/vm_object.h,v 1.14 2007/06/08 02:00:47 dillon Exp $
  66  */
  67
  68 /*
  69  *      Virtual memory object module definitions.
  70  */
  71
  72 #ifndef _VM_VM_OBJECT_H_
  73 #define _VM_VM_OBJECT_H_
  74
  75 #ifndef _SYS_TYPES_H_
  76 #include <sys/types.h>
  77 #endif
  78 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
  79 #include <sys/systm.h>
  80 #endif
  81 #ifndef _SYS_QUEUE_H_
  82 #include <sys/queue.h>
  83 #endif
  84 #ifndef _SYS_TREE_H_
  85 #include <sys/tree.h>
  86 #endif
  87 #ifndef _SYS_THREAD_H_
  88 #include <sys/thread.h>
  89 #endif
  90 #ifndef _MACHINE_ATOMIC_H_
  91 #include <machine/atomic.h>
  92 #endif
  93 #ifndef _VM_VM_H_
  94 #include <vm/vm.h>
  95 #endif
  96 #ifndef _VM_VM_PAGE_H_
  97 #include <vm/vm_page.h>
  98 #endif
  99
 100 #ifdef _KERNEL
 101
 102 #ifndef _SYS_THREAD2_H_
 103 #include <sys/thread2.h>
 104 #endif
 105
 106 #endif
 107
 108 struct swblock;
 109 struct swblock_rb_tree;
 110 int rb_swblock_compare(struct swblock *, struct swblock *);
 111
 112 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare,
 113               vm_pindex_t);
 114
 115 enum obj_type {
 116         OBJT_DEFAULT,
 117         OBJT_SWAP,      /* object backed by swap blocks */
 118         OBJT_VNODE,     /* object backed by file pages (vnode) */
 119         OBJT_DEVICE,    /* object backed by device pages */
 120         OBJT_PHYS,      /* object backed by physical pages */
 121         OBJT_DEAD,      /* dead object */
 122         OBJT_MARKER     /* marker object */
 123 };
 124 typedef u_char objtype_t;
 125
 126 /*
 127  * vm_object_lock       A lock covering byte ranges within a VM object
 128  *
 129  */
 130 struct vm_object_lock {
 131         struct vm_object_lock *next;
 132         int     type;                   /* type of lock */
 133         int     waiting;                /* someone is waiting on the lock */
 134         off_t   base;                   /* byte offset into object */
 135         off_t   bytes;                  /* extent in bytes */
 136 };
 137
 138 #define VMOBJ_LOCK_SHARED       1
 139 #define VMOBJ_LOCK_EXCL         2
 140
 141 /*
 142  * vm_object            A VM object which represents an arbitrarily sized
 143  *                      data store.
 144  *
 145  * Locking requirements: vmobj_token for ref_count and object_list, and
 146  * vm_token for everything else.
 147  */
 148 struct vm_object {
 149         TAILQ_ENTRY(vm_object) object_list; /* vmobj_token */
 150         LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
 151         LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
 152         RB_HEAD(vm_page_rb_tree, vm_page) rb_memq;      /* resident pages */
 153         int generation;                 /* generation ID */
 154         vm_pindex_t size;               /* Object size */
 155         int ref_count;                  /* vmobj_token */
 156         int shadow_count;               /* how many objects that this is a shadow for */
 157         int hash_rand;                  /* vm hash table randomizer     */
 158         objtype_t type;                 /* type of pager */
 159         u_short flags;                  /* see below */
 160         u_short pg_color;               /* color of first page in obj */
 161         u_short unused01;
 162         int paging_in_progress;         /* Paging (in or out) so don't collapse or destroy */
 163         int resident_page_count;        /* number of resident pages */
 164         struct vm_object *backing_object; /* object that I'm a shadow of */
 165         vm_ooffset_t backing_object_offset;/* Offset in backing object */
 166         TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
 167         void *handle;
 168         vm_object_lock_t range_locks;
 169         union {
 170                 /*
 171                  * Device pager
 172                  *
 173                  *      devp_pglist - list of allocated pages
 174                  */
 175                 struct {
 176                         TAILQ_HEAD(, vm_page) devp_pglist;
 177                 } devp;
 178         } un_pager;
 179
 180         /*
 181          * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing
 182          * store.  For vnodes the swap backing store acts as a fast
 183          * data cache but the vnode contains the official data.
 184          */
 185         RB_HEAD(swblock_rb_tree, swblock) swblock_root;
 186         int     swblock_count;
 187 };
 188
 189 /*
 190  * Flags
 191  */
 192 #define OBJ_ACTIVE      0x0004          /* active objects */
 193 #define OBJ_DEAD        0x0008          /* dead objects (during rundown) */
 194 #define OBJ_NOSPLIT     0x0010          /* dont split this object */
 195 #define OBJ_PIPWNT      0x0040          /* paging in progress wanted */
 196 #define OBJ_WRITEABLE   0x0080          /* object has been made writable */
 197 #define OBJ_MIGHTBEDIRTY 0x0100         /* object might be dirty */
 198 #define OBJ_CLEANING    0x0200
 199 #define OBJ_DEADWNT     0x1000          /* waiting because object is dead */
 200 #define OBJ_ONEMAPPING  0x2000          /* One USE (a single, non-forked) mapping flag */
 201 #define OBJ_NOMSYNC     0x4000          /* disable msync() system call */
 202
 203 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
 204 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
 205
 206 #ifdef  _KERNEL
 207
 208 #define OBJPC_SYNC      0x1                     /* sync I/O */
 209 #define OBJPC_INVAL     0x2                     /* invalidate */
 210 #define OBJPC_NOSYNC    0x4                     /* skip if PG_NOSYNC */
 211
 212 TAILQ_HEAD(object_q, vm_object);
 213
 214 extern struct object_q vm_object_list;  /* list of allocated objects */
 215
 216  /* lock for object list and count */
 217
 218 extern struct vm_object kernel_object;  /* the single kernel object */
 219
 220 #endif                          /* _KERNEL */
 221
 222 #ifdef _KERNEL
 223
 224 static __inline void
 225 vm_object_set_flag(vm_object_t object, u_int bits)
 226 {
 227         atomic_set_short(&object->flags, bits);
 228 }
 229
 230 static __inline void
 231 vm_object_clear_flag(vm_object_t object, u_int bits)
 232 {
 233         atomic_clear_short(&object->flags, bits);
 234 }
 235
 236 static __inline void
 237 vm_object_pip_add(vm_object_t object, int i)
 238 {
 239         atomic_add_int(&object->paging_in_progress, i);
 240 }
 241
 242 static __inline void
 243 vm_object_pip_subtract(vm_object_t object, int i)
 244 {
 245         atomic_subtract_int(&object->paging_in_progress, i);
 246 }
 247
 248 static __inline void
 249 vm_object_pip_wakeup(vm_object_t object)
 250 {
 251         atomic_subtract_int(&object->paging_in_progress, 1);
 252         if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
 253                 vm_object_clear_flag(object, OBJ_PIPWNT);
 254                 wakeup(object);
 255         }
 256 }
 257
 258 static __inline void
 259 vm_object_pip_wakeupn(vm_object_t object, int i)
 260 {
 261         if (i)
 262                 atomic_subtract_int(&object->paging_in_progress, i);
 263         if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
 264                 vm_object_clear_flag(object, OBJ_PIPWNT);
 265                 wakeup(object);
 266         }
 267 }
 268
 269 static __inline void
 270 vm_object_pip_sleep(vm_object_t object, char *waitid)
 271 {
 272         if (object->paging_in_progress) {
 273                 crit_enter();
 274                 if (object->paging_in_progress) {
 275                         vm_object_set_flag(object, OBJ_PIPWNT);
 276                         tsleep(object, 0, waitid, 0);
 277                 }
 278                 crit_exit();
 279         }
 280 }
 281
 282 static __inline void
 283 vm_object_pip_wait(vm_object_t object, char *waitid)
 284 {
 285         while (object->paging_in_progress)
 286                 vm_object_pip_sleep(object, waitid);
 287 }
 288
 289 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
 290 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
 291 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
 292 void vm_object_collapse (vm_object_t);
 293 void vm_object_deallocate (vm_object_t);
 294 void vm_object_deallocate_locked (vm_object_t);
 295 void vm_object_terminate (vm_object_t);
 296 void vm_object_set_writeable_dirty (vm_object_t);
 297 void vm_object_init (void);
 298 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
 299 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
 300 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
 301 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
 302 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
 303 void vm_object_reference (vm_object_t);
 304 void vm_object_reference_locked (vm_object_t);
 305 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
 306 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
 307 void vm_object_init2 (void);
 308 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t, vm_prot_t, int, int *);
 309 void vm_object_dead_sleep(vm_object_t, const char *);
 310 void vm_object_dead_wakeup(vm_object_t);
 311
 312 #endif                          /* _KERNEL */
 313
 314 #endif                          /* _VM_VM_OBJECT_H_ */