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 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the University of 21 * California, Berkeley and its contributors. 22 * 4. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * @(#)vm_pager.h 8.4 (Berkeley) 1/12/94 39 * $FreeBSD: src/sys/vm/vm_pager.h,v 1.24.2.2 2002/12/31 09:34:51 dillon Exp $ 40 * $DragonFly: src/sys/vm/vm_pager.h,v 1.6 2006/02/17 19:18:08 dillon Exp $ 41 */ 42 43 /* 44 * Pager routine interface definition. 45 */ 46 47 #ifndef _VM_PAGER_ 48 #define _VM_PAGER_ 49 50 #include <sys/queue.h> 51 52 TAILQ_HEAD(pagerlst, vm_object); 53 54 struct buf; 55 struct bio; 56 57 struct pagerops { 58 void (*pgo_init) (void); /* Initialize pager. */ 59 vm_object_t (*pgo_alloc) (void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t); /* Allocate pager. */ 60 void (*pgo_dealloc) (vm_object_t); /* Disassociate. */ 61 int (*pgo_getpages) (vm_object_t, vm_page_t *, int, int); /* Get (read) page. */ 62 void (*pgo_putpages) (vm_object_t, vm_page_t *, int, int, int *); /* Put (write) page. */ 63 boolean_t (*pgo_haspage) (vm_object_t, vm_pindex_t, int *, int *); /* Does pager have page? */ 64 void (*pgo_pageunswapped) (vm_page_t); 65 void (*pgo_strategy) (vm_object_t, struct bio *); 66 }; 67 68 /* 69 * get/put return values 70 * OK operation was successful 71 * BAD specified data was out of the accepted range 72 * FAIL specified data was in range, but doesn't exist 73 * PEND operations was initiated but not completed 74 * ERROR error while accessing data that is in range and exists 75 * AGAIN temporary resource shortage prevented operation from happening 76 */ 77 #define VM_PAGER_OK 0 78 #define VM_PAGER_BAD 1 79 #define VM_PAGER_FAIL 2 80 #define VM_PAGER_PEND 3 81 #define VM_PAGER_ERROR 4 82 #define VM_PAGER_AGAIN 5 83 84 #define VM_PAGER_PUT_SYNC 0x0001 85 #define VM_PAGER_PUT_INVAL 0x0002 86 #define VM_PAGER_IGNORE_CLEANCHK 0x0004 87 #define VM_PAGER_CLUSTER_OK 0x0008 88 89 #ifdef _KERNEL 90 91 #ifdef MALLOC_DECLARE 92 MALLOC_DECLARE(M_VMPGDATA); 93 #endif 94 95 struct vnode; 96 97 extern vm_map_t pager_map; 98 extern int pager_map_size; 99 extern struct pagerops *pagertab[]; 100 101 vm_object_t vm_pager_allocate (objtype_t, void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t); 102 void vm_pager_bufferinit (void); 103 void vm_pager_deallocate (vm_object_t); 104 static __inline int vm_pager_get_pages (vm_object_t, vm_page_t *, int, int); 105 static __inline boolean_t vm_pager_has_page (vm_object_t, vm_pindex_t, int *, int *); 106 void vm_pager_init (void); 107 vm_object_t vm_pager_object_lookup (struct pagerlst *, void *); 108 void vm_pager_sync (void); 109 void vm_pager_strategy (vm_object_t object, struct bio *bio); 110 struct buf *getchainbuf(struct buf *bp, struct vnode *vp, int flags); 111 void flushchainbuf(struct buf *nbp); 112 void waitchainbuf(struct buf *bp, int count, int done); 113 void autochaindone(struct buf *bp); 114 115 /* 116 * vm_page_get_pages: 117 * 118 * Retrieve pages from the VM system in order to map them into an object 119 * ( or into VM space somewhere ). If the pagein was successful, we 120 * must fully validate it. 121 */ 122 123 static __inline int 124 vm_pager_get_pages( 125 vm_object_t object, 126 vm_page_t *m, 127 int count, 128 int reqpage 129 ) { 130 int r; 131 132 r = (*pagertab[object->type]->pgo_getpages)(object, m, count, reqpage); 133 if (r == VM_PAGER_OK && m[reqpage]->valid != VM_PAGE_BITS_ALL) { 134 vm_page_zero_invalid(m[reqpage], TRUE); 135 } 136 return(r); 137 } 138 139 static __inline void 140 vm_pager_put_pages( 141 vm_object_t object, 142 vm_page_t *m, 143 int count, 144 int flags, 145 int *rtvals 146 ) { 147 (*pagertab[object->type]->pgo_putpages) 148 (object, m, count, flags, rtvals); 149 } 150 151 /* 152 * vm_pager_haspage 153 * 154 * Check to see if an object's pager has the requested page. The 155 * object's pager will also set before and after to give the caller 156 * some idea of the number of pages before and after the requested 157 * page can be I/O'd efficiently. 158 * 159 * This routine does not have to be called at any particular spl. 160 */ 161 162 static __inline boolean_t 163 vm_pager_has_page( 164 vm_object_t object, 165 vm_pindex_t offset, 166 int *before, 167 int *after 168 ) { 169 return ((*pagertab[object->type]->pgo_haspage) (object, offset, before, after)); 170 } 171 172 /* 173 * vm_pager_page_unswapped 174 * 175 * called at splvm() to destroy swap associated with the page. 176 * 177 * This function may not block. 178 */ 179 180 static __inline void 181 vm_pager_page_unswapped(vm_page_t m) 182 { 183 if (pagertab[m->object->type]->pgo_pageunswapped) 184 (*pagertab[m->object->type]->pgo_pageunswapped)(m); 185 } 186 187 #endif 188 189 #endif /* _VM_PAGER_ */ 190