drivers/gpu/drm/drm_file.c

   1 /*
   2  * \author Rickard E. (Rik) Faith <[email protected]>
   3  * \author Daryll Strauss <[email protected]>
   4  * \author Gareth Hughes <[email protected]>
   5  */
   6
   7 /*
   8  * Created: Mon Jan  4 08:58:31 1999 by [email protected]
   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_gem.h>
  46 #include <drm/drm_print.h>
  47
  48 #include "drm_crtc_internal.h"
  49 #include "drm_internal.h"
  50
  51 /* from BKL pushdown */
  52 DEFINE_MUTEX(drm_global_mutex);
  53
  54 bool drm_dev_needs_global_mutex(struct drm_device *dev)
  55 {
  56         /*
  57          * The deprecated ->load callback must be called after the driver is
  58          * already registered. This means such drivers rely on the BKL to make
  59          * sure an open can't proceed until the driver is actually fully set up.
  60          * Similar hilarity holds for the unload callback.
  61          */
  62         if (dev->driver->load || dev->driver->unload)
  63                 return true;
  64
  65         /*
  66          * Drivers with the lastclose callback assume that it's synchronized
  67          * against concurrent opens, which again needs the BKL. The proper fix
  68          * is to use the drm_client infrastructure with proper locking for each
  69          * client.
  70          */
  71         if (dev->driver->lastclose)
  72                 return true;
  73
  74         return false;
  75 }
  76
  77 /**
  78  * DOC: file operations
  79  *
  80  * Drivers must define the file operations structure that forms the DRM
  81  * userspace API entry point, even though most of those operations are
  82  * implemented in the DRM core. The resulting &struct file_operations must be
  83  * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
  84  * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
  85  * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
  86  * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
  87  * that require 32/64 bit compatibility support must provide their own
  88  * &file_operations.compat_ioctl handler that processes private ioctls and calls
  89  * drm_compat_ioctl() for core ioctls.
  90  *
  91  * In addition drm_read() and drm_poll() provide support for DRM events. DRM
  92  * events are a generic and extensible means to send asynchronous events to
  93  * userspace through the file descriptor. They are used to send vblank event and
  94  * page flip completions by the KMS API. But drivers can also use it for their
  95  * own needs, e.g. to signal completion of rendering.
  96  *
  97  * For the driver-side event interface see drm_event_reserve_init() and
  98  * drm_send_event() as the main starting points.
  99  *
 100  * The memory mapping implementation will vary depending on how the driver
 101  * manages memory. For GEM-based drivers this is drm_gem_mmap().
 102  *
 103  * No other file operations are supported by the DRM userspace API. Overall the
 104  * following is an example &file_operations structure::
 105  *
 106  *     static const example_drm_fops = {
 107  *             .owner = THIS_MODULE,
 108  *             .open = drm_open,
 109  *             .release = drm_release,
 110  *             .unlocked_ioctl = drm_ioctl,
 111  *             .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
 112  *             .poll = drm_poll,
 113  *             .read = drm_read,
 114  *             .llseek = no_llseek,
 115  *             .mmap = drm_gem_mmap,
 116  *     };
 117  *
 118  * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
 119  * DMA based drivers there is the DEFINE_DRM_GEM_DMA_FOPS() macro to make this
 120  * simpler.
 121  *
 122  * The driver's &file_operations must be stored in &drm_driver.fops.
 123  *
 124  * For driver-private IOCTL handling see the more detailed discussion in
 125  * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
 126  */
 127
 128 /**
 129  * drm_file_alloc - allocate file context
 130  * @minor: minor to allocate on
 131  *
 132  * This allocates a new DRM file context. It is not linked into any context and
 133  * can be used by the caller freely. Note that the context keeps a pointer to
 134  * @minor, so it must be freed before @minor is.
 135  *
 136  * RETURNS:
 137  * Pointer to newly allocated context, ERR_PTR on failure.
 138  */
 139 struct drm_file *drm_file_alloc(struct drm_minor *minor)
 140 {
 141         static atomic64_t ident = ATOMIC_INIT(0);
 142         struct drm_device *dev = minor->dev;
 143         struct drm_file *file;
 144         int ret;
 145
 146         file = kzalloc(sizeof(*file), GFP_KERNEL);
 147         if (!file)
 148                 return ERR_PTR(-ENOMEM);
 149
 150         /* Get a unique identifier for fdinfo: */
 151         file->client_id = atomic64_inc_return(&ident);
 152         rcu_assign_pointer(file->pid, get_pid(task_tgid(current)));
 153         file->minor = minor;
 154
 155         /* for compatibility root is always authenticated */
 156         file->authenticated = capable(CAP_SYS_ADMIN);
 157
 158         INIT_LIST_HEAD(&file->lhead);
 159         INIT_LIST_HEAD(&file->fbs);
 160         mutex_init(&file->fbs_lock);
 161         INIT_LIST_HEAD(&file->blobs);
 162         INIT_LIST_HEAD(&file->pending_event_list);
 163         INIT_LIST_HEAD(&file->event_list);
 164         init_waitqueue_head(&file->event_wait);
 165         file->event_space = 4096; /* set aside 4k for event buffer */
 166
 167         spin_lock_init(&file->master_lookup_lock);
 168         mutex_init(&file->event_read_lock);
 169
 170         if (drm_core_check_feature(dev, DRIVER_GEM))
 171                 drm_gem_open(dev, file);
 172
 173         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 174                 drm_syncobj_open(file);
 175
 176         drm_prime_init_file_private(&file->prime);
 177
 178         if (dev->driver->open) {
 179                 ret = dev->driver->open(dev, file);
 180                 if (ret < 0)
 181                         goto out_prime_destroy;
 182         }
 183
 184         return file;
 185
 186 out_prime_destroy:
 187         drm_prime_destroy_file_private(&file->prime);
 188         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 189                 drm_syncobj_release(file);
 190         if (drm_core_check_feature(dev, DRIVER_GEM))
 191                 drm_gem_release(dev, file);
 192         put_pid(rcu_access_pointer(file->pid));
 193         kfree(file);
 194
 195         return ERR_PTR(ret);
 196 }
 197
 198 static void drm_events_release(struct drm_file *file_priv)
 199 {
 200         struct drm_device *dev = file_priv->minor->dev;
 201         struct drm_pending_event *e, *et;
 202         unsigned long flags;
 203
 204         spin_lock_irqsave(&dev->event_lock, flags);
 205
 206         /* Unlink pending events */
 207         list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
 208                                  pending_link) {
 209                 list_del(&e->pending_link);
 210                 e->file_priv = NULL;
 211         }
 212
 213         /* Remove unconsumed events */
 214         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 215                 list_del(&e->link);
 216                 kfree(e);
 217         }
 218
 219         spin_unlock_irqrestore(&dev->event_lock, flags);
 220 }
 221
 222 /**
 223  * drm_file_free - free file context
 224  * @file: context to free, or NULL
 225  *
 226  * This destroys and deallocates a DRM file context previously allocated via
 227  * drm_file_alloc(). The caller must make sure to unlink it from any contexts
 228  * before calling this.
 229  *
 230  * If NULL is passed, this is a no-op.
 231  */
 232 void drm_file_free(struct drm_file *file)
 233 {
 234         struct drm_device *dev;
 235
 236         if (!file)
 237                 return;
 238
 239         dev = file->minor->dev;
 240
 241         drm_dbg_core(dev, "comm=\"%s\", pid=%d, dev=0x%lx, open_count=%d\n",
 242                      current->comm, task_pid_nr(current),
 243                      (long)old_encode_dev(file->minor->kdev->devt),
 244                      atomic_read(&dev->open_count));
 245
 246         drm_events_release(file);
 247
 248         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 249                 drm_fb_release(file);
 250                 drm_property_destroy_user_blobs(dev, file);
 251         }
 252
 253         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 254                 drm_syncobj_release(file);
 255
 256         if (drm_core_check_feature(dev, DRIVER_GEM))
 257                 drm_gem_release(dev, file);
 258
 259         if (drm_is_primary_client(file))
 260                 drm_master_release(file);
 261
 262         if (dev->driver->postclose)
 263                 dev->driver->postclose(dev, file);
 264
 265         drm_prime_destroy_file_private(&file->prime);
 266
 267         WARN_ON(!list_empty(&file->event_list));
 268
 269         put_pid(rcu_access_pointer(file->pid));
 270         kfree(file);
 271 }
 272
 273 static void drm_close_helper(struct file *filp)
 274 {
 275         struct drm_file *file_priv = filp->private_data;
 276         struct drm_device *dev = file_priv->minor->dev;
 277
 278         mutex_lock(&dev->filelist_mutex);
 279         list_del(&file_priv->lhead);
 280         mutex_unlock(&dev->filelist_mutex);
 281
 282         drm_file_free(file_priv);
 283 }
 284
 285 /*
 286  * Check whether DRI will run on this CPU.
 287  *
 288  * \return non-zero if the DRI will run on this CPU, or zero otherwise.
 289  */
 290 static int drm_cpu_valid(void)
 291 {
 292 #if defined(__sparc__) && !defined(__sparc_v9__)
 293         return 0;               /* No cmpxchg before v9 sparc. */
 294 #endif
 295         return 1;
 296 }
 297
 298 /*
 299  * Called whenever a process opens a drm node
 300  *
 301  * \param filp file pointer.
 302  * \param minor acquired minor-object.
 303  * \return zero on success or a negative number on failure.
 304  *
 305  * Creates and initializes a drm_file structure for the file private data in \p
 306  * filp and add it into the double linked list in \p dev.
 307  */
 308 int drm_open_helper(struct file *filp, struct drm_minor *minor)
 309 {
 310         struct drm_device *dev = minor->dev;
 311         struct drm_file *priv;
 312         int ret;
 313
 314         if (filp->f_flags & O_EXCL)
 315                 return -EBUSY;  /* No exclusive opens */
 316         if (!drm_cpu_valid())
 317                 return -EINVAL;
 318         if (dev->switch_power_state != DRM_SWITCH_POWER_ON &&
 319             dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 320                 return -EINVAL;
 321
 322         drm_dbg_core(dev, "comm=\"%s\", pid=%d, minor=%d\n",
 323                      current->comm, task_pid_nr(current), minor->index);
 324
 325         priv = drm_file_alloc(minor);
 326         if (IS_ERR(priv))
 327                 return PTR_ERR(priv);
 328
 329         if (drm_is_primary_client(priv)) {
 330                 ret = drm_master_open(priv);
 331                 if (ret) {
 332                         drm_file_free(priv);
 333                         return ret;
 334                 }
 335         }
 336
 337         filp->private_data = priv;
 338         filp->f_mode |= FMODE_UNSIGNED_OFFSET;
 339         priv->filp = filp;
 340
 341         mutex_lock(&dev->filelist_mutex);
 342         list_add(&priv->lhead, &dev->filelist);
 343         mutex_unlock(&dev->filelist_mutex);
 344
 345         return 0;
 346 }
 347
 348 /**
 349  * drm_open - open method for DRM file
 350  * @inode: device inode
 351  * @filp: file pointer.
 352  *
 353  * This function must be used by drivers as their &file_operations.open method.
 354  * It looks up the correct DRM device and instantiates all the per-file
 355  * resources for it. It also calls the &drm_driver.open driver callback.
 356  *
 357  * RETURNS:
 358  *
 359  * 0 on success or negative errno value on failure.
 360  */
 361 int drm_open(struct inode *inode, struct file *filp)
 362 {
 363         struct drm_device *dev;
 364         struct drm_minor *minor;
 365         int retcode;
 366
 367         minor = drm_minor_acquire(iminor(inode));
 368         if (IS_ERR(minor))
 369                 return PTR_ERR(minor);
 370
 371         dev = minor->dev;
 372         if (drm_dev_needs_global_mutex(dev))
 373                 mutex_lock(&drm_global_mutex);
 374
 375         atomic_fetch_inc(&dev->open_count);
 376
 377         /* share address_space across all char-devs of a single device */
 378         filp->f_mapping = dev->anon_inode->i_mapping;
 379
 380         retcode = drm_open_helper(filp, minor);
 381         if (retcode)
 382                 goto err_undo;
 383
 384         if (drm_dev_needs_global_mutex(dev))
 385                 mutex_unlock(&drm_global_mutex);
 386
 387         return 0;
 388
 389 err_undo:
 390         atomic_dec(&dev->open_count);
 391         if (drm_dev_needs_global_mutex(dev))
 392                 mutex_unlock(&drm_global_mutex);
 393         drm_minor_release(minor);
 394         return retcode;
 395 }
 396 EXPORT_SYMBOL(drm_open);
 397
 398 void drm_lastclose(struct drm_device * dev)
 399 {
 400         drm_dbg_core(dev, "\n");
 401
 402         if (dev->driver->lastclose)
 403                 dev->driver->lastclose(dev);
 404         drm_dbg_core(dev, "driver lastclose completed\n");
 405
 406         drm_client_dev_restore(dev);
 407 }
 408
 409 /**
 410  * drm_release - release method for DRM file
 411  * @inode: device inode
 412  * @filp: file pointer.
 413  *
 414  * This function must be used by drivers as their &file_operations.release
 415  * method. It frees any resources associated with the open file, and calls the
 416  * &drm_driver.postclose driver callback. If this is the last open file for the
 417  * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
 418  *
 419  * RETURNS:
 420  *
 421  * Always succeeds and returns 0.
 422  */
 423 int drm_release(struct inode *inode, struct file *filp)
 424 {
 425         struct drm_file *file_priv = filp->private_data;
 426         struct drm_minor *minor = file_priv->minor;
 427         struct drm_device *dev = minor->dev;
 428
 429         if (drm_dev_needs_global_mutex(dev))
 430                 mutex_lock(&drm_global_mutex);
 431
 432         drm_dbg_core(dev, "open_count = %d\n", atomic_read(&dev->open_count));
 433
 434         drm_close_helper(filp);
 435
 436         if (atomic_dec_and_test(&dev->open_count))
 437                 drm_lastclose(dev);
 438
 439         if (drm_dev_needs_global_mutex(dev))
 440                 mutex_unlock(&drm_global_mutex);
 441
 442         drm_minor_release(minor);
 443
 444         return 0;
 445 }
 446 EXPORT_SYMBOL(drm_release);
 447
 448 void drm_file_update_pid(struct drm_file *filp)
 449 {
 450         struct drm_device *dev;
 451         struct pid *pid, *old;
 452
 453         /*
 454          * Master nodes need to keep the original ownership in order for
 455          * drm_master_check_perm to keep working correctly. (See comment in
 456          * drm_auth.c.)
 457          */
 458         if (filp->was_master)
 459                 return;
 460
 461         pid = task_tgid(current);
 462
 463         /*
 464          * Quick unlocked check since the model is a single handover followed by
 465          * exclusive repeated use.
 466          */
 467         if (pid == rcu_access_pointer(filp->pid))
 468                 return;
 469
 470         dev = filp->minor->dev;
 471         mutex_lock(&dev->filelist_mutex);
 472         get_pid(pid);
 473         old = rcu_replace_pointer(filp->pid, pid, 1);
 474         mutex_unlock(&dev->filelist_mutex);
 475
 476         synchronize_rcu();
 477         put_pid(old);
 478 }
 479
 480 /**
 481  * drm_release_noglobal - release method for DRM file
 482  * @inode: device inode
 483  * @filp: file pointer.
 484  *
 485  * This function may be used by drivers as their &file_operations.release
 486  * method. It frees any resources associated with the open file prior to taking
 487  * the drm_global_mutex, which then calls the &drm_driver.postclose driver
 488  * callback. If this is the last open file for the DRM device also proceeds to
 489  * call the &drm_driver.lastclose driver callback.
 490  *
 491  * RETURNS:
 492  *
 493  * Always succeeds and returns 0.
 494  */
 495 int drm_release_noglobal(struct inode *inode, struct file *filp)
 496 {
 497         struct drm_file *file_priv = filp->private_data;
 498         struct drm_minor *minor = file_priv->minor;
 499         struct drm_device *dev = minor->dev;
 500
 501         drm_close_helper(filp);
 502
 503         if (atomic_dec_and_mutex_lock(&dev->open_count, &drm_global_mutex)) {
 504                 drm_lastclose(dev);
 505                 mutex_unlock(&drm_global_mutex);
 506         }
 507
 508         drm_minor_release(minor);
 509
 510         return 0;
 511 }
 512 EXPORT_SYMBOL(drm_release_noglobal);
 513
 514 /**
 515  * drm_read - read method for DRM file
 516  * @filp: file pointer
 517  * @buffer: userspace destination pointer for the read
 518  * @count: count in bytes to read
 519  * @offset: offset to read
 520  *
 521  * This function must be used by drivers as their &file_operations.read
 522  * method if they use DRM events for asynchronous signalling to userspace.
 523  * Since events are used by the KMS API for vblank and page flip completion this
 524  * means all modern display drivers must use it.
 525  *
 526  * @offset is ignored, DRM events are read like a pipe. Polling support is
 527  * provided by drm_poll().
 528  *
 529  * This function will only ever read a full event. Therefore userspace must
 530  * supply a big enough buffer to fit any event to ensure forward progress. Since
 531  * the maximum event space is currently 4K it's recommended to just use that for
 532  * safety.
 533  *
 534  * RETURNS:
 535  *
 536  * Number of bytes read (always aligned to full events, and can be 0) or a
 537  * negative error code on failure.
 538  */
 539 ssize_t drm_read(struct file *filp, char __user *buffer,
 540                  size_t count, loff_t *offset)
 541 {
 542         struct drm_file *file_priv = filp->private_data;
 543         struct drm_device *dev = file_priv->minor->dev;
 544         ssize_t ret;
 545
 546         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 547         if (ret)
 548                 return ret;
 549
 550         for (;;) {
 551                 struct drm_pending_event *e = NULL;
 552
 553                 spin_lock_irq(&dev->event_lock);
 554                 if (!list_empty(&file_priv->event_list)) {
 555                         e = list_first_entry(&file_priv->event_list,
 556                                         struct drm_pending_event, link);
 557                         file_priv->event_space += e->event->length;
 558                         list_del(&e->link);
 559                 }
 560                 spin_unlock_irq(&dev->event_lock);
 561
 562                 if (e == NULL) {
 563                         if (ret)
 564                                 break;
 565
 566                         if (filp->f_flags & O_NONBLOCK) {
 567                                 ret = -EAGAIN;
 568                                 break;
 569                         }
 570
 571                         mutex_unlock(&file_priv->event_read_lock);
 572                         ret = wait_event_interruptible(file_priv->event_wait,
 573                                                        !list_empty(&file_priv->event_list));
 574                         if (ret >= 0)
 575                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 576                         if (ret)
 577                                 return ret;
 578                 } else {
 579                         unsigned length = e->event->length;
 580
 581                         if (length > count - ret) {
 582 put_back_event:
 583                                 spin_lock_irq(&dev->event_lock);
 584                                 file_priv->event_space -= length;
 585                                 list_add(&e->link, &file_priv->event_list);
 586                                 spin_unlock_irq(&dev->event_lock);
 587                                 wake_up_interruptible_poll(&file_priv->event_wait,
 588                                         EPOLLIN | EPOLLRDNORM);
 589                                 break;
 590                         }
 591
 592                         if (copy_to_user(buffer + ret, e->event, length)) {
 593                                 if (ret == 0)
 594                                         ret = -EFAULT;
 595                                 goto put_back_event;
 596                         }
 597
 598                         ret += length;
 599                         kfree(e);
 600                 }
 601         }
 602         mutex_unlock(&file_priv->event_read_lock);
 603
 604         return ret;
 605 }
 606 EXPORT_SYMBOL(drm_read);
 607
 608 /**
 609  * drm_poll - poll method for DRM file
 610  * @filp: file pointer
 611  * @wait: poll waiter table
 612  *
 613  * This function must be used by drivers as their &file_operations.read method
 614  * if they use DRM events for asynchronous signalling to userspace.  Since
 615  * events are used by the KMS API for vblank and page flip completion this means
 616  * all modern display drivers must use it.
 617  *
 618  * See also drm_read().
 619  *
 620  * RETURNS:
 621  *
 622  * Mask of POLL flags indicating the current status of the file.
 623  */
 624 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
 625 {
 626         struct drm_file *file_priv = filp->private_data;
 627         __poll_t mask = 0;
 628
 629         poll_wait(filp, &file_priv->event_wait, wait);
 630
 631         if (!list_empty(&file_priv->event_list))
 632                 mask |= EPOLLIN | EPOLLRDNORM;
 633
 634         return mask;
 635 }
 636 EXPORT_SYMBOL(drm_poll);
 637
 638 /**
 639  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 640  * @dev: DRM device
 641  * @file_priv: DRM file private data
 642  * @p: tracking structure for the pending event
 643  * @e: actual event data to deliver to userspace
 644  *
 645  * This function prepares the passed in event for eventual delivery. If the event
 646  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 647  * anything) then the even must be cancelled and freed using
 648  * drm_event_cancel_free(). Successfully initialized events should be sent out
 649  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 650  * asynchronous event to userspace.
 651  *
 652  * If callers embedded @p into a larger structure it must be allocated with
 653  * kmalloc and @p must be the first member element.
 654  *
 655  * This is the locked version of drm_event_reserve_init() for callers which
 656  * already hold &drm_device.event_lock.
 657  *
 658  * RETURNS:
 659  *
 660  * 0 on success or a negative error code on failure.
 661  */
 662 int drm_event_reserve_init_locked(struct drm_device *dev,
 663                                   struct drm_file *file_priv,
 664                                   struct drm_pending_event *p,
 665                                   struct drm_event *e)
 666 {
 667         if (file_priv->event_space < e->length)
 668                 return -ENOMEM;
 669
 670         file_priv->event_space -= e->length;
 671
 672         p->event = e;
 673         list_add(&p->pending_link, &file_priv->pending_event_list);
 674         p->file_priv = file_priv;
 675
 676         return 0;
 677 }
 678 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 679
 680 /**
 681  * drm_event_reserve_init - init a DRM event and reserve space for it
 682  * @dev: DRM device
 683  * @file_priv: DRM file private data
 684  * @p: tracking structure for the pending event
 685  * @e: actual event data to deliver to userspace
 686  *
 687  * This function prepares the passed in event for eventual delivery. If the event
 688  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 689  * anything) then the even must be cancelled and freed using
 690  * drm_event_cancel_free(). Successfully initialized events should be sent out
 691  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 692  * asynchronous event to userspace.
 693  *
 694  * If callers embedded @p into a larger structure it must be allocated with
 695  * kmalloc and @p must be the first member element.
 696  *
 697  * Callers which already hold &drm_device.event_lock should use
 698  * drm_event_reserve_init_locked() instead.
 699  *
 700  * RETURNS:
 701  *
 702  * 0 on success or a negative error code on failure.
 703  */
 704 int drm_event_reserve_init(struct drm_device *dev,
 705                            struct drm_file *file_priv,
 706                            struct drm_pending_event *p,
 707                            struct drm_event *e)
 708 {
 709         unsigned long flags;
 710         int ret;
 711
 712         spin_lock_irqsave(&dev->event_lock, flags);
 713         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 714         spin_unlock_irqrestore(&dev->event_lock, flags);
 715
 716         return ret;
 717 }
 718 EXPORT_SYMBOL(drm_event_reserve_init);
 719
 720 /**
 721  * drm_event_cancel_free - free a DRM event and release its space
 722  * @dev: DRM device
 723  * @p: tracking structure for the pending event
 724  *
 725  * This function frees the event @p initialized with drm_event_reserve_init()
 726  * and releases any allocated space. It is used to cancel an event when the
 727  * nonblocking operation could not be submitted and needed to be aborted.
 728  */
 729 void drm_event_cancel_free(struct drm_device *dev,
 730                            struct drm_pending_event *p)
 731 {
 732         unsigned long flags;
 733
 734         spin_lock_irqsave(&dev->event_lock, flags);
 735         if (p->file_priv) {
 736                 p->file_priv->event_space += p->event->length;
 737                 list_del(&p->pending_link);
 738         }
 739         spin_unlock_irqrestore(&dev->event_lock, flags);
 740
 741         if (p->fence)
 742                 dma_fence_put(p->fence);
 743
 744         kfree(p);
 745 }
 746 EXPORT_SYMBOL(drm_event_cancel_free);
 747
 748 static void drm_send_event_helper(struct drm_device *dev,
 749                            struct drm_pending_event *e, ktime_t timestamp)
 750 {
 751         assert_spin_locked(&dev->event_lock);
 752
 753         if (e->completion) {
 754                 complete_all(e->completion);
 755                 e->completion_release(e->completion);
 756                 e->completion = NULL;
 757         }
 758
 759         if (e->fence) {
 760                 if (timestamp)
 761                         dma_fence_signal_timestamp(e->fence, timestamp);
 762                 else
 763                         dma_fence_signal(e->fence);
 764                 dma_fence_put(e->fence);
 765         }
 766
 767         if (!e->file_priv) {
 768                 kfree(e);
 769                 return;
 770         }
 771
 772         list_del(&e->pending_link);
 773         list_add_tail(&e->link,
 774                       &e->file_priv->event_list);
 775         wake_up_interruptible_poll(&e->file_priv->event_wait,
 776                 EPOLLIN | EPOLLRDNORM);
 777 }
 778
 779 /**
 780  * drm_send_event_timestamp_locked - send DRM event to file descriptor
 781  * @dev: DRM device
 782  * @e: DRM event to deliver
 783  * @timestamp: timestamp to set for the fence event in kernel's CLOCK_MONOTONIC
 784  * time domain
 785  *
 786  * This function sends the event @e, initialized with drm_event_reserve_init(),
 787  * to its associated userspace DRM file. Callers must already hold
 788  * &drm_device.event_lock.
 789  *
 790  * Note that the core will take care of unlinking and disarming events when the
 791  * corresponding DRM file is closed. Drivers need not worry about whether the
 792  * DRM file for this event still exists and can call this function upon
 793  * completion of the asynchronous work unconditionally.
 794  */
 795 void drm_send_event_timestamp_locked(struct drm_device *dev,
 796                                      struct drm_pending_event *e, ktime_t timestamp)
 797 {
 798         drm_send_event_helper(dev, e, timestamp);
 799 }
 800 EXPORT_SYMBOL(drm_send_event_timestamp_locked);
 801
 802 /**
 803  * drm_send_event_locked - send DRM event to file descriptor
 804  * @dev: DRM device
 805  * @e: DRM event to deliver
 806  *
 807  * This function sends the event @e, initialized with drm_event_reserve_init(),
 808  * to its associated userspace DRM file. Callers must already hold
 809  * &drm_device.event_lock, see drm_send_event() for the unlocked version.
 810  *
 811  * Note that the core will take care of unlinking and disarming events when the
 812  * corresponding DRM file is closed. Drivers need not worry about whether the
 813  * DRM file for this event still exists and can call this function upon
 814  * completion of the asynchronous work unconditionally.
 815  */
 816 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 817 {
 818         drm_send_event_helper(dev, e, 0);
 819 }
 820 EXPORT_SYMBOL(drm_send_event_locked);
 821
 822 /**
 823  * drm_send_event - send DRM event to file descriptor
 824  * @dev: DRM device
 825  * @e: DRM event to deliver
 826  *
 827  * This function sends the event @e, initialized with drm_event_reserve_init(),
 828  * to its associated userspace DRM file. This function acquires
 829  * &drm_device.event_lock, see drm_send_event_locked() for callers which already
 830  * hold this lock.
 831  *
 832  * Note that the core will take care of unlinking and disarming events when the
 833  * corresponding DRM file is closed. Drivers need not worry about whether the
 834  * DRM file for this event still exists and can call this function upon
 835  * completion of the asynchronous work unconditionally.
 836  */
 837 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 838 {
 839         unsigned long irqflags;
 840
 841         spin_lock_irqsave(&dev->event_lock, irqflags);
 842         drm_send_event_helper(dev, e, 0);
 843         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 844 }
 845 EXPORT_SYMBOL(drm_send_event);
 846
 847 static void print_size(struct drm_printer *p, const char *stat,
 848                        const char *region, u64 sz)
 849 {
 850         const char *units[] = {"", " KiB", " MiB"};
 851         unsigned u;
 852
 853         for (u = 0; u < ARRAY_SIZE(units) - 1; u++) {
 854                 if (sz == 0 || !IS_ALIGNED(sz, SZ_1K))
 855                         break;
 856                 sz = div_u64(sz, SZ_1K);
 857         }
 858
 859         drm_printf(p, "drm-%s-%s:\t%llu%s\n", stat, region, sz, units[u]);
 860 }
 861
 862 /**
 863  * drm_print_memory_stats - A helper to print memory stats
 864  * @p: The printer to print output to
 865  * @stats: The collected memory stats
 866  * @supported_status: Bitmask of optional stats which are available
 867  * @region: The memory region
 868  *
 869  */
 870 void drm_print_memory_stats(struct drm_printer *p,
 871                             const struct drm_memory_stats *stats,
 872                             enum drm_gem_object_status supported_status,
 873                             const char *region)
 874 {
 875         print_size(p, "total", region, stats->private + stats->shared);
 876         print_size(p, "shared", region, stats->shared);
 877         print_size(p, "active", region, stats->active);
 878
 879         if (supported_status & DRM_GEM_OBJECT_RESIDENT)
 880                 print_size(p, "resident", region, stats->resident);
 881
 882         if (supported_status & DRM_GEM_OBJECT_PURGEABLE)
 883                 print_size(p, "purgeable", region, stats->purgeable);
 884 }
 885 EXPORT_SYMBOL(drm_print_memory_stats);
 886
 887 /**
 888  * drm_show_memory_stats - Helper to collect and show standard fdinfo memory stats
 889  * @p: the printer to print output to
 890  * @file: the DRM file
 891  *
 892  * Helper to iterate over GEM objects with a handle allocated in the specified
 893  * file.
 894  */
 895 void drm_show_memory_stats(struct drm_printer *p, struct drm_file *file)
 896 {
 897         struct drm_gem_object *obj;
 898         struct drm_memory_stats status = {};
 899         enum drm_gem_object_status supported_status = 0;
 900         int id;
 901
 902         spin_lock(&file->table_lock);
 903         idr_for_each_entry (&file->object_idr, obj, id) {
 904                 enum drm_gem_object_status s = 0;
 905                 size_t add_size = (obj->funcs && obj->funcs->rss) ?
 906                         obj->funcs->rss(obj) : obj->size;
 907
 908                 if (obj->funcs && obj->funcs->status) {
 909                         s = obj->funcs->status(obj);
 910                         supported_status = DRM_GEM_OBJECT_RESIDENT |
 911                                         DRM_GEM_OBJECT_PURGEABLE;
 912                 }
 913
 914                 if (drm_gem_object_is_shared_for_memory_stats(obj)) {
 915                         status.shared += obj->size;
 916                 } else {
 917                         status.private += obj->size;
 918                 }
 919
 920                 if (s & DRM_GEM_OBJECT_RESIDENT) {
 921                         status.resident += add_size;
 922                 } else {
 923                         /* If already purged or not yet backed by pages, don't
 924                          * count it as purgeable:
 925                          */
 926                         s &= ~DRM_GEM_OBJECT_PURGEABLE;
 927                 }
 928
 929                 if (!dma_resv_test_signaled(obj->resv, dma_resv_usage_rw(true))) {
 930                         status.active += add_size;
 931
 932                         /* If still active, don't count as purgeable: */
 933                         s &= ~DRM_GEM_OBJECT_PURGEABLE;
 934                 }
 935
 936                 if (s & DRM_GEM_OBJECT_PURGEABLE)
 937                         status.purgeable += add_size;
 938         }
 939         spin_unlock(&file->table_lock);
 940
 941         drm_print_memory_stats(p, &status, supported_status, "memory");
 942 }
 943 EXPORT_SYMBOL(drm_show_memory_stats);
 944
 945 /**
 946  * drm_show_fdinfo - helper for drm file fops
 947  * @m: output stream
 948  * @f: the device file instance
 949  *
 950  * Helper to implement fdinfo, for userspace to query usage stats, etc, of a
 951  * process using the GPU.  See also &drm_driver.show_fdinfo.
 952  *
 953  * For text output format description please see Documentation/gpu/drm-usage-stats.rst
 954  */
 955 void drm_show_fdinfo(struct seq_file *m, struct file *f)
 956 {
 957         struct drm_file *file = f->private_data;
 958         struct drm_device *dev = file->minor->dev;
 959         struct drm_printer p = drm_seq_file_printer(m);
 960
 961         drm_printf(&p, "drm-driver:\t%s\n", dev->driver->name);
 962         drm_printf(&p, "drm-client-id:\t%llu\n", file->client_id);
 963
 964         if (dev_is_pci(dev->dev)) {
 965                 struct pci_dev *pdev = to_pci_dev(dev->dev);
 966
 967                 drm_printf(&p, "drm-pdev:\t%04x:%02x:%02x.%d\n",
 968                            pci_domain_nr(pdev->bus), pdev->bus->number,
 969                            PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn));
 970         }
 971
 972         if (dev->driver->show_fdinfo)
 973                 dev->driver->show_fdinfo(&p, file);
 974 }
 975 EXPORT_SYMBOL(drm_show_fdinfo);
 976
 977 /**
 978  * mock_drm_getfile - Create a new struct file for the drm device
 979  * @minor: drm minor to wrap (e.g. #drm_device.primary)
 980  * @flags: file creation mode (O_RDWR etc)
 981  *
 982  * This create a new struct file that wraps a DRM file context around a
 983  * DRM minor. This mimicks userspace opening e.g. /dev/dri/card0, but without
 984  * invoking userspace. The struct file may be operated on using its f_op
 985  * (the drm_device.driver.fops) to mimick userspace operations, or be supplied
 986  * to userspace facing functions as an internal/anonymous client.
 987  *
 988  * RETURNS:
 989  * Pointer to newly created struct file, ERR_PTR on failure.
 990  */
 991 struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags)
 992 {
 993         struct drm_device *dev = minor->dev;
 994         struct drm_file *priv;
 995         struct file *file;
 996
 997         priv = drm_file_alloc(minor);
 998         if (IS_ERR(priv))
 999                 return ERR_CAST(priv);
1000
1001         file = anon_inode_getfile("drm", dev->driver->fops, priv, flags);
1002         if (IS_ERR(file)) {
1003                 drm_file_free(priv);
1004                 return file;
1005         }
1006
1007         /* Everyone shares a single global address space */
1008         file->f_mapping = dev->anon_inode->i_mapping;
1009
1010         drm_dev_get(dev);
1011         priv->filp = file;
1012
1013         return file;
1014 }
1015 EXPORT_SYMBOL_FOR_TESTS_ONLY(mock_drm_getfile);