drivers/gpu/drm/amd/amdgpu/amdgpu_object.c

   1 /*
   2  * Copyright 2009 Jerome Glisse.
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  16  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  17  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  18  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * The above copyright notice and this permission notice (including the
  22  * next paragraph) shall be included in all copies or substantial portions
  23  * of the Software.
  24  *
  25  */
  26 /*
  27  * Authors:
  28  *    Jerome Glisse <[email protected]>
  29  *    Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
  30  *    Dave Airlie
  31  */
  32 #include <linux/list.h>
  33 #include <linux/slab.h>
  34 #include <linux/dma-buf.h>
  35
  36 #include <drm/amdgpu_drm.h>
  37 #include <drm/drm_cache.h>
  38 #include "amdgpu.h"
  39 #include "amdgpu_trace.h"
  40 #include "amdgpu_amdkfd.h"
  41
  42 /**
  43  * DOC: amdgpu_object
  44  *
  45  * This defines the interfaces to operate on an &amdgpu_bo buffer object which
  46  * represents memory used by driver (VRAM, system memory, etc.). The driver
  47  * provides DRM/GEM APIs to userspace. DRM/GEM APIs then use these interfaces
  48  * to create/destroy/set buffer object which are then managed by the kernel TTM
  49  * memory manager.
  50  * The interfaces are also used internally by kernel clients, including gfx,
  51  * uvd, etc. for kernel managed allocations used by the GPU.
  52  *
  53  */
  54
  55 /**
  56  * amdgpu_bo_subtract_pin_size - Remove BO from pin_size accounting
  57  *
  58  * @bo: &amdgpu_bo buffer object
  59  *
  60  * This function is called when a BO stops being pinned, and updates the
  61  * &amdgpu_device pin_size values accordingly.
  62  */
  63 static void amdgpu_bo_subtract_pin_size(struct amdgpu_bo *bo)
  64 {
  65         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
  66
  67         if (bo->tbo.mem.mem_type == TTM_PL_VRAM) {
  68                 atomic64_sub(amdgpu_bo_size(bo), &adev->vram_pin_size);
  69                 atomic64_sub(amdgpu_vram_mgr_bo_visible_size(bo),
  70                              &adev->visible_pin_size);
  71         } else if (bo->tbo.mem.mem_type == TTM_PL_TT) {
  72                 atomic64_sub(amdgpu_bo_size(bo), &adev->gart_pin_size);
  73         }
  74 }
  75
  76 static void amdgpu_bo_destroy(struct ttm_buffer_object *tbo)
  77 {
  78         struct amdgpu_device *adev = amdgpu_ttm_adev(tbo->bdev);
  79         struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
  80
  81         if (bo->tbo.pin_count > 0)
  82                 amdgpu_bo_subtract_pin_size(bo);
  83
  84         amdgpu_bo_kunmap(bo);
  85
  86         if (bo->tbo.base.import_attach)
  87                 drm_prime_gem_destroy(&bo->tbo.base, bo->tbo.sg);
  88         drm_gem_object_release(&bo->tbo.base);
  89         /* in case amdgpu_device_recover_vram got NULL of bo->parent */
  90         if (!list_empty(&bo->shadow_list)) {
  91                 mutex_lock(&adev->shadow_list_lock);
  92                 list_del_init(&bo->shadow_list);
  93                 mutex_unlock(&adev->shadow_list_lock);
  94         }
  95         amdgpu_bo_unref(&bo->parent);
  96
  97         kfree(bo->metadata);
  98         kfree(bo);
  99 }
 100
 101 /**
 102  * amdgpu_bo_is_amdgpu_bo - check if the buffer object is an &amdgpu_bo
 103  * @bo: buffer object to be checked
 104  *
 105  * Uses destroy function associated with the object to determine if this is
 106  * an &amdgpu_bo.
 107  *
 108  * Returns:
 109  * true if the object belongs to &amdgpu_bo, false if not.
 110  */
 111 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo)
 112 {
 113         if (bo->destroy == &amdgpu_bo_destroy)
 114                 return true;
 115         return false;
 116 }
 117
 118 /**
 119  * amdgpu_bo_placement_from_domain - set buffer's placement
 120  * @abo: &amdgpu_bo buffer object whose placement is to be set
 121  * @domain: requested domain
 122  *
 123  * Sets buffer's placement according to requested domain and the buffer's
 124  * flags.
 125  */
 126 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain)
 127 {
 128         struct amdgpu_device *adev = amdgpu_ttm_adev(abo->tbo.bdev);
 129         struct ttm_placement *placement = &abo->placement;
 130         struct ttm_place *places = abo->placements;
 131         u64 flags = abo->flags;
 132         u32 c = 0;
 133
 134         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 135                 unsigned visible_pfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
 136
 137                 places[c].fpfn = 0;
 138                 places[c].lpfn = 0;
 139                 places[c].mem_type = TTM_PL_VRAM;
 140                 places[c].flags = 0;
 141
 142                 if (flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
 143                         places[c].lpfn = visible_pfn;
 144                 else
 145                         places[c].flags |= TTM_PL_FLAG_TOPDOWN;
 146
 147                 if (flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS)
 148                         places[c].flags |= TTM_PL_FLAG_CONTIGUOUS;
 149                 c++;
 150         }
 151
 152         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 153                 places[c].fpfn = 0;
 154                 places[c].lpfn = 0;
 155                 places[c].mem_type = TTM_PL_TT;
 156                 places[c].flags = 0;
 157                 c++;
 158         }
 159
 160         if (domain & AMDGPU_GEM_DOMAIN_CPU) {
 161                 places[c].fpfn = 0;
 162                 places[c].lpfn = 0;
 163                 places[c].mem_type = TTM_PL_SYSTEM;
 164                 places[c].flags = 0;
 165                 c++;
 166         }
 167
 168         if (domain & AMDGPU_GEM_DOMAIN_GDS) {
 169                 places[c].fpfn = 0;
 170                 places[c].lpfn = 0;
 171                 places[c].mem_type = AMDGPU_PL_GDS;
 172                 places[c].flags = 0;
 173                 c++;
 174         }
 175
 176         if (domain & AMDGPU_GEM_DOMAIN_GWS) {
 177                 places[c].fpfn = 0;
 178                 places[c].lpfn = 0;
 179                 places[c].mem_type = AMDGPU_PL_GWS;
 180                 places[c].flags = 0;
 181                 c++;
 182         }
 183
 184         if (domain & AMDGPU_GEM_DOMAIN_OA) {
 185                 places[c].fpfn = 0;
 186                 places[c].lpfn = 0;
 187                 places[c].mem_type = AMDGPU_PL_OA;
 188                 places[c].flags = 0;
 189                 c++;
 190         }
 191
 192         if (!c) {
 193                 places[c].fpfn = 0;
 194                 places[c].lpfn = 0;
 195                 places[c].mem_type = TTM_PL_SYSTEM;
 196                 places[c].flags = 0;
 197                 c++;
 198         }
 199
 200         BUG_ON(c >= AMDGPU_BO_MAX_PLACEMENTS);
 201
 202         placement->num_placement = c;
 203         placement->placement = places;
 204
 205         placement->num_busy_placement = c;
 206         placement->busy_placement = places;
 207 }
 208
 209 /**
 210  * amdgpu_bo_create_reserved - create reserved BO for kernel use
 211  *
 212  * @adev: amdgpu device object
 213  * @size: size for the new BO
 214  * @align: alignment for the new BO
 215  * @domain: where to place it
 216  * @bo_ptr: used to initialize BOs in structures
 217  * @gpu_addr: GPU addr of the pinned BO
 218  * @cpu_addr: optional CPU address mapping
 219  *
 220  * Allocates and pins a BO for kernel internal use, and returns it still
 221  * reserved.
 222  *
 223  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 224  *
 225  * Returns:
 226  * 0 on success, negative error code otherwise.
 227  */
 228 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
 229                               unsigned long size, int align,
 230                               u32 domain, struct amdgpu_bo **bo_ptr,
 231                               u64 *gpu_addr, void **cpu_addr)
 232 {
 233         struct amdgpu_bo_param bp;
 234         bool free = false;
 235         int r;
 236
 237         if (!size) {
 238                 amdgpu_bo_unref(bo_ptr);
 239                 return 0;
 240         }
 241
 242         memset(&bp, 0, sizeof(bp));
 243         bp.size = size;
 244         bp.byte_align = align;
 245         bp.domain = domain;
 246         bp.flags = cpu_addr ? AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED
 247                 : AMDGPU_GEM_CREATE_NO_CPU_ACCESS;
 248         bp.flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 249         bp.type = ttm_bo_type_kernel;
 250         bp.resv = NULL;
 251
 252         if (!*bo_ptr) {
 253                 r = amdgpu_bo_create(adev, &bp, bo_ptr);
 254                 if (r) {
 255                         dev_err(adev->dev, "(%d) failed to allocate kernel bo\n",
 256                                 r);
 257                         return r;
 258                 }
 259                 free = true;
 260         }
 261
 262         r = amdgpu_bo_reserve(*bo_ptr, false);
 263         if (r) {
 264                 dev_err(adev->dev, "(%d) failed to reserve kernel bo\n", r);
 265                 goto error_free;
 266         }
 267
 268         r = amdgpu_bo_pin(*bo_ptr, domain);
 269         if (r) {
 270                 dev_err(adev->dev, "(%d) kernel bo pin failed\n", r);
 271                 goto error_unreserve;
 272         }
 273
 274         r = amdgpu_ttm_alloc_gart(&(*bo_ptr)->tbo);
 275         if (r) {
 276                 dev_err(adev->dev, "%p bind failed\n", *bo_ptr);
 277                 goto error_unpin;
 278         }
 279
 280         if (gpu_addr)
 281                 *gpu_addr = amdgpu_bo_gpu_offset(*bo_ptr);
 282
 283         if (cpu_addr) {
 284                 r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
 285                 if (r) {
 286                         dev_err(adev->dev, "(%d) kernel bo map failed\n", r);
 287                         goto error_unpin;
 288                 }
 289         }
 290
 291         return 0;
 292
 293 error_unpin:
 294         amdgpu_bo_unpin(*bo_ptr);
 295 error_unreserve:
 296         amdgpu_bo_unreserve(*bo_ptr);
 297
 298 error_free:
 299         if (free)
 300                 amdgpu_bo_unref(bo_ptr);
 301
 302         return r;
 303 }
 304
 305 /**
 306  * amdgpu_bo_create_kernel - create BO for kernel use
 307  *
 308  * @adev: amdgpu device object
 309  * @size: size for the new BO
 310  * @align: alignment for the new BO
 311  * @domain: where to place it
 312  * @bo_ptr:  used to initialize BOs in structures
 313  * @gpu_addr: GPU addr of the pinned BO
 314  * @cpu_addr: optional CPU address mapping
 315  *
 316  * Allocates and pins a BO for kernel internal use.
 317  *
 318  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 319  *
 320  * Returns:
 321  * 0 on success, negative error code otherwise.
 322  */
 323 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 324                             unsigned long size, int align,
 325                             u32 domain, struct amdgpu_bo **bo_ptr,
 326                             u64 *gpu_addr, void **cpu_addr)
 327 {
 328         int r;
 329
 330         r = amdgpu_bo_create_reserved(adev, size, align, domain, bo_ptr,
 331                                       gpu_addr, cpu_addr);
 332
 333         if (r)
 334                 return r;
 335
 336         if (*bo_ptr)
 337                 amdgpu_bo_unreserve(*bo_ptr);
 338
 339         return 0;
 340 }
 341
 342 /**
 343  * amdgpu_bo_create_kernel_at - create BO for kernel use at specific location
 344  *
 345  * @adev: amdgpu device object
 346  * @offset: offset of the BO
 347  * @size: size of the BO
 348  * @domain: where to place it
 349  * @bo_ptr:  used to initialize BOs in structures
 350  * @cpu_addr: optional CPU address mapping
 351  *
 352  * Creates a kernel BO at a specific offset in the address space of the domain.
 353  *
 354  * Returns:
 355  * 0 on success, negative error code otherwise.
 356  */
 357 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
 358                                uint64_t offset, uint64_t size, uint32_t domain,
 359                                struct amdgpu_bo **bo_ptr, void **cpu_addr)
 360 {
 361         struct ttm_operation_ctx ctx = { false, false };
 362         unsigned int i;
 363         int r;
 364
 365         offset &= PAGE_MASK;
 366         size = ALIGN(size, PAGE_SIZE);
 367
 368         r = amdgpu_bo_create_reserved(adev, size, PAGE_SIZE, domain, bo_ptr,
 369                                       NULL, cpu_addr);
 370         if (r)
 371                 return r;
 372
 373         if ((*bo_ptr) == NULL)
 374                 return 0;
 375
 376         /*
 377          * Remove the original mem node and create a new one at the request
 378          * position.
 379          */
 380         if (cpu_addr)
 381                 amdgpu_bo_kunmap(*bo_ptr);
 382
 383         ttm_resource_free(&(*bo_ptr)->tbo, &(*bo_ptr)->tbo.mem);
 384
 385         for (i = 0; i < (*bo_ptr)->placement.num_placement; ++i) {
 386                 (*bo_ptr)->placements[i].fpfn = offset >> PAGE_SHIFT;
 387                 (*bo_ptr)->placements[i].lpfn = (offset + size) >> PAGE_SHIFT;
 388         }
 389         r = ttm_bo_mem_space(&(*bo_ptr)->tbo, &(*bo_ptr)->placement,
 390                              &(*bo_ptr)->tbo.mem, &ctx);
 391         if (r)
 392                 goto error;
 393
 394         if (cpu_addr) {
 395                 r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
 396                 if (r)
 397                         goto error;
 398         }
 399
 400         amdgpu_bo_unreserve(*bo_ptr);
 401         return 0;
 402
 403 error:
 404         amdgpu_bo_unreserve(*bo_ptr);
 405         amdgpu_bo_unref(bo_ptr);
 406         return r;
 407 }
 408
 409 /**
 410  * amdgpu_bo_free_kernel - free BO for kernel use
 411  *
 412  * @bo: amdgpu BO to free
 413  * @gpu_addr: pointer to where the BO's GPU memory space address was stored
 414  * @cpu_addr: pointer to where the BO's CPU memory space address was stored
 415  *
 416  * unmaps and unpin a BO for kernel internal use.
 417  */
 418 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 419                            void **cpu_addr)
 420 {
 421         if (*bo == NULL)
 422                 return;
 423
 424         if (likely(amdgpu_bo_reserve(*bo, true) == 0)) {
 425                 if (cpu_addr)
 426                         amdgpu_bo_kunmap(*bo);
 427
 428                 amdgpu_bo_unpin(*bo);
 429                 amdgpu_bo_unreserve(*bo);
 430         }
 431         amdgpu_bo_unref(bo);
 432
 433         if (gpu_addr)
 434                 *gpu_addr = 0;
 435
 436         if (cpu_addr)
 437                 *cpu_addr = NULL;
 438 }
 439
 440 /* Validate bo size is bit bigger then the request domain */
 441 static bool amdgpu_bo_validate_size(struct amdgpu_device *adev,
 442                                           unsigned long size, u32 domain)
 443 {
 444         struct ttm_resource_manager *man = NULL;
 445
 446         /*
 447          * If GTT is part of requested domains the check must succeed to
 448          * allow fall back to GTT
 449          */
 450         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 451                 man = ttm_manager_type(&adev->mman.bdev, TTM_PL_TT);
 452
 453                 if (size < (man->size << PAGE_SHIFT))
 454                         return true;
 455                 else
 456                         goto fail;
 457         }
 458
 459         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 460                 man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
 461
 462                 if (size < (man->size << PAGE_SHIFT))
 463                         return true;
 464                 else
 465                         goto fail;
 466         }
 467
 468
 469         /* TODO add more domains checks, such as AMDGPU_GEM_DOMAIN_CPU */
 470         return true;
 471
 472 fail:
 473         DRM_DEBUG("BO size %lu > total memory in domain: %llu\n", size,
 474                   man->size << PAGE_SHIFT);
 475         return false;
 476 }
 477
 478 bool amdgpu_bo_support_uswc(u64 bo_flags)
 479 {
 480
 481 #ifdef CONFIG_X86_32
 482         /* XXX: Write-combined CPU mappings of GTT seem broken on 32-bit
 483          * See https://bugs.freedesktop.org/show_bug.cgi?id=84627
 484          */
 485         return false;
 486 #elif defined(CONFIG_X86) && !defined(CONFIG_X86_PAT)
 487         /* Don't try to enable write-combining when it can't work, or things
 488          * may be slow
 489          * See https://bugs.freedesktop.org/show_bug.cgi?id=88758
 490          */
 491
 492 #ifndef CONFIG_COMPILE_TEST
 493 #warning Please enable CONFIG_MTRR and CONFIG_X86_PAT for better performance \
 494          thanks to write-combining
 495 #endif
 496
 497         if (bo_flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
 498                 DRM_INFO_ONCE("Please enable CONFIG_MTRR and CONFIG_X86_PAT for "
 499                               "better performance thanks to write-combining\n");
 500         return false;
 501 #else
 502         /* For architectures that don't support WC memory,
 503          * mask out the WC flag from the BO
 504          */
 505         if (!drm_arch_can_wc_memory())
 506                 return false;
 507
 508         return true;
 509 #endif
 510 }
 511
 512 static int amdgpu_bo_do_create(struct amdgpu_device *adev,
 513                                struct amdgpu_bo_param *bp,
 514                                struct amdgpu_bo **bo_ptr)
 515 {
 516         struct ttm_operation_ctx ctx = {
 517                 .interruptible = (bp->type != ttm_bo_type_kernel),
 518                 .no_wait_gpu = bp->no_wait_gpu,
 519                 /* We opt to avoid OOM on system pages allocations */
 520                 .gfp_retry_mayfail = true,
 521                 .allow_res_evict = bp->type != ttm_bo_type_kernel,
 522                 .resv = bp->resv
 523         };
 524         struct amdgpu_bo *bo;
 525         unsigned long page_align, size = bp->size;
 526         int r;
 527
 528         /* Note that GDS/GWS/OA allocates 1 page per byte/resource. */
 529         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA)) {
 530                 /* GWS and OA don't need any alignment. */
 531                 page_align = bp->byte_align;
 532                 size <<= PAGE_SHIFT;
 533         } else if (bp->domain & AMDGPU_GEM_DOMAIN_GDS) {
 534                 /* Both size and alignment must be a multiple of 4. */
 535                 page_align = ALIGN(bp->byte_align, 4);
 536                 size = ALIGN(size, 4) << PAGE_SHIFT;
 537         } else {
 538                 /* Memory should be aligned at least to a page size. */
 539                 page_align = ALIGN(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
 540                 size = ALIGN(size, PAGE_SIZE);
 541         }
 542
 543         if (!amdgpu_bo_validate_size(adev, size, bp->domain))
 544                 return -ENOMEM;
 545
 546         *bo_ptr = NULL;
 547
 548         bo = kzalloc(sizeof(struct amdgpu_bo), GFP_KERNEL);
 549         if (bo == NULL)
 550                 return -ENOMEM;
 551         drm_gem_private_object_init(adev_to_drm(adev), &bo->tbo.base, size);
 552         INIT_LIST_HEAD(&bo->shadow_list);
 553         bo->vm_bo = NULL;
 554         bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
 555                 bp->domain;
 556         bo->allowed_domains = bo->preferred_domains;
 557         if (bp->type != ttm_bo_type_kernel &&
 558             bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
 559                 bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
 560
 561         bo->flags = bp->flags;
 562
 563         if (!amdgpu_bo_support_uswc(bo->flags))
 564                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 565
 566         bo->tbo.bdev = &adev->mman.bdev;
 567         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA |
 568                           AMDGPU_GEM_DOMAIN_GDS))
 569                 amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_CPU);
 570         else
 571                 amdgpu_bo_placement_from_domain(bo, bp->domain);
 572         if (bp->type == ttm_bo_type_kernel)
 573                 bo->tbo.priority = 1;
 574
 575         r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, size, bp->type,
 576                                  &bo->placement, page_align, &ctx,  NULL,
 577                                  bp->resv, &amdgpu_bo_destroy);
 578         if (unlikely(r != 0))
 579                 return r;
 580
 581         if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
 582             bo->tbo.mem.mem_type == TTM_PL_VRAM &&
 583             bo->tbo.mem.start < adev->gmc.visible_vram_size >> PAGE_SHIFT)
 584                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
 585                                              ctx.bytes_moved);
 586         else
 587                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
 588
 589         if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
 590             bo->tbo.mem.mem_type == TTM_PL_VRAM) {
 591                 struct dma_fence *fence;
 592
 593                 r = amdgpu_fill_buffer(bo, 0, bo->tbo.base.resv, &fence);
 594                 if (unlikely(r))
 595                         goto fail_unreserve;
 596
 597                 amdgpu_bo_fence(bo, fence, false);
 598                 dma_fence_put(bo->tbo.moving);
 599                 bo->tbo.moving = dma_fence_get(fence);
 600                 dma_fence_put(fence);
 601         }
 602         if (!bp->resv)
 603                 amdgpu_bo_unreserve(bo);
 604         *bo_ptr = bo;
 605
 606         trace_amdgpu_bo_create(bo);
 607
 608         /* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
 609         if (bp->type == ttm_bo_type_device)
 610                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 611
 612         return 0;
 613
 614 fail_unreserve:
 615         if (!bp->resv)
 616                 dma_resv_unlock(bo->tbo.base.resv);
 617         amdgpu_bo_unref(&bo);
 618         return r;
 619 }
 620
 621 static int amdgpu_bo_create_shadow(struct amdgpu_device *adev,
 622                                    unsigned long size,
 623                                    struct amdgpu_bo *bo)
 624 {
 625         struct amdgpu_bo_param bp;
 626         int r;
 627
 628         if (bo->shadow)
 629                 return 0;
 630
 631         memset(&bp, 0, sizeof(bp));
 632         bp.size = size;
 633         bp.domain = AMDGPU_GEM_DOMAIN_GTT;
 634         bp.flags = AMDGPU_GEM_CREATE_CPU_GTT_USWC |
 635                 AMDGPU_GEM_CREATE_SHADOW;
 636         bp.type = ttm_bo_type_kernel;
 637         bp.resv = bo->tbo.base.resv;
 638
 639         r = amdgpu_bo_do_create(adev, &bp, &bo->shadow);
 640         if (!r) {
 641                 bo->shadow->parent = amdgpu_bo_ref(bo);
 642                 mutex_lock(&adev->shadow_list_lock);
 643                 list_add_tail(&bo->shadow->shadow_list, &adev->shadow_list);
 644                 mutex_unlock(&adev->shadow_list_lock);
 645         }
 646
 647         return r;
 648 }
 649
 650 /**
 651  * amdgpu_bo_create - create an &amdgpu_bo buffer object
 652  * @adev: amdgpu device object
 653  * @bp: parameters to be used for the buffer object
 654  * @bo_ptr: pointer to the buffer object pointer
 655  *
 656  * Creates an &amdgpu_bo buffer object; and if requested, also creates a
 657  * shadow object.
 658  * Shadow object is used to backup the original buffer object, and is always
 659  * in GTT.
 660  *
 661  * Returns:
 662  * 0 for success or a negative error code on failure.
 663  */
 664 int amdgpu_bo_create(struct amdgpu_device *adev,
 665                      struct amdgpu_bo_param *bp,
 666                      struct amdgpu_bo **bo_ptr)
 667 {
 668         u64 flags = bp->flags;
 669         int r;
 670
 671         bp->flags = bp->flags & ~AMDGPU_GEM_CREATE_SHADOW;
 672         r = amdgpu_bo_do_create(adev, bp, bo_ptr);
 673         if (r)
 674                 return r;
 675
 676         if ((flags & AMDGPU_GEM_CREATE_SHADOW) && !(adev->flags & AMD_IS_APU)) {
 677                 if (!bp->resv)
 678                         WARN_ON(dma_resv_lock((*bo_ptr)->tbo.base.resv,
 679                                                         NULL));
 680
 681                 r = amdgpu_bo_create_shadow(adev, bp->size, *bo_ptr);
 682
 683                 if (!bp->resv)
 684                         dma_resv_unlock((*bo_ptr)->tbo.base.resv);
 685
 686                 if (r)
 687                         amdgpu_bo_unref(bo_ptr);
 688         }
 689
 690         return r;
 691 }
 692
 693 /**
 694  * amdgpu_bo_validate - validate an &amdgpu_bo buffer object
 695  * @bo: pointer to the buffer object
 696  *
 697  * Sets placement according to domain; and changes placement and caching
 698  * policy of the buffer object according to the placement.
 699  * This is used for validating shadow bos.  It calls ttm_bo_validate() to
 700  * make sure the buffer is resident where it needs to be.
 701  *
 702  * Returns:
 703  * 0 for success or a negative error code on failure.
 704  */
 705 int amdgpu_bo_validate(struct amdgpu_bo *bo)
 706 {
 707         struct ttm_operation_ctx ctx = { false, false };
 708         uint32_t domain;
 709         int r;
 710
 711         if (bo->tbo.pin_count)
 712                 return 0;
 713
 714         domain = bo->preferred_domains;
 715
 716 retry:
 717         amdgpu_bo_placement_from_domain(bo, domain);
 718         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 719         if (unlikely(r == -ENOMEM) && domain != bo->allowed_domains) {
 720                 domain = bo->allowed_domains;
 721                 goto retry;
 722         }
 723
 724         return r;
 725 }
 726
 727 /**
 728  * amdgpu_bo_restore_shadow - restore an &amdgpu_bo shadow
 729  *
 730  * @shadow: &amdgpu_bo shadow to be restored
 731  * @fence: dma_fence associated with the operation
 732  *
 733  * Copies a buffer object's shadow content back to the object.
 734  * This is used for recovering a buffer from its shadow in case of a gpu
 735  * reset where vram context may be lost.
 736  *
 737  * Returns:
 738  * 0 for success or a negative error code on failure.
 739  */
 740 int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow, struct dma_fence **fence)
 741
 742 {
 743         struct amdgpu_device *adev = amdgpu_ttm_adev(shadow->tbo.bdev);
 744         struct amdgpu_ring *ring = adev->mman.buffer_funcs_ring;
 745         uint64_t shadow_addr, parent_addr;
 746
 747         shadow_addr = amdgpu_bo_gpu_offset(shadow);
 748         parent_addr = amdgpu_bo_gpu_offset(shadow->parent);
 749
 750         return amdgpu_copy_buffer(ring, shadow_addr, parent_addr,
 751                                   amdgpu_bo_size(shadow), NULL, fence,
 752                                   true, false, false);
 753 }
 754
 755 /**
 756  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
 757  * @bo: &amdgpu_bo buffer object to be mapped
 758  * @ptr: kernel virtual address to be returned
 759  *
 760  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
 761  * amdgpu_bo_kptr() to get the kernel virtual address.
 762  *
 763  * Returns:
 764  * 0 for success or a negative error code on failure.
 765  */
 766 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
 767 {
 768         void *kptr;
 769         long r;
 770
 771         if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
 772                 return -EPERM;
 773
 774         kptr = amdgpu_bo_kptr(bo);
 775         if (kptr) {
 776                 if (ptr)
 777                         *ptr = kptr;
 778                 return 0;
 779         }
 780
 781         r = dma_resv_wait_timeout_rcu(bo->tbo.base.resv, false, false,
 782                                                 MAX_SCHEDULE_TIMEOUT);
 783         if (r < 0)
 784                 return r;
 785
 786         r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.mem.num_pages, &bo->kmap);
 787         if (r)
 788                 return r;
 789
 790         if (ptr)
 791                 *ptr = amdgpu_bo_kptr(bo);
 792
 793         return 0;
 794 }
 795
 796 /**
 797  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
 798  * @bo: &amdgpu_bo buffer object
 799  *
 800  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
 801  *
 802  * Returns:
 803  * the virtual address of a buffer object area.
 804  */
 805 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
 806 {
 807         bool is_iomem;
 808
 809         return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
 810 }
 811
 812 /**
 813  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
 814  * @bo: &amdgpu_bo buffer object to be unmapped
 815  *
 816  * Unmaps a kernel map set up by amdgpu_bo_kmap().
 817  */
 818 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
 819 {
 820         if (bo->kmap.bo)
 821                 ttm_bo_kunmap(&bo->kmap);
 822 }
 823
 824 /**
 825  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
 826  * @bo: &amdgpu_bo buffer object
 827  *
 828  * References the contained &ttm_buffer_object.
 829  *
 830  * Returns:
 831  * a refcounted pointer to the &amdgpu_bo buffer object.
 832  */
 833 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
 834 {
 835         if (bo == NULL)
 836                 return NULL;
 837
 838         ttm_bo_get(&bo->tbo);
 839         return bo;
 840 }
 841
 842 /**
 843  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
 844  * @bo: &amdgpu_bo buffer object
 845  *
 846  * Unreferences the contained &ttm_buffer_object and clear the pointer
 847  */
 848 void amdgpu_bo_unref(struct amdgpu_bo **bo)
 849 {
 850         struct ttm_buffer_object *tbo;
 851
 852         if ((*bo) == NULL)
 853                 return;
 854
 855         tbo = &((*bo)->tbo);
 856         ttm_bo_put(tbo);
 857         *bo = NULL;
 858 }
 859
 860 /**
 861  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
 862  * @bo: &amdgpu_bo buffer object to be pinned
 863  * @domain: domain to be pinned to
 864  * @min_offset: the start of requested address range
 865  * @max_offset: the end of requested address range
 866  *
 867  * Pins the buffer object according to requested domain and address range. If
 868  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
 869  * pin_count and pin_size accordingly.
 870  *
 871  * Pinning means to lock pages in memory along with keeping them at a fixed
 872  * offset. It is required when a buffer can not be moved, for example, when
 873  * a display buffer is being scanned out.
 874  *
 875  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
 876  * where to pin a buffer if there are specific restrictions on where a buffer
 877  * must be located.
 878  *
 879  * Returns:
 880  * 0 for success or a negative error code on failure.
 881  */
 882 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 883                              u64 min_offset, u64 max_offset)
 884 {
 885         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 886         struct ttm_operation_ctx ctx = { false, false };
 887         int r, i;
 888
 889         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
 890                 return -EPERM;
 891
 892         if (WARN_ON_ONCE(min_offset > max_offset))
 893                 return -EINVAL;
 894
 895         /* A shared bo cannot be migrated to VRAM */
 896         if (bo->prime_shared_count || bo->tbo.base.import_attach) {
 897                 if (domain & AMDGPU_GEM_DOMAIN_GTT)
 898                         domain = AMDGPU_GEM_DOMAIN_GTT;
 899                 else
 900                         return -EINVAL;
 901         }
 902
 903         /* This assumes only APU display buffers are pinned with (VRAM|GTT).
 904          * See function amdgpu_display_supported_domains()
 905          */
 906         domain = amdgpu_bo_get_preferred_pin_domain(adev, domain);
 907
 908         if (bo->tbo.pin_count) {
 909                 uint32_t mem_type = bo->tbo.mem.mem_type;
 910                 uint32_t mem_flags = bo->tbo.mem.placement;
 911
 912                 if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
 913                         return -EINVAL;
 914
 915                 if ((mem_type == TTM_PL_VRAM) &&
 916                     (bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS) &&
 917                     !(mem_flags & TTM_PL_FLAG_CONTIGUOUS))
 918                         return -EINVAL;
 919
 920                 ttm_bo_pin(&bo->tbo);
 921
 922                 if (max_offset != 0) {
 923                         u64 domain_start = amdgpu_ttm_domain_start(adev,
 924                                                                    mem_type);
 925                         WARN_ON_ONCE(max_offset <
 926                                      (amdgpu_bo_gpu_offset(bo) - domain_start));
 927                 }
 928
 929                 return 0;
 930         }
 931
 932         if (bo->tbo.base.import_attach)
 933                 dma_buf_pin(bo->tbo.base.import_attach);
 934
 935         /* force to pin into visible video ram */
 936         if (!(bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS))
 937                 bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 938         amdgpu_bo_placement_from_domain(bo, domain);
 939         for (i = 0; i < bo->placement.num_placement; i++) {
 940                 unsigned fpfn, lpfn;
 941
 942                 fpfn = min_offset >> PAGE_SHIFT;
 943                 lpfn = max_offset >> PAGE_SHIFT;
 944
 945                 if (fpfn > bo->placements[i].fpfn)
 946                         bo->placements[i].fpfn = fpfn;
 947                 if (!bo->placements[i].lpfn ||
 948                     (lpfn && lpfn < bo->placements[i].lpfn))
 949                         bo->placements[i].lpfn = lpfn;
 950         }
 951
 952         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 953         if (unlikely(r)) {
 954                 dev_err(adev->dev, "%p pin failed\n", bo);
 955                 goto error;
 956         }
 957
 958         ttm_bo_pin(&bo->tbo);
 959
 960         domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
 961         if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
 962                 atomic64_add(amdgpu_bo_size(bo), &adev->vram_pin_size);
 963                 atomic64_add(amdgpu_vram_mgr_bo_visible_size(bo),
 964                              &adev->visible_pin_size);
 965         } else if (domain == AMDGPU_GEM_DOMAIN_GTT) {
 966                 atomic64_add(amdgpu_bo_size(bo), &adev->gart_pin_size);
 967         }
 968
 969 error:
 970         return r;
 971 }
 972
 973 /**
 974  * amdgpu_bo_pin - pin an &amdgpu_bo buffer object
 975  * @bo: &amdgpu_bo buffer object to be pinned
 976  * @domain: domain to be pinned to
 977  *
 978  * A simple wrapper to amdgpu_bo_pin_restricted().
 979  * Provides a simpler API for buffers that do not have any strict restrictions
 980  * on where a buffer must be located.
 981  *
 982  * Returns:
 983  * 0 for success or a negative error code on failure.
 984  */
 985 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain)
 986 {
 987         bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 988         return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
 989 }
 990
 991 /**
 992  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
 993  * @bo: &amdgpu_bo buffer object to be unpinned
 994  *
 995  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
 996  * Changes placement and pin size accordingly.
 997  *
 998  * Returns:
 999  * 0 for success or a negative error code on failure.
1000  */
1001 void amdgpu_bo_unpin(struct amdgpu_bo *bo)
1002 {
1003         ttm_bo_unpin(&bo->tbo);
1004         if (bo->tbo.pin_count)
1005                 return;
1006
1007         amdgpu_bo_subtract_pin_size(bo);
1008
1009         if (bo->tbo.base.import_attach)
1010                 dma_buf_unpin(bo->tbo.base.import_attach);
1011 }
1012
1013 /**
1014  * amdgpu_bo_evict_vram - evict VRAM buffers
1015  * @adev: amdgpu device object
1016  *
1017  * Evicts all VRAM buffers on the lru list of the memory type.
1018  * Mainly used for evicting vram at suspend time.
1019  *
1020  * Returns:
1021  * 0 for success or a negative error code on failure.
1022  */
1023 int amdgpu_bo_evict_vram(struct amdgpu_device *adev)
1024 {
1025         struct ttm_resource_manager *man;
1026
1027         /* late 2.6.33 fix IGP hibernate - we need pm ops to do this correct */
1028 #ifndef CONFIG_HIBERNATION
1029         if (adev->flags & AMD_IS_APU) {
1030                 /* Useless to evict on IGP chips */
1031                 return 0;
1032         }
1033 #endif
1034
1035         man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
1036         return ttm_resource_manager_evict_all(&adev->mman.bdev, man);
1037 }
1038
1039 static const char *amdgpu_vram_names[] = {
1040         "UNKNOWN",
1041         "GDDR1",
1042         "DDR2",
1043         "GDDR3",
1044         "GDDR4",
1045         "GDDR5",
1046         "HBM",
1047         "DDR3",
1048         "DDR4",
1049         "GDDR6",
1050         "DDR5"
1051 };
1052
1053 /**
1054  * amdgpu_bo_init - initialize memory manager
1055  * @adev: amdgpu device object
1056  *
1057  * Calls amdgpu_ttm_init() to initialize amdgpu memory manager.
1058  *
1059  * Returns:
1060  * 0 for success or a negative error code on failure.
1061  */
1062 int amdgpu_bo_init(struct amdgpu_device *adev)
1063 {
1064         /* On A+A platform, VRAM can be mapped as WB */
1065         if (!adev->gmc.xgmi.connected_to_cpu) {
1066                 /* reserve PAT memory space to WC for VRAM */
1067                 arch_io_reserve_memtype_wc(adev->gmc.aper_base,
1068                                 adev->gmc.aper_size);
1069
1070                 /* Add an MTRR for the VRAM */
1071                 adev->gmc.vram_mtrr = arch_phys_wc_add(adev->gmc.aper_base,
1072                                 adev->gmc.aper_size);
1073         }
1074
1075         DRM_INFO("Detected VRAM RAM=%lluM, BAR=%lluM\n",
1076                  adev->gmc.mc_vram_size >> 20,
1077                  (unsigned long long)adev->gmc.aper_size >> 20);
1078         DRM_INFO("RAM width %dbits %s\n",
1079                  adev->gmc.vram_width, amdgpu_vram_names[adev->gmc.vram_type]);
1080         return amdgpu_ttm_init(adev);
1081 }
1082
1083 /**
1084  * amdgpu_bo_fini - tear down memory manager
1085  * @adev: amdgpu device object
1086  *
1087  * Reverses amdgpu_bo_init() to tear down memory manager.
1088  */
1089 void amdgpu_bo_fini(struct amdgpu_device *adev)
1090 {
1091         amdgpu_ttm_fini(adev);
1092         if (!adev->gmc.xgmi.connected_to_cpu) {
1093                 arch_phys_wc_del(adev->gmc.vram_mtrr);
1094                 arch_io_free_memtype_wc(adev->gmc.aper_base, adev->gmc.aper_size);
1095         }
1096 }
1097
1098 /**
1099  * amdgpu_bo_fbdev_mmap - mmap fbdev memory
1100  * @bo: &amdgpu_bo buffer object
1101  * @vma: vma as input from the fbdev mmap method
1102  *
1103  * Calls ttm_fbdev_mmap() to mmap fbdev memory if it is backed by a bo.
1104  *
1105  * Returns:
1106  * 0 for success or a negative error code on failure.
1107  */
1108 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
1109                              struct vm_area_struct *vma)
1110 {
1111         if (vma->vm_pgoff != 0)
1112                 return -EACCES;
1113
1114         return ttm_bo_mmap_obj(vma, &bo->tbo);
1115 }
1116
1117 /**
1118  * amdgpu_bo_set_tiling_flags - set tiling flags
1119  * @bo: &amdgpu_bo buffer object
1120  * @tiling_flags: new flags
1121  *
1122  * Sets buffer object's tiling flags with the new one. Used by GEM ioctl or
1123  * kernel driver to set the tiling flags on a buffer.
1124  *
1125  * Returns:
1126  * 0 for success or a negative error code on failure.
1127  */
1128 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags)
1129 {
1130         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1131
1132         if (adev->family <= AMDGPU_FAMILY_CZ &&
1133             AMDGPU_TILING_GET(tiling_flags, TILE_SPLIT) > 6)
1134                 return -EINVAL;
1135
1136         bo->tiling_flags = tiling_flags;
1137         return 0;
1138 }
1139
1140 /**
1141  * amdgpu_bo_get_tiling_flags - get tiling flags
1142  * @bo: &amdgpu_bo buffer object
1143  * @tiling_flags: returned flags
1144  *
1145  * Gets buffer object's tiling flags. Used by GEM ioctl or kernel driver to
1146  * set the tiling flags on a buffer.
1147  */
1148 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags)
1149 {
1150         dma_resv_assert_held(bo->tbo.base.resv);
1151
1152         if (tiling_flags)
1153                 *tiling_flags = bo->tiling_flags;
1154 }
1155
1156 /**
1157  * amdgpu_bo_set_metadata - set metadata
1158  * @bo: &amdgpu_bo buffer object
1159  * @metadata: new metadata
1160  * @metadata_size: size of the new metadata
1161  * @flags: flags of the new metadata
1162  *
1163  * Sets buffer object's metadata, its size and flags.
1164  * Used via GEM ioctl.
1165  *
1166  * Returns:
1167  * 0 for success or a negative error code on failure.
1168  */
1169 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
1170                             uint32_t metadata_size, uint64_t flags)
1171 {
1172         void *buffer;
1173
1174         if (!metadata_size) {
1175                 if (bo->metadata_size) {
1176                         kfree(bo->metadata);
1177                         bo->metadata = NULL;
1178                         bo->metadata_size = 0;
1179                 }
1180                 return 0;
1181         }
1182
1183         if (metadata == NULL)
1184                 return -EINVAL;
1185
1186         buffer = kmemdup(metadata, metadata_size, GFP_KERNEL);
1187         if (buffer == NULL)
1188                 return -ENOMEM;
1189
1190         kfree(bo->metadata);
1191         bo->metadata_flags = flags;
1192         bo->metadata = buffer;
1193         bo->metadata_size = metadata_size;
1194
1195         return 0;
1196 }
1197
1198 /**
1199  * amdgpu_bo_get_metadata - get metadata
1200  * @bo: &amdgpu_bo buffer object
1201  * @buffer: returned metadata
1202  * @buffer_size: size of the buffer
1203  * @metadata_size: size of the returned metadata
1204  * @flags: flags of the returned metadata
1205  *
1206  * Gets buffer object's metadata, its size and flags. buffer_size shall not be
1207  * less than metadata_size.
1208  * Used via GEM ioctl.
1209  *
1210  * Returns:
1211  * 0 for success or a negative error code on failure.
1212  */
1213 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
1214                            size_t buffer_size, uint32_t *metadata_size,
1215                            uint64_t *flags)
1216 {
1217         if (!buffer && !metadata_size)
1218                 return -EINVAL;
1219
1220         if (buffer) {
1221                 if (buffer_size < bo->metadata_size)
1222                         return -EINVAL;
1223
1224                 if (bo->metadata_size)
1225                         memcpy(buffer, bo->metadata, bo->metadata_size);
1226         }
1227
1228         if (metadata_size)
1229                 *metadata_size = bo->metadata_size;
1230         if (flags)
1231                 *flags = bo->metadata_flags;
1232
1233         return 0;
1234 }
1235
1236 /**
1237  * amdgpu_bo_move_notify - notification about a memory move
1238  * @bo: pointer to a buffer object
1239  * @evict: if this move is evicting the buffer from the graphics address space
1240  * @new_mem: new information of the bufer object
1241  *
1242  * Marks the corresponding &amdgpu_bo buffer object as invalid, also performs
1243  * bookkeeping.
1244  * TTM driver callback which is called when ttm moves a buffer.
1245  */
1246 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
1247                            bool evict,
1248                            struct ttm_resource *new_mem)
1249 {
1250         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1251         struct amdgpu_bo *abo;
1252         struct ttm_resource *old_mem = &bo->mem;
1253
1254         if (!amdgpu_bo_is_amdgpu_bo(bo))
1255                 return;
1256
1257         abo = ttm_to_amdgpu_bo(bo);
1258         amdgpu_vm_bo_invalidate(adev, abo, evict);
1259
1260         amdgpu_bo_kunmap(abo);
1261
1262         if (abo->tbo.base.dma_buf && !abo->tbo.base.import_attach &&
1263             bo->mem.mem_type != TTM_PL_SYSTEM)
1264                 dma_buf_move_notify(abo->tbo.base.dma_buf);
1265
1266         /* remember the eviction */
1267         if (evict)
1268                 atomic64_inc(&adev->num_evictions);
1269
1270         /* update statistics */
1271         if (!new_mem)
1272                 return;
1273
1274         /* move_notify is called before move happens */
1275         trace_amdgpu_bo_move(abo, new_mem->mem_type, old_mem->mem_type);
1276 }
1277
1278 /**
1279  * amdgpu_bo_release_notify - notification about a BO being released
1280  * @bo: pointer to a buffer object
1281  *
1282  * Wipes VRAM buffers whose contents should not be leaked before the
1283  * memory is released.
1284  */
1285 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo)
1286 {
1287         struct dma_fence *fence = NULL;
1288         struct amdgpu_bo *abo;
1289         int r;
1290
1291         if (!amdgpu_bo_is_amdgpu_bo(bo))
1292                 return;
1293
1294         abo = ttm_to_amdgpu_bo(bo);
1295
1296         if (abo->kfd_bo)
1297                 amdgpu_amdkfd_unreserve_memory_limit(abo);
1298
1299         /* We only remove the fence if the resv has individualized. */
1300         WARN_ON_ONCE(bo->type == ttm_bo_type_kernel
1301                         && bo->base.resv != &bo->base._resv);
1302         if (bo->base.resv == &bo->base._resv)
1303                 amdgpu_amdkfd_remove_fence_on_pt_pd_bos(abo);
1304
1305         if (bo->mem.mem_type != TTM_PL_VRAM || !bo->mem.mm_node ||
1306             !(abo->flags & AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE))
1307                 return;
1308
1309         dma_resv_lock(bo->base.resv, NULL);
1310
1311         r = amdgpu_fill_buffer(abo, AMDGPU_POISON, bo->base.resv, &fence);
1312         if (!WARN_ON(r)) {
1313                 amdgpu_bo_fence(abo, fence, false);
1314                 dma_fence_put(fence);
1315         }
1316
1317         dma_resv_unlock(bo->base.resv);
1318 }
1319
1320 /**
1321  * amdgpu_bo_fault_reserve_notify - notification about a memory fault
1322  * @bo: pointer to a buffer object
1323  *
1324  * Notifies the driver we are taking a fault on this BO and have reserved it,
1325  * also performs bookkeeping.
1326  * TTM driver callback for dealing with vm faults.
1327  *
1328  * Returns:
1329  * 0 for success or a negative error code on failure.
1330  */
1331 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo)
1332 {
1333         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1334         struct ttm_operation_ctx ctx = { false, false };
1335         struct amdgpu_bo *abo = ttm_to_amdgpu_bo(bo);
1336         unsigned long offset, size;
1337         int r;
1338
1339         /* Remember that this BO was accessed by the CPU */
1340         abo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
1341
1342         if (bo->mem.mem_type != TTM_PL_VRAM)
1343                 return 0;
1344
1345         size = bo->mem.num_pages << PAGE_SHIFT;
1346         offset = bo->mem.start << PAGE_SHIFT;
1347         if ((offset + size) <= adev->gmc.visible_vram_size)
1348                 return 0;
1349
1350         /* Can't move a pinned BO to visible VRAM */
1351         if (abo->tbo.pin_count > 0)
1352                 return VM_FAULT_SIGBUS;
1353
1354         /* hurrah the memory is not visible ! */
1355         atomic64_inc(&adev->num_vram_cpu_page_faults);
1356         amdgpu_bo_placement_from_domain(abo, AMDGPU_GEM_DOMAIN_VRAM |
1357                                         AMDGPU_GEM_DOMAIN_GTT);
1358
1359         /* Avoid costly evictions; only set GTT as a busy placement */
1360         abo->placement.num_busy_placement = 1;
1361         abo->placement.busy_placement = &abo->placements[1];
1362
1363         r = ttm_bo_validate(bo, &abo->placement, &ctx);
1364         if (unlikely(r == -EBUSY || r == -ERESTARTSYS))
1365                 return VM_FAULT_NOPAGE;
1366         else if (unlikely(r))
1367                 return VM_FAULT_SIGBUS;
1368
1369         offset = bo->mem.start << PAGE_SHIFT;
1370         /* this should never happen */
1371         if (bo->mem.mem_type == TTM_PL_VRAM &&
1372             (offset + size) > adev->gmc.visible_vram_size)
1373                 return VM_FAULT_SIGBUS;
1374
1375         ttm_bo_move_to_lru_tail_unlocked(bo);
1376         return 0;
1377 }
1378
1379 /**
1380  * amdgpu_bo_fence - add fence to buffer object
1381  *
1382  * @bo: buffer object in question
1383  * @fence: fence to add
1384  * @shared: true if fence should be added shared
1385  *
1386  */
1387 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
1388                      bool shared)
1389 {
1390         struct dma_resv *resv = bo->tbo.base.resv;
1391
1392         if (shared)
1393                 dma_resv_add_shared_fence(resv, fence);
1394         else
1395                 dma_resv_add_excl_fence(resv, fence);
1396 }
1397
1398 /**
1399  * amdgpu_bo_sync_wait_resv - Wait for BO reservation fences
1400  *
1401  * @adev: amdgpu device pointer
1402  * @resv: reservation object to sync to
1403  * @sync_mode: synchronization mode
1404  * @owner: fence owner
1405  * @intr: Whether the wait is interruptible
1406  *
1407  * Extract the fences from the reservation object and waits for them to finish.
1408  *
1409  * Returns:
1410  * 0 on success, errno otherwise.
1411  */
1412 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
1413                              enum amdgpu_sync_mode sync_mode, void *owner,
1414                              bool intr)
1415 {
1416         struct amdgpu_sync sync;
1417         int r;
1418
1419         amdgpu_sync_create(&sync);
1420         amdgpu_sync_resv(adev, &sync, resv, sync_mode, owner);
1421         r = amdgpu_sync_wait(&sync, intr);
1422         amdgpu_sync_free(&sync);
1423         return r;
1424 }
1425
1426 /**
1427  * amdgpu_bo_sync_wait - Wrapper for amdgpu_bo_sync_wait_resv
1428  * @bo: buffer object to wait for
1429  * @owner: fence owner
1430  * @intr: Whether the wait is interruptible
1431  *
1432  * Wrapper to wait for fences in a BO.
1433  * Returns:
1434  * 0 on success, errno otherwise.
1435  */
1436 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr)
1437 {
1438         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1439
1440         return amdgpu_bo_sync_wait_resv(adev, bo->tbo.base.resv,
1441                                         AMDGPU_SYNC_NE_OWNER, owner, intr);
1442 }
1443
1444 /**
1445  * amdgpu_bo_gpu_offset - return GPU offset of bo
1446  * @bo: amdgpu object for which we query the offset
1447  *
1448  * Note: object should either be pinned or reserved when calling this
1449  * function, it might be useful to add check for this for debugging.
1450  *
1451  * Returns:
1452  * current GPU offset of the object.
1453  */
1454 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo)
1455 {
1456         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_SYSTEM);
1457         WARN_ON_ONCE(!dma_resv_is_locked(bo->tbo.base.resv) &&
1458                      !bo->tbo.pin_count && bo->tbo.type != ttm_bo_type_kernel);
1459         WARN_ON_ONCE(bo->tbo.mem.start == AMDGPU_BO_INVALID_OFFSET);
1460         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_VRAM &&
1461                      !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1462
1463         return amdgpu_bo_gpu_offset_no_check(bo);
1464 }
1465
1466 /**
1467  * amdgpu_bo_gpu_offset_no_check - return GPU offset of bo
1468  * @bo: amdgpu object for which we query the offset
1469  *
1470  * Returns:
1471  * current GPU offset of the object without raising warnings.
1472  */
1473 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo)
1474 {
1475         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1476         uint64_t offset;
1477
1478         offset = (bo->tbo.mem.start << PAGE_SHIFT) +
1479                  amdgpu_ttm_domain_start(adev, bo->tbo.mem.mem_type);
1480
1481         return amdgpu_gmc_sign_extend(offset);
1482 }
1483
1484 /**
1485  * amdgpu_bo_get_preferred_pin_domain - get preferred domain for scanout
1486  * @adev: amdgpu device object
1487  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1488  *
1489  * Returns:
1490  * Which of the allowed domains is preferred for pinning the BO for scanout.
1491  */
1492 uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
1493                                             uint32_t domain)
1494 {
1495         if (domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) {
1496                 domain = AMDGPU_GEM_DOMAIN_VRAM;
1497                 if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1498                         domain = AMDGPU_GEM_DOMAIN_GTT;
1499         }
1500         return domain;
1501 }
1502
1503 #if defined(CONFIG_DEBUG_FS)
1504 #define amdgpu_bo_print_flag(m, bo, flag)                       \
1505         do {                                                    \
1506                 if (bo->flags & (AMDGPU_GEM_CREATE_ ## flag)) { \
1507                         seq_printf((m), " " #flag);             \
1508                 }                                               \
1509         } while (0)
1510
1511 /**
1512  * amdgpu_bo_print_info - print BO info in debugfs file
1513  *
1514  * @id: Index or Id of the BO
1515  * @bo: Requested BO for printing info
1516  * @m: debugfs file
1517  *
1518  * Print BO information in debugfs file
1519  *
1520  * Returns:
1521  * Size of the BO in bytes.
1522  */
1523 u64 amdgpu_bo_print_info(int id, struct amdgpu_bo *bo, struct seq_file *m)
1524 {
1525         struct dma_buf_attachment *attachment;
1526         struct dma_buf *dma_buf;
1527         unsigned int domain;
1528         const char *placement;
1529         unsigned int pin_count;
1530         u64 size;
1531
1532         domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
1533         switch (domain) {
1534         case AMDGPU_GEM_DOMAIN_VRAM:
1535                 placement = "VRAM";
1536                 break;
1537         case AMDGPU_GEM_DOMAIN_GTT:
1538                 placement = " GTT";
1539                 break;
1540         case AMDGPU_GEM_DOMAIN_CPU:
1541         default:
1542                 placement = " CPU";
1543                 break;
1544         }
1545
1546         size = amdgpu_bo_size(bo);
1547         seq_printf(m, "\t\t0x%08x: %12lld byte %s",
1548                         id, size, placement);
1549
1550         pin_count = READ_ONCE(bo->tbo.pin_count);
1551         if (pin_count)
1552                 seq_printf(m, " pin count %d", pin_count);
1553
1554         dma_buf = READ_ONCE(bo->tbo.base.dma_buf);
1555         attachment = READ_ONCE(bo->tbo.base.import_attach);
1556
1557         if (attachment)
1558                 seq_printf(m, " imported from %p", dma_buf);
1559         else if (dma_buf)
1560                 seq_printf(m, " exported as %p", dma_buf);
1561
1562         amdgpu_bo_print_flag(m, bo, CPU_ACCESS_REQUIRED);
1563         amdgpu_bo_print_flag(m, bo, NO_CPU_ACCESS);
1564         amdgpu_bo_print_flag(m, bo, CPU_GTT_USWC);
1565         amdgpu_bo_print_flag(m, bo, VRAM_CLEARED);
1566         amdgpu_bo_print_flag(m, bo, SHADOW);
1567         amdgpu_bo_print_flag(m, bo, VRAM_CONTIGUOUS);
1568         amdgpu_bo_print_flag(m, bo, VM_ALWAYS_VALID);
1569         amdgpu_bo_print_flag(m, bo, EXPLICIT_SYNC);
1570
1571         seq_puts(m, "\n");
1572
1573         return size;
1574 }
1575 #endif