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         int ret;
 398
 399         if (WARN_ON_ONCE(vc4->is_vc5))
 400                 return ERR_PTR(-ENODEV);
 401
 402         bo = kzalloc(sizeof(*bo), GFP_KERNEL);
 403         if (!bo)
 404                 return NULL;
 405
 406         bo->madv = VC4_MADV_WILLNEED;
 407         refcount_set(&bo->usecnt, 0);
 408
 409         ret = drmm_mutex_init(dev, &bo->madv_lock);
 410         if (ret)
 411                 return ERR_PTR(ret);
 412
 413         mutex_lock(&vc4->bo_lock);
 414         bo->label = VC4_BO_TYPE_KERNEL;
 415         vc4->bo_labels[VC4_BO_TYPE_KERNEL].num_allocated++;
 416         vc4->bo_labels[VC4_BO_TYPE_KERNEL].size_allocated += size;
 417         mutex_unlock(&vc4->bo_lock);
 418
 419         bo->base.base.funcs = &vc4_gem_object_funcs;
 420
 421         return &bo->base.base;
 422 }
 423
 424 struct vc4_bo *vc4_bo_create(struct drm_device *dev, size_t unaligned_size,
 425                              bool allow_unzeroed, enum vc4_kernel_bo_type type)
 426 {
 427         size_t size = roundup(unaligned_size, PAGE_SIZE);
 428         struct vc4_dev *vc4 = to_vc4_dev(dev);
 429         struct drm_gem_cma_object *cma_obj;
 430         struct vc4_bo *bo;
 431
 432         if (WARN_ON_ONCE(vc4->is_vc5))
 433                 return ERR_PTR(-ENODEV);
 434
 435         if (size == 0)
 436                 return ERR_PTR(-EINVAL);
 437
 438         /* First, try to get a vc4_bo from the kernel BO cache. */
 439         bo = vc4_bo_get_from_cache(dev, size, type);
 440         if (bo) {
 441                 if (!allow_unzeroed)
 442                         memset(bo->base.vaddr, 0, bo->base.base.size);
 443                 return bo;
 444         }
 445
 446         cma_obj = drm_gem_cma_create(dev, size);
 447         if (IS_ERR(cma_obj)) {
 448                 /*
 449                  * If we've run out of CMA memory, kill the cache of
 450                  * CMA allocations we've got laying around and try again.
 451                  */
 452                 vc4_bo_cache_purge(dev);
 453                 cma_obj = drm_gem_cma_create(dev, size);
 454         }
 455
 456         if (IS_ERR(cma_obj)) {
 457                 /*
 458                  * Still not enough CMA memory, purge the userspace BO
 459                  * cache and retry.
 460                  * This is sub-optimal since we purge the whole userspace
 461                  * BO cache which forces user that want to re-use the BO to
 462                  * restore its initial content.
 463                  * Ideally, we should purge entries one by one and retry
 464                  * after each to see if CMA allocation succeeds. Or even
 465                  * better, try to find an entry with at least the same
 466                  * size.
 467                  */
 468                 vc4_bo_userspace_cache_purge(dev);
 469                 cma_obj = drm_gem_cma_create(dev, size);
 470         }
 471
 472         if (IS_ERR(cma_obj)) {
 473                 struct drm_printer p = drm_info_printer(vc4->base.dev);
 474                 DRM_ERROR("Failed to allocate from CMA:\n");
 475                 vc4_bo_stats_print(&p, vc4);
 476                 return ERR_PTR(-ENOMEM);
 477         }
 478         bo = to_vc4_bo(&cma_obj->base);
 479
 480         /* By default, BOs do not support the MADV ioctl. This will be enabled
 481          * only on BOs that are exposed to userspace (V3D, V3D_SHADER and DUMB
 482          * BOs).
 483          */
 484         bo->madv = __VC4_MADV_NOTSUPP;
 485
 486         mutex_lock(&vc4->bo_lock);
 487         vc4_bo_set_label(&cma_obj->base, type);
 488         mutex_unlock(&vc4->bo_lock);
 489
 490         return bo;
 491 }
 492
 493 int vc4_bo_dumb_create(struct drm_file *file_priv,
 494                        struct drm_device *dev,
 495                        struct drm_mode_create_dumb *args)
 496 {
 497         struct vc4_dev *vc4 = to_vc4_dev(dev);
 498         struct vc4_bo *bo = NULL;
 499         int ret;
 500
 501         if (WARN_ON_ONCE(vc4->is_vc5))
 502                 return -ENODEV;
 503
 504         ret = vc4_dumb_fixup_args(args);
 505         if (ret)
 506                 return ret;
 507
 508         bo = vc4_bo_create(dev, args->size, false, VC4_BO_TYPE_DUMB);
 509         if (IS_ERR(bo))
 510                 return PTR_ERR(bo);
 511
 512         bo->madv = VC4_MADV_WILLNEED;
 513
 514         ret = drm_gem_handle_create(file_priv, &bo->base.base, &args->handle);
 515         drm_gem_object_put(&bo->base.base);
 516
 517         return ret;
 518 }
 519
 520 static void vc4_bo_cache_free_old(struct drm_device *dev)
 521 {
 522         struct vc4_dev *vc4 = to_vc4_dev(dev);
 523         unsigned long expire_time = jiffies - msecs_to_jiffies(1000);
 524
 525         lockdep_assert_held(&vc4->bo_lock);
 526
 527         while (!list_empty(&vc4->bo_cache.time_list)) {
 528                 struct vc4_bo *bo = list_last_entry(&vc4->bo_cache.time_list,
 529                                                     struct vc4_bo, unref_head);
 530                 if (time_before(expire_time, bo->free_time)) {
 531                         mod_timer(&vc4->bo_cache.time_timer,
 532                                   round_jiffies_up(jiffies +
 533                                                    msecs_to_jiffies(1000)));
 534                         return;
 535                 }
 536
 537                 vc4_bo_remove_from_cache(bo);
 538                 vc4_bo_destroy(bo);
 539         }
 540 }
 541
 542 /* Called on the last userspace/kernel unreference of the BO.  Returns
 543  * it to the BO cache if possible, otherwise frees it.
 544  */
 545 static void vc4_free_object(struct drm_gem_object *gem_bo)
 546 {
 547         struct drm_device *dev = gem_bo->dev;
 548         struct vc4_dev *vc4 = to_vc4_dev(dev);
 549         struct vc4_bo *bo = to_vc4_bo(gem_bo);
 550         struct list_head *cache_list;
 551
 552         /* Remove the BO from the purgeable list. */
 553         mutex_lock(&bo->madv_lock);
 554         if (bo->madv == VC4_MADV_DONTNEED && !refcount_read(&bo->usecnt))
 555                 vc4_bo_remove_from_purgeable_pool(bo);
 556         mutex_unlock(&bo->madv_lock);
 557
 558         mutex_lock(&vc4->bo_lock);
 559         /* If the object references someone else's memory, we can't cache it.
 560          */
 561         if (gem_bo->import_attach) {
 562                 vc4_bo_destroy(bo);
 563                 goto out;
 564         }
 565
 566         /* Don't cache if it was publicly named. */
 567         if (gem_bo->name) {
 568                 vc4_bo_destroy(bo);
 569                 goto out;
 570         }
 571
 572         /* If this object was partially constructed but CMA allocation
 573          * had failed, just free it. Can also happen when the BO has been
 574          * purged.
 575          */
 576         if (!bo->base.vaddr) {
 577                 vc4_bo_destroy(bo);
 578                 goto out;
 579         }
 580
 581         cache_list = vc4_get_cache_list_for_size(dev, gem_bo->size);
 582         if (!cache_list) {
 583                 vc4_bo_destroy(bo);
 584                 goto out;
 585         }
 586
 587         if (bo->validated_shader) {
 588                 kfree(bo->validated_shader->uniform_addr_offsets);
 589                 kfree(bo->validated_shader->texture_samples);
 590                 kfree(bo->validated_shader);
 591                 bo->validated_shader = NULL;
 592         }
 593
 594         /* Reset madv and usecnt before adding the BO to the cache. */
 595         bo->madv = __VC4_MADV_NOTSUPP;
 596         refcount_set(&bo->usecnt, 0);
 597
 598         bo->t_format = false;
 599         bo->free_time = jiffies;
 600         list_add(&bo->size_head, cache_list);
 601         list_add(&bo->unref_head, &vc4->bo_cache.time_list);
 602
 603         vc4_bo_set_label(&bo->base.base, VC4_BO_TYPE_KERNEL_CACHE);
 604
 605         vc4_bo_cache_free_old(dev);
 606
 607 out:
 608         mutex_unlock(&vc4->bo_lock);
 609 }
 610
 611 static void vc4_bo_cache_time_work(struct work_struct *work)
 612 {
 613         struct vc4_dev *vc4 =
 614                 container_of(work, struct vc4_dev, bo_cache.time_work);
 615         struct drm_device *dev = &vc4->base;
 616
 617         mutex_lock(&vc4->bo_lock);
 618         vc4_bo_cache_free_old(dev);
 619         mutex_unlock(&vc4->bo_lock);
 620 }
 621
 622 int vc4_bo_inc_usecnt(struct vc4_bo *bo)
 623 {
 624         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 625         int ret;
 626
 627         if (WARN_ON_ONCE(vc4->is_vc5))
 628                 return -ENODEV;
 629
 630         /* Fast path: if the BO is already retained by someone, no need to
 631          * check the madv status.
 632          */
 633         if (refcount_inc_not_zero(&bo->usecnt))
 634                 return 0;
 635
 636         mutex_lock(&bo->madv_lock);
 637         switch (bo->madv) {
 638         case VC4_MADV_WILLNEED:
 639                 if (!refcount_inc_not_zero(&bo->usecnt))
 640                         refcount_set(&bo->usecnt, 1);
 641                 ret = 0;
 642                 break;
 643         case VC4_MADV_DONTNEED:
 644                 /* We shouldn't use a BO marked as purgeable if at least
 645                  * someone else retained its content by incrementing usecnt.
 646                  * Luckily the BO hasn't been purged yet, but something wrong
 647                  * is happening here. Just throw an error instead of
 648                  * authorizing this use case.
 649                  */
 650         case __VC4_MADV_PURGED:
 651                 /* We can't use a purged BO. */
 652         default:
 653                 /* Invalid madv value. */
 654                 ret = -EINVAL;
 655                 break;
 656         }
 657         mutex_unlock(&bo->madv_lock);
 658
 659         return ret;
 660 }
 661
 662 void vc4_bo_dec_usecnt(struct vc4_bo *bo)
 663 {
 664         struct vc4_dev *vc4 = to_vc4_dev(bo->base.base.dev);
 665
 666         if (WARN_ON_ONCE(vc4->is_vc5))
 667                 return;
 668
 669         /* Fast path: if the BO is still retained by someone, no need to test
 670          * the madv value.
 671          */
 672         if (refcount_dec_not_one(&bo->usecnt))
 673                 return;
 674
 675         mutex_lock(&bo->madv_lock);
 676         if (refcount_dec_and_test(&bo->usecnt) &&
 677             bo->madv == VC4_MADV_DONTNEED)
 678                 vc4_bo_add_to_purgeable_pool(bo);
 679         mutex_unlock(&bo->madv_lock);
 680 }
 681
 682 static void vc4_bo_cache_time_timer(struct timer_list *t)
 683 {
 684         struct vc4_dev *vc4 = from_timer(vc4, t, bo_cache.time_timer);
 685
 686         schedule_work(&vc4->bo_cache.time_work);
 687 }
 688
 689 static struct dma_buf *vc4_prime_export(struct drm_gem_object *obj, int flags)
 690 {
 691         struct vc4_bo *bo = to_vc4_bo(obj);
 692         struct dma_buf *dmabuf;
 693         int ret;
 694
 695         if (bo->validated_shader) {
 696                 DRM_DEBUG("Attempting to export shader BO\n");
 697                 return ERR_PTR(-EINVAL);
 698         }
 699
 700         /* Note: as soon as the BO is exported it becomes unpurgeable, because
 701          * noone ever decrements the usecnt even if the reference held by the
 702          * exported BO is released. This shouldn't be a problem since we don't
 703          * expect exported BOs to be marked as purgeable.
 704          */
 705         ret = vc4_bo_inc_usecnt(bo);
 706         if (ret) {
 707                 DRM_ERROR("Failed to increment BO usecnt\n");
 708                 return ERR_PTR(ret);
 709         }
 710
 711         dmabuf = drm_gem_prime_export(obj, flags);
 712         if (IS_ERR(dmabuf))
 713                 vc4_bo_dec_usecnt(bo);
 714
 715         return dmabuf;
 716 }
 717
 718 static vm_fault_t vc4_fault(struct vm_fault *vmf)
 719 {
 720         struct vm_area_struct *vma = vmf->vma;
 721         struct drm_gem_object *obj = vma->vm_private_data;
 722         struct vc4_bo *bo = to_vc4_bo(obj);
 723
 724         /* The only reason we would end up here is when user-space accesses
 725          * BO's memory after it's been purged.
 726          */
 727         mutex_lock(&bo->madv_lock);
 728         WARN_ON(bo->madv != __VC4_MADV_PURGED);
 729         mutex_unlock(&bo->madv_lock);
 730
 731         return VM_FAULT_SIGBUS;
 732 }
 733
 734 static int vc4_gem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
 735 {
 736         struct vc4_bo *bo = to_vc4_bo(obj);
 737
 738         if (bo->validated_shader && (vma->vm_flags & VM_WRITE)) {
 739                 DRM_DEBUG("mmaping of shader BOs for writing not allowed.\n");
 740                 return -EINVAL;
 741         }
 742
 743         if (bo->madv != VC4_MADV_WILLNEED) {
 744                 DRM_DEBUG("mmaping of %s BO not allowed\n",
 745                           bo->madv == VC4_MADV_DONTNEED ?
 746                           "purgeable" : "purged");
 747                 return -EINVAL;
 748         }
 749
 750         return drm_gem_cma_mmap(obj, vma);
 751 }
 752
 753 static const struct vm_operations_struct vc4_vm_ops = {
 754         .fault = vc4_fault,
 755         .open = drm_gem_vm_open,
 756         .close = drm_gem_vm_close,
 757 };
 758
 759 static const struct drm_gem_object_funcs vc4_gem_object_funcs = {
 760         .free = vc4_free_object,
 761         .export = vc4_prime_export,
 762         .get_sg_table = drm_gem_cma_get_sg_table,
 763         .vmap = drm_gem_cma_vmap,
 764         .mmap = vc4_gem_object_mmap,
 765         .vm_ops = &vc4_vm_ops,
 766 };
 767
 768 static int vc4_grab_bin_bo(struct vc4_dev *vc4, struct vc4_file *vc4file)
 769 {
 770         int ret;
 771
 772         if (!vc4->v3d)
 773                 return -ENODEV;
 774
 775         if (vc4file->bin_bo_used)
 776                 return 0;
 777
 778         ret = vc4_v3d_bin_bo_get(vc4, &vc4file->bin_bo_used);
 779         if (ret)
 780                 return ret;
 781
 782         return 0;
 783 }
 784
 785 int vc4_create_bo_ioctl(struct drm_device *dev, void *data,
 786                         struct drm_file *file_priv)
 787 {
 788         struct drm_vc4_create_bo *args = data;
 789         struct vc4_file *vc4file = file_priv->driver_priv;
 790         struct vc4_dev *vc4 = to_vc4_dev(dev);
 791         struct vc4_bo *bo = NULL;
 792         int ret;
 793
 794         if (WARN_ON_ONCE(vc4->is_vc5))
 795                 return -ENODEV;
 796
 797         ret = vc4_grab_bin_bo(vc4, vc4file);
 798         if (ret)
 799                 return ret;
 800
 801         /*
 802          * We can't allocate from the BO cache, because the BOs don't
 803          * get zeroed, and that might leak data between users.
 804          */
 805         bo = vc4_bo_create(dev, args->size, false, VC4_BO_TYPE_V3D);
 806         if (IS_ERR(bo))
 807                 return PTR_ERR(bo);
 808
 809         bo->madv = VC4_MADV_WILLNEED;
 810
 811         ret = drm_gem_handle_create(file_priv, &bo->base.base, &args->handle);
 812         drm_gem_object_put(&bo->base.base);
 813
 814         return ret;
 815 }
 816
 817 int vc4_mmap_bo_ioctl(struct drm_device *dev, void *data,
 818                       struct drm_file *file_priv)
 819 {
 820         struct vc4_dev *vc4 = to_vc4_dev(dev);
 821         struct drm_vc4_mmap_bo *args = data;
 822         struct drm_gem_object *gem_obj;
 823
 824         if (WARN_ON_ONCE(vc4->is_vc5))
 825                 return -ENODEV;
 826
 827         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
 828         if (!gem_obj) {
 829                 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
 830                 return -EINVAL;
 831         }
 832
 833         /* The mmap offset was set up at BO allocation time. */
 834         args->offset = drm_vma_node_offset_addr(&gem_obj->vma_node);
 835
 836         drm_gem_object_put(gem_obj);
 837         return 0;
 838 }
 839
 840 int
 841 vc4_create_shader_bo_ioctl(struct drm_device *dev, void *data,
 842                            struct drm_file *file_priv)
 843 {
 844         struct drm_vc4_create_shader_bo *args = data;
 845         struct vc4_file *vc4file = file_priv->driver_priv;
 846         struct vc4_dev *vc4 = to_vc4_dev(dev);
 847         struct vc4_bo *bo = NULL;
 848         int ret;
 849
 850         if (WARN_ON_ONCE(vc4->is_vc5))
 851                 return -ENODEV;
 852
 853         if (args->size == 0)
 854                 return -EINVAL;
 855
 856         if (args->size % sizeof(u64) != 0)
 857                 return -EINVAL;
 858
 859         if (args->flags != 0) {
 860                 DRM_INFO("Unknown flags set: 0x%08x\n", args->flags);
 861                 return -EINVAL;
 862         }
 863
 864         if (args->pad != 0) {
 865                 DRM_INFO("Pad set: 0x%08x\n", args->pad);
 866                 return -EINVAL;
 867         }
 868
 869         ret = vc4_grab_bin_bo(vc4, vc4file);
 870         if (ret)
 871                 return ret;
 872
 873         bo = vc4_bo_create(dev, args->size, true, VC4_BO_TYPE_V3D_SHADER);
 874         if (IS_ERR(bo))
 875                 return PTR_ERR(bo);
 876
 877         bo->madv = VC4_MADV_WILLNEED;
 878
 879         if (copy_from_user(bo->base.vaddr,
 880                              (void __user *)(uintptr_t)args->data,
 881                              args->size)) {
 882                 ret = -EFAULT;
 883                 goto fail;
 884         }
 885         /* Clear the rest of the memory from allocating from the BO
 886          * cache.
 887          */
 888         memset(bo->base.vaddr + args->size, 0,
 889                bo->base.base.size - args->size);
 890
 891         bo->validated_shader = vc4_validate_shader(&bo->base);
 892         if (!bo->validated_shader) {
 893                 ret = -EINVAL;
 894                 goto fail;
 895         }
 896
 897         /* We have to create the handle after validation, to avoid
 898          * races for users to do doing things like mmap the shader BO.
 899          */
 900         ret = drm_gem_handle_create(file_priv, &bo->base.base, &args->handle);
 901
 902 fail:
 903         drm_gem_object_put(&bo->base.base);
 904
 905         return ret;
 906 }
 907
 908 /**
 909  * vc4_set_tiling_ioctl() - Sets the tiling modifier for a BO.
 910  * @dev: DRM device
 911  * @data: ioctl argument
 912  * @file_priv: DRM file for this fd
 913  *
 914  * The tiling state of the BO decides the default modifier of an fb if
 915  * no specific modifier was set by userspace, and the return value of
 916  * vc4_get_tiling_ioctl() (so that userspace can treat a BO it
 917  * received from dmabuf as the same tiling format as the producer
 918  * used).
 919  */
 920 int vc4_set_tiling_ioctl(struct drm_device *dev, void *data,
 921                          struct drm_file *file_priv)
 922 {
 923         struct vc4_dev *vc4 = to_vc4_dev(dev);
 924         struct drm_vc4_set_tiling *args = data;
 925         struct drm_gem_object *gem_obj;
 926         struct vc4_bo *bo;
 927         bool t_format;
 928
 929         if (WARN_ON_ONCE(vc4->is_vc5))
 930                 return -ENODEV;
 931
 932         if (args->flags != 0)
 933                 return -EINVAL;
 934
 935         switch (args->modifier) {
 936         case DRM_FORMAT_MOD_NONE:
 937                 t_format = false;
 938                 break;
 939         case DRM_FORMAT_MOD_BROADCOM_VC4_T_TILED:
 940                 t_format = true;
 941                 break;
 942         default:
 943                 return -EINVAL;
 944         }
 945
 946         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
 947         if (!gem_obj) {
 948                 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
 949                 return -ENOENT;
 950         }
 951         bo = to_vc4_bo(gem_obj);
 952         bo->t_format = t_format;
 953
 954         drm_gem_object_put(gem_obj);
 955
 956         return 0;
 957 }
 958
 959 /**
 960  * vc4_get_tiling_ioctl() - Gets the tiling modifier for a BO.
 961  * @dev: DRM device
 962  * @data: ioctl argument
 963  * @file_priv: DRM file for this fd
 964  *
 965  * Returns the tiling modifier for a BO as set by vc4_set_tiling_ioctl().
 966  */
 967 int vc4_get_tiling_ioctl(struct drm_device *dev, void *data,
 968                          struct drm_file *file_priv)
 969 {
 970         struct vc4_dev *vc4 = to_vc4_dev(dev);
 971         struct drm_vc4_get_tiling *args = data;
 972         struct drm_gem_object *gem_obj;
 973         struct vc4_bo *bo;
 974
 975         if (WARN_ON_ONCE(vc4->is_vc5))
 976                 return -ENODEV;
 977
 978         if (args->flags != 0 || args->modifier != 0)
 979                 return -EINVAL;
 980
 981         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
 982         if (!gem_obj) {
 983                 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
 984                 return -ENOENT;
 985         }
 986         bo = to_vc4_bo(gem_obj);
 987
 988         if (bo->t_format)
 989                 args->modifier = DRM_FORMAT_MOD_BROADCOM_VC4_T_TILED;
 990         else
 991                 args->modifier = DRM_FORMAT_MOD_NONE;
 992
 993         drm_gem_object_put(gem_obj);
 994
 995         return 0;
 996 }
 997
 998 int vc4_bo_debugfs_init(struct drm_minor *minor)
 999 {
1000         struct drm_device *drm = minor->dev;
1001         struct vc4_dev *vc4 = to_vc4_dev(drm);
1002         int ret;
1003
1004         if (!vc4->v3d)
1005                 return -ENODEV;
1006
1007         ret = vc4_debugfs_add_file(minor, "bo_stats",
1008                                    vc4_bo_stats_debugfs, NULL);
1009         if (ret)
1010                 return ret;
1011
1012         return 0;
1013 }
1014
1015 static void vc4_bo_cache_destroy(struct drm_device *dev, void *unused);
1016 int vc4_bo_cache_init(struct drm_device *dev)
1017 {
1018         struct vc4_dev *vc4 = to_vc4_dev(dev);
1019         int ret;
1020         int i;
1021
1022         if (WARN_ON_ONCE(vc4->is_vc5))
1023                 return -ENODEV;
1024
1025         /* Create the initial set of BO labels that the kernel will
1026          * use.  This lets us avoid a bunch of string reallocation in
1027          * the kernel's draw and BO allocation paths.
1028          */
1029         vc4->bo_labels = kcalloc(VC4_BO_TYPE_COUNT, sizeof(*vc4->bo_labels),
1030                                  GFP_KERNEL);
1031         if (!vc4->bo_labels)
1032                 return -ENOMEM;
1033         vc4->num_labels = VC4_BO_TYPE_COUNT;
1034
1035         BUILD_BUG_ON(ARRAY_SIZE(bo_type_names) != VC4_BO_TYPE_COUNT);
1036         for (i = 0; i < VC4_BO_TYPE_COUNT; i++)
1037                 vc4->bo_labels[i].name = bo_type_names[i];
1038
1039         ret = drmm_mutex_init(dev, &vc4->bo_lock);
1040         if (ret) {
1041                 kfree(vc4->bo_labels);
1042                 return ret;
1043         }
1044
1045         INIT_LIST_HEAD(&vc4->bo_cache.time_list);
1046
1047         INIT_WORK(&vc4->bo_cache.time_work, vc4_bo_cache_time_work);
1048         timer_setup(&vc4->bo_cache.time_timer, vc4_bo_cache_time_timer, 0);
1049
1050         return drmm_add_action_or_reset(dev, vc4_bo_cache_destroy, NULL);
1051 }
1052
1053 static void vc4_bo_cache_destroy(struct drm_device *dev, void *unused)
1054 {
1055         struct vc4_dev *vc4 = to_vc4_dev(dev);
1056         int i;
1057
1058         del_timer(&vc4->bo_cache.time_timer);
1059         cancel_work_sync(&vc4->bo_cache.time_work);
1060
1061         vc4_bo_cache_purge(dev);
1062
1063         for (i = 0; i < vc4->num_labels; i++) {
1064                 if (vc4->bo_labels[i].num_allocated) {
1065                         DRM_ERROR("Destroying BO cache with %d %s "
1066                                   "BOs still allocated\n",
1067                                   vc4->bo_labels[i].num_allocated,
1068                                   vc4->bo_labels[i].name);
1069                 }
1070
1071                 if (is_user_label(i))
1072                         kfree(vc4->bo_labels[i].name);
1073         }
1074         kfree(vc4->bo_labels);
1075 }
1076
1077 int vc4_label_bo_ioctl(struct drm_device *dev, void *data,
1078                        struct drm_file *file_priv)
1079 {
1080         struct vc4_dev *vc4 = to_vc4_dev(dev);
1081         struct drm_vc4_label_bo *args = data;
1082         char *name;
1083         struct drm_gem_object *gem_obj;
1084         int ret = 0, label;
1085
1086         if (WARN_ON_ONCE(vc4->is_vc5))
1087                 return -ENODEV;
1088
1089         if (!args->len)
1090                 return -EINVAL;
1091
1092         name = strndup_user(u64_to_user_ptr(args->name), args->len + 1);
1093         if (IS_ERR(name))
1094                 return PTR_ERR(name);
1095
1096         gem_obj = drm_gem_object_lookup(file_priv, args->handle);
1097         if (!gem_obj) {
1098                 DRM_ERROR("Failed to look up GEM BO %d\n", args->handle);
1099                 kfree(name);
1100                 return -ENOENT;
1101         }
1102
1103         mutex_lock(&vc4->bo_lock);
1104         label = vc4_get_user_label(vc4, name);
1105         if (label != -1)
1106                 vc4_bo_set_label(gem_obj, label);
1107         else
1108                 ret = -ENOMEM;
1109         mutex_unlock(&vc4->bo_lock);
1110
1111         drm_gem_object_put(gem_obj);
1112
1113         return ret;
1114 }