xref: /freebsd/sys/vm/device_pager.c (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
1 /*
2  * Copyright (c) 1990 University of Utah.
3  * Copyright (c) 1991, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * the Systems Programming Group of the University of Utah Computer
8  * Science Department.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)device_pager.c	8.1 (Berkeley) 6/11/93
39  * $Id: device_pager.c,v 1.5 1995/01/09 16:05:29 davidg Exp $
40  */
41 
42 /*
43  * Page to/from special files.
44  */
45 
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/conf.h>
49 #include <sys/mman.h>
50 #include <sys/malloc.h>
51 #include <sys/proc.h>
52 
53 #include <vm/vm.h>
54 #include <vm/vm_kern.h>
55 #include <vm/vm_page.h>
56 #include <vm/device_pager.h>
57 
58 struct pagerlst dev_pager_list;	/* list of managed devices */
59 struct pglist dev_pager_fakelist;	/* list of available vm_page_t's */
60 
61 #ifdef DEBUG
62 int dpagerdebug = 0;
63 
64 #define	DDB_FOLLOW	0x01
65 #define DDB_INIT	0x02
66 #define DDB_ALLOC	0x04
67 #define DDB_FAIL	0x08
68 #endif
69 
70 static vm_pager_t dev_pager_alloc __P((caddr_t, vm_size_t, vm_prot_t, vm_offset_t));
71 static void dev_pager_dealloc __P((vm_pager_t));
72 static int dev_pager_getpage __P((vm_pager_t, vm_page_t, boolean_t));
73 static boolean_t dev_pager_haspage __P((vm_pager_t, vm_offset_t));
74 static void dev_pager_init __P((void));
75 static int dev_pager_putpage __P((vm_pager_t, vm_page_t, boolean_t));
76 static vm_page_t dev_pager_getfake __P((vm_offset_t));
77 static void dev_pager_putfake __P((vm_page_t));
78 
79 struct pagerops devicepagerops = {
80 	dev_pager_init,
81 	dev_pager_alloc,
82 	dev_pager_dealloc,
83 	dev_pager_getpage,
84 	0,
85 	dev_pager_putpage,
86 	0,
87 	dev_pager_haspage
88 };
89 
90 static void
91 dev_pager_init()
92 {
93 #ifdef DEBUG
94 	if (dpagerdebug & DDB_FOLLOW)
95 		printf("dev_pager_init()\n");
96 #endif
97 	TAILQ_INIT(&dev_pager_list);
98 	TAILQ_INIT(&dev_pager_fakelist);
99 }
100 
101 static vm_pager_t
102 dev_pager_alloc(handle, size, prot, foff)
103 	caddr_t handle;
104 	vm_size_t size;
105 	vm_prot_t prot;
106 	vm_offset_t foff;
107 {
108 	dev_t dev;
109 	vm_pager_t pager;
110 	int (*mapfunc) ();
111 	vm_object_t object;
112 	dev_pager_t devp;
113 	unsigned int npages, off;
114 
115 #ifdef DEBUG
116 	if (dpagerdebug & DDB_FOLLOW)
117 		printf("dev_pager_alloc(%x, %x, %x, %x)\n",
118 		    handle, size, prot, foff);
119 #endif
120 #ifdef DIAGNOSTIC
121 	/*
122 	 * Pageout to device, should never happen.
123 	 */
124 	if (handle == NULL)
125 		panic("dev_pager_alloc called");
126 #endif
127 
128 	/*
129 	 * Make sure this device can be mapped.
130 	 */
131 	dev = (dev_t) (u_long) handle;
132 	mapfunc = cdevsw[major(dev)].d_mmap;
133 	if (mapfunc == NULL || mapfunc == enodev || mapfunc == nullop)
134 		return (NULL);
135 
136 	/*
137 	 * Offset should be page aligned.
138 	 */
139 	if (foff & (PAGE_SIZE - 1))
140 		return (NULL);
141 
142 	/*
143 	 * Check that the specified range of the device allows the desired
144 	 * protection.
145 	 *
146 	 * XXX assumes VM_PROT_* == PROT_*
147 	 */
148 	npages = atop(round_page(size));
149 	for (off = foff; npages--; off += PAGE_SIZE)
150 		if ((*mapfunc) (dev, off, (int) prot) == -1)
151 			return (NULL);
152 
153 	/*
154 	 * Look up pager, creating as necessary.
155 	 */
156 top:
157 	pager = vm_pager_lookup(&dev_pager_list, handle);
158 	if (pager == NULL) {
159 		/*
160 		 * Allocate and initialize pager structs
161 		 */
162 		pager = (vm_pager_t) malloc(sizeof *pager, M_VMPAGER, M_WAITOK);
163 		if (pager == NULL)
164 			return (NULL);
165 		devp = (dev_pager_t) malloc(sizeof *devp, M_VMPGDATA, M_WAITOK);
166 		if (devp == NULL) {
167 			free((caddr_t) pager, M_VMPAGER);
168 			return (NULL);
169 		}
170 		pager->pg_handle = handle;
171 		pager->pg_ops = &devicepagerops;
172 		pager->pg_type = PG_DEVICE;
173 		pager->pg_data = (caddr_t) devp;
174 		TAILQ_INIT(&devp->devp_pglist);
175 		/*
176 		 * Allocate object and associate it with the pager.
177 		 */
178 		object = devp->devp_object = vm_object_allocate(0);
179 		vm_object_enter(object, pager);
180 		object->pager = pager;
181 		/*
182 		 * Finally, put it on the managed list so other can find it.
183 		 * First we re-lookup in case someone else beat us to this
184 		 * point (due to blocking in the various mallocs).  If so, we
185 		 * free everything and start over.
186 		 */
187 		if (vm_pager_lookup(&dev_pager_list, handle)) {
188 			free((caddr_t) devp, M_VMPGDATA);
189 			free((caddr_t) pager, M_VMPAGER);
190 			goto top;
191 		}
192 		TAILQ_INSERT_TAIL(&dev_pager_list, pager, pg_list);
193 #ifdef DEBUG
194 		if (dpagerdebug & DDB_ALLOC) {
195 			printf("dev_pager_alloc: pager %x devp %x object %x\n",
196 			    pager, devp, object);
197 			vm_object_print(object, FALSE);
198 		}
199 #endif
200 	} else {
201 		/*
202 		 * Gain a reference to the object.
203 		 */
204 		object = vm_object_lookup(pager);
205 #ifdef DIAGNOSTIC
206 		devp = (dev_pager_t) pager->pg_data;
207 		if (object != devp->devp_object)
208 			panic("dev_pager_setup: bad object");
209 #endif
210 	}
211 	return (pager);
212 }
213 
214 static void
215 dev_pager_dealloc(pager)
216 	vm_pager_t pager;
217 {
218 	dev_pager_t devp;
219 	vm_object_t object;
220 	vm_page_t m;
221 
222 #ifdef DEBUG
223 	if (dpagerdebug & DDB_FOLLOW)
224 		printf("dev_pager_dealloc(%x)\n", pager);
225 #endif
226 	TAILQ_REMOVE(&dev_pager_list, pager, pg_list);
227 	/*
228 	 * Get the object. Note: cannot use vm_object_lookup since object has
229 	 * already been removed from the hash chain.
230 	 */
231 	devp = (dev_pager_t) pager->pg_data;
232 	object = devp->devp_object;
233 #ifdef DEBUG
234 	if (dpagerdebug & DDB_ALLOC)
235 		printf("dev_pager_dealloc: devp %x object %x\n", devp, object);
236 #endif
237 	/*
238 	 * Free up our fake pages.
239 	 */
240 	while ((m = devp->devp_pglist.tqh_first) != 0) {
241 		TAILQ_REMOVE(&devp->devp_pglist, m, pageq);
242 		dev_pager_putfake(m);
243 	}
244 	free((caddr_t) devp, M_VMPGDATA);
245 	free((caddr_t) pager, M_VMPAGER);
246 }
247 
248 static int
249 dev_pager_getpage(pager, m, sync)
250 	vm_pager_t pager;
251 	vm_page_t m;
252 	boolean_t sync;
253 {
254 	register vm_object_t object;
255 	vm_offset_t offset, paddr;
256 	vm_page_t page;
257 	dev_t dev;
258 	int s;
259 	int (*mapfunc) (), prot;
260 
261 #ifdef DEBUG
262 	if (dpagerdebug & DDB_FOLLOW)
263 		printf("dev_pager_getpage(%x, %x)\n", pager, m);
264 #endif
265 
266 	object = m->object;
267 	dev = (dev_t) (u_long) pager->pg_handle;
268 	offset = m->offset + object->paging_offset;
269 	prot = PROT_READ;	/* XXX should pass in? */
270 	mapfunc = cdevsw[major(dev)].d_mmap;
271 
272 	if (mapfunc == NULL || mapfunc == enodev || mapfunc == nullop)
273 		panic("dev_pager_getpage: no map function");
274 
275 	paddr = pmap_phys_address((*mapfunc) ((dev_t) dev, (int) offset, prot));
276 #ifdef DIAGNOSTIC
277 	if (paddr == -1)
278 		panic("dev_pager_getpage: map function returns error");
279 #endif
280 	/*
281 	 * Replace the passed in page with our own fake page and free up the
282 	 * original.
283 	 */
284 	page = dev_pager_getfake(paddr);
285 	TAILQ_INSERT_TAIL(&((dev_pager_t) pager->pg_data)->devp_pglist,
286 	    page, pageq);
287 	vm_object_lock(object);
288 	vm_page_lock_queues();
289 	PAGE_WAKEUP(m);
290 	vm_page_free(m);
291 	vm_page_unlock_queues();
292 	s = splhigh();
293 	vm_page_insert(page, object, offset);
294 	splx(s);
295 	if (offset + PAGE_SIZE > object->size)
296 		object->size = offset + PAGE_SIZE;	/* XXX anal */
297 	vm_object_unlock(object);
298 
299 	return (VM_PAGER_OK);
300 }
301 
302 static int
303 dev_pager_putpage(pager, m, sync)
304 	vm_pager_t pager;
305 	vm_page_t m;
306 	boolean_t sync;
307 {
308 #ifdef DEBUG
309 	if (dpagerdebug & DDB_FOLLOW)
310 		printf("dev_pager_putpage(%x, %x)\n", pager, m);
311 #endif
312 	if (pager == NULL)
313 		return 0;
314 	panic("dev_pager_putpage called");
315 }
316 
317 static boolean_t
318 dev_pager_haspage(pager, offset)
319 	vm_pager_t pager;
320 	vm_offset_t offset;
321 {
322 #ifdef DEBUG
323 	if (dpagerdebug & DDB_FOLLOW)
324 		printf("dev_pager_haspage(%x, %x)\n", pager, offset);
325 #endif
326 	return (TRUE);
327 }
328 
329 static vm_page_t
330 dev_pager_getfake(paddr)
331 	vm_offset_t paddr;
332 {
333 	vm_page_t m;
334 	int i;
335 
336 	if (dev_pager_fakelist.tqh_first == NULL) {
337 		m = (vm_page_t) malloc(PAGE_SIZE * 2, M_VMPGDATA, M_WAITOK);
338 		for (i = (PAGE_SIZE * 2) / sizeof(*m); i > 0; i--) {
339 			TAILQ_INSERT_TAIL(&dev_pager_fakelist, m, pageq);
340 			m++;
341 		}
342 	}
343 	m = dev_pager_fakelist.tqh_first;
344 	TAILQ_REMOVE(&dev_pager_fakelist, m, pageq);
345 
346 	m->flags = PG_BUSY | PG_FICTITIOUS;
347 	m->dirty = 0;
348 	m->valid = VM_PAGE_BITS_ALL;
349 	m->busy = 0;
350 	m->bmapped = 0;
351 
352 	m->wire_count = 1;
353 	m->phys_addr = paddr;
354 
355 	return (m);
356 }
357 
358 static void
359 dev_pager_putfake(m)
360 	vm_page_t m;
361 {
362 #ifdef DIAGNOSTIC
363 	if (!(m->flags & PG_FICTITIOUS))
364 		panic("dev_pager_putfake: bad page");
365 #endif
366 	TAILQ_INSERT_TAIL(&dev_pager_fakelist, m, pageq);
367 }
368