uvm_pager.h revision 1.9.4.5 1 /* $NetBSD: uvm_pager.h,v 1.9.4.5 1999/08/09 00:05:56 chs Exp $ */
2
3 /*
4 *
5 * Copyright (c) 1997 Charles D. Cranor and Washington University.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by Charles D. Cranor and
19 * Washington University.
20 * 4. The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 * from: Id: uvm_pager.h,v 1.1.2.14 1998/01/13 19:00:50 chuck Exp
35 */
36
37 #ifndef _UVM_UVM_PAGER_H_
38 #define _UVM_UVM_PAGER_H_
39
40 #include <sys/buf.h>
41
42 /*
43 * uvm_pager.h
44 */
45
46 /*
47 * pager ops
48 */
49
50 struct uvm_pagerops {
51 void (*pgo_init) __P((void));/* init pager */
52 void (*pgo_reference) /* add reference to obj */
53 __P((struct uvm_object *));
54 void (*pgo_detach) /* drop reference to obj */
55 __P((struct uvm_object *));
56 int (*pgo_fault) /* special nonstd fault fn */
57 __P((struct uvm_faultinfo *, vaddr_t,
58 vm_page_t *, int, int, vm_fault_t,
59 vm_prot_t, int));
60 boolean_t (*pgo_flush) /* flush pages out of obj */
61 __P((struct uvm_object *, voff_t, voff_t, int));
62 int (*pgo_get) /* get/read page */
63 __P((struct uvm_object *, voff_t,
64 vm_page_t *, int *, int, vm_prot_t, int, int));
65 int (*pgo_put) /* put/write page */
66 __P((struct uvm_object *, vm_page_t *,
67 int, boolean_t));
68 void (*pgo_cluster) /* return range of cluster */
69 __P((struct uvm_object *, voff_t, voff_t *,
70 voff_t *));
71 struct vm_page ** (*pgo_mk_pcluster) /* make "put" cluster */
72 __P((struct uvm_object *, struct vm_page **,
73 int *, struct vm_page *, int, voff_t,
74 voff_t));
75 void (*pgo_shareprot) /* share protect */
76 __P((vm_map_entry_t, vm_prot_t));
77 void (*pgo_aiodone) /* async iodone */
78 __P((struct uvm_aiodesc *));
79 boolean_t (*pgo_releasepg) /* release page */
80 __P((struct vm_page *, struct vm_page **));
81 };
82
83 /* pager flags [mostly for flush] */
84
85 #define PGO_CLEANIT 0x001 /* write dirty pages to backing store */
86 #define PGO_SYNCIO 0x002 /* if PGO_CLEAN: use sync I/O? */
87 /*
88 * if neither PGO_INVALIDATE or PGO_FREE are set then the pages
89 * stay where they are.
90 */
91 #define PGO_DEACTIVATE 0x004 /* deactivate flushed pages */
92 #define PGO_FREE 0x008 /* free flushed pages */
93
94 #define PGO_ALLPAGES 0x010 /* flush whole object/get all pages */
95 #define PGO_DOACTCLUST 0x020 /* flag to mk_pcluster to include active */
96 #define PGO_LOCKED 0x040 /* fault data structures are locked [get] */
97 #define PGO_PDFREECLUST 0x080 /* daemon's free cluster flag [uvm_pager_put] */
98 #define PGO_REALLOCSWAP 0x100 /* reallocate swap area [pager_dropcluster] */
99 #define PGO_OVERWRITE 0x200 /* page will be overwritten immediately */
100
101 /* page we are not interested in getting */
102 #define PGO_DONTCARE ((struct vm_page *) -1L) /* [get only] */
103
104 #ifdef _KERNEL
105
106 /*
107 * handle inline options
108 */
109
110 #ifdef UVM_PAGER_INLINE
111 #define PAGER_INLINE static __inline
112 #else
113 #define PAGER_INLINE /* nothing */
114 #endif /* UVM_PAGER_INLINE */
115
116 /*
117 * prototypes
118 */
119
120 void uvm_pager_dropcluster __P((struct uvm_object *,
121 struct vm_page *, struct vm_page **,
122 int *, int, int));
123 void uvm_pager_init __P((void));
124 int uvm_pager_put __P((struct uvm_object *, struct vm_page *,
125 struct vm_page ***, int *, int,
126 voff_t, voff_t));
127
128 PAGER_INLINE struct vm_page *uvm_pageratop __P((vaddr_t));
129
130 vaddr_t uvm_pagermapin __P((struct vm_page **, int, int));
131 void uvm_pagermapout __P((vaddr_t, int));
132 struct vm_page **uvm_mk_pcluster __P((struct uvm_object *, struct vm_page **,
133 int *, struct vm_page *, int,
134 voff_t, voff_t));
135 void uvm_shareprot __P((vm_map_entry_t, vm_prot_t));
136 int uvm_errno2vmerror __P((int));
137
138 #endif /* _KERNEL */
139
140 #endif /* _UVM_UVM_PAGER_H_ */
141