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().
 117  *
 118  * No other file operations are supported by the DRM userspace API. Overall the
 119  * following is an example &file_operations structure::
 120  *
 121  *     static const example_drm_fops = {
 122  *             .owner = THIS_MODULE,
 123  *             .open = drm_open,
 124  *             .release = drm_release,
 125  *             .unlocked_ioctl = drm_ioctl,
 126  *             .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
 127  *             .poll = drm_poll,
 128  *             .read = drm_read,
 129  *             .llseek = no_llseek,
 130  *             .mmap = drm_gem_mmap,
 131  *     };
 132  *
 133  * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
 134  * CMA based drivers there is the DEFINE_DRM_GEM_CMA_FOPS() macro to make this
 135  * simpler.
 136  *
 137  * The driver's &file_operations must be stored in &drm_driver.fops.
 138  *
 139  * For driver-private IOCTL handling see the more detailed discussion in
 140  * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
 141  */
 142
 143 /**
 144  * drm_file_alloc - allocate file context
 145  * @minor: minor to allocate on
 146  *
 147  * This allocates a new DRM file context. It is not linked into any context and
 148  * can be used by the caller freely. Note that the context keeps a pointer to
 149  * @minor, so it must be freed before @minor is.
 150  *
 151  * RETURNS:
 152  * Pointer to newly allocated context, ERR_PTR on failure.
 153  */
 154 struct drm_file *drm_file_alloc(struct drm_minor *minor)
 155 {
 156         struct drm_device *dev = minor->dev;
 157         struct drm_file *file;
 158         int ret;
 159
 160         file = kzalloc(sizeof(*file), GFP_KERNEL);
 161         if (!file)
 162                 return ERR_PTR(-ENOMEM);
 163
 164         file->pid = get_pid(task_pid(current));
 165         file->minor = minor;
 166
 167         /* for compatibility root is always authenticated */
 168         file->authenticated = capable(CAP_SYS_ADMIN);
 169
 170         INIT_LIST_HEAD(&file->lhead);
 171         INIT_LIST_HEAD(&file->fbs);
 172         mutex_init(&file->fbs_lock);
 173         INIT_LIST_HEAD(&file->blobs);
 174         INIT_LIST_HEAD(&file->pending_event_list);
 175         INIT_LIST_HEAD(&file->event_list);
 176         init_waitqueue_head(&file->event_wait);
 177         file->event_space = 4096; /* set aside 4k for event buffer */
 178
 179         mutex_init(&file->event_read_lock);
 180
 181         if (drm_core_check_feature(dev, DRIVER_GEM))
 182                 drm_gem_open(dev, file);
 183
 184         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 185                 drm_syncobj_open(file);
 186
 187         drm_prime_init_file_private(&file->prime);
 188
 189         if (dev->driver->open) {
 190                 ret = dev->driver->open(dev, file);
 191                 if (ret < 0)
 192                         goto out_prime_destroy;
 193         }
 194
 195         return file;
 196
 197 out_prime_destroy:
 198         drm_prime_destroy_file_private(&file->prime);
 199         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 200                 drm_syncobj_release(file);
 201         if (drm_core_check_feature(dev, DRIVER_GEM))
 202                 drm_gem_release(dev, file);
 203         put_pid(file->pid);
 204         kfree(file);
 205
 206         return ERR_PTR(ret);
 207 }
 208
 209 static void drm_events_release(struct drm_file *file_priv)
 210 {
 211         struct drm_device *dev = file_priv->minor->dev;
 212         struct drm_pending_event *e, *et;
 213         unsigned long flags;
 214
 215         spin_lock_irqsave(&dev->event_lock, flags);
 216
 217         /* Unlink pending events */
 218         list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
 219                                  pending_link) {
 220                 list_del(&e->pending_link);
 221                 e->file_priv = NULL;
 222         }
 223
 224         /* Remove unconsumed events */
 225         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 226                 list_del(&e->link);
 227                 kfree(e);
 228         }
 229
 230         spin_unlock_irqrestore(&dev->event_lock, flags);
 231 }
 232
 233 /**
 234  * drm_file_free - free file context
 235  * @file: context to free, or NULL
 236  *
 237  * This destroys and deallocates a DRM file context previously allocated via
 238  * drm_file_alloc(). The caller must make sure to unlink it from any contexts
 239  * before calling this.
 240  *
 241  * If NULL is passed, this is a no-op.
 242  */
 243 void drm_file_free(struct drm_file *file)
 244 {
 245         struct drm_device *dev;
 246
 247         if (!file)
 248                 return;
 249
 250         dev = file->minor->dev;
 251
 252         DRM_DEBUG("comm=\"%s\", pid=%d, dev=0x%lx, open_count=%d\n",
 253                   current->comm, task_pid_nr(current),
 254                   (long)old_encode_dev(file->minor->kdev->devt),
 255                   atomic_read(&dev->open_count));
 256
 257 #ifdef CONFIG_DRM_LEGACY
 258         if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
 259             dev->driver->preclose)
 260                 dev->driver->preclose(dev, file);
 261 #endif
 262
 263         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 264                 drm_legacy_lock_release(dev, file->filp);
 265
 266         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 267                 drm_legacy_reclaim_buffers(dev, file);
 268
 269         drm_events_release(file);
 270
 271         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 272                 drm_fb_release(file);
 273                 drm_property_destroy_user_blobs(dev, file);
 274         }
 275
 276         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 277                 drm_syncobj_release(file);
 278
 279         if (drm_core_check_feature(dev, DRIVER_GEM))
 280                 drm_gem_release(dev, file);
 281
 282         drm_legacy_ctxbitmap_flush(dev, file);
 283
 284         if (drm_is_primary_client(file))
 285                 drm_master_release(file);
 286
 287         if (dev->driver->postclose)
 288                 dev->driver->postclose(dev, file);
 289
 290         drm_prime_destroy_file_private(&file->prime);
 291
 292         WARN_ON(!list_empty(&file->event_list));
 293
 294         put_pid(file->pid);
 295         kfree(file);
 296 }
 297
 298 static void drm_close_helper(struct file *filp)
 299 {
 300         struct drm_file *file_priv = filp->private_data;
 301         struct drm_device *dev = file_priv->minor->dev;
 302
 303         mutex_lock(&dev->filelist_mutex);
 304         list_del(&file_priv->lhead);
 305         mutex_unlock(&dev->filelist_mutex);
 306
 307         drm_file_free(file_priv);
 308 }
 309
 310 /*
 311  * Check whether DRI will run on this CPU.
 312  *
 313  * \return non-zero if the DRI will run on this CPU, or zero otherwise.
 314  */
 315 static int drm_cpu_valid(void)
 316 {
 317 #if defined(__sparc__) && !defined(__sparc_v9__)
 318         return 0;               /* No cmpxchg before v9 sparc. */
 319 #endif
 320         return 1;
 321 }
 322
 323 /*
 324  * Called whenever a process opens a drm node
 325  *
 326  * \param filp file pointer.
 327  * \param minor acquired minor-object.
 328  * \return zero on success or a negative number on failure.
 329  *
 330  * Creates and initializes a drm_file structure for the file private data in \p
 331  * filp and add it into the double linked list in \p dev.
 332  */
 333 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
 334 {
 335         struct drm_device *dev = minor->dev;
 336         struct drm_file *priv;
 337         int ret;
 338
 339         if (filp->f_flags & O_EXCL)
 340                 return -EBUSY;  /* No exclusive opens */
 341         if (!drm_cpu_valid())
 342                 return -EINVAL;
 343         if (dev->switch_power_state != DRM_SWITCH_POWER_ON &&
 344             dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 345                 return -EINVAL;
 346
 347         DRM_DEBUG("comm=\"%s\", pid=%d, minor=%d\n", current->comm,
 348                   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 CONFIG_DRM_LEGACY
 371 #ifdef __alpha__
 372         /*
 373          * Default the hose
 374          */
 375         if (!dev->hose) {
 376                 struct pci_dev *pci_dev;
 377
 378                 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
 379                 if (pci_dev) {
 380                         dev->hose = pci_dev->sysdata;
 381                         pci_dev_put(pci_dev);
 382                 }
 383                 if (!dev->hose) {
 384                         struct pci_bus *b = list_entry(pci_root_buses.next,
 385                                 struct pci_bus, node);
 386                         if (b)
 387                                 dev->hose = b->sysdata;
 388                 }
 389         }
 390 #endif
 391 #endif
 392
 393         return 0;
 394 }
 395
 396 /**
 397  * drm_open - open method for DRM file
 398  * @inode: device inode
 399  * @filp: file pointer.
 400  *
 401  * This function must be used by drivers as their &file_operations.open method.
 402  * It looks up the correct DRM device and instantiates all the per-file
 403  * resources for it. It also calls the &drm_driver.open driver callback.
 404  *
 405  * RETURNS:
 406  *
 407  * 0 on success or negative errno value on falure.
 408  */
 409 int drm_open(struct inode *inode, struct file *filp)
 410 {
 411         struct drm_device *dev;
 412         struct drm_minor *minor;
 413         int retcode;
 414         int need_setup = 0;
 415
 416         minor = drm_minor_acquire(iminor(inode));
 417         if (IS_ERR(minor))
 418                 return PTR_ERR(minor);
 419
 420         dev = minor->dev;
 421         if (drm_dev_needs_global_mutex(dev))
 422                 mutex_lock(&drm_global_mutex);
 423
 424         if (!atomic_fetch_inc(&dev->open_count))
 425                 need_setup = 1;
 426
 427         /* share address_space across all char-devs of a single device */
 428         filp->f_mapping = dev->anon_inode->i_mapping;
 429
 430         retcode = drm_open_helper(filp, minor);
 431         if (retcode)
 432                 goto err_undo;
 433         if (need_setup) {
 434                 retcode = drm_legacy_setup(dev);
 435                 if (retcode) {
 436                         drm_close_helper(filp);
 437                         goto err_undo;
 438                 }
 439         }
 440
 441         if (drm_dev_needs_global_mutex(dev))
 442                 mutex_unlock(&drm_global_mutex);
 443
 444         return 0;
 445
 446 err_undo:
 447         atomic_dec(&dev->open_count);
 448         if (drm_dev_needs_global_mutex(dev))
 449                 mutex_unlock(&drm_global_mutex);
 450         drm_minor_release(minor);
 451         return retcode;
 452 }
 453 EXPORT_SYMBOL(drm_open);
 454
 455 void drm_lastclose(struct drm_device * dev)
 456 {
 457         DRM_DEBUG("\n");
 458
 459         if (dev->driver->lastclose)
 460                 dev->driver->lastclose(dev);
 461         DRM_DEBUG("driver lastclose completed\n");
 462
 463         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 464                 drm_legacy_dev_reinit(dev);
 465
 466         drm_client_dev_restore(dev);
 467 }
 468
 469 /**
 470  * drm_release - release method for DRM file
 471  * @inode: device inode
 472  * @filp: file pointer.
 473  *
 474  * This function must be used by drivers as their &file_operations.release
 475  * method. It frees any resources associated with the open file, and calls the
 476  * &drm_driver.postclose driver callback. If this is the last open file for the
 477  * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
 478  *
 479  * RETURNS:
 480  *
 481  * Always succeeds and returns 0.
 482  */
 483 int drm_release(struct inode *inode, struct file *filp)
 484 {
 485         struct drm_file *file_priv = filp->private_data;
 486         struct drm_minor *minor = file_priv->minor;
 487         struct drm_device *dev = minor->dev;
 488
 489         if (drm_dev_needs_global_mutex(dev))
 490                 mutex_lock(&drm_global_mutex);
 491
 492         DRM_DEBUG("open_count = %d\n", atomic_read(&dev->open_count));
 493
 494         drm_close_helper(filp);
 495
 496         if (atomic_dec_and_test(&dev->open_count))
 497                 drm_lastclose(dev);
 498
 499         if (drm_dev_needs_global_mutex(dev))
 500                 mutex_unlock(&drm_global_mutex);
 501
 502         drm_minor_release(minor);
 503
 504         return 0;
 505 }
 506 EXPORT_SYMBOL(drm_release);
 507
 508 /**
 509  * drm_release_noglobal - release method for DRM file
 510  * @inode: device inode
 511  * @filp: file pointer.
 512  *
 513  * This function may be used by drivers as their &file_operations.release
 514  * method. It frees any resources associated with the open file prior to taking
 515  * the drm_global_mutex, which then calls the &drm_driver.postclose driver
 516  * callback. If this is the last open file for the DRM device also proceeds to
 517  * call the &drm_driver.lastclose driver callback.
 518  *
 519  * RETURNS:
 520  *
 521  * Always succeeds and returns 0.
 522  */
 523 int drm_release_noglobal(struct inode *inode, struct file *filp)
 524 {
 525         struct drm_file *file_priv = filp->private_data;
 526         struct drm_minor *minor = file_priv->minor;
 527         struct drm_device *dev = minor->dev;
 528
 529         drm_close_helper(filp);
 530
 531         if (atomic_dec_and_mutex_lock(&dev->open_count, &drm_global_mutex)) {
 532                 drm_lastclose(dev);
 533                 mutex_unlock(&drm_global_mutex);
 534         }
 535
 536         drm_minor_release(minor);
 537
 538         return 0;
 539 }
 540 EXPORT_SYMBOL(drm_release_noglobal);
 541
 542 /**
 543  * drm_read - read method for DRM file
 544  * @filp: file pointer
 545  * @buffer: userspace destination pointer for the read
 546  * @count: count in bytes to read
 547  * @offset: offset to read
 548  *
 549  * This function must be used by drivers as their &file_operations.read
 550  * method iff they use DRM events for asynchronous signalling to userspace.
 551  * Since events are used by the KMS API for vblank and page flip completion this
 552  * means all modern display drivers must use it.
 553  *
 554  * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
 555  * must set the &file_operation.llseek to no_llseek(). Polling support is
 556  * provided by drm_poll().
 557  *
 558  * This function will only ever read a full event. Therefore userspace must
 559  * supply a big enough buffer to fit any event to ensure forward progress. Since
 560  * the maximum event space is currently 4K it's recommended to just use that for
 561  * safety.
 562  *
 563  * RETURNS:
 564  *
 565  * Number of bytes read (always aligned to full events, and can be 0) or a
 566  * negative error code on failure.
 567  */
 568 ssize_t drm_read(struct file *filp, char __user *buffer,
 569                  size_t count, loff_t *offset)
 570 {
 571         struct drm_file *file_priv = filp->private_data;
 572         struct drm_device *dev = file_priv->minor->dev;
 573         ssize_t ret;
 574
 575         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 576         if (ret)
 577                 return ret;
 578
 579         for (;;) {
 580                 struct drm_pending_event *e = NULL;
 581
 582                 spin_lock_irq(&dev->event_lock);
 583                 if (!list_empty(&file_priv->event_list)) {
 584                         e = list_first_entry(&file_priv->event_list,
 585                                         struct drm_pending_event, link);
 586                         file_priv->event_space += e->event->length;
 587                         list_del(&e->link);
 588                 }
 589                 spin_unlock_irq(&dev->event_lock);
 590
 591                 if (e == NULL) {
 592                         if (ret)
 593                                 break;
 594
 595                         if (filp->f_flags & O_NONBLOCK) {
 596                                 ret = -EAGAIN;
 597                                 break;
 598                         }
 599
 600                         mutex_unlock(&file_priv->event_read_lock);
 601                         ret = wait_event_interruptible(file_priv->event_wait,
 602                                                        !list_empty(&file_priv->event_list));
 603                         if (ret >= 0)
 604                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 605                         if (ret)
 606                                 return ret;
 607                 } else {
 608                         unsigned length = e->event->length;
 609
 610                         if (length > count - ret) {
 611 put_back_event:
 612                                 spin_lock_irq(&dev->event_lock);
 613                                 file_priv->event_space -= length;
 614                                 list_add(&e->link, &file_priv->event_list);
 615                                 spin_unlock_irq(&dev->event_lock);
 616                                 wake_up_interruptible_poll(&file_priv->event_wait,
 617                                         EPOLLIN | EPOLLRDNORM);
 618                                 break;
 619                         }
 620
 621                         if (copy_to_user(buffer + ret, e->event, length)) {
 622                                 if (ret == 0)
 623                                         ret = -EFAULT;
 624                                 goto put_back_event;
 625                         }
 626
 627                         ret += length;
 628                         kfree(e);
 629                 }
 630         }
 631         mutex_unlock(&file_priv->event_read_lock);
 632
 633         return ret;
 634 }
 635 EXPORT_SYMBOL(drm_read);
 636
 637 /**
 638  * drm_poll - poll method for DRM file
 639  * @filp: file pointer
 640  * @wait: poll waiter table
 641  *
 642  * This function must be used by drivers as their &file_operations.read method
 643  * iff they use DRM events for asynchronous signalling to userspace.  Since
 644  * events are used by the KMS API for vblank and page flip completion this means
 645  * all modern display drivers must use it.
 646  *
 647  * See also drm_read().
 648  *
 649  * RETURNS:
 650  *
 651  * Mask of POLL flags indicating the current status of the file.
 652  */
 653 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
 654 {
 655         struct drm_file *file_priv = filp->private_data;
 656         __poll_t mask = 0;
 657
 658         poll_wait(filp, &file_priv->event_wait, wait);
 659
 660         if (!list_empty(&file_priv->event_list))
 661                 mask |= EPOLLIN | EPOLLRDNORM;
 662
 663         return mask;
 664 }
 665 EXPORT_SYMBOL(drm_poll);
 666
 667 /**
 668  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 669  * @dev: DRM device
 670  * @file_priv: DRM file private data
 671  * @p: tracking structure for the pending event
 672  * @e: actual event data to deliver to userspace
 673  *
 674  * This function prepares the passed in event for eventual delivery. If the event
 675  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 676  * anything) then the even must be cancelled and freed using
 677  * drm_event_cancel_free(). Successfully initialized events should be sent out
 678  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 679  * asynchronous event to userspace.
 680  *
 681  * If callers embedded @p into a larger structure it must be allocated with
 682  * kmalloc and @p must be the first member element.
 683  *
 684  * This is the locked version of drm_event_reserve_init() for callers which
 685  * already hold &drm_device.event_lock.
 686  *
 687  * RETURNS:
 688  *
 689  * 0 on success or a negative error code on failure.
 690  */
 691 int drm_event_reserve_init_locked(struct drm_device *dev,
 692                                   struct drm_file *file_priv,
 693                                   struct drm_pending_event *p,
 694                                   struct drm_event *e)
 695 {
 696         if (file_priv->event_space < e->length)
 697                 return -ENOMEM;
 698
 699         file_priv->event_space -= e->length;
 700
 701         p->event = e;
 702         list_add(&p->pending_link, &file_priv->pending_event_list);
 703         p->file_priv = file_priv;
 704
 705         return 0;
 706 }
 707 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 708
 709 /**
 710  * drm_event_reserve_init - init a DRM event and reserve space for it
 711  * @dev: DRM device
 712  * @file_priv: DRM file private data
 713  * @p: tracking structure for the pending event
 714  * @e: actual event data to deliver to userspace
 715  *
 716  * This function prepares the passed in event for eventual delivery. If the event
 717  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 718  * anything) then the even must be cancelled and freed using
 719  * drm_event_cancel_free(). Successfully initialized events should be sent out
 720  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 721  * asynchronous event to userspace.
 722  *
 723  * If callers embedded @p into a larger structure it must be allocated with
 724  * kmalloc and @p must be the first member element.
 725  *
 726  * Callers which already hold &drm_device.event_lock should use
 727  * drm_event_reserve_init_locked() instead.
 728  *
 729  * RETURNS:
 730  *
 731  * 0 on success or a negative error code on failure.
 732  */
 733 int drm_event_reserve_init(struct drm_device *dev,
 734                            struct drm_file *file_priv,
 735                            struct drm_pending_event *p,
 736                            struct drm_event *e)
 737 {
 738         unsigned long flags;
 739         int ret;
 740
 741         spin_lock_irqsave(&dev->event_lock, flags);
 742         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 743         spin_unlock_irqrestore(&dev->event_lock, flags);
 744
 745         return ret;
 746 }
 747 EXPORT_SYMBOL(drm_event_reserve_init);
 748
 749 /**
 750  * drm_event_cancel_free - free a DRM event and release its space
 751  * @dev: DRM device
 752  * @p: tracking structure for the pending event
 753  *
 754  * This function frees the event @p initialized with drm_event_reserve_init()
 755  * and releases any allocated space. It is used to cancel an event when the
 756  * nonblocking operation could not be submitted and needed to be aborted.
 757  */
 758 void drm_event_cancel_free(struct drm_device *dev,
 759                            struct drm_pending_event *p)
 760 {
 761         unsigned long flags;
 762
 763         spin_lock_irqsave(&dev->event_lock, flags);
 764         if (p->file_priv) {
 765                 p->file_priv->event_space += p->event->length;
 766                 list_del(&p->pending_link);
 767         }
 768         spin_unlock_irqrestore(&dev->event_lock, flags);
 769
 770         if (p->fence)
 771                 dma_fence_put(p->fence);
 772
 773         kfree(p);
 774 }
 775 EXPORT_SYMBOL(drm_event_cancel_free);
 776
 777 /**
 778  * drm_send_event_helper - send DRM event to file descriptor
 779  * @dev: DRM device
 780  * @e: DRM event to deliver
 781  * @timestamp: timestamp to set for the fence event in kernel's CLOCK_MONOTONIC
 782  * time domain
 783  *
 784  * This helper function sends the event @e, initialized with
 785  * drm_event_reserve_init(), to its associated userspace DRM file.
 786  * The timestamp variant of dma_fence_signal is used when the caller
 787  * sends a valid timestamp.
 788  */
 789 void drm_send_event_helper(struct drm_device *dev,
 790                            struct drm_pending_event *e, ktime_t timestamp)
 791 {
 792         assert_spin_locked(&dev->event_lock);
 793
 794         if (e->completion) {
 795                 complete_all(e->completion);
 796                 e->completion_release(e->completion);
 797                 e->completion = NULL;
 798         }
 799
 800         if (e->fence) {
 801                 if (timestamp)
 802                         dma_fence_signal_timestamp(e->fence, timestamp);
 803                 else
 804                         dma_fence_signal(e->fence);
 805                 dma_fence_put(e->fence);
 806         }
 807
 808         if (!e->file_priv) {
 809                 kfree(e);
 810                 return;
 811         }
 812
 813         list_del(&e->pending_link);
 814         list_add_tail(&e->link,
 815                       &e->file_priv->event_list);
 816         wake_up_interruptible_poll(&e->file_priv->event_wait,
 817                 EPOLLIN | EPOLLRDNORM);
 818 }
 819
 820 /**
 821  * drm_send_event_timestamp_locked - send DRM event to file descriptor
 822  * @dev: DRM device
 823  * @e: DRM event to deliver
 824  * @timestamp: timestamp to set for the fence event in kernel's CLOCK_MONOTONIC
 825  * time domain
 826  *
 827  * This function sends the event @e, initialized with drm_event_reserve_init(),
 828  * to its associated userspace DRM file. Callers must already hold
 829  * &drm_device.event_lock.
 830  *
 831  * Note that the core will take care of unlinking and disarming events when the
 832  * corresponding DRM file is closed. Drivers need not worry about whether the
 833  * DRM file for this event still exists and can call this function upon
 834  * completion of the asynchronous work unconditionally.
 835  */
 836 void drm_send_event_timestamp_locked(struct drm_device *dev,
 837                                      struct drm_pending_event *e, ktime_t timestamp)
 838 {
 839         drm_send_event_helper(dev, e, timestamp);
 840 }
 841 EXPORT_SYMBOL(drm_send_event_timestamp_locked);
 842
 843 /**
 844  * drm_send_event_locked - send DRM event to file descriptor
 845  * @dev: DRM device
 846  * @e: DRM event to deliver
 847  *
 848  * This function sends the event @e, initialized with drm_event_reserve_init(),
 849  * to its associated userspace DRM file. Callers must already hold
 850  * &drm_device.event_lock, see drm_send_event() for the unlocked version.
 851  *
 852  * Note that the core will take care of unlinking and disarming events when the
 853  * corresponding DRM file is closed. Drivers need not worry about whether the
 854  * DRM file for this event still exists and can call this function upon
 855  * completion of the asynchronous work unconditionally.
 856  */
 857 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 858 {
 859         drm_send_event_helper(dev, e, 0);
 860 }
 861 EXPORT_SYMBOL(drm_send_event_locked);
 862
 863 /**
 864  * drm_send_event - send DRM event to file descriptor
 865  * @dev: DRM device
 866  * @e: DRM event to deliver
 867  *
 868  * This function sends the event @e, initialized with drm_event_reserve_init(),
 869  * to its associated userspace DRM file. This function acquires
 870  * &drm_device.event_lock, see drm_send_event_locked() for callers which already
 871  * hold this lock.
 872  *
 873  * Note that the core will take care of unlinking and disarming events when the
 874  * corresponding DRM file is closed. Drivers need not worry about whether the
 875  * DRM file for this event still exists and can call this function upon
 876  * completion of the asynchronous work unconditionally.
 877  */
 878 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 879 {
 880         unsigned long irqflags;
 881
 882         spin_lock_irqsave(&dev->event_lock, irqflags);
 883         drm_send_event_helper(dev, e, 0);
 884         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 885 }
 886 EXPORT_SYMBOL(drm_send_event);
 887
 888 /**
 889  * mock_drm_getfile - Create a new struct file for the drm device
 890  * @minor: drm minor to wrap (e.g. #drm_device.primary)
 891  * @flags: file creation mode (O_RDWR etc)
 892  *
 893  * This create a new struct file that wraps a DRM file context around a
 894  * DRM minor. This mimicks userspace opening e.g. /dev/dri/card0, but without
 895  * invoking userspace. The struct file may be operated on using its f_op
 896  * (the drm_device.driver.fops) to mimick userspace operations, or be supplied
 897  * to userspace facing functions as an internal/anonymous client.
 898  *
 899  * RETURNS:
 900  * Pointer to newly created struct file, ERR_PTR on failure.
 901  */
 902 struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags)
 903 {
 904         struct drm_device *dev = minor->dev;
 905         struct drm_file *priv;
 906         struct file *file;
 907
 908         priv = drm_file_alloc(minor);
 909         if (IS_ERR(priv))
 910                 return ERR_CAST(priv);
 911
 912         file = anon_inode_getfile("drm", dev->driver->fops, priv, flags);
 913         if (IS_ERR(file)) {
 914                 drm_file_free(priv);
 915                 return file;
 916         }
 917
 918         /* Everyone shares a single global address space */
 919         file->f_mapping = dev->anon_inode->i_mapping;
 920
 921         drm_dev_get(dev);
 922         priv->filp = file;
 923
 924         return file;
 925 }
 926 EXPORT_SYMBOL_FOR_TESTS_ONLY(mock_drm_getfile);
 927
 928 #ifdef CONFIG_MMU
 929 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 930 /*
 931  * drm_addr_inflate() attempts to construct an aligned area by inflating
 932  * the area size and skipping the unaligned start of the area.
 933  * adapted from shmem_get_unmapped_area()
 934  */
 935 static unsigned long drm_addr_inflate(unsigned long addr,
 936                                       unsigned long len,
 937                                       unsigned long pgoff,
 938                                       unsigned long flags,
 939                                       unsigned long huge_size)
 940 {
 941         unsigned long offset, inflated_len;
 942         unsigned long inflated_addr;
 943         unsigned long inflated_offset;
 944
 945         offset = (pgoff << PAGE_SHIFT) & (huge_size - 1);
 946         if (offset && offset + len < 2 * huge_size)
 947                 return addr;
 948         if ((addr & (huge_size - 1)) == offset)
 949                 return addr;
 950
 951         inflated_len = len + huge_size - PAGE_SIZE;
 952         if (inflated_len > TASK_SIZE)
 953                 return addr;
 954         if (inflated_len < len)
 955                 return addr;
 956
 957         inflated_addr = current->mm->get_unmapped_area(NULL, 0, inflated_len,
 958                                                        0, flags);
 959         if (IS_ERR_VALUE(inflated_addr))
 960                 return addr;
 961         if (inflated_addr & ~PAGE_MASK)
 962                 return addr;
 963
 964         inflated_offset = inflated_addr & (huge_size - 1);
 965         inflated_addr += offset - inflated_offset;
 966         if (inflated_offset > offset)
 967                 inflated_addr += huge_size;
 968
 969         if (inflated_addr > TASK_SIZE - len)
 970                 return addr;
 971
 972         return inflated_addr;
 973 }
 974
 975 /**
 976  * drm_get_unmapped_area() - Get an unused user-space virtual memory area
 977  * suitable for huge page table entries.
 978  * @file: The struct file representing the address space being mmap()'d.
 979  * @uaddr: Start address suggested by user-space.
 980  * @len: Length of the area.
 981  * @pgoff: The page offset into the address space.
 982  * @flags: mmap flags
 983  * @mgr: The address space manager used by the drm driver. This argument can
 984  * probably be removed at some point when all drivers use the same
 985  * address space manager.
 986  *
 987  * This function attempts to find an unused user-space virtual memory area
 988  * that can accommodate the size we want to map, and that is properly
 989  * aligned to facilitate huge page table entries matching actual
 990  * huge pages or huge page aligned memory in buffer objects. Buffer objects
 991  * are assumed to start at huge page boundary pfns (io memory) or be
 992  * populated by huge pages aligned to the start of the buffer object
 993  * (system- or coherent memory). Adapted from shmem_get_unmapped_area.
 994  *
 995  * Return: aligned user-space address.
 996  */
 997 unsigned long drm_get_unmapped_area(struct file *file,
 998                                     unsigned long uaddr, unsigned long len,
 999                                     unsigned long pgoff, unsigned long flags,
1000                                     struct drm_vma_offset_manager *mgr)
1001 {
1002         unsigned long addr;
1003         unsigned long inflated_addr;
1004         struct drm_vma_offset_node *node;
1005
1006         if (len > TASK_SIZE)
1007                 return -ENOMEM;
1008
1009         /*
1010          * @pgoff is the file page-offset the huge page boundaries of
1011          * which typically aligns to physical address huge page boundaries.
1012          * That's not true for DRM, however, where physical address huge
1013          * page boundaries instead are aligned with the offset from
1014          * buffer object start. So adjust @pgoff to be the offset from
1015          * buffer object start.
1016          */
1017         drm_vma_offset_lock_lookup(mgr);
1018         node = drm_vma_offset_lookup_locked(mgr, pgoff, 1);
1019         if (node)
1020                 pgoff -= node->vm_node.start;
1021         drm_vma_offset_unlock_lookup(mgr);
1022
1023         addr = current->mm->get_unmapped_area(file, uaddr, len, pgoff, flags);
1024         if (IS_ERR_VALUE(addr))
1025                 return addr;
1026         if (addr & ~PAGE_MASK)
1027                 return addr;
1028         if (addr > TASK_SIZE - len)
1029                 return addr;
1030
1031         if (len < HPAGE_PMD_SIZE)
1032                 return addr;
1033         if (flags & MAP_FIXED)
1034                 return addr;
1035         /*
1036          * Our priority is to support MAP_SHARED mapped hugely;
1037          * and support MAP_PRIVATE mapped hugely too, until it is COWed.
1038          * But if caller specified an address hint, respect that as before.
1039          */
1040         if (uaddr)
1041                 return addr;
1042
1043         inflated_addr = drm_addr_inflate(addr, len, pgoff, flags,
1044                                          HPAGE_PMD_SIZE);
1045
1046         if (IS_ENABLED(CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD) &&
1047             len >= HPAGE_PUD_SIZE)
1048                 inflated_addr = drm_addr_inflate(inflated_addr, len, pgoff,
1049                                                  flags, HPAGE_PUD_SIZE);
1050         return inflated_addr;
1051 }
1052 #else /* CONFIG_TRANSPARENT_HUGEPAGE */
1053 unsigned long drm_get_unmapped_area(struct file *file,
1054                                     unsigned long uaddr, unsigned long len,
1055                                     unsigned long pgoff, unsigned long flags,
1056                                     struct drm_vma_offset_manager *mgr)
1057 {
1058         return current->mm->get_unmapped_area(file, uaddr, len, pgoff, flags);
1059 }
1060 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
1061 EXPORT_SYMBOL_GPL(drm_get_unmapped_area);
1062 #endif /* CONFIG_MMU */