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/highmem.h>
35 #include <linux/pagemap.h>
36 #include <linux/shmem_fs.h>
37 #include <linux/file.h>
38 #include <linux/swap.h>
39 #include <linux/slab.h>
40 #include <linux/export.h>
41 #include <drm/drm_cache.h>
42 #include <drm/drm_mem_util.h>
43 #include <drm/ttm/ttm_module.h>
44 #include <drm/ttm/ttm_bo_driver.h>
45 #include <drm/ttm/ttm_placement.h>
46 #include <drm/ttm/ttm_page_alloc.h>
49 * Allocates storage for pointers to the pages that back the ttm.
51 static void ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
53 ttm->pages = drm_calloc_large(ttm->num_pages, sizeof(void*));
56 static void ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
58 ttm->ttm.pages = drm_calloc_large(ttm->ttm.num_pages,
59 sizeof(*ttm->ttm.pages) +
60 sizeof(*ttm->dma_address));
61 ttm->dma_address = (void *) (ttm->ttm.pages + ttm->ttm.num_pages);
65 static inline int ttm_tt_set_page_caching(struct page *p,
66 enum ttm_caching_state c_old,
67 enum ttm_caching_state c_new)
74 if (c_old != tt_cached) {
75 /* p isn't in the default caching state, set it to
76 * writeback first to free its current memtype. */
78 ret = set_pages_wb(p, 1);
84 ret = set_memory_wc((unsigned long) page_address(p), 1);
85 else if (c_new == tt_uncached)
86 ret = set_pages_uc(p, 1);
90 #else /* CONFIG_X86 */
91 static inline int ttm_tt_set_page_caching(struct page *p,
92 enum ttm_caching_state c_old,
93 enum ttm_caching_state c_new)
97 #endif /* CONFIG_X86 */
100 * Change caching policy for the linear kernel map
101 * for range of pages in a ttm.
104 static int ttm_tt_set_caching(struct ttm_tt *ttm,
105 enum ttm_caching_state c_state)
108 struct page *cur_page;
111 if (ttm->caching_state == c_state)
114 if (ttm->state == tt_unpopulated) {
115 /* Change caching but don't populate */
116 ttm->caching_state = c_state;
120 if (ttm->caching_state == tt_cached)
121 drm_clflush_pages(ttm->pages, ttm->num_pages);
123 for (i = 0; i < ttm->num_pages; ++i) {
124 cur_page = ttm->pages[i];
125 if (likely(cur_page != NULL)) {
126 ret = ttm_tt_set_page_caching(cur_page,
129 if (unlikely(ret != 0))
134 ttm->caching_state = c_state;
139 for (j = 0; j < i; ++j) {
140 cur_page = ttm->pages[j];
141 if (likely(cur_page != NULL)) {
142 (void)ttm_tt_set_page_caching(cur_page, c_state,
150 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement)
152 enum ttm_caching_state state;
154 if (placement & TTM_PL_FLAG_WC)
156 else if (placement & TTM_PL_FLAG_UNCACHED)
161 return ttm_tt_set_caching(ttm, state);
163 EXPORT_SYMBOL(ttm_tt_set_placement_caching);
165 void ttm_tt_destroy(struct ttm_tt *ttm)
172 if (ttm->state == tt_unbound)
173 ttm_tt_unpopulate(ttm);
175 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) &&
177 fput(ttm->swap_storage);
179 ttm->swap_storage = NULL;
180 ttm->func->destroy(ttm);
183 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
184 unsigned long size, uint32_t page_flags,
185 struct page *dummy_read_page)
188 ttm->glob = bdev->glob;
189 ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
190 ttm->caching_state = tt_cached;
191 ttm->page_flags = page_flags;
192 ttm->dummy_read_page = dummy_read_page;
193 ttm->state = tt_unpopulated;
194 ttm->swap_storage = NULL;
196 ttm_tt_alloc_page_directory(ttm);
199 pr_err("Failed allocating page table\n");
204 EXPORT_SYMBOL(ttm_tt_init);
206 void ttm_tt_fini(struct ttm_tt *ttm)
208 drm_free_large(ttm->pages);
211 EXPORT_SYMBOL(ttm_tt_fini);
213 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
214 unsigned long size, uint32_t page_flags,
215 struct page *dummy_read_page)
217 struct ttm_tt *ttm = &ttm_dma->ttm;
220 ttm->glob = bdev->glob;
221 ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
222 ttm->caching_state = tt_cached;
223 ttm->page_flags = page_flags;
224 ttm->dummy_read_page = dummy_read_page;
225 ttm->state = tt_unpopulated;
226 ttm->swap_storage = NULL;
228 INIT_LIST_HEAD(&ttm_dma->pages_list);
229 ttm_dma_tt_alloc_page_directory(ttm_dma);
232 pr_err("Failed allocating page table\n");
237 EXPORT_SYMBOL(ttm_dma_tt_init);
239 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma)
241 struct ttm_tt *ttm = &ttm_dma->ttm;
243 drm_free_large(ttm->pages);
245 ttm_dma->dma_address = NULL;
247 EXPORT_SYMBOL(ttm_dma_tt_fini);
249 void ttm_tt_unbind(struct ttm_tt *ttm)
253 if (ttm->state == tt_bound) {
254 ret = ttm->func->unbind(ttm);
256 ttm->state = tt_unbound;
260 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem)
267 if (ttm->state == tt_bound)
270 ret = ttm->bdev->driver->ttm_tt_populate(ttm);
274 ret = ttm->func->bind(ttm, bo_mem);
275 if (unlikely(ret != 0))
278 ttm->state = tt_bound;
282 EXPORT_SYMBOL(ttm_tt_bind);
284 int ttm_tt_swapin(struct ttm_tt *ttm)
286 struct address_space *swap_space;
287 struct file *swap_storage;
288 struct page *from_page;
289 struct page *to_page;
293 swap_storage = ttm->swap_storage;
294 BUG_ON(swap_storage == NULL);
296 swap_space = swap_storage->f_mapping;
298 for (i = 0; i < ttm->num_pages; ++i) {
299 from_page = shmem_read_mapping_page(swap_space, i);
300 if (IS_ERR(from_page)) {
301 ret = PTR_ERR(from_page);
304 to_page = ttm->pages[i];
305 if (unlikely(to_page == NULL))
308 copy_highpage(to_page, from_page);
312 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP))
314 ttm->swap_storage = NULL;
315 ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED;
322 int ttm_tt_swapout(struct ttm_tt *ttm, struct file *persistent_swap_storage)
324 struct address_space *swap_space;
325 struct file *swap_storage;
326 struct page *from_page;
327 struct page *to_page;
331 BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated);
332 BUG_ON(ttm->caching_state != tt_cached);
334 if (!persistent_swap_storage) {
335 swap_storage = shmem_file_setup("ttm swap",
336 ttm->num_pages << PAGE_SHIFT,
338 if (IS_ERR(swap_storage)) {
339 pr_err("Failed allocating swap storage\n");
340 return PTR_ERR(swap_storage);
343 swap_storage = persistent_swap_storage;
345 swap_space = swap_storage->f_mapping;
347 for (i = 0; i < ttm->num_pages; ++i) {
348 from_page = ttm->pages[i];
349 if (unlikely(from_page == NULL))
351 to_page = shmem_read_mapping_page(swap_space, i);
352 if (IS_ERR(to_page)) {
353 ret = PTR_ERR(to_page);
356 copy_highpage(to_page, from_page);
357 set_page_dirty(to_page);
358 mark_page_accessed(to_page);
362 ttm_tt_unpopulate(ttm);
363 ttm->swap_storage = swap_storage;
364 ttm->page_flags |= TTM_PAGE_FLAG_SWAPPED;
365 if (persistent_swap_storage)
366 ttm->page_flags |= TTM_PAGE_FLAG_PERSISTENT_SWAP;
370 if (!persistent_swap_storage)
376 static void ttm_tt_clear_mapping(struct ttm_tt *ttm)
379 struct page **page = ttm->pages;
381 if (ttm->page_flags & TTM_PAGE_FLAG_SG)
384 for (i = 0; i < ttm->num_pages; ++i) {
385 (*page)->mapping = NULL;
386 (*page++)->index = 0;
390 void ttm_tt_unpopulate(struct ttm_tt *ttm)
392 if (ttm->state == tt_unpopulated)
395 ttm_tt_clear_mapping(ttm);
396 ttm->bdev->driver->ttm_tt_unpopulate(ttm);