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