The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/vm/vm_object.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    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: releng/11.2/sys/vm/vm_object.h 331722 2018-03-29 02:50:57Z eadler $
   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 #include <sys/_pctrie.h>
   74 #include <sys/_rwlock.h>
   75 
   76 #include <vm/_vm_radix.h>
   77 
   78 /*
   79  *      Types defined:
   80  *
   81  *      vm_object_t             Virtual memory object.
   82  *
   83  * List of locks
   84  *      (c)     const until freed
   85  *      (o)     per-object lock 
   86  *      (f)     free pages queue mutex
   87  *
   88  */
   89 
   90 #ifndef VM_PAGE_HAVE_PGLIST
   91 TAILQ_HEAD(pglist, vm_page);
   92 #define VM_PAGE_HAVE_PGLIST
   93 #endif
   94 
   95 struct vm_object {
   96         struct rwlock lock;
   97         TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
   98         LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
   99         LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
  100         struct pglist memq;             /* list of resident pages */
  101         struct vm_radix rtree;          /* root of the resident page radix trie*/
  102         vm_pindex_t size;               /* Object size */
  103         int generation;                 /* generation ID */
  104         int ref_count;                  /* How many refs?? */
  105         int shadow_count;               /* how many objects that this is a shadow for */
  106         vm_memattr_t memattr;           /* default memory attribute for pages */
  107         objtype_t type;                 /* type of pager */
  108         u_short flags;                  /* see below */
  109         u_short pg_color;               /* (c) color of first page in obj */
  110         u_int paging_in_progress;       /* Paging (in or out) so don't collapse or destroy */
  111         int resident_page_count;        /* number of resident pages */
  112         struct vm_object *backing_object; /* object that I'm a shadow of */
  113         vm_ooffset_t backing_object_offset;/* Offset in backing object */
  114         TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
  115         LIST_HEAD(, vm_reserv) rvq;     /* list of reservations */
  116         void *handle;
  117         union {
  118                 /*
  119                  * VNode pager
  120                  *
  121                  *      vnp_size - current size of file
  122                  */
  123                 struct {
  124                         off_t vnp_size;
  125                         vm_ooffset_t writemappings;
  126                 } vnp;
  127 
  128                 /*
  129                  * Device pager
  130                  *
  131                  *      devp_pglist - list of allocated pages
  132                  */
  133                 struct {
  134                         TAILQ_HEAD(, vm_page) devp_pglist;
  135                         struct cdev_pager_ops *ops;
  136                         struct cdev *dev;
  137                 } devp;
  138 
  139                 /*
  140                  * SG pager
  141                  *
  142                  *      sgp_pglist - list of allocated pages
  143                  */
  144                 struct {
  145                         TAILQ_HEAD(, vm_page) sgp_pglist;
  146                 } sgp;
  147 
  148                 /*
  149                  * Swap pager
  150                  *
  151                  *      swp_tmpfs - back-pointer to the tmpfs vnode,
  152                  *                   if any, which uses the vm object
  153                  *                   as backing store.  The handle
  154                  *                   cannot be reused for linking,
  155                  *                   because the vnode can be
  156                  *                   reclaimed and recreated, making
  157                  *                   the handle changed and hash-chain
  158                  *                   invalid.
  159                  *
  160                  *      swp_blks -   pc-trie of the allocated swap blocks.
  161                  *
  162                  */
  163                 struct {
  164                         void *swp_tmpfs;
  165                         struct pctrie swp_blks;
  166                 } swp;
  167         } un_pager;
  168         struct ucred *cred;
  169         vm_ooffset_t charge;
  170         void *umtx_data;
  171 };
  172 
  173 /*
  174  * Flags
  175  */
  176 #define OBJ_FICTITIOUS  0x0001          /* (c) contains fictitious pages */
  177 #define OBJ_UNMANAGED   0x0002          /* (c) contains unmanaged pages */
  178 #define OBJ_POPULATE    0x0004          /* pager implements populate() */
  179 #define OBJ_DEAD        0x0008          /* dead objects (during rundown) */
  180 #define OBJ_NOSPLIT     0x0010          /* dont split this object */
  181 #define OBJ_UMTXDEAD    0x0020          /* umtx pshared was terminated */
  182 #define OBJ_PIPWNT      0x0040          /* paging in progress wanted */
  183 #define OBJ_PG_DTOR     0x0080          /* dont reset object, leave that for dtor */
  184 #define OBJ_MIGHTBEDIRTY 0x0100         /* object might be dirty, only for vnode */
  185 #define OBJ_TMPFS_NODE  0x0200          /* object belongs to tmpfs VREG node */
  186 #define OBJ_TMPFS_DIRTY 0x0400          /* dirty tmpfs obj */
  187 #define OBJ_COLORED     0x1000          /* pg_color is defined */
  188 #define OBJ_ONEMAPPING  0x2000          /* One USE (a single, non-forked) mapping flag */
  189 #define OBJ_DISCONNECTWNT 0x4000        /* disconnect from vnode wanted */
  190 #define OBJ_TMPFS       0x8000          /* has tmpfs vnode allocated */
  191 
  192 /*
  193  * Helpers to perform conversion between vm_object page indexes and offsets.
  194  * IDX_TO_OFF() converts an index into an offset.
  195  * OFF_TO_IDX() converts an offset into an index.  Since offsets are signed
  196  *   by default, the sign propagation in OFF_TO_IDX(), when applied to
  197  *   negative offsets, is intentional and returns a vm_object page index
  198  *   that cannot be created by a userspace mapping.
  199  * UOFF_TO_IDX() treats the offset as an unsigned value and converts it
  200  *   into an index accordingly.  Use it only when the full range of offset
  201  *   values are allowed.  Currently, this only applies to device mappings.
  202  * OBJ_MAX_SIZE specifies the maximum page index corresponding to the
  203  *   maximum unsigned offset.
  204  */
  205 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
  206 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
  207 #define UOFF_TO_IDX(off) (((vm_pindex_t)(off)) >> PAGE_SHIFT)
  208 #define OBJ_MAX_SIZE    (UOFF_TO_IDX(UINT64_MAX) + 1)
  209 
  210 #ifdef  _KERNEL
  211 
  212 #define OBJPC_SYNC      0x1                     /* sync I/O */
  213 #define OBJPC_INVAL     0x2                     /* invalidate */
  214 #define OBJPC_NOSYNC    0x4                     /* skip if VPO_NOSYNC */
  215 
  216 /*
  217  * The following options are supported by vm_object_page_remove().
  218  */
  219 #define OBJPR_CLEANONLY 0x1             /* Don't remove dirty pages. */
  220 #define OBJPR_NOTMAPPED 0x2             /* Don't unmap pages. */
  221 
  222 TAILQ_HEAD(object_q, vm_object);
  223 
  224 extern struct object_q vm_object_list;  /* list of allocated objects */
  225 extern struct mtx vm_object_list_mtx;   /* lock for object list and count */
  226 
  227 extern struct vm_object kernel_object_store;
  228 extern struct vm_object kmem_object_store;
  229 
  230 #define kernel_object   (&kernel_object_store)
  231 #define kmem_object     (&kmem_object_store)
  232 
  233 #define VM_OBJECT_ASSERT_LOCKED(object)                                 \
  234         rw_assert(&(object)->lock, RA_LOCKED)
  235 #define VM_OBJECT_ASSERT_RLOCKED(object)                                \
  236         rw_assert(&(object)->lock, RA_RLOCKED)
  237 #define VM_OBJECT_ASSERT_WLOCKED(object)                                \
  238         rw_assert(&(object)->lock, RA_WLOCKED)
  239 #define VM_OBJECT_ASSERT_UNLOCKED(object)                               \
  240         rw_assert(&(object)->lock, RA_UNLOCKED)
  241 #define VM_OBJECT_LOCK_DOWNGRADE(object)                                \
  242         rw_downgrade(&(object)->lock)
  243 #define VM_OBJECT_RLOCK(object)                                         \
  244         rw_rlock(&(object)->lock)
  245 #define VM_OBJECT_RUNLOCK(object)                                       \
  246         rw_runlock(&(object)->lock)
  247 #define VM_OBJECT_SLEEP(object, wchan, pri, wmesg, timo)                \
  248         rw_sleep((wchan), &(object)->lock, (pri), (wmesg), (timo))
  249 #define VM_OBJECT_TRYRLOCK(object)                                      \
  250         rw_try_rlock(&(object)->lock)
  251 #define VM_OBJECT_TRYWLOCK(object)                                      \
  252         rw_try_wlock(&(object)->lock)
  253 #define VM_OBJECT_TRYUPGRADE(object)                                    \
  254         rw_try_upgrade(&(object)->lock)
  255 #define VM_OBJECT_WLOCK(object)                                         \
  256         rw_wlock(&(object)->lock)
  257 #define VM_OBJECT_WOWNED(object)                                        \
  258         rw_wowned(&(object)->lock)
  259 #define VM_OBJECT_WUNLOCK(object)                                       \
  260         rw_wunlock(&(object)->lock)
  261 
  262 /*
  263  *      The object must be locked or thread private.
  264  */
  265 static __inline void
  266 vm_object_set_flag(vm_object_t object, u_short bits)
  267 {
  268 
  269         object->flags |= bits;
  270 }
  271 
  272 /*
  273  *      Conditionally set the object's color, which (1) enables the allocation
  274  *      of physical memory reservations for anonymous objects and larger-than-
  275  *      superpage-sized named objects and (2) determines the first page offset
  276  *      within the object at which a reservation may be allocated.  In other
  277  *      words, the color determines the alignment of the object with respect
  278  *      to the largest superpage boundary.  When mapping named objects, like
  279  *      files or POSIX shared memory objects, the color should be set to zero
  280  *      before a virtual address is selected for the mapping.  In contrast,
  281  *      for anonymous objects, the color may be set after the virtual address
  282  *      is selected.
  283  *
  284  *      The object must be locked.
  285  */
  286 static __inline void
  287 vm_object_color(vm_object_t object, u_short color)
  288 {
  289 
  290         if ((object->flags & OBJ_COLORED) == 0) {
  291                 object->pg_color = color;
  292                 object->flags |= OBJ_COLORED;
  293         }
  294 }
  295 
  296 void vm_object_clear_flag(vm_object_t object, u_short bits);
  297 void vm_object_pip_add(vm_object_t object, short i);
  298 void vm_object_pip_subtract(vm_object_t object, short i);
  299 void vm_object_pip_wakeup(vm_object_t object);
  300 void vm_object_pip_wakeupn(vm_object_t object, short i);
  301 void vm_object_pip_wait(vm_object_t object, char *waitid);
  302 
  303 void umtx_shm_object_init(vm_object_t object);
  304 void umtx_shm_object_terminated(vm_object_t object);
  305 extern int umtx_shm_vnobj_persistent;
  306 
  307 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
  308 boolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t,
  309    boolean_t);
  310 void vm_object_collapse (vm_object_t);
  311 void vm_object_deallocate (vm_object_t);
  312 void vm_object_destroy (vm_object_t);
  313 void vm_object_terminate (vm_object_t);
  314 void vm_object_set_writeable_dirty (vm_object_t);
  315 void vm_object_init (void);
  316 void vm_object_madvise(vm_object_t, vm_pindex_t, vm_pindex_t, int);
  317 boolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start,
  318     vm_ooffset_t end, int flags);
  319 void vm_object_page_noreuse(vm_object_t object, vm_pindex_t start,
  320     vm_pindex_t end);
  321 void vm_object_page_remove(vm_object_t object, vm_pindex_t start,
  322     vm_pindex_t end, int options);
  323 boolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t);
  324 void vm_object_print(long addr, boolean_t have_addr, long count, char *modif);
  325 void vm_object_reference (vm_object_t);
  326 void vm_object_reference_locked(vm_object_t);
  327 int  vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr);
  328 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
  329 void vm_object_split(vm_map_entry_t);
  330 boolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t,
  331     boolean_t);
  332 void vm_object_unwire(vm_object_t object, vm_ooffset_t offset,
  333     vm_size_t length, uint8_t queue);
  334 struct vnode *vm_object_vnode(vm_object_t object);
  335 #endif                          /* _KERNEL */
  336 
  337 #endif                          /* _VM_OBJECT_ */

Cache object: 7525659a6abf97374f7fc15b6c24e22d


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.