xref: /dragonfly/sys/dev/drm/ttm/ttm_tt.c (revision 50b09fda)
1 /**************************************************************************
2  *
3  * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  **************************************************************************/
27 /*
28  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
29  */
30 /*
31  * Copyright (c) 2013 The FreeBSD Foundation
32  * All rights reserved.
33  *
34  * Portions of this software were developed by Konstantin Belousov
35  * <kib@FreeBSD.org> under sponsorship from the FreeBSD Foundation.
36  *
37  * $FreeBSD: head/sys/dev/drm2/ttm/ttm_tt.c 251452 2013-06-06 06:17:20Z alc $
38  */
39 
40 #define pr_fmt(fmt) "[TTM] " fmt
41 
42 #include <drm/drmP.h>
43 
44 #include <linux/export.h>
45 #include <drm/drm_mem_util.h>
46 #include <drm/ttm/ttm_module.h>
47 #include <drm/ttm/ttm_bo_driver.h>
48 #include <drm/ttm/ttm_placement.h>
49 #include <drm/ttm/ttm_page_alloc.h>
50 
51 #include <vm/vm_page2.h>
52 
53 /**
54  * Allocates storage for pointers to the pages that back the ttm.
55  */
56 static void ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
57 {
58 	ttm->pages = drm_calloc_large(ttm->num_pages, sizeof(void*));
59 }
60 
61 static void ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
62 {
63 	ttm->ttm.pages = drm_calloc_large(ttm->ttm.num_pages, sizeof(void*));
64 	ttm->dma_address = drm_calloc_large(ttm->ttm.num_pages,
65 					    sizeof(*ttm->dma_address));
66 }
67 
68 static inline int ttm_tt_set_page_caching(struct page *p,
69 					  enum ttm_caching_state c_old,
70 					  enum ttm_caching_state c_new)
71 {
72 
73 	/* XXXKIB our VM does not need this. */
74 #if 0
75 	if (c_old != tt_cached) {
76 		/* p isn't in the default caching state, set it to
77 		 * writeback first to free its current memtype. */
78 		pmap_page_set_memattr(p, VM_MEMATTR_WRITE_BACK);
79 	}
80 #endif
81 
82 	if (c_new == tt_wc)
83 		pmap_page_set_memattr((struct vm_page *)p, VM_MEMATTR_WRITE_COMBINING);
84 	else if (c_new == tt_uncached)
85 		pmap_page_set_memattr((struct vm_page *)p, VM_MEMATTR_UNCACHEABLE);
86 
87 	return (0);
88 }
89 
90 /*
91  * Change caching policy for the linear kernel map
92  * for range of pages in a ttm.
93  */
94 
95 static int ttm_tt_set_caching(struct ttm_tt *ttm,
96 			      enum ttm_caching_state c_state)
97 {
98 	int i, j;
99 	struct page *cur_page;
100 	int ret;
101 
102 	if (ttm->caching_state == c_state)
103 		return 0;
104 
105 	if (ttm->state == tt_unpopulated) {
106 		/* Change caching but don't populate */
107 		ttm->caching_state = c_state;
108 		return 0;
109 	}
110 
111 	if (ttm->caching_state == tt_cached)
112 		drm_clflush_pages(ttm->pages, ttm->num_pages);
113 
114 	for (i = 0; i < ttm->num_pages; ++i) {
115 		cur_page = ttm->pages[i];
116 		if (likely(cur_page != NULL)) {
117 			ret = ttm_tt_set_page_caching(cur_page,
118 						      ttm->caching_state,
119 						      c_state);
120 			if (unlikely(ret != 0))
121 				goto out_err;
122 		}
123 	}
124 
125 	ttm->caching_state = c_state;
126 
127 	return 0;
128 
129 out_err:
130 	for (j = 0; j < i; ++j) {
131 		cur_page = ttm->pages[j];
132 		if (likely(cur_page != NULL)) {
133 			(void)ttm_tt_set_page_caching(cur_page, c_state,
134 						      ttm->caching_state);
135 		}
136 	}
137 
138 	return ret;
139 }
140 
141 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement)
142 {
143 	enum ttm_caching_state state;
144 
145 	if (placement & TTM_PL_FLAG_WC)
146 		state = tt_wc;
147 	else if (placement & TTM_PL_FLAG_UNCACHED)
148 		state = tt_uncached;
149 	else
150 		state = tt_cached;
151 
152 	return ttm_tt_set_caching(ttm, state);
153 }
154 EXPORT_SYMBOL(ttm_tt_set_placement_caching);
155 
156 void ttm_tt_destroy(struct ttm_tt *ttm)
157 {
158 	if (unlikely(ttm == NULL))
159 		return;
160 
161 	if (ttm->state == tt_bound) {
162 		ttm_tt_unbind(ttm);
163 	}
164 
165 	if (likely(ttm->pages != NULL)) {
166 		ttm->bdev->driver->ttm_tt_unpopulate(ttm);
167 	}
168 
169 	if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) &&
170 	    ttm->swap_storage)
171 		vm_object_deallocate(ttm->swap_storage);
172 
173 	ttm->swap_storage = NULL;
174 	ttm->func->destroy(ttm);
175 }
176 
177 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
178 		unsigned long size, uint32_t page_flags,
179 		struct page *dummy_read_page)
180 {
181 	ttm->bdev = bdev;
182 	ttm->glob = bdev->glob;
183 	ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
184 	ttm->caching_state = tt_cached;
185 	ttm->page_flags = page_flags;
186 	ttm->dummy_read_page = dummy_read_page;
187 	ttm->state = tt_unpopulated;
188 	ttm->swap_storage = NULL;
189 
190 	ttm_tt_alloc_page_directory(ttm);
191 	if (!ttm->pages) {
192 		ttm_tt_destroy(ttm);
193 		pr_err("Failed allocating page table\n");
194 		return -ENOMEM;
195 	}
196 	return 0;
197 }
198 EXPORT_SYMBOL(ttm_tt_init);
199 
200 void ttm_tt_fini(struct ttm_tt *ttm)
201 {
202 	drm_free_large(ttm->pages);
203 	ttm->pages = NULL;
204 }
205 EXPORT_SYMBOL(ttm_tt_fini);
206 
207 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
208 		unsigned long size, uint32_t page_flags,
209 		struct page *dummy_read_page)
210 {
211 	struct ttm_tt *ttm = &ttm_dma->ttm;
212 
213 	ttm->bdev = bdev;
214 	ttm->glob = bdev->glob;
215 	ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
216 	ttm->caching_state = tt_cached;
217 	ttm->page_flags = page_flags;
218 	ttm->dummy_read_page = dummy_read_page;
219 	ttm->state = tt_unpopulated;
220 	ttm->swap_storage = NULL;
221 
222 	INIT_LIST_HEAD(&ttm_dma->pages_list);
223 	ttm_dma_tt_alloc_page_directory(ttm_dma);
224 	if (!ttm->pages || !ttm_dma->dma_address) {
225 		ttm_tt_destroy(ttm);
226 		pr_err("Failed allocating page table\n");
227 		return -ENOMEM;
228 	}
229 	return 0;
230 }
231 EXPORT_SYMBOL(ttm_dma_tt_init);
232 
233 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma)
234 {
235 	struct ttm_tt *ttm = &ttm_dma->ttm;
236 
237 	drm_free_large(ttm->pages);
238 	ttm->pages = NULL;
239 	drm_free_large(ttm_dma->dma_address);
240 	ttm_dma->dma_address = NULL;
241 }
242 EXPORT_SYMBOL(ttm_dma_tt_fini);
243 
244 void ttm_tt_unbind(struct ttm_tt *ttm)
245 {
246 	int ret;
247 
248 	if (ttm->state == tt_bound) {
249 		ret = ttm->func->unbind(ttm);
250 		BUG_ON(ret);
251 		ttm->state = tt_unbound;
252 	}
253 }
254 
255 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem)
256 {
257 	int ret = 0;
258 
259 	if (!ttm)
260 		return -EINVAL;
261 
262 	if (ttm->state == tt_bound)
263 		return 0;
264 
265 	ret = ttm->bdev->driver->ttm_tt_populate(ttm);
266 	if (ret)
267 		return ret;
268 
269 	ret = ttm->func->bind(ttm, bo_mem);
270 	if (unlikely(ret != 0))
271 		return ret;
272 
273 	ttm->state = tt_bound;
274 
275 	return 0;
276 }
277 EXPORT_SYMBOL(ttm_tt_bind);
278 
279 int ttm_tt_swapin(struct ttm_tt *ttm)
280 {
281 	vm_object_t obj;
282 	vm_page_t from_page, to_page;
283 	int i, ret, rv;
284 
285 	obj = ttm->swap_storage;
286 
287 	VM_OBJECT_LOCK(obj);
288 	vm_object_pip_add(obj, 1);
289 	for (i = 0; i < ttm->num_pages; ++i) {
290 		from_page = vm_page_grab(obj, i, VM_ALLOC_NORMAL |
291 						 VM_ALLOC_RETRY);
292 		if (from_page->valid != VM_PAGE_BITS_ALL) {
293 			if (vm_pager_has_page(obj, i)) {
294 				rv = vm_pager_get_page(obj, &from_page, 1);
295 				if (rv != VM_PAGER_OK) {
296 					vm_page_free(from_page);
297 					ret = -EIO;
298 					goto err_ret;
299 				}
300 			} else {
301 				vm_page_zero_invalid(from_page, TRUE);
302 			}
303 		}
304 		to_page = (struct vm_page *)ttm->pages[i];
305 		if (unlikely(to_page == NULL)) {
306 			ret = -ENOMEM;
307 			vm_page_wakeup(from_page);
308 			goto err_ret;
309 		}
310 		pmap_copy_page(VM_PAGE_TO_PHYS(from_page),
311 			       VM_PAGE_TO_PHYS(to_page));
312 		vm_page_wakeup(from_page);
313 	}
314 	vm_object_pip_wakeup(obj);
315 	VM_OBJECT_UNLOCK(obj);
316 
317 	if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP))
318 		vm_object_deallocate(obj);
319 	ttm->swap_storage = NULL;
320 	ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED;
321 	return (0);
322 
323 err_ret:
324 	vm_object_pip_wakeup(obj);
325 	VM_OBJECT_UNLOCK(obj);
326 	return (ret);
327 }
328 
329 int ttm_tt_swapout(struct ttm_tt *ttm, vm_object_t persistent_swap_storage)
330 {
331 	vm_object_t obj;
332 	vm_page_t from_page, to_page;
333 	int i;
334 
335 	BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated);
336 	BUG_ON(ttm->caching_state != tt_cached);
337 
338 	if (!persistent_swap_storage) {
339 		obj = swap_pager_alloc(NULL,
340 		    IDX_TO_OFF(ttm->num_pages), VM_PROT_DEFAULT, 0);
341 		if (obj == NULL) {
342 			pr_err("Failed allocating swap storage\n");
343 			return (-ENOMEM);
344 		}
345 	} else
346 		obj = persistent_swap_storage;
347 
348 	VM_OBJECT_LOCK(obj);
349 	vm_object_pip_add(obj, 1);
350 	for (i = 0; i < ttm->num_pages; ++i) {
351 		from_page = (struct vm_page *)ttm->pages[i];
352 		if (unlikely(from_page == NULL))
353 			continue;
354 		to_page = vm_page_grab(obj, i, VM_ALLOC_NORMAL |
355 					       VM_ALLOC_RETRY);
356 		pmap_copy_page(VM_PAGE_TO_PHYS(from_page),
357 					VM_PAGE_TO_PHYS(to_page));
358 		to_page->valid = VM_PAGE_BITS_ALL;
359 		vm_page_dirty(to_page);
360 		vm_page_wakeup(to_page);
361 	}
362 	vm_object_pip_wakeup(obj);
363 	VM_OBJECT_UNLOCK(obj);
364 
365 	ttm->bdev->driver->ttm_tt_unpopulate(ttm);
366 	ttm->swap_storage = obj;
367 	ttm->page_flags |= TTM_PAGE_FLAG_SWAPPED;
368 	if (persistent_swap_storage)
369 		ttm->page_flags |= TTM_PAGE_FLAG_PERSISTENT_SWAP;
370 
371 	return 0;
372 }
373