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