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 <glisse@freedesktop.org>
  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                 .resv = bp->resv,
 522                 .flags = bp->type != ttm_bo_type_kernel ?
 523                         TTM_OPT_FLAG_ALLOW_RES_EVICT : 0
 524         };
 525         struct amdgpu_bo *bo;
 526         unsigned long page_align, size = bp->size;
 527         size_t acc_size;
 528         int r;
 529
 530         /* Note that GDS/GWS/OA allocates 1 page per byte/resource. */
 531         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA)) {
 532                 /* GWS and OA don't need any alignment. */
 533                 page_align = bp->byte_align;
 534                 size <<= PAGE_SHIFT;
 535         } else if (bp->domain & AMDGPU_GEM_DOMAIN_GDS) {
 536                 /* Both size and alignment must be a multiple of 4. */
 537                 page_align = ALIGN(bp->byte_align, 4);
 538                 size = ALIGN(size, 4) << PAGE_SHIFT;
 539         } else {
 540                 /* Memory should be aligned at least to a page size. */
 541                 page_align = ALIGN(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
 542                 size = ALIGN(size, PAGE_SIZE);
 543         }
 544
 545         if (!amdgpu_bo_validate_size(adev, size, bp->domain))
 546                 return -ENOMEM;
 547
 548         *bo_ptr = NULL;
 549
 550         acc_size = ttm_bo_dma_acc_size(&adev->mman.bdev, size,
 551                                        sizeof(struct amdgpu_bo));
 552
 553         bo = kzalloc(sizeof(struct amdgpu_bo), GFP_KERNEL);
 554         if (bo == NULL)
 555                 return -ENOMEM;
 556         drm_gem_private_object_init(adev_to_drm(adev), &bo->tbo.base, size);
 557         INIT_LIST_HEAD(&bo->shadow_list);
 558         bo->vm_bo = NULL;
 559         bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
 560                 bp->domain;
 561         bo->allowed_domains = bo->preferred_domains;
 562         if (bp->type != ttm_bo_type_kernel &&
 563             bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
 564                 bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
 565
 566         bo->flags = bp->flags;
 567
 568         if (!amdgpu_bo_support_uswc(bo->flags))
 569                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 570
 571         bo->tbo.bdev = &adev->mman.bdev;
 572         if (bp->domain & (AMDGPU_GEM_DOMAIN_GWS | AMDGPU_GEM_DOMAIN_OA |
 573                           AMDGPU_GEM_DOMAIN_GDS))
 574                 amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_CPU);
 575         else
 576                 amdgpu_bo_placement_from_domain(bo, bp->domain);
 577         if (bp->type == ttm_bo_type_kernel)
 578                 bo->tbo.priority = 1;
 579
 580         r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, size, bp->type,
 581                                  &bo->placement, page_align, &ctx, acc_size,
 582                                  NULL, bp->resv, &amdgpu_bo_destroy);
 583         if (unlikely(r != 0))
 584                 return r;
 585
 586         if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
 587             bo->tbo.mem.mem_type == TTM_PL_VRAM &&
 588             bo->tbo.mem.start < adev->gmc.visible_vram_size >> PAGE_SHIFT)
 589                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
 590                                              ctx.bytes_moved);
 591         else
 592                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
 593
 594         if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
 595             bo->tbo.mem.mem_type == TTM_PL_VRAM) {
 596                 struct dma_fence *fence;
 597
 598                 r = amdgpu_fill_buffer(bo, 0, bo->tbo.base.resv, &fence);
 599                 if (unlikely(r))
 600                         goto fail_unreserve;
 601
 602                 amdgpu_bo_fence(bo, fence, false);
 603                 dma_fence_put(bo->tbo.moving);
 604                 bo->tbo.moving = dma_fence_get(fence);
 605                 dma_fence_put(fence);
 606         }
 607         if (!bp->resv)
 608                 amdgpu_bo_unreserve(bo);
 609         *bo_ptr = bo;
 610
 611         trace_amdgpu_bo_create(bo);
 612
 613         /* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
 614         if (bp->type == ttm_bo_type_device)
 615                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 616
 617         return 0;
 618
 619 fail_unreserve:
 620         if (!bp->resv)
 621                 dma_resv_unlock(bo->tbo.base.resv);
 622         amdgpu_bo_unref(&bo);
 623         return r;
 624 }
 625
 626 static int amdgpu_bo_create_shadow(struct amdgpu_device *adev,
 627                                    unsigned long size,
 628                                    struct amdgpu_bo *bo)
 629 {
 630         struct amdgpu_bo_param bp;
 631         int r;
 632
 633         if (bo->shadow)
 634                 return 0;
 635
 636         memset(&bp, 0, sizeof(bp));
 637         bp.size = size;
 638         bp.domain = AMDGPU_GEM_DOMAIN_GTT;
 639         bp.flags = AMDGPU_GEM_CREATE_CPU_GTT_USWC |
 640                 AMDGPU_GEM_CREATE_SHADOW;
 641         bp.type = ttm_bo_type_kernel;
 642         bp.resv = bo->tbo.base.resv;
 643
 644         r = amdgpu_bo_do_create(adev, &bp, &bo->shadow);
 645         if (!r) {
 646                 bo->shadow->parent = amdgpu_bo_ref(bo);
 647                 mutex_lock(&adev->shadow_list_lock);
 648                 list_add_tail(&bo->shadow->shadow_list, &adev->shadow_list);
 649                 mutex_unlock(&adev->shadow_list_lock);
 650         }
 651
 652         return r;
 653 }
 654
 655 /**
 656  * amdgpu_bo_create - create an &amdgpu_bo buffer object
 657  * @adev: amdgpu device object
 658  * @bp: parameters to be used for the buffer object
 659  * @bo_ptr: pointer to the buffer object pointer
 660  *
 661  * Creates an &amdgpu_bo buffer object; and if requested, also creates a
 662  * shadow object.
 663  * Shadow object is used to backup the original buffer object, and is always
 664  * in GTT.
 665  *
 666  * Returns:
 667  * 0 for success or a negative error code on failure.
 668  */
 669 int amdgpu_bo_create(struct amdgpu_device *adev,
 670                      struct amdgpu_bo_param *bp,
 671                      struct amdgpu_bo **bo_ptr)
 672 {
 673         u64 flags = bp->flags;
 674         int r;
 675
 676         bp->flags = bp->flags & ~AMDGPU_GEM_CREATE_SHADOW;
 677         r = amdgpu_bo_do_create(adev, bp, bo_ptr);
 678         if (r)
 679                 return r;
 680
 681         if ((flags & AMDGPU_GEM_CREATE_SHADOW) && !(adev->flags & AMD_IS_APU)) {
 682                 if (!bp->resv)
 683                         WARN_ON(dma_resv_lock((*bo_ptr)->tbo.base.resv,
 684                                                         NULL));
 685
 686                 r = amdgpu_bo_create_shadow(adev, bp->size, *bo_ptr);
 687
 688                 if (!bp->resv)
 689                         dma_resv_unlock((*bo_ptr)->tbo.base.resv);
 690
 691                 if (r)
 692                         amdgpu_bo_unref(bo_ptr);
 693         }
 694
 695         return r;
 696 }
 697
 698 /**
 699  * amdgpu_bo_validate - validate an &amdgpu_bo buffer object
 700  * @bo: pointer to the buffer object
 701  *
 702  * Sets placement according to domain; and changes placement and caching
 703  * policy of the buffer object according to the placement.
 704  * This is used for validating shadow bos.  It calls ttm_bo_validate() to
 705  * make sure the buffer is resident where it needs to be.
 706  *
 707  * Returns:
 708  * 0 for success or a negative error code on failure.
 709  */
 710 int amdgpu_bo_validate(struct amdgpu_bo *bo)
 711 {
 712         struct ttm_operation_ctx ctx = { false, false };
 713         uint32_t domain;
 714         int r;
 715
 716         if (bo->tbo.pin_count)
 717                 return 0;
 718
 719         domain = bo->preferred_domains;
 720
 721 retry:
 722         amdgpu_bo_placement_from_domain(bo, domain);
 723         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 724         if (unlikely(r == -ENOMEM) && domain != bo->allowed_domains) {
 725                 domain = bo->allowed_domains;
 726                 goto retry;
 727         }
 728
 729         return r;
 730 }
 731
 732 /**
 733  * amdgpu_bo_restore_shadow - restore an &amdgpu_bo shadow
 734  *
 735  * @shadow: &amdgpu_bo shadow to be restored
 736  * @fence: dma_fence associated with the operation
 737  *
 738  * Copies a buffer object's shadow content back to the object.
 739  * This is used for recovering a buffer from its shadow in case of a gpu
 740  * reset where vram context may be lost.
 741  *
 742  * Returns:
 743  * 0 for success or a negative error code on failure.
 744  */
 745 int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow, struct dma_fence **fence)
 746
 747 {
 748         struct amdgpu_device *adev = amdgpu_ttm_adev(shadow->tbo.bdev);
 749         struct amdgpu_ring *ring = adev->mman.buffer_funcs_ring;
 750         uint64_t shadow_addr, parent_addr;
 751
 752         shadow_addr = amdgpu_bo_gpu_offset(shadow);
 753         parent_addr = amdgpu_bo_gpu_offset(shadow->parent);
 754
 755         return amdgpu_copy_buffer(ring, shadow_addr, parent_addr,
 756                                   amdgpu_bo_size(shadow), NULL, fence,
 757                                   true, false, false);
 758 }
 759
 760 /**
 761  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
 762  * @bo: &amdgpu_bo buffer object to be mapped
 763  * @ptr: kernel virtual address to be returned
 764  *
 765  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
 766  * amdgpu_bo_kptr() to get the kernel virtual address.
 767  *
 768  * Returns:
 769  * 0 for success or a negative error code on failure.
 770  */
 771 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
 772 {
 773         void *kptr;
 774         long r;
 775
 776         if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
 777                 return -EPERM;
 778
 779         kptr = amdgpu_bo_kptr(bo);
 780         if (kptr) {
 781                 if (ptr)
 782                         *ptr = kptr;
 783                 return 0;
 784         }
 785
 786         r = dma_resv_wait_timeout_rcu(bo->tbo.base.resv, false, false,
 787                                                 MAX_SCHEDULE_TIMEOUT);
 788         if (r < 0)
 789                 return r;
 790
 791         r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.num_pages, &bo->kmap);
 792         if (r)
 793                 return r;
 794
 795         if (ptr)
 796                 *ptr = amdgpu_bo_kptr(bo);
 797
 798         return 0;
 799 }
 800
 801 /**
 802  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
 803  * @bo: &amdgpu_bo buffer object
 804  *
 805  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
 806  *
 807  * Returns:
 808  * the virtual address of a buffer object area.
 809  */
 810 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
 811 {
 812         bool is_iomem;
 813
 814         return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
 815 }
 816
 817 /**
 818  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
 819  * @bo: &amdgpu_bo buffer object to be unmapped
 820  *
 821  * Unmaps a kernel map set up by amdgpu_bo_kmap().
 822  */
 823 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
 824 {
 825         if (bo->kmap.bo)
 826                 ttm_bo_kunmap(&bo->kmap);
 827 }
 828
 829 /**
 830  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
 831  * @bo: &amdgpu_bo buffer object
 832  *
 833  * References the contained &ttm_buffer_object.
 834  *
 835  * Returns:
 836  * a refcounted pointer to the &amdgpu_bo buffer object.
 837  */
 838 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
 839 {
 840         if (bo == NULL)
 841                 return NULL;
 842
 843         ttm_bo_get(&bo->tbo);
 844         return bo;
 845 }
 846
 847 /**
 848  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
 849  * @bo: &amdgpu_bo buffer object
 850  *
 851  * Unreferences the contained &ttm_buffer_object and clear the pointer
 852  */
 853 void amdgpu_bo_unref(struct amdgpu_bo **bo)
 854 {
 855         struct ttm_buffer_object *tbo;
 856
 857         if ((*bo) == NULL)
 858                 return;
 859
 860         tbo = &((*bo)->tbo);
 861         ttm_bo_put(tbo);
 862         *bo = NULL;
 863 }
 864
 865 /**
 866  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
 867  * @bo: &amdgpu_bo buffer object to be pinned
 868  * @domain: domain to be pinned to
 869  * @min_offset: the start of requested address range
 870  * @max_offset: the end of requested address range
 871  *
 872  * Pins the buffer object according to requested domain and address range. If
 873  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
 874  * pin_count and pin_size accordingly.
 875  *
 876  * Pinning means to lock pages in memory along with keeping them at a fixed
 877  * offset. It is required when a buffer can not be moved, for example, when
 878  * a display buffer is being scanned out.
 879  *
 880  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
 881  * where to pin a buffer if there are specific restrictions on where a buffer
 882  * must be located.
 883  *
 884  * Returns:
 885  * 0 for success or a negative error code on failure.
 886  */
 887 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 888                              u64 min_offset, u64 max_offset)
 889 {
 890         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 891         struct ttm_operation_ctx ctx = { false, false };
 892         int r, i;
 893
 894         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
 895                 return -EPERM;
 896
 897         if (WARN_ON_ONCE(min_offset > max_offset))
 898                 return -EINVAL;
 899
 900         /* A shared bo cannot be migrated to VRAM */
 901         if (bo->prime_shared_count) {
 902                 if (domain & AMDGPU_GEM_DOMAIN_GTT)
 903                         domain = AMDGPU_GEM_DOMAIN_GTT;
 904                 else
 905                         return -EINVAL;
 906         }
 907
 908         /* This assumes only APU display buffers are pinned with (VRAM|GTT).
 909          * See function amdgpu_display_supported_domains()
 910          */
 911         domain = amdgpu_bo_get_preferred_pin_domain(adev, domain);
 912
 913         if (bo->tbo.pin_count) {
 914                 uint32_t mem_type = bo->tbo.mem.mem_type;
 915
 916                 if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
 917                         return -EINVAL;
 918
 919                 ttm_bo_pin(&bo->tbo);
 920
 921                 if (max_offset != 0) {
 922                         u64 domain_start = amdgpu_ttm_domain_start(adev,
 923                                                                    mem_type);
 924                         WARN_ON_ONCE(max_offset <
 925                                      (amdgpu_bo_gpu_offset(bo) - domain_start));
 926                 }
 927
 928                 return 0;
 929         }
 930
 931         if (bo->tbo.base.import_attach)
 932                 dma_buf_pin(bo->tbo.base.import_attach);
 933
 934         bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 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         return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
 988 }
 989
 990 /**
 991  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
 992  * @bo: &amdgpu_bo buffer object to be unpinned
 993  *
 994  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
 995  * Changes placement and pin size accordingly.
 996  *
 997  * Returns:
 998  * 0 for success or a negative error code on failure.
 999  */
