1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */ 2 /************************************************************************** 3 * 4 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA 5 * All Rights Reserved. 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a 8 * copy of this software and associated documentation files (the 9 * "Software"), to deal in the Software without restriction, including 10 * without limitation the rights to use, copy, modify, merge, publish, 11 * distribute, sub license, and/or sell copies of the Software, and to 12 * permit persons to whom the Software is furnished to do so, subject to 13 * the following conditions: 14 * 15 * The above copyright notice and this permission notice (including the 16 * next paragraph) shall be included in all copies or substantial portions 17 * of the Software. 18 * 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 22 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, 23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 25 * USE OR OTHER DEALINGS IN THE SOFTWARE. 26 * 27 **************************************************************************/ 28 /* 29 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com> 30 */ 31 32 #define pr_fmt(fmt) "[TTM] " fmt 33 34 #include <linux/sched.h> 35 #include <linux/pagemap.h> 36 #include <linux/shmem_fs.h> 37 #include <linux/file.h> 38 #include <drm/drm_cache.h> 39 #include <drm/ttm/ttm_bo_driver.h> 40 #include <drm/ttm/ttm_page_alloc.h> 41 #include <drm/ttm/ttm_set_memory.h> 42 43 /** 44 * Allocates a ttm structure for the given BO. 45 */ 46 int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc) 47 { 48 struct ttm_bo_device *bdev = bo->bdev; 49 uint32_t page_flags = 0; 50 51 dma_resv_assert_held(bo->base.resv); 52 53 if (bo->ttm) 54 return 0; 55 56 if (bdev->need_dma32) 57 page_flags |= TTM_PAGE_FLAG_DMA32; 58 59 if (bdev->no_retry) 60 page_flags |= TTM_PAGE_FLAG_NO_RETRY; 61 62 switch (bo->type) { 63 case ttm_bo_type_device: 64 if (zero_alloc) 65 page_flags |= TTM_PAGE_FLAG_ZERO_ALLOC; 66 break; 67 case ttm_bo_type_kernel: 68 break; 69 case ttm_bo_type_sg: 70 page_flags |= TTM_PAGE_FLAG_SG; 71 break; 72 default: 73 pr_err("Illegal buffer object type\n"); 74 return -EINVAL; 75 } 76 77 bo->ttm = bdev->driver->ttm_tt_create(bo, page_flags); 78 if (unlikely(bo->ttm == NULL)) 79 return -ENOMEM; 80 81 return 0; 82 } 83 84 /** 85 * Allocates storage for pointers to the pages that back the ttm. 86 */ 87 static int ttm_tt_alloc_page_directory(struct ttm_tt *ttm) 88 { 89 ttm->pages = kvmalloc_array(ttm->num_pages, sizeof(void*), 90 GFP_KERNEL | __GFP_ZERO); 91 if (!ttm->pages) 92 return -ENOMEM; 93 return 0; 94 } 95 96 static int ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm) 97 { 98 ttm->ttm.pages = kvmalloc_array(ttm->ttm.num_pages, 99 sizeof(*ttm->ttm.pages) + 100 sizeof(*ttm->dma_address), 101 GFP_KERNEL | __GFP_ZERO); 102 if (!ttm->ttm.pages) 103 return -ENOMEM; 104 ttm->dma_address = (void *) (ttm->ttm.pages + ttm->ttm.num_pages); 105 return 0; 106 } 107 108 static int ttm_sg_tt_alloc_page_directory(struct ttm_dma_tt *ttm) 109 { 110 ttm->dma_address = kvmalloc_array(ttm->ttm.num_pages, 111 sizeof(*ttm->dma_address), 112 GFP_KERNEL | __GFP_ZERO); 113 if (!ttm->dma_address) 114 return -ENOMEM; 115 return 0; 116 } 117 118 static int ttm_tt_set_page_caching(struct page *p, 119 enum ttm_caching_state c_old, 120 enum ttm_caching_state c_new) 121 { 122 int ret = 0; 123 124 if (PageHighMem(p)) 125 return 0; 126 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. */ 130 131 ret = ttm_set_pages_wb(p, 1); 132 if (ret) 133 return ret; 134 } 135 136 if (c_new == tt_wc) 137 ret = ttm_set_pages_wc(p, 1); 138 else if (c_new == tt_uncached) 139 ret = ttm_set_pages_uc(p, 1); 140 141 return ret; 142 } 143 144 /* 145 * Change caching policy for the linear kernel map 146 * for range of pages in a ttm. 147 */ 148 149 static int ttm_tt_set_caching(struct ttm_tt *ttm, 150 enum ttm_caching_state c_state) 151 { 152 int i, j; 153 struct page *cur_page; 154 int ret; 155 156 if (ttm->caching_state == c_state) 157 return 0; 158 159 if (ttm->state == tt_unpopulated) { 160 /* Change caching but don't populate */ 161 ttm->caching_state = c_state; 162 return 0; 163 } 164 165 if (ttm->caching_state == tt_cached) 166 drm_clflush_pages(ttm->pages, ttm->num_pages); 167 168 for (i = 0; i < ttm->num_pages; ++i) { 169 cur_page = ttm->pages[i]; 170 if (likely(cur_page != NULL)) { 171 ret = ttm_tt_set_page_caching(cur_page, 172 ttm->caching_state, 173 c_state); 174 if (unlikely(ret != 0)) 175 goto out_err; 176 } 177 } 178 179 ttm->caching_state = c_state; 180 181 return 0; 182 183 out_err: 184 for (j = 0; j < i; ++j) { 185 cur_page = ttm->pages[j]; 186 if (likely(cur_page != NULL)) { 187 (void)ttm_tt_set_page_caching(cur_page, c_state, 188 ttm->caching_state); 189 } 190 } 191 192 return ret; 193 } 194 195 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement) 196 { 197 enum ttm_caching_state state; 198 199 if (placement & TTM_PL_FLAG_WC) 200 state = tt_wc; 201 else if (placement & TTM_PL_FLAG_UNCACHED) 202 state = tt_uncached; 203 else 204 state = tt_cached; 205 206 return ttm_tt_set_caching(ttm, state); 207 } 208 EXPORT_SYMBOL(ttm_tt_set_placement_caching); 209 210 void ttm_tt_destroy(struct ttm_tt *ttm) 211 { 212 if (ttm == NULL) 213 return; 214 215 ttm_tt_unbind(ttm); 216 217 if (ttm->state == tt_unbound) 218 ttm_tt_unpopulate(ttm); 219 220 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) && 221 ttm->swap_storage) 222 fput(ttm->swap_storage); 223 224 ttm->swap_storage = NULL; 225 ttm->func->destroy(ttm); 226 } 227 228 static void ttm_tt_init_fields(struct ttm_tt *ttm, 229 struct ttm_buffer_object *bo, 230 uint32_t page_flags) 231 { 232 ttm->bdev = bo->bdev; 233 ttm->num_pages = bo->num_pages; 234 ttm->caching_state = tt_cached; 235 ttm->page_flags = page_flags; 236 ttm->state = tt_unpopulated; 237 ttm->swap_storage = NULL; 238 ttm->sg = bo->sg; 239 } 240 241 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_buffer_object *bo, 242 uint32_t page_flags) 243 { 244 ttm_tt_init_fields(ttm, bo, page_flags); 245 246 if (ttm_tt_alloc_page_directory(ttm)) { 247 ttm_tt_destroy(ttm); 248 pr_err("Failed allocating page table\n"); 249 return -ENOMEM; 250 } 251 return 0; 252 } 253 EXPORT_SYMBOL(ttm_tt_init); 254 255 void ttm_tt_fini(struct ttm_tt *ttm) 256 { 257 kvfree(ttm->pages); 258 ttm->pages = NULL; 259 } 260 EXPORT_SYMBOL(ttm_tt_fini); 261 262 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo, 263 uint32_t page_flags) 264 { 265 struct ttm_tt *ttm = &ttm_dma->ttm; 266 267 ttm_tt_init_fields(ttm, bo, page_flags); 268 269 INIT_LIST_HEAD(&ttm_dma->pages_list); 270 if (ttm_dma_tt_alloc_page_directory(ttm_dma)) { 271 ttm_tt_destroy(ttm); 272 pr_err("Failed allocating page table\n"); 273 return -ENOMEM; 274 } 275 return 0; 276 } 277 EXPORT_SYMBOL(ttm_dma_tt_init); 278 279 int ttm_sg_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo, 280 uint32_t page_flags) 281 { 282 struct ttm_tt *ttm = &ttm_dma->ttm; 283 int ret; 284 285 ttm_tt_init_fields(ttm, bo, page_flags); 286 287 INIT_LIST_HEAD(&ttm_dma->pages_list); 288 if (page_flags & TTM_PAGE_FLAG_SG) 289 ret = ttm_sg_tt_alloc_page_directory(ttm_dma); 290 else 291 ret = ttm_dma_tt_alloc_page_directory(ttm_dma); 292 if (ret) { 293 ttm_tt_destroy(ttm); 294 pr_err("Failed allocating page table\n"); 295 return -ENOMEM; 296 } 297 return 0; 298 } 299 EXPORT_SYMBOL(ttm_sg_tt_init); 300 301 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma) 302 { 303 struct ttm_tt *ttm = &ttm_dma->ttm; 304 305 if (ttm->pages) 306 kvfree(ttm->pages); 307 else 308 kvfree(ttm_dma->dma_address); 309 ttm->pages = NULL; 310 ttm_dma->dma_address = NULL; 311 } 312 EXPORT_SYMBOL(ttm_dma_tt_fini); 313 314 void ttm_tt_unbind(struct ttm_tt *ttm) 315 { 316 int ret; 317 318 if (ttm->state == tt_bound) { 319 ret = ttm->func->unbind(ttm); 320 BUG_ON(ret); 321 ttm->state = tt_unbound; 322 } 323 } 324 325 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_resource *bo_mem, 326 struct ttm_operation_ctx *ctx) 327 { 328 int ret = 0; 329 330 if (!ttm) 331 return -EINVAL; 332 333 if (ttm->state == tt_bound) 334 return 0; 335 336 ret = ttm_tt_populate(ttm, ctx); 337 if (ret) 338 return ret; 339 340 ret = ttm->func->bind(ttm, bo_mem); 341 if (unlikely(ret != 0)) 342 return ret; 343 344 ttm->state = tt_bound; 345 346 return 0; 347 } 348 EXPORT_SYMBOL(ttm_tt_bind); 349 350 int ttm_tt_swapin(struct ttm_tt *ttm) 351 { 352 struct address_space *swap_space; 353 struct file *swap_storage; 354 struct page *from_page; 355 struct page *to_page; 356 int i; 357 int ret = -ENOMEM; 358 359 swap_storage = ttm->swap_storage; 360 BUG_ON(swap_storage == NULL); 361 362 swap_space = swap_storage->f_mapping; 363 364 for (i = 0; i < ttm->num_pages; ++i) { 365 gfp_t gfp_mask = mapping_gfp_mask(swap_space); 366 367 gfp_mask |= (ttm->page_flags & TTM_PAGE_FLAG_NO_RETRY ? __GFP_RETRY_MAYFAIL : 0); 368 from_page = shmem_read_mapping_page_gfp(swap_space, i, gfp_mask); 369 370 if (IS_ERR(from_page)) { 371 ret = PTR_ERR(from_page); 372 goto out_err; 373 } 374 to_page = ttm->pages[i]; 375 if (unlikely(to_page == NULL)) 376 goto out_err; 377 378 copy_highpage(to_page, from_page); 379 put_page(from_page); 380 } 381 382 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP)) 383 fput(swap_storage); 384 ttm->swap_storage = NULL; 385 ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED; 386 387 return 0; 388 out_err: 389 return ret; 390 } 391 392 int ttm_tt_swapout(struct ttm_tt *ttm, struct file *persistent_swap_storage) 393 { 394 struct address_space *swap_space; 395 struct file *swap_storage; 396 struct page *from_page; 397 struct page *to_page; 398 int i; 399 int ret = -ENOMEM; 400 401 BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated); 402 BUG_ON(ttm->caching_state != tt_cached); 403 404 if (!persistent_swap_storage) { 405 swap_storage = shmem_file_setup("ttm swap", 406 ttm->num_pages << PAGE_SHIFT, 407 0); 408 if (IS_ERR(swap_storage)) { 409 pr_err("Failed allocating swap storage\n"); 410 return PTR_ERR(swap_storage); 411 } 412 } else { 413 swap_storage = persistent_swap_storage; 414 } 415 416 swap_space = swap_storage->f_mapping; 417 418 for (i = 0; i < ttm->num_pages; ++i) { 419 gfp_t gfp_mask = mapping_gfp_mask(swap_space); 420 421 gfp_mask |= (ttm->page_flags & TTM_PAGE_FLAG_NO_RETRY ? __GFP_RETRY_MAYFAIL : 0); 422 423 from_page = ttm->pages[i]; 424 if (unlikely(from_page == NULL)) 425 continue; 426 427 to_page = shmem_read_mapping_page_gfp(swap_space, i, gfp_mask); 428 if (IS_ERR(to_page)) { 429 ret = PTR_ERR(to_page); 430 goto out_err; 431 } 432 copy_highpage(to_page, from_page); 433 set_page_dirty(to_page); 434 mark_page_accessed(to_page); 435 put_page(to_page); 436 } 437 438 ttm_tt_unpopulate(ttm); 439 ttm->swap_storage = swap_storage; 440 ttm->page_flags |= TTM_PAGE_FLAG_SWAPPED; 441 if (persistent_swap_storage) 442 ttm->page_flags |= TTM_PAGE_FLAG_PERSISTENT_SWAP; 443 444 return 0; 445 out_err: 446 if (!persistent_swap_storage) 447 fput(swap_storage); 448 449 return ret; 450 } 451 452 static void ttm_tt_add_mapping(struct ttm_tt *ttm) 453 { 454 pgoff_t i; 455 456 if (ttm->page_flags & TTM_PAGE_FLAG_SG) 457 return; 458 459 for (i = 0; i < ttm->num_pages; ++i) 460 ttm->pages[i]->mapping = ttm->bdev->dev_mapping; 461 } 462 463 int ttm_tt_populate(struct ttm_tt *ttm, struct ttm_operation_ctx *ctx) 464 { 465 int ret; 466 467 if (ttm->state != tt_unpopulated) 468 return 0; 469 470 if (ttm->bdev->driver->ttm_tt_populate) 471 ret = ttm->bdev->driver->ttm_tt_populate(ttm, ctx); 472 else 473 ret = ttm_pool_populate(ttm, ctx); 474 if (!ret) 475 ttm_tt_add_mapping(ttm); 476 return ret; 477 } 478 479 static void ttm_tt_clear_mapping(struct ttm_tt *ttm) 480 { 481 pgoff_t i; 482 struct page **page = ttm->pages; 483 484 if (ttm->page_flags & TTM_PAGE_FLAG_SG) 485 return; 486 487 for (i = 0; i < ttm->num_pages; ++i) { 488 (*page)->mapping = NULL; 489 (*page++)->index = 0; 490 } 491 } 492 493 void ttm_tt_unpopulate(struct ttm_tt *ttm) 494 { 495 if (ttm->state == tt_unpopulated) 496 return; 497 498 ttm_tt_clear_mapping(ttm); 499 if (ttm->bdev->driver->ttm_tt_unpopulate) 500 ttm->bdev->driver->ttm_tt_unpopulate(ttm); 501 else 502 ttm_pool_unpopulate(ttm); 503 } 504