2 * Copyright (c) 1990 University of Utah.
3 * Copyright (c) 1991, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * the Systems Programming Group of the University of Utah Computer
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)device_pager.c 8.1 (Berkeley) 6/11/93
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
41 #include <sys/systm.h>
45 #include <sys/mutex.h>
50 #include <vm/vm_param.h>
51 #include <vm/vm_object.h>
52 #include <vm/vm_page.h>
53 #include <vm/vm_pager.h>
56 static void dev_pager_init(void);
57 static vm_object_t dev_pager_alloc(void *, vm_ooffset_t, vm_prot_t,
58 vm_ooffset_t, struct ucred *);
59 static void dev_pager_dealloc(vm_object_t);
60 static int dev_pager_getpages(vm_object_t, vm_page_t *, int, int);
61 static void dev_pager_putpages(vm_object_t, vm_page_t *, int,
63 static boolean_t dev_pager_haspage(vm_object_t, vm_pindex_t, int *,
65 static void dev_pager_free_page(vm_object_t object, vm_page_t m);
67 /* list of device pager objects */
68 static struct pagerlst dev_pager_object_list;
69 /* protect list manipulation */
70 static struct mtx dev_pager_mtx;
72 struct pagerops devicepagerops = {
73 .pgo_init = dev_pager_init,
74 .pgo_alloc = dev_pager_alloc,
75 .pgo_dealloc = dev_pager_dealloc,
76 .pgo_getpages = dev_pager_getpages,
77 .pgo_putpages = dev_pager_putpages,
78 .pgo_haspage = dev_pager_haspage,
81 struct pagerops mgtdevicepagerops = {
82 .pgo_alloc = dev_pager_alloc,
83 .pgo_dealloc = dev_pager_dealloc,
84 .pgo_getpages = dev_pager_getpages,
85 .pgo_putpages = dev_pager_putpages,
86 .pgo_haspage = dev_pager_haspage,
89 static int old_dev_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
90 vm_ooffset_t foff, struct ucred *cred, u_short *color);
91 static void old_dev_pager_dtor(void *handle);
92 static int old_dev_pager_fault(vm_object_t object, vm_ooffset_t offset,
93 int prot, vm_page_t *mres);
95 static struct cdev_pager_ops old_dev_pager_ops = {
96 .cdev_pg_ctor = old_dev_pager_ctor,
97 .cdev_pg_dtor = old_dev_pager_dtor,
98 .cdev_pg_fault = old_dev_pager_fault
104 TAILQ_INIT(&dev_pager_object_list);
105 mtx_init(&dev_pager_mtx, "dev_pager list", NULL, MTX_DEF);
109 cdev_pager_lookup(void *handle)
113 mtx_lock(&dev_pager_mtx);
114 object = vm_pager_object_lookup(&dev_pager_object_list, handle);
115 mtx_unlock(&dev_pager_mtx);
120 cdev_pager_allocate(void *handle, enum obj_type tp, struct cdev_pager_ops *ops,
121 vm_ooffset_t size, vm_prot_t prot, vm_ooffset_t foff, struct ucred *cred)
123 vm_object_t object, object1;
127 if (tp != OBJT_DEVICE && tp != OBJT_MGTDEVICE)
131 * Offset should be page aligned.
133 if (foff & PAGE_MASK)
136 size = round_page(size);
137 pindex = OFF_TO_IDX(foff + size);
139 if (ops->cdev_pg_ctor(handle, size, prot, foff, cred, &color) != 0)
141 mtx_lock(&dev_pager_mtx);
144 * Look up pager, creating as necessary.
147 object = vm_pager_object_lookup(&dev_pager_object_list, handle);
148 if (object == NULL) {
150 * Allocate object and associate it with the pager. Initialize
151 * the object's pg_color based upon the physical address of the
154 mtx_unlock(&dev_pager_mtx);
155 object1 = vm_object_allocate(tp, pindex);
156 object1->flags |= OBJ_COLORED;
157 object1->pg_color = color;
158 object1->handle = handle;
159 object1->un_pager.devp.ops = ops;
160 TAILQ_INIT(&object1->un_pager.devp.devp_pglist);
161 mtx_lock(&dev_pager_mtx);
162 object = vm_pager_object_lookup(&dev_pager_object_list, handle);
163 if (object != NULL) {
165 * We raced with other thread while allocating object.
167 if (pindex > object->size)
168 object->size = pindex;
172 object->handle = handle;
173 TAILQ_INSERT_TAIL(&dev_pager_object_list, object,
175 KASSERT(object->type == tp,
176 ("Inconsistent device pager type %p %d", object, tp));
179 if (pindex > object->size)
180 object->size = pindex;
182 mtx_unlock(&dev_pager_mtx);
183 if (object1 != NULL) {
184 object1->handle = object1;
185 mtx_lock(&dev_pager_mtx);
186 TAILQ_INSERT_TAIL(&dev_pager_object_list, object1,
188 mtx_unlock(&dev_pager_mtx);
189 vm_object_deallocate(object1);
195 dev_pager_alloc(void *handle, vm_ooffset_t size, vm_prot_t prot,
196 vm_ooffset_t foff, struct ucred *cred)
199 return (cdev_pager_allocate(handle, OBJT_DEVICE, &old_dev_pager_ops,
200 size, prot, foff, cred));
204 cdev_pager_free_page(vm_object_t object, vm_page_t m)
207 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
208 if (object->type == OBJT_MGTDEVICE) {
209 KASSERT((m->oflags & VPO_UNMANAGED) == 0, ("unmanaged %p", m));
214 } else if (object->type == OBJT_DEVICE)
215 dev_pager_free_page(object, m);
219 dev_pager_free_page(vm_object_t object, vm_page_t m)
222 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
223 KASSERT((object->type == OBJT_DEVICE &&
224 (m->oflags & VPO_UNMANAGED) != 0),
225 ("Managed device or page obj %p m %p", object, m));
226 TAILQ_REMOVE(&object->un_pager.devp.devp_pglist, m, pageq);
231 dev_pager_dealloc(object)
236 VM_OBJECT_UNLOCK(object);
237 object->un_pager.devp.ops->cdev_pg_dtor(object->handle);
239 mtx_lock(&dev_pager_mtx);
240 TAILQ_REMOVE(&dev_pager_object_list, object, pager_object_list);
241 mtx_unlock(&dev_pager_mtx);
242 VM_OBJECT_LOCK(object);
244 if (object->type == OBJT_DEVICE) {
246 * Free up our fake pages.
248 while ((m = TAILQ_FIRST(&object->un_pager.devp.devp_pglist))
250 dev_pager_free_page(object, m);
255 dev_pager_getpages(vm_object_t object, vm_page_t *ma, int count, int reqpage)
259 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
260 error = object->un_pager.devp.ops->cdev_pg_fault(object,
261 IDX_TO_OFF(ma[reqpage]->pindex), PROT_READ, &ma[reqpage]);
263 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
265 for (i = 0; i < count; i++) {
269 vm_page_unlock(ma[i]);
273 if (error == VM_PAGER_OK) {
274 KASSERT((object->type == OBJT_DEVICE &&
275 (ma[reqpage]->oflags & VPO_UNMANAGED) != 0) ||
276 (object->type == OBJT_MGTDEVICE &&
277 (ma[reqpage]->oflags & VPO_UNMANAGED) == 0),
278 ("Wrong page type %p %p", ma[reqpage], object));
279 if (object->type == OBJT_DEVICE) {
280 TAILQ_INSERT_TAIL(&object->un_pager.devp.devp_pglist,
289 old_dev_pager_fault(vm_object_t object, vm_ooffset_t offset, int prot,
294 vm_page_t m_paddr, page;
299 vm_memattr_t memattr;
302 pidx = OFF_TO_IDX(offset);
303 memattr = object->memattr;
305 VM_OBJECT_UNLOCK(object);
307 dev = object->handle;
308 csw = dev_refthread(dev, &ref);
310 VM_OBJECT_LOCK(object);
311 return (VM_PAGER_FAIL);
316 ret = csw->d_mmap(dev, offset, &paddr, prot, &memattr);
318 dev_relthread(dev, ref);
321 "WARNING: dev_pager_getpage: map function returns error %d", ret);
322 VM_OBJECT_LOCK(object);
323 return (VM_PAGER_FAIL);
326 /* If "paddr" is a real page, perform a sanity check on "memattr". */
327 if ((m_paddr = vm_phys_paddr_to_vm_page(paddr)) != NULL &&
328 pmap_page_get_memattr(m_paddr) != memattr) {
329 memattr = pmap_page_get_memattr(m_paddr);
331 "WARNING: A device driver has set \"memattr\" inconsistently.\n");
333 if (((*mres)->flags & PG_FICTITIOUS) != 0) {
335 * If the passed in result page is a fake page, update it with
336 * the new physical address.
339 VM_OBJECT_LOCK(object);
340 vm_page_updatefake(page, paddr, memattr);
343 * Replace the passed in reqpage page with our own fake page and
344 * free up the all of the original pages.
346 page = vm_page_getfake(paddr, memattr);
347 VM_OBJECT_LOCK(object);
350 vm_page_unlock(*mres);
352 vm_page_insert(page, object, pidx);
354 page->valid = VM_PAGE_BITS_ALL;
355 return (VM_PAGER_OK);
359 dev_pager_putpages(object, m, count, sync, rtvals)
367 panic("dev_pager_putpage called");
371 dev_pager_haspage(object, pindex, before, after)
385 old_dev_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
386 vm_ooffset_t foff, struct ucred *cred, u_short *color)
397 * Make sure this device can be mapped.
400 csw = dev_refthread(dev, &ref);
405 * Check that the specified range of the device allows the desired
408 * XXX assumes VM_PROT_* == PROT_*
410 npages = OFF_TO_IDX(size);
411 for (off = foff; npages--; off += PAGE_SIZE) {
412 if (csw->d_mmap(dev, off, &paddr, (int)prot, &dummy) != 0) {
413 dev_relthread(dev, ref);
419 dev_relthread(dev, ref);
420 *color = atop(paddr) - OFF_TO_IDX(off - PAGE_SIZE);
425 old_dev_pager_dtor(void *handle)