drivers/gpu/drm/ttm/ttm_tt.c

   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 #define pr_fmt(fmt) "[TTM] " fmt
  32
  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>
  40 #ifdef CONFIG_X86
  41 #include <asm/set_memory.h>
  42 #endif
  43
  44 /**
  45  * Allocates a ttm structure for the given BO.
  46  */
  47 int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc)
  48 {
  49         struct ttm_bo_device *bdev = bo->bdev;
  50         uint32_t page_flags = 0;
  51
  52         reservation_object_assert_held(bo->resv);
  53
  54         if (bdev->need_dma32)
  55                 page_flags |= TTM_PAGE_FLAG_DMA32;
  56
  57         if (bdev->no_retry)
  58                 page_flags |= TTM_PAGE_FLAG_NO_RETRY;
  59
  60         switch (bo->type) {
  61         case ttm_bo_type_device:
  62                 if (zero_alloc)
  63                         page_flags |= TTM_PAGE_FLAG_ZERO_ALLOC;
  64                 break;
  65         case ttm_bo_type_kernel:
  66                 break;
  67         case ttm_bo_type_sg:
  68                 page_flags |= TTM_PAGE_FLAG_SG;
  69                 break;
  70         default:
  71                 bo->ttm = NULL;
  72                 pr_err("Illegal buffer object type\n");
  73                 return -EINVAL;
  74         }
  75
  76         bo->ttm = bdev->driver->ttm_tt_create(bo, page_flags);
  77         if (unlikely(bo->ttm == NULL))
  78                 return -ENOMEM;
  79
  80         return 0;
  81 }
  82
  83 /**
  84  * Allocates storage for pointers to the pages that back the ttm.
  85  */
  86 static int ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
  87 {
  88         ttm->pages = kvmalloc_array(ttm->num_pages, sizeof(void*),
  89                         GFP_KERNEL | __GFP_ZERO);
  90         if (!ttm->pages)
  91                 return -ENOMEM;
  92         return 0;
  93 }
  94
  95 static int ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
  96 {
  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);
 101         if (!ttm->ttm.pages)
 102                 return -ENOMEM;
 103         ttm->dma_address = (void *) (ttm->ttm.pages + ttm->ttm.num_pages);
 104         return 0;
 105 }
 106
 107 static int ttm_sg_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
 108 {
 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)
 113                 return -ENOMEM;
 114         return 0;
 115 }
 116
 117 #ifdef CONFIG_X86
 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)
 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 = set_pages_wb(p, 1);
 132                 if (ret)
 133                         return ret;
 134         }
 135
 136         if (c_new == tt_wc)
 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);
 140
 141         return ret;
 142 }
 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)
 147 {
 148         return 0;
 149 }
 150 #endif /* CONFIG_X86 */
 151
 152 /*
 153  * Change caching policy for the linear kernel map
 154  * for range of pages in a ttm.
 155  */
 156
 157 static int ttm_tt_set_caching(struct ttm_tt *ttm,
 158                               enum ttm_caching_state c_state)
 159 {
 160         int i, j;
 161         struct page *cur_page;
 162         int ret;
 163
 164         if (ttm->caching_state == c_state)
 165                 return 0;
 166
 167         if (ttm->state == tt_unpopulated) {
 168                 /* Change caching but don't populate */
 169                 ttm->caching_state = c_state;
 170                 return 0;
 171         }
 172
 173         if (ttm->caching_state == tt_cached)
 174                 drm_clflush_pages(ttm->pages, ttm->num_pages);
 175
 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,
 180                                                       ttm->caching_state,
 181                                                       c_state);
 182                         if (unlikely(ret != 0))
 183                                 goto out_err;
 184                 }
 185         }
 186
 187         ttm->caching_state = c_state;
 188
 189         return 0;
 190
 191 out_err:
 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,
 196                                                       ttm->caching_state);
 197                 }
 198         }
 199
 200         return ret;
 201 }
 202
 203 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement)
 204 {
 205         enum ttm_caching_state state;
 206
 207         if (placement & TTM_PL_FLAG_WC)
 208                 state = tt_wc;
 209         else if (placement & TTM_PL_FLAG_UNCACHED)
 210                 state = tt_uncached;
 211         else
 212                 state = tt_cached;
 213
 214         return ttm_tt_set_caching(ttm, state);
 215 }
 216 EXPORT_SYMBOL(ttm_tt_set_placement_caching);
 217
 218 void ttm_tt_destroy(struct ttm_tt *ttm)
 219 {
 220         if (ttm == NULL)
 221                 return;
 222
 223         ttm_tt_unbind(ttm);
 224
 225         if (ttm->state == tt_unbound)
 226                 ttm_tt_unpopulate(ttm);
 227
 228         if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) &&
 229             ttm->swap_storage)
 230                 fput(ttm->swap_storage);
 231
 232         ttm->swap_storage = NULL;
 233         ttm->func->destroy(ttm);
 234 }
 235
 236 void ttm_tt_init_fields(struct ttm_tt *ttm, struct ttm_buffer_object *bo,
 237                         uint32_t page_flags)
 238 {
 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;
 245         ttm->sg = bo->sg;
 246 }
 247
 248 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_buffer_object *bo,
 249                 uint32_t page_flags)
 250 {
 251         ttm_tt_init_fields(ttm, bo, page_flags);
 252
 253         if (ttm_tt_alloc_page_directory(ttm)) {
 254                 ttm_tt_destroy(ttm);
 255                 pr_err("Failed allocating page table\n");
 256                 return -ENOMEM;
 257         }
 258         return 0;
 259 }
 260 EXPORT_SYMBOL(ttm_tt_init);
 261
 262 void ttm_tt_fini(struct ttm_tt *ttm)
 263 {
 264         kvfree(ttm->pages);
 265         ttm->pages = NULL;
 266 }
 267 EXPORT_SYMBOL(ttm_tt_fini);
 268
 269 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo,
 270                     uint32_t page_flags)
 271 {
 272         struct ttm_tt *ttm = &ttm_dma->ttm;
 273
 274         ttm_tt_init_fields(ttm, bo, page_flags);
 275
 276         INIT_LIST_HEAD(&ttm_dma->pages_list);
 277         if (ttm_dma_tt_alloc_page_directory(ttm_dma)) {
 278                 ttm_tt_destroy(ttm);
 279                 pr_err("Failed allocating page table\n");
 280                 return -ENOMEM;
 281         }
 282         return 0;
 283 }
 284 EXPORT_SYMBOL(ttm_dma_tt_init);
 285
 286 int ttm_sg_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo,
 287                    uint32_t page_flags)
 288 {
 289         struct ttm_tt *ttm = &ttm_dma->ttm;
 290         int ret;
 291
 292         ttm_tt_init_fields(ttm, bo, page_flags);
 293
 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);
 297         else
 298                 ret = ttm_dma_tt_alloc_page_directory(ttm_dma);
 299         if (ret) {
 300                 ttm_tt_destroy(ttm);
 301                 pr_err("Failed allocating page table\n");
 302                 return -ENOMEM;
 303         }
 304         return 0;
 305 }
 306 EXPORT_SYMBOL(ttm_sg_tt_init);
 307
 308 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma)
 309 {
 310         struct ttm_tt *ttm = &ttm_dma->ttm;
 311
 312         if (ttm->pages)
 313                 kvfree(ttm->pages);
 314         else
 315                 kvfree(ttm_dma->dma_address);
 316         ttm->pages = NULL;
 317         ttm_dma->dma_address = NULL;
 318 }
 319 EXPORT_SYMBOL(ttm_dma_tt_fini);
 320
 321 void ttm_tt_unbind(struct ttm_tt *ttm)
 322 {
 323         int ret;
 324
 325         if (ttm->state == tt_bound) {
 326                 ret = ttm->func->unbind(ttm);
 327                 BUG_ON(ret);
 328                 ttm->state = tt_unbound;
 329         }
 330 }
 331
 332 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem,
 333                 struct ttm_operation_ctx *ctx)
 334 {
 335         int ret = 0;
 336
 337         if (!ttm)
 338                 return -EINVAL;
 339
 340         if (ttm->state == tt_bound)
 341                 return 0;
 342
 343         ret = ttm_tt_populate(ttm, ctx);
 344         if (ret)
 345                 return ret;
 346
 347         ret = ttm->func->bind(ttm, bo_mem);
 348         if (unlikely(ret != 0))
 349                 return ret;
 350
 351         ttm->state = tt_bound;
 352
 353         return 0;
 354 }
 355 EXPORT_SYMBOL(ttm_tt_bind);
 356
 357 int ttm_tt_swapin(struct ttm_tt *ttm)
 358 {
 359         struct address_space *swap_space;
 360         struct file *swap_storage;
 361         struct page *from_page;
 362         struct page *to_page;
 363         int i;
 364         int ret = -ENOMEM;
 365
 366         swap_storage = ttm->swap_storage;
 367         BUG_ON(swap_storage == NULL);
 368
 369         swap_space = swap_storage->f_mapping;
 370
 371         for (i = 0; i < ttm->num_pages; ++i) {
 372                 gfp_t gfp_mask = mapping_gfp_mask(swap_space);
 373
 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);
 376
 377                 if (IS_ERR(from_page)) {
 378                         ret = PTR_ERR(from_page);
 379                         goto out_err;
 380                 }
 381                 to_page = ttm->pages[i];
 382                 if (unlikely(to_page == NULL))
 383                         goto out_err;
 384
 385                 copy_highpage(to_page, from_page);
 386                 put_page(from_page);
 387         }
 388
 389         if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP))
 390                 fput(swap_storage);
 391         ttm->swap_storage = NULL;
 392         ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED;
 393
 394         return 0;
 395 out_err:
 396         return ret;
 397 }
 398
 399 int ttm_tt_swapout(struct ttm_tt *ttm, struct file *persistent_swap_storage)
 400 {
 401         struct address_space *swap_space;
 402         struct file *swap_storage;
 403         struct page *from_page;
 404         struct page *to_page;
 405         int i;
 406         int ret = -ENOMEM;
 407
 408         BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated);
 409         BUG_ON(ttm->caching_state != tt_cached);
 410
 411         if (!persistent_swap_storage) {
 412                 swap_storage = shmem_file_setup("ttm swap",
 413                                                 ttm->num_pages << PAGE_SHIFT,
 414                                                 0);
 415                 if (IS_ERR(swap_storage)) {
 416                         pr_err("Failed allocating swap storage\n");
 417                         return PTR_ERR(swap_storage);
 418                 }
 419         } else {
 420                 swap_storage = persistent_swap_storage;
 421         }
 422
 423         swap_space = swap_storage->f_mapping;
 424
 425         for (i = 0; i < ttm->num_pages; ++i) {
 426                 gfp_t gfp_mask = mapping_gfp_mask(swap_space);
 427
 428                 gfp_mask |= (ttm->page_flags & TTM_PAGE_FLAG_NO_RETRY ? __GFP_RETRY_MAYFAIL : 0);
 429
 430                 from_page = ttm->pages[i];
 431                 if (unlikely(from_page == NULL))
 432                         continue;
 433
 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);
 437                         goto out_err;
 438                 }
 439                 copy_highpage(to_page, from_page);
 440                 set_page_dirty(to_page);
 441                 mark_page_accessed(to_page);
 442                 put_page(to_page);
 443         }
 444
 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;
 450
 451         return 0;
 452 out_err:
 453         if (!persistent_swap_storage)
 454                 fput(swap_storage);
 455
 456         return ret;
 457 }
 458
 459 static void ttm_tt_add_mapping(struct ttm_tt *ttm)
 460 {
 461         pgoff_t i;
 462
 463         if (ttm->page_flags & TTM_PAGE_FLAG_SG)
 464                 return;
 465
 466         for (i = 0; i < ttm->num_pages; ++i)
 467                 ttm->pages[i]->mapping = ttm->bdev->dev_mapping;
 468 }
 469
 470 int ttm_tt_populate(struct ttm_tt *ttm, struct ttm_operation_ctx *ctx)
 471 {
 472         int ret;
 473
 474         if (ttm->state != tt_unpopulated)
 475                 return 0;
 476
 477         if (ttm->bdev->driver->ttm_tt_populate)
 478                 ret = ttm->bdev->driver->ttm_tt_populate(ttm, ctx);
 479         else
 480                 ret = ttm_pool_populate(ttm, ctx);
 481         if (!ret)
 482                 ttm_tt_add_mapping(ttm);
 483         return ret;
 484 }
 485
 486 static void ttm_tt_clear_mapping(struct ttm_tt *ttm)
 487 {
 488         pgoff_t i;
 489         struct page **page = ttm->pages;
 490
 491         if (ttm->page_flags & TTM_PAGE_FLAG_SG)
 492                 return;
 493
 494         for (i = 0; i < ttm->num_pages; ++i) {
 495                 (*page)->mapping = NULL;
 496                 (*page++)->index = 0;
 497         }
 498 }
 499
 500 void ttm_tt_unpopulate(struct ttm_tt *ttm)
 501 {
 502         if (ttm->state == tt_unpopulated)
 503                 return;
 504
 505         ttm_tt_clear_mapping(ttm);
 506         if (ttm->bdev->driver->ttm_tt_unpopulate)
 507                 ttm->bdev->driver->ttm_tt_unpopulate(ttm);
 508         else
 509                 ttm_pool_unpopulate(ttm);
 510 }