drivers/gpu/drm/drm_file.c

   1 /*
   2  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   3  * \author Daryll Strauss <daryll@valinux.com>
   4  * \author Gareth Hughes <gareth@valinux.com>
   5  */
   6
   7 /*
   8  * Created: Mon Jan  4 08:58:31 1999 by faith@valinux.com
   9  *
  10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12  * All Rights Reserved.
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice (including the next
  22  * paragraph) shall be included in all copies or substantial portions of the
  23  * Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  28  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  31  * OTHER DEALINGS IN THE SOFTWARE.
  32  */
  33
  34 #include <linux/anon_inodes.h>
  35 #include <linux/dma-fence.h>
  36 #include <linux/file.h>
  37 #include <linux/module.h>
  38 #include <linux/pci.h>
  39 #include <linux/poll.h>
  40 #include <linux/slab.h>
  41
  42 #include <drm/drm_client.h>
  43 #include <drm/drm_drv.h>
  44 #include <drm/drm_file.h>
  45 #include <drm/drm_print.h>
  46
  47 #include "drm_crtc_internal.h"
  48 #include "drm_internal.h"
  49 #include "drm_legacy.h"
  50
  51 #if defined(CONFIG_MMU) && defined(CONFIG_TRANSPARENT_HUGEPAGE)
  52 #include <uapi/asm/mman.h>
  53 #include <drm/drm_vma_manager.h>
  54 #endif
  55
  56 /* from BKL pushdown */
  57 DEFINE_MUTEX(drm_global_mutex);
  58
  59 bool drm_dev_needs_global_mutex(struct drm_device *dev)
  60 {
  61         /*
  62          * Legacy drivers rely on all kinds of BKL locking semantics, don't
  63          * bother. They also still need BKL locking for their ioctls, so better
  64          * safe than sorry.
  65          */
  66         if (drm_core_check_feature(dev, DRIVER_LEGACY))
  67                 return true;
  68
  69         /*
  70          * The deprecated ->load callback must be called after the driver is
  71          * already registered. This means such drivers rely on the BKL to make
  72          * sure an open can't proceed until the driver is actually fully set up.
  73          * Similar hilarity holds for the unload callback.
  74          */
  75         if (dev->driver->load || dev->driver->unload)
  76                 return true;
  77
  78         /*
  79          * Drivers with the lastclose callback assume that it's synchronized
  80          * against concurrent opens, which again needs the BKL. The proper fix
  81          * is to use the drm_client infrastructure with proper locking for each
  82          * client.
  83          */
  84         if (dev->driver->lastclose)
  85                 return true;
  86
  87         return false;
  88 }
  89
  90 /**
  91  * DOC: file operations
  92  *
  93  * Drivers must define the file operations structure that forms the DRM
  94  * userspace API entry point, even though most of those operations are
  95  * implemented in the DRM core. The resulting &struct file_operations must be
  96  * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
  97  * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
  98  * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
  99  * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
 100  * that require 32/64 bit compatibility support must provide their own
 101  * &file_operations.compat_ioctl handler that processes private ioctls and calls
 102  * drm_compat_ioctl() for core ioctls.
 103  *
 104  * In addition drm_read() and drm_poll() provide support for DRM events. DRM
 105  * events are a generic and extensible means to send asynchronous events to
 106  * userspace through the file descriptor. They are used to send vblank event and
 107  * page flip completions by the KMS API. But drivers can also use it for their
 108  * own needs, e.g. to signal completion of rendering.
 109  *
 110  * For the driver-side event interface see drm_event_reserve_init() and
 111  * drm_send_event() as the main starting points.
 112  *
 113  * The memory mapping implementation will vary depending on how the driver
 114  * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
 115  * function, modern drivers should use one of the provided memory-manager
 116  * specific implementations. For GEM-based drivers this is drm_gem_mmap(), and
 117  * for drivers which use the CMA GEM helpers it's drm_gem_cma_mmap().
 118  *
 119  * No other file operations are supported by the DRM userspace API. Overall the
 120  * following is an example &file_operations structure::
 121  *
 122  *     static const example_drm_fops = {
 123  *             .owner = THIS_MODULE,
 124  *             .open = drm_open,
 125  *             .release = drm_release,
 126  *             .unlocked_ioctl = drm_ioctl,
 127  *             .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
 128  *             .poll = drm_poll,
 129  *             .read = drm_read,
 130  *             .llseek = no_llseek,
 131  *             .mmap = drm_gem_mmap,
 132  *     };
 133  *
 134  * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
 135  * CMA based drivers there is the DEFINE_DRM_GEM_CMA_FOPS() macro to make this
 136  * simpler.
 137  *
 138  * The driver's &file_operations must be stored in &drm_driver.fops.
 139  *
 140  * For driver-private IOCTL handling see the more detailed discussion in
 141  * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
 142  */
 143
 144 /**
 145  * drm_file_alloc - allocate file context
 146  * @minor: minor to allocate on
 147  *
 148  * This allocates a new DRM file context. It is not linked into any context and
 149  * can be used by the caller freely. Note that the context keeps a pointer to
 150  * @minor, so it must be freed before @minor is.
 151  *
 152  * RETURNS:
 153  * Pointer to newly allocated context, ERR_PTR on failure.
 154  */
 155 struct drm_file *drm_file_alloc(struct drm_minor *minor)
 156 {
 157         struct drm_device *dev = minor->dev;
 158         struct drm_file *file;
 159         int ret;
 160
 161         file = kzalloc(sizeof(*file), GFP_KERNEL);
 162         if (!file)
 163                 return ERR_PTR(-ENOMEM);
 164
 165         file->pid = get_pid(task_pid(current));
 166         file->minor = minor;
 167
 168         /* for compatibility root is always authenticated */
 169         file->authenticated = capable(CAP_SYS_ADMIN);
 170
 171         INIT_LIST_HEAD(&file->lhead);
 172         INIT_LIST_HEAD(&file->fbs);
 173         mutex_init(&file->fbs_lock);
 174         INIT_LIST_HEAD(&file->blobs);
 175         INIT_LIST_HEAD(&file->pending_event_list);
 176         INIT_LIST_HEAD(&file->event_list);
 177         init_waitqueue_head(&file->event_wait);
 178         file->event_space = 4096; /* set aside 4k for event buffer */
 179
 180         mutex_init(&file->event_read_lock);
 181
 182         if (drm_core_check_feature(dev, DRIVER_GEM))
 183                 drm_gem_open(dev, file);
 184
 185         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 186                 drm_syncobj_open(file);
 187
 188         drm_prime_init_file_private(&file->prime);
 189
 190         if (dev->driver->open) {
 191                 ret = dev->driver->open(dev, file);
 192                 if (ret < 0)
 193                         goto out_prime_destroy;
 194         }
 195
 196         return file;
 197
 198 out_prime_destroy:
 199         drm_prime_destroy_file_private(&file->prime);
 200         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 201                 drm_syncobj_release(file);
 202         if (drm_core_check_feature(dev, DRIVER_GEM))
 203                 drm_gem_release(dev, file);
 204         put_pid(file->pid);
 205         kfree(file);
 206
 207         return ERR_PTR(ret);
 208 }
 209
 210 static void drm_events_release(struct drm_file *file_priv)
 211 {
 212         struct drm_device *dev = file_priv->minor->dev;
 213         struct drm_pending_event *e, *et;
 214         unsigned long flags;
 215
 216         spin_lock_irqsave(&dev->event_lock, flags);
 217
 218         /* Unlink pending events */
 219         list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
 220                                  pending_link) {
 221                 list_del(&e->pending_link);
 222                 e->file_priv = NULL;
 223         }
 224
 225         /* Remove unconsumed events */
 226         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 227                 list_del(&e->link);
 228                 kfree(e);
 229         }
 230
 231         spin_unlock_irqrestore(&dev->event_lock, flags);
 232 }
 233
 234 /**
 235  * drm_file_free - free file context
 236  * @file: context to free, or NULL
 237  *
 238  * This destroys and deallocates a DRM file context previously allocated via
 239  * drm_file_alloc(). The caller must make sure to unlink it from any contexts
 240  * before calling this.
 241  *
 242  * If NULL is passed, this is a no-op.
 243  *
 244  * RETURNS:
 245  * 0 on success, or error code on failure.
 246  */
 247 void drm_file_free(struct drm_file *file)
 248 {
 249         struct drm_device *dev;
 250
 251         if (!file)
 252                 return;
 253
 254         dev = file->minor->dev;
 255
 256         DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
 257                   task_pid_nr(current),
 258                   (long)old_encode_dev(file->minor->kdev->devt),
 259                   atomic_read(&dev->open_count));
 260
 261         if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
 262             dev->driver->preclose)
 263                 dev->driver->preclose(dev, file);
 264
 265         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 266                 drm_legacy_lock_release(dev, file->filp);
 267
 268         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 269                 drm_legacy_reclaim_buffers(dev, file);
 270
 271         drm_events_release(file);
 272
 273         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 274                 drm_fb_release(file);
 275                 drm_property_destroy_user_blobs(dev, file);
 276         }
 277
 278         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 279                 drm_syncobj_release(file);
 280
 281         if (drm_core_check_feature(dev, DRIVER_GEM))
 282                 drm_gem_release(dev, file);
 283
 284         drm_legacy_ctxbitmap_flush(dev, file);
 285
 286         if (drm_is_primary_client(file))
 287                 drm_master_release(file);
 288
 289         if (dev->driver->postclose)
 290                 dev->driver->postclose(dev, file);
 291
 292         drm_prime_destroy_file_private(&file->prime);
 293
 294         WARN_ON(!list_empty(&file->event_list));
 295
 296         put_pid(file->pid);
 297         kfree(file);
 298 }
 299
 300 static void drm_close_helper(struct file *filp)
 301 {
 302         struct drm_file *file_priv = filp->private_data;
 303         struct drm_device *dev = file_priv->minor->dev;
 304
 305         mutex_lock(&dev->filelist_mutex);
 306         list_del(&file_priv->lhead);
 307         mutex_unlock(&dev->filelist_mutex);
 308
 309         drm_file_free(file_priv);
 310 }
 311
 312 /*
 313  * Check whether DRI will run on this CPU.
 314  *
 315  * \return non-zero if the DRI will run on this CPU, or zero otherwise.
 316  */
 317 static int drm_cpu_valid(void)
 318 {
 319 #if defined(__sparc__) && !defined(__sparc_v9__)
 320         return 0;               /* No cmpxchg before v9 sparc. */
 321 #endif
 322         return 1;
 323 }
 324
 325 /*
 326  * Called whenever a process opens a drm node
 327  *
 328  * \param filp file pointer.
 329  * \param minor acquired minor-object.
 330  * \return zero on success or a negative number on failure.
 331  *
 332  * Creates and initializes a drm_file structure for the file private data in \p
 333  * filp and add it into the double linked list in \p dev.
 334  */
 335 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
 336 {
 337         struct drm_device *dev = minor->dev;
 338         struct drm_file *priv;
 339         int ret;
 340
 341         if (filp->f_flags & O_EXCL)
 342                 return -EBUSY;  /* No exclusive opens */
 343         if (!drm_cpu_valid())
 344                 return -EINVAL;
 345         if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 346                 return -EINVAL;
 347
 348         DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
 349
 350         priv = drm_file_alloc(minor);
 351         if (IS_ERR(priv))
 352                 return PTR_ERR(priv);
 353
 354         if (drm_is_primary_client(priv)) {
 355                 ret = drm_master_open(priv);
 356                 if (ret) {
 357                         drm_file_free(priv);
 358                         return ret;
 359                 }
 360         }
 361
 362         filp->private_data = priv;
 363         filp->f_mode |= FMODE_UNSIGNED_OFFSET;
 364         priv->filp = filp;
 365
 366         mutex_lock(&dev->filelist_mutex);
 367         list_add(&priv->lhead, &dev->filelist);
 368         mutex_unlock(&dev->filelist_mutex);
 369
 370 #ifdef __alpha__
 371         /*
 372          * Default the hose
 373          */
 374         if (!dev->hose) {
 375                 struct pci_dev *pci_dev;
 376                 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
 377                 if (pci_dev) {
 378                         dev->hose = pci_dev->sysdata;
 379                         pci_dev_put(pci_dev);
 380                 }
 381                 if (!dev->hose) {
 382                         struct pci_bus *b = list_entry(pci_root_buses.next,
 383                                 struct pci_bus, node);
 384                         if (b)
 385                                 dev->hose = b->sysdata;
 386                 }
 387         }
 388 #endif
 389
 390         return 0;
 391 }
 392
 393 /**
 394  * drm_open - open method for DRM file
 395  * @inode: device inode
 396  * @filp: file pointer.
 397  *
 398  * This function must be used by drivers as their &file_operations.open method.
 399  * It looks up the correct DRM device and instantiates all the per-file
 400  * resources for it. It also calls the &drm_driver.open driver callback.
 401  *
 402  * RETURNS:
 403  *
 404  * 0 on success or negative errno value on falure.
 405  */
 406 int drm_open(struct inode *inode, struct file *filp)
 407 {
 408         struct drm_device *dev;
 409         struct drm_minor *minor;
 410         int retcode;
 411         int need_setup = 0;
 412
 413         minor = drm_minor_acquire(iminor(inode));
 414         if (IS_ERR(minor))
 415                 return PTR_ERR(minor);
 416
 417         dev = minor->dev;
 418         if (drm_dev_needs_global_mutex(dev))
 419                 mutex_lock(&drm_global_mutex);
 420
 421         if (!atomic_fetch_inc(&dev->open_count))
 422                 need_setup = 1;
 423
 424         /* share address_space across all char-devs of a single device */
 425         filp->f_mapping = dev->anon_inode->i_mapping;
 426
 427         retcode = drm_open_helper(filp, minor);
 428         if (retcode)
 429                 goto err_undo;
 430         if (need_setup) {
 431                 retcode = drm_legacy_setup(dev);
 432                 if (retcode) {
 433                         drm_close_helper(filp);
 434                         goto err_undo;
 435                 }
 436         }
 437
 438         if (drm_dev_needs_global_mutex(dev))
 439                 mutex_unlock(&drm_global_mutex);
 440
 441         return 0;
 442
 443 err_undo:
 444         atomic_dec(&dev->open_count);
 445         if (drm_dev_needs_global_mutex(dev))
 446                 mutex_unlock(&drm_global_mutex);
 447         drm_minor_release(minor);
 448         return retcode;
 449 }
 450 EXPORT_SYMBOL(drm_open);
 451
 452 void drm_lastclose(struct drm_device * dev)
 453 {
 454         DRM_DEBUG("\n");
 455
 456         if (dev->driver->lastclose)
 457                 dev->driver->lastclose(dev);
 458         DRM_DEBUG("driver lastclose completed\n");
 459
 460         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 461                 drm_legacy_dev_reinit(dev);
 462
 463         drm_client_dev_restore(dev);
 464 }
 465
 466 /**
 467  * drm_release - release method for DRM file
 468  * @inode: device inode
 469  * @filp: file pointer.
 470  *
 471  * This function must be used by drivers as their &file_operations.release
 472  * method. It frees any resources associated with the open file, and calls the
 473  * &drm_driver.postclose driver callback. If this is the last open file for the
 474  * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
 475  *
 476  * RETURNS:
 477  *
 478  * Always succeeds and returns 0.
 479  */
 480 int drm_release(struct inode *inode, struct file *filp)
 481 {
 482         struct drm_file *file_priv = filp->private_data;
 483         struct drm_minor *minor = file_priv->minor;
 484         struct drm_device *dev = minor->dev;
 485
 486         if (drm_dev_needs_global_mutex(dev))
 487                 mutex_lock(&drm_global_mutex);
 488
 489         DRM_DEBUG("open_count = %d\n", atomic_read(&dev->open_count));
 490
 491         drm_close_helper(filp);
 492
 493         if (atomic_dec_and_test(&dev->open_count))
 494                 drm_lastclose(dev);
 495
 496         if (drm_dev_needs_global_mutex(dev))
 497                 mutex_unlock(&drm_global_mutex);
 498
 499         drm_minor_release(minor);
 500
 501         return 0;
 502 }
 503 EXPORT_SYMBOL(drm_release);
 504
 505 /**
 506  * drm_release_noglobal - release method for DRM file
 507  * @inode: device inode
 508  * @filp: file pointer.
 509  *
 510  * This function may be used by drivers as their &file_operations.release
 511  * method. It frees any resources associated with the open file prior to taking
 512  * the drm_global_mutex, which then calls the &drm_driver.postclose driver
 513  * callback. If this is the last open file for the DRM device also proceeds to
 514  * call the &drm_driver.lastclose driver callback.
 515  *
 516  * RETURNS:
 517  *
 518  * Always succeeds and returns 0.
 519  */
 520 int drm_release_noglobal(struct inode *inode, struct file *filp)
 521 {
 522         struct drm_file *file_priv = filp->private_data;
 523         struct drm_minor *minor = file_priv->minor;
 524         struct drm_device *dev = minor->dev;
 525
 526         drm_close_helper(filp);
 527
 528         if (atomic_dec_and_mutex_lock(&dev->open_count, &drm_global_mutex)) {
 529                 drm_lastclose(dev);
 530                 mutex_unlock(&drm_global_mutex);
 531         }
 532
 533         drm_minor_release(minor);
 534
 535         return 0;
 536 }
 537 EXPORT_SYMBOL(drm_release_noglobal);
 538
 539 /**
 540  * drm_read - read method for DRM file
 541  * @filp: file pointer
 542  * @buffer: userspace destination pointer for the read
 543  * @count: count in bytes to read
 544  * @offset: offset to read
 545  *
 546  * This function must be used by drivers as their &file_operations.read
 547  * method iff they use DRM events for asynchronous signalling to userspace.
 548  * Since events are used by the KMS API for vblank and page flip completion this
 549  * means all modern display drivers must use it.
 550  *
 551  * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
 552  * must set the &file_operation.llseek to no_llseek(). Polling support is
 553  * provided by drm_poll().
 554  *
 555  * This function will only ever read a full event. Therefore userspace must
 556  * supply a big enough buffer to fit any event to ensure forward progress. Since
 557  * the maximum event space is currently 4K it's recommended to just use that for
 558  * safety.
 559  *
 560  * RETURNS:
 561  *
 562  * Number of bytes read (always aligned to full events, and can be 0) or a
 563  * negative error code on failure.
 564  */
 565 ssize_t drm_read(struct file *filp, char __user *buffer,
 566                  size_t count, loff_t *offset)
 567 {
 568         struct drm_file *file_priv = filp->private_data;
 569         struct drm_device *dev = file_priv->minor->dev;
 570         ssize_t ret;
 571
 572         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 573         if (ret)
 574                 return ret;
 575
 576         for (;;) {
 577                 struct drm_pending_event *e = NULL;
 578
 579                 spin_lock_irq(&dev->event_lock);
 580                 if (!list_empty(&file_priv->event_list)) {
 581                         e = list_first_entry(&file_priv->event_list,
 582                                         struct drm_pending_event, link);
 583                         file_priv->event_space += e->event->length;
 584                         list_del(&e->link);
 585                 }
 586                 spin_unlock_irq(&dev->event_lock);
 587
 588                 if (e == NULL) {
 589                         if (ret)
 590                                 break;
 591
 592                         if (filp->f_flags & O_NONBLOCK) {
 593                                 ret = -EAGAIN;
 594                                 break;
 595                         }
 596
 597                         mutex_unlock(&file_priv->event_read_lock);
 598                         ret = wait_event_interruptible(file_priv->event_wait,
 599                                                        !list_empty(&file_priv->event_list));
 600                         if (ret >= 0)
 601                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 602                         if (ret)
 603                                 return ret;
 604                 } else {
 605                         unsigned length = e->event->length;
 606
 607                         if (length > count - ret) {
 608 put_back_event:
 609                                 spin_lock_irq(&dev->event_lock);
 610                                 file_priv->event_space -= length;
 611                                 list_add(&e->link, &file_priv->event_list);
 612                                 spin_unlock_irq(&dev->event_lock);
 613                                 wake_up_interruptible_poll(&file_priv->event_wait,
 614                                         EPOLLIN | EPOLLRDNORM);
 615                                 break;
 616                         }
 617
 618                         if (copy_to_user(buffer + ret, e->event, length)) {
 619                                 if (ret == 0)
 620                                         ret = -EFAULT;
 621                                 goto put_back_event;
 622                         }
 623
 624                         ret += length;
 625                         kfree(e);
 626                 }
 627         }
 628         mutex_unlock(&file_priv->event_read_lock);
 629
 630         return ret;
 631 }
 632 EXPORT_SYMBOL(drm_read);
 633
 634 /**
 635  * drm_poll - poll method for DRM file
 636  * @filp: file pointer
 637  * @wait: poll waiter table
 638  *
 639  * This function must be used by drivers as their &file_operations.read method
 640  * iff they use DRM events for asynchronous signalling to userspace.  Since
 641  * events are used by the KMS API for vblank and page flip completion this means
 642  * all modern display drivers must use it.
 643  *
 644  * See also drm_read().
 645  *
 646  * RETURNS:
 647  *
 648  * Mask of POLL flags indicating the current status of the file.
 649  */
 650 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
 651 {
 652         struct drm_file *file_priv = filp->private_data;
 653         __poll_t mask = 0;
 654
 655         poll_wait(filp, &file_priv->event_wait, wait);
 656
 657         if (!list_empty(&file_priv->event_list))
 658                 mask |= EPOLLIN | EPOLLRDNORM;
 659
 660         return mask;
 661 }
 662 EXPORT_SYMBOL(drm_poll);
 663
 664 /**
 665  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 666  * @dev: DRM device
 667  * @file_priv: DRM file private data
 668  * @p: tracking structure for the pending event
 669  * @e: actual event data to deliver to userspace
 670  *
 671  * This function prepares the passed in event for eventual delivery. If the event
 672  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 673  * anything) then the even must be cancelled and freed using
 674  * drm_event_cancel_free(). Successfully initialized events should be sent out
 675  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 676  * asynchronous event to userspace.
 677  *
 678  * If callers embedded @p into a larger structure it must be allocated with
 679  * kmalloc and @p must be the first member element.
 680  *
 681  * This is the locked version of drm_event_reserve_init() for callers which
 682  * already hold &drm_device.event_lock.
 683  *
 684  * RETURNS:
 685  *
 686  * 0 on success or a negative error code on failure.
 687  */
 688 int drm_event_reserve_init_locked(struct drm_device *dev,
 689                                   struct drm_file *file_priv,
 690                                   struct drm_pending_event *p,
 691                                   struct drm_event *e)
 692 {
 693         if (file_priv->event_space < e->length)
 694                 return -ENOMEM;
 695
 696         file_priv->event_space -= e->length;
 697
 698         p->event = e;
 699         list_add(&p->pending_link, &file_priv->pending_event_list);
 700         p->file_priv = file_priv;
 701
 702         return 0;
 703 }
 704 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 705
 706 /**
 707  * drm_event_reserve_init - init a DRM event and reserve space for it
 708  * @dev: DRM device
 709  * @file_priv: DRM file private data
 710  * @p: tracking structure for the pending event
 711  * @e: actual event data to deliver to userspace
 712  *
 713  * This function prepares the passed in event for eventual delivery. If the event
 714  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 715  * anything) then the even must be cancelled and freed using
 716  * drm_event_cancel_free(). Successfully initialized events should be sent out
 717  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 718  * asynchronous event to userspace.
 719  *
 720  * If callers embedded @p into a larger structure it must be allocated with
 721  * kmalloc and @p must be the first member element.
 722  *
 723  * Callers which already hold &drm_device.event_lock should use
 724  * drm_event_reserve_init_locked() instead.
 725  *
 726  * RETURNS:
 727  *
 728  * 0 on success or a negative error code on failure.
 729  */
 730 int drm_event_reserve_init(struct drm_device *dev,
 731                            struct drm_file *file_priv,
 732                            struct drm_pending_event *p,
 733                            struct drm_event *e)
 734 {
 735         unsigned long flags;
 736         int ret;
 737
 738         spin_lock_irqsave(&dev->event_lock, flags);
 739         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 740         spin_unlock_irqrestore(&dev->event_lock, flags);
 741
 742         return ret;
 743 }
 744 EXPORT_SYMBOL(drm_event_reserve_init);
 745
 746 /**
 747  * drm_event_cancel_free - free a DRM event and release its space
 748  * @dev: DRM device
 749  * @p: tracking structure for the pending event
 750  *
 751  * This function frees the event @p initialized with drm_event_reserve_init()
 752  * and releases any allocated space. It is used to cancel an event when the
 753  * nonblocking operation could not be submitted and needed to be aborted.
 754  */
 755 void drm_event_cancel_free(struct drm_device *dev,
 756                            struct drm_pending_event *p)
 757 {
 758         unsigned long flags;
 759         spin_lock_irqsave(&dev->event_lock, flags);
 760         if (p->file_priv) {
 761                 p->file_priv->event_space += p->event->length;
 762                 list_del(&p->pending_link);
 763         }
 764         spin_unlock_irqrestore(&dev->event_lock, flags);
 765
 766         if (p->fence)
 767                 dma_fence_put(p->fence);
 768
 769         kfree(p);
 770 }
 771 EXPORT_SYMBOL(drm_event_cancel_free);
 772
 773 /**
 774  * drm_send_event_locked - send DRM event to file descriptor
 775  * @dev: DRM device
 776  * @e: DRM event to deliver
 777  *
 778  * This function sends the event @e, initialized with drm_event_reserve_init(),
 779  * to its associated userspace DRM file. Callers must already hold
 780  * &drm_device.event_lock, see drm_send_event() for the unlocked version.
 781  *
 782  * Note that the core will take care of unlinking and disarming events when the
 783  * corresponding DRM file is closed. Drivers need not worry about whether the
 784  * DRM file for this event still exists and can call this function upon
 785  * completion of the asynchronous work unconditionally.
 786  */
 787 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 788 {
 789         assert_spin_locked(&dev->event_lock);
 790
 791         if (e->completion) {
 792                 complete_all(e->completion);
 793                 e->completion_release(e->completion);
 794                 e->completion = NULL;
 795         }
 796
 797         if (e->fence) {
 798                 dma_fence_signal(e->fence);
 799                 dma_fence_put(e->fence);
 800         }
 801
 802         if (!e->file_priv) {
 803                 kfree(e);
 804                 return;
 805         }
 806
 807         list_del(&e->pending_link);
 808         list_add_tail(&e->link,
 809                       &e->file_priv->event_list);
 810         wake_up_interruptible_poll(&e->file_priv->event_wait,
 811                 EPOLLIN | EPOLLRDNORM);
 812 }
 813 EXPORT_SYMBOL(drm_send_event_locked);
 814
 815 /**
 816  * drm_send_event - send DRM event to file descriptor
 817  * @dev: DRM device
 818  * @e: DRM event to deliver
 819  *
 820  * This function sends the event @e, initialized with drm_event_reserve_init(),
 821  * to its associated userspace DRM file. This function acquires
 822  * &drm_device.event_lock, see drm_send_event_locked() for callers which already
 823  * hold this lock.
 824  *
 825  * Note that the core will take care of unlinking and disarming events when the
 826  * corresponding DRM file is closed. Drivers need not worry about whether the
 827  * DRM file for this event still exists and can call this function upon
 828  * completion of the asynchronous work unconditionally.
 829  */
 830 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 831 {
 832         unsigned long irqflags;
 833
 834         spin_lock_irqsave(&dev->event_lock, irqflags);
 835         drm_send_event_locked(dev, e);
 836         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 837 }
 838 EXPORT_SYMBOL(drm_send_event);
 839
 840 /**
 841  * mock_drm_getfile - Create a new struct file for the drm device
 842  * @minor: drm minor to wrap (e.g. #drm_device.primary)
 843  * @flags: file creation mode (O_RDWR etc)
 844  *
 845  * This create a new struct file that wraps a DRM file context around a
 846  * DRM minor. This mimicks userspace opening e.g. /dev/dri/card0, but without
 847  * invoking userspace. The struct file may be operated on using its f_op
 848  * (the drm_device.driver.fops) to mimick userspace operations, or be supplied
 849  * to userspace facing functions as an internal/anonymous client.
 850  *
 851  * RETURNS:
 852  * Pointer to newly created struct file, ERR_PTR on failure.
 853  */
 854 struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags)
 855 {
 856         struct drm_device *dev = minor->dev;
 857         struct drm_file *priv;
 858         struct file *file;
 859
 860         priv = drm_file_alloc(minor);
 861         if (IS_ERR(priv))
 862                 return ERR_CAST(priv);
 863
 864         file = anon_inode_getfile("drm", dev->driver->fops, priv, flags);
 865         if (IS_ERR(file)) {
 866                 drm_file_free(priv);
 867                 return file;
 868         }
 869
 870         /* Everyone shares a single global address space */
 871         file->f_mapping = dev->anon_inode->i_mapping;
 872
 873         drm_dev_get(dev);
 874         priv->filp = file;
 875
 876         return file;
 877 }
 878 EXPORT_SYMBOL_FOR_TESTS_ONLY(mock_drm_getfile);
 879
 880 #ifdef CONFIG_MMU
 881 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 882 /*
 883  * drm_addr_inflate() attempts to construct an aligned area by inflating
 884  * the area size and skipping the unaligned start of the area.
 885  * adapted from shmem_get_unmapped_area()
 886  */
 887 static unsigned long drm_addr_inflate(unsigned long addr,
 888                                       unsigned long len,
 889                                       unsigned long pgoff,
 890                                       unsigned long flags,
 891                                       unsigned long huge_size)
 892 {
 893         unsigned long offset, inflated_len;
 894         unsigned long inflated_addr;
 895         unsigned long inflated_offset;
 896
 897         offset = (pgoff << PAGE_SHIFT) & (huge_size - 1);
 898         if (offset && offset + len < 2 * huge_size)
 899                 return addr;
 900         if ((addr & (huge_size - 1)) == offset)
 901                 return addr;
 902
 903         inflated_len = len + huge_size - PAGE_SIZE;
 904         if (inflated_len > TASK_SIZE)
 905                 return addr;
 906         if (inflated_len < len)
 907                 return addr;
 908
 909         inflated_addr = current->mm->get_unmapped_area(NULL, 0, inflated_len,
 910                                                        0, flags);
 911         if (IS_ERR_VALUE(inflated_addr))
 912                 return addr;
 913         if (inflated_addr & ~PAGE_MASK)
 914                 return addr;
 915
 916         inflated_offset = inflated_addr & (huge_size - 1);
 917         inflated_addr += offset - inflated_offset;
 918         if (inflated_offset > offset)
 919                 inflated_addr += huge_size;
 920
 921         if (inflated_addr > TASK_SIZE - len)
 922                 return addr;
 923
 924         return inflated_addr;
 925 }
 926
 927 /**
 928  * drm_get_unmapped_area() - Get an unused user-space virtual memory area
 929  * suitable for huge page table entries.
 930  * @file: The struct file representing the address space being mmap()'d.
 931  * @uaddr: Start address suggested by user-space.
 932  * @len: Length of the area.
 933  * @pgoff: The page offset into the address space.
 934  * @flags: mmap flags
 935  * @mgr: The address space manager used by the drm driver. This argument can
 936  * probably be removed at some point when all drivers use the same
 937  * address space manager.
 938  *
 939  * This function attempts to find an unused user-space virtual memory area
 940  * that can accommodate the size we want to map, and that is properly
 941  * aligned to facilitate huge page table entries matching actual
 942  * huge pages or huge page aligned memory in buffer objects. Buffer objects
 943  * are assumed to start at huge page boundary pfns (io memory) or be
 944  * populated by huge pages aligned to the start of the buffer object
 945  * (system- or coherent memory). Adapted from shmem_get_unmapped_area.
 946  *
 947  * Return: aligned user-space address.
 948  */
 949 unsigned long drm_get_unmapped_area(struct file *file,
 950                                     unsigned long uaddr, unsigned long len,
 951                                     unsigned long pgoff, unsigned long flags,
 952                                     struct drm_vma_offset_manager *mgr)
 953 {
 954         unsigned long addr;
 955         unsigned long inflated_addr;
 956         struct drm_vma_offset_node *node;
 957
 958         if (len > TASK_SIZE)
 959                 return -ENOMEM;
 960
 961         /*
 962          * @pgoff is the file page-offset the huge page boundaries of
 963          * which typically aligns to physical address huge page boundaries.
 964          * That's not true for DRM, however, where physical address huge
 965          * page boundaries instead are aligned with the offset from
 966          * buffer object start. So adjust @pgoff to be the offset from
 967          * buffer object start.
 968          */
 969         drm_vma_offset_lock_lookup(mgr);
 970         node = drm_vma_offset_lookup_locked(mgr, pgoff, 1);
 971         if (node)
 972                 pgoff -= node->vm_node.start;
 973         drm_vma_offset_unlock_lookup(mgr);
 974
 975         addr = current->mm->get_unmapped_area(file, uaddr, len, pgoff, flags);
 976         if (IS_ERR_VALUE(addr))
 977                 return addr;
 978         if (addr & ~PAGE_MASK)
 979                 return addr;
 980         if (addr > TASK_SIZE - len)
 981                 return addr;
 982
 983         if (len < HPAGE_PMD_SIZE)
 984                 return addr;
 985         if (flags & MAP_FIXED)
 986                 return addr;
 987         /*
 988          * Our priority is to support MAP_SHARED mapped hugely;
 989          * and support MAP_PRIVATE mapped hugely too, until it is COWed.
 990          * But if caller specified an address hint, respect that as before.
 991          */
 992         if (uaddr)
 993                 return addr;
 994
 995         inflated_addr = drm_addr_inflate(addr, len, pgoff, flags,
 996                                          HPAGE_PMD_SIZE);
 997
 998         if (IS_ENABLED(CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD) &&
 999             len >= HPAGE_PUD_SIZE)
1000                 inflated_addr = drm_addr_inflate(inflated_addr, len, pgoff,
1001                                                  flags, HPAGE_PUD_SIZE);
1002         return inflated_addr;
1003 }
1004 #else /* CONFIG_TRANSPARENT_HUGEPAGE */
1005 unsigned long drm_get_unmapped_area(struct file *file,
1006                                     unsigned long uaddr, unsigned long len,
1007                                     unsigned long pgoff, unsigned long flags,
1008                                     struct drm_vma_offset_manager *mgr)
1009 {
1010         return current->mm->get_unmapped_area(file, uaddr, len, pgoff, flags);
1011 }
1012 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
1013 EXPORT_SYMBOL_GPL(drm_get_unmapped_area);
1014 #endif /* CONFIG_MMU */