160727d8bSWarner Losh /*- 251369649SPedro F. Giffuni * SPDX-License-Identifier: BSD-3-Clause 351369649SPedro F. Giffuni * 4df8bae1dSRodney W. Grimes * Copyright (c) 1990 University of Utah. 5df8bae1dSRodney W. Grimes * Copyright (c) 1991, 1993 6df8bae1dSRodney W. Grimes * The Regents of the University of California. All rights reserved. 7df8bae1dSRodney W. Grimes * 8df8bae1dSRodney W. Grimes * This code is derived from software contributed to Berkeley by 9df8bae1dSRodney W. Grimes * the Systems Programming Group of the University of Utah Computer 10df8bae1dSRodney W. Grimes * Science Department. 11df8bae1dSRodney W. Grimes * 12df8bae1dSRodney W. Grimes * Redistribution and use in source and binary forms, with or without 13df8bae1dSRodney W. Grimes * modification, are permitted provided that the following conditions 14df8bae1dSRodney W. Grimes * are met: 15df8bae1dSRodney W. Grimes * 1. Redistributions of source code must retain the above copyright 16df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer. 17df8bae1dSRodney W. Grimes * 2. Redistributions in binary form must reproduce the above copyright 18df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer in the 19df8bae1dSRodney W. Grimes * documentation and/or other materials provided with the distribution. 20fbbd9655SWarner Losh * 3. Neither the name of the University nor the names of its contributors 21df8bae1dSRodney W. Grimes * may be used to endorse or promote products derived from this software 22df8bae1dSRodney W. Grimes * without specific prior written permission. 23df8bae1dSRodney W. Grimes * 24df8bae1dSRodney W. Grimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25df8bae1dSRodney W. Grimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26df8bae1dSRodney W. Grimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27df8bae1dSRodney W. Grimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28df8bae1dSRodney W. Grimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29df8bae1dSRodney W. Grimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30df8bae1dSRodney W. Grimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31df8bae1dSRodney W. Grimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32df8bae1dSRodney W. Grimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33df8bae1dSRodney W. Grimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34df8bae1dSRodney W. Grimes * SUCH DAMAGE. 35df8bae1dSRodney W. Grimes * 36df8bae1dSRodney W. Grimes * @(#)vm_pager.h 8.4 (Berkeley) 1/12/94 37c3aac50fSPeter Wemm * $FreeBSD$ 38df8bae1dSRodney W. Grimes */ 39df8bae1dSRodney W. Grimes 40df8bae1dSRodney W. Grimes /* 41df8bae1dSRodney W. Grimes * Pager routine interface definition. 42df8bae1dSRodney W. Grimes */ 43df8bae1dSRodney W. Grimes 44df8bae1dSRodney W. Grimes #ifndef _VM_PAGER_ 45df8bae1dSRodney W. Grimes #define _VM_PAGER_ 46df8bae1dSRodney W. Grimes 47e7a58978SBruce Evans #include <sys/queue.h> 48e7a58978SBruce Evans 49e3975643SJake Burkholder TAILQ_HEAD(pagerlst, vm_object); 50df8bae1dSRodney W. Grimes 51d20b2f76SPoul-Henning Kamp typedef void pgo_init_t(void); 523364c323SKonstantin Belousov typedef vm_object_t pgo_alloc_t(void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t, 533364c323SKonstantin Belousov struct ucred *); 54d20b2f76SPoul-Henning Kamp typedef void pgo_dealloc_t(vm_object_t); 55b0cd2017SGleb Smirnoff typedef int pgo_getpages_t(vm_object_t, vm_page_t *, int, int *, int *); 5690effb23SGleb Smirnoff typedef void pgo_getpages_iodone_t(void *, vm_page_t *, int, int); 57b0cd2017SGleb Smirnoff typedef int pgo_getpages_async_t(vm_object_t, vm_page_t *, int, int *, int *, 5890effb23SGleb Smirnoff pgo_getpages_iodone_t, void *); 59d20b2f76SPoul-Henning Kamp typedef void pgo_putpages_t(vm_object_t, vm_page_t *, int, int, int *); 60d20b2f76SPoul-Henning Kamp typedef boolean_t pgo_haspage_t(vm_object_t, vm_pindex_t, int *, int *); 61c42b43a0SKonstantin Belousov typedef int pgo_populate_t(vm_object_t, vm_pindex_t, int, vm_prot_t, 62c42b43a0SKonstantin Belousov vm_pindex_t *, vm_pindex_t *); 63d20b2f76SPoul-Henning Kamp typedef void pgo_pageunswapped_t(vm_page_t); 64fe7bcbafSKyle Evans typedef void pgo_writecount_t(vm_object_t, vm_offset_t, vm_offset_t); 65d20b2f76SPoul-Henning Kamp 66df8bae1dSRodney W. Grimes struct pagerops { 67d20b2f76SPoul-Henning Kamp pgo_init_t *pgo_init; /* Initialize pager. */ 68d20b2f76SPoul-Henning Kamp pgo_alloc_t *pgo_alloc; /* Allocate pager. */ 69d20b2f76SPoul-Henning Kamp pgo_dealloc_t *pgo_dealloc; /* Disassociate. */ 70d20b2f76SPoul-Henning Kamp pgo_getpages_t *pgo_getpages; /* Get (read) page. */ 7190effb23SGleb Smirnoff pgo_getpages_async_t *pgo_getpages_async; /* Get page asyncly. */ 72d20b2f76SPoul-Henning Kamp pgo_putpages_t *pgo_putpages; /* Put (write) page. */ 73e1a44545SGleb Smirnoff pgo_haspage_t *pgo_haspage; /* Query page. */ 74c42b43a0SKonstantin Belousov pgo_populate_t *pgo_populate; /* Bulk spec pagein. */ 75d20b2f76SPoul-Henning Kamp pgo_pageunswapped_t *pgo_pageunswapped; 76fe7bcbafSKyle Evans /* Operations for specialized writecount handling */ 77fe7bcbafSKyle Evans pgo_writecount_t *pgo_update_writecount; 78fe7bcbafSKyle Evans pgo_writecount_t *pgo_release_writecount; 79df8bae1dSRodney W. Grimes }; 80df8bae1dSRodney W. Grimes 81745f3305SPoul-Henning Kamp extern struct pagerops defaultpagerops; 82745f3305SPoul-Henning Kamp extern struct pagerops swappagerops; 83745f3305SPoul-Henning Kamp extern struct pagerops vnodepagerops; 84745f3305SPoul-Henning Kamp extern struct pagerops devicepagerops; 85745f3305SPoul-Henning Kamp extern struct pagerops physpagerops; 8601381811SJohn Baldwin extern struct pagerops sgpagerops; 87b7ac5a85SKonstantin Belousov extern struct pagerops mgtdevicepagerops; 88745f3305SPoul-Henning Kamp 89df8bae1dSRodney W. Grimes /* 90df8bae1dSRodney W. Grimes * get/put return values 91df8bae1dSRodney W. Grimes * OK operation was successful 92df8bae1dSRodney W. Grimes * BAD specified data was out of the accepted range 93df8bae1dSRodney W. Grimes * FAIL specified data was in range, but doesn't exist 94df8bae1dSRodney W. Grimes * PEND operations was initiated but not completed 95df8bae1dSRodney W. Grimes * ERROR error while accessing data that is in range and exists 96df8bae1dSRodney W. Grimes * AGAIN temporary resource shortage prevented operation from happening 97df8bae1dSRodney W. Grimes */ 98df8bae1dSRodney W. Grimes #define VM_PAGER_OK 0 99df8bae1dSRodney W. Grimes #define VM_PAGER_BAD 1 100df8bae1dSRodney W. Grimes #define VM_PAGER_FAIL 2 101df8bae1dSRodney W. Grimes #define VM_PAGER_PEND 3 102df8bae1dSRodney W. Grimes #define VM_PAGER_ERROR 4 103df8bae1dSRodney W. Grimes #define VM_PAGER_AGAIN 5 104df8bae1dSRodney W. Grimes 10543b7990eSMatthew Dillon #define VM_PAGER_PUT_SYNC 0x0001 10643b7990eSMatthew Dillon #define VM_PAGER_PUT_INVAL 0x0002 10799e6e193SMark Johnston #define VM_PAGER_PUT_NOREUSE 0x0004 10843b7990eSMatthew Dillon #define VM_PAGER_CLUSTER_OK 0x0008 1098f9110f6SJohn Dyson 110c4473420SPeter Wemm #ifdef _KERNEL 111a1c995b6SPoul-Henning Kamp 1121c7c3c6aSMatthew Dillon extern struct pagerops *pagertab[]; 1135f518366SJeff Roberson extern struct mtx_padalign pbuf_mtx; 11428f8db14SBruce Evans 115cd853791SKonstantin Belousov /* 116cd853791SKonstantin Belousov * Number of pages that pbuf buffer can store in b_pages. 117cd853791SKonstantin Belousov * It is +1 to allow for unaligned data buffer of maxphys size. 118cd853791SKonstantin Belousov */ 119cd853791SKonstantin Belousov #define PBUF_PAGES (atop(maxphys) + 1) 120cd853791SKonstantin Belousov 1213364c323SKonstantin Belousov vm_object_t vm_pager_allocate(objtype_t, void *, vm_ooffset_t, vm_prot_t, 1223364c323SKonstantin Belousov vm_ooffset_t, struct ucred *); 12311caded3SAlfred Perlstein void vm_pager_bufferinit(void); 12411caded3SAlfred Perlstein void vm_pager_deallocate(vm_object_t); 125b0cd2017SGleb Smirnoff int vm_pager_get_pages(vm_object_t, vm_page_t *, int, int *, int *); 126b0cd2017SGleb Smirnoff int vm_pager_get_pages_async(vm_object_t, vm_page_t *, int, int *, int *, 127093ebe1dSGleb Smirnoff pgo_getpages_iodone_t, void *); 12811caded3SAlfred Perlstein void vm_pager_init(void); 12911caded3SAlfred Perlstein vm_object_t vm_pager_object_lookup(struct pagerlst *, void *); 1301c7c3c6aSMatthew Dillon 131e4542174SMatthew Dillon static __inline void 1321c7c3c6aSMatthew Dillon vm_pager_put_pages( 1331c7c3c6aSMatthew Dillon vm_object_t object, 1341c7c3c6aSMatthew Dillon vm_page_t *m, 1351c7c3c6aSMatthew Dillon int count, 1361c7c3c6aSMatthew Dillon int flags, 1371c7c3c6aSMatthew Dillon int *rtvals 1381c7c3c6aSMatthew Dillon ) { 13989f6b863SAttilio Rao VM_OBJECT_ASSERT_WLOCKED(object); 140e4542174SMatthew Dillon (*pagertab[object->type]->pgo_putpages) 141e4542174SMatthew Dillon (object, m, count, flags, rtvals); 1421c7c3c6aSMatthew Dillon } 1431c7c3c6aSMatthew Dillon 14425db2c54SMatthew Dillon /* 14525db2c54SMatthew Dillon * vm_pager_haspage 14625db2c54SMatthew Dillon * 14725db2c54SMatthew Dillon * Check to see if an object's pager has the requested page. The 14825db2c54SMatthew Dillon * object's pager will also set before and after to give the caller 14925db2c54SMatthew Dillon * some idea of the number of pages before and after the requested 15025db2c54SMatthew Dillon * page can be I/O'd efficiently. 15125db2c54SMatthew Dillon * 152cf51adc0SAlan Cox * The object must be locked. 15325db2c54SMatthew Dillon */ 1541c7c3c6aSMatthew Dillon static __inline boolean_t 1551c7c3c6aSMatthew Dillon vm_pager_has_page( 1561c7c3c6aSMatthew Dillon vm_object_t object, 1571c7c3c6aSMatthew Dillon vm_pindex_t offset, 1581c7c3c6aSMatthew Dillon int *before, 1591c7c3c6aSMatthew Dillon int *after 1601c7c3c6aSMatthew Dillon ) { 16123955314SAlfred Perlstein boolean_t ret; 16223955314SAlfred Perlstein 1634153054aSJeff Roberson VM_OBJECT_ASSERT_LOCKED(object); 16423955314SAlfred Perlstein ret = (*pagertab[object->type]->pgo_haspage) 16523955314SAlfred Perlstein (object, offset, before, after); 16623955314SAlfred Perlstein return (ret); 1671c7c3c6aSMatthew Dillon } 1681c7c3c6aSMatthew Dillon 169c42b43a0SKonstantin Belousov static __inline int 170c42b43a0SKonstantin Belousov vm_pager_populate(vm_object_t object, vm_pindex_t pidx, int fault_type, 171c42b43a0SKonstantin Belousov vm_prot_t max_prot, vm_pindex_t *first, vm_pindex_t *last) 172c42b43a0SKonstantin Belousov { 173c42b43a0SKonstantin Belousov 174c42b43a0SKonstantin Belousov MPASS((object->flags & OBJ_POPULATE) != 0); 175c42b43a0SKonstantin Belousov MPASS(pidx < object->size); 176c99d0c58SMark Johnston MPASS(blockcount_read(&object->paging_in_progress) > 0); 177c42b43a0SKonstantin Belousov return ((*pagertab[object->type]->pgo_populate)(object, pidx, 178c42b43a0SKonstantin Belousov fault_type, max_prot, first, last)); 179c42b43a0SKonstantin Belousov } 180c42b43a0SKonstantin Belousov 1811c7c3c6aSMatthew Dillon /* 1821c7c3c6aSMatthew Dillon * vm_pager_page_unswapped 1831c7c3c6aSMatthew Dillon * 184cf51adc0SAlan Cox * Destroy swap associated with the page. 1851c7c3c6aSMatthew Dillon * 186f976cfd9SPoul-Henning Kamp * XXX: A much better name would be "vm_pager_page_dirtied()" 187f976cfd9SPoul-Henning Kamp * XXX: It is not obvious if this could be profitably used by any 188f976cfd9SPoul-Henning Kamp * XXX: pagers besides the swap_pager or if it should even be a 189f976cfd9SPoul-Henning Kamp * XXX: generic pager_op in the first place. 1901c7c3c6aSMatthew Dillon */ 1911c7c3c6aSMatthew Dillon static __inline void 1921c7c3c6aSMatthew Dillon vm_pager_page_unswapped(vm_page_t m) 1931c7c3c6aSMatthew Dillon { 1942e3b314dSAlan Cox 1951c7c3c6aSMatthew Dillon if (pagertab[m->object->type]->pgo_pageunswapped) 1961c7c3c6aSMatthew Dillon (*pagertab[m->object->type]->pgo_pageunswapped)(m); 1971c7c3c6aSMatthew Dillon } 1981c7c3c6aSMatthew Dillon 199fe7bcbafSKyle Evans static __inline void 200fe7bcbafSKyle Evans vm_pager_update_writecount(vm_object_t object, vm_offset_t start, 201fe7bcbafSKyle Evans vm_offset_t end) 202fe7bcbafSKyle Evans { 203fe7bcbafSKyle Evans 204fe7bcbafSKyle Evans if (pagertab[object->type]->pgo_update_writecount) 205fe7bcbafSKyle Evans pagertab[object->type]->pgo_update_writecount(object, start, 206fe7bcbafSKyle Evans end); 207fe7bcbafSKyle Evans } 208fe7bcbafSKyle Evans 209fe7bcbafSKyle Evans static __inline void 210fe7bcbafSKyle Evans vm_pager_release_writecount(vm_object_t object, vm_offset_t start, 211fe7bcbafSKyle Evans vm_offset_t end) 212fe7bcbafSKyle Evans { 213fe7bcbafSKyle Evans 214fe7bcbafSKyle Evans if (pagertab[object->type]->pgo_release_writecount) 215fe7bcbafSKyle Evans pagertab[object->type]->pgo_release_writecount(object, start, 216fe7bcbafSKyle Evans end); 217fe7bcbafSKyle Evans } 218fe7bcbafSKyle Evans 219286790a7SKonstantin Belousov struct cdev_pager_ops { 220286790a7SKonstantin Belousov int (*cdev_pg_fault)(vm_object_t vm_obj, vm_ooffset_t offset, 221286790a7SKonstantin Belousov int prot, vm_page_t *mres); 222c42b43a0SKonstantin Belousov int (*cdev_pg_populate)(vm_object_t vm_obj, vm_pindex_t pidx, 223c42b43a0SKonstantin Belousov int fault_type, vm_prot_t max_prot, vm_pindex_t *first, 224c42b43a0SKonstantin Belousov vm_pindex_t *last); 225286790a7SKonstantin Belousov int (*cdev_pg_ctor)(void *handle, vm_ooffset_t size, vm_prot_t prot, 226286790a7SKonstantin Belousov vm_ooffset_t foff, struct ucred *cred, u_short *color); 227286790a7SKonstantin Belousov void (*cdev_pg_dtor)(void *handle); 228286790a7SKonstantin Belousov }; 229286790a7SKonstantin Belousov 230286790a7SKonstantin Belousov vm_object_t cdev_pager_allocate(void *handle, enum obj_type tp, 231286790a7SKonstantin Belousov struct cdev_pager_ops *ops, vm_ooffset_t size, vm_prot_t prot, 232286790a7SKonstantin Belousov vm_ooffset_t foff, struct ucred *cred); 233286790a7SKonstantin Belousov vm_object_t cdev_pager_lookup(void *handle); 234286790a7SKonstantin Belousov void cdev_pager_free_page(vm_object_t object, vm_page_t m); 235286790a7SKonstantin Belousov 236a720b31cSKonstantin Belousov struct phys_pager_ops { 237a720b31cSKonstantin Belousov int (*phys_pg_getpages)(vm_object_t vm_obj, vm_page_t *m, int count, 238a720b31cSKonstantin Belousov int *rbehind, int *rahead); 239a720b31cSKonstantin Belousov int (*phys_pg_populate)(vm_object_t vm_obj, vm_pindex_t pidx, 240a720b31cSKonstantin Belousov int fault_type, vm_prot_t max_prot, vm_pindex_t *first, 241a720b31cSKonstantin Belousov vm_pindex_t *last); 242a720b31cSKonstantin Belousov boolean_t (*phys_pg_haspage)(vm_object_t obj, vm_pindex_t pindex, 243a720b31cSKonstantin Belousov int *before, int *after); 244a720b31cSKonstantin Belousov void (*phys_pg_ctor)(vm_object_t vm_obj, vm_prot_t prot, 245a720b31cSKonstantin Belousov vm_ooffset_t foff, struct ucred *cred); 246a720b31cSKonstantin Belousov void (*phys_pg_dtor)(vm_object_t vm_obj); 247a720b31cSKonstantin Belousov }; 248a720b31cSKonstantin Belousov extern struct phys_pager_ops default_phys_pg_ops; 249a720b31cSKonstantin Belousov vm_object_t phys_pager_allocate(void *handle, struct phys_pager_ops *ops, 250a720b31cSKonstantin Belousov void *data, vm_ooffset_t size, vm_prot_t prot, vm_ooffset_t foff, 251a720b31cSKonstantin Belousov struct ucred *cred); 252a720b31cSKonstantin Belousov 253a1287949SEivind Eklund #endif /* _KERNEL */ 254df8bae1dSRodney W. Grimes #endif /* _VM_PAGER_ */ 255