1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 28 /* All Rights Reserved */ 29 30 /* 31 * University Copyright- Copyright (c) 1982, 1986, 1988 32 * The Regents of the University of California 33 * All Rights Reserved 34 * 35 * University Acknowledgment- Portions of this document are derived from 36 * software developed by the University of California, Berkeley, and its 37 * contributors. 38 */ 39 40 #ifndef _VM_AS_H 41 #define _VM_AS_H 42 43 #pragma ident "%Z%%M% %I% %E% SMI" 44 45 #include <sys/watchpoint.h> 46 #include <vm/seg.h> 47 #include <vm/faultcode.h> 48 #include <vm/hat.h> 49 #include <sys/avl.h> 50 51 #ifdef __cplusplus 52 extern "C" { 53 #endif 54 55 /* 56 * VM - Address spaces. 57 */ 58 59 /* 60 * Each address space consists of a sorted list of segments 61 * and machine dependent address translation information. 62 * 63 * All the hard work is in the segment drivers and the 64 * hardware address translation code. 65 * 66 * The segment list is represented as an AVL tree. 67 * 68 * The address space lock (a_lock) is a long term lock which serializes 69 * access to certain operations (as_map, as_unmap) and protects the 70 * underlying generic segment data (seg.h) along with some fields in the 71 * address space structure as shown below: 72 * 73 * address space structure segment structure 74 * 75 * a_segtree s_base 76 * a_size s_size 77 * a_lastgap s_link 78 * a_seglast s_ops 79 * s_as 80 * s_data 81 * 82 * The address space contents lock (a_contents) is a short term 83 * lock that protects most of the data in the address space structure. 84 * This lock is always acquired after the "a_lock" in all situations 85 * except while dealing with AS_CLAIMGAP to avoid deadlocks. 86 * 87 * The following fields are protected by this lock: 88 * 89 * a_flags (AS_PAGLCK, AS_CLAIMGAP, etc.) 90 * a_unmapwait 91 * a_seglast 92 * 93 * The address space lock (a_lock) is always held prior to any segment 94 * operation. Some segment drivers use the address space lock to protect 95 * some or all of their segment private data, provided the version of 96 * "a_lock" (read vs. write) is consistent with the use of the data. 97 * 98 * The following fields are protected by the hat layer lock: 99 * 100 * a_vbits 101 * a_hat 102 * a_hrm 103 */ 104 105 struct as { 106 kmutex_t a_contents; /* protect certain fields in the structure */ 107 uchar_t a_flags; /* as attributes */ 108 uchar_t a_vbits; /* used for collecting statistics */ 109 kcondvar_t a_cv; /* used by as_rangelock */ 110 struct hat *a_hat; /* hat structure */ 111 struct hrmstat *a_hrm; /* ref and mod bits */ 112 caddr_t a_userlimit; /* highest allowable address in this as */ 113 struct seg *a_seglast; /* last segment hit on the addr space */ 114 krwlock_t a_lock; /* protects segment related fields */ 115 size_t a_size; /* size of address space */ 116 struct seg *a_lastgap; /* last seg found by as_gap() w/ AS_HI (mmap) */ 117 struct seg *a_lastgaphl; /* last seg saved in as_gap() either for */ 118 /* AS_HI or AS_LO used in as_addseg() */ 119 avl_tree_t a_segtree; /* segments in this address space. (AVL tree) */ 120 avl_tree_t a_wpage; /* watched pages (procfs) */ 121 uchar_t a_updatedir; /* mappings changed, rebuild a_objectdir */ 122 timespec_t a_updatetime; /* time when mappings last changed */ 123 vnode_t **a_objectdir; /* object directory (procfs) */ 124 size_t a_sizedir; /* size of object directory */ 125 struct as_callback *a_callbacks; /* callback list */ 126 void *a_xhat; /* list of xhat providers */ 127 }; 128 129 #define AS_PAGLCK 0x80 130 #define AS_CLAIMGAP 0x40 131 #define AS_UNMAPWAIT 0x20 132 #define AS_NEEDSPURGE 0x10 /* mostly for seg_nf, see as_purge() */ 133 #define AS_BUSY 0x01 /* needed by XHAT framework */ 134 135 #define AS_ISPGLCK(as) ((as)->a_flags & AS_PAGLCK) 136 #define AS_ISCLAIMGAP(as) ((as)->a_flags & AS_CLAIMGAP) 137 #define AS_ISUNMAPWAIT(as) ((as)->a_flags & AS_UNMAPWAIT) 138 #define AS_ISBUSY(as) ((as)->a_flags & AS_BUSY) 139 140 141 #define AS_SETPGLCK(as) ((as)->a_flags |= AS_PAGLCK) 142 #define AS_SETCLAIMGAP(as) ((as)->a_flags |= AS_CLAIMGAP) 143 #define AS_SETUNMAPWAIT(as) ((as)->a_flags |= AS_UNMAPWAIT) 144 #define AS_SETBUSY(as) ((as)->a_flags |= AS_BUSY) 145 146 #define AS_CLRPGLCK(as) ((as)->a_flags &= ~AS_PAGLCK) 147 #define AS_CLRCLAIMGAP(as) ((as)->a_flags &= ~AS_CLAIMGAP) 148 #define AS_CLRUNMAPWAIT(as) ((as)->a_flags &= ~AS_UNMAPWAIT) 149 #define AS_CLRBUSY(as) ((as)->a_flags &= ~AS_BUSY) 150 151 #define AS_TYPE_64BIT(as) \ 152 (((as)->a_userlimit > (caddr_t)UINT32_MAX) ? 1 : 0) 153 154 /* 155 * The as_callback is the basic structure which supports the ability to 156 * inform clients of specific events pertaining to address space management. 157 * A user calls as_add_callback to register an address space callback 158 * for a range of pages, specifying the events that need to occur. 159 * When as_do_callbacks is called and finds a 'matching' entry, the 160 * callback is called once, and the callback function MUST call 161 * as_delete_callback when all callback activities are complete. 162 * The thread calling as_do_callbacks blocks until the as_delete_callback 163 * is called. This allows for asynchorous events to subside before the 164 * as_do_callbacks thread continues. 165 * 166 * An example of the need for this is a driver which has done long-term 167 * locking of memory. Address space management operations (events) such 168 * as as_free, as_umap, and as_setprot will block indefinitely until the 169 * pertinent memory is unlocked. The callback mechanism provides the 170 * way to inform the driver of the event so that the driver may do the 171 * necessary unlocking. 172 * 173 * The contents of this structure is protected by a_contents lock 174 */ 175 typedef void (*callback_func_t)(struct as *, void *, uint_t); 176 struct as_callback { 177 struct as_callback *ascb_next; /* list link */ 178 uint_t ascb_events; /* event types */ 179 callback_func_t ascb_func; /* callback function */ 180 void *ascb_arg; /* callback argument */ 181 caddr_t ascb_saddr; /* start address */ 182 size_t ascb_len; /* address range */ 183 }; 184 /* 185 * Callback events 186 */ 187 #define AS_FREE_EVENT 0x1 188 #define AS_SETPROT_EVENT 0x2 189 #define AS_UNMAP_EVENT 0x4 190 #define AS_CALLBACK_CALLED ((uint_t)(1U << (8 * sizeof (uint_t) - 1U))) 191 #define AS_UNMAPWAIT_EVENT \ 192 (AS_FREE_EVENT | AS_SETPROT_EVENT | AS_UNMAP_EVENT) 193 #define AS_ALL_EVENT \ 194 (AS_FREE_EVENT | AS_SETPROT_EVENT | AS_UNMAP_EVENT) 195 196 197 /* Return code values for as_callback_delete */ 198 enum as_cbdelete_rc { 199 AS_CALLBACK_DELETED, 200 AS_CALLBACK_NOTFOUND, 201 AS_CALLBACK_DELETE_DEFERRED 202 }; 203 204 #ifdef _KERNEL 205 206 /* 207 * Flags for as_gap. 208 */ 209 #define AH_DIR 0x1 /* direction flag mask */ 210 #define AH_LO 0x0 /* find lowest hole */ 211 #define AH_HI 0x1 /* find highest hole */ 212 #define AH_CONTAIN 0x2 /* hole must contain `addr' */ 213 214 extern struct as kas; /* kernel's address space */ 215 216 /* 217 * Macros for address space locking. 218 */ 219 #define AS_LOCK_ENTER(as, lock, type) rw_enter((lock), (type)) 220 #define AS_LOCK_EXIT(as, lock) rw_exit((lock)) 221 #define AS_LOCK_DESTROY(as, lock) rw_destroy((lock)) 222 #define AS_LOCK_TRYENTER(as, lock, type) rw_tryenter((lock), (type)) 223 224 /* 225 * Macros to test lock states. 226 */ 227 #define AS_LOCK_HELD(as, lock) RW_LOCK_HELD((lock)) 228 #define AS_READ_HELD(as, lock) RW_READ_HELD((lock)) 229 #define AS_WRITE_HELD(as, lock) RW_WRITE_HELD((lock)) 230 231 /* 232 * macros to walk thru segment lists 233 */ 234 #define AS_SEGFIRST(as) avl_first(&(as)->a_segtree) 235 #define AS_SEGNEXT(as, seg) AVL_NEXT(&(as)->a_segtree, (seg)) 236 #define AS_SEGPREV(as, seg) AVL_PREV(&(as)->a_segtree, (seg)) 237 238 void as_init(void); 239 void as_avlinit(struct as *); 240 struct seg *as_segat(struct as *as, caddr_t addr); 241 void as_rangelock(struct as *as); 242 void as_rangeunlock(struct as *as); 243 struct as *as_alloc(void); 244 void as_free(struct as *as); 245 int as_dup(struct as *as, struct as **outas); 246 struct seg *as_findseg(struct as *as, caddr_t addr, int tail); 247 int as_addseg(struct as *as, struct seg *newseg); 248 struct seg *as_removeseg(struct as *as, struct seg *seg); 249 faultcode_t as_fault(struct hat *hat, struct as *as, caddr_t addr, size_t size, 250 enum fault_type type, enum seg_rw rw); 251 faultcode_t as_faulta(struct as *as, caddr_t addr, size_t size); 252 int as_setprot(struct as *as, caddr_t addr, size_t size, uint_t prot); 253 int as_checkprot(struct as *as, caddr_t addr, size_t size, uint_t prot); 254 int as_unmap(struct as *as, caddr_t addr, size_t size); 255 int as_map(struct as *as, caddr_t addr, size_t size, int ((*crfp)()), 256 void *argsp); 257 void as_purge(struct as *as); 258 int as_gap(struct as *as, size_t minlen, caddr_t *basep, size_t *lenp, 259 uint_t flags, caddr_t addr); 260 int as_memory(struct as *as, caddr_t *basep, size_t *lenp); 261 size_t as_swapout(struct as *as); 262 int as_incore(struct as *as, caddr_t addr, size_t size, char *vec, 263 size_t *sizep); 264 int as_ctl(struct as *as, caddr_t addr, size_t size, int func, int attr, 265 uintptr_t arg, ulong_t *lock_map, size_t pos); 266 int as_exec(struct as *oas, caddr_t ostka, size_t stksz, 267 struct as *nas, caddr_t nstka, uint_t hatflag); 268 int as_pagelock(struct as *as, struct page ***ppp, caddr_t addr, 269 size_t size, enum seg_rw rw); 270 void as_pageunlock(struct as *as, struct page **pp, caddr_t addr, 271 size_t size, enum seg_rw rw); 272 void as_pagereclaim(struct as *as, struct page **pp, caddr_t addr, 273 size_t size, enum seg_rw rw); 274 int as_setpagesize(struct as *as, caddr_t addr, size_t size, uint_t szc, 275 boolean_t wait); 276 void as_setwatch(struct as *as); 277 void as_clearwatch(struct as *as); 278 int as_getmemid(struct as *, caddr_t, memid_t *); 279 280 int as_add_callback(struct as *, void (*)(), void *, uint_t, 281 caddr_t, size_t, int); 282 uint_t as_delete_callback(struct as *, void *); 283 284 #endif /* _KERNEL */ 285 286 #ifdef __cplusplus 287 } 288 #endif 289 290 #endif /* _VM_AS_H */ 291