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 (atomic_read(&obj->handle_count) == 0)
 251                 return;
 252
 253         /*
 254         * Must bump handle count first as this may be the last
 255         * ref, in which case the object would disappear before we
 256         * checked for a name
 257         */
 258
 259         if (atomic_dec_and_test(&obj->handle_count))
 260                 drm_gem_object_handle_free(obj);
 261         drm_gem_object_unreference_unlocked(obj);
 262 }
 263
 264 /**
 265  * Removes the mapping from handle to filp for this object.
 266  */
 267 int
 268 drm_gem_handle_delete(struct drm_file *filp, u32 handle)
 269 {
 270         struct drm_device *dev;
 271         struct drm_gem_object *obj;
 272
 273         /* This is gross. The idr system doesn't let us try a delete and
 274          * return an error code.  It just spews if you fail at deleting.
 275          * So, we have to grab a lock around finding the object and then
 276          * doing the delete on it and dropping the refcount, or the user
 277          * could race us to double-decrement the refcount and cause a
 278          * use-after-free later.  Given the frequency of our handle lookups,
 279          * we may want to use ida for number allocation and a hash table
 280          * for the pointers, anyway.
 281          */
 282         spin_lock(&filp->table_lock);
 283
 284         /* Check if we currently have a reference on the object */
 285         obj = idr_find(&filp->object_idr, handle);
 286         if (obj == NULL) {
 287                 spin_unlock(&filp->table_lock);
 288                 return -EINVAL;
 289         }
 290         dev = obj->dev;
 291
 292         DRM_DEBUG("%s:hdl[%d]obj[0x%x]\n", __func__, handle, (int)obj);
 293
 294         /* Release reference and decrement refcount. */
 295         idr_remove(&filp->object_idr, handle);
 296         spin_unlock(&filp->table_lock);
 297
 298         drm_gem_remove_prime_handles(obj, filp);
 299
 300         if (dev->driver->gem_close_object)
 301                 dev->driver->gem_close_object(obj, filp);
 302         drm_gem_object_handle_unreference_unlocked(obj);
 303
 304         return 0;
 305 }
 306 EXPORT_SYMBOL(drm_gem_handle_delete);
 307
 308 /**
 309  * Create a handle for this object. This adds a handle reference
 310  * to the object, which includes a regular reference count. Callers
 311  * will likely want to dereference the object afterwards.
 312  */
 313 int
 314 drm_gem_handle_create(struct drm_file *file_priv,
 315                        struct drm_gem_object *obj,
 316                        u32 *handlep)
 317 {
 318         struct drm_device *dev = obj->dev;
 319         int ret;
 320
 321         /*
 322          * Get the user-visible handle using idr.  Preload and perform
 323          * allocation under our spinlock.
 324          */
 325         idr_preload(GFP_KERNEL);
 326         spin_lock(&file_priv->table_lock);
 327
 328         ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
 329
 330         spin_unlock(&file_priv->table_lock);
 331         idr_preload_end();
 332         if (ret < 0)
 333                 return ret;
 334         *handlep = ret;
 335
 336         drm_gem_object_handle_reference(obj);
 337
 338         if (dev->driver->gem_open_object) {
 339                 ret = dev->driver->gem_open_object(obj, file_priv);
 340                 if (ret) {
 341                         drm_gem_handle_delete(file_priv, *handlep);
 342                         return ret;
 343                 }
 344         }
 345
 346         return 0;
 347 }
 348 EXPORT_SYMBOL(drm_gem_handle_create);
 349
 350
 351 /**
 352  * drm_gem_free_mmap_offset - release a fake mmap offset for an object
 353  * @obj: obj in question
 354  *
 355  * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
 356  */
 357 void
 358 drm_gem_free_mmap_offset(struct drm_gem_object *obj)
 359 {
 360         struct drm_device *dev = obj->dev;
 361         struct drm_gem_mm *mm = dev->mm_private;
 362         struct drm_map_list *list = &obj->map_list;
 363
 364         drm_ht_remove_item(&mm->offset_hash, &list->hash);
 365         drm_mm_put_block(list->file_offset_node);
 366         kfree(list->map);
 367         list->map = NULL;
 368 }
 369 EXPORT_SYMBOL(drm_gem_free_mmap_offset);
 370
 371 /**
 372  * drm_gem_create_mmap_offset - create a fake mmap offset for an object
 373  * @obj: obj in question
 374  *
 375  * GEM memory mapping works by handing back to userspace a fake mmap offset
 376  * it can use in a subsequent mmap(2) call.  The DRM core code then looks
 377  * up the object based on the offset and sets up the various memory mapping
 378  * structures.
 379  *
 380  * This routine allocates and attaches a fake offset for @obj.
 381  */
 382 int
 383 drm_gem_create_mmap_offset(struct drm_gem_object *obj)
 384 {
 385         struct drm_device *dev = obj->dev;
 386         struct drm_gem_mm *mm = dev->mm_private;
 387         struct drm_map_list *list;
 388         struct drm_local_map *map;
 389         int ret;
 390
 391         /* Set the object up for mmap'ing */
 392         list = &obj->map_list;
 393         list->map = kzalloc(sizeof(struct drm_map_list), GFP_KERNEL);
 394         if (!list->map)
 395                 return -ENOMEM;
 396
 397         map = list->map;
 398         map->type = _DRM_GEM;
 399         map->size = obj->size;
 400         map->handle = obj;
 401
 402         /* Get a DRM GEM mmap offset allocated... */
 403         list->file_offset_node = drm_mm_search_free(&mm->offset_manager,
 404                         obj->size / PAGE_SIZE, 0, false);
 405
 406         if (!list->file_offset_node) {
 407                 DRM_ERROR("failed to allocate offset for bo %d\n", obj->name);
 408                 ret = -ENOSPC;
 409                 goto out_free_list;
 410         }
 411
 412         list->file_offset_node = drm_mm_get_block(list->file_offset_node,
 413                         obj->size / PAGE_SIZE, 0);
 414         if (!list->file_offset_node) {
 415                 ret = -ENOMEM;
 416                 goto out_free_list;
 417         }
 418
 419         list->hash.key = list->file_offset_node->start;
 420         ret = drm_ht_insert_item(&mm->offset_hash, &list->hash);
 421         if (ret) {
 422                 DRM_ERROR("failed to add to map hash\n");
 423                 goto out_free_mm;
 424         }
 425
 426         return 0;
 427
 428 out_free_mm:
 429         drm_mm_put_block(list->file_offset_node);
 430 out_free_list:
 431         kfree(list->map);
 432         list->map = NULL;
 433
 434         return ret;
 435 }
 436 EXPORT_SYMBOL(drm_gem_create_mmap_offset);
 437
 438 /** Returns a reference to the object named by the handle. */
 439 struct drm_gem_object *
 440 drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
 441                       u32 handle)
 442 {
 443         struct drm_gem_object *obj;
 444
 445         spin_lock(&filp->table_lock);
 446
 447         /* Check if we currently have a reference on the object */
 448         obj = idr_find(&filp->object_idr, handle);
 449         if (obj == NULL) {
 450                 spin_unlock(&filp->table_lock);
 451                 return NULL;
 452         }
 453
 454         drm_gem_object_reference(obj);
 455
 456         spin_unlock(&filp->table_lock);
 457
 458         return obj;
 459 }
 460 EXPORT_SYMBOL(drm_gem_object_lookup);
 461
 462 /**
 463  * Releases the handle to an mm object.
 464  */
 465 int
 466 drm_gem_close_ioctl(struct drm_device *dev, void *data,
 467                     struct drm_file *file_priv)
 468 {
 469         struct drm_gem_close *args = data;
 470         int ret;
 471
 472         if (!(dev->driver->driver_features & DRIVER_GEM))
 473                 return -ENODEV;
 474
 475         ret = drm_gem_handle_delete(file_priv, args->handle);
 476
 477         return ret;
 478 }
 479
 480 /**
 481  * Create a global name for an object, returning the name.
 482  *
 483  * Note that the name does not hold a reference; when the object
 484  * is freed, the name goes away.
 485  */
 486 int
 487 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
 488                     struct drm_file *file_priv)
 489 {
 490         struct drm_gem_flink *args = data;
 491         struct drm_gem_object *obj;
 492         int ret;
 493
 494         if (!(dev->driver->driver_features & DRIVER_GEM))
 495                 return -ENODEV;
 496
 497         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
 498         if (obj == NULL)
 499                 return -ENOENT;
 500
 501         idr_preload(GFP_KERNEL);
 502         spin_lock(&dev->object_name_lock);
 503         if (!obj->name) {
 504                 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
 505                 if (ret < 0)
 506                         goto err;
 507
 508                 obj->name = ret;
 509
 510                 /* Allocate a reference for the name table.  */
 511                 drm_gem_object_reference(obj);
 512         }
 513
 514         args->name = (uint64_t) obj->name;
 515         ret = 0;
 516
 517 err:
 518         spin_unlock(&dev->object_name_lock);
 519         idr_preload_end();
 520         drm_gem_object_unreference_unlocked(obj);
 521
 522         DRM_DEBUG("%s:hdl[%d]obj[0x%x]name[%d]\n",
 523                 __func__, (int) args->handle, (int)obj, args->name);
 524
 525         return ret;
 526 }
 527
 528 /**
 529  * Open an object using the global name, returning a handle and the size.
 530  *
 531  * This handle (of course) holds a reference to the object, so the object
 532  * will not go away until the handle is deleted.
 533  */
 534 int
 535 drm_gem_open_ioctl(struct drm_device *dev, void *data,
 536                    struct drm_file *file_priv)
 537 {
 538         struct drm_gem_open *args = data;
 539         struct drm_gem_object *obj;
 540         int ret;
 541         u32 handle;
 542
 543         if (!(dev->driver->driver_features & DRIVER_GEM))
 544                 return -ENODEV;
 545
 546         spin_lock(&dev->object_name_lock);
 547         obj = idr_find(&dev->object_name_idr, (int) args->name);
 548         if (obj)
 549                 drm_gem_object_reference(obj);
 550         spin_unlock(&dev->object_name_lock);
 551         if (!obj)
 552                 return -ENOENT;
 553
 554         ret = drm_gem_handle_create(file_priv, obj, &handle);
 555         drm_gem_object_unreference_unlocked(obj);
 556         if (ret)
 557                 return ret;
 558
 559         args->handle = handle;
 560         args->size = obj->size;
 561
 562         DRM_DEBUG("%s:name[%d]obj[0x%x]hdl[%d]sz[%d]\n",
 563                 __func__, (int) args->name, (int)obj,
 564                 args->handle, (int)args->size);
 565
 566         return 0;
 567 }
 568
 569 /**
 570  * Called at device open time, sets up the structure for handling refcounting
 571  * of mm objects.
 572  */
 573 void
 574 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
 575 {
 576         idr_init(&file_private->object_idr);
 577         spin_lock_init(&file_private->table_lock);
 578 }
 579
 580 /**
 581  * Called at device close to release the file's
 582  * handle references on objects.
 583  */
 584 static int
 585 drm_gem_object_release_handle(int id, void *ptr, void *data)
 586 {
 587         struct drm_file *file_priv = data;
 588         struct drm_gem_object *obj = ptr;
 589         struct drm_device *dev = obj->dev;
 590
 591         drm_gem_remove_prime_handles(obj, file_priv);
 592
 593         if (dev->driver->gem_close_object)
 594                 dev->driver->gem_close_object(obj, file_priv);
 595
 596         drm_gem_object_handle_unreference_unlocked(obj);
 597
 598         return 0;
 599 }
 600
 601 /**
 602  * Called at close time when the filp is going away.
 603  *
 604  * Releases any remaining references on objects by this filp.
 605  */
 606 void
 607 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
 608 {
 609         idr_for_each(&file_private->object_idr,
 610                      &drm_gem_object_release_handle, file_private);
 611         idr_destroy(&file_private->object_idr);
 612 }
 613
 614 void
 615 drm_gem_object_release(struct drm_gem_object *obj)
 616 {
 617         if (obj->filp)
 618             fput(obj->filp);
 619 }
 620 EXPORT_SYMBOL(drm_gem_object_release);
 621
 622 /**
 623  * Called after the last reference to the object has been lost.
 624  * Must be called holding struct_ mutex
 625  *
 626  * Frees the object
 627  */
 628 void
 629 drm_gem_object_free(struct kref *kref)
 630 {
 631         struct drm_gem_object *obj = (struct drm_gem_object *) kref;
 632         struct drm_device *dev = obj->dev;
 633
 634         BUG_ON(!mutex_is_locked(&dev->struct_mutex));
 635
 636         if (dev->driver->gem_free_object != NULL)
 637                 dev->driver->gem_free_object(obj);
 638 }
 639 EXPORT_SYMBOL(drm_gem_object_free);
 640
 641 void drm_gem_vm_open(struct vm_area_struct *vma)
 642 {
 643         struct drm_gem_object *obj = vma->vm_private_data;
 644
 645         drm_gem_object_reference(obj);
 646
 647         mutex_lock(&obj->dev->struct_mutex);
 648         drm_vm_open_locked(obj->dev, vma);
 649         mutex_unlock(&obj->dev->struct_mutex);
 650 }
 651 EXPORT_SYMBOL(drm_gem_vm_open);
 652
 653 void drm_gem_vm_close(struct vm_area_struct *vma)
 654 {
 655         struct drm_gem_object *obj = vma->vm_private_data;
 656         struct drm_device *dev = obj->dev;
 657
 658         mutex_lock(&dev->struct_mutex);
 659         drm_vm_close_locked(obj->dev, vma);
 660         drm_gem_object_unreference(obj);
 661         mutex_unlock(&dev->struct_mutex);
 662 }
 663 EXPORT_SYMBOL(drm_gem_vm_close);
 664
 665 /**
 666  * drm_gem_mmap_obj - memory map a GEM object
 667  * @obj: the GEM object to map
 668  * @obj_size: the object size to be mapped, in bytes
 669  * @vma: VMA for the area to be mapped
 670  *
 671  * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
 672  * provided by the driver. Depending on their requirements, drivers can either
 673  * provide a fault handler in their gem_vm_ops (in which case any accesses to
 674  * the object will be trapped, to perform migration, GTT binding, surface
 675  * register allocation, or performance monitoring), or mmap the buffer memory
 676  * synchronously after calling drm_gem_mmap_obj.
 677  *
 678  * This function is mainly intended to implement the DMABUF mmap operation, when
 679  * the GEM object is not looked up based on its fake offset. To implement the
 680  * DRM mmap operation, drivers should use the drm_gem_mmap() function.
 681  *
 682  * NOTE: This function has to be protected with dev->struct_mutex
 683  *
 684  * Return 0 or success or -EINVAL if the object size is smaller than the VMA
 685  * size, or if no gem_vm_ops are provided.
 686  */
 687 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
 688                      struct vm_area_struct *vma)
 689 {
 690         struct drm_device *dev = obj->dev;
 691
 692         lockdep_assert_held(&dev->struct_mutex);
 693
 694         /* Check for valid size. */
 695         if (obj_size < vma->vm_end - vma->vm_start)
 696                 return -EINVAL;
 697
 698         if (!dev->driver->gem_vm_ops)
 699                 return -EINVAL;
 700
 701         vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
 702         vma->vm_ops = dev->driver->gem_vm_ops;
 703         vma->vm_private_data = obj;
 704         vma->vm_page_prot =  pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
 705
 706         /* Take a ref for this mapping of the object, so that the fault
 707          * handler can dereference the mmap offset's pointer to the object.
 708          * This reference is cleaned up by the corresponding vm_close
 709          * (which should happen whether the vma was created by this call, or
 710          * by a vm_open due to mremap or partial unmap or whatever).
 711          */
 712         drm_gem_object_reference(obj);
 713
 714         drm_vm_open_locked(dev, vma);
 715         return 0;
 716 }
 717 EXPORT_SYMBOL(drm_gem_mmap_obj);
 718
 719 /**
 720  * drm_gem_mmap - memory map routine for GEM objects
 721  * @filp: DRM file pointer
 722  * @vma: VMA for the area to be mapped
 723  *
 724  * If a driver supports GEM object mapping, mmap calls on the DRM file
 725  * descriptor will end up here.
 726  *
 727  * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
 728  * contain the fake offset we created when the GTT map ioctl was called on
 729  * the object) and map it with a call to drm_gem_mmap_obj().
 730  */
 731 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
 732 {
 733         struct drm_file *priv = filp->private_data;
 734         struct drm_device *dev = priv->minor->dev;
 735         struct drm_gem_mm *mm = dev->mm_private;
 736         struct drm_local_map *map = NULL;
 737         struct drm_hash_item *hash;
 738         int ret = 0;
 739
 740         if (drm_device_is_unplugged(dev))
 741                 return -ENODEV;
 742
 743         mutex_lock(&dev->struct_mutex);
 744
 745         if (drm_ht_find_item(&mm->offset_hash, vma->vm_pgoff, &hash)) {
 746                 mutex_unlock(&dev->struct_mutex);
 747                 return drm_mmap(filp, vma);
 748         }
 749
 750         map = drm_hash_entry(hash, struct drm_map_list, hash)->map;
 751         if (!map ||
 752             ((map->flags & _DRM_RESTRICTED) && !capable(CAP_SYS_ADMIN))) {
 753                 ret =  -EPERM;
 754                 goto out_unlock;
 755         }
 756
 757         ret = drm_gem_mmap_obj(map->handle, map->size, vma);
 758
 759 out_unlock:
 760         mutex_unlock(&dev->struct_mutex);
 761
 762         return ret;
 763 }
 764 EXPORT_SYMBOL(drm_gem_mmap);