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  * 4. 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$
  61  */
  62
  63 /*
  64  *      Virtual memory object module definitions.
  65  */
  66
  67 #ifndef _VM_OBJECT_
  68 #define _VM_OBJECT_
  69
  70 #include <sys/queue.h>
  71 #include <sys/_lock.h>
  72 #include <sys/_mutex.h>
  73
  74 #include <vm/_vm_radix.h>
  75
  76 /*
  77  *      Types defined:
  78  *
  79  *      vm_object_t             Virtual memory object.
  80  *
  81  *      The root of cached pages pool is protected by both the per-object mutex
  82  *      and the free pages queue mutex.
  83  *      On insert in the cache radix trie, the per-object mutex is expected
  84  *      to be already held and the free pages queue mutex will be
  85  *      acquired during the operation too.
  86  *      On remove and lookup from the cache radix trie, only the free
  87  *      pages queue mutex is expected to be locked.
  88  *      These rules allow for reliably checking for the presence of cached
  89  *      pages with only the per-object lock held, thereby reducing contention
  90  *      for the free pages queue mutex.
  91  *
  92  * List of locks
  93  *      (c)     const until freed
  94  *      (o)     per-object mutex
  95  *      (f)     free pages queue mutex
  96  *
  97  */
  98
  99 struct vm_object {
 100         struct mtx mtx;
 101         TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
 102         LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
 103         LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
 104         TAILQ_HEAD(, vm_page) memq;     /* list of resident pages */
 105         struct vm_radix rtree;          /* root of the resident page radix trie*/
 106         vm_pindex_t size;               /* Object size */
 107         int generation;                 /* generation ID */
 108         int ref_count;                  /* How many refs?? */
 109         int shadow_count;               /* how many objects that this is a shadow for */
 110         vm_memattr_t memattr;           /* default memory attribute for pages */
 111         objtype_t type;                 /* type of pager */
 112         u_short flags;                  /* see below */
 113         u_short pg_color;               /* (c) color of first page in obj */
 114         u_int paging_in_progress;       /* Paging (in or out) so don't collapse or destroy */
 115         int resident_page_count;        /* number of resident pages */
 116         struct vm_object *backing_object; /* object that I'm a shadow of */
 117         vm_ooffset_t backing_object_offset;/* Offset in backing object */
 118         TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
 119         LIST_HEAD(, vm_reserv) rvq;     /* list of reservations */
 120         struct vm_radix cache;          /* (o + f) root of the cache page radix trie */
 121         void *handle;
 122         union {
 123                 /*
 124                  * VNode pager
 125                  *
 126                  *      vnp_size - current size of file
 127                  */
 128                 struct {
 129                         off_t vnp_size;
 130                         vm_ooffset_t writemappings;
 131                 } vnp;
 132
 133                 /*
 134                  * Device pager
 135                  *
 136                  *      devp_pglist - list of allocated pages
 137                  */
 138                 struct {
 139                         TAILQ_HEAD(, vm_page) devp_pglist;
 140                         struct cdev_pager_ops *ops;
 141                         struct cdev *dev;
 142                 } devp;
 143
 144                 /*
 145                  * SG pager
 146                  *
 147                  *      sgp_pglist - list of allocated pages
 148                  */
 149                 struct {
 150                         TAILQ_HEAD(, vm_page) sgp_pglist;
 151                 } sgp;
 152
 153                 /*
 154                  * Swap pager
 155                  *
 156                  *      swp_bcount - number of swap 'swblock' metablocks, each
 157                  *                   contains up to 16 swapblk assignments.
 158                  *                   see vm/swap_pager.h
 159                  */
 160                 struct {
 161                         int swp_bcount;
 162                 } swp;
 163         } un_pager;
 164         struct ucred *cred;
 165         vm_ooffset_t charge;
 166 };
 167
 168 /*
 169  * Flags
 170  */
 171 #define OBJ_FICTITIOUS  0x0001          /* (c) contains fictitious pages */
 172 #define OBJ_UNMANAGED   0x0002          /* (c) contains unmanaged pages */
 173 #define OBJ_ACTIVE      0x0004          /* active objects */
 174 #define OBJ_DEAD        0x0008          /* dead objects (during rundown) */
 175 #define OBJ_NOSPLIT     0x0010          /* dont split this object */
 176 #define OBJ_PIPWNT      0x0040          /* paging in progress wanted */
 177 #define OBJ_MIGHTBEDIRTY 0x0100         /* object might be dirty, only for vnode */
 178 #define OBJ_COLORED     0x1000          /* pg_color is defined */
 179 #define OBJ_ONEMAPPING  0x2000          /* One USE (a single, non-forked) mapping flag */
 180 #define OBJ_DISCONNECTWNT 0x4000        /* disconnect from vnode wanted */
 181
 182 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
 183 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
 184
 185 #ifdef  _KERNEL
 186
 187 #define OBJPC_SYNC      0x1                     /* sync I/O */
 188 #define OBJPC_INVAL     0x2                     /* invalidate */
 189 #define OBJPC_NOSYNC    0x4                     /* skip if PG_NOSYNC */
 190
 191 /*
 192  * The following options are supported by vm_object_page_remove().
 193  */
 194 #define OBJPR_CLEANONLY 0x1             /* Don't remove dirty pages. */
 195 #define OBJPR_NOTMAPPED 0x2             /* Don't unmap pages. */
 196
 197 TAILQ_HEAD(object_q, vm_object);
 198
 199 extern struct object_q vm_object_list;  /* list of allocated objects */
 200 extern struct mtx vm_object_list_mtx;   /* lock for object list and count */
 201
 202 extern struct vm_object kernel_object_store;
 203 extern struct vm_object kmem_object_store;
 204
 205 #define kernel_object   (&kernel_object_store)
 206 #define kmem_object     (&kmem_object_store)
 207
 208 #define VM_OBJECT_LOCK(object)          mtx_lock(&(object)->mtx)
 209 #define VM_OBJECT_LOCK_ASSERT(object, type) \
 210                                         mtx_assert(&(object)->mtx, (type))
 211 #define VM_OBJECT_LOCK_INIT(object, type) \
 212                                         mtx_init(&(object)->mtx, "vm object", \
 213                                             (type), MTX_DEF | MTX_DUPOK)
 214 #define VM_OBJECT_LOCKED(object)        mtx_owned(&(object)->mtx)
 215 #define VM_OBJECT_MTX(object)           (&(object)->mtx)
 216 #define VM_OBJECT_TRYLOCK(object)       mtx_trylock(&(object)->mtx)
 217 #define VM_OBJECT_UNLOCK(object)        mtx_unlock(&(object)->mtx)
 218
 219 /*
 220  *      The object must be locked or thread private.
 221  */
 222 static __inline void
 223 vm_object_set_flag(vm_object_t object, u_short bits)
 224 {
 225
 226         object->flags |= bits;
 227 }
 228
 229 void vm_object_clear_flag(vm_object_t object, u_short bits);
 230 void vm_object_pip_add(vm_object_t object, short i);
 231 void vm_object_pip_subtract(vm_object_t object, short i);
 232 void vm_object_pip_wakeup(vm_object_t object);
 233 void vm_object_pip_wakeupn(vm_object_t object, short i);
 234 void vm_object_pip_wait(vm_object_t object, char *waitid);
 235
 236 static __inline boolean_t
 237 vm_object_cache_is_empty(vm_object_t object)
 238 {
 239
 240         return (__predict_true(object->cache.rt_root == 0));
 241 }
 242
 243 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
 244 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
 245 boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t,
 246    boolean_t);
 247 void vm_object_collapse (vm_object_t);
 248 void vm_object_deallocate (vm_object_t);
 249 void vm_object_destroy (vm_object_t);
 250 void vm_object_terminate (vm_object_t);
 251 void vm_object_set_writeable_dirty (vm_object_t);
 252 void vm_object_init (void);
 253 void vm_object_madvise(vm_object_t, vm_pindex_t, vm_pindex_t, int);
 254 void vm_object_page_cache(vm_object_t object, vm_pindex_t start,
 255     vm_pindex_t end);
 256 boolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start,
 257     vm_ooffset_t end, int flags);
 258 void vm_object_page_remove(vm_object_t object, vm_pindex_t start,
 259     vm_pindex_t end, int options);
 260 boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t);
 261 void vm_object_print(long addr, boolean_t have_addr, long count, char *modif);
 262 void vm_object_reference (vm_object_t);
 263 void vm_object_reference_locked(vm_object_t);
 264 int  vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr);
 265 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
 266 void vm_object_split(vm_map_entry_t);
 267 boolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t,
 268     boolean_t);
 269 #endif                          /* _KERNEL */
 270
 271 #endif                          /* _VM_OBJECT_ */