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