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 <linux/shmem_fs.h>
  38 #include <linux/dma-buf.h>
  39 #include <drm/drmP.h>
  40
  41 /** @file drm_gem.c
  42  *
  43  * This file provides some of the base ioctls and library routines for
  44  * the graphics memory manager implemented by each device driver.
  45  *
  46  * Because various devices have different requirements in terms of
  47  * synchronization and migration strategies, implementing that is left up to
  48  * the driver, and all that the general API provides should be generic --
  49  * allocating objects, reading/writing data with the cpu, freeing objects.
  50  * Even there, platform-dependent optimizations for reading/writing data with
  51  * the CPU mean we'll likely hook those out to driver-specific calls.  However,
  52  * the DRI2 implementation wants to have at least allocate/mmap be generic.
  53  *
  54  * The goal was to have swap-backed object allocation managed through
  55  * struct file.  However, file descriptors as handles to a struct file have
  56  * two major failings:
  57  * - Process limits prevent more than 1024 or so being used at a time by
  58  *   default.
  59  * - Inability to allocate high fds will aggravate the X Server's select()
  60  *   handling, and likely that of many GL client applications as well.
  61  *
  62  * This led to a plan of using our own integer IDs (called handles, following
  63  * DRM terminology) to mimic fds, and implement the fd syscalls we need as
  64  * ioctls.  The objects themselves will still include the struct file so
  65  * that we can transition to fds if the required kernel infrastructure shows
  66  * up at a later date, and as our interface with shmfs for memory allocation.
  67  */
  68
  69 /*
  70  * We make up offsets for buffer objects so we can recognize them at
  71  * mmap time.
  72  */
  73
  74 /* pgoff in mmap is an unsigned long, so we need to make sure that
  75  * the faked up offset will fit
  76  */
  77
  78 #if BITS_PER_LONG == 64
  79 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
  80 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
  81 #else
  82 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
  83 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
  84 #endif
  85
  86 /**
  87  * Initialize the GEM device fields
  88  */
  89
  90 int
  91 drm_gem_init(struct drm_device *dev)
  92 {
  93         struct drm_gem_mm *mm;
  94
  95         spin_lock_init(&dev->object_name_lock);
  96         idr_init(&dev->object_name_idr);
  97
  98         mm = kzalloc(sizeof(struct drm_gem_mm), GFP_KERNEL);
  99         if (!mm) {
 100                 DRM_ERROR("out of memory\n");
 101                 return -ENOMEM;
 102         }
 103
 104         dev->mm_private = mm;
 105
 106         if (drm_ht_create(&mm->offset_hash, 12)) {
 107                 kfree(mm);
 108                 return -ENOMEM;
 109         }
 110
 111         if (drm_mm_init(&mm->offset_manager, DRM_FILE_PAGE_OFFSET_START,
 112                         DRM_FILE_PAGE_OFFSET_SIZE)) {
 113                 drm_ht_remove(&mm->offset_hash);
 114                 kfree(mm);
 115                 return -ENOMEM;
 116         }
 117
 118         return 0;
 119 }
 120
 121 void
 122 drm_gem_destroy(struct drm_device *dev)
 123 {
 124         struct drm_gem_mm *mm = dev->mm_private;
 125
 126         drm_mm_takedown(&mm->offset_manager);
 127         drm_ht_remove(&mm->offset_hash);
 128         kfree(mm);
 129         dev->mm_private = NULL;
 130 }
 131
 132 /**
 133  * Initialize an already allocated GEM object of the specified size with
 134  * shmfs backing store.
 135  */
 136 int drm_gem_object_init(struct drm_device *dev,
 137                         struct drm_gem_object *obj, size_t size)
 138 {
 139         struct file *filp;
 140
 141         filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
 142         if (IS_ERR(filp))
 143                 return PTR_ERR(filp);
 144
 145         drm_gem_private_object_init(dev, obj, size);
 146         obj->filp = filp;
 147
 148         return 0;
 149 }
 150 EXPORT_SYMBOL(drm_gem_object_init);
 151
 152 /**
 153  * Initialize an already allocated GEM object of the specified size with
 154  * no GEM provided backing store. Instead the caller is responsible for
 155  * backing the object and handling it.
 156  */
 157 void drm_gem_private_object_init(struct drm_device *dev,
 158                                  struct drm_gem_object *obj, size_t size)
 159 {
 160         BUG_ON((size & (PAGE_SIZE - 1)) != 0);
 161
 162         obj->dev = dev;
 163         obj->filp = NULL;
 164
 165         kref_init(&obj->refcount);
 166         atomic_set(&obj->handle_count, 0);
 167         obj->size = size;
 168 }
 169 EXPORT_SYMBOL(drm_gem_private_object_init);
 170
 171 /**
 172  * Allocate a GEM object of the specified size with shmfs backing store
 173  */
 174 struct drm_gem_object *
 175 drm_gem_object_alloc(struct drm_device *dev, size_t size)
 176 {
 177         struct drm_gem_object *obj;
 178
 179         obj = kzalloc(sizeof(*obj), GFP_KERNEL);
 180         if (!obj)
 181                 goto free;
 182
 183         if (drm_gem_object_init(dev, obj, size) != 0)
 184                 goto free;
 185
 186         if (dev->driver->gem_init_object != NULL &&
 187             dev->driver->gem_init_object(obj) != 0) {
 188                 goto fput;
 189         }
 190         return obj;
 191 fput:
 192         /* Object_init mangles the global counters - readjust them. */
 193         fput(obj->filp);
 194 free:
 195         kfree(obj);
 196         return NULL;
 197 }
 198 EXPORT_SYMBOL(drm_gem_object_alloc);
 199
 200 static void
 201 drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
 202 {
 203         if (obj->import_attach) {
 204                 drm_prime_remove_buf_handle(&filp->prime,
 205                                 obj->import_attach->dmabuf);
 206         }
 207         if (obj->export_dma_buf) {
 208                 drm_prime_remove_buf_handle(&filp->prime,
 209                                 obj->export_dma_buf);
 210         }
 211 }
 212
 213 static void drm_gem_object_ref_bug(struct kref *list_kref)
 214 {
 215         BUG();
 216 }
 217
 218 /**
 219  * Called after the last handle to the object has been closed
 220  *
 221  * Removes any name for the object. Note that this must be
 222  * called before drm_gem_object_free or we'll be touching
 223  * freed memory
 224  */
 225 static void drm_gem_object_handle_free(struct drm_gem_object *obj)
 226 {
 227         struct drm_device *dev = obj->dev;
 228
 229         /* Remove any name for this object */
 230         spin_lock(&dev->object_name_lock);
 231         if (obj->name) {
 232                 idr_remove(&dev->object_name_idr, obj->name);
 233                 obj->name = 0;
 234                 spin_unlock(&dev->object_name_lock);
 235                 /*
 236                  * The object name held a reference to this object, drop
 237                  * that now.
 238                 *
 239                 * This cannot be the last reference, since the handle holds one too.
 240                  */
 241                 kref_put(&obj->refcount, drm_gem_object_ref_bug);
 242         } else
 243                 spin_unlock(&dev->object_name_lock);
 244
 245 }
 246
 247 void
 248 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
 249 {
 250         if (obj == NULL)
 251                 return;
 252
 253         if (atomic_read(&obj->handle_count) == 0)
 254                 return;
 255
 256         /*
 257         * Must bump handle count first as this may be the last
 258         * ref, in which case the object would disappear before we
 259         * checked for a name
 260         */
 261
 262         if (atomic_dec_and_test(&obj->handle_count))
 263                 drm_gem_object_handle_free(obj);
 264         drm_gem_object_unreference_unlocked(obj);
 265 }
 266
 267 /**
 268  * Removes the mapping from handle to filp for this object.
 269  */
 270 int
 271 drm_gem_handle_delete(struct drm_file *filp, u32 handle)
 272 {
 273         struct drm_device *dev;
 274         struct drm_gem_object *obj;
 275
 276         /* This is gross. The idr system doesn't let us try a delete and
 277          * return an error code.  It just spews if you fail at deleting.
 278          * So, we have to grab a lock around finding the object and then
 279          * doing the delete on it and dropping the refcount, or the user
 280          * could race us to double-decrement the refcount and cause a
 281          * use-after-free later.  Given the frequency of our handle lookups,
 282          * we may want to use ida for number allocation and a hash table
 283          * for the pointers, anyway.
 284          */
 285         spin_lock(&filp->table_lock);
 286
 287         /* Check if we currently have a reference on the object */
 288         obj = idr_find(&filp->object_idr, handle);
 289         if (obj == NULL) {
 290                 spin_unlock(&filp->table_lock);
 291                 return -EINVAL;
 292         }
 293         dev = obj->dev;
 294
 295         DRM_DEBUG("%s:hdl[%d]obj[0x%x]\n", __func__, handle, (int)obj);
 296
 297         /* Release reference and decrement refcount. */
 298         idr_remove(&filp->object_idr, handle);
 299         spin_unlock(&filp->table_lock);
 300
 301         drm_gem_remove_prime_handles(obj, filp);
 302
 303         if (dev->driver->gem_close_object)
 304                 dev->driver->gem_close_object(obj, filp);
 305         drm_gem_object_handle_unreference_unlocked(obj);
 306
 307         return 0;
 308 }
 309 EXPORT_SYMBOL(drm_gem_handle_delete);
 310
 311 /**
 312  * Create a handle for this object. This adds a handle reference
 313  * to the object, which includes a regular reference count. Callers
 314  * will likely want to dereference the object afterwards.
 315  */
 316 int
 317 drm_gem_handle_create(struct drm_file *file_priv,
 318                        struct drm_gem_object *obj,
 319                        u32 *handlep)
 320 {
 321         struct drm_device *dev = obj->dev;
 322         int ret;
 323
 324         /*
 325          * Get the user-visible handle using idr.  Preload and perform
 326          * allocation under our spinlock.
 327          */
 328         idr_preload(GFP_KERNEL);
 329         spin_lock(&file_priv->table_lock);
 330
 331         ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
 332
 333         spin_unlock(&file_priv->table_lock);
 334         idr_preload_end();
 335         if (ret < 0)
 336                 return ret;
 337         *handlep = ret;
 338
 339         drm_gem_object_handle_reference(obj);
 340
 341         if (dev->driver->gem_open_object) {
 342                 ret = dev->driver->gem_open_object(obj, file_priv);
 343                 if (ret) {
 344                         drm_gem_handle_delete(file_priv, *handlep);
 345                         return ret;
 346                 }
 347         }
 348
 349         return 0;
 350 }
 351 EXPORT_SYMBOL(drm_gem_handle_create);
 352
 353
 354 /**
 355  * drm_gem_free_mmap_offset - release a fake mmap offset for an object
 356  * @obj: obj in question
 357  *
 358  * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
 359  */
 360 void
 361 drm_gem_free_mmap_offset(struct drm_gem_object *obj)
 362 {
 363         struct drm_device *dev = obj->dev;
 364         struct drm_gem_mm *mm = dev->mm_private;
 365         struct drm_map_list *list = &obj->map_list;
 366
 367         drm_ht_remove_item(&mm->offset_hash, &list->hash);
 368         drm_mm_put_block(list->file_offset_node);
 369         kfree(list->map);
 370         list->map = NULL;
 371 }
 372 EXPORT_SYMBOL(drm_gem_free_mmap_offset);
 373
 374 /**
 375  * drm_gem_create_mmap_offset - create a fake mmap offset for an object
 376  * @obj: obj in question
 377  *
 378  * GEM memory mapping works by handing back to userspace a fake mmap offset
 379  * it can use in a subsequent mmap(2) call.  The DRM core code then looks
 380  * up the object based on the offset and sets up the various memory mapping
 381  * structures.
 382  *
 383  * This routine allocates and attaches a fake offset for @obj.
 384  */
 385 int
 386 drm_gem_create_mmap_offset(struct drm_gem_object *obj)
 387 {
 388         struct drm_device *dev = obj->dev;
 389         struct drm_gem_mm *mm = dev->mm_private;
 390         struct drm_map_list *list;
 391         struct drm_local_map *map;
 392         int ret;
 393
 394         /* Set the object up for mmap'ing */
 395         list = &obj->map_list;
 396         list->map = kzalloc(sizeof(struct drm_map_list), GFP_KERNEL);
 397         if (!list->map)
 398                 return -ENOMEM;
 399
 400         map = list->map;
 401         map->type = _DRM_GEM;
 402         map->size = obj->size;
 403         map->handle = obj;
 404
 405         /* Get a DRM GEM mmap offset allocated... */
 406         list->file_offset_node = drm_mm_search_free(&mm->offset_manager,
 407                         obj->size / PAGE_SIZE, 0, false);
 408
 409         if (!list->file_offset_node) {
 410                 DRM_ERROR("failed to allocate offset for bo %d\n", obj->name);
 411                 ret = -ENOSPC;
 412                 goto out_free_list;
 413         }
 414
 415         list->file_offset_node = drm_mm_get_block(list->file_offset_node,
 416                         obj->size / PAGE_SIZE, 0);
 417         if (!list->file_offset_node) {
 418                 ret = -ENOMEM;
 419                 goto out_free_list;
 420         }
 421
 422         list->hash.key = list->file_offset_node->start;
 423         ret = drm_ht_insert_item(&mm->offset_hash, &list->hash);
 424         if (ret) {
 425                 DRM_ERROR("failed to add to map hash\n");
 426                 goto out_free_mm;
 427         }
 428
 429         return 0;
 430
 431 out_free_mm:
 432         drm_mm_put_block(list->file_offset_node);
 433 out_free_list:
 434         kfree(list->map);
 435         list->map = NULL;
 436
 437         return ret;
 438 }
 439 EXPORT_SYMBOL(drm_gem_create_mmap_offset);
 440
 441 /** Returns a reference to the object named by the handle. */
 442 struct drm_gem_object *
 443 drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
 444                       u32 handle)
 445 {
 446         struct drm_gem_object *obj;
 447
 448         spin_lock(&filp->table_lock);
 449
 450         /* Check if we currently have a reference on the object */
 451         obj = idr_find(&filp->object_idr, handle);
 452         if (obj == NULL) {
 453                 spin_unlock(&filp->table_lock);
 454                 return NULL;
 455         }
 456
 457         drm_gem_object_reference(obj);
 458
 459         spin_unlock(&filp->table_lock);
 460
 461         return obj;
 462 }
 463 EXPORT_SYMBOL(drm_gem_object_lookup);
 464
 465 /**
 466  * Releases the handle to an mm object.
 467  */
 468 int
 469 drm_gem_close_ioctl(struct drm_device *dev, void *data,
 470                     struct drm_file *file_priv)
 471 {
 472         struct drm_gem_close *args = data;
 473         int ret;
 474
 475         if (!(dev->driver->driver_features & DRIVER_GEM))
 476                 return -ENODEV;
 477
 478         ret = drm_gem_handle_delete(file_priv, args->handle);
 479
 480         return ret;
 481 }
 482
 483 /**
 484  * Create a global name for an object, returning the name.
 485  *
 486  * Note that the name does not hold a reference; when the object
 487  * is freed, the name goes away.
 488  */
 489 int
 490 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
 491                     struct drm_file *file_priv)
 492 {
 493         struct drm_gem_flink *args = data;
 494         struct drm_gem_object *obj;
 495         int ret;
 496
 497         if (!(dev->driver->driver_features & DRIVER_GEM))
 498                 return -ENODEV;
 499
 500         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
 501         if (obj == NULL)
 502                 return -ENOENT;
 503
 504         idr_preload(GFP_KERNEL);
 505         spin_lock(&dev->object_name_lock);
 506         if (!obj->name) {
 507                 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
 508                 if (ret < 0)
 509                         goto err;
 510
 511                 obj->name = ret;
 512
 513                 /* Allocate a reference for the name table.  */
 514                 drm_gem_object_reference(obj);
 515         }
 516
 517         args->name = (uint64_t) obj->name;
 518         ret = 0;
 519
 520 err:
 521         spin_unlock(&dev->object_name_lock);
 522         idr_preload_end();
 523         drm_gem_object_unreference_unlocked(obj);
 524
 525         DRM_DEBUG("%s:hdl[%d]obj[0x%x]name[%d]\n",
 526                 __func__, (int) args->handle, (int)obj, args->name);
 527
 528         return ret;
 529 }
 530
 531 /**
 532  * Open an object using the global name, returning a handle and the size.
 533  *
 534  * This handle (of course) holds a reference to the object, so the object
 535  * will not go away until the handle is deleted.
 536  */
 537 int
 538 drm_gem_open_ioctl(struct drm_device *dev, void *data,
 539                    struct drm_file *file_priv)
 540 {
 541         struct drm_gem_open *args = data;
 542         struct drm_gem_object *obj;
 543         int ret;
 544         u32 handle;
 545
 546         if (!(dev->driver->driver_features & DRIVER_GEM))
 547                 return -ENODEV;
 548
 549         spin_lock(&dev->object_name_lock);
 550         obj = idr_find(&dev->object_name_idr, (int) args->name);
 551         if (obj)
 552                 drm_gem_object_reference(obj);
 553         spin_unlock(&dev->object_name_lock);
 554         if (!obj)
 555                 return -ENOENT;
 556
 557         ret = drm_gem_handle_create(file_priv, obj, &handle);
 558         drm_gem_object_unreference_unlocked(obj);
 559         if (ret)
 560                 return ret;
 561
 562         args->handle = handle;
 563         args->size = obj->size;
 564
 565         DRM_DEBUG("%s:name[%d]obj[0x%x]hdl[%d]sz[%d]\n",
 566                 __func__, (int) args->name, (int)obj,
 567                 args->handle, (int)args->size);
 568
 569         return 0;
 570 }
 571
 572 /**
 573  * Called at device open time, sets up the structure for handling refcounting
 574  * of mm objects.
 575  */
 576 void
 577 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
 578 {
 579         idr_init(&file_private->object_idr);
 580         spin_lock_init(&file_private->table_lock);
 581 }
 582
 583 /**
 584  * Called at device close to release the file's
 585  * handle references on objects.
 586  */
 587 static int
 588 drm_gem_object_release_handle(int id, void *ptr, void *data)
 589 {
 590         struct drm_file *file_priv = data;
 591         struct drm_gem_object *obj = ptr;
 592         struct drm_device *dev = obj->dev;
 593
 594         drm_gem_remove_prime_handles(obj, file_priv);
 595
 596         if (dev->driver->gem_close_object)
 597                 dev->driver->gem_close_object(obj, file_priv);
 598
 599         drm_gem_object_handle_unreference_unlocked(obj);
 600
 601         return 0;
 602 }
 603
 604 /**
 605  * Called at close time when the filp is going away.
 606  *
 607  * Releases any remaining references on objects by this filp.
 608  */
 609 void
 610 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
 611 {
 612         idr_for_each(&file_private->object_idr,
 613                      &drm_gem_object_release_handle, file_private);
 614         idr_destroy(&file_private->object_idr);
 615 }
 616
 617 void
 618 drm_gem_object_release(struct drm_gem_object *obj)
 619 {
 620         if (obj->filp)
 621             fput(obj->filp);
 622 }
 623 EXPORT_SYMBOL(drm_gem_object_release);
 624
 625 /**
 626  * Called after the last reference to the object has been lost.
 627  * Must be called holding struct_ mutex
 628  *
 629  * Frees the object
 630  */
 631 void
 632 drm_gem_object_free(struct kref *kref)
 633 {
 634         struct drm_gem_object *obj = (struct drm_gem_object *) kref;
 635         struct drm_device *dev = obj->dev;
 636
 637         BUG_ON(!mutex_is_locked(&dev->struct_mutex));
 638
 639         if (dev->driver->gem_free_object != NULL)
 640                 dev->driver->gem_free_object(obj);
 641 }
 642 EXPORT_SYMBOL(drm_gem_object_free);
 643
 644 void drm_gem_vm_open(struct vm_area_struct *vma)
 645 {
 646         struct drm_gem_object *obj = vma->vm_private_data;
 647
 648         drm_gem_object_reference(obj);
 649
 650         mutex_lock(&obj->dev->struct_mutex);
 651         drm_vm_open_locked(obj->dev, vma);
 652         mutex_unlock(&obj->dev->struct_mutex);
 653 }
 654 EXPORT_SYMBOL(drm_gem_vm_open);
 655
 656 void drm_gem_vm_close(struct vm_area_struct *vma)
 657 {
 658         struct drm_gem_object *obj = vma->vm_private_data;
 659         struct drm_device *dev = obj->dev;
 660
 661         mutex_lock(&dev->struct_mutex);
 662         drm_vm_close_locked(obj->dev, vma);
 663         drm_gem_object_unreference(obj);
 664         mutex_unlock(&dev->struct_mutex);
 665 }
 666 EXPORT_SYMBOL(drm_gem_vm_close);
 667
 668 /**
 669  * drm_gem_mmap_obj - memory map a GEM object
 670  * @obj: the GEM object to map
 671  * @obj_size: the object size to be mapped, in bytes
 672  * @vma: VMA for the area to be mapped
 673  *
 674  * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
 675  * provided by the driver. Depending on their requirements, drivers can either
 676  * provide a fault handler in their gem_vm_ops (in which case any accesses to
 677  * the object will be trapped, to perform migration, GTT binding, surface
 678  * register allocation, or performance monitoring), or mmap the buffer memory
 679  * synchronously after calling drm_gem_mmap_obj.
 680  *
 681  * This function is mainly intended to implement the DMABUF mmap operation, when
 682  * the GEM object is not looked up based on its fake offset. To implement the
 683  * DRM mmap operation, drivers should use the drm_gem_mmap() function.
 684  *
 685  * NOTE: This function has to be protected with dev->struct_mutex
 686  *
 687  * Return 0 or success or -EINVAL if the object size is smaller than the VMA
 688  * size, or if no gem_vm_ops are provided.
 689  */
 690 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
 691                      struct vm_area_struct *vma)
 692 {
 693         struct drm_device *dev = obj->dev;
 694
 695         lockdep_assert_held(&dev->struct_mutex);
 696
 697         /* Check for valid size. */
 698         if (obj_size < vma->vm_end - vma->vm_start)
 699                 return -EINVAL;
 700
 701         if (!dev->driver->gem_vm_ops)
 702                 return -EINVAL;
 703
 704         vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
 705         vma->vm_ops = dev->driver->gem_vm_ops;
 706         vma->vm_private_data = obj;
 707         vma->vm_page_prot =  pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
 708
 709         /* Take a ref for this mapping of the object, so that the fault
 710          * handler can dereference the mmap offset's pointer to the object.
 711          * This reference is cleaned up by the corresponding vm_close
 712          * (which should happen whether the vma was created by this call, or
 713          * by a vm_open due to mremap or partial unmap or whatever).
 714          */
 715         drm_gem_object_reference(obj);
 716
 717         drm_vm_open_locked(dev, vma);
 718         return 0;
 719 }
 720 EXPORT_SYMBOL(drm_gem_mmap_obj);
 721
 722 /**
 723  * drm_gem_mmap - memory map routine for GEM objects
 724  * @filp: DRM file pointer
 725  * @vma: VMA for the area to be mapped
 726  *
 727  * If a driver supports GEM object mapping, mmap calls on the DRM file
 728  * descriptor will end up here.
 729  *
 730  * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
 731  * contain the fake offset we created when the GTT map ioctl was called on
 732  * the object) and map it with a call to drm_gem_mmap_obj().
 733  */
 734 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
 735 {
 736         struct drm_file *priv = filp->private_data;
 737         struct drm_device *dev = priv->minor->dev;
 738         struct drm_gem_mm *mm = dev->mm_private;
 739         struct drm_local_map *map = NULL;
 740         struct drm_hash_item *hash;
 741         int ret = 0;
 742
 743         if (drm_device_is_unplugged(dev))
 744                 return -ENODEV;
 745
 746         mutex_lock(&dev->struct_mutex);
 747
 748         if (drm_ht_find_item(&mm->offset_hash, vma->vm_pgoff, &hash)) {
 749                 mutex_unlock(&dev->struct_mutex);
 750                 return drm_mmap(filp, vma);
 751         }
 752
 753         map = drm_hash_entry(hash, struct drm_map_list, hash)->map;
 754         if (!map ||
 755             ((map->flags & _DRM_RESTRICTED) && !capable(CAP_SYS_ADMIN))) {
 756                 ret =  -EPERM;
 757                 goto out_unlock;
 758         }
 759
 760         ret = drm_gem_mmap_obj(map->handle, map->size, vma);
 761
 762 out_unlock:
 763         mutex_unlock(&dev->struct_mutex);
 764
 765         return ret;
 766 }
 767 EXPORT_SYMBOL(drm_gem_mmap);