sys/dev/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  * Copyright (c) 2011 The FreeBSD Foundation
  29  * All rights reserved.
  30  *
  31  * This software was developed by Konstantin Belousov under sponsorship from
  32  * the FreeBSD Foundation.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  */
  55
  56 #include "opt_vm.h"
  57
  58 #include <sys/param.h>
  59 #include <sys/systm.h>
  60 #include <sys/limits.h>
  61 #include <sys/lock.h>
  62 #include <sys/mutex.h>
  63 #include <sys/conf.h>
  64
  65 #include <vm/vm.h>
  66 #include <vm/vm_page.h>
  67
  68 #include <linux/types.h>
  69 #include <linux/mm.h>
  70 #include <linux/module.h>
  71 #include <drm/drmP.h>
  72 #include <drm/drm_vma_manager.h>
  73 #include <drm/drm_gem.h>
  74 #include "drm_internal.h"
  75
  76 /** @file drm_gem.c
  77  *
  78  * This file provides some of the base ioctls and library routines for
  79  * the graphics memory manager implemented by each device driver.
  80  *
  81  * Because various devices have different requirements in terms of
  82  * synchronization and migration strategies, implementing that is left up to
  83  * the driver, and all that the general API provides should be generic --
  84  * allocating objects, reading/writing data with the cpu, freeing objects.
  85  * Even there, platform-dependent optimizations for reading/writing data with
  86  * the CPU mean we'll likely hook those out to driver-specific calls.  However,
  87  * the DRI2 implementation wants to have at least allocate/mmap be generic.
  88  *
  89  * The goal was to have swap-backed object allocation managed through
  90  * struct file.  However, file descriptors as handles to a struct file have
  91  * two major failings:
  92  * - Process limits prevent more than 1024 or so being used at a time by
  93  *   default.
  94  * - Inability to allocate high fds will aggravate the X Server's select()
  95  *   handling, and likely that of many GL client applications as well.
  96  *
  97  * This led to a plan of using our own integer IDs (called handles, following
  98  * DRM terminology) to mimic fds, and implement the fd syscalls we need as
  99  * ioctls.  The objects themselves will still include the struct file so
 100  * that we can transition to fds if the required kernel infrastructure shows
 101  * up at a later date, and as our interface with shmfs for memory allocation.
 102  */
 103
 104 /*
 105  * We make up offsets for buffer objects so we can recognize them at
 106  * mmap time.
 107  */
 108
 109 /* pgoff in mmap is an unsigned long, so we need to make sure that
 110  * the faked up offset will fit
 111  */
 112
 113 #if BITS_PER_LONG == 64
 114 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
 115 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
 116 #else
 117 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
 118 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
 119 #endif
 120
 121 /**
 122  * drm_gem_init - Initialize the GEM device fields
 123  * @dev: drm_devic structure to initialize
 124  */
 125 int
 126 drm_gem_init(struct drm_device *dev)
 127 {
 128         struct drm_gem_mm *mm;
 129
 130         lockinit(&dev->object_name_lock, "objnam", 0, LK_CANRECURSE);
 131         idr_init(&dev->object_name_idr);
 132
 133         mm = kzalloc(sizeof(struct drm_gem_mm), GFP_KERNEL);
 134         if (!mm) {
 135                 DRM_ERROR("out of memory\n");
 136                 return -ENOMEM;
 137         }
 138
 139         dev->mm_private = mm;
 140
 141         if (drm_ht_create(&mm->offset_hash, 12)) {
 142                 kfree(mm);
 143                 return -ENOMEM;
 144         }
 145
 146         mm->idxunr = new_unrhdr(0, DRM_GEM_MAX_IDX, NULL);
 147         drm_mm_init(&mm->offset_manager, DRM_FILE_PAGE_OFFSET_START,
 148                     DRM_FILE_PAGE_OFFSET_SIZE);
 149         drm_vma_offset_manager_init(&mm->vma_manager,
 150                                     DRM_FILE_PAGE_OFFSET_START,
 151                                     DRM_FILE_PAGE_OFFSET_SIZE);
 152
 153         return 0;
 154 }
 155
 156 void
 157 drm_gem_destroy(struct drm_device *dev)
 158 {
 159         struct drm_gem_mm *mm = dev->mm_private;
 160
 161         drm_mm_takedown(&mm->offset_manager);
 162         drm_ht_remove(&mm->offset_hash);
 163
 164         drm_vma_offset_manager_destroy(&mm->vma_manager);
 165         delete_unrhdr(mm->idxunr);
 166         kfree(mm);
 167         dev->mm_private = NULL;
 168 }
 169
 170 /**
 171  * Initialize an already allocated GEM object of the specified size with
 172  * shmfs backing store.
 173  */
 174 int drm_gem_object_init(struct drm_device *dev,
 175                         struct drm_gem_object *obj, size_t size)
 176 {
 177         drm_gem_private_object_init(dev, obj, size);
 178
 179         obj->vm_obj = default_pager_alloc(NULL, size,
 180             VM_PROT_READ | VM_PROT_WRITE, 0);
 181
 182         return 0;
 183 }
 184 EXPORT_SYMBOL(drm_gem_object_init);
 185
 186 /**
 187  * drm_gem_object_init - initialize an allocated private GEM object
 188  * @dev: drm_device the object should be initialized for
 189  * @obj: drm_gem_object to initialize
 190  * @size: object size
 191  *
 192  * Initialize an already allocated GEM object of the specified size with
 193  * no GEM provided backing store. Instead the caller is responsible for
 194  * backing the object and handling it.
 195  */
 196 void drm_gem_private_object_init(struct drm_device *dev,
 197                                  struct drm_gem_object *obj, size_t size)
 198 {
 199         BUG_ON((size & (PAGE_SIZE - 1)) != 0);
 200
 201         obj->dev = dev;
 202         obj->vm_obj = NULL;
 203
 204         kref_init(&obj->refcount);
 205         obj->handle_count = 0;
 206         obj->size = size;
 207         drm_vma_node_reset(&obj->vma_node);
 208 }
 209 EXPORT_SYMBOL(drm_gem_private_object_init);
 210
 211 static void
 212 drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
 213 {
 214 #if 0
 215         if (obj->import_attach) {
 216                 drm_prime_remove_buf_handle(&filp->prime,
 217                                 obj->import_attach->dmabuf);
 218         }
 219         if (obj->export_dma_buf) {
 220                 drm_prime_remove_buf_handle(&filp->prime,
 221                                 obj->export_dma_buf);
 222         }
 223 #endif
 224 }
 225
 226 static void drm_gem_object_ref_bug(struct kref *list_kref)
 227 {
 228         BUG();
 229 }
 230
 231 /**
 232  * drm_gem_object_free - release resources bound to userspace handles
 233  * @obj: GEM object to clean up.
 234  *
 235  * Called after the last handle to the object has been closed
 236  *
 237  * Removes any name for the object. Note that this must be
 238  * called before drm_gem_object_free or we'll be touching
 239  * freed memory
 240  */
 241 static void drm_gem_object_handle_free(struct drm_gem_object *obj)
 242 {
 243         struct drm_device *dev = obj->dev;
 244
 245         /* Remove any name for this object */
 246         if (obj->name) {
 247                 idr_remove(&dev->object_name_idr, obj->name);
 248                 obj->name = 0;
 249         /*
 250          * The object name held a reference to this object, drop
 251          * that now.
 252         *
 253         * This cannot be the last reference, since the handle holds one too.
 254          */
 255                 kref_put(&obj->refcount, drm_gem_object_ref_bug);
 256         }
 257 }
 258
 259 #if 0
 260 static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj)
 261 {
 262         /* Unbreak the reference cycle if we have an exported dma_buf. */
 263         if (obj->dma_buf) {
 264                 dma_buf_put(obj->dma_buf);
 265                 obj->dma_buf = NULL;
 266         }
 267 }
 268 #endif
 269
 270 static void
 271 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
 272 {
 273         if (WARN_ON(obj->handle_count == 0))
 274                 return;
 275
 276         /*
 277         * Must bump handle count first as this may be the last
 278         * ref, in which case the object would disappear before we
 279         * checked for a name
 280         */
 281
 282         mutex_lock(&obj->dev->object_name_lock);
 283         if (--obj->handle_count == 0)
 284                 drm_gem_object_handle_free(obj);
 285         mutex_unlock(&obj->dev->object_name_lock);
 286
 287         drm_gem_object_unreference_unlocked(obj);
 288 }
 289
 290 /**
 291  * drm_gem_handle_delete - deletes the given file-private handle
 292  * @filp: drm file-private structure to use for the handle look up
 293  * @handle: userspace handle to delete
 294  *
 295  * Removes the GEM handle from the @filp lookup table which has been added with
 296  * drm_gem_handle_create(). If this is the last handle also cleans up linked
 297  * resources like GEM names.
 298  */
 299 int
 300 drm_gem_handle_delete(struct drm_file *filp, u32 handle)
 301 {
 302         struct drm_device *dev;
 303         struct drm_gem_object *obj;
 304
 305         /* This is gross. The idr system doesn't let us try a delete and
 306          * return an error code.  It just spews if you fail at deleting.
 307          * So, we have to grab a lock around finding the object and then
 308          * doing the delete on it and dropping the refcount, or the user
 309          * could race us to double-decrement the refcount and cause a
 310          * use-after-free later.  Given the frequency of our handle lookups,
 311          * we may want to use ida for number allocation and a hash table
 312          * for the pointers, anyway.
 313          */
 314         lockmgr(&filp->table_lock, LK_EXCLUSIVE);
 315
 316         /* Check if we currently have a reference on the object */
 317         obj = idr_find(&filp->object_idr, handle);
 318         if (obj == NULL) {
 319                 lockmgr(&filp->table_lock, LK_RELEASE);
 320                 return -EINVAL;
 321         }
 322         dev = obj->dev;
 323
 324         /* Release reference and decrement refcount. */
 325         idr_remove(&filp->object_idr, handle);
 326         lockmgr(&filp->table_lock, LK_RELEASE);
 327
 328         drm_gem_remove_prime_handles(obj, filp);
 329
 330         if (dev->driver->gem_close_object)
 331                 dev->driver->gem_close_object(obj, filp);
 332         drm_gem_object_handle_unreference_unlocked(obj);
 333
 334         return 0;
 335 }
 336 EXPORT_SYMBOL(drm_gem_handle_delete);
 337
 338 /**
 339  * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
 340  * @file: drm file-private structure to remove the dumb handle from
 341  * @dev: corresponding drm_device
 342  * @handle: the dumb handle to remove
 343  *
 344  * This implements the ->dumb_destroy kms driver callback for drivers which use
 345  * gem to manage their backing storage.
 346  */
 347 int drm_gem_dumb_destroy(struct drm_file *file,
 348                          struct drm_device *dev,
 349                          uint32_t handle)
 350 {
 351         return drm_gem_handle_delete(file, handle);
 352 }
 353 EXPORT_SYMBOL(drm_gem_dumb_destroy);
 354
 355 /**
 356  * drm_gem_handle_create_tail - internal functions to create a handle
 357  * @file_priv: drm file-private structure to register the handle for
 358  * @obj: object to register
 359  * @handlep: pointer to return the created handle to the caller
 360  *
 361  * This expects the dev->object_name_lock to be held already and will drop it
 362  * before returning. Used to avoid races in establishing new handles when
 363  * importing an object from either an flink name or a dma-buf.
 364  *
 365  * Handles must be release again through drm_gem_handle_delete(). This is done
 366  * when userspace closes @file_priv for all attached handles, or through the
 367  * GEM_CLOSE ioctl for individual handles.
 368  */
 369 int
 370 drm_gem_handle_create_tail(struct drm_file *file_priv,
 371                            struct drm_gem_object *obj,
 372                            u32 *handlep)
 373 {
 374         struct drm_device *dev = obj->dev;
 375         int ret;
 376
 377         *handlep = 0;           /* whack gcc warning */
 378         WARN_ON(!mutex_is_locked(&dev->object_name_lock));
 379
 380         /*
 381          * Get the user-visible handle using idr.  Preload and perform
 382          * allocation under our spinlock.
 383          */
 384         idr_preload(GFP_KERNEL);
 385         lockmgr(&file_priv->table_lock, LK_EXCLUSIVE);
 386
 387         ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
 388         drm_gem_object_reference(obj);
 389         obj->handle_count++;
 390         lockmgr(&file_priv->table_lock, LK_RELEASE);
 391         idr_preload_end();
 392         mutex_unlock(&dev->object_name_lock);
 393         if (ret < 0) {
 394                 drm_gem_object_handle_unreference_unlocked(obj);
 395                 return ret;
 396         }
 397         *handlep = ret;
 398
 399 #if 0
 400         ret = drm_vma_node_allow(&obj->vma_node, file_priv->filp);
 401         if (ret) {
 402                 drm_gem_handle_delete(file_priv, *handlep);
 403                 return ret;
 404         }
 405 #endif
 406
 407         if (dev->driver->gem_open_object) {
 408                 ret = dev->driver->gem_open_object(obj, file_priv);
 409                 if (ret) {
 410                         drm_gem_handle_delete(file_priv, *handlep);
 411                         return ret;
 412                 }
 413         }
 414
 415         return 0;
 416 }
 417
 418 /**
 419  * drm_gem_handle_create - create a gem handle for an object
 420  * @file_priv: drm file-private structure to register the handle for
 421  * @obj: object to register
 422  * @handlep: pionter to return the created handle to the caller
 423  *
 424  * Create a handle for this object. This adds a handle reference
 425  * to the object, which includes a regular reference count. Callers
 426  * will likely want to dereference the object afterwards.
 427  */
 428 int drm_gem_handle_create(struct drm_file *file_priv,
 429                           struct drm_gem_object *obj,
 430                           u32 *handlep)
 431 {
 432         mutex_lock(&obj->dev->object_name_lock);
 433
 434         return drm_gem_handle_create_tail(file_priv, obj, handlep);
 435 }
 436 EXPORT_SYMBOL(drm_gem_handle_create);
 437
 438 /**
 439  * drm_gem_free_mmap_offset - release a fake mmap offset for an object
 440  * @obj: obj in question
 441  *
 442  * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
 443  */
 444 void
 445 drm_gem_free_mmap_offset(struct drm_gem_object *obj)
 446 {
 447         struct drm_device *dev = obj->dev;
 448         struct drm_gem_mm *mm = dev->mm_private;
 449         struct drm_hash_item *list;
 450
 451         if (!obj->on_map)
 452                 return;
 453         list = &obj->map_list;
 454
 455         drm_ht_remove_item(&mm->offset_hash, list);
 456         free_unr(mm->idxunr, list->key);
 457         obj->on_map = false;
 458
 459         drm_vma_offset_remove(&mm->vma_manager, &obj->vma_node);
 460 }
 461 EXPORT_SYMBOL(drm_gem_free_mmap_offset);
 462
 463 /**
 464  * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
 465  * @obj: obj in question
 466  * @size: the virtual size
 467  *
 468  * GEM memory mapping works by handing back to userspace a fake mmap offset
 469  * it can use in a subsequent mmap(2) call.  The DRM core code then looks
 470  * up the object based on the offset and sets up the various memory mapping
 471  * structures.
 472  *
 473  * This routine allocates and attaches a fake offset for @obj, in cases where
 474  * the virtual size differs from the physical size (ie. obj->size).  Otherwise
 475  * just use drm_gem_create_mmap_offset().
 476  */
 477 int
 478 drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
 479 {
 480         struct drm_device *dev = obj->dev;
 481         struct drm_gem_mm *mm = dev->mm_private;
 482         int ret = 0;
 483
 484         if (obj->on_map)
 485                 return (0);
 486
 487         obj->map_list.key = alloc_unr(mm->idxunr);
 488         ret = drm_ht_insert_item(&mm->offset_hash, &obj->map_list);
 489         if (ret != 0) {
 490                 DRM_ERROR("failed to add to map hash\n");
 491                 free_unr(mm->idxunr, obj->map_list.key);
 492                 return (ret);
 493         }
 494         obj->on_map = true;
 495         return 0;
 496
 497         return drm_vma_offset_add(&mm->vma_manager, &obj->vma_node,
 498                                   size / PAGE_SIZE);
 499 }
 500 EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
 501
 502 /**
 503  * drm_gem_create_mmap_offset - create a fake mmap offset for an object
 504  * @obj: obj in question
 505  *
 506  * GEM memory mapping works by handing back to userspace a fake mmap offset
 507  * it can use in a subsequent mmap(2) call.  The DRM core code then looks
 508  * up the object based on the offset and sets up the various memory mapping
 509  * structures.
 510  *
 511  * This routine allocates and attaches a fake offset for @obj.
 512  */
 513 int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
 514 {
 515         return drm_gem_create_mmap_offset_size(obj, obj->size);
 516 }
 517 EXPORT_SYMBOL(drm_gem_create_mmap_offset);
 518
 519 /**
 520  * drm_gem_object_lookup - look up a GEM object from it's handle
 521  * @dev: DRM device
 522  * @filp: DRM file private date
 523  * @handle: userspace handle
 524  *
 525  * Returns:
 526  *
 527  * A reference to the object named by the handle if such exists on @filp, NULL
 528  * otherwise.
 529  */
 530 struct drm_gem_object *
 531 drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
 532                       u32 handle)
 533 {
 534         struct drm_gem_object *obj;
 535
 536         lockmgr(&filp->table_lock, LK_EXCLUSIVE);
 537
 538         /* Check if we currently have a reference on the object */
 539         obj = idr_find(&filp->object_idr, handle);
 540         if (obj == NULL) {
 541                 lockmgr(&filp->table_lock, LK_RELEASE);
 542                 return NULL;
 543         }
 544
 545         drm_gem_object_reference(obj);
 546
 547         lockmgr(&filp->table_lock, LK_RELEASE);
 548
 549         return obj;
 550 }
 551 EXPORT_SYMBOL(drm_gem_object_lookup);
 552
 553 /**
 554  * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl
 555  * @dev: drm_device
 556  * @data: ioctl data
 557  * @file_priv: drm file-private structure
 558  *
 559  * Releases the handle to an mm object.
 560  */
 561 int
 562 drm_gem_close_ioctl(struct drm_device *dev, void *data,
 563                     struct drm_file *file_priv)
 564 {
 565         struct drm_gem_close *args = data;
 566         int ret;
 567
 568         if (!drm_core_check_feature(dev, DRIVER_GEM))
 569                 return -ENODEV;
 570
 571         ret = drm_gem_handle_delete(file_priv, args->handle);
 572
 573         return ret;
 574 }
 575
 576 /**
 577  * Create a global name for an object, returning the name.
 578  *
 579  * Note that the name does not hold a reference; when the object
 580  * is freed, the name goes away.
 581  */
 582 int
 583 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
 584                     struct drm_file *file_priv)
 585 {
 586         struct drm_gem_flink *args = data;
 587         struct drm_gem_object *obj;
 588         int ret;
 589
 590         if (!drm_core_check_feature(dev, DRIVER_GEM))
 591                 return -ENODEV;
 592
 593         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
 594         if (obj == NULL)
 595                 return -ENOENT;
 596
 597         idr_preload(GFP_KERNEL);
 598         lockmgr(&dev->object_name_lock, LK_EXCLUSIVE);
 599         /* prevent races with concurrent gem_close. */
 600         if (obj->handle_count == 0) {
 601                 ret = -ENOENT;
 602                 goto err;
 603         }
 604
 605         if (!obj->name) {
 606                 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
 607                 if (ret < 0)
 608                         goto err;
 609
 610                 obj->name = ret;
 611
 612                 /* Allocate a reference for the name table.  */
 613                 drm_gem_object_reference(obj);
 614         }
 615
 616         args->name = (uint64_t) obj->name;
 617         ret = 0;
 618
 619 err:
 620         lockmgr(&dev->object_name_lock, LK_RELEASE);
 621         idr_preload_end();
 622         drm_gem_object_unreference_unlocked(obj);
 623         return ret;
 624 }
 625
 626 /**
 627  * drm_gem_open - implementation of the GEM_OPEN ioctl
 628  * @dev: drm_device
 629  * @data: ioctl data
 630  * @file_priv: drm file-private structure
 631  *
 632  * Open an object using the global name, returning a handle and the size.
 633  *
 634  * This handle (of course) holds a reference to the object, so the object
 635  * will not go away until the handle is deleted.
 636  */
 637 int
 638 drm_gem_open_ioctl(struct drm_device *dev, void *data,
 639                    struct drm_file *file_priv)
 640 {
 641         struct drm_gem_open *args = data;
 642         struct drm_gem_object *obj;
 643         int ret;
 644         u32 handle;
 645
 646         if (!drm_core_check_feature(dev, DRIVER_GEM))
 647                 return -ENODEV;
 648
 649         lockmgr(&dev->object_name_lock, LK_EXCLUSIVE);
 650         obj = idr_find(&dev->object_name_idr, (int) args->name);
 651         if (obj)
 652                 drm_gem_object_reference(obj);
 653         lockmgr(&dev->object_name_lock, LK_RELEASE);
 654         if (!obj)
 655                 return -ENOENT;
 656
 657         ret = drm_gem_handle_create(file_priv, obj, &handle);
 658         drm_gem_object_unreference_unlocked(obj);
 659         if (ret)
 660                 return ret;
 661
 662         args->handle = handle;
 663         args->size = obj->size;
 664
 665         return 0;
 666 }
 667
 668 /**
 669  * gem_gem_open - initalizes GEM file-private structures at devnode open time
 670  * @dev: drm_device which is being opened by userspace
 671  * @file_private: drm file-private structure to set up
 672  *
 673  * Called at device open time, sets up the structure for handling refcounting
 674  * of mm objects.
 675  */
 676 void
 677 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
 678 {
 679         idr_init(&file_private->object_idr);
 680         lockinit(&file_private->table_lock, "fptab", 0, LK_CANRECURSE);
 681 }
 682
 683 /*
 684  * Called at device close to release the file's
 685  * handle references on objects.
 686  */
 687 static int
 688 drm_gem_object_release_handle(int id, void *ptr, void *data)
 689 {
 690         struct drm_file *file_priv = data;
 691         struct drm_gem_object *obj = ptr;
 692         struct drm_device *dev = obj->dev;
 693
 694         drm_gem_remove_prime_handles(obj, file_priv);
 695
 696         if (dev->driver->gem_close_object)
 697                 dev->driver->gem_close_object(obj, file_priv);
 698
 699         drm_gem_object_handle_unreference_unlocked(obj);
 700
 701         return 0;
 702 }
 703
 704 /**
 705  * drm_gem_release - release file-private GEM resources
 706  * @dev: drm_device which is being closed by userspace
 707  * @file_private: drm file-private structure to clean up
 708  *
 709  * Called at close time when the filp is going away.
 710  *
 711  * Releases any remaining references on objects by this filp.
 712  */
 713 void
 714 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
 715 {
 716         idr_for_each(&file_private->object_idr,
 717                      &drm_gem_object_release_handle, file_private);
 718         idr_destroy(&file_private->object_idr);
 719 }
 720
 721 void
 722 drm_gem_object_release(struct drm_gem_object *obj)
 723 {
 724
 725         /*
 726          * obj->vm_obj can be NULL for private gem objects.
 727          */
 728         vm_object_deallocate(obj->vm_obj);
 729 }
 730 EXPORT_SYMBOL(drm_gem_object_release);
 731
 732 /**
 733  * drm_gem_object_free - free a GEM object
 734  * @kref: kref of the object to free
 735  *
 736  * Called after the last reference to the object has been lost.
 737  * Must be called holding struct_ mutex
 738  *
 739  * Frees the object
 740  */
 741 void
 742 drm_gem_object_free(struct kref *kref)
 743 {
 744         struct drm_gem_object *obj =
 745                 container_of(kref, struct drm_gem_object, refcount);
 746         struct drm_device *dev = obj->dev;
 747
 748         WARN_ON(!mutex_is_locked(&dev->struct_mutex));
 749
 750         if (dev->driver->gem_free_object != NULL)
 751                 dev->driver->gem_free_object(obj);
 752 }
 753 EXPORT_SYMBOL(drm_gem_object_free);
 754
 755 static struct drm_gem_object *
 756 drm_gem_object_from_offset(struct drm_device *dev, vm_ooffset_t offset)
 757 {
 758         struct drm_gem_object *obj;
 759         struct drm_gem_mm *mm = dev->mm_private;
 760         struct drm_hash_item *hash;
 761
 762         if ((offset & DRM_GEM_MAPPING_MASK) != DRM_GEM_MAPPING_KEY)
 763                 return (NULL);
 764         offset &= ~DRM_GEM_MAPPING_KEY;
 765
 766         if (drm_ht_find_item(&mm->offset_hash, DRM_GEM_MAPPING_IDX(offset),
 767             &hash) != 0) {
 768                 return (NULL);
 769         }
 770         obj = container_of(hash, struct drm_gem_object, map_list);
 771         return (obj);
 772 }
 773
 774 int
 775 drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset, vm_size_t size,
 776     struct vm_object **obj_res, int nprot)
 777 {
 778         struct drm_gem_object *gem_obj;
 779         struct vm_object *vm_obj;
 780
 781         DRM_LOCK(dev);
 782         gem_obj = drm_gem_object_from_offset(dev, *offset);
 783         if (gem_obj == NULL) {
 784                 DRM_UNLOCK(dev);
 785                 return (ENODEV);
 786         }
 787
 788         drm_gem_object_reference(gem_obj);
 789         DRM_UNLOCK(dev);
 790         vm_obj = cdev_pager_allocate(gem_obj, OBJT_MGTDEVICE,
 791             dev->driver->gem_pager_ops, size, nprot,
 792             DRM_GEM_MAPPING_MAPOFF(*offset), curthread->td_ucred);
 793         if (vm_obj == NULL) {
 794                 drm_gem_object_unreference_unlocked(gem_obj);
 795                 return (EINVAL);
 796         }
 797         *offset = DRM_GEM_MAPPING_MAPOFF(*offset);
 798         *obj_res = vm_obj;
 799         return (0);
 800 }