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("comm=\"%s\", pid=%d, dev=0x%lx, open_count=%d\n",
 257                   current->comm, 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 &&
 346             dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 347                 return -EINVAL;
 348
 349         DRM_DEBUG("comm=\"%s\", pid=%d, minor=%d\n", current->comm,
 350                   task_pid_nr(current), minor->index);
 351
 352         priv = drm_file_alloc(minor);
 353         if (IS_ERR(priv))
 354                 return PTR_ERR(priv);
 355
 356         if (drm_is_primary_client(priv)) {
 357                 ret = drm_master_open(priv);
 358                 if (ret) {
 359                         drm_file_free(priv);
 360                         return ret;
 361                 }
 362         }
 363
 364         filp->private_data = priv;
 365         filp->f_mode |= FMODE_UNSIGNED_OFFSET;
 366         priv->filp = filp;
 367
 368         mutex_lock(&dev->filelist_mutex);
 369         list_add(&priv->lhead, &dev->filelist);
 370         mutex_unlock(&dev->filelist_mutex);
 371
 372 #ifdef __alpha__
 373         /*
 374          * Default the hose
 375          */
 376         if (!dev->hose) {
 377                 struct pci_dev *pci_dev;
 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
 392         return 0;
 393 }
 394
 395 /**
 396  * drm_open - open method for DRM file
 397  * @inode: device inode
 398  * @filp: file pointer.
 399  *
 400  * This function must be used by drivers as their &file_operations.open method.
 401  * It looks up the correct DRM device and instantiates all the per-file
 402  * resources for it. It also calls the &drm_driver.open driver callback.
 403  *
 404  * RETURNS:
 405  *
 406  * 0 on success or negative errno value on falure.
 407  */
 408 int drm_open(struct inode *inode, struct file *filp)
 409 {
 410         struct drm_device *dev;
 411         struct drm_minor *minor;
 412         int retcode;
 413         int need_setup = 0;
 414
 415         minor = drm_minor_acquire(iminor(inode));
 416         if (IS_ERR(minor))
 417                 return PTR_ERR(minor);
 418
 419         dev = minor->dev;
 420         if (drm_dev_needs_global_mutex(dev))
 421                 mutex_lock(&drm_global_mutex);
 422
 423         if (!atomic_fetch_inc(&dev->open_count))
 424                 need_setup = 1;
 425
 426         /* share address_space across all char-devs of a single device */
 427         filp->f_mapping = dev->anon_inode->i_mapping;
 428
 429         retcode = drm_open_helper(filp, minor);
 430         if (retcode)
 431                 goto err_undo;
 432         if (need_setup) {
 433                 retcode = drm_legacy_setup(dev);
 434                 if (retcode) {
 435                         drm_close_helper(filp);
 436                         goto err_undo;
 437                 }
 438         }
 439
 440         if (drm_dev_needs_global_mutex(dev))
 441                 mutex_unlock(&drm_global_mutex);
 442
 443         return 0;
 444
 445 err_undo:
 446         atomic_dec(&dev->open_count);
 447         if (drm_dev_needs_global_mutex(dev))
 448                 mutex_unlock(&drm_global_mutex);
 449         drm_minor_release(minor);
 450         return retcode;
 451 }
 452 EXPORT_SYMBOL(drm_open);
 453
 454 void drm_lastclose(struct drm_device * dev)
 455 {
 456         DRM_DEBUG("\n");
 457
 458         if (dev->driver->lastclose)
 459                 dev->driver->lastclose(dev);
 460         DRM_DEBUG("driver lastclose completed\n");
 461
 462         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 463                 drm_legacy_dev_reinit(dev);
 464
 465         drm_client_dev_restore(dev);
 466 }
 467
 468 /**
 469  * drm_release - release method for DRM file
 470  * @inode: device inode
 471  * @filp: file pointer.
 472  *
 473  * This function must be used by drivers as their &file_operations.release
 474  * method. It frees any resources associated with the open file, and calls the
 475  * &drm_driver.postclose driver callback. If this is the last open file for the
 476  * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
 477  *
 478  * RETURNS:
 479  *
 480  * Always succeeds and returns 0.
 481  */
 482 int drm_release(struct inode *inode, struct file *filp)
 483 {
 484         struct drm_file *file_priv = filp->private_data;
 485         struct drm_minor *minor = file_priv->minor;
 486         struct drm_device *dev = minor->dev;
 487
 488         if (drm_dev_needs_global_mutex(dev))
 489                 mutex_lock(&drm_global_mutex);
 490
 491         DRM_DEBUG("open_count = %d\n", atomic_read(&dev->open_count));
 492
 493         drm_close_helper(filp);
 494
 495         if (atomic_dec_and_test(&dev->open_count))
 496                 drm_lastclose(dev);
 497
 498         if (drm_dev_needs_global_mutex(dev))
 499                 mutex_unlock(&drm_global_mutex);
 500
 501         drm_minor_release(minor);
 502
 503         return 0;
 504 }
 505 EXPORT_SYMBOL(drm_release);
 506
 507 /**
 508  * drm_release_noglobal - release method for DRM file
 509  * @inode: device inode
 510  * @filp: file pointer.
 511  *
 512  * This function may be used by drivers as their &file_operations.release
 513  * method. It frees any resources associated with the open file prior to taking
 514  * the drm_global_mutex, which then calls the &drm_driver.postclose driver
 515  * callback. If this is the last open file for the DRM device also proceeds to
 516  * call the &drm_driver.lastclose driver callback.
 517  *
 518  * RETURNS:
 519  *
 520  * Always succeeds and returns 0.
 521  */
 522 int drm_release_noglobal(struct inode *inode, struct file *filp)
 523 {
 524         struct drm_file *file_priv = filp->private_data;
 525         struct drm_minor *minor = file_priv->minor;
 526         struct drm_device *dev = minor->dev;
 527
 528         drm_close_helper(filp);
 529
 530         if (atomic_dec_and_mutex_lock(&dev->open_count, &drm_global_mutex)) {
 531                 drm_lastclose(dev);
 532                 mutex_unlock(&drm_global_mutex);
 533         }
 534
 535         drm_minor_release(minor);
 536
 537         return 0;
 538 }
 539 EXPORT_SYMBOL(drm_release_noglobal);
 540
 541 /**
 542  * drm_read - read method for DRM file
 543  * @filp: file pointer
 544  * @buffer: userspace destination pointer for the read
 545  * @count: count in bytes to read
 546  * @offset: offset to read
 547  *
 548  * This function must be used by drivers as their &file_operations.read
 549  * method iff they use DRM events for asynchronous signalling to userspace.
 550  * Since events are used by the KMS API for vblank and page flip completion this
 551  * means all modern display drivers must use it.
 552  *
 553  * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
 554  * must set the &file_operation.llseek to no_llseek(). Polling support is
 555  * provided by drm_poll().
 556  *
 557  * This function will only ever read a full event. Therefore userspace must
 558  * supply a big enough buffer to fit any event to ensure forward progress. Since
 559  * the maximum event space is currently 4K it's recommended to just use that for
 560  * safety.
 561  *
 562  * RETURNS:
 563  *
 564  * Number of bytes read (always aligned to full events, and can be 0) or a
 565  * negative error code on failure.
 566  */
 567 ssize_t drm_read(struct file *filp, char __user *buffer,
 568                  size_t count, loff_t *offset)
 569 {
 570         struct drm_file *file_priv = filp->private_data;
 571         struct drm_device *dev = file_priv->minor->dev;
 572         ssize_t ret;
 573
 574         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 575         if (ret)
 576                 return ret;
 577
 578         for (;;) {
 579                 struct drm_pending_event *e = NULL;
 580
 581                 spin_lock_irq(&dev->event_lock);
 582                 if (!list_empty(&file_priv->event_list)) {
 583                         e = list_first_entry(&file_priv->event_list,
 584                                         struct drm_pending_event, link);
 585                         file_priv->event_space += e->event->length;
 586                         list_del(&e->link);
 587                 }
 588                 spin_unlock_irq(&dev->event_lock);
 589
 590                 if (e == NULL) {
 591                         if (ret)
 592                                 break;
 593
 594                         if (filp->f_flags & O_NONBLOCK) {
 595                                 ret = -EAGAIN;
 596                                 break;
 597                         }
 598
 599                         mutex_unlock(&file_priv->event_read_lock);
 600                         ret = wait_event_interruptible(file_priv->event_wait,
 601                                                        !list_empty(&file_priv->event_list));
 602                         if (ret >= 0)
 603                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 604                         if (ret)
 605                                 return ret;
 606                 } else {
 607                         unsigned length = e->event->length;
 608
 609                         if (length > count - ret) {
 610 put_back_event:
 611                                 spin_lock_irq(&dev->event_lock);
 612                                 file_priv->event_space -= length;
 613                                 list_add(&e->link, &file_priv->event_list);
 614                                 spin_unlock_irq(&dev->event_lock);
 615                                 wake_up_interruptible_poll(&file_priv->event_wait,
 616                                         EPOLLIN | EPOLLRDNORM);
 617                                 break;
 618                         }
 619
 620                         if (copy_to_user(buffer + ret, e->event, length)) {
 621                                 if (ret == 0)
 622                                         ret = -EFAULT;
 623                                 goto put_back_event;
 624                         }
 625
 626                         ret += length;
 627                         kfree(e);
 628                 }
 629         }
 630         mutex_unlock(&file_priv->event_read_lock);
 631
 632         return ret;
 633 }
 634 EXPORT_SYMBOL(drm_read);
 635
 636 /**
 637  * drm_poll - poll method for DRM file
 638  * @filp: file pointer
 639  * @wait: poll waiter table
 640  *
 641  * This function must be used by drivers as their &file_operations.read method
 642  * iff they use DRM events for asynchronous signalling to userspace.  Since
 643  * events are used by the KMS API for vblank and page flip completion this means
 644  * all modern display drivers must use it.
 645  *
 646  * See also drm_read().
 647  *
 648  * RETURNS:
 649  *
 650  * Mask of POLL flags indicating the current status of the file.
 651  */
 652 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
 653 {
 654         struct drm_file *file_priv = filp->private_data;
 655         __poll_t mask = 0;
 656
 657         poll_wait(filp, &file_priv->event_wait, wait);
 658
 659         if (!list_empty(&file_priv->event_list))
 660                 mask |= EPOLLIN | EPOLLRDNORM;
 661
 662         return mask;
 663 }
 664 EXPORT_SYMBOL(drm_poll);
 665
 666 /**
 667  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 668  * @dev: DRM device
 669  * @file_priv: DRM file private data
 670  * @p: tracking structure for the pending event
 671  * @e: actual event data to deliver to userspace
 672  *
 673  * This function prepares the passed in event for eventual delivery. If the event
 674  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 675  * anything) then the even must be cancelled and freed using
 676  * drm_event_cancel_free(). Successfully initialized events should be sent out
 677  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 678  * asynchronous event to userspace.
 679  *
 680  * If callers embedded @p into a larger structure it must be allocated with
 681  * kmalloc and @p must be the first member element.
 682  *
 683  * This is the locked version of drm_event_reserve_init() for callers which
 684  * already hold &drm_device.event_lock.
 685  *
 686  * RETURNS:
 687  *
 688  * 0 on success or a negative error code on failure.
 689  */
 690 int drm_event_reserve_init_locked(struct drm_device *dev,
 691                                   struct drm_file *file_priv,
 692                                   struct drm_pending_event *p,
 693                                   struct drm_event *e)
 694 {
 695         if (file_priv->event_space < e->length)
 696                 return -ENOMEM;
 697
 698         file_priv->event_space -= e->length;
 699
 700         p->event = e;
 701         list_add(&p->pending_link, &file_priv->pending_event_list);
 702         p->file_priv = file_priv;
 703
 704         return 0;
 705 }
 706 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 707
 708 /**
 709  * drm_event_reserve_init - init a DRM event and reserve space for it
 710  * @dev: DRM device
 711  * @file_priv: DRM file private data
 712  * @p: tracking structure for the pending event
 713  * @e: actual event data to deliver to userspace
 714  *
 715  * This function prepares the passed in event for eventual delivery. If the event
 716  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 717  * anything) then the even must be cancelled and freed using
 718  * drm_event_cancel_free(). Successfully initialized events should be sent out
 719  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 720  * asynchronous event to userspace.
 721  *
 722  * If callers embedded @p into a larger structure it must be allocated with
 723  * kmalloc and @p must be the first member element.
 724  *
 725  * Callers which already hold &drm_device.event_lock should use
 726  * drm_event_reserve_init_locked() instead.
 727  *
 728  * RETURNS:
 729  *
 730  * 0 on success or a negative error code on failure.
 731  */
 732 int drm_event_reserve_init(struct drm_device *dev,
 733                            struct drm_file *file_priv,
 734                            struct drm_pending_event *p,
 735                            struct drm_event *e)
 736 {
 737         unsigned long flags;
 738         int ret;
 739
 740         spin_lock_irqsave(&dev->event_lock, flags);
 741         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 742         spin_unlock_irqrestore(&dev->event_lock, flags);
 743
 744         return ret;
 745 }
 746 EXPORT_SYMBOL(drm_event_reserve_init);
 747
 748 /**
 749  * drm_event_cancel_free - free a DRM event and release its space
 750  * @dev: DRM device
 751  * @p: tracking structure for the pending event
 752  *
 753  * This function frees the event @p initialized with drm_event_reserve_init()
 754  * and releases any allocated space. It is used to cancel an event when the
 755  * nonblocking operation could not be submitted and needed to be aborted.
 756  */
 757 void drm_event_cancel_free(struct drm_device *dev,
 758                            struct drm_pending_event *p)
 759 {
 760         unsigned long flags;
 761         spin_lock_irqsave(&dev->event_lock, flags);
 762         if (p->file_priv) {
 763                 p->file_priv->event_space += p->event->length;
 764                 list_del(&p->pending_link);
 765         }
 766         spin_unlock_irqrestore(&dev->event_lock, flags);
 767
 768         if (p->fence)
 769                 dma_fence_put(p->fence);
 770
 771         kfree(p);
 772 }
 773 EXPORT_SYMBOL(drm_event_cancel_free);
 774
 775 /**
 776  * drm_send_event_locked - send DRM event to file descriptor
 777  * @dev: DRM device
 778  * @e: DRM event to deliver
 779  *
 780  * This function sends the event @e, initialized with drm_event_reserve_init(),
 781  * to its associated userspace DRM file. Callers must already hold
 782  * &drm_device.event_lock, see drm_send_event() for the unlocked version.
 783  *
 784  * Note that the core will take care of unlinking and disarming events when the
 785  * corresponding DRM file is closed. Drivers need not worry about whether the
 786  * DRM file for this event still exists and can call this function upon
 787  * completion of the asynchronous work unconditionally.
 788  */
 789 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 790 {
 791         assert_spin_locked(&dev->event_lock);
 792
 793         if (e->completion) {
 794                 complete_all(e->completion);
 795                 e->completion_release(e->completion);
 796                 e->completion = NULL;
 797         }
 798
 799         if (e->fence) {
 800                 dma_fence_signal(e->fence);
 801                 dma_fence_put(e->fence);
 802         }
 803
 804         if (!e->file_priv) {
 805                 kfree(e);
 806                 return;
 807         }
 808
 809         list_del(&e->pending_link);
 810         list_add_tail(&e->link,
 811                       &e->file_priv->event_list);
 812         wake_up_interruptible_poll(&e->file_priv->event_wait,
 813                 EPOLLIN | EPOLLRDNORM);
 814 }
 815 EXPORT_SYMBOL(drm_send_event_locked);
 816
 817 /**
 818  * drm_send_event - send DRM event to file descriptor
 819  * @dev: DRM device
 820  * @e: DRM event to deliver
 821  *
 822  * This function sends the event @e, initialized with drm_event_reserve_init(),
 823  * to its associated userspace DRM file. This function acquires
 824  * &drm_device.event_lock, see drm_send_event_locked() for callers which already
 825  * hold this lock.
 826  *
 827  * Note that the core will take care of unlinking and disarming events when the
 828  * corresponding DRM file is closed. Drivers need not worry about whether the
 829  * DRM file for this event still exists and can call this function upon
 830  * completion of the asynchronous work unconditionally.
 831  */
 832 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 833 {
 834         unsigned long irqflags;
 835
 836         spin_lock_irqsave(&dev->event_lock, irqflags);
 837         drm_send_event_locked(dev, e);
 838         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 839 }
 840 EXPORT_SYMBOL(drm_send_event);
 841
 842 /**
 843  * mock_drm_getfile - Create a new struct file for the drm device
 844  * @minor: drm minor to wrap (e.g. #drm_device.primary)
 845  * @flags: file creation mode (O_RDWR etc)
 846  *
 847  * This create a new struct file that wraps a DRM file context around a
 848  * DRM minor. This mimicks userspace opening e.g. /dev/dri/card0, but without
 849  * invoking userspace. The struct file may be operated on using its f_op
 850  * (the drm_device.driver.fops) to mimick userspace operations, or be supplied
 851  * to userspace facing functions as an internal/anonymous client.
 852  *
 853  * RETURNS:
 854  * Pointer to newly created struct file, ERR_PTR on failure.
 855  */
 856 struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags)
 857 {
 858         struct drm_device *dev = minor->dev;
 859         struct drm_file *priv;
 860         struct file *file;
 861
 862         priv = drm_file_alloc(minor);
 863         if (IS_ERR(priv))
 864                 return ERR_CAST(priv);
 865
 866         file = anon_inode_getfile("drm", dev->driver->fops, priv, flags);
 867         if (IS_ERR(file)) {
 868                 drm_file_free(priv);
 869                 return file;
 870         }
 871
 872         /* Everyone shares a single global address space */
 873         file->f_mapping = dev->anon_inode->i_mapping;
 874
 875         drm_dev_get(dev);
 876         priv->filp = file;
 877
 878         return file;
 879 }
 880 EXPORT_SYMBOL_FOR_TESTS_ONLY(mock_drm_getfile);
 881
 882 #ifdef CONFIG_MMU
 883 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 884 /*
 885  * drm_addr_inflate() attempts to construct an aligned area by inflating
 886  * the area size and skipping the unaligned start of the area.
 887  * adapted from shmem_get_unmapped_area()
 888  */
 889 static unsigned long drm_addr_inflate(unsigned long addr,
 890                                       unsigned long len,
 891                                       unsigned long pgoff,
 892                                       unsigned long flags,
 893                                       unsigned long huge_size)
 894 {
 895         unsigned long offset, inflated_len;
 896         unsigned long inflated_addr;
 897         unsigned long inflated_offset;
 898
 899         offset = (pgoff << PAGE_SHIFT) & (huge_size - 1);
 900         if (offset && offset + len < 2 * huge_size)
 901                 return addr;
 902         if ((addr & (huge_size - 1)) == offset)
 903                 return addr;
 904
 905         inflated_len = len + huge_size - PAGE_SIZE;
 906         if (inflated_len > TASK_SIZE)
 907                 return addr;
 908         if (inflated_len < len)
 909                 return addr;
 910
 911         inflated_addr = current->mm->get_unmapped_area(NULL, 0, inflated_len,
 912                                                        0, flags);
 913         if (IS_ERR_VALUE(inflated_addr))
 914                 return addr;
 915         if (inflated_addr & ~PAGE_MASK)
 916                 return addr;
 917
 918         inflated_offset = inflated_addr & (huge_size - 1);
 919         inflated_addr += offset - inflated_offset;
 920         if (inflated_offset > offset)
 921                 inflated_addr += huge_size;
 922
 923         if (inflated_addr > TASK_SIZE - len)
 924                 return addr;
 925
 926         return inflated_addr;
 927 }
 928
 929 /**
 930  * drm_get_unmapped_area() - Get an unused user-space virtual memory area
 931  * suitable for huge page table entries.
 932  * @file: The struct file representing the address space being mmap()'d.
 933  * @uaddr: Start address suggested by user-space.
 934  * @len: Length of the area.
 935  * @pgoff: The page offset into the address space.
 936  * @flags: mmap flags
 937  * @mgr: The address space manager used by the drm driver. This argument can
 938  * probably be removed at some point when all drivers use the same
 939  * address space manager.
 940  *
 941  * This function attempts to find an unused user-space virtual memory area
 942  * that can accommodate the size we want to map, and that is properly
 943  * aligned to facilitate huge page table entries matching actual
 944  * huge pages or huge page aligned memory in buffer objects. Buffer objects
 945  * are assumed to start at huge page boundary pfns (io memory) or be
 946  * populated by huge pages aligned to the start of the buffer object
 947  * (system- or coherent memory). Adapted from shmem_get_unmapped_area.
 948  *
 949  * Return: aligned user-space address.
 950  */
 951 unsigned long drm_get_unmapped_area(struct file *file,
 952                                     unsigned long uaddr, unsigned long len,
 953                                     unsigned long pgoff, unsigned long flags,
 954                                     struct drm_vma_offset_manager *mgr)
 955 {
 956         unsigned long addr;
 957         unsigned long inflated_addr;
 958         struct drm_vma_offset_node *node;
 959
 960         if (len > TASK_SIZE)
 961                 return -ENOMEM;
 962
 963         /*
 964          * @pgoff is the file page-offset the huge page boundaries of
 965          * which typically aligns to physical address huge page boundaries.
 966          * That's not true for DRM, however, where physical address huge
 967          * page boundaries instead are aligned with the offset from
 968          * buffer object start. So adjust @pgoff to be the offset from
 969          * buffer object start.
 970          */
 971         drm_vma_offset_lock_lookup(mgr);
 972         node = drm_vma_offset_lookup_locked(mgr, pgoff, 1);
 973         if (node)
 974                 pgoff -= node->vm_node.start;
 975         drm_vma_offset_unlock_lookup(mgr);
 976
 977         addr = current->mm->get_unmapped_area(file, uaddr, len, pgoff, flags);
 978         if (IS_ERR_VALUE(addr))
 979                 return addr;
 980         if (addr & ~PAGE_MASK)
 981                 return addr;
 982         if (addr > TASK_SIZE - len)
 983                 return addr;
 984
 985         if (len < HPAGE_PMD_SIZE)
 986                 return addr;
 987         if (flags & MAP_FIXED)
 988                 return addr;
 989         /*
 990          * Our priority is to support MAP_SHARED mapped hugely;
 991          * and support MAP_PRIVATE mapped hugely too, until it is COWed.
 992          * But if caller specified an address hint, respect that as before.
 993          */
 994         if (uaddr)
 995                 return addr;
 996
 997         inflated_addr = drm_addr_inflate(addr, len, pgoff, flags,
 998                                          HPAGE_PMD_SIZE);
 999
1000         if (IS_ENABLED(CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD) &&
1001             len >= HPAGE_PUD_SIZE)
1002                 inflated_addr = drm_addr_inflate(inflated_addr, len, pgoff,
1003                                                  flags, HPAGE_PUD_SIZE);
1004         return inflated_addr;
1005 }
1006 #else /* CONFIG_TRANSPARENT_HUGEPAGE */
1007 unsigned long drm_get_unmapped_area(struct file *file,
1008                                     unsigned long uaddr, unsigned long len,
1009                                     unsigned long pgoff, unsigned long flags,
1010                                     struct drm_vma_offset_manager *mgr)
1011 {
1012         return current->mm->get_unmapped_area(file, uaddr, len, pgoff, flags);
1013 }
1014 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
1015 EXPORT_SYMBOL_GPL(drm_get_unmapped_area);
1016 #endif /* CONFIG_MMU */