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$
  65  */
  66
  67 /*
  68  *      Virtual memory object module definitions.
  69  */
  70
  71 #ifndef _VM_OBJECT_
  72 #define _VM_OBJECT_
  73
  74 #include <sys/queue.h>
  75
  76 enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
  77                 OBJT_DEAD };
  78 typedef u_char objtype_t;
  79
  80 /*
  81  *      Types defined:
  82  *
  83  *      vm_object_t             Virtual memory object.
  84  *
  85  * List of locks
  86  *      (c)     const until freed
  87  *
  88  */
  89
  90 struct vm_object {
  91         TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
  92         TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
  93         TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
  94         TAILQ_HEAD(, vm_page) memq;     /* list of resident pages */
  95         vm_page_t root;                 /* root of the resident page splay tree */
  96         int generation;                 /* generation ID */
  97         vm_pindex_t size;               /* Object size */
  98         int ref_count;                  /* How many refs?? */
  99         int shadow_count;               /* how many objects that this is a shadow for */
 100         int hash_rand;                  /* (c) hash table randomizer */
 101         objtype_t type;                 /* type of pager */
 102         u_short flags;                  /* see below */
 103         u_short pg_color;               /* (c) color of first page in obj */
 104         u_short paging_in_progress;     /* Paging (in or out) so don't collapse or destroy */
 105         int resident_page_count;        /* number of resident pages */
 106         struct vm_object *backing_object; /* object that I'm a shadow of */
 107         vm_ooffset_t backing_object_offset;/* Offset in backing object */
 108         TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
 109         void *handle;
 110         union {
 111                 /*
 112                  * VNode pager
 113                  *
 114                  *      vnp_size - current size of file
 115                  */
 116                 struct {
 117                         off_t vnp_size;
 118                 } vnp;
 119
 120                 /*
 121                  * Device pager
 122                  *
 123                  *      devp_pglist - list of allocated pages
 124                  */
 125                 struct {
 126                         TAILQ_HEAD(, vm_page) devp_pglist;
 127                 } devp;
 128
 129                 /*
 130                  * Swap pager
 131                  *
 132                  *      swp_bcount - number of swap 'swblock' metablocks, each
 133                  *                   contains up to 16 swapblk assignments.
 134                  *                   see vm/swap_pager.h
 135                  */
 136                 struct {
 137                         int swp_bcount;
 138                 } swp;
 139         } un_pager;
 140 };
 141
 142 /*
 143  * Flags
 144  */
 145 #define OBJ_ACTIVE      0x0004          /* active objects */
 146 #define OBJ_DEAD        0x0008          /* dead objects (during rundown) */
 147 #define OBJ_NOSPLIT     0x0010          /* dont split this object */
 148 #define OBJ_PIPWNT      0x0040          /* paging in progress wanted */
 149 #define OBJ_WRITEABLE   0x0080          /* object has been made writable */
 150 #define OBJ_MIGHTBEDIRTY 0x0100         /* object might be dirty */
 151 #define OBJ_CLEANING    0x0200
 152 #define OBJ_OPT         0x1000          /* I/O optimization */
 153 #define OBJ_ONEMAPPING  0x2000          /* One USE (a single, non-forked) mapping flag */
 154
 155 #define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
 156 #define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
 157
 158 #ifdef  _KERNEL
 159
 160 #define OBJPC_SYNC      0x1                     /* sync I/O */
 161 #define OBJPC_INVAL     0x2                     /* invalidate */
 162 #define OBJPC_NOSYNC    0x4                     /* skip if PG_NOSYNC */
 163
 164 TAILQ_HEAD(object_q, vm_object);
 165
 166 extern struct object_q vm_object_list;  /* list of allocated objects */
 167 extern struct mtx vm_object_list_mtx;   /* lock for object list and count */
 168
 169 extern vm_object_t kernel_object;       /* the single kernel object */
 170 extern vm_object_t kmem_object;
 171
 172 #endif                          /* _KERNEL */
 173
 174 #ifdef _KERNEL
 175 #define vm_object_lock(object)          mtx_lock(&Giant)
 176 #define vm_object_unlock(object)        mtx_unlock(&Giant)
 177
 178 void vm_freeze_copyopts(vm_object_t, vm_pindex_t, vm_pindex_t);
 179
 180 void vm_object_set_flag(vm_object_t object, u_short bits);
 181 void vm_object_clear_flag(vm_object_t object, u_short bits);
 182 void vm_object_pip_add(vm_object_t object, short i);
 183 void vm_object_pip_subtract(vm_object_t object, short i);
 184 void vm_object_pip_wakeup(vm_object_t object);
 185 void vm_object_pip_wakeupn(vm_object_t object, short i);
 186 void vm_object_pip_sleep(vm_object_t object, char *waitid);
 187 void vm_object_pip_wait(vm_object_t object, char *waitid);
 188
 189 vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
 190 vm_object_t vm_object_allocate_wait (objtype_t, vm_pindex_t, int);
 191 void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
 192 boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
 193 void vm_object_collapse (vm_object_t);
 194 void vm_object_deallocate (vm_object_t);
 195 void vm_object_terminate (vm_object_t);
 196 void vm_object_vndeallocate (vm_object_t);
 197 void vm_object_set_writeable_dirty (vm_object_t);
 198 void vm_object_init (void);
 199 void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
 200 void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
 201 void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
 202 void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
 203 void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
 204 void vm_object_reference (vm_object_t);
 205 void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
 206 void vm_object_split(vm_map_entry_t);
 207 void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
 208 void vm_object_init2 (void);
 209 #endif                          /* _KERNEL */
 210
 211 #endif                          /* _VM_OBJECT_ */