vm_object.h revision 233728
176195Sbrian/*- 276195Sbrian * Copyright (c) 1991, 1993 376358Sbrian * The Regents of the University of California. All rights reserved. 476358Sbrian * 576358Sbrian * This code is derived from software contributed to Berkeley by 676195Sbrian * The Mach Operating System project at Carnegie-Mellon University. 776195Sbrian * 876195Sbrian * Redistribution and use in source and binary forms, with or without 976195Sbrian * modification, are permitted provided that the following conditions 1076195Sbrian * are met: 1176195Sbrian * 1. Redistributions of source code must retain the above copyright 1276195Sbrian * notice, this list of conditions and the following disclaimer. 1376195Sbrian * 2. Redistributions in binary form must reproduce the above copyright 1476195Sbrian * notice, this list of conditions and the following disclaimer in the 1576195Sbrian * documentation and/or other materials provided with the distribution. 1676195Sbrian * 4. Neither the name of the University nor the names of its contributors 1776195Sbrian * may be used to endorse or promote products derived from this software 1876195Sbrian * without specific prior written permission. 1976195Sbrian * 2076195Sbrian * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2176195Sbrian * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2276195Sbrian * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2376195Sbrian * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2476195Sbrian * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2576195Sbrian * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2676195Sbrian * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2776195Sbrian * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2876195Sbrian * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2976195Sbrian * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3076195Sbrian * SUCH DAMAGE. 3176195Sbrian * 3276195Sbrian * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94 3376195Sbrian * 3476195Sbrian * 3576195Sbrian * Copyright (c) 1987, 1990 Carnegie-Mellon University. 3676195Sbrian * All rights reserved. 3776195Sbrian * 3876195Sbrian * Authors: Avadis Tevanian, Jr., Michael Wayne Young 3976195Sbrian * 4076195Sbrian * Permission to use, copy, modify and distribute this software and 4176195Sbrian * its documentation is hereby granted, provided that both the copyright 4276195Sbrian * notice and this permission notice appear in all copies of the 4376195Sbrian * software, derivative works or modified versions, and any portions 4476195Sbrian * thereof, and that both notices appear in supporting documentation. 4576195Sbrian * 4676195Sbrian * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 4776195Sbrian * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 4876195Sbrian * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 4976195Sbrian * 5076195Sbrian * Carnegie Mellon requests users of this software to return to 5176195Sbrian * 5276195Sbrian * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 5376848Sbrian * School of Computer Science 5476853Sbrian * Carnegie Mellon University 5576853Sbrian * Pittsburgh PA 15213-3890 5676853Sbrian * 5776853Sbrian * any improvements or extensions that they make and grant Carnegie the 5876195Sbrian * rights to redistribute these changes. 5976195Sbrian * 6076195Sbrian * $FreeBSD: stable/9/sys/vm/vm_object.h 233728 2012-03-31 06:44:48Z kib $ 6176195Sbrian */ 6276195Sbrian 6376195Sbrian/* 6476195Sbrian * Virtual memory object module definitions. 6576195Sbrian */ 6676195Sbrian 6776195Sbrian#ifndef _VM_OBJECT_ 6876195Sbrian#define _VM_OBJECT_ 6976195Sbrian 7076195Sbrian#include <sys/queue.h> 7176195Sbrian#include <sys/_lock.h> 7276195Sbrian#include <sys/_mutex.h> 7376195Sbrian 7476195Sbrian/* 7576195Sbrian * Types defined: 7676195Sbrian * 7776195Sbrian * vm_object_t Virtual memory object. 7876195Sbrian * 7976195Sbrian * List of locks 8076195Sbrian * (c) const until freed 8176195Sbrian * 8276195Sbrian */ 8376195Sbrian 8476195Sbrianstruct vm_object { 8576195Sbrian struct mtx mtx; 8676195Sbrian TAILQ_ENTRY(vm_object) object_list; /* list of all objects */ 8776195Sbrian LIST_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */ 8876195Sbrian LIST_ENTRY(vm_object) shadow_list; /* chain of shadow objects */ 8976195Sbrian TAILQ_HEAD(, vm_page) memq; /* list of resident pages */ 9076195Sbrian vm_page_t root; /* root of the resident page splay tree */ 9176195Sbrian vm_pindex_t size; /* Object size */ 9276195Sbrian int generation; /* generation ID */ 9376195Sbrian int ref_count; /* How many refs?? */ 9476195Sbrian int shadow_count; /* how many objects that this is a shadow for */ 9576195Sbrian vm_memattr_t memattr; /* default memory attribute for pages */ 9676195Sbrian objtype_t type; /* type of pager */ 9776195Sbrian u_short flags; /* see below */ 9876195Sbrian u_short pg_color; /* (c) color of first page in obj */ 9976195Sbrian u_short pad1; /* Old pip counter */ 10076195Sbrian int resident_page_count; /* number of resident pages */ 10176195Sbrian struct vm_object *backing_object; /* object that I'm a shadow of */ 10276195Sbrian vm_ooffset_t backing_object_offset;/* Offset in backing object */ 10376195Sbrian TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */ 10476195Sbrian LIST_HEAD(, vm_reserv) rvq; /* list of reservations */ 10576195Sbrian vm_page_t cache; /* root of the cache page splay tree */ 10689062Smsmith void *handle; 10789062Smsmith union { 10876195Sbrian /* 10976195Sbrian * VNode pager 11076195Sbrian * 11176195Sbrian * vnp_size - current size of file 11276195Sbrian */ 11376195Sbrian struct { 11476195Sbrian off_t vnp_size; 11576195Sbrian vm_ooffset_t writemappings; 11676195Sbrian } vnp; 11776195Sbrian 11876195Sbrian /* 11976195Sbrian * Device pager 12076195Sbrian * 12176195Sbrian * devp_pglist - list of allocated pages 12276195Sbrian */ 12376195Sbrian struct { 12476195Sbrian TAILQ_HEAD(, vm_page) devp_pglist; 12576195Sbrian struct cdev_pager_ops *ops; 12676195Sbrian } devp; 12776195Sbrian 12876195Sbrian /* 12976195Sbrian * SG pager 13076195Sbrian * 13176195Sbrian * sgp_pglist - list of allocated pages 13276195Sbrian */ 13376195Sbrian struct { 13476195Sbrian TAILQ_HEAD(, vm_page) sgp_pglist; 13576195Sbrian } sgp; 13676195Sbrian 13776195Sbrian /* 13876195Sbrian * Swap pager 13976195Sbrian * 14076195Sbrian * swp_bcount - number of swap 'swblock' metablocks, each 14176195Sbrian * contains up to 16 swapblk assignments. 14276195Sbrian * see vm/swap_pager.h 14376195Sbrian */ 14476195Sbrian struct { 14576195Sbrian int swp_bcount; 14676195Sbrian } swp; 14776195Sbrian } un_pager; 14876195Sbrian struct ucred *cred; 14976195Sbrian vm_ooffset_t charge; 15076195Sbrian u_int paging_in_progress; /* Paging (in or out) so don't collapse or destroy */ 15176195Sbrian}; 15276195Sbrian 15376195Sbrian/* 15476195Sbrian * Flags 15576195Sbrian */ 15676195Sbrian#define OBJ_ACTIVE 0x0004 /* active objects */ 15776195Sbrian#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */ 15876195Sbrian#define OBJ_NOSPLIT 0x0010 /* dont split this object */ 15976195Sbrian#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */ 16076195Sbrian#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty, only for vnode */ 16176195Sbrian#define OBJ_COLORED 0x1000 /* pg_color is defined */ 16276195Sbrian#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */ 16376195Sbrian#define OBJ_DISCONNECTWNT 0x4000 /* disconnect from vnode wanted */ 16476195Sbrian 16576195Sbrian#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT) 16676195Sbrian#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT)) 16776195Sbrian 16876195Sbrian#ifdef _KERNEL 16976195Sbrian 17076195Sbrian#define OBJPC_SYNC 0x1 /* sync I/O */ 17176195Sbrian#define OBJPC_INVAL 0x2 /* invalidate */ 17276195Sbrian#define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */ 17376195Sbrian 17476195Sbrian/* 17576195Sbrian * The following options are supported by vm_object_page_remove(). 17676195Sbrian */ 17776195Sbrian#define OBJPR_CLEANONLY 0x1 /* Don't remove dirty pages. */ 17876195Sbrian#define OBJPR_NOTMAPPED 0x2 /* Don't unmap pages. */ 17976195Sbrian 18076195SbrianTAILQ_HEAD(object_q, vm_object); 18176195Sbrian 18276195Sbrianextern struct object_q vm_object_list; /* list of allocated objects */ 18376195Sbrianextern struct mtx vm_object_list_mtx; /* lock for object list and count */ 18476195Sbrian 18576195Sbrianextern struct vm_object kernel_object_store; 18676195Sbrianextern struct vm_object kmem_object_store; 18776195Sbrian 18876195Sbrian#define kernel_object (&kernel_object_store) 18976195Sbrian#define kmem_object (&kmem_object_store) 19076195Sbrian 19176195Sbrian#define VM_OBJECT_LOCK(object) mtx_lock(&(object)->mtx) 19276195Sbrian#define VM_OBJECT_LOCK_ASSERT(object, type) \ 19376195Sbrian mtx_assert(&(object)->mtx, (type)) 19476195Sbrian#define VM_OBJECT_LOCK_INIT(object, type) \ 19576195Sbrian mtx_init(&(object)->mtx, "vm object", \ 19676195Sbrian (type), MTX_DEF | MTX_DUPOK) 19776195Sbrian#define VM_OBJECT_LOCKED(object) mtx_owned(&(object)->mtx) 19876195Sbrian#define VM_OBJECT_MTX(object) (&(object)->mtx) 19976195Sbrian#define VM_OBJECT_TRYLOCK(object) mtx_trylock(&(object)->mtx) 20076195Sbrian#define VM_OBJECT_UNLOCK(object) mtx_unlock(&(object)->mtx) 20176195Sbrian 20276195Sbrian/* 20376195Sbrian * The object must be locked or thread private. 20476195Sbrian */ 20576195Sbrianstatic __inline void 20676195Sbrianvm_object_set_flag(vm_object_t object, u_short bits) 20776195Sbrian{ 20876195Sbrian 20976195Sbrian object->flags |= bits; 21076195Sbrian} 21176195Sbrian 21276195Sbrianvoid vm_object_clear_flag(vm_object_t object, u_short bits); 21376195Sbrianvoid vm_object_pip_add(vm_object_t object, short i); 21476195Sbrianvoid vm_object_pip_subtract(vm_object_t object, short i); 21576195Sbrianvoid vm_object_pip_wakeup(vm_object_t object); 21676195Sbrianvoid vm_object_pip_wakeupn(vm_object_t object, short i); 21776195Sbrianvoid vm_object_pip_wait(vm_object_t object, char *waitid); 21876195Sbrian 21976195Sbrianvm_object_t vm_object_allocate (objtype_t, vm_pindex_t); 22076195Sbrianvoid _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t); 22176195Sbrianboolean_t vm_object_coalesce(vm_object_t, vm_ooffset_t, vm_size_t, vm_size_t, 22276195Sbrian boolean_t); 22376195Sbrianvoid vm_object_collapse (vm_object_t); 22476195Sbrianvoid vm_object_deallocate (vm_object_t); 22576195Sbrianvoid vm_object_destroy (vm_object_t); 22676195Sbrianvoid vm_object_terminate (vm_object_t); 22776195Sbrianvoid vm_object_set_writeable_dirty (vm_object_t); 22876195Sbrianvoid vm_object_init (void); 22976195Sbrianvoid vm_object_page_cache(vm_object_t object, vm_pindex_t start, 23076195Sbrian vm_pindex_t end); 23176195Sbrianboolean_t vm_object_page_clean(vm_object_t object, vm_ooffset_t start, 23276195Sbrian vm_ooffset_t end, int flags); 23376195Sbrianvoid vm_object_page_remove(vm_object_t object, vm_pindex_t start, 23476195Sbrian vm_pindex_t end, int options); 23576195Sbrianboolean_t vm_object_populate(vm_object_t, vm_pindex_t, vm_pindex_t); 23676195Sbrianvoid vm_object_print(long addr, boolean_t have_addr, long count, char *modif); 23776195Sbrianvoid vm_object_reference (vm_object_t); 23876195Sbrianvoid vm_object_reference_locked(vm_object_t); 23976195Sbrianint vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr); 24076195Sbrianvoid vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t); 24176195Sbrianvoid vm_object_split(vm_map_entry_t); 24276195Sbrianboolean_t vm_object_sync(vm_object_t, vm_ooffset_t, vm_size_t, boolean_t, 24376195Sbrian boolean_t); 24476195Sbrianvoid vm_object_madvise (vm_object_t, vm_pindex_t, int, int); 24576195Sbrian#endif /* _KERNEL */ 24676195Sbrian 24776195Sbrian#endif /* _VM_OBJECT_ */ 24876195Sbrian