drivers/gpu/drm/vc4/vc4_bo.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  Copyright © 2015 Broadcom
   4  */
   5
   6 /**
   7  * DOC: VC4 GEM BO management support
   8  *
   9  * The VC4 GPU architecture (both scanout and rendering) has direct
  10  * access to system memory with no MMU in between.  To support it, we
  11  * use the GEM CMA helper functions to allocate contiguous ranges of
  12  * physical memory for our BOs.
  13  *
  14  * Since the CMA allocator is very slow, we keep a cache of recently
  15  * freed BOs around so that the kernel's allocation of objects for 3D
  16  * rendering can return quickly.
  17  */
  18
  19 #include <linux/dma-buf.h>
  20
  21 #include "vc4_drv.h"
  22 #include "uapi/drm/vc4_drm.h"
  23
  24 static const struct drm_gem_object_funcs vc4_gem_object_funcs;
  25
  26 static const char * const bo_type_names[] = {
  27         "kernel",
  28         "V3D",
  29         "V3D shader",
  30         "dumb",
  31         "binner",
  32         "RCL",
  33         "BCL",
  34         "kernel BO cache",
  35 };
  36
  37 static bool is_user_label(int label)
  38 {
  39         return label >= VC4_BO_TYPE_COUNT;
  40 }
  41
  42 static void vc4_bo_stats_print(struct drm_printer *p, struct vc4_dev *vc4)
  43 {
  44         int i;
  45
  46         for (i = 0; i < vc4->num_labels; i++) {
  47                 if (!vc4->bo_labels[i].num_allocated)
  48                         continue;
  49
  50                 drm_printf(p, "%30s: %6dkb BOs (%d)\n",
  51                            vc4->bo_labels[i].name,
  52                            vc4->bo_labels[i].size_allocated / 1024,
  53                            vc4->bo_labels[i].num_allocated);
  54         }
  55
  56         mutex_lock(&vc4->purgeable.lock);
  57         if (vc4->purgeable.num)
  58                 drm_printf(p, "%30s: %6zdkb BOs (%d)\n", "userspace BO cache",
  59                            vc4->purgeable.size / 1024, vc4->purgeable.num);
  60
  61         if (vc4->purgeable.purged_num)
  62                 drm_printf(p, "%30s: %6zdkb BOs (%d)\n", "total purged BO",
  63                            vc4->purgeable.purged_size / 1024,
  64                            vc4->purgeable.purged_num);
  65         mutex_unlock(&vc4->purgeable.lock);
  66 }
  67
  68 static int vc4_bo_stats_debugfs(struct seq_file *m, void *unused)
  69 {
  70         struct drm_info_node *node = (struct drm_info_node *)m->private;
  71         struct drm_device *dev = node->minor->dev;
  72         struct vc4_dev *vc4 = to_vc4_dev(dev);
  73         struct drm_printer p = drm_seq_file_printer(m);
  74
  75         vc4_bo_stats_print(&p, vc4);
  76
  77         return 0;
  78 }
  79
  80 /* Takes ownership of *name and returns the appropriate slot for it in
  81  * the bo_labels[] array, extending it as necessary.
  82  *
  83  * This is inefficient and could use a hash table instead of walking
  84  * an array and strcmp()ing.  However, the assumption is that user
  85  * labeling will be infrequent (scanout buffers and other long-lived
  86  * objects, or debug driver builds), so we can live with it for now.
  87  */
  88 static int vc4_get_user_label(struct vc4_dev *vc4, const char *name)
  89 {
  90         int i;
  91         int free_slot = -1;
  92
  93         for (i = 0; i < vc4->num_labels; i++) {
  94                 if (!vc4->bo_labels[i].name) {
  95                         free_slot = i;
  96                 } else if (strcmp(vc4->bo_labels[i].name, name) == 0) {
  97                         kfree(name);
  98                         return i;
  99                 }
 100         }
 101
 102         if (free_slot != -1) {
 103                 WARN_ON(vc4->bo_labels[free_slot].num_allocated != 0);
 104                 vc4->bo_labels[free_slot].name = name;
 105                 return free_slot;
 106         } else {
 107                 u32 new_label_count = vc4->num_labels + 1;
 108                 struct vc4_label *new_labels =
 109                         krealloc(vc4->bo_labels,
 110                                  new_label_count * sizeof(*new_labels),
 111                                  GFP_KERNEL);
 112
 113                 if (!new_labels) {
 114                         kfree(name);
 115                         return -1;
 116                 }
 117
 118                 free_slot = vc4->num_labels;
 119                 vc4->bo_labels = new_labels;
 120                 vc4->num_labels = new_label_count;
 121
 122                 vc4->bo_labels[free_slot].name = name;
 123                 vc4->bo_labels[free_slot].num_allocated = 0;
 124                 vc4->bo_labels[free_slot].size_allocated = 0;
 125
 126                 return free_slot;
 127         }
 128 }
 129
 130 static void vc4_bo_set_label(struct drm_gem_object *gem_obj, int label)
 131 {
 132         struct vc4_bo *bo = to_vc4_bo(gem_obj);
 133         struct vc4_dev *vc4 = to_vc4_dev(gem_obj->dev);
 134
 135         lockdep_assert_held(&vc4->bo_lock);
 136
 137         if (label != -1) {
 138                 vc4->bo_labels[label].num_allocated++;
 139                 vc4->bo_labels[label].size_allocated += gem_obj->size;
 140         }
 141
 142         vc4->bo_labels[bo->label].num_allocated--;
 143         vc4->bo_labels[bo->label].size_allocated -= gem_obj->size;
 144
 145         if (vc4->bo_labels[bo->label].num_allocated == 0 &&
 146             is_user_label(bo->label)) {
 147                 /* Free user BO label slots on last unreference.
 148                  * Slots are just where we track the stats for a given
 149                  * name, and once a name is unused we can reuse that
 150                  * slot.
 151                  */
 152                 kfree(vc4->bo_labels[bo->label].name);
 153                 vc4->bo_labels[bo->label].name = NULL;
 154         }
 155
 156         bo->label = label;
 157 }
 158
 159 static uint32_t bo_page_index(size_t size)
 160 {
 161         return (size / PAGE_SIZE) - 1;
 162 }
 163
 164 static void vc4_bo_destroy(struct vc4_bo *bo)
 165 {
 166         struct drm_gem_object *obj = &bo->base.base;
 167         struct vc4_dev *vc4 = to_vc4_dev(obj->dev);
 168
 169         lockdep_assert_held(&vc4->bo_lock);
 170
 171         vc4_bo_set_label(obj, -1);
 172
 173         if (bo->validated_shader) {
 174                 kfree(bo->validated_shader->uniform_addr_offsets);
 175                 kfree(bo->validated_shader->texture_samples);
 176                 kfree(bo->validated_shader);
 177                 bo->validated_shader = NULL;
 178         }
 179
 180         drm_gem_cma_free_object(obj);
 181 }
 182
 183 static void vc4_bo_remove_from_cache(struct vc4_bo *bo)
 184 {
 185         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 186
 187         lockdep_assert_held(&vc4->bo_lock);
 188         list_del(&bo->unref_head);
 189         list_del(&bo->size_head);
 190 }
 191
 192 static struct list_head *vc4_get_cache_list_for_size(struct drm_device *dev,
 193                                                      size_t size)
 194 {
 195         struct vc4_dev *vc4 = to_vc4_dev(dev);
 196         uint32_t page_index = bo_page_index(size);
 197
 198         if (vc4->bo_cache.size_list_size <= page_index) {
 199                 uint32_t new_size = max(vc4->bo_cache.size_list_size * 2,
 200                                         page_index + 1);
 201                 struct list_head *new_list;
 202                 uint32_t i;
 203
 204                 new_list = kmalloc_array(new_size, sizeof(struct list_head),
 205                                          GFP_KERNEL);
 206                 if (!new_list)
 207                         return NULL;
 208
 209                 /* Rebase the old cached BO lists to their new list
 210                  * head locations.
 211                  */
 212                 for (i = 0; i < vc4->bo_cache.size_list_size; i++) {
 213                         struct list_head *old_list =
 214                                 &vc4->bo_cache.size_list[i];
 215
 216                         if (list_empty(old_list))
 217                                 INIT_LIST_HEAD(&new_list[i]);
 218                         else
 219                                 list_replace(old_list, &new_list[i]);
 220                 }
 221                 /* And initialize the brand new BO list heads. */
 222                 for (i = vc4->bo_cache.size_list_size; i < new_size; i++)
 223                         INIT_LIST_HEAD(&new_list[i]);
 224
 225                 kfree(vc4->bo_cache.size_list);
 226                 vc4->bo_cache.size_list = new_list;
 227                 vc4->bo_cache.size_list_size = new_size;
 228         }
 229
 230         return &vc4->bo_cache.size_list[page_index];
 231 }
 232
 233 static void vc4_bo_cache_purge(struct drm_device *dev)
 234 {
 235         struct vc4_dev *vc4 = to_vc4_dev(dev);
 236
 237         mutex_lock(&vc4->bo_lock);
 238         while (!list_empty(&vc4->bo_cache.time_list)) {
 239                 struct vc4_bo *bo = list_last_entry(&vc4->bo_cache.time_list,
 240                                                     struct vc4_bo, unref_head);
 241                 vc4_bo_remove_from_cache(bo);
 242                 vc4_bo_destroy(bo);
 243         }
 244         mutex_unlock(&vc4->bo_lock);
 245 }
 246
 247 void vc4_bo_add_to_purgeable_pool(struct vc4_bo *bo)
 248 {
 249         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 250
 251         if (WARN_ON_ONCE(vc4->is_vc5))
 252                 return;
 253
 254         mutex_lock(&vc4->purgeable.lock);
 255         list_add_tail(&bo->size_head, &vc4->purgeable.list);
 256         vc4->purgeable.num++;
 257         vc4->purgeable.size += bo->base.base.size;
 258         mutex_unlock(&vc4->purgeable.lock);
 259 }
 260
 261 static void vc4_bo_remove_from_purgeable_pool_locked(struct vc4_bo *bo)
 262 {
 263         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 264
 265         if (WARN_ON_ONCE(vc4->is_vc5))
 266                 return;
 267
 268         /* list_del_init() is used here because the caller might release
 269          * the purgeable lock in order to acquire the madv one and update the
 270          * madv status.
 271          * During this short period of time a user might decide to mark
 272          * the BO as unpurgeable, and if bo->madv is set to
 273          * VC4_MADV_DONTNEED it will try to remove the BO from the
 274          * purgeable list which will fail if the ->next/prev fields
 275          * are set to LIST_POISON1/LIST_POISON2 (which is what
 276          * list_del() does).
 277          * Re-initializing the list element guarantees that list_del()
 278          * will work correctly even if it's a NOP.
 279          */
 280         list_del_init(&bo->size_head);
 281         vc4->purgeable.num--;
 282         vc4->purgeable.size -= bo->base.base.size;
 283 }
 284
 285 void vc4_bo_remove_from_purgeable_pool(struct vc4_bo *bo)
 286 {
 287         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 288
 289         mutex_lock(&vc4->purgeable.lock);
 290         vc4_bo_remove_from_purgeable_pool_locked(bo);
 291         mutex_unlock(&vc4->purgeable.lock);
 292 }
 293
 294 static void vc4_bo_purge(struct drm_gem_object *obj)
 295 {
 296         struct vc4_bo *bo = to_vc4_bo(obj);
 297         struct drm_device *dev = obj->dev;
 298
 299         WARN_ON(!mutex_is_locked(&bo->madv_lock));
 300         WARN_ON(bo->madv != VC4_MADV_DONTNEED);
 301
 302         drm_vma_node_unmap(&obj->vma_node, dev->anon_inode->i_mapping);
 303
 304         dma_free_wc(dev->dev, obj->size, bo->base.vaddr, bo->base.paddr);
 305         bo->base.vaddr = NULL;
 306         bo->madv = __VC4_MADV_PURGED;
 307 }
 308
 309 static void vc4_bo_userspace_cache_purge(struct drm_device *dev)
 310 {
 311         struct vc4_dev *vc4 = to_vc4_dev(dev);
 312
 313         mutex_lock(&vc4->purgeable.lock);
 314         while (!list_empty(&vc4->purgeable.list)) {
 315                 struct vc4_bo *bo = list_first_entry(&vc4->purgeable.list,
 316                                                      struct vc4_bo, size_head);
 317                 struct drm_gem_object *obj = &bo->base.base;
 318                 size_t purged_size = 0;
 319
 320                 vc4_bo_remove_from_purgeable_pool_locked(bo);
 321
 322                 /* Release the purgeable lock while we're purging the BO so
 323                  * that other people can continue inserting things in the
 324                  * purgeable pool without having to wait for all BOs to be
 325                  * purged.
 326                  */
 327                 mutex_unlock(&vc4->purgeable.lock);
 328                 mutex_lock(&bo->madv_lock);
 329
 330                 /* Since we released the purgeable pool lock before acquiring
 331                  * the BO madv one, the user may have marked the BO as WILLNEED
 332                  * and re-used it in the meantime.
 333                  * Before purging the BO we need to make sure
 334                  * - it is still marked as DONTNEED
 335                  * - it has not been re-inserted in the purgeable list
 336                  * - it is not used by HW blocks
 337                  * If one of these conditions is not met, just skip the entry.
 338                  */
 339                 if (bo->madv == VC4_MADV_DONTNEED &&
 340                     list_empty(&bo->size_head) &&
 341                     !refcount_read(&bo->usecnt)) {
 342                         purged_size = bo->base.base.size;
 343                         vc4_bo_purge(obj);
 344                 }
 345                 mutex_unlock(&bo->madv_lock);
 346                 mutex_lock(&vc4->purgeable.lock);
 347
 348                 if (purged_size) {
 349                         vc4->purgeable.purged_size += purged_size;
 350                         vc4->purgeable.purged_num++;
 351                 }
 352         }
 353         mutex_unlock(&vc4->purgeable.lock);
 354 }
 355
 356 static struct vc4_bo *vc4_bo_get_from_cache(struct drm_device *dev,
 357                                             uint32_t size,
 358                                             enum vc4_kernel_bo_type type)
 359 {
 360         struct vc4_dev *vc4 = to_vc4_dev(dev);
 361         uint32_t page_index = bo_page_index(size);
 362         struct vc4_bo *bo = NULL;
 363
 364         size = roundup(size, PAGE_SIZE);
 365
 366         mutex_lock(&vc4->bo_lock);
 367         if (page_index >= vc4->bo_cache.size_list_size)
 368                 goto out;
 369
 370         if (list_empty(&vc4->bo_cache.size_list[page_index]))
 371                 goto out;
 372
 373         bo = list_first_entry(&vc4->bo_cache.size_list[page_index],
 374                               struct vc4_bo, size_head);
 375         vc4_bo_remove_from_cache(bo);
 376         kref_init(&bo->base.base.refcount);
 377
 378 out:
 379         if (bo)
 380                 vc4_bo_set_label(&bo->base.base, type);
 381         mutex_unlock(&vc4->bo_lock);
 382         return bo;
 383 }
 384
 385 /**
 386  * vc4_create_object - Implementation of driver->gem_create_object.
 387  * @dev: DRM device
 388  * @size: Size in bytes of the memory the object will reference
 389  *
 390  * This lets the CMA helpers allocate object structs for us, and keep
 391  * our BO stats correct.
 392  */
 393 struct drm_gem_object *vc4_create_object(struct drm_device *dev, size_t size)
 394 {
 395         struct vc4_dev *vc4 = to_vc4_dev(dev);
 396         struct vc4_bo *bo;
 397
 398         if (WARN_ON_ONCE(vc4->is_vc5))
 399                 return ERR_PTR(-ENODEV);
 400
 401         bo = kzalloc(sizeof(*bo), GFP_KERNEL);
 402         if (!bo)
 403                 return NULL;
 404
 405         bo->madv = VC4_MADV_WILLNEED;
 406         refcount_set(&bo->usecnt, 0);
 407         mutex_init(&bo->madv_lock);
 408         mutex_lock(&vc4->bo_lock);
 409         bo->label = VC4_BO_TYPE_KERNEL;
 410         vc4->bo_labels[VC4_BO_TYPE_KERNEL].num_allocated++;
 411         vc4->bo_labels[VC4_BO_TYPE_KERNEL].size_allocated += size;
 412         mutex_unlock(&vc4->bo_lock);
 413
 414         bo->base.base.funcs = &vc4_gem_object_funcs;
 415
 416         return &bo->base.base;
 417 }
 418
 419 struct vc4_bo *vc4_bo_create(struct drm_device *dev, size_t unaligned_size,
 420                              bool allow_unzeroed, enum vc4_kernel_bo_type type)
 421 {
 422         size_t size = roundup(unaligned_size, PAGE_SIZE);
 423         struct vc4_dev *vc4 = to_vc4_dev(dev);
 424         struct drm_gem_cma_object *cma_obj;
 425         struct vc4_bo *bo;
 426
 427         if (WARN_ON_ONCE(vc4->is_vc5))
 428                 return ERR_PTR(-ENODEV);
 429
 430         if (size == 0)
 431                 return ERR_PTR(-EINVAL);
 432
 433         /* First, try to get a vc4_bo from the kernel BO cache. */
 434         bo = vc4_bo_get_from_cache(dev, size, type);
 435         if (bo) {
 436                 if (!allow_unzeroed)
 437                         memset(bo->base.vaddr, 0, bo->base.base.size);
 438                 return bo;
 439         }
 440
 441         cma_obj = drm_gem_cma_create(dev, size);
 442         if (IS_ERR(cma_obj)) {
 443                 /*
 444                  * If we've run out of CMA memory, kill the cache of
 445                  * CMA allocations we've got laying around and try again.
 446                  */
 447                 vc4_bo_cache_purge(dev);
 448                 cma_obj = drm_gem_cma_create(dev, size);
 449         }
 450
 451         if (IS_ERR(cma_obj)) {
 452                 /*
 453                  * Still not enough CMA memory, purge the userspace BO
 454                  * cache and retry.
 455                  * This is sub-optimal since we purge the whole userspace
 456                  * BO cache which forces user that want to re-use the BO to
 457                  * restore its initial content.
 458                  * Ideally, we should purge entries one by one and retry
 459                  * after each to see if CMA allocation succeeds. Or even
 460                  * better, try to find an entry with at least the same
 461                  * size.
 462                  */
 463                 vc4_bo_userspace_cache_purge(dev);
 464                 cma_obj = drm_gem_cma_create(dev, size);
 465         }
 466
 467         if (IS_ERR(cma_obj)) {
 468                 struct drm_printer p = drm_info_printer(vc4->base.dev);
 469                 DRM_ERROR("Failed to allocate from CMA:\n");
 470                 vc4_bo_stats_print(&p, vc4);
 471                 return ERR_PTR(-ENOMEM);
 472         }
 473         bo = to_vc4_bo(&cma_obj->base);
 474
 475         /* By default, BOs do not support the MADV ioctl. This will be enabled
 476          * only on BOs that are exposed to userspace (V3D, V3D_SHADER and DUMB
 477          * BOs).
 478          */
 479         bo->madv = __VC4_MADV_NOTSUPP;
 480
 481         mutex_lock(&vc4->bo_lock);
 482         vc4_bo_set_label(&cma_obj->base, type);
 483         mutex_unlock(&vc4->bo_lock);
 484
 485         return bo;
 486 }
 487
 488 int vc4_bo_dumb_create(struct drm_file *file_priv,
 489                        struct drm_device *dev,
 490                        struct drm_mode_create_dumb *args)
 491 {
 492         struct vc4_dev *vc4 = to_vc4_dev(dev);
 493         struct vc4_bo *bo = NULL;
 494         int ret;
 495
 496         if (WARN_ON_ONCE(vc4->is_vc5))
 497                 return -ENODEV;
 498
 499         ret = vc4_dumb_fixup_args(args);
 500         if (ret)
 501                 return ret;
 502
 503         bo = vc4_bo_create(dev, args->size, false, VC4_BO_TYPE_DUMB);
 504         if (IS_ERR(bo))
 505                 return PTR_ERR(bo);
 506
 507         bo->madv = VC4_MADV_WILLNEED;
 508
 509         ret = drm_gem_handle_create(file_priv, &bo->base.base, &args->handle);
 510         drm_gem_object_put(&bo->base.base);
 511
 512         return ret;
 513 }
 514
 515 static void vc4_bo_cache_free_old(struct drm_device *dev)
 516 {
 517         struct vc4_dev *vc4 = to_vc4_dev(dev);
 518         unsigned long expire_time = jiffies - msecs_to_jiffies(1000);
 519
 520         lockdep_assert_held(&vc4->bo_lock);
 521
 522         while (!list_empty(&vc4->bo_cache.time_list)) {
 523                 struct vc4_bo *bo = list_last_entry(&vc4->bo_cache.time_list,
 524                                                     struct vc4_bo, unref_head);
 525                 if (time_before(expire_time, bo->free_time)) {
 526                         mod_timer(&vc4->bo_cache.time_timer,
 527                                   round_jiffies_up(jiffies +
 528                                                    msecs_to_jiffies(1000)));
 529                         return;
 530                 }
 531
 532                 vc4_bo_remove_from_cache(bo);
 533                 vc4_bo_destroy(bo);
 534         }
 535 }
 536
 537 /* Called on the last userspace/kernel unreference of the BO.  Returns
 538  * it to the BO cache if possible, otherwise frees it.
 539  */
 540 static void vc4_free_object(struct drm_gem_object *gem_bo)
 541 {
 542         struct drm_device *dev = gem_bo->dev;
 543         struct vc4_dev *vc4 = to_vc4_dev(dev);
 544         struct vc4_bo *bo = to_vc4_bo(gem_bo);
 545         struct list_head *cache_list;
 546
 547         /* Remove the BO from the purgeable list. */
 548         mutex_lock(&bo->madv_lock);
 549         if (bo->madv == VC4_MADV_DONTNEED && !refcount_read(&bo->usecnt))
 550                 vc4_bo_remove_from_purgeable_pool(bo);
 551         mutex_unlock(&bo->madv_lock);
 552
 553         mutex_lock(&vc4->bo_lock);
 554         /* If the object references someone else's memory, we can't cache it.
 555          */
 556         if (gem_bo->import_attach) {
 557                 vc4_bo_destroy(bo);
 558                 goto out;
 559         }
 560
 561         /* Don't cache if it was publicly named. */
 562         if (gem_bo->name) {
 563                 vc4_bo_destroy(bo);
 564                 goto out;
 565         }
 566
 567         /* If this object was partially constructed but CMA allocation
 568          * had failed, just free it. Can also happen when the BO has been
 569          * purged.
 570          */
 571         if (!bo->base.vaddr) {
 572                 vc4_bo_destroy(bo);
 573                 goto out;
 574         }
 575
 576         cache_list = vc4_get_cache_list_for_size(dev, gem_bo->size);
 577         if (!cache_list) {
 578                 vc4_bo_destroy(bo);
 579                 goto out;
 580         }
 581
 582         if (bo->validated_shader) {
 583                 kfree(bo->validated_shader->uniform_addr_offsets);
 584                 kfree(bo->validated_shader->texture_samples);
 585                 kfree(bo->validated_shader);
 586                 bo->validated_shader = NULL;
 587         }
 588
 589         /* Reset madv and usecnt before adding the BO to the cache. */
 590         bo->madv = __VC4_MADV_NOTSUPP;
 591         refcount_set(&bo->usecnt, 0);
 592
 593         bo->t_format = false;
 594         bo->free_time = jiffies;
 595         list_add(&bo->size_head, cache_list);
 596         list_add(&bo->unref_head, &vc4->bo_cache.time_list);
 597
 598         vc4_bo_set_label(&bo->base.base, VC4_BO_TYPE_KERNEL_CACHE);
 599
 600         vc4_bo_cache_free_old(dev);
 601
 602 out:
 603         mutex_unlock(&vc4->bo_lock);
 604 }
 605
 606 static void vc4_bo_cache_time_work(struct work_struct *work)
 607 {
 608         struct vc4_dev *vc4 =
 609                 container_of(work, struct vc4_dev, bo_cache.time_work);
 610         struct drm_device *dev = &vc4->base;
 611
 612         mutex_lock(&vc4->bo_lock);
 613         vc4_bo_cache_free_old(dev);
 614         mutex_unlock(&vc4->bo_lock);
 615 }
 616
 617 int vc4_bo_inc_usecnt(struct vc4_bo *bo)
 618 {
 619         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 620         int ret;
 621
 622         if (WARN_ON_ONCE(vc4->is_vc5))
 623                 return -ENODEV;
 624
 625         /* Fast path: if the BO is already retained by someone, no need to
 626          * check the madv status.
 627          */
 628         if (refcount_inc_not_zero(&bo->usecnt))
 629                 return 0;
 630
 631         mutex_lock(&bo->madv_lock);
 632         switch (bo->madv) {
 633         case VC4_MADV_WILLNEED:
 634                 if (!refcount_inc_not_zero(&bo->usecnt))
 635                         refcount_set(&bo->usecnt, 1);
 636                 ret = 0;
 637                 break;
 638         case VC4_MADV_DONTNEED:
 639                 /* We shouldn't use a BO marked as purgeable if at least
 640                  * someone else retained its content by incrementing usecnt.
 641                  * Luckily the BO hasn't been purged yet, but something wrong
 642                  * is happening here. Just throw an error instead of
 643                  * authorizing this use case.
 644                  */
 645         case __VC4_MADV_PURGED:
 646                 /* We can't use a purged BO. */
 647         default:
 648                 /* Invalid madv value. */
 649                 ret = -EINVAL;
 650                 break;
 651         }
 652         mutex_unlock(&bo->madv_lock);
 653
 654         return ret;
 655 }
 656
 657 void vc4_bo_dec_usecnt(struct vc4_bo *bo)
 658 {
 659         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 660
 661         if (WARN_ON_ONCE(vc4->is_vc5))
 662                 return;
 663
 664         /* Fast path: if the BO is still retained by someone, no need to test
 665          * the madv value.
 666          */
 667         if (refcount_dec_not_one(&bo->usecnt))
 668                 return;
 669
 670         mutex_lock(&bo->madv_lock);
 671         if (refcount_dec_and_test(&bo->usecnt) &&
 672             bo->madv == VC4_MADV_DONTNEED)
 673                 vc4_bo_add_to_purgeable_pool(bo);
 674         mutex_unlock(&bo->madv_lock);
 675 }
 676
 677 static void vc4_bo_cache_time_timer(struct timer_list *t)
 678 {
 679         struct vc4_dev *vc4 = from_timer(vc4, t, bo_cache.time_timer);
 680
 681         schedule_work(&vc4->bo_cache.time_work);
 682 }
 683
 684 static struct dma_buf *vc4_prime_export(struct drm_gem_object *obj, int flags)
 685 {
 686         struct vc4_bo *bo = to_vc4_bo(obj);
 687         struct dma_buf *dmabuf;
 688         int ret;
 689
 690         if (bo->validated_shader) {
 691                 DRM_DEBUG("Attempting to export shader BO\n");
 692                 return ERR_PTR(-EINVAL);
 693         }
 694
 695         /* Note: as soon as the BO is exported it becomes unpurgeable, because
 696          * noone ever decrements the usecnt even if the reference held by the
 697          * exported BO is released. This shouldn't be a problem since we don't
 698          * expect exported BOs to be marked as purgeable.
 699          */
 700         ret = vc4_bo_inc_usecnt(bo);
 701         if (ret) {
 702                 DRM_ERROR("Failed to increment BO usecnt\n");
 703                 return ERR_PTR(ret);
 704         }
 705
 706         dmabuf = drm_gem_prime_export(obj, flags);
 707         if (IS_ERR(dmabuf))
 708                 vc4_bo_dec_usecnt(bo);
 709
 710         return dmabuf;
 711 }
 712
 713 static vm_fault_t vc4_fault(struct vm_fault *vmf)
 714 {
 715         struct vm_area_struct *vma = vmf->vma;
 716         struct drm_gem_object *obj = vma->vm_private_data;
 717         struct vc4_bo *bo = to_vc4_bo(obj);
 718
 719         /* The only reason we would end up here is when user-space accesses
 720          * BO's memory after it's been purged.
 721          */
 722         mutex_lock(&bo->madv_lock);
 723         WARN_ON(bo->madv != __VC4_MADV_PURGED);
 724         mutex_unlock(&bo->madv_lock);
 725
 726         return VM_FAULT_SIGBUS;
 727 }
 728
 729 static int vc4_gem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
 730 {
 731         struct vc4_bo *bo = to_vc4_bo(obj);
 732
 733         if (bo->validated_shader && (vma->vm_flags & VM_WRITE)) {
 734                 DRM_DEBUG("mmaping of shader BOs for writing not allowed.\n");
 735                 return -EINVAL;
 736         }
 737
 738         if (bo->madv != VC4_MADV_WILLNEED) {
 739                 DRM_DEBUG("mmaping of %s BO not allowed\n",
 740                           bo->madv == VC4_MADV_DONTNEED ?
 741                           "purgeable" : "purged");
 742                 return -EINVAL;
 743         }
 744
 745         return drm_gem_cma_mmap(obj, vma);
 746 }
 747
 748 static const struct vm_operations_struct vc4_vm_ops = {
 749         .fault = vc4_fault,
 750         .open = drm_gem_vm_open,
 751         .close = drm_gem_vm_close,
 752 };
 753
 754 static const struct drm_gem_object_funcs vc4_gem_object_funcs = {
 755         .free = vc4_free_object,
 756         .export = vc4_prime_export,
 757         .get_sg_table = drm_gem_cma_get_sg_table,
 758         .vmap = drm_gem_cma_vmap,
 759         .mmap = vc4_gem_object_mmap,
 760         .vm_ops = &vc4_vm_ops,
 761 };
 762
 763 static int vc4_grab_bin_bo(struct vc4_dev *vc4, struct vc4_file *vc4file)
 764 {
 765         int ret;
 766
 767         if (!vc4->v3d)
 768                 return -ENODEV;
 769
 770         if (vc4file->bin_bo_used)
 771                 return 0;
 772
 773         ret = vc4_v3d_bin_bo_get(vc4, &vc4file->bin_bo_used);
 774         if (ret)
 775                 return ret;
 776
 777         return 0;
 778 }
 779
 780 int vc4_create_bo_ioctl(struct drm_device *dev, void *data,
 781                         struct drm_file *file_priv)
 782 {
 783         struct drm_vc4_create_bo *args = data;
 784         struct vc4_file *vc4file = file_priv->driver_priv;
 785         struct vc4_dev *vc4 = to_vc4_dev(dev);
 786         struct vc4_bo *bo = NULL;
 787         int ret;
 788
 789         if (WARN_ON_ONCE(vc4->is_vc5))
 790                 return -ENODEV;
 791
 792         ret = vc4_grab_bin_bo(vc4, vc4file);
 793         if (ret)
 794                 return ret;
 795
 796         /*
 797          * We can't allocate from the BO cache, because the BOs don't
 798          * get zeroed, and that might leak data between users.
 799          */
 800         bo = vc4_bo_create(dev, args->size, false, VC4_BO_TYPE_V3D);
 801         if (IS_ERR(bo))
 802                 return PTR_ERR(bo);
 803
 804         bo->madv = VC4_MADV_WILLNEED;
 805
 806         ret = drm_gem_handle_create(file_priv, &bo->base.base, &args->handle);
 807         drm_gem_object_put(&bo->base.base);
 808
 809         return ret;
 810 }
 811
 812 int vc4_mmap_bo_ioctl(struct drm_device *dev, void *data,
 813                       struct drm_file *file_priv)
 814 {
 815         struct vc4_dev *vc4 = to_vc4_dev(dev);
 816         struct drm_vc4_mmap_bo *args = data;
 817         struct drm_gem_object *gem_obj;
 818
 819         if (WARN_ON_ONCE(vc4->is_vc5))
 820                 return -ENODEV;
 821
 822         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
 823         if (!gem_obj) {
 824                 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
 825                 return -EINVAL;
 826         }
 827
 828         /* The mmap offset was set up at BO allocation time. */
 829         args->offset = drm_vma_node_offset_addr(&gem_obj->vma_node);
 830
 831         drm_gem_object_put(gem_obj);
 832         return 0;
 833 }
 834
 835 int
 836 vc4_create_shader_bo_ioctl(struct drm_device *dev, void *data,
 837                            struct drm_file *file_priv)
 838 {
 839         struct drm_vc4_create_shader_bo *args = data;
 840         struct vc4_file *vc4file = file_priv->driver_priv;
 841         struct vc4_dev *vc4 = to_vc4_dev(dev);
 842         struct vc4_bo *bo = NULL;
 843         int ret;
 844
 845         if (WARN_ON_ONCE(vc4->is_vc5))
 846                 return -ENODEV;
 847
 848         if (args->size == 0)
 849                 return -EINVAL;
 850
 851         if (args->size % sizeof(u64) != 0)
 852                 return -EINVAL;
 853
 854         if (args->flags != 0) {
 855                 DRM_INFO("Unknown flags set: 0x%08x\n", args->flags);
 856                 return -EINVAL;
 857         }
 858
 859         if (args->pad != 0) {
 860                 DRM_INFO("Pad set: 0x%08x\n", args->pad);
 861                 return -EINVAL;
 862         }
 863
 864         ret = vc4_grab_bin_bo(vc4, vc4file);
 865         if (ret)
 866                 return ret;
 867
 868         bo = vc4_bo_create(dev, args->size, true, VC4_BO_TYPE_V3D_SHADER);
 869         if (IS_ERR(bo))
 870                 return PTR_ERR(bo);
 871
 872         bo->madv = VC4_MADV_WILLNEED;
 873
 874         if (copy_from_user(bo->base.vaddr,
 875                              (void __user *)(uintptr_t)args->data,
 876                              args->size)) {
 877                 ret = -EFAULT;
 878                 goto fail;
 879         }
 880         /* Clear the rest of the memory from allocating from the BO
 881          * cache.
 882          */
 883         memset(bo->base.vaddr + args->size, 0,
 884                bo->base.base.size - args->size);
 885
 886         bo->validated_shader = vc4_validate_shader(&bo->base);
 887         if (!bo->validated_shader) {
 888                 ret = -EINVAL;
 889                 goto fail;
 890         }
 891
 892         /* We have to create the handle after validation, to avoid
 893          * races for users to do doing things like mmap the shader BO.
 894          */
 895         ret = drm_gem_handle_create(file_priv, &bo->base.base, &args->handle);
 896
 897 fail:
 898         drm_gem_object_put(&bo->base.base);
 899
 900         return ret;
 901 }
 902
 903 /**
 904  * vc4_set_tiling_ioctl() - Sets the tiling modifier for a BO.
 905  * @dev: DRM device
 906  * @data: ioctl argument
 907  * @file_priv: DRM file for this fd
 908  *
 909  * The tiling state of the BO decides the default modifier of an fb if
 910  * no specific modifier was set by userspace, and the return value of
 911  * vc4_get_tiling_ioctl() (so that userspace can treat a BO it
 912  * received from dmabuf as the same tiling format as the producer
 913  * used).
 914  */
 915 int vc4_set_tiling_ioctl(struct drm_device *dev, void *data,
 916                          struct drm_file *file_priv)
 917 {
 918         struct vc4_dev *vc4 = to_vc4_dev(dev);
 919         struct drm_vc4_set_tiling *args = data;
 920         struct drm_gem_object *gem_obj;
 921         struct vc4_bo *bo;
 922         bool t_format;
 923
 924         if (WARN_ON_ONCE(vc4->is_vc5))
 925                 return -ENODEV;
 926
 927         if (args->flags != 0)
 928                 return -EINVAL;
 929
 930         switch (args->modifier) {
 931         case DRM_FORMAT_MOD_NONE:
 932                 t_format = false;
 933                 break;
 934         case DRM_FORMAT_MOD_BROADCOM_VC4_T_TILED:
 935                 t_format = true;
 936                 break;
 937         default:
 938                 return -EINVAL;
 939         }
 940
 941         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
 942         if (!gem_obj) {
 943                 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
 944                 return -ENOENT;
 945         }
 946         bo = to_vc4_bo(gem_obj);
 947         bo->t_format = t_format;
 948
 949         drm_gem_object_put(gem_obj);
 950
 951         return 0;
 952 }
 953
 954 /**
 955  * vc4_get_tiling_ioctl() - Gets the tiling modifier for a BO.
 956  * @dev: DRM device
 957  * @data: ioctl argument
 958  * @file_priv: DRM file for this fd
 959  *
 960  * Returns the tiling modifier for a BO as set by vc4_set_tiling_ioctl().
 961  */
 962 int vc4_get_tiling_ioctl(struct drm_device *dev, void *data,
 963                          struct drm_file *file_priv)
 964 {
 965         struct vc4_dev *vc4 = to_vc4_dev(dev);
 966         struct drm_vc4_get_tiling *args = data;
 967         struct drm_gem_object *gem_obj;
 968         struct vc4_bo *bo;
 969
 970         if (WARN_ON_ONCE(vc4->is_vc5))
 971                 return -ENODEV;
 972
 973         if (args->flags != 0 || args->modifier != 0)
 974                 return -EINVAL;
 975
 976         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
 977         if (!gem_obj) {
 978                 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
 979                 return -ENOENT;
 980         }
 981         bo = to_vc4_bo(gem_obj);
 982
 983         if (bo->t_format)
 984                 args->modifier = DRM_FORMAT_MOD_BROADCOM_VC4_T_TILED;
 985         else
 986                 args->modifier = DRM_FORMAT_MOD_NONE;
 987
 988         drm_gem_object_put(gem_obj);
 989
 990         return 0;
 991 }
 992
 993 static void vc4_bo_cache_destroy(struct drm_device *dev, void *unused);
 994 int vc4_bo_cache_init(struct drm_device *dev)
 995 {
 996         struct vc4_dev *vc4 = to_vc4_dev(dev);
 997         int i;
 998
 999         if (WARN_ON_ONCE(vc4->is_vc5))
1000                 return -ENODEV;
1001
1002         /* Create the initial set of BO labels that the kernel will
1003          * use.  This lets us avoid a bunch of string reallocation in
1004          * the kernel's draw and BO allocation paths.
1005          */
1006         vc4->bo_labels = kcalloc(VC4_BO_TYPE_COUNT, sizeof(*vc4->bo_labels),
1007                                  GFP_KERNEL);
1008         if (!vc4->bo_labels)
1009                 return -ENOMEM;
1010         vc4->num_labels = VC4_BO_TYPE_COUNT;
1011
1012         BUILD_BUG_ON(ARRAY_SIZE(bo_type_names) != VC4_BO_TYPE_COUNT);
1013         for (i = 0; i < VC4_BO_TYPE_COUNT; i++)
1014                 vc4->bo_labels[i].name = bo_type_names[i];
1015
1016         mutex_init(&vc4->bo_lock);
1017
1018         vc4_debugfs_add_file(dev, "bo_stats", vc4_bo_stats_debugfs, NULL);
1019
1020         INIT_LIST_HEAD(&vc4->bo_cache.time_list);
1021
1022         INIT_WORK(&vc4->bo_cache.time_work, vc4_bo_cache_time_work);
1023         timer_setup(&vc4->bo_cache.time_timer, vc4_bo_cache_time_timer, 0);
1024
1025         return drmm_add_action_or_reset(dev, vc4_bo_cache_destroy, NULL);
1026 }
1027
1028 static void vc4_bo_cache_destroy(struct drm_device *dev, void *unused)
1029 {
1030         struct vc4_dev *vc4 = to_vc4_dev(dev);
1031         int i;
1032
1033         del_timer(&vc4->bo_cache.time_timer);
1034         cancel_work_sync(&vc4->bo_cache.time_work);
1035
1036         vc4_bo_cache_purge(dev);
1037
1038         for (i = 0; i < vc4->num_labels; i++) {
1039                 if (vc4->bo_labels[i].num_allocated) {
1040                         DRM_ERROR("Destroying BO cache with %d %s "
1041                                   "BOs still allocated\n",
1042                                   vc4->bo_labels[i].num_allocated,
1043                                   vc4->bo_labels[i].name);
1044                 }
1045
1046                 if (is_user_label(i))
1047                         kfree(vc4->bo_labels[i].name);
1048         }
1049         kfree(vc4->bo_labels);
1050 }
1051
1052 int vc4_label_bo_ioctl(struct drm_device *dev, void *data,
1053                        struct drm_file *file_priv)
1054 {
1055         struct vc4_dev *vc4 = to_vc4_dev(dev);
1056         struct drm_vc4_label_bo *args = data;
1057         char *name;
1058         struct drm_gem_object *gem_obj;
1059         int ret = 0, label;
1060
1061         if (WARN_ON_ONCE(vc4->is_vc5))
1062                 return -ENODEV;
1063
1064         if (!args->len)
1065                 return -EINVAL;
1066
1067         name = strndup_user(u64_to_user_ptr(args->name), args->len + 1);
1068         if (IS_ERR(name))
1069                 return PTR_ERR(name);
1070
1071         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
1072         if (!gem_obj) {
1073                 DRM_ERROR("Failed to look up GEM BO %d\n", args->handle);
1074                 kfree(name);
1075                 return -ENOENT;
1076         }
1077
1078         mutex_lock(&vc4->bo_lock);
1079         label = vc4_get_user_label(vc4, name);
1080         if (label != -1)
1081                 vc4_bo_set_label(gem_obj, label);
1082         else
1083                 ret = -ENOMEM;
1084         mutex_unlock(&vc4->bo_lock);
1085
1086         drm_gem_object_put(gem_obj);
1087
1088         return ret;
1089 }