NetBSD/sys/uvm/uvm_object.h

133 lines
4.3 KiB
C

/* $NetBSD: uvm_object.h,v 1.30 2011/02/02 15:13:34 chuck Exp $ */
/*
* Copyright (c) 1997 Charles D. Cranor and Washington University.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* from: Id: uvm_object.h,v 1.1.2.2 1998/01/04 22:44:51 chuck Exp
*/
#ifndef _UVM_UVM_OBJECT_H_
#define _UVM_UVM_OBJECT_H_
/*
* uvm_object.h
*/
#include <sys/rbtree.h>
#include <uvm/uvm_pglist.h>
/*
* uvm_object: all that is left of mach objects.
*/
struct uvm_object {
kmutex_t vmobjlock; /* lock on memq */
const struct uvm_pagerops *pgops; /* pager ops */
struct pglist memq; /* pages in this object */
int uo_npages; /* # of pages in memq */
unsigned uo_refs; /* reference count */
struct rb_tree rb_tree; /* tree of pages */
};
/*
* UVM_OBJ_KERN is a 'special' uo_refs value which indicates that the
* object is a kernel memory object rather than a normal one (kernel
* memory objects don't have reference counts -- they never die).
*
* this value is used to detected kernel object mappings at uvm_unmap()
* time. normally when an object is unmapped its pages eventaully become
* deactivated and then paged out and/or freed. this is not useful
* for kernel objects... when a kernel object is unmapped we always want
* to free the resources associated with the mapping. UVM_OBJ_KERN
* allows us to decide which type of unmapping we want to do.
*/
#define UVM_OBJ_KERN (-2)
#define UVM_OBJ_IS_KERN_OBJECT(uobj) \
((uobj)->uo_refs == UVM_OBJ_KERN)
#ifdef _KERNEL
extern const struct uvm_pagerops uvm_vnodeops;
extern const struct uvm_pagerops uvm_deviceops;
extern const struct uvm_pagerops ubc_pager;
extern const struct uvm_pagerops aobj_pager;
#define UVM_OBJ_IS_VNODE(uobj) \
((uobj)->pgops == &uvm_vnodeops)
#define UVM_OBJ_IS_DEVICE(uobj) \
((uobj)->pgops == &uvm_deviceops)
#define UVM_OBJ_IS_VTEXT(uobj) \
(UVM_OBJ_IS_VNODE(uobj) && uvn_text_p(uobj))
#define UVM_OBJ_IS_CLEAN(uobj) \
(UVM_OBJ_IS_VNODE(uobj) && uvn_clean_p(uobj))
/*
* UVM_OBJ_NEEDS_WRITEFAULT: true if the uobj needs to detect modification.
* (ie. wants to avoid writable user mappings.)
*
* XXX bad name
*/
#define UVM_OBJ_NEEDS_WRITEFAULT(uobj) \
(UVM_OBJ_IS_VNODE(uobj) && uvn_needs_writefault_p(uobj))
#define UVM_OBJ_IS_AOBJ(uobj) \
((uobj)->pgops == &aobj_pager)
extern const rb_tree_ops_t uvm_page_tree_ops;
#define UVM_OBJ_INIT(uobj, ops, refs) \
do { \
mutex_init(&(uobj)->vmobjlock, MUTEX_DEFAULT, IPL_NONE);\
(uobj)->pgops = (ops); \
TAILQ_INIT(&(uobj)->memq); \
(uobj)->uo_npages = 0; \
(uobj)->uo_refs = (refs); \
rb_tree_init(&(uobj)->rb_tree, &uvm_page_tree_ops); \
} while (/* CONSTCOND */ 0)
#ifdef DIAGNOSTIC
#define UVM_OBJ_DESTROY(uobj) \
do { \
voff_t _xo = 0; \
void *_xn; \
mutex_destroy(&(uobj)->vmobjlock); \
_xn = rb_tree_find_node_geq(&(uobj)->rb_tree, &_xo); \
KASSERT(_xn == NULL); \
} while (/* CONSTCOND */ 0)
#else
#define UVM_OBJ_DESTROY(uobj) \
do { \
mutex_destroy(&(uobj)->vmobjlock); \
} while (/* CONSTCOND */ 0)
#endif /* DIAGNOSTIC */
#endif /* _KERNEL */
#endif /* _UVM_UVM_OBJECT_H_ */