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. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      from: @(#)vm_object.h   8.3 (Berkeley) 1/12/94
  33  *
  34  *
  35  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  36  * All rights reserved.
  37  *
  38  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  39  *
  40  * Permission to use, copy, modify and distribute this software and
  41  * its documentation is hereby granted, provided that both the copyright
  42  * notice and this permission notice appear in all copies of the
  43  * software, derivative works or modified versions, and any portions
  44  * thereof, and that both notices appear in supporting documentation.
  45  *
  46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  48  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  49  *
  50  * Carnegie Mellon requests users of this software to return to
  51  *
  52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  53  *  School of Computer Science
  54  *  Carnegie Mellon University
  55  *  Pittsburgh PA 15213-3890
  56  *
  57  * any improvements or extensions that they make and grant Carnegie the
  58  * rights to redistribute these changes.
  59  *
  60  * $FreeBSD: src/sys/vm/vm_object.h,v 1.63.2.3 2003/05/26 19:17:56 alc Exp $
  61  */
  62
  63 /*
  64  *      Virtual memory object module definitions.
  65  */
  66
  67 #ifndef _VM_VM_OBJECT_H_
  68 #define _VM_VM_OBJECT_H_
  69
  70 #ifndef _SYS_TYPES_H_
  71 #include <sys/types.h>
  72 #endif
  73 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
  74 #include <sys/systm.h>
  75 #endif
  76 #ifndef _SYS_QUEUE_H_
  77 #include <sys/queue.h>
  78 #endif
  79 #ifndef _SYS_TREE_H_
  80 #include <sys/tree.h>
  81 #endif
  82 #ifndef _SYS_THREAD_H_
  83 #include <sys/thread.h>
  84 #endif
  85 #ifndef _MACHINE_PMAP_H_
  86 #include <machine/pmap.h>
  87 #endif
  88 #ifndef _CPU_ATOMIC_H_
  89 #include <machine/atomic.h>
  90 #endif
  91 #ifndef _VM_VM_H_
  92 #include <vm/vm.h>
  93 #endif
  94 #ifndef _VM_VM_PAGE_H_
  95 #include <vm/vm_page.h>
  96 #endif
  97
  98 #ifdef _KERNEL
  99
 100 #ifndef _SYS_REFCOUNT_H_
 101 #include <sys/refcount.h>
 102 #endif
 103
 104 #endif
 105
 106 struct swblock;
 107 struct swblock_rb_tree;
 108 int rb_swblock_compare(struct swblock *, struct swblock *);
 109
 110 RB_PROTOTYPE2(swblock_rb_tree, swblock, swb_entry, rb_swblock_compare,
 111               vm_pindex_t);
 112
 113 enum obj_type {
 114         OBJT_DEFAULT,
 115         OBJT_SWAP,      /* object backed by swap blocks */
 116         OBJT_VNODE,     /* object backed by file pages (vnode) */
 117         OBJT_DEVICE,    /* object backed by device pages */
 118         OBJT_MGTDEVICE,
 119         OBJT_PHYS,      /* object backed by physical pages */
 120         OBJT_DEAD,      /* dead object */
 121         OBJT_MARKER     /* marker object */
 122 };
 123 typedef u_char objtype_t;
 124
 125 /*
 126  * A VM object which represents an arbitrarily sized data store.
 127  *
 128  * NOTE:
 129  *      shadow_head is only used by OBJT_DEFAULT or OBJT_SWAP objects.
 130  *      OBJT_VNODE objects explicitly do not keep track of who is shadowing
 131  *      them.
 132  *
 133  * LOCKING:
 134  *      vmobj_tokens[n] for object_list, hashed by address.
 135  *
 136  *      vm_object_hold/drop() for most vm_object related operations.
 137  *      OBJ_CHAINLOCK to avoid chain/shadow object collisions.
 138  */
 139 struct vm_object {
 140         TAILQ_ENTRY(vm_object) object_list; /* locked by vmobj_tokens[n] */
 141         LIST_HEAD(, vm_object) shadow_head; /* objects we are a shadow for */
 142         LIST_ENTRY(vm_object) shadow_list;  /* chain of shadow objects */
 143         RB_HEAD(vm_page_rb_tree, vm_page) rb_memq;      /* resident pages */
 144         int generation;                 /* generation ID */
 145         vm_pindex_t size;               /* Object size */
 146         int ref_count;
 147         int shadow_count;               /* count of objs we are a shadow for */
 148         vm_memattr_t memattr;           /* default memory attribute for pages */
 149         objtype_t type;                 /* type of pager */
 150         u_short flags;                  /* see below */
 151         u_short pg_color;               /* color of first page in obj */
 152         u_int paging_in_progress;       /* Paging (in or out) so don't collapse or destroy */
 153         long resident_page_count;       /* number of resident pages */
 154         u_int unused01;
 155         struct vm_object *backing_object; /* object that I'm a shadow of */
 156         vm_ooffset_t backing_object_offset;/* Offset in backing object */
 157         TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
 158         void *handle;                   /* control handle: vp, etc */
 159         int hold_count;                 /* count prevents destruction */
 160
 161 #if defined(DEBUG_LOCKS)
 162         /*
 163          * Record threads holding a vm_object
 164          */
 165
 166 #define VMOBJ_DEBUG_ARRAY_SIZE          (32)
 167         char debug_hold_thrs[VMOBJ_DEBUG_ARRAY_SIZE][64];
 168         const char *debug_hold_file[VMOBJ_DEBUG_ARRAY_SIZE];
 169         int debug_hold_line[VMOBJ_DEBUG_ARRAY_SIZE];
 170         int     debug_index;
 171 #endif
 172
 173         union {
 174                 /*
 175                  * Device pager
 176                  *
 177                  *      devp_pglist - list of allocated pages
 178                  */
 179                 struct {
 180                         TAILQ_HEAD(, vm_page) devp_pglist;
 181                         struct cdev_pager_ops *ops;
 182                         struct cdev *dev;
 183                 } devp;
 184         } un_pager;
 185
 186         /*
 187          * OBJT_SWAP and OBJT_VNODE VM objects may have swap backing
 188          * store.  For vnodes the swap backing store acts as a fast
 189          * data cache but the vnode contains the official data.
 190          */
 191         RB_HEAD(swblock_rb_tree, swblock) swblock_root;
 192         long    swblock_count;
 193         struct  lwkt_token      token;
 194         struct md_object        md;     /* machine specific (typ pmap) */
 195         uint32_t                chainlk;/* chaining lock */
 196 };
 197
 198 /*
 199  * Flags
 200  *
 201  * OBJ_ONEMAPPING - Only applies to DEFAULT and SWAP objects.  It may be
 202  *                  gratuitously re-cleared in other cases but will already
 203  *                  be clear in those cases.  It might not be set on other
 204  *                  object types (particularly OBJT_VNODE).
 205  *
 206  *                  This flag indicates that any given page index within the
 207  *                  object is only mapped to a single vm_map_entry.  Split
 208  *                  vm_map_entry's (denoting distinct non-overlapping page
 209  *                  ranges) do not clear this flag.  This flag is typically
 210  *                  cleared on fork().
 211  *
 212  * OBJ_NOPAGEIN   - vn and tmpfs set this flag, indicating to swapoff
 213  *                  that the objects aren't intended to have any vm_page's,
 214  *                  only swap blocks.  vn and tmpfs don't know how to deal
 215  *                  with any actual pages.
 216  */
 217 #define OBJ_UNUSED0001  0x0001          /* backing_object/shadow changing */
 218 #define OBJ_ONSHADOW    0x0002          /* backing_object on shadow list */
 219 #define OBJ_ACTIVE      0x0004          /* active objects */
 220 #define OBJ_DEAD        0x0008          /* dead objects (during rundown) */
 221 #define OBJ_NOSPLIT     0x0010          /* dont split this object */
 222 #define OBJ_NOPAGEIN    0x0040          /* special OBJT_SWAP */
 223 #define OBJ_WRITEABLE   0x0080          /* object has been made writable */
 224 #define OBJ_MIGHTBEDIRTY 0x0100         /* object might be dirty */
 225 #define OBJ_CLEANING    0x0200
 226 #define OBJ_DEADWNT     0x1000          /* waiting because object is dead */
 227 #define OBJ_ONEMAPPING  0x2000
 228 #define OBJ_NOMSYNC     0x4000          /* disable msync() system call */
 229
 230 #define CHAINLK_EXCL    0x80000000
 231 #define CHAINLK_WAIT    0x40000000
 232 #define CHAINLK_EXCLREQ 0x20000000
 233 #define CHAINLK_MASK    0x1FFFFFFF
 234
 235 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
 236 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
 237
 238 #define VMOBJ_HSIZE     256
 239 #define VMOBJ_HMASK     (VMOBJ_HSIZE - 1)
 240
 241 #ifdef  _KERNEL
 242
 243 #define OBJPC_SYNC      0x1                     /* sync I/O */
 244 #define OBJPC_INVAL     0x2                     /* invalidate */
 245 #define OBJPC_NOSYNC    0x4                     /* skip if PG_NOSYNC */
 246
 247 /*
 248  * Used to chain vm_object deallocations
 249  */
 250 struct vm_object_dealloc_list {
 251         struct vm_object_dealloc_list *next;
 252         vm_object_t     object;
 253 };
 254
 255 TAILQ_HEAD(object_q, vm_object);
 256
 257 struct vm_object_hash {
 258         struct object_q         list;
 259         struct lwkt_token       token;
 260 } __cachealign;
 261
 262 extern struct vm_object_hash vm_object_hash[VMOBJ_HSIZE];
 263
 264  /* lock for object list and count */
 265
 266 extern struct vm_object kernel_object;  /* the single kernel object */
 267 extern int vm_shared_fault;
 268
 269 #endif                          /* _KERNEL */
 270
 271 #ifdef _KERNEL
 272
 273 #define VM_OBJECT_LOCK(object)          vm_object_hold(object)
 274 #define VM_OBJECT_UNLOCK(object)        vm_object_drop(object)
 275
 276 static __inline void
 277 vm_object_set_flag(vm_object_t object, u_int bits)
 278 {
 279         atomic_set_short(&object->flags, bits);
 280 }
 281
 282 static __inline void
 283 vm_object_clear_flag(vm_object_t object, u_int bits)
 284 {
 285         atomic_clear_short(&object->flags, bits);
 286 }
 287
 288 static __inline void
 289 vm_object_pip_add(vm_object_t object, u_int i)
 290 {
 291         refcount_acquire_n(&object->paging_in_progress, i);
 292 }
 293
 294 static __inline void
 295 vm_object_pip_wakeup_n(vm_object_t object, u_int i)
 296 {
 297         refcount_release_wakeup_n(&object->paging_in_progress, i);
 298 }
 299
 300 static __inline void
 301 vm_object_pip_wakeup(vm_object_t object)
 302 {
 303         vm_object_pip_wakeup_n(object, 1);
 304 }
 305
 306 static __inline void
 307 vm_object_pip_wait(vm_object_t object, char *waitid)
 308 {
 309         refcount_wait(&object->paging_in_progress, waitid);
 310 }
 311
 312 static __inline lwkt_token_t
 313 vm_object_token(vm_object_t obj)
 314 {
 315         return (&obj->token);
 316 }
 317
 318 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
 319 vm_object_t vm_object_allocate_hold (objtype_t, vm_pindex_t);
 320 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
 321 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
 322 void vm_object_collapse (vm_object_t, struct vm_object_dealloc_list **);
 323 void vm_object_deallocate_list(struct vm_object_dealloc_list **);
 324 void vm_object_terminate (vm_object_t);
 325 void vm_object_set_writeable_dirty (vm_object_t);
 326 void vm_object_init(vm_object_t, vm_pindex_t);
 327 void vm_object_init1 (void);
 328 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, int);
 329 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
 330 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
 331 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
 332 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
 333 void vm_object_chain_wait (vm_object_t object, int shared);
 334 void vm_object_chain_acquire(vm_object_t object, int shared);
 335 void vm_object_chain_release(vm_object_t object);
 336 void vm_object_chain_release_all(vm_object_t object, vm_object_t stopobj);
 337 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t, int);
 338 void vm_object_madvise (vm_object_t, vm_pindex_t, vm_pindex_t, int);
 339 void vm_object_init2 (void);
 340 vm_page_t vm_fault_object_page(vm_object_t, vm_ooffset_t,
 341                                 vm_prot_t, int, int *, int *);
 342 void vm_object_lock_swap(void);
 343 void vm_object_lock(vm_object_t);
 344 void vm_object_lock_shared(vm_object_t);
 345 void vm_object_unlock(vm_object_t);
 346
 347 #if defined(DEBUG_LOCKS)
 348
 349 #define VMOBJDEBUG(x)   debug ## x
 350 #define VMOBJDBARGS     , char *file, int line
 351 #define VMOBJDBFWD      , file, line
 352
 353 #define vm_object_hold(obj)                     \
 354                 debugvm_object_hold(obj, __FILE__, __LINE__)
 355 #define vm_object_hold_try(obj)                 \
 356                 debugvm_object_hold_try(obj, __FILE__, __LINE__)
 357 #define vm_object_hold_shared(obj)              \
 358                 debugvm_object_hold_shared(obj, __FILE__, __LINE__)
 359 #define vm_object_drop(obj)                     \
 360                 debugvm_object_drop(obj, __FILE__, __LINE__)
 361 #define vm_object_reference_quick(obj)          \
 362                 debugvm_object_reference_quick(obj, __FILE__, __LINE__)
 363 #define vm_object_reference_locked(obj)         \
 364                 debugvm_object_reference_locked(obj, __FILE__, __LINE__)
 365 #define vm_object_reference_locked_chain_held(obj)              \
 366                 debugvm_object_reference_locked_chain_held(     \
 367                                         obj, __FILE__, __LINE__)
 368 #define vm_object_deallocate(obj)               \
 369                 debugvm_object_deallocate(obj, __FILE__, __LINE__)
 370 #define vm_object_deallocate_locked(obj)        \
 371                 debugvm_object_deallocate_locked(obj, __FILE__, __LINE__)
 372
 373 #else
 374
 375 #define VMOBJDEBUG(x)   x
 376 #define VMOBJDBARGS
 377 #define VMOBJDBFWD
 378
 379 #endif
 380
 381 void VMOBJDEBUG(vm_object_hold)(vm_object_t object VMOBJDBARGS);
 382 int VMOBJDEBUG(vm_object_hold_try)(vm_object_t object VMOBJDBARGS);
 383 void VMOBJDEBUG(vm_object_hold_shared)(vm_object_t object VMOBJDBARGS);
 384 void VMOBJDEBUG(vm_object_drop)(vm_object_t object VMOBJDBARGS);
 385 void VMOBJDEBUG(vm_object_reference_quick)(vm_object_t object VMOBJDBARGS);
 386 void VMOBJDEBUG(vm_object_reference_locked)(vm_object_t object VMOBJDBARGS);
 387 void VMOBJDEBUG(vm_object_reference_locked_chain_held)(
 388                         vm_object_t object VMOBJDBARGS);
 389 void VMOBJDEBUG(vm_object_deallocate)(vm_object_t object VMOBJDBARGS);
 390 void VMOBJDEBUG(vm_object_deallocate_locked)(vm_object_t object VMOBJDBARGS);
 391
 392 void vm_object_upgrade(vm_object_t);
 393 void vm_object_downgrade(vm_object_t);
 394
 395 #endif                          /* _KERNEL */
 396
 397 #endif                          /* _VM_VM_OBJECT_H_ */