1000 void amdgpu_bo_unpin(struct amdgpu_bo *bo)
1001 {
1002         ttm_bo_unpin(&bo->tbo);
1003         if (bo->tbo.pin_count)
1004                 return;
1005
1006         amdgpu_bo_subtract_pin_size(bo);
1007
1008         if (bo->tbo.base.import_attach)
1009                 dma_buf_unpin(bo->tbo.base.import_attach);
1010 }
1011
1012 /**
1013  * amdgpu_bo_evict_vram - evict VRAM buffers
1014  * @adev: amdgpu device object
1015  *
1016  * Evicts all VRAM buffers on the lru list of the memory type.
1017  * Mainly used for evicting vram at suspend time.
1018  *
1019  * Returns:
1020  * 0 for success or a negative error code on failure.
1021  */
1022 int amdgpu_bo_evict_vram(struct amdgpu_device *adev)
1023 {
1024         struct ttm_resource_manager *man;
1025
1026         /* late 2.6.33 fix IGP hibernate - we need pm ops to do this correct */
1027 #ifndef CONFIG_HIBERNATION
1028         if (adev->flags & AMD_IS_APU) {
1029                 /* Useless to evict on IGP chips */
1030                 return 0;
1031         }
1032 #endif
1033
1034         man = ttm_manager_type(&adev->mman.bdev, TTM_PL_VRAM);
1035         return ttm_resource_manager_evict_all(&adev->mman.bdev, man);
1036 }
1037
1038 static const char *amdgpu_vram_names[] = {
1039         "UNKNOWN",
1040         "GDDR1",
1041         "DDR2",
1042         "GDDR3",
1043         "GDDR4",
1044         "GDDR5",
1045         "HBM",
1046         "DDR3",
1047         "DDR4",
1048         "GDDR6",
1049 };
1050
1051 /**
1052  * amdgpu_bo_init - initialize memory manager
1053  * @adev: amdgpu device object
1054  *
1055  * Calls amdgpu_ttm_init() to initialize amdgpu memory manager.
1056  *
1057  * Returns:
1058  * 0 for success or a negative error code on failure.
1059  */
1060 int amdgpu_bo_init(struct amdgpu_device *adev)
1061 {
1062         /* reserve PAT memory space to WC for VRAM */
1063         arch_io_reserve_memtype_wc(adev->gmc.aper_base,
1064                                    adev->gmc.aper_size);
1065
1066         /* Add an MTRR for the VRAM */
1067         adev->gmc.vram_mtrr = arch_phys_wc_add(adev->gmc.aper_base,
1068                                               adev->gmc.aper_size);
1069         DRM_INFO("Detected VRAM RAM=%lluM, BAR=%lluM\n",
1070                  adev->gmc.mc_vram_size >> 20,
1071                  (unsigned long long)adev->gmc.aper_size >> 20);
1072         DRM_INFO("RAM width %dbits %s\n",
1073                  adev->gmc.vram_width, amdgpu_vram_names[adev->gmc.vram_type]);
1074         return amdgpu_ttm_init(adev);
1075 }
1076
1077 /**
1078  * amdgpu_bo_late_init - late init
1079  * @adev: amdgpu device object
1080  *
1081  * Calls amdgpu_ttm_late_init() to free resources used earlier during
1082  * initialization.
1083  *
1084  * Returns:
1085  * 0 for success or a negative error code on failure.
1086  */
1087 int amdgpu_bo_late_init(struct amdgpu_device *adev)
1088 {
1089         amdgpu_ttm_late_init(adev);
1090
1091         return 0;
1092 }
1093
1094 /**
1095  * amdgpu_bo_fini - tear down memory manager
1096  * @adev: amdgpu device object
1097  *
1098  * Reverses amdgpu_bo_init() to tear down memory manager.
1099  */
1100 void amdgpu_bo_fini(struct amdgpu_device *adev)
1101 {
1102         amdgpu_ttm_fini(adev);
1103         arch_phys_wc_del(adev->gmc.vram_mtrr);
1104         arch_io_free_memtype_wc(adev->gmc.aper_base, adev->gmc.aper_size);
1105 }
1106
1107 /**
1108  * amdgpu_bo_fbdev_mmap - mmap fbdev memory
1109  * @bo: &amdgpu_bo buffer object
1110  * @vma: vma as input from the fbdev mmap method
1111  *
1112  * Calls ttm_fbdev_mmap() to mmap fbdev memory if it is backed by a bo.
1113  *
1114  * Returns:
1115  * 0 for success or a negative error code on failure.
1116  */
1117 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
1118                              struct vm_area_struct *vma)
1119 {
1120         if (vma->vm_pgoff != 0)
1121                 return -EACCES;
1122
1123         return ttm_bo_mmap_obj(vma, &bo->tbo);
1124 }
1125
1126 /**
1127  * amdgpu_bo_set_tiling_flags - set tiling flags
1128  * @bo: &amdgpu_bo buffer object
1129  * @tiling_flags: new flags
1130  *
1131  * Sets buffer object's tiling flags with the new one. Used by GEM ioctl or
1132  * kernel driver to set the tiling flags on a buffer.
1133  *
1134  * Returns:
1135  * 0 for success or a negative error code on failure.
1136  */
1137 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags)
1138 {
1139         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1140
1141         if (adev->family <= AMDGPU_FAMILY_CZ &&
1142             AMDGPU_TILING_GET(tiling_flags, TILE_SPLIT) > 6)
1143                 return -EINVAL;
1144
1145         bo->tiling_flags = tiling_flags;
1146         return 0;
1147 }
1148
1149 /**
1150  * amdgpu_bo_get_tiling_flags - get tiling flags
1151  * @bo: &amdgpu_bo buffer object
1152  * @tiling_flags: returned flags
1153  *
1154  * Gets buffer object's tiling flags. Used by GEM ioctl or kernel driver to
1155  * set the tiling flags on a buffer.
1156  */
1157 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags)
1158 {
1159         dma_resv_assert_held(bo->tbo.base.resv);
1160
1161         if (tiling_flags)
1162                 *tiling_flags = bo->tiling_flags;
1163 }
1164
1165 /**
1166  * amdgpu_bo_set_metadata - set metadata
1167  * @bo: &amdgpu_bo buffer object
1168  * @metadata: new metadata
1169  * @metadata_size: size of the new metadata
1170  * @flags: flags of the new metadata
1171  *
1172  * Sets buffer object's metadata, its size and flags.
1173  * Used via GEM ioctl.
1174  *
1175  * Returns:
1176  * 0 for success or a negative error code on failure.
1177  */
1178 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
1179                             uint32_t metadata_size, uint64_t flags)
1180 {
1181         void *buffer;
1182
1183         if (!metadata_size) {
1184                 if (bo->metadata_size) {
1185                         kfree(bo->metadata);
1186                         bo->metadata = NULL;
1187                         bo->metadata_size = 0;
1188                 }
1189                 return 0;
1190         }
1191
1192         if (metadata == NULL)
1193                 return -EINVAL;
1194
1195         buffer = kmemdup(metadata, metadata_size, GFP_KERNEL);
1196         if (buffer == NULL)
1197                 return -ENOMEM;
1198
1199         kfree(bo->metadata);
1200         bo->metadata_flags = flags;
1201         bo->metadata = buffer;
1202         bo->metadata_size = metadata_size;
1203
1204         return 0;
1205 }
1206
1207 /**
1208  * amdgpu_bo_get_metadata - get metadata
1209  * @bo: &amdgpu_bo buffer object
1210  * @buffer: returned metadata
1211  * @buffer_size: size of the buffer
1212  * @metadata_size: size of the returned metadata
1213  * @flags: flags of the returned metadata
1214  *
1215  * Gets buffer object's metadata, its size and flags. buffer_size shall not be
1216  * less than metadata_size.
1217  * Used via GEM ioctl.
1218  *
1219  * Returns:
1220  * 0 for success or a negative error code on failure.
1221  */
1222 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
1223                            size_t buffer_size, uint32_t *metadata_size,
1224                            uint64_t *flags)
1225 {
1226         if (!buffer && !metadata_size)
1227                 return -EINVAL;
1228
1229         if (buffer) {
1230                 if (buffer_size < bo->metadata_size)
1231                         return -EINVAL;
1232
1233                 if (bo->metadata_size)
1234                         memcpy(buffer, bo->metadata, bo->metadata_size);
1235         }
1236
1237         if (metadata_size)
1238                 *metadata_size = bo->metadata_size;
1239         if (flags)
1240                 *flags = bo->metadata_flags;
1241
1242         return 0;
1243 }
1244
1245 /**
1246  * amdgpu_bo_move_notify - notification about a memory move
1247  * @bo: pointer to a buffer object
1248  * @evict: if this move is evicting the buffer from the graphics address space
1249  * @new_mem: new information of the bufer object
1250  *
1251  * Marks the corresponding &amdgpu_bo buffer object as invalid, also performs
1252  * bookkeeping.
1253  * TTM driver callback which is called when ttm moves a buffer.
1254  */
1255 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
1256                            bool evict,
1257                            struct ttm_resource *new_mem)
1258 {
1259         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1260         struct amdgpu_bo *abo;
1261         struct ttm_resource *old_mem = &bo->mem;
1262
1263         if (!amdgpu_bo_is_amdgpu_bo(bo))
1264                 return;
1265
1266         abo = ttm_to_amdgpu_bo(bo);
1267         amdgpu_vm_bo_invalidate(adev, abo, evict);
1268
1269         amdgpu_bo_kunmap(abo);
1270
1271         if (abo->tbo.base.dma_buf && !abo->tbo.base.import_attach &&
1272             bo->mem.mem_type != TTM_PL_SYSTEM)
1273                 dma_buf_move_notify(abo->tbo.base.dma_buf);
1274
1275         /* remember the eviction */
1276         if (evict)
1277                 atomic64_inc(&adev->num_evictions);
1278
1279         /* update statistics */
1280         if (!new_mem)
1281                 return;
1282
1283         /* move_notify is called before move happens */
1284         trace_amdgpu_bo_move(abo, new_mem->mem_type, old_mem->mem_type);
1285 }
1286
1287 /**
1288  * amdgpu_bo_release_notify - notification about a BO being released
1289  * @bo: pointer to a buffer object
1290  *
1291  * Wipes VRAM buffers whose contents should not be leaked before the
1292  * memory is released.
1293  */
1294 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo)
1295 {
1296         struct dma_fence *fence = NULL;
1297         struct amdgpu_bo *abo;
1298         int r;
1299
1300         if (!amdgpu_bo_is_amdgpu_bo(bo))
1301                 return;
1302
1303         abo = ttm_to_amdgpu_bo(bo);
1304
1305         if (abo->kfd_bo)
1306                 amdgpu_amdkfd_unreserve_memory_limit(abo);
1307
1308         /* We only remove the fence if the resv has individualized. */
1309         WARN_ON_ONCE(bo->type == ttm_bo_type_kernel
1310                         && bo->base.resv != &bo->base._resv);
1311         if (bo->base.resv == &bo->base._resv)
1312                 amdgpu_amdkfd_remove_fence_on_pt_pd_bos(abo);
1313
1314         if (bo->mem.mem_type != TTM_PL_VRAM || !bo->mem.mm_node ||
1315             !(abo->flags & AMDGPU_GEM_CREATE_VRAM_WIPE_ON_RELEASE))
1316                 return;
1317
1318         dma_resv_lock(bo->base.resv, NULL);
1319
1320         r = amdgpu_fill_buffer(abo, AMDGPU_POISON, bo->base.resv, &fence);
1321         if (!WARN_ON(r)) {
1322                 amdgpu_bo_fence(abo, fence, false);
1323                 dma_fence_put(fence);
1324         }
1325
1326         dma_resv_unlock(bo->base.resv);
1327 }
1328
1329 /**
1330  * amdgpu_bo_fault_reserve_notify - notification about a memory fault
1331  * @bo: pointer to a buffer object
1332  *
1333  * Notifies the driver we are taking a fault on this BO and have reserved it,
1334  * also performs bookkeeping.
1335  * TTM driver callback for dealing with vm faults.
1336  *
1337  * Returns:
1338  * 0 for success or a negative error code on failure.
1339  */
1340 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo)
1341 {
1342         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1343         struct ttm_operation_ctx ctx = { false, false };
1344         struct amdgpu_bo *abo = ttm_to_amdgpu_bo(bo);
1345         unsigned long offset, size;
1346         int r;
1347
1348         /* Remember that this BO was accessed by the CPU */
1349         abo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
1350
1351         if (bo->mem.mem_type != TTM_PL_VRAM)
1352                 return 0;
1353
1354         size = bo->mem.num_pages << PAGE_SHIFT;
1355         offset = bo->mem.start << PAGE_SHIFT;
1356         if ((offset + size) <= adev->gmc.visible_vram_size)
1357                 return 0;
1358
1359         /* Can't move a pinned BO to visible VRAM */
1360         if (abo->tbo.pin_count > 0)
1361                 return VM_FAULT_SIGBUS;
1362
1363         /* hurrah the memory is not visible ! */
1364         atomic64_inc(&adev->num_vram_cpu_page_faults);
1365         amdgpu_bo_placement_from_domain(abo, AMDGPU_GEM_DOMAIN_VRAM |
1366                                         AMDGPU_GEM_DOMAIN_GTT);
1367
1368         /* Avoid costly evictions; only set GTT as a busy placement */
1369         abo->placement.num_busy_placement = 1;
1370         abo->placement.busy_placement = &abo->placements[1];
1371
1372         r = ttm_bo_validate(bo, &abo->placement, &ctx);
1373         if (unlikely(r == -EBUSY || r == -ERESTARTSYS))
1374                 return VM_FAULT_NOPAGE;
1375         else if (unlikely(r))
1376                 return VM_FAULT_SIGBUS;
1377
1378         offset = bo->mem.start << PAGE_SHIFT;
1379         /* this should never happen */
1380         if (bo->mem.mem_type == TTM_PL_VRAM &&
1381             (offset + size) > adev->gmc.visible_vram_size)
1382                 return VM_FAULT_SIGBUS;
1383
1384         ttm_bo_move_to_lru_tail_unlocked(bo);
1385         return 0;
1386 }
1387
1388 /**
1389  * amdgpu_bo_fence - add fence to buffer object
1390  *
1391  * @bo: buffer object in question
1392  * @fence: fence to add
1393  * @shared: true if fence should be added shared
1394  *
1395  */
1396 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
1397                      bool shared)
1398 {
1399         struct dma_resv *resv = bo->tbo.base.resv;
1400
1401         if (shared)
1402                 dma_resv_add_shared_fence(resv, fence);
1403         else
1404                 dma_resv_add_excl_fence(resv, fence);
1405 }
1406
1407 /**
1408  * amdgpu_bo_sync_wait_resv - Wait for BO reservation fences
1409  *
1410  * @adev: amdgpu device pointer
1411  * @resv: reservation object to sync to
1412  * @sync_mode: synchronization mode
1413  * @owner: fence owner
1414  * @intr: Whether the wait is interruptible
1415  *
1416  * Extract the fences from the reservation object and waits for them to finish.
1417  *
1418  * Returns:
1419  * 0 on success, errno otherwise.
1420  */
1421 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
1422                              enum amdgpu_sync_mode sync_mode, void *owner,
1423                              bool intr)
1424 {
1425         struct amdgpu_sync sync;
1426         int r;
1427
1428         amdgpu_sync_create(&sync);
1429         amdgpu_sync_resv(adev, &sync, resv, sync_mode, owner);
1430         r = amdgpu_sync_wait(&sync, intr);
1431         amdgpu_sync_free(&sync);
1432         return r;
1433 }
1434
1435 /**
1436  * amdgpu_bo_sync_wait - Wrapper for amdgpu_bo_sync_wait_resv
1437  * @bo: buffer object to wait for
1438  * @owner: fence owner
1439  * @intr: Whether the wait is interruptible
1440  *
1441  * Wrapper to wait for fences in a BO.
1442  * Returns:
1443  * 0 on success, errno otherwise.
1444  */
1445 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr)
1446 {
1447         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1448
1449         return amdgpu_bo_sync_wait_resv(adev, bo->tbo.base.resv,
1450                                         AMDGPU_SYNC_NE_OWNER, owner, intr);
1451 }
1452
1453 /**
1454  * amdgpu_bo_gpu_offset - return GPU offset of bo
1455  * @bo: amdgpu object for which we query the offset
1456  *
1457  * Note: object should either be pinned or reserved when calling this
1458  * function, it might be useful to add check for this for debugging.
1459  *
1460  * Returns:
1461  * current GPU offset of the object.
1462  */
1463 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo)
1464 {
1465         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_SYSTEM);
1466         WARN_ON_ONCE(!dma_resv_is_locked(bo->tbo.base.resv) &&
1467                      !bo->tbo.pin_count && bo->tbo.type != ttm_bo_type_kernel);
1468         WARN_ON_ONCE(bo->tbo.mem.start == AMDGPU_BO_INVALID_OFFSET);
1469         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_VRAM &&
1470                      !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1471
1472         return amdgpu_bo_gpu_offset_no_check(bo);
1473 }
1474
1475 /**
1476  * amdgpu_bo_gpu_offset_no_check - return GPU offset of bo
1477  * @bo: amdgpu object for which we query the offset
1478  *
1479  * Returns:
1480  * current GPU offset of the object without raising warnings.
1481  */
1482 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo)
1483 {
1484         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1485         uint64_t offset;
1486
1487         offset = (bo->tbo.mem.start << PAGE_SHIFT) +
1488                  amdgpu_ttm_domain_start(adev, bo->tbo.mem.mem_type);
1489
1490         return amdgpu_gmc_sign_extend(offset);
1491 }
1492
1493 /**
1494  * amdgpu_bo_get_preferred_pin_domain - get preferred domain for scanout
1495  * @adev: amdgpu device object
1496  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1497  *
1498  * Returns:
1499  * Which of the allowed domains is preferred for pinning the BO for scanout.
1500  */
1501 uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
1502                                             uint32_t domain)
1503 {
1504         if (domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) {
1505                 domain = AMDGPU_GEM_DOMAIN_VRAM;
1506                 if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1507                         domain = AMDGPU_GEM_DOMAIN_GTT;
1508         }
1509         return domain;
1510 }