1 /*- 2 * Copyright (c) 1990 University of Utah. 3 * Copyright (c) 1991, 1993 4 * The Regents of the University of California. All rights reserved. 5 * 6 * This code is derived from software contributed to Berkeley by 7 * the Systems Programming Group of the University of Utah Computer 8 * Science Department. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 4. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)vm_pager.h 8.4 (Berkeley) 1/12/94 35 * $FreeBSD$ 36 */ 37 38 /* 39 * Pager routine interface definition. 40 */ 41 42 #ifndef _VM_PAGER_ 43 #define _VM_PAGER_ 44 45 #include <sys/queue.h> 46 47 TAILQ_HEAD(pagerlst, vm_object); 48 49 typedef void pgo_init_t(void); 50 typedef vm_object_t pgo_alloc_t(void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t, 51 struct ucred *); 52 typedef void pgo_dealloc_t(vm_object_t); 53 typedef int pgo_getpages_t(vm_object_t, vm_page_t *, int, int *, int *); 54 typedef void pgo_getpages_iodone_t(void *, vm_page_t *, int, int); 55 typedef int pgo_getpages_async_t(vm_object_t, vm_page_t *, int, int *, int *, 56 pgo_getpages_iodone_t, void *); 57 typedef void pgo_putpages_t(vm_object_t, vm_page_t *, int, int, int *); 58 typedef boolean_t pgo_haspage_t(vm_object_t, vm_pindex_t, int *, int *); 59 typedef void pgo_pageunswapped_t(vm_page_t); 60 61 struct pagerops { 62 pgo_init_t *pgo_init; /* Initialize pager. */ 63 pgo_alloc_t *pgo_alloc; /* Allocate pager. */ 64 pgo_dealloc_t *pgo_dealloc; /* Disassociate. */ 65 pgo_getpages_t *pgo_getpages; /* Get (read) page. */ 66 pgo_getpages_async_t *pgo_getpages_async; /* Get page asyncly. */ 67 pgo_putpages_t *pgo_putpages; /* Put (write) page. */ 68 pgo_haspage_t *pgo_haspage; /* Query page. */ 69 pgo_pageunswapped_t *pgo_pageunswapped; 70 }; 71 72 extern struct pagerops defaultpagerops; 73 extern struct pagerops swappagerops; 74 extern struct pagerops vnodepagerops; 75 extern struct pagerops devicepagerops; 76 extern struct pagerops physpagerops; 77 extern struct pagerops sgpagerops; 78 extern struct pagerops mgtdevicepagerops; 79 80 /* 81 * get/put return values 82 * OK operation was successful 83 * BAD specified data was out of the accepted range 84 * FAIL specified data was in range, but doesn't exist 85 * PEND operations was initiated but not completed 86 * ERROR error while accessing data that is in range and exists 87 * AGAIN temporary resource shortage prevented operation from happening 88 */ 89 #define VM_PAGER_OK 0 90 #define VM_PAGER_BAD 1 91 #define VM_PAGER_FAIL 2 92 #define VM_PAGER_PEND 3 93 #define VM_PAGER_ERROR 4 94 #define VM_PAGER_AGAIN 5 95 96 #define VM_PAGER_PUT_SYNC 0x0001 97 #define VM_PAGER_PUT_INVAL 0x0002 98 #define VM_PAGER_CLUSTER_OK 0x0008 99 100 #ifdef _KERNEL 101 102 extern struct pagerops *pagertab[]; 103 extern struct mtx_padalign pbuf_mtx; 104 105 vm_object_t vm_pager_allocate(objtype_t, void *, vm_ooffset_t, vm_prot_t, 106 vm_ooffset_t, struct ucred *); 107 void vm_pager_bufferinit(void); 108 void vm_pager_deallocate(vm_object_t); 109 int vm_pager_get_pages(vm_object_t, vm_page_t *, int, int *, int *); 110 int vm_pager_get_pages_async(vm_object_t, vm_page_t *, int, int *, int *, 111 pgo_getpages_iodone_t, void *); 112 void vm_pager_init(void); 113 vm_object_t vm_pager_object_lookup(struct pagerlst *, void *); 114 115 static __inline void 116 vm_pager_put_pages( 117 vm_object_t object, 118 vm_page_t *m, 119 int count, 120 int flags, 121 int *rtvals 122 ) { 123 124 VM_OBJECT_ASSERT_WLOCKED(object); 125 (*pagertab[object->type]->pgo_putpages) 126 (object, m, count, flags, rtvals); 127 } 128 129 /* 130 * vm_pager_haspage 131 * 132 * Check to see if an object's pager has the requested page. The 133 * object's pager will also set before and after to give the caller 134 * some idea of the number of pages before and after the requested 135 * page can be I/O'd efficiently. 136 * 137 * The object must be locked. 138 */ 139 static __inline boolean_t 140 vm_pager_has_page( 141 vm_object_t object, 142 vm_pindex_t offset, 143 int *before, 144 int *after 145 ) { 146 boolean_t ret; 147 148 VM_OBJECT_ASSERT_WLOCKED(object); 149 ret = (*pagertab[object->type]->pgo_haspage) 150 (object, offset, before, after); 151 return (ret); 152 } 153 154 /* 155 * vm_pager_page_unswapped 156 * 157 * Destroy swap associated with the page. 158 * 159 * The object containing the page must be locked. 160 * This function may not block. 161 * 162 * XXX: A much better name would be "vm_pager_page_dirtied()" 163 * XXX: It is not obvious if this could be profitably used by any 164 * XXX: pagers besides the swap_pager or if it should even be a 165 * XXX: generic pager_op in the first place. 166 */ 167 static __inline void 168 vm_pager_page_unswapped(vm_page_t m) 169 { 170 171 VM_OBJECT_ASSERT_LOCKED(m->object); 172 if (pagertab[m->object->type]->pgo_pageunswapped) 173 (*pagertab[m->object->type]->pgo_pageunswapped)(m); 174 } 175 176 struct cdev_pager_ops { 177 int (*cdev_pg_fault)(vm_object_t vm_obj, vm_ooffset_t offset, 178 int prot, vm_page_t *mres); 179 int (*cdev_pg_ctor)(void *handle, vm_ooffset_t size, vm_prot_t prot, 180 vm_ooffset_t foff, struct ucred *cred, u_short *color); 181 void (*cdev_pg_dtor)(void *handle); 182 }; 183 184 vm_object_t cdev_pager_allocate(void *handle, enum obj_type tp, 185 struct cdev_pager_ops *ops, vm_ooffset_t size, vm_prot_t prot, 186 vm_ooffset_t foff, struct ucred *cred); 187 vm_object_t cdev_pager_lookup(void *handle); 188 void cdev_pager_free_page(vm_object_t object, vm_page_t m); 189 190 #endif /* _KERNEL */ 191 #endif /* _VM_PAGER_ */ 192