1 /* 2 * Copyright (c) 1991 Regents of the University of California. 3 * 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 * %sccs.include.redist.c% 9 * 10 * @(#)vm_object.h 7.7 (Berkeley) 05/04/92 11 * 12 * 13 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 14 * All rights reserved. 15 * 16 * Authors: Avadis Tevanian, Jr., Michael Wayne Young 17 * 18 * Permission to use, copy, modify and distribute this software and 19 * its documentation is hereby granted, provided that both the copyright 20 * notice and this permission notice appear in all copies of the 21 * software, derivative works or modified versions, and any portions 22 * thereof, and that both notices appear in supporting documentation. 23 * 24 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 25 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 26 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 27 * 28 * Carnegie Mellon requests users of this software to return to 29 * 30 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 31 * School of Computer Science 32 * Carnegie Mellon University 33 * Pittsburgh PA 15213-3890 34 * 35 * any improvements or extensions that they make and grant Carnegie the 36 * rights to redistribute these changes. 37 */ 38 39 /* 40 * Virtual memory object module definitions. 41 */ 42 43 #ifndef _VM_OBJECT_ 44 #define _VM_OBJECT_ 45 46 #include <vm/vm_pager.h> 47 48 /* 49 * Types defined: 50 * 51 * vm_object_t Virtual memory object. 52 */ 53 54 struct vm_object { 55 queue_chain_t memq; /* Resident memory */ 56 queue_chain_t object_list; /* list of all objects */ 57 u_short flags; /* see below */ 58 u_short paging_in_progress; /* Paging (in or out) so 59 don't collapse or destroy */ 60 simple_lock_data_t Lock; /* Synchronization */ 61 int LockHolder; 62 int ref_count; /* How many refs?? */ 63 vm_size_t size; /* Object size */ 64 int resident_page_count; 65 /* number of resident pages */ 66 struct vm_object *copy; /* Object that holds copies of 67 my changed pages */ 68 vm_pager_t pager; /* Where to get data */ 69 vm_offset_t paging_offset; /* Offset into paging space */ 70 struct vm_object *shadow; /* My shadow */ 71 vm_offset_t shadow_offset; /* Offset in shadow */ 72 queue_chain_t cached_list; /* for persistence */ 73 }; 74 /* 75 * Flags 76 */ 77 #define OBJ_CANPERSIST 0x0001 /* allow to persist */ 78 #define OBJ_INTERNAL 0x0002 /* internally created object */ 79 #define OBJ_ACTIVE 0x0004 /* used to mark active objects */ 80 81 struct vm_object_hash_entry { 82 queue_chain_t hash_links; /* hash chain links */ 83 vm_object_t object; /* object we represent */ 84 }; 85 86 typedef struct vm_object_hash_entry *vm_object_hash_entry_t; 87 88 #ifdef KERNEL 89 queue_head_t vm_object_cached_list; /* list of objects persisting */ 90 int vm_object_cached; /* size of cached list */ 91 simple_lock_data_t vm_cache_lock; /* lock for object cache */ 92 93 queue_head_t vm_object_list; /* list of allocated objects */ 94 long vm_object_count; /* count of all objects */ 95 simple_lock_data_t vm_object_list_lock; 96 /* lock for object list and count */ 97 98 vm_object_t kernel_object; /* the single kernel object */ 99 vm_object_t kmem_object; 100 101 #define vm_object_cache_lock() simple_lock(&vm_cache_lock) 102 #define vm_object_cache_unlock() simple_unlock(&vm_cache_lock) 103 #endif KERNEL 104 105 #if VM_OBJECT_DEBUG 106 #define vm_object_lock_init(object) { simple_lock_init(&(object)->Lock); (object)->LockHolder = 0; } 107 #define vm_object_lock(object) { simple_lock(&(object)->Lock); (object)->LockHolder = (int) current_thread(); } 108 #define vm_object_unlock(object) { (object)->LockHolder = 0; simple_unlock(&(object)->Lock); } 109 #define vm_object_lock_try(object) (simple_lock_try(&(object)->Lock) ? ( ((object)->LockHolder = (int) current_thread()) , TRUE) : FALSE) 110 #define vm_object_sleep(event, object, interruptible) \ 111 { (object)->LockHolder = 0; thread_sleep((event), &(object)->Lock, (interruptible)); } 112 #else VM_OBJECT_DEBUG 113 #define vm_object_lock_init(object) simple_lock_init(&(object)->Lock) 114 #define vm_object_lock(object) simple_lock(&(object)->Lock) 115 #define vm_object_unlock(object) simple_unlock(&(object)->Lock) 116 #define vm_object_lock_try(object) simple_lock_try(&(object)->Lock) 117 #define vm_object_sleep(event, object, interruptible) \ 118 thread_sleep((event), &(object)->Lock, (interruptible)) 119 #endif VM_OBJECT_DEBUG 120 121 #ifdef KERNEL 122 vm_object_t vm_object_allocate __P((vm_size_t)); 123 void vm_object_cache_clear __P((void)); 124 void vm_object_cache_trim __P((void)); 125 boolean_t vm_object_coalesce __P((vm_object_t, vm_object_t, 126 vm_offset_t, vm_offset_t, vm_offset_t, vm_size_t)); 127 void vm_object_collapse __P((vm_object_t)); 128 void vm_object_copy __P((vm_object_t, vm_offset_t, vm_size_t, 129 vm_object_t *, vm_offset_t *, boolean_t *)); 130 void vm_object_deactivate_pages __P((vm_object_t)); 131 void vm_object_deallocate __P((vm_object_t)); 132 void vm_object_enter __P((vm_object_t, vm_pager_t)); 133 void vm_object_init __P((vm_size_t)); 134 vm_object_t vm_object_lookup __P((vm_pager_t)); 135 void vm_object_page_clean __P((vm_object_t, 136 vm_offset_t, vm_offset_t, boolean_t)); 137 void vm_object_page_remove __P((vm_object_t, 138 vm_offset_t, vm_offset_t)); 139 void vm_object_pmap_copy __P((vm_object_t, 140 vm_offset_t, vm_offset_t)); 141 void vm_object_pmap_remove __P((vm_object_t, 142 vm_offset_t, vm_offset_t)); 143 void vm_object_print __P((vm_object_t, boolean_t)); 144 void vm_object_reference __P((vm_object_t)); 145 void vm_object_remove __P((vm_pager_t)); 146 void vm_object_setpager __P((vm_object_t, 147 vm_pager_t, vm_offset_t, boolean_t)); 148 void vm_object_shadow __P((vm_object_t *, 149 vm_offset_t *, vm_size_t)); 150 void vm_object_shutdown __P((void)); 151 void vm_object_terminate __P((vm_object_t)); 152 #endif 153 #endif _VM_OBJECT_ 154