1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1990 University of Utah. 5 * Copyright (c) 1991, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * the Systems Programming Group of the University of Utah Computer 10 * Science Department. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. 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 * @(#)vm_pager.h 8.4 (Berkeley) 1/12/94 37 * $FreeBSD$ 38 */ 39 40 /* 41 * Pager routine interface definition. 42 */ 43 44 #ifndef _VM_PAGER_ 45 #define _VM_PAGER_ 46 47 #include <sys/queue.h> 48 49 TAILQ_HEAD(pagerlst, vm_object); 50 struct vnode; 51 52 typedef void pgo_init_t(void); 53 typedef vm_object_t pgo_alloc_t(void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t, 54 struct ucred *); 55 typedef void pgo_dealloc_t(vm_object_t); 56 typedef int pgo_getpages_t(vm_object_t, vm_page_t *, int, int *, int *); 57 typedef void pgo_getpages_iodone_t(void *, vm_page_t *, int, int); 58 typedef int pgo_getpages_async_t(vm_object_t, vm_page_t *, int, int *, int *, 59 pgo_getpages_iodone_t, void *); 60 typedef void pgo_putpages_t(vm_object_t, vm_page_t *, int, int, int *); 61 typedef boolean_t pgo_haspage_t(vm_object_t, vm_pindex_t, int *, int *); 62 typedef int pgo_populate_t(vm_object_t, vm_pindex_t, int, vm_prot_t, 63 vm_pindex_t *, vm_pindex_t *); 64 typedef void pgo_pageunswapped_t(vm_page_t); 65 typedef void pgo_writecount_t(vm_object_t, vm_offset_t, vm_offset_t); 66 typedef void pgo_set_writeable_dirty_t(vm_object_t); 67 typedef bool pgo_mightbedirty_t(vm_object_t); 68 typedef void pgo_getvp_t(vm_object_t object, struct vnode **vpp, 69 bool *vp_heldp); 70 typedef void pgo_freespace_t(vm_object_t object, vm_pindex_t start, 71 vm_size_t size); 72 73 struct pagerops { 74 pgo_init_t *pgo_init; /* Initialize pager. */ 75 pgo_alloc_t *pgo_alloc; /* Allocate pager. */ 76 pgo_dealloc_t *pgo_dealloc; /* Disassociate. */ 77 pgo_getpages_t *pgo_getpages; /* Get (read) page. */ 78 pgo_getpages_async_t *pgo_getpages_async; /* Get page asyncly. */ 79 pgo_putpages_t *pgo_putpages; /* Put (write) page. */ 80 pgo_haspage_t *pgo_haspage; /* Query page. */ 81 pgo_populate_t *pgo_populate; /* Bulk spec pagein. */ 82 pgo_pageunswapped_t *pgo_pageunswapped; 83 pgo_writecount_t *pgo_update_writecount; 84 pgo_writecount_t *pgo_release_writecount; 85 pgo_set_writeable_dirty_t *pgo_set_writeable_dirty; 86 pgo_mightbedirty_t *pgo_mightbedirty; 87 pgo_getvp_t *pgo_getvp; 88 pgo_freespace_t *pgo_freespace; 89 }; 90 91 extern struct pagerops defaultpagerops; 92 extern struct pagerops swappagerops; 93 extern struct pagerops vnodepagerops; 94 extern struct pagerops devicepagerops; 95 extern struct pagerops physpagerops; 96 extern struct pagerops sgpagerops; 97 extern struct pagerops mgtdevicepagerops; 98 99 /* 100 * get/put return values 101 * OK operation was successful 102 * BAD specified data was out of the accepted range 103 * FAIL specified data was in range, but doesn't exist 104 * PEND operations was initiated but not completed 105 * ERROR error while accessing data that is in range and exists 106 * AGAIN temporary resource shortage prevented operation from happening 107 */ 108 #define VM_PAGER_OK 0 109 #define VM_PAGER_BAD 1 110 #define VM_PAGER_FAIL 2 111 #define VM_PAGER_PEND 3 112 #define VM_PAGER_ERROR 4 113 #define VM_PAGER_AGAIN 5 114 115 #define VM_PAGER_PUT_SYNC 0x0001 116 #define VM_PAGER_PUT_INVAL 0x0002 117 #define VM_PAGER_PUT_NOREUSE 0x0004 118 #define VM_PAGER_CLUSTER_OK 0x0008 119 120 #ifdef _KERNEL 121 122 extern struct pagerops *pagertab[]; 123 extern struct mtx_padalign pbuf_mtx; 124 125 /* 126 * Number of pages that pbuf buffer can store in b_pages. 127 * It is +1 to allow for unaligned data buffer of maxphys size. 128 */ 129 #define PBUF_PAGES (atop(maxphys) + 1) 130 131 vm_object_t vm_pager_allocate(objtype_t, void *, vm_ooffset_t, vm_prot_t, 132 vm_ooffset_t, struct ucred *); 133 void vm_pager_bufferinit(void); 134 void vm_pager_deallocate(vm_object_t); 135 int vm_pager_get_pages(vm_object_t, vm_page_t *, int, int *, int *); 136 int vm_pager_get_pages_async(vm_object_t, vm_page_t *, int, int *, int *, 137 pgo_getpages_iodone_t, void *); 138 void vm_pager_init(void); 139 vm_object_t vm_pager_object_lookup(struct pagerlst *, void *); 140 141 static __inline void 142 vm_pager_put_pages(vm_object_t object, vm_page_t *m, int count, int flags, 143 int *rtvals) 144 { 145 VM_OBJECT_ASSERT_WLOCKED(object); 146 (*pagertab[object->type]->pgo_putpages) 147 (object, m, count, flags, rtvals); 148 } 149 150 /* 151 * vm_pager_haspage 152 * 153 * Check to see if an object's pager has the requested page. The 154 * object's pager will also set before and after to give the caller 155 * some idea of the number of pages before and after the requested 156 * page can be I/O'd efficiently. 157 * 158 * The object must be locked. 159 */ 160 static __inline boolean_t 161 vm_pager_has_page(vm_object_t object, vm_pindex_t offset, int *before, 162 int *after) 163 { 164 boolean_t ret; 165 166 VM_OBJECT_ASSERT_LOCKED(object); 167 ret = (*pagertab[object->type]->pgo_haspage) 168 (object, offset, before, after); 169 return (ret); 170 } 171 172 static __inline int 173 vm_pager_populate(vm_object_t object, vm_pindex_t pidx, int fault_type, 174 vm_prot_t max_prot, vm_pindex_t *first, vm_pindex_t *last) 175 { 176 177 MPASS((object->flags & OBJ_POPULATE) != 0); 178 MPASS(pidx < object->size); 179 MPASS(blockcount_read(&object->paging_in_progress) > 0); 180 return ((*pagertab[object->type]->pgo_populate)(object, pidx, 181 fault_type, max_prot, first, last)); 182 } 183 184 /* 185 * vm_pager_page_unswapped 186 * 187 * Destroy swap associated with the page. 188 * 189 * XXX: A much better name would be "vm_pager_page_dirtied()" 190 * XXX: It is not obvious if this could be profitably used by any 191 * XXX: pagers besides the swap_pager or if it should even be a 192 * XXX: generic pager_op in the first place. 193 */ 194 static __inline void 195 vm_pager_page_unswapped(vm_page_t m) 196 { 197 pgo_pageunswapped_t *method; 198 199 method = pagertab[m->object->type]->pgo_pageunswapped; 200 if (method != NULL) 201 method(m); 202 } 203 204 static __inline void 205 vm_pager_update_writecount(vm_object_t object, vm_offset_t start, 206 vm_offset_t end) 207 { 208 pgo_writecount_t *method; 209 210 method = pagertab[object->type]->pgo_update_writecount; 211 if (method != NULL) 212 method(object, start, end); 213 } 214 215 static __inline void 216 vm_pager_release_writecount(vm_object_t object, vm_offset_t start, 217 vm_offset_t end) 218 { 219 pgo_writecount_t *method; 220 221 method = pagertab[object->type]->pgo_release_writecount; 222 if (method != NULL) 223 method(object, start, end); 224 } 225 226 static __inline void 227 vm_pager_getvp(vm_object_t object, struct vnode **vpp, bool *vp_heldp) 228 { 229 pgo_getvp_t *method; 230 231 *vpp = NULL; 232 if (vp_heldp != NULL) 233 *vp_heldp = false; 234 method = pagertab[object->type]->pgo_getvp; 235 if (method != NULL) 236 method(object, vpp, vp_heldp); 237 } 238 239 static __inline void 240 vm_pager_freespace(vm_object_t object, vm_pindex_t start, 241 vm_size_t size) 242 { 243 pgo_freespace_t *method; 244 245 method = pagertab[object->type]->pgo_freespace; 246 if (method != NULL) 247 method(object, start, size); 248 } 249 250 struct cdev_pager_ops { 251 int (*cdev_pg_fault)(vm_object_t vm_obj, vm_ooffset_t offset, 252 int prot, vm_page_t *mres); 253 int (*cdev_pg_populate)(vm_object_t vm_obj, vm_pindex_t pidx, 254 int fault_type, vm_prot_t max_prot, vm_pindex_t *first, 255 vm_pindex_t *last); 256 int (*cdev_pg_ctor)(void *handle, vm_ooffset_t size, vm_prot_t prot, 257 vm_ooffset_t foff, struct ucred *cred, u_short *color); 258 void (*cdev_pg_dtor)(void *handle); 259 }; 260 261 vm_object_t cdev_pager_allocate(void *handle, enum obj_type tp, 262 struct cdev_pager_ops *ops, vm_ooffset_t size, vm_prot_t prot, 263 vm_ooffset_t foff, struct ucred *cred); 264 vm_object_t cdev_pager_lookup(void *handle); 265 void cdev_pager_free_page(vm_object_t object, vm_page_t m); 266 267 struct phys_pager_ops { 268 int (*phys_pg_getpages)(vm_object_t vm_obj, vm_page_t *m, int count, 269 int *rbehind, int *rahead); 270 int (*phys_pg_populate)(vm_object_t vm_obj, vm_pindex_t pidx, 271 int fault_type, vm_prot_t max_prot, vm_pindex_t *first, 272 vm_pindex_t *last); 273 boolean_t (*phys_pg_haspage)(vm_object_t obj, vm_pindex_t pindex, 274 int *before, int *after); 275 void (*phys_pg_ctor)(vm_object_t vm_obj, vm_prot_t prot, 276 vm_ooffset_t foff, struct ucred *cred); 277 void (*phys_pg_dtor)(vm_object_t vm_obj); 278 }; 279 extern struct phys_pager_ops default_phys_pg_ops; 280 vm_object_t phys_pager_allocate(void *handle, struct phys_pager_ops *ops, 281 void *data, vm_ooffset_t size, vm_prot_t prot, vm_ooffset_t foff, 282 struct ucred *cred); 283 284 #endif /* _KERNEL */ 285 #endif /* _VM_PAGER_ */ 286