1 /**************************************************************************
3 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
31 #define pr_fmt(fmt) "[TTM] " fmt
33 #include <linux/sched.h>
34 #include <linux/pagemap.h>
35 #include <linux/shmem_fs.h>
36 #include <linux/file.h>
37 #include <drm/drm_cache.h>
38 #include <drm/ttm/ttm_bo_driver.h>
39 #include <drm/ttm/ttm_page_alloc.h>
41 #include <asm/set_memory.h>
45 * Allocates a ttm structure for the given BO.
47 int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc)
49 struct ttm_bo_device *bdev = bo->bdev;
50 uint32_t page_flags = 0;
52 reservation_object_assert_held(bo->resv);
55 page_flags |= TTM_PAGE_FLAG_DMA32;
58 page_flags |= TTM_PAGE_FLAG_NO_RETRY;
61 case ttm_bo_type_device:
63 page_flags |= TTM_PAGE_FLAG_ZERO_ALLOC;
65 case ttm_bo_type_kernel:
68 page_flags |= TTM_PAGE_FLAG_SG;
72 pr_err("Illegal buffer object type\n");
76 bo->ttm = bdev->driver->ttm_tt_create(bo, page_flags);
77 if (unlikely(bo->ttm == NULL))
84 * Allocates storage for pointers to the pages that back the ttm.
86 static int ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
88 ttm->pages = kvmalloc_array(ttm->num_pages, sizeof(void*),
89 GFP_KERNEL | __GFP_ZERO);
95 static int ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
97 ttm->ttm.pages = kvmalloc_array(ttm->ttm.num_pages,
98 sizeof(*ttm->ttm.pages) +
99 sizeof(*ttm->dma_address),
100 GFP_KERNEL | __GFP_ZERO);
103 ttm->dma_address = (void *) (ttm->ttm.pages + ttm->ttm.num_pages);
107 static int ttm_sg_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
109 ttm->dma_address = kvmalloc_array(ttm->ttm.num_pages,
110 sizeof(*ttm->dma_address),
111 GFP_KERNEL | __GFP_ZERO);
112 if (!ttm->dma_address)
118 static inline int ttm_tt_set_page_caching(struct page *p,
119 enum ttm_caching_state c_old,
120 enum ttm_caching_state c_new)
127 if (c_old != tt_cached) {
128 /* p isn't in the default caching state, set it to
129 * writeback first to free its current memtype. */
131 ret = set_pages_wb(p, 1);
137 ret = set_memory_wc((unsigned long) page_address(p), 1);
138 else if (c_new == tt_uncached)
139 ret = set_pages_uc(p, 1);
143 #else /* CONFIG_X86 */
144 static inline int ttm_tt_set_page_caching(struct page *p,
145 enum ttm_caching_state c_old,
146 enum ttm_caching_state c_new)
150 #endif /* CONFIG_X86 */
153 * Change caching policy for the linear kernel map
154 * for range of pages in a ttm.
157 static int ttm_tt_set_caching(struct ttm_tt *ttm,
158 enum ttm_caching_state c_state)
161 struct page *cur_page;
164 if (ttm->caching_state == c_state)
167 if (ttm->state == tt_unpopulated) {
168 /* Change caching but don't populate */
169 ttm->caching_state = c_state;
173 if (ttm->caching_state == tt_cached)
174 drm_clflush_pages(ttm->pages, ttm->num_pages);
176 for (i = 0; i < ttm->num_pages; ++i) {
177 cur_page = ttm->pages[i];
178 if (likely(cur_page != NULL)) {
179 ret = ttm_tt_set_page_caching(cur_page,
182 if (unlikely(ret != 0))
187 ttm->caching_state = c_state;
192 for (j = 0; j < i; ++j) {
193 cur_page = ttm->pages[j];
194 if (likely(cur_page != NULL)) {
195 (void)ttm_tt_set_page_caching(cur_page, c_state,
203 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement)
205 enum ttm_caching_state state;
207 if (placement & TTM_PL_FLAG_WC)
209 else if (placement & TTM_PL_FLAG_UNCACHED)
214 return ttm_tt_set_caching(ttm, state);
216 EXPORT_SYMBOL(ttm_tt_set_placement_caching);
218 void ttm_tt_destroy(struct ttm_tt *ttm)
225 if (ttm->state == tt_unbound)
226 ttm_tt_unpopulate(ttm);
228 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) &&
230 fput(ttm->swap_storage);
232 ttm->swap_storage = NULL;
233 ttm->func->destroy(ttm);
236 void ttm_tt_init_fields(struct ttm_tt *ttm, struct ttm_buffer_object *bo,
239 ttm->bdev = bo->bdev;
240 ttm->num_pages = bo->num_pages;
241 ttm->caching_state = tt_cached;
242 ttm->page_flags = page_flags;
243 ttm->state = tt_unpopulated;
244 ttm->swap_storage = NULL;
248 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_buffer_object *bo,
251 ttm_tt_init_fields(ttm, bo, page_flags);
253 if (ttm_tt_alloc_page_directory(ttm)) {
255 pr_err("Failed allocating page table\n");
260 EXPORT_SYMBOL(ttm_tt_init);
262 void ttm_tt_fini(struct ttm_tt *ttm)
267 EXPORT_SYMBOL(ttm_tt_fini);
269 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo,
272 struct ttm_tt *ttm = &ttm_dma->ttm;
274 ttm_tt_init_fields(ttm, bo, page_flags);
276 INIT_LIST_HEAD(&ttm_dma->pages_list);
277 if (ttm_dma_tt_alloc_page_directory(ttm_dma)) {
279 pr_err("Failed allocating page table\n");
284 EXPORT_SYMBOL(ttm_dma_tt_init);
286 int ttm_sg_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo,
289 struct ttm_tt *ttm = &ttm_dma->ttm;
292 ttm_tt_init_fields(ttm, bo, page_flags);
294 INIT_LIST_HEAD(&ttm_dma->pages_list);
295 if (page_flags & TTM_PAGE_FLAG_SG)
296 ret = ttm_sg_tt_alloc_page_directory(ttm_dma);
298 ret = ttm_dma_tt_alloc_page_directory(ttm_dma);
301 pr_err("Failed allocating page table\n");
306 EXPORT_SYMBOL(ttm_sg_tt_init);
308 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma)
310 struct ttm_tt *ttm = &ttm_dma->ttm;
315 kvfree(ttm_dma->dma_address);
317 ttm_dma->dma_address = NULL;
319 EXPORT_SYMBOL(ttm_dma_tt_fini);
321 void ttm_tt_unbind(struct ttm_tt *ttm)
325 if (ttm->state == tt_bound) {
326 ret = ttm->func->unbind(ttm);
328 ttm->state = tt_unbound;
332 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem,
333 struct ttm_operation_ctx *ctx)
340 if (ttm->state == tt_bound)
343 ret = ttm_tt_populate(ttm, ctx);
347 ret = ttm->func->bind(ttm, bo_mem);
348 if (unlikely(ret != 0))
351 ttm->state = tt_bound;
355 EXPORT_SYMBOL(ttm_tt_bind);
357 int ttm_tt_swapin(struct ttm_tt *ttm)
359 struct address_space *swap_space;
360 struct file *swap_storage;
361 struct page *from_page;
362 struct page *to_page;
366 swap_storage = ttm->swap_storage;
367 BUG_ON(swap_storage == NULL);
369 swap_space = swap_storage->f_mapping;
371 for (i = 0; i < ttm->num_pages; ++i) {
372 gfp_t gfp_mask = mapping_gfp_mask(swap_space);
374 gfp_mask |= (ttm->page_flags & TTM_PAGE_FLAG_NO_RETRY ? __GFP_RETRY_MAYFAIL : 0);
375 from_page = shmem_read_mapping_page_gfp(swap_space, i, gfp_mask);
377 if (IS_ERR(from_page)) {
378 ret = PTR_ERR(from_page);
381 to_page = ttm->pages[i];
382 if (unlikely(to_page == NULL))
385 copy_highpage(to_page, from_page);
389 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP))
391 ttm->swap_storage = NULL;
392 ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED;
399 int ttm_tt_swapout(struct ttm_tt *ttm, struct file *persistent_swap_storage)
401 struct address_space *swap_space;
402 struct file *swap_storage;
403 struct page *from_page;
404 struct page *to_page;
408 BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated);
409 BUG_ON(ttm->caching_state != tt_cached);
411 if (!persistent_swap_storage) {
412 swap_storage = shmem_file_setup("ttm swap",
413 ttm->num_pages << PAGE_SHIFT,
415 if (IS_ERR(swap_storage)) {
416 pr_err("Failed allocating swap storage\n");
417 return PTR_ERR(swap_storage);
420 swap_storage = persistent_swap_storage;
423 swap_space = swap_storage->f_mapping;
425 for (i = 0; i < ttm->num_pages; ++i) {
426 gfp_t gfp_mask = mapping_gfp_mask(swap_space);
428 gfp_mask |= (ttm->page_flags & TTM_PAGE_FLAG_NO_RETRY ? __GFP_RETRY_MAYFAIL : 0);
430 from_page = ttm->pages[i];
431 if (unlikely(from_page == NULL))
434 to_page = shmem_read_mapping_page_gfp(swap_space, i, gfp_mask);
435 if (IS_ERR(to_page)) {
436 ret = PTR_ERR(to_page);
439 copy_highpage(to_page, from_page);
440 set_page_dirty(to_page);
441 mark_page_accessed(to_page);
445 ttm_tt_unpopulate(ttm);
446 ttm->swap_storage = swap_storage;
447 ttm->page_flags |= TTM_PAGE_FLAG_SWAPPED;
448 if (persistent_swap_storage)
449 ttm->page_flags |= TTM_PAGE_FLAG_PERSISTENT_SWAP;
453 if (!persistent_swap_storage)
459 static void ttm_tt_add_mapping(struct ttm_tt *ttm)
463 if (ttm->page_flags & TTM_PAGE_FLAG_SG)
466 for (i = 0; i < ttm->num_pages; ++i)
467 ttm->pages[i]->mapping = ttm->bdev->dev_mapping;
470 int ttm_tt_populate(struct ttm_tt *ttm, struct ttm_operation_ctx *ctx)
474 if (ttm->state != tt_unpopulated)
477 if (ttm->bdev->driver->ttm_tt_populate)
478 ret = ttm->bdev->driver->ttm_tt_populate(ttm, ctx);
480 ret = ttm_pool_populate(ttm, ctx);
482 ttm_tt_add_mapping(ttm);
486 static void ttm_tt_clear_mapping(struct ttm_tt *ttm)
489 struct page **page = ttm->pages;
491 if (ttm->page_flags & TTM_PAGE_FLAG_SG)
494 for (i = 0; i < ttm->num_pages; ++i) {
495 (*page)->mapping = NULL;
496 (*page++)->index = 0;
500 void ttm_tt_unpopulate(struct ttm_tt *ttm)
502 if (ttm->state == tt_unpopulated)
505 ttm_tt_clear_mapping(ttm);
506 if (ttm->bdev->driver->ttm_tt_unpopulate)
507 ttm->bdev->driver->ttm_tt_unpopulate(ttm);
509 ttm_pool_unpopulate(ttm);