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