uvm_pager.h revision 1.22 1 /* $NetBSD: uvm_pager.h,v 1.22 2001/05/25 04:06:16 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 /*
38 * Copyright (c) 1990 University of Utah.
39 * Copyright (c) 1991, 1993
40 * The Regents of the University of California. All rights reserved.
41 *
42 * This code is derived from software contributed to Berkeley by
43 * the Systems Programming Group of the University of Utah Computer
44 * Science Department.
45 *
46 * Redistribution and use in source and binary forms, with or without
47 * modification, are permitted provided that the following conditions
48 * are met:
49 * 1. Redistributions of source code must retain the above copyright
50 * notice, this list of conditions and the following disclaimer.
51 * 2. Redistributions in binary form must reproduce the above copyright
52 * notice, this list of conditions and the following disclaimer in the
53 * documentation and/or other materials provided with the distribution.
54 * 3. All advertising materials mentioning features or use of this software
55 * must display the following acknowledgement:
56 * This product includes software developed by the University of
57 * California, Berkeley and its contributors.
58 * 4. Neither the name of the University nor the names of its contributors
59 * may be used to endorse or promote products derived from this software
60 * without specific prior written permission.
61 *
62 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
63 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
64 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
65 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
66 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
67 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
68 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
69 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
70 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
71 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
72 * SUCH DAMAGE.
73 *
74 * @(#)vm_pager.h 8.5 (Berkeley) 7/7/94
75 */
76
77 #ifndef _UVM_UVM_PAGER_H_
78 #define _UVM_UVM_PAGER_H_
79
80 /*
81 * uvm_pager.h
82 */
83
84 /*
85 * pager ops
86 */
87
88 struct uvm_pagerops {
89 void (*pgo_init) __P((void));/* init pager */
90 void (*pgo_reference) /* add reference to obj */
91 __P((struct uvm_object *));
92 void (*pgo_detach) /* drop reference to obj */
93 __P((struct uvm_object *));
94 int (*pgo_fault) /* special nonstd fault fn */
95 __P((struct uvm_faultinfo *, vaddr_t,
96 vm_page_t *, int, int, vm_fault_t,
97 vm_prot_t, int));
98 boolean_t (*pgo_flush) /* flush pages out of obj */
99 __P((struct uvm_object *, voff_t, voff_t, int));
100 int (*pgo_get) /* get/read page */
101 __P((struct uvm_object *, voff_t,
102 vm_page_t *, int *, int, vm_prot_t, int, int));
103 int (*pgo_put) /* put/write page */
104 __P((struct uvm_object *, vm_page_t *,
105 int, boolean_t));
106 void (*pgo_cluster) /* return range of cluster */
107 __P((struct uvm_object *, voff_t, voff_t *,
108 voff_t *));
109 struct vm_page ** (*pgo_mk_pcluster) /* make "put" cluster */
110 __P((struct uvm_object *, struct vm_page **,
111 int *, struct vm_page *, int, voff_t,
112 voff_t));
113 boolean_t (*pgo_releasepg) /* release page */
114 __P((struct vm_page *, struct vm_page **));
115 };
116
117 /* pager flags [mostly for flush] */
118
119 #define PGO_CLEANIT 0x001 /* write dirty pages to backing store */
120 #define PGO_SYNCIO 0x002 /* if PGO_CLEANIT: use sync I/O? */
121 #define PGO_DEACTIVATE 0x004 /* deactivate flushed pages */
122 #define PGO_FREE 0x008 /* free flushed pages */
123 /* if PGO_FREE is not set then the pages stay where they are. */
124
125 #define PGO_ALLPAGES 0x010 /* flush whole object/get all pages */
126 #define PGO_DOACTCLUST 0x020 /* flag to mk_pcluster to include active */
127 #define PGO_LOCKED 0x040 /* fault data structures are locked [get] */
128 #define PGO_PDFREECLUST 0x080 /* daemon's free cluster flag [uvm_pager_put] */
129 #define PGO_REALLOCSWAP 0x100 /* reallocate swap area [pager_dropcluster] */
130 #define PGO_OVERWRITE 0x200 /* pages will be overwritten before unlocked */
131 #define PGO_WEAK 0x400 /* "weak" put, for nfs */
132 #define PGO_PASTEOF 0x800 /* allow allocation of pages past EOF */
133
134 /* page we are not interested in getting */
135 #define PGO_DONTCARE ((struct vm_page *) -1L) /* [get only] */
136
137 #ifdef _KERNEL
138
139 /*
140 * handle inline options
141 */
142
143 #ifdef UVM_PAGER_INLINE
144 #define PAGER_INLINE static __inline
145 #else
146 #define PAGER_INLINE /* nothing */
147 #endif /* UVM_PAGER_INLINE */
148
149 /*
150 * prototypes
151 */
152
153 void uvm_pager_dropcluster __P((struct uvm_object *,
154 struct vm_page *, struct vm_page **,
155 int *, int));
156 void uvm_pager_init __P((void));
157 int uvm_pager_put __P((struct uvm_object *, struct vm_page *,
158 struct vm_page ***, int *, int,
159 voff_t, voff_t));
160
161 PAGER_INLINE struct vm_page *uvm_pageratop __P((vaddr_t));
162
163 vaddr_t uvm_pagermapin __P((struct vm_page **, int, int));
164 void uvm_pagermapout __P((vaddr_t, int));
165 struct vm_page **uvm_mk_pcluster __P((struct uvm_object *, struct vm_page **,
166 int *, struct vm_page *, int,
167 voff_t, voff_t));
168
169 /* Flags to uvm_pagermapin() */
170 #define UVMPAGER_MAPIN_WAITOK 0x01 /* it's okay to wait */
171 #define UVMPAGER_MAPIN_READ 0x02 /* host <- device */
172 #define UVMPAGER_MAPIN_WRITE 0x00 /* device -> host (pseudo flag) */
173
174 /*
175 * XXX
176 * this is needed until the device strategy interface
177 * is changed to do physically-addressed i/o.
178 */
179
180 #ifndef PAGER_MAP_SIZE
181 #define PAGER_MAP_SIZE (16 * 1024 * 1024)
182 #endif
183
184 #endif /* _KERNEL */
185
186 #endif /* _UVM_UVM_PAGER_H_ */
187