drivers/gpu/drm/drm_gem.c

   1 /*
   2  * Copyright © 2008 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 #include <linux/types.h>
  29 #include <linux/slab.h>
  30 #include <linux/mm.h>
  31 #include <linux/uaccess.h>
  32 #include <linux/fs.h>
  33 #include <linux/file.h>
  34 #include <linux/module.h>
  35 #include <linux/mman.h>
  36 #include <linux/pagemap.h>
  37 #include "drmP.h"
  38
  39 /** @file drm_gem.c
  40  *
  41  * This file provides some of the base ioctls and library routines for
  42  * the graphics memory manager implemented by each device driver.
  43  *
  44  * Because various devices have different requirements in terms of
  45  * synchronization and migration strategies, implementing that is left up to
  46  * the driver, and all that the general API provides should be generic --
  47  * allocating objects, reading/writing data with the cpu, freeing objects.
  48  * Even there, platform-dependent optimizations for reading/writing data with
  49  * the CPU mean we'll likely hook those out to driver-specific calls.  However,
  50  * the DRI2 implementation wants to have at least allocate/mmap be generic.
  51  *
  52  * The goal was to have swap-backed object allocation managed through
  53  * struct file.  However, file descriptors as handles to a struct file have
  54  * two major failings:
  55  * - Process limits prevent more than 1024 or so being used at a time by
  56  *   default.
  57  * - Inability to allocate high fds will aggravate the X Server's select()
  58  *   handling, and likely that of many GL client applications as well.
  59  *
  60  * This led to a plan of using our own integer IDs (called handles, following
  61  * DRM terminology) to mimic fds, and implement the fd syscalls we need as
  62  * ioctls.  The objects themselves will still include the struct file so
  63  * that we can transition to fds if the required kernel infrastructure shows
  64  * up at a later date, and as our interface with shmfs for memory allocation.
  65  */
  66
  67 /*
  68  * We make up offsets for buffer objects so we can recognize them at
  69  * mmap time.
  70  */
  71 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
  72 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
  73
  74 /**
  75  * Initialize the GEM device fields
  76  */
  77
  78 int
  79 drm_gem_init(struct drm_device *dev)
  80 {
  81         struct drm_gem_mm *mm;
  82
  83         spin_lock_init(&dev->object_name_lock);
  84         idr_init(&dev->object_name_idr);
  85         atomic_set(&dev->object_count, 0);
  86         atomic_set(&dev->object_memory, 0);
  87         atomic_set(&dev->pin_count, 0);
  88         atomic_set(&dev->pin_memory, 0);
  89         atomic_set(&dev->gtt_count, 0);
  90         atomic_set(&dev->gtt_memory, 0);
  91
  92         mm = kzalloc(sizeof(struct drm_gem_mm), GFP_KERNEL);
  93         if (!mm) {
  94                 DRM_ERROR("out of memory\n");
  95                 return -ENOMEM;
  96         }
  97
  98         dev->mm_private = mm;
  99
 100         if (drm_ht_create(&mm->offset_hash, 19)) {
 101                 kfree(mm);
 102                 return -ENOMEM;
 103         }
 104
 105         if (drm_mm_init(&mm->offset_manager, DRM_FILE_PAGE_OFFSET_START,
 106                         DRM_FILE_PAGE_OFFSET_SIZE)) {
 107                 drm_ht_remove(&mm->offset_hash);
 108                 kfree(mm);
 109                 return -ENOMEM;
 110         }
 111
 112         return 0;
 113 }
 114
 115 void
 116 drm_gem_destroy(struct drm_device *dev)
 117 {
 118         struct drm_gem_mm *mm = dev->mm_private;
 119
 120         drm_mm_takedown(&mm->offset_manager);
 121         drm_ht_remove(&mm->offset_hash);
 122         kfree(mm);
 123         dev->mm_private = NULL;
 124 }
 125
 126 /**
 127  * Initialize an already allocate GEM object of the specified size with
 128  * shmfs backing store.
 129  */
 130 int drm_gem_object_init(struct drm_device *dev,
 131                         struct drm_gem_object *obj, size_t size)
 132 {
 133         BUG_ON((size & (PAGE_SIZE - 1)) != 0);
 134
 135         obj->dev = dev;
 136         obj->filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
 137         if (IS_ERR(obj->filp))
 138                 return -ENOMEM;
 139
 140         kref_init(&obj->refcount);
 141         kref_init(&obj->handlecount);
 142         obj->size = size;
 143
 144         atomic_inc(&dev->object_count);
 145         atomic_add(obj->size, &dev->object_memory);
 146
 147         return 0;
 148 }
 149 EXPORT_SYMBOL(drm_gem_object_init);
 150
 151 /**
 152  * Allocate a GEM object of the specified size with shmfs backing store
 153  */
 154 struct drm_gem_object *
 155 drm_gem_object_alloc(struct drm_device *dev, size_t size)
 156 {
 157         struct drm_gem_object *obj;
 158
 159         obj = kzalloc(sizeof(*obj), GFP_KERNEL);
 160         if (!obj)
 161                 goto free;
 162
 163         if (drm_gem_object_init(dev, obj, size) != 0)
 164                 goto free;
 165
 166         if (dev->driver->gem_init_object != NULL &&
 167             dev->driver->gem_init_object(obj) != 0) {
 168                 goto fput;
 169         }
 170         return obj;
 171 fput:
 172         /* Object_init mangles the global counters - readjust them. */
 173         atomic_dec(&dev->object_count);
 174         atomic_sub(obj->size, &dev->object_memory);
 175         fput(obj->filp);
 176 free:
 177         kfree(obj);
 178         return NULL;
 179 }
 180 EXPORT_SYMBOL(drm_gem_object_alloc);
 181
 182 /**
 183  * Removes the mapping from handle to filp for this object.
 184  */
 185 static int
 186 drm_gem_handle_delete(struct drm_file *filp, u32 handle)
 187 {
 188         struct drm_device *dev;
 189         struct drm_gem_object *obj;
 190
 191         /* This is gross. The idr system doesn't let us try a delete and
 192          * return an error code.  It just spews if you fail at deleting.
 193          * So, we have to grab a lock around finding the object and then
 194          * doing the delete on it and dropping the refcount, or the user
 195          * could race us to double-decrement the refcount and cause a
 196          * use-after-free later.  Given the frequency of our handle lookups,
 197          * we may want to use ida for number allocation and a hash table
 198          * for the pointers, anyway.
 199          */
 200         spin_lock(&filp->table_lock);
 201
 202         /* Check if we currently have a reference on the object */
 203         obj = idr_find(&filp->object_idr, handle);
 204         if (obj == NULL) {
 205                 spin_unlock(&filp->table_lock);
 206                 return -EINVAL;
 207         }
 208         dev = obj->dev;
 209
 210         /* Release reference and decrement refcount. */
 211         idr_remove(&filp->object_idr, handle);
 212         spin_unlock(&filp->table_lock);
 213
 214         drm_gem_object_handle_unreference_unlocked(obj);
 215
 216         return 0;
 217 }
 218
 219 /**
 220  * Create a handle for this object. This adds a handle reference
 221  * to the object, which includes a regular reference count. Callers
 222  * will likely want to dereference the object afterwards.
 223  */
 224 int
 225 drm_gem_handle_create(struct drm_file *file_priv,
 226                        struct drm_gem_object *obj,
 227                        u32 *handlep)
 228 {
 229         int     ret;
 230
 231         /*
 232          * Get the user-visible handle using idr.
 233          */
 234 again:
 235         /* ensure there is space available to allocate a handle */
 236         if (idr_pre_get(&file_priv->object_idr, GFP_KERNEL) == 0)
 237                 return -ENOMEM;
 238
 239         /* do the allocation under our spinlock */
 240         spin_lock(&file_priv->table_lock);
 241         ret = idr_get_new_above(&file_priv->object_idr, obj, 1, (int *)handlep);
 242         spin_unlock(&file_priv->table_lock);
 243         if (ret == -EAGAIN)
 244                 goto again;
 245
 246         if (ret != 0)
 247                 return ret;
 248
 249         drm_gem_object_handle_reference(obj);
 250         return 0;
 251 }
 252 EXPORT_SYMBOL(drm_gem_handle_create);
 253
 254 /** Returns a reference to the object named by the handle. */
 255 struct drm_gem_object *
 256 drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
 257                       u32 handle)
 258 {
 259         struct drm_gem_object *obj;
 260
 261         spin_lock(&filp->table_lock);
 262
 263         /* Check if we currently have a reference on the object */
 264         obj = idr_find(&filp->object_idr, handle);
 265         if (obj == NULL) {
 266                 spin_unlock(&filp->table_lock);
 267                 return NULL;
 268         }
 269
 270         drm_gem_object_reference(obj);
 271
 272         spin_unlock(&filp->table_lock);
 273
 274         return obj;
 275 }
 276 EXPORT_SYMBOL(drm_gem_object_lookup);
 277
 278 /**
 279  * Releases the handle to an mm object.
 280  */
 281 int
 282 drm_gem_close_ioctl(struct drm_device *dev, void *data,
 283                     struct drm_file *file_priv)
 284 {
 285         struct drm_gem_close *args = data;
 286         int ret;
 287
 288         if (!(dev->driver->driver_features & DRIVER_GEM))
 289                 return -ENODEV;
 290
 291         ret = drm_gem_handle_delete(file_priv, args->handle);
 292
 293         return ret;
 294 }
 295
 296 /**
 297  * Create a global name for an object, returning the name.
 298  *
 299  * Note that the name does not hold a reference; when the object
 300  * is freed, the name goes away.
 301  */
 302 int
 303 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
 304                     struct drm_file *file_priv)
 305 {
 306         struct drm_gem_flink *args = data;
 307         struct drm_gem_object *obj;
 308         int ret;
 309
 310         if (!(dev->driver->driver_features & DRIVER_GEM))
 311                 return -ENODEV;
 312
 313         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
 314         if (obj == NULL)
 315                 return -EBADF;
 316
 317 again:
 318         if (idr_pre_get(&dev->object_name_idr, GFP_KERNEL) == 0) {
 319                 ret = -ENOMEM;
 320                 goto err;
 321         }
 322
 323         spin_lock(&dev->object_name_lock);
 324         if (!obj->name) {
 325                 ret = idr_get_new_above(&dev->object_name_idr, obj, 1,
 326                                         &obj->name);
 327                 args->name = (uint64_t) obj->name;
 328                 spin_unlock(&dev->object_name_lock);
 329
 330                 if (ret == -EAGAIN)
 331                         goto again;
 332
 333                 if (ret != 0)
 334                         goto err;
 335
 336                 /* Allocate a reference for the name table.  */
 337                 drm_gem_object_reference(obj);
 338         } else {
 339                 args->name = (uint64_t) obj->name;
 340                 spin_unlock(&dev->object_name_lock);
 341                 ret = 0;
 342         }
 343
 344 err:
 345         drm_gem_object_unreference_unlocked(obj);
 346         return ret;
 347 }
 348
 349 /**
 350  * Open an object using the global name, returning a handle and the size.
 351  *
 352  * This handle (of course) holds a reference to the object, so the object
 353  * will not go away until the handle is deleted.
 354  */
 355 int
 356 drm_gem_open_ioctl(struct drm_device *dev, void *data,
 357                    struct drm_file *file_priv)
 358 {
 359         struct drm_gem_open *args = data;
 360         struct drm_gem_object *obj;
 361         int ret;
 362         u32 handle;
 363
 364         if (!(dev->driver->driver_features & DRIVER_GEM))
 365                 return -ENODEV;
 366
 367         spin_lock(&dev->object_name_lock);
 368         obj = idr_find(&dev->object_name_idr, (int) args->name);
 369         if (obj)
 370                 drm_gem_object_reference(obj);
 371         spin_unlock(&dev->object_name_lock);
 372         if (!obj)
 373                 return -ENOENT;
 374
 375         ret = drm_gem_handle_create(file_priv, obj, &handle);
 376         drm_gem_object_unreference_unlocked(obj);
 377         if (ret)
 378                 return ret;
 379
 380         args->handle = handle;
 381         args->size = obj->size;
 382
 383         return 0;
 384 }
 385
 386 /**
 387  * Called at device open time, sets up the structure for handling refcounting
 388  * of mm objects.
 389  */
 390 void
 391 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
 392 {
 393         idr_init(&file_private->object_idr);
 394         spin_lock_init(&file_private->table_lock);
 395 }
 396
 397 /**
 398  * Called at device close to release the file's
 399  * handle references on objects.
 400  */
 401 static int
 402 drm_gem_object_release_handle(int id, void *ptr, void *data)
 403 {
 404         struct drm_gem_object *obj = ptr;
 405
 406         drm_gem_object_handle_unreference_unlocked(obj);
 407
 408         return 0;
 409 }
 410
 411 /**
 412  * Called at close time when the filp is going away.
 413  *
 414  * Releases any remaining references on objects by this filp.
 415  */
 416 void
 417 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
 418 {
 419         idr_for_each(&file_private->object_idr,
 420                      &drm_gem_object_release_handle, NULL);
 421
 422         idr_destroy(&file_private->object_idr);
 423 }
 424
 425 void
 426 drm_gem_object_release(struct drm_gem_object *obj)
 427 {
 428         struct drm_device *dev = obj->dev;
 429         fput(obj->filp);
 430         atomic_dec(&dev->object_count);
 431         atomic_sub(obj->size, &dev->object_memory);
 432 }
 433 EXPORT_SYMBOL(drm_gem_object_release);
 434
 435 /**
 436  * Called after the last reference to the object has been lost.
 437  * Must be called holding struct_ mutex
 438  *
 439  * Frees the object
 440  */
 441 void
 442 drm_gem_object_free(struct kref *kref)
 443 {
 444         struct drm_gem_object *obj = (struct drm_gem_object *) kref;
 445         struct drm_device *dev = obj->dev;
 446
 447         BUG_ON(!mutex_is_locked(&dev->struct_mutex));
 448
 449         if (dev->driver->gem_free_object != NULL)
 450                 dev->driver->gem_free_object(obj);
 451 }
 452 EXPORT_SYMBOL(drm_gem_object_free);
 453
 454 /**
 455  * Called after the last reference to the object has been lost.
 456  * Must be called without holding struct_mutex
 457  *
 458  * Frees the object
 459  */
 460 void
 461 drm_gem_object_free_unlocked(struct kref *kref)
 462 {
 463         struct drm_gem_object *obj = (struct drm_gem_object *) kref;
 464         struct drm_device *dev = obj->dev;
 465
 466         if (dev->driver->gem_free_object_unlocked != NULL)
 467                 dev->driver->gem_free_object_unlocked(obj);
 468         else if (dev->driver->gem_free_object != NULL) {
 469                 mutex_lock(&dev->struct_mutex);
 470                 dev->driver->gem_free_object(obj);
 471                 mutex_unlock(&dev->struct_mutex);
 472         }
 473 }
 474 EXPORT_SYMBOL(drm_gem_object_free_unlocked);
 475
 476 static void drm_gem_object_ref_bug(struct kref *list_kref)
 477 {
 478         BUG();
 479 }
 480
 481 /**
 482  * Called after the last handle to the object has been closed
 483  *
 484  * Removes any name for the object. Note that this must be
 485  * called before drm_gem_object_free or we'll be touching
 486  * freed memory
 487  */
 488 void
 489 drm_gem_object_handle_free(struct kref *kref)
 490 {
 491         struct drm_gem_object *obj = container_of(kref,
 492                                                   struct drm_gem_object,
 493                                                   handlecount);
 494         struct drm_device *dev = obj->dev;
 495
 496         /* Remove any name for this object */
 497         spin_lock(&dev->object_name_lock);
 498         if (obj->name) {
 499                 idr_remove(&dev->object_name_idr, obj->name);
 500                 obj->name = 0;
 501                 spin_unlock(&dev->object_name_lock);
 502                 /*
 503                  * The object name held a reference to this object, drop
 504                  * that now.
 505                 *
 506                 * This cannot be the last reference, since the handle holds one too.
 507                  */
 508                 kref_put(&obj->refcount, drm_gem_object_ref_bug);
 509         } else
 510                 spin_unlock(&dev->object_name_lock);
 511
 512 }
 513 EXPORT_SYMBOL(drm_gem_object_handle_free);
 514
 515 void drm_gem_vm_open(struct vm_area_struct *vma)
 516 {
 517         struct drm_gem_object *obj = vma->vm_private_data;
 518
 519         drm_gem_object_reference(obj);
 520 }
 521 EXPORT_SYMBOL(drm_gem_vm_open);
 522
 523 void drm_gem_vm_close(struct vm_area_struct *vma)
 524 {
 525         struct drm_gem_object *obj = vma->vm_private_data;
 526
 527         drm_gem_object_unreference_unlocked(obj);
 528 }
 529 EXPORT_SYMBOL(drm_gem_vm_close);
 530
 531
 532 /**
 533  * drm_gem_mmap - memory map routine for GEM objects
 534  * @filp: DRM file pointer
 535  * @vma: VMA for the area to be mapped
 536  *
 537  * If a driver supports GEM object mapping, mmap calls on the DRM file
 538  * descriptor will end up here.
 539  *
 540  * If we find the object based on the offset passed in (vma->vm_pgoff will
 541  * contain the fake offset we created when the GTT map ioctl was called on
 542  * the object), we set up the driver fault handler so that any accesses
 543  * to the object can be trapped, to perform migration, GTT binding, surface
 544  * register allocation, or performance monitoring.
 545  */
 546 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
 547 {
 548         struct drm_file *priv = filp->private_data;
 549         struct drm_device *dev = priv->minor->dev;
 550         struct drm_gem_mm *mm = dev->mm_private;
 551         struct drm_local_map *map = NULL;
 552         struct drm_gem_object *obj;
 553         struct drm_hash_item *hash;
 554         int ret = 0;
 555
 556         mutex_lock(&dev->struct_mutex);
 557
 558         if (drm_ht_find_item(&mm->offset_hash, vma->vm_pgoff, &hash)) {
 559                 mutex_unlock(&dev->struct_mutex);
 560                 return drm_mmap(filp, vma);
 561         }
 562
 563         map = drm_hash_entry(hash, struct drm_map_list, hash)->map;
 564         if (!map ||
 565             ((map->flags & _DRM_RESTRICTED) && !capable(CAP_SYS_ADMIN))) {
 566                 ret =  -EPERM;
 567                 goto out_unlock;
 568         }
 569
 570         /* Check for valid size. */
 571         if (map->size < vma->vm_end - vma->vm_start) {
 572                 ret = -EINVAL;
 573                 goto out_unlock;
 574         }
 575
 576         obj = map->handle;
 577         if (!obj->dev->driver->gem_vm_ops) {
 578                 ret = -EINVAL;
 579                 goto out_unlock;
 580         }
 581
 582         vma->vm_flags |= VM_RESERVED | VM_IO | VM_PFNMAP | VM_DONTEXPAND;
 583         vma->vm_ops = obj->dev->driver->gem_vm_ops;
 584         vma->vm_private_data = map->handle;
 585         vma->vm_page_prot =  pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
 586
 587         /* Take a ref for this mapping of the object, so that the fault
 588          * handler can dereference the mmap offset's pointer to the object.
 589          * This reference is cleaned up by the corresponding vm_close
 590          * (which should happen whether the vma was created by this call, or
 591          * by a vm_open due to mremap or partial unmap or whatever).
 592          */
 593         drm_gem_object_reference(obj);
 594
 595         vma->vm_file = filp;    /* Needed for drm_vm_open() */
 596         drm_vm_open_locked(vma);
 597
 598 out_unlock:
 599         mutex_unlock(&dev->struct_mutex);
 600
 601         return ret;
 602 }
 603 EXPORT_SYMBOL(drm_gem_mmap);