160727d8bSWarner Losh /*- 2df8bae1dSRodney W. Grimes * Copyright (c) 1990 University of Utah. 3df8bae1dSRodney W. Grimes * Copyright (c) 1991, 1993 4df8bae1dSRodney W. Grimes * The Regents of the University of California. All rights reserved. 5df8bae1dSRodney W. Grimes * 6df8bae1dSRodney W. Grimes * This code is derived from software contributed to Berkeley by 7df8bae1dSRodney W. Grimes * the Systems Programming Group of the University of Utah Computer 8df8bae1dSRodney W. Grimes * Science Department. 9df8bae1dSRodney W. Grimes * 10df8bae1dSRodney W. Grimes * Redistribution and use in source and binary forms, with or without 11df8bae1dSRodney W. Grimes * modification, are permitted provided that the following conditions 12df8bae1dSRodney W. Grimes * are met: 13df8bae1dSRodney W. Grimes * 1. Redistributions of source code must retain the above copyright 14df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer. 15df8bae1dSRodney W. Grimes * 2. Redistributions in binary form must reproduce the above copyright 16df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer in the 17df8bae1dSRodney W. Grimes * documentation and/or other materials provided with the distribution. 18df8bae1dSRodney W. Grimes * 4. Neither the name of the University nor the names of its contributors 19df8bae1dSRodney W. Grimes * may be used to endorse or promote products derived from this software 20df8bae1dSRodney W. Grimes * without specific prior written permission. 21df8bae1dSRodney W. Grimes * 22df8bae1dSRodney W. Grimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23df8bae1dSRodney W. Grimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24df8bae1dSRodney W. Grimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25df8bae1dSRodney W. Grimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26df8bae1dSRodney W. Grimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27df8bae1dSRodney W. Grimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28df8bae1dSRodney W. Grimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29df8bae1dSRodney W. Grimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30df8bae1dSRodney W. Grimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31df8bae1dSRodney W. Grimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32df8bae1dSRodney W. Grimes * SUCH DAMAGE. 33df8bae1dSRodney W. Grimes * 34df8bae1dSRodney W. Grimes * @(#)vm_pager.h 8.4 (Berkeley) 1/12/94 35c3aac50fSPeter Wemm * $FreeBSD$ 36df8bae1dSRodney W. Grimes */ 37df8bae1dSRodney W. Grimes 38df8bae1dSRodney W. Grimes /* 39df8bae1dSRodney W. Grimes * Pager routine interface definition. 40df8bae1dSRodney W. Grimes */ 41df8bae1dSRodney W. Grimes 42df8bae1dSRodney W. Grimes #ifndef _VM_PAGER_ 43df8bae1dSRodney W. Grimes #define _VM_PAGER_ 44df8bae1dSRodney W. Grimes 45e7a58978SBruce Evans #include <sys/queue.h> 46e7a58978SBruce Evans 47e3975643SJake Burkholder TAILQ_HEAD(pagerlst, vm_object); 48df8bae1dSRodney W. Grimes 49d20b2f76SPoul-Henning Kamp typedef void pgo_init_t(void); 503364c323SKonstantin Belousov typedef vm_object_t pgo_alloc_t(void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t, 513364c323SKonstantin Belousov struct ucred *); 52d20b2f76SPoul-Henning Kamp typedef void pgo_dealloc_t(vm_object_t); 53d20b2f76SPoul-Henning Kamp typedef int pgo_getpages_t(vm_object_t, vm_page_t *, int, int); 5490effb23SGleb Smirnoff typedef void pgo_getpages_iodone_t(void *, vm_page_t *, int, int); 5590effb23SGleb Smirnoff typedef int pgo_getpages_async_t(vm_object_t, vm_page_t *, int, int, 5690effb23SGleb Smirnoff pgo_getpages_iodone_t, void *); 57d20b2f76SPoul-Henning Kamp typedef void pgo_putpages_t(vm_object_t, vm_page_t *, int, int, int *); 58d20b2f76SPoul-Henning Kamp typedef boolean_t pgo_haspage_t(vm_object_t, vm_pindex_t, int *, int *); 59d20b2f76SPoul-Henning Kamp typedef void pgo_pageunswapped_t(vm_page_t); 60d20b2f76SPoul-Henning Kamp 61df8bae1dSRodney W. Grimes struct pagerops { 62d20b2f76SPoul-Henning Kamp pgo_init_t *pgo_init; /* Initialize pager. */ 63d20b2f76SPoul-Henning Kamp pgo_alloc_t *pgo_alloc; /* Allocate pager. */ 64d20b2f76SPoul-Henning Kamp pgo_dealloc_t *pgo_dealloc; /* Disassociate. */ 65d20b2f76SPoul-Henning Kamp pgo_getpages_t *pgo_getpages; /* Get (read) page. */ 6690effb23SGleb Smirnoff pgo_getpages_async_t *pgo_getpages_async; /* Get page asyncly. */ 67d20b2f76SPoul-Henning Kamp pgo_putpages_t *pgo_putpages; /* Put (write) page. */ 68e1a44545SGleb Smirnoff pgo_haspage_t *pgo_haspage; /* Query page. */ 69d20b2f76SPoul-Henning Kamp pgo_pageunswapped_t *pgo_pageunswapped; 70df8bae1dSRodney W. Grimes }; 71df8bae1dSRodney W. Grimes 72745f3305SPoul-Henning Kamp extern struct pagerops defaultpagerops; 73745f3305SPoul-Henning Kamp extern struct pagerops swappagerops; 74745f3305SPoul-Henning Kamp extern struct pagerops vnodepagerops; 75745f3305SPoul-Henning Kamp extern struct pagerops devicepagerops; 76745f3305SPoul-Henning Kamp extern struct pagerops physpagerops; 7701381811SJohn Baldwin extern struct pagerops sgpagerops; 78b7ac5a85SKonstantin Belousov extern struct pagerops mgtdevicepagerops; 79745f3305SPoul-Henning Kamp 80df8bae1dSRodney W. Grimes /* 81df8bae1dSRodney W. Grimes * get/put return values 82df8bae1dSRodney W. Grimes * OK operation was successful 83df8bae1dSRodney W. Grimes * BAD specified data was out of the accepted range 84df8bae1dSRodney W. Grimes * FAIL specified data was in range, but doesn't exist 85df8bae1dSRodney W. Grimes * PEND operations was initiated but not completed 86df8bae1dSRodney W. Grimes * ERROR error while accessing data that is in range and exists 87df8bae1dSRodney W. Grimes * AGAIN temporary resource shortage prevented operation from happening 88df8bae1dSRodney W. Grimes */ 89df8bae1dSRodney W. Grimes #define VM_PAGER_OK 0 90df8bae1dSRodney W. Grimes #define VM_PAGER_BAD 1 91df8bae1dSRodney W. Grimes #define VM_PAGER_FAIL 2 92df8bae1dSRodney W. Grimes #define VM_PAGER_PEND 3 93df8bae1dSRodney W. Grimes #define VM_PAGER_ERROR 4 94df8bae1dSRodney W. Grimes #define VM_PAGER_AGAIN 5 95df8bae1dSRodney W. Grimes 9643b7990eSMatthew Dillon #define VM_PAGER_PUT_SYNC 0x0001 9743b7990eSMatthew Dillon #define VM_PAGER_PUT_INVAL 0x0002 9843b7990eSMatthew Dillon #define VM_PAGER_CLUSTER_OK 0x0008 998f9110f6SJohn Dyson 100c4473420SPeter Wemm #ifdef _KERNEL 101a1c995b6SPoul-Henning Kamp 1021c7c3c6aSMatthew Dillon extern struct pagerops *pagertab[]; 1035f518366SJeff Roberson extern struct mtx_padalign pbuf_mtx; 10428f8db14SBruce Evans 1053364c323SKonstantin Belousov vm_object_t vm_pager_allocate(objtype_t, void *, vm_ooffset_t, vm_prot_t, 1063364c323SKonstantin Belousov vm_ooffset_t, struct ucred *); 10711caded3SAlfred Perlstein void vm_pager_bufferinit(void); 10811caded3SAlfred Perlstein void vm_pager_deallocate(vm_object_t); 109093ebe1dSGleb Smirnoff int vm_pager_get_pages(vm_object_t, vm_page_t *, int, int); 110093ebe1dSGleb Smirnoff int vm_pager_get_pages_async(vm_object_t, vm_page_t *, int, int, 111093ebe1dSGleb Smirnoff pgo_getpages_iodone_t, void *); 11211caded3SAlfred Perlstein static __inline boolean_t vm_pager_has_page(vm_object_t, vm_pindex_t, int *, int *); 11311caded3SAlfred Perlstein void vm_pager_init(void); 11411caded3SAlfred Perlstein vm_object_t vm_pager_object_lookup(struct pagerlst *, void *); 115396b3e34SAlan Cox void vm_pager_free_nonreq(vm_object_t object, vm_page_t ma[], int reqpage, 1164d6481a4SGleb Smirnoff int npages, boolean_t object_locked); 1171c7c3c6aSMatthew Dillon 118e4542174SMatthew Dillon static __inline void 1191c7c3c6aSMatthew Dillon vm_pager_put_pages( 1201c7c3c6aSMatthew Dillon vm_object_t object, 1211c7c3c6aSMatthew Dillon vm_page_t *m, 1221c7c3c6aSMatthew Dillon int count, 1231c7c3c6aSMatthew Dillon int flags, 1241c7c3c6aSMatthew Dillon int *rtvals 1251c7c3c6aSMatthew Dillon ) { 1262e3b314dSAlan Cox 12789f6b863SAttilio Rao VM_OBJECT_ASSERT_WLOCKED(object); 128e4542174SMatthew Dillon (*pagertab[object->type]->pgo_putpages) 129e4542174SMatthew Dillon (object, m, count, flags, rtvals); 1301c7c3c6aSMatthew Dillon } 1311c7c3c6aSMatthew Dillon 13225db2c54SMatthew Dillon /* 13325db2c54SMatthew Dillon * vm_pager_haspage 13425db2c54SMatthew Dillon * 13525db2c54SMatthew Dillon * Check to see if an object's pager has the requested page. The 13625db2c54SMatthew Dillon * object's pager will also set before and after to give the caller 13725db2c54SMatthew Dillon * some idea of the number of pages before and after the requested 13825db2c54SMatthew Dillon * page can be I/O'd efficiently. 13925db2c54SMatthew Dillon * 140cf51adc0SAlan Cox * The object must be locked. 14125db2c54SMatthew Dillon */ 1421c7c3c6aSMatthew Dillon static __inline boolean_t 1431c7c3c6aSMatthew Dillon vm_pager_has_page( 1441c7c3c6aSMatthew Dillon vm_object_t object, 1451c7c3c6aSMatthew Dillon vm_pindex_t offset, 1461c7c3c6aSMatthew Dillon int *before, 1471c7c3c6aSMatthew Dillon int *after 1481c7c3c6aSMatthew Dillon ) { 14923955314SAlfred Perlstein boolean_t ret; 15023955314SAlfred Perlstein 15189f6b863SAttilio Rao VM_OBJECT_ASSERT_WLOCKED(object); 15223955314SAlfred Perlstein ret = (*pagertab[object->type]->pgo_haspage) 15323955314SAlfred Perlstein (object, offset, before, after); 15423955314SAlfred Perlstein return (ret); 1551c7c3c6aSMatthew Dillon } 1561c7c3c6aSMatthew Dillon 1571c7c3c6aSMatthew Dillon /* 1581c7c3c6aSMatthew Dillon * vm_pager_page_unswapped 1591c7c3c6aSMatthew Dillon * 160cf51adc0SAlan Cox * Destroy swap associated with the page. 1611c7c3c6aSMatthew Dillon * 162cf51adc0SAlan Cox * The object containing the page must be locked. 1631c7c3c6aSMatthew Dillon * This function may not block. 164f976cfd9SPoul-Henning Kamp * 165f976cfd9SPoul-Henning Kamp * XXX: A much better name would be "vm_pager_page_dirtied()" 166f976cfd9SPoul-Henning Kamp * XXX: It is not obvious if this could be profitably used by any 167f976cfd9SPoul-Henning Kamp * XXX: pagers besides the swap_pager or if it should even be a 168f976cfd9SPoul-Henning Kamp * XXX: generic pager_op in the first place. 1691c7c3c6aSMatthew Dillon */ 1701c7c3c6aSMatthew Dillon static __inline void 1711c7c3c6aSMatthew Dillon vm_pager_page_unswapped(vm_page_t m) 1721c7c3c6aSMatthew Dillon { 1732e3b314dSAlan Cox 174385b4265SKonstantin Belousov VM_OBJECT_ASSERT_LOCKED(m->object); 1751c7c3c6aSMatthew Dillon if (pagertab[m->object->type]->pgo_pageunswapped) 1761c7c3c6aSMatthew Dillon (*pagertab[m->object->type]->pgo_pageunswapped)(m); 1771c7c3c6aSMatthew Dillon } 1781c7c3c6aSMatthew Dillon 179286790a7SKonstantin Belousov struct cdev_pager_ops { 180286790a7SKonstantin Belousov int (*cdev_pg_fault)(vm_object_t vm_obj, vm_ooffset_t offset, 181286790a7SKonstantin Belousov int prot, vm_page_t *mres); 182286790a7SKonstantin Belousov int (*cdev_pg_ctor)(void *handle, vm_ooffset_t size, vm_prot_t prot, 183286790a7SKonstantin Belousov vm_ooffset_t foff, struct ucred *cred, u_short *color); 184286790a7SKonstantin Belousov void (*cdev_pg_dtor)(void *handle); 185286790a7SKonstantin Belousov }; 186286790a7SKonstantin Belousov 187286790a7SKonstantin Belousov vm_object_t cdev_pager_allocate(void *handle, enum obj_type tp, 188286790a7SKonstantin Belousov struct cdev_pager_ops *ops, vm_ooffset_t size, vm_prot_t prot, 189286790a7SKonstantin Belousov vm_ooffset_t foff, struct ucred *cred); 190286790a7SKonstantin Belousov vm_object_t cdev_pager_lookup(void *handle); 191286790a7SKonstantin Belousov void cdev_pager_free_page(vm_object_t object, vm_page_t m); 192286790a7SKonstantin Belousov 193a1287949SEivind Eklund #endif /* _KERNEL */ 194df8bae1dSRodney W. Grimes #endif /* _VM_PAGER_ */ 195