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 * 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.
21 *
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
32 * SUCH DAMAGE.
33 *
34 *	@(#)device_pager.c	8.1 (Berkeley) 6/11/93
35 */
36
37#include <sys/cdefs.h>
38__FBSDID("$FreeBSD$");
39
40#include <sys/param.h>
41#include <sys/systm.h>
42#include <sys/conf.h>
43#include <sys/lock.h>
44#include <sys/proc.h>
45#include <sys/mutex.h>
46#include <sys/mman.h>
47#include <sys/rwlock.h>
48#include <sys/sx.h>
49
50#include <vm/vm.h>
51#include <vm/vm_param.h>
52#include <vm/vm_object.h>
53#include <vm/vm_page.h>
54#include <vm/vm_pager.h>
55#include <vm/vm_phys.h>
56#include <vm/uma.h>
57
58static void dev_pager_init(void);
59static vm_object_t dev_pager_alloc(void *, vm_ooffset_t, vm_prot_t,
60    vm_ooffset_t, struct ucred *);
61static void dev_pager_dealloc(vm_object_t);
62static int dev_pager_getpages(vm_object_t, vm_page_t *, int, int *, int *);
63static void dev_pager_putpages(vm_object_t, vm_page_t *, int, int, int *);
64static boolean_t dev_pager_haspage(vm_object_t, vm_pindex_t, int *, int *);
65static void dev_pager_free_page(vm_object_t object, vm_page_t m);
66
67/* list of device pager objects */
68static struct pagerlst dev_pager_object_list;
69/* protect list manipulation */
70static struct mtx dev_pager_mtx;
71
72struct 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,
79};
80
81struct 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,
87};
88
89static 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);
91static void old_dev_pager_dtor(void *handle);
92static int old_dev_pager_fault(vm_object_t object, vm_ooffset_t offset,
93    int prot, vm_page_t *mres);
94
95static 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
99};
100
101static void
102dev_pager_init(void)
103{
104
105	TAILQ_INIT(&dev_pager_object_list);
106	mtx_init(&dev_pager_mtx, "dev_pager list", NULL, MTX_DEF);
107}
108
109vm_object_t
110cdev_pager_lookup(void *handle)
111{
112	vm_object_t object;
113
114	mtx_lock(&dev_pager_mtx);
115	object = vm_pager_object_lookup(&dev_pager_object_list, handle);
116	mtx_unlock(&dev_pager_mtx);
117	return (object);
118}
119
120vm_object_t
121cdev_pager_allocate(void *handle, enum obj_type tp, struct cdev_pager_ops *ops,
122    vm_ooffset_t size, vm_prot_t prot, vm_ooffset_t foff, struct ucred *cred)
123{
124	vm_object_t object, object1;
125	vm_pindex_t pindex;
126	u_short color;
127
128	if (tp != OBJT_DEVICE && tp != OBJT_MGTDEVICE)
129		return (NULL);
130
131	/*
132	 * Offset should be page aligned.
133	 */
134	if (foff & PAGE_MASK)
135		return (NULL);
136
137	size = round_page(size);
138	pindex = OFF_TO_IDX(foff + size);
139
140	if (ops->cdev_pg_ctor(handle, size, prot, foff, cred, &color) != 0)
141		return (NULL);
142	mtx_lock(&dev_pager_mtx);
143
144	/*
145	 * Look up pager, creating as necessary.
146	 */
147	object1 = NULL;
148	object = vm_pager_object_lookup(&dev_pager_object_list, handle);
149	if (object == NULL) {
150		/*
151		 * Allocate object and associate it with the pager.  Initialize
152		 * the object's pg_color based upon the physical address of the
153		 * device's memory.
154		 */
155		mtx_unlock(&dev_pager_mtx);
156		object1 = vm_object_allocate(tp, pindex);
157		object1->flags |= OBJ_COLORED;
158		object1->pg_color = color;
159		object1->handle = handle;
160		object1->un_pager.devp.ops = ops;
161		object1->un_pager.devp.dev = handle;
162		TAILQ_INIT(&object1->un_pager.devp.devp_pglist);
163		mtx_lock(&dev_pager_mtx);
164		object = vm_pager_object_lookup(&dev_pager_object_list, handle);
165		if (object != NULL) {
166			/*
167			 * We raced with other thread while allocating object.
168			 */
169			if (pindex > object->size)
170				object->size = pindex;
171			KASSERT(object->type == tp,
172		    ("Inconsistent device pager type %p %d", object, tp));
173		} else {
174			object = object1;
175			object1 = NULL;
176			object->handle = handle;
177			TAILQ_INSERT_TAIL(&dev_pager_object_list, object,
178			    pager_object_list);
179		}
180	} else {
181		if (pindex > object->size)
182			object->size = pindex;
183		KASSERT(object->type == tp,
184		    ("Inconsistent device pager type %p %d", object, tp));
185	}
186	mtx_unlock(&dev_pager_mtx);
187	if (object1 != NULL) {
188		object1->handle = object1;
189		mtx_lock(&dev_pager_mtx);
190		TAILQ_INSERT_TAIL(&dev_pager_object_list, object1,
191		    pager_object_list);
192		mtx_unlock(&dev_pager_mtx);
193		vm_object_deallocate(object1);
194	}
195	return (object);
196}
197
198static vm_object_t
199dev_pager_alloc(void *handle, vm_ooffset_t size, vm_prot_t prot,
200    vm_ooffset_t foff, struct ucred *cred)
201{
202
203	return (cdev_pager_allocate(handle, OBJT_DEVICE, &old_dev_pager_ops,
204	    size, prot, foff, cred));
205}
206
207void
208cdev_pager_free_page(vm_object_t object, vm_page_t m)
209{
210
211	VM_OBJECT_ASSERT_WLOCKED(object);
212	if (object->type == OBJT_MGTDEVICE) {
213		KASSERT((m->oflags & VPO_UNMANAGED) == 0, ("unmanaged %p", m));
214		pmap_remove_all(m);
215		vm_page_lock(m);
216		vm_page_remove(m);
217		vm_page_unlock(m);
218	} else if (object->type == OBJT_DEVICE)
219		dev_pager_free_page(object, m);
220}
221
222static void
223dev_pager_free_page(vm_object_t object, vm_page_t m)
224{
225
226	VM_OBJECT_ASSERT_WLOCKED(object);
227	KASSERT((object->type == OBJT_DEVICE &&
228	    (m->oflags & VPO_UNMANAGED) != 0),
229	    ("Managed device or page obj %p m %p", object, m));
230	TAILQ_REMOVE(&object->un_pager.devp.devp_pglist, m, plinks.q);
231	vm_page_putfake(m);
232}
233
234static void
235dev_pager_dealloc(vm_object_t object)
236{
237	vm_page_t m;
238
239	VM_OBJECT_WUNLOCK(object);
240	object->un_pager.devp.ops->cdev_pg_dtor(object->un_pager.devp.dev);
241
242	mtx_lock(&dev_pager_mtx);
243	TAILQ_REMOVE(&dev_pager_object_list, object, pager_object_list);
244	mtx_unlock(&dev_pager_mtx);
245	VM_OBJECT_WLOCK(object);
246
247	if (object->type == OBJT_DEVICE) {
248		/*
249		 * Free up our fake pages.
250		 */
251		while ((m = TAILQ_FIRST(&object->un_pager.devp.devp_pglist))
252		    != NULL)
253			dev_pager_free_page(object, m);
254	}
255	object->handle = NULL;
256	object->type = OBJT_DEAD;
257}
258
259static int
260dev_pager_getpages(vm_object_t object, vm_page_t *ma, int count, int *rbehind,
261    int *rahead)
262{
263	int error;
264
265	/* Since our haspage reports zero after/before, the count is 1. */
266	KASSERT(count == 1, ("%s: count %d", __func__, count));
267	VM_OBJECT_ASSERT_WLOCKED(object);
268	error = object->un_pager.devp.ops->cdev_pg_fault(object,
269	    IDX_TO_OFF(ma[0]->pindex), PROT_READ, &ma[0]);
270
271	VM_OBJECT_ASSERT_WLOCKED(object);
272
273	if (error == VM_PAGER_OK) {
274		KASSERT((object->type == OBJT_DEVICE &&
275		     (ma[0]->oflags & VPO_UNMANAGED) != 0) ||
276		    (object->type == OBJT_MGTDEVICE &&
277		     (ma[0]->oflags & VPO_UNMANAGED) == 0),
278		    ("Wrong page type %p %p", ma[0], object));
279		if (object->type == OBJT_DEVICE) {
280			TAILQ_INSERT_TAIL(&object->un_pager.devp.devp_pglist,
281			    ma[0], plinks.q);
282		}
283		if (rbehind)
284			*rbehind = 0;
285		if (rahead)
286			*rahead = 0;
287	}
288
289	return (error);
290}
291
292static int
293old_dev_pager_fault(vm_object_t object, vm_ooffset_t offset, int prot,
294    vm_page_t *mres)
295{
296	vm_paddr_t paddr;
297	vm_page_t m_paddr, page;
298	struct cdev *dev;
299	struct cdevsw *csw;
300	struct file *fpop;
301	struct thread *td;
302	vm_memattr_t memattr, memattr1;
303	int ref, ret;
304
305	memattr = object->memattr;
306
307	VM_OBJECT_WUNLOCK(object);
308
309	dev = object->handle;
310	csw = dev_refthread(dev, &ref);
311	if (csw == NULL) {
312		VM_OBJECT_WLOCK(object);
313		return (VM_PAGER_FAIL);
314	}
315	td = curthread;
316	fpop = td->td_fpop;
317	td->td_fpop = NULL;
318	ret = csw->d_mmap(dev, offset, &paddr, prot, &memattr);
319	td->td_fpop = fpop;
320	dev_relthread(dev, ref);
321	if (ret != 0) {
322		printf(
323	    "WARNING: dev_pager_getpage: map function returns error %d", ret);
324		VM_OBJECT_WLOCK(object);
325		return (VM_PAGER_FAIL);
326	}
327
328	/* If "paddr" is a real page, perform a sanity check on "memattr". */
329	if ((m_paddr = vm_phys_paddr_to_vm_page(paddr)) != NULL &&
330	    (memattr1 = pmap_page_get_memattr(m_paddr)) != memattr) {
331		/*
332		 * For the /dev/mem d_mmap routine to return the
333		 * correct memattr, pmap_page_get_memattr() needs to
334		 * be called, which we do there.
335		 */
336		if ((csw->d_flags & D_MEM) == 0) {
337			printf("WARNING: Device driver %s has set "
338			    "\"memattr\" inconsistently (drv %u pmap %u).\n",
339			    csw->d_name, memattr, memattr1);
340		}
341		memattr = memattr1;
342	}
343	if (((*mres)->flags & PG_FICTITIOUS) != 0) {
344		/*
345		 * If the passed in result page is a fake page, update it with
346		 * the new physical address.
347		 */
348		page = *mres;
349		VM_OBJECT_WLOCK(object);
350		vm_page_updatefake(page, paddr, memattr);
351	} else {
352		/*
353		 * Replace the passed in reqpage page with our own fake page and
354		 * free up the all of the original pages.
355		 */
356		page = vm_page_getfake(paddr, memattr);
357		VM_OBJECT_WLOCK(object);
358		vm_page_replace_checked(page, object, (*mres)->pindex, *mres);
359		vm_page_lock(*mres);
360		vm_page_free(*mres);
361		vm_page_unlock(*mres);
362		*mres = page;
363	}
364	page->valid = VM_PAGE_BITS_ALL;
365	return (VM_PAGER_OK);
366}
367
368static void
369dev_pager_putpages(vm_object_t object, vm_page_t *m, int count, int flags,
370    int *rtvals)
371{
372
373	panic("dev_pager_putpage called");
374}
375
376static boolean_t
377dev_pager_haspage(vm_object_t object, vm_pindex_t pindex, int *before,
378    int *after)
379{
380
381	if (before != NULL)
382		*before = 0;
383	if (after != NULL)
384		*after = 0;
385	return (TRUE);
386}
387
388static int
389old_dev_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
390    vm_ooffset_t foff, struct ucred *cred, u_short *color)
391{
392	struct cdev *dev;
393	struct cdevsw *csw;
394	vm_memattr_t dummy;
395	vm_ooffset_t off;
396	vm_paddr_t paddr;
397	unsigned int npages;
398	int ref;
399
400	/*
401	 * Make sure this device can be mapped.
402	 */
403	dev = handle;
404	csw = dev_refthread(dev, &ref);
405	if (csw == NULL)
406		return (ENXIO);
407
408	/*
409	 * Check that the specified range of the device allows the desired
410	 * protection.
411	 *
412	 * XXX assumes VM_PROT_* == PROT_*
413	 */
414	npages = OFF_TO_IDX(size);
415	paddr = 0; /* Make paddr initialized for the case of size == 0. */
416	for (off = foff; npages--; off += PAGE_SIZE) {
417		if (csw->d_mmap(dev, off, &paddr, (int)prot, &dummy) != 0) {
418			dev_relthread(dev, ref);
419			return (EINVAL);
420		}
421	}
422
423	dev_ref(dev);
424	dev_relthread(dev, ref);
425	*color = atop(paddr) - OFF_TO_IDX(off - PAGE_SIZE);
426	return (0);
427}
428
429static void
430old_dev_pager_dtor(void *handle)
431{
432
433	dev_rel(handle);
434}
435