drivers/gpu/drm/drm_fops.c

   1 /**
   2  * \file drm_fops.c
   3  * File operations for DRM
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Daryll Strauss <daryll@valinux.com>
   7  * \author Gareth Hughes <gareth@valinux.com>
   8  */
   9
  10 /*
  11  * Created: Mon Jan  4 08:58:31 1999 by faith@valinux.com
  12  *
  13  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  14  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  15  * All Rights Reserved.
  16  *
  17  * Permission is hereby granted, free of charge, to any person obtaining a
  18  * copy of this software and associated documentation files (the "Software"),
  19  * to deal in the Software without restriction, including without limitation
  20  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  21  * and/or sell copies of the Software, and to permit persons to whom the
  22  * Software is furnished to do so, subject to the following conditions:
  23  *
  24  * The above copyright notice and this permission notice (including the next
  25  * paragraph) shall be included in all copies or substantial portions of the
  26  * Software.
  27  *
  28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  29  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  30  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  31  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  32  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  33  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  34  * OTHER DEALINGS IN THE SOFTWARE.
  35  */
  36
  37 #include <drm/drmP.h>
  38 #include <linux/poll.h>
  39 #include <linux/slab.h>
  40 #include <linux/module.h>
  41
  42 /* from BKL pushdown */
  43 DEFINE_MUTEX(drm_global_mutex);
  44 EXPORT_SYMBOL(drm_global_mutex);
  45
  46 static int drm_open_helper(struct file *filp, struct drm_minor *minor);
  47
  48 static int drm_setup(struct drm_device * dev)
  49 {
  50         int ret;
  51
  52         if (dev->driver->firstopen &&
  53             !drm_core_check_feature(dev, DRIVER_MODESET)) {
  54                 ret = dev->driver->firstopen(dev);
  55                 if (ret != 0)
  56                         return ret;
  57         }
  58
  59         ret = drm_legacy_dma_setup(dev);
  60         if (ret < 0)
  61                 return ret;
  62
  63
  64         DRM_DEBUG("\n");
  65         return 0;
  66 }
  67
  68 /**
  69  * Open file.
  70  *
  71  * \param inode device inode
  72  * \param filp file pointer.
  73  * \return zero on success or a negative number on failure.
  74  *
  75  * Searches the DRM device with the same minor number, calls open_helper(), and
  76  * increments the device open count. If the open count was previous at zero,
  77  * i.e., it's the first that the device is open, then calls setup().
  78  */
  79 int drm_open(struct inode *inode, struct file *filp)
  80 {
  81         struct drm_device *dev;
  82         struct drm_minor *minor;
  83         int retcode;
  84         int need_setup = 0;
  85
  86         minor = drm_minor_acquire(iminor(inode));
  87         if (IS_ERR(minor))
  88                 return PTR_ERR(minor);
  89
  90         dev = minor->dev;
  91         if (!dev->open_count++)
  92                 need_setup = 1;
  93
  94         /* share address_space across all char-devs of a single device */
  95         filp->f_mapping = dev->anon_inode->i_mapping;
  96
  97         retcode = drm_open_helper(filp, minor);
  98         if (retcode)
  99                 goto err_undo;
 100         if (need_setup) {
 101                 retcode = drm_setup(dev);
 102                 if (retcode)
 103                         goto err_undo;
 104         }
 105         return 0;
 106
 107 err_undo:
 108         dev->open_count--;
 109         drm_minor_release(minor);
 110         return retcode;
 111 }
 112 EXPORT_SYMBOL(drm_open);
 113
 114 /**
 115  * File \c open operation.
 116  *
 117  * \param inode device inode.
 118  * \param filp file pointer.
 119  *
 120  * Puts the dev->fops corresponding to the device minor number into
 121  * \p filp, call the \c open method, and restore the file operations.
 122  */
 123 int drm_stub_open(struct inode *inode, struct file *filp)
 124 {
 125         struct drm_device *dev;
 126         struct drm_minor *minor;
 127         int err = -ENODEV;
 128         const struct file_operations *new_fops;
 129
 130         DRM_DEBUG("\n");
 131
 132         mutex_lock(&drm_global_mutex);
 133         minor = drm_minor_acquire(iminor(inode));
 134         if (IS_ERR(minor))
 135                 goto out_unlock;
 136
 137         dev = minor->dev;
 138         new_fops = fops_get(dev->driver->fops);
 139         if (!new_fops)
 140                 goto out_release;
 141
 142         replace_fops(filp, new_fops);
 143         if (filp->f_op->open)
 144                 err = filp->f_op->open(inode, filp);
 145
 146 out_release:
 147         drm_minor_release(minor);
 148 out_unlock:
 149         mutex_unlock(&drm_global_mutex);
 150         return err;
 151 }
 152
 153 /**
 154  * Check whether DRI will run on this CPU.
 155  *
 156  * \return non-zero if the DRI will run on this CPU, or zero otherwise.
 157  */
 158 static int drm_cpu_valid(void)
 159 {
 160 #if defined(__sparc__) && !defined(__sparc_v9__)
 161         return 0;               /* No cmpxchg before v9 sparc. */
 162 #endif
 163         return 1;
 164 }
 165
 166 /**
 167  * Called whenever a process opens /dev/drm.
 168  *
 169  * \param filp file pointer.
 170  * \param minor acquired minor-object.
 171  * \return zero on success or a negative number on failure.
 172  *
 173  * Creates and initializes a drm_file structure for the file private data in \p
 174  * filp and add it into the double linked list in \p dev.
 175  */
 176 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
 177 {
 178         struct drm_device *dev = minor->dev;
 179         struct drm_file *priv;
 180         int ret;
 181
 182         if (filp->f_flags & O_EXCL)
 183                 return -EBUSY;  /* No exclusive opens */
 184         if (!drm_cpu_valid())
 185                 return -EINVAL;
 186         if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 187                 return -EINVAL;
 188
 189         DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
 190
 191         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 192         if (!priv)
 193                 return -ENOMEM;
 194
 195         filp->private_data = priv;
 196         priv->filp = filp;
 197         priv->uid = current_euid();
 198         priv->pid = get_pid(task_pid(current));
 199         priv->minor = minor;
 200
 201         /* for compatibility root is always authenticated */
 202         priv->always_authenticated = capable(CAP_SYS_ADMIN);
 203         priv->authenticated = priv->always_authenticated;
 204         priv->lock_count = 0;
 205
 206         INIT_LIST_HEAD(&priv->lhead);
 207         INIT_LIST_HEAD(&priv->fbs);
 208         mutex_init(&priv->fbs_lock);
 209         INIT_LIST_HEAD(&priv->event_list);
 210         init_waitqueue_head(&priv->event_wait);
 211         priv->event_space = 4096; /* set aside 4k for event buffer */
 212
 213         if (dev->driver->driver_features & DRIVER_GEM)
 214                 drm_gem_open(dev, priv);
 215
 216         if (drm_core_check_feature(dev, DRIVER_PRIME))
 217                 drm_prime_init_file_private(&priv->prime);
 218
 219         if (dev->driver->open) {
 220                 ret = dev->driver->open(dev, priv);
 221                 if (ret < 0)
 222                         goto out_prime_destroy;
 223         }
 224
 225         /* if there is no current master make this fd it, but do not create
 226          * any master object for render clients */
 227         mutex_lock(&dev->master_mutex);
 228         if (drm_is_primary_client(priv) && !priv->minor->master) {
 229                 /* create a new master */
 230                 priv->minor->master = drm_master_create(priv->minor);
 231                 if (!priv->minor->master) {
 232                         ret = -ENOMEM;
 233                         goto out_close;
 234                 }
 235
 236                 /* take another reference for the copy in the local file priv */
 237                 priv->master = drm_master_get(priv->minor->master);
 238                 priv->authenticated = 1;
 239
 240                 if (dev->driver->master_create) {
 241                         ret = dev->driver->master_create(dev, priv->master);
 242                         if (ret) {
 243                                 /* drop both references if this fails */
 244                                 drm_master_put(&priv->minor->master);
 245                                 drm_master_put(&priv->master);
 246                                 goto out_close;
 247                         }
 248                 }
 249                 if (dev->driver->master_set) {
 250                         ret = dev->driver->master_set(dev, priv, true);
 251                         if (ret) {
 252                                 /* drop both references if this fails */
 253                                 drm_master_put(&priv->minor->master);
 254                                 drm_master_put(&priv->master);
 255                                 goto out_close;
 256                         }
 257                 }
 258         } else if (drm_is_primary_client(priv)) {
 259                 /* get a reference to the master */
 260                 priv->master = drm_master_get(priv->minor->master);
 261         }
 262         mutex_unlock(&dev->master_mutex);
 263
 264         mutex_lock(&dev->struct_mutex);
 265         list_add(&priv->lhead, &dev->filelist);
 266         mutex_unlock(&dev->struct_mutex);
 267
 268 #ifdef __alpha__
 269         /*
 270          * Default the hose
 271          */
 272         if (!dev->hose) {
 273                 struct pci_dev *pci_dev;
 274                 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
 275                 if (pci_dev) {
 276                         dev->hose = pci_dev->sysdata;
 277                         pci_dev_put(pci_dev);
 278                 }
 279                 if (!dev->hose) {
 280                         struct pci_bus *b = list_entry(pci_root_buses.next,
 281                                 struct pci_bus, node);
 282                         if (b)
 283                                 dev->hose = b->sysdata;
 284                 }
 285         }
 286 #endif
 287
 288         return 0;
 289
 290 out_close:
 291         mutex_unlock(&dev->master_mutex);
 292         if (dev->driver->postclose)
 293                 dev->driver->postclose(dev, priv);
 294 out_prime_destroy:
 295         if (drm_core_check_feature(dev, DRIVER_PRIME))
 296                 drm_prime_destroy_file_private(&priv->prime);
 297         if (dev->driver->driver_features & DRIVER_GEM)
 298                 drm_gem_release(dev, priv);
 299         put_pid(priv->pid);
 300         kfree(priv);
 301         filp->private_data = NULL;
 302         return ret;
 303 }
 304
 305 static void drm_master_release(struct drm_device *dev, struct file *filp)
 306 {
 307         struct drm_file *file_priv = filp->private_data;
 308
 309         if (drm_i_have_hw_lock(dev, file_priv)) {
 310                 DRM_DEBUG("File %p released, freeing lock for context %d\n",
 311                           filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
 312                 drm_lock_free(&file_priv->master->lock,
 313                               _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
 314         }
 315 }
 316
 317 static void drm_events_release(struct drm_file *file_priv)
 318 {
 319         struct drm_device *dev = file_priv->minor->dev;
 320         struct drm_pending_event *e, *et;
 321         struct drm_pending_vblank_event *v, *vt;
 322         unsigned long flags;
 323
 324         spin_lock_irqsave(&dev->event_lock, flags);
 325
 326         /* Remove pending flips */
 327         list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
 328                 if (v->base.file_priv == file_priv) {
 329                         list_del(&v->base.link);
 330                         drm_vblank_put(dev, v->pipe);
 331                         v->base.destroy(&v->base);
 332                 }
 333
 334         /* Remove unconsumed events */
 335         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 336                 list_del(&e->link);
 337                 e->destroy(e);
 338         }
 339
 340         spin_unlock_irqrestore(&dev->event_lock, flags);
 341 }
 342
 343 /**
 344  * drm_legacy_dev_reinit
 345  *
 346  * Reinitializes a legacy/ums drm device in it's lastclose function.
 347  */
 348 static void drm_legacy_dev_reinit(struct drm_device *dev)
 349 {
 350         if (drm_core_check_feature(dev, DRIVER_MODESET))
 351                 return;
 352
 353         dev->sigdata.lock = NULL;
 354
 355         dev->context_flag = 0;
 356         dev->last_context = 0;
 357         dev->if_version = 0;
 358 }
 359
 360 /**
 361  * Take down the DRM device.
 362  *
 363  * \param dev DRM device structure.
 364  *
 365  * Frees every resource in \p dev.
 366  *
 367  * \sa drm_device
 368  */
 369 int drm_lastclose(struct drm_device * dev)
 370 {
 371         struct drm_vma_entry *vma, *vma_temp;
 372
 373         DRM_DEBUG("\n");
 374
 375         if (dev->driver->lastclose)
 376                 dev->driver->lastclose(dev);
 377         DRM_DEBUG("driver lastclose completed\n");
 378
 379         if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
 380                 drm_irq_uninstall(dev);
 381
 382         mutex_lock(&dev->struct_mutex);
 383
 384         drm_agp_clear(dev);
 385
 386         drm_legacy_sg_cleanup(dev);
 387
 388         /* Clear vma list (only built for debugging) */
 389         list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
 390                 list_del(&vma->head);
 391                 kfree(vma);
 392         }
 393
 394         drm_legacy_dma_takedown(dev);
 395
 396         mutex_unlock(&dev->struct_mutex);
 397
 398         drm_legacy_dev_reinit(dev);
 399
 400         DRM_DEBUG("lastclose completed\n");
 401         return 0;
 402 }
 403
 404 /**
 405  * Release file.
 406  *
 407  * \param inode device inode
 408  * \param file_priv DRM file private.
 409  * \return zero on success or a negative number on failure.
 410  *
 411  * If the hardware lock is held then free it, and take it again for the kernel
 412  * context since it's necessary to reclaim buffers. Unlink the file private
 413  * data from its list and free it. Decreases the open count and if it reaches
 414  * zero calls drm_lastclose().
 415  */
 416 int drm_release(struct inode *inode, struct file *filp)
 417 {
 418         struct drm_file *file_priv = filp->private_data;
 419         struct drm_minor *minor = file_priv->minor;
 420         struct drm_device *dev = minor->dev;
 421         int retcode = 0;
 422
 423         mutex_lock(&drm_global_mutex);
 424
 425         DRM_DEBUG("open_count = %d\n", dev->open_count);
 426
 427         if (dev->driver->preclose)
 428                 dev->driver->preclose(dev, file_priv);
 429
 430         /* ========================================================
 431          * Begin inline drm_release
 432          */
 433
 434         DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
 435                   task_pid_nr(current),
 436                   (long)old_encode_dev(file_priv->minor->kdev->devt),
 437                   dev->open_count);
 438
 439         /* Release any auth tokens that might point to this file_priv,
 440            (do that under the drm_global_mutex) */
 441         if (file_priv->magic)
 442                 (void) drm_remove_magic(file_priv->master, file_priv->magic);
 443
 444         /* if the master has gone away we can't do anything with the lock */
 445         if (file_priv->minor->master)
 446                 drm_master_release(dev, filp);
 447
 448         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 449                 drm_core_reclaim_buffers(dev, file_priv);
 450
 451         drm_events_release(file_priv);
 452
 453         if (dev->driver->driver_features & DRIVER_MODESET)
 454                 drm_fb_release(file_priv);
 455
 456         if (dev->driver->driver_features & DRIVER_GEM)
 457                 drm_gem_release(dev, file_priv);
 458
 459         drm_ctxbitmap_flush(dev, file_priv);
 460
 461         mutex_lock(&dev->master_mutex);
 462
 463         if (drm_is_master(file_priv)) {
 464                 struct drm_master *master = file_priv->master;
 465                 struct drm_file *temp;
 466
 467                 mutex_lock(&dev->struct_mutex);
 468                 list_for_each_entry(temp, &dev->filelist, lhead) {
 469                         if ((temp->master == file_priv->master) &&
 470                             (temp != file_priv))
 471                                 temp->authenticated = temp->always_authenticated;
 472                 }
 473
 474                 /**
 475                  * Since the master is disappearing, so is the
 476                  * possibility to lock.
 477                  */
 478
 479                 if (master->lock.hw_lock) {
 480                         if (dev->sigdata.lock == master->lock.hw_lock)
 481                                 dev->sigdata.lock = NULL;
 482                         master->lock.hw_lock = NULL;
 483                         master->lock.file_priv = NULL;
 484                         wake_up_interruptible_all(&master->lock.lock_queue);
 485                 }
 486                 mutex_unlock(&dev->struct_mutex);
 487
 488                 if (file_priv->minor->master == file_priv->master) {
 489                         /* drop the reference held my the minor */
 490                         if (dev->driver->master_drop)
 491                                 dev->driver->master_drop(dev, file_priv, true);
 492                         drm_master_put(&file_priv->minor->master);
 493                 }
 494         }
 495
 496         /* drop the master reference held by the file priv */
 497         if (file_priv->master)
 498                 drm_master_put(&file_priv->master);
 499         mutex_unlock(&dev->master_mutex);
 500
 501         mutex_lock(&dev->struct_mutex);
 502         list_del(&file_priv->lhead);
 503         mutex_unlock(&dev->struct_mutex);
 504
 505         if (dev->driver->postclose)
 506                 dev->driver->postclose(dev, file_priv);
 507
 508
 509         if (drm_core_check_feature(dev, DRIVER_PRIME))
 510                 drm_prime_destroy_file_private(&file_priv->prime);
 511
 512         put_pid(file_priv->pid);
 513         kfree(file_priv);
 514
 515         /* ========================================================
 516          * End inline drm_release
 517          */
 518
 519         if (!--dev->open_count) {
 520                 retcode = drm_lastclose(dev);
 521                 if (drm_device_is_unplugged(dev))
 522                         drm_put_dev(dev);
 523         }
 524         mutex_unlock(&drm_global_mutex);
 525
 526         drm_minor_release(minor);
 527
 528         return retcode;
 529 }
 530 EXPORT_SYMBOL(drm_release);
 531
 532 static bool
 533 drm_dequeue_event(struct drm_file *file_priv,
 534                   size_t total, size_t max, struct drm_pending_event **out)
 535 {
 536         struct drm_device *dev = file_priv->minor->dev;
 537         struct drm_pending_event *e;
 538         unsigned long flags;
 539         bool ret = false;
 540
 541         spin_lock_irqsave(&dev->event_lock, flags);
 542
 543         *out = NULL;
 544         if (list_empty(&file_priv->event_list))
 545                 goto out;
 546         e = list_first_entry(&file_priv->event_list,
 547                              struct drm_pending_event, link);
 548         if (e->event->length + total > max)
 549                 goto out;
 550
 551         file_priv->event_space += e->event->length;
 552         list_del(&e->link);
 553         *out = e;
 554         ret = true;
 555
 556 out:
 557         spin_unlock_irqrestore(&dev->event_lock, flags);
 558         return ret;
 559 }
 560
 561 ssize_t drm_read(struct file *filp, char __user *buffer,
 562                  size_t count, loff_t *offset)
 563 {
 564         struct drm_file *file_priv = filp->private_data;
 565         struct drm_pending_event *e;
 566         size_t total;
 567         ssize_t ret;
 568
 569         ret = wait_event_interruptible(file_priv->event_wait,
 570                                        !list_empty(&file_priv->event_list));
 571         if (ret < 0)
 572                 return ret;
 573
 574         total = 0;
 575         while (drm_dequeue_event(file_priv, total, count, &e)) {
 576                 if (copy_to_user(buffer + total,
 577                                  e->event, e->event->length)) {
 578                         total = -EFAULT;
 579                         break;
 580                 }
 581
 582                 total += e->event->length;
 583                 e->destroy(e);
 584         }
 585
 586         return total;
 587 }
 588 EXPORT_SYMBOL(drm_read);
 589
 590 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
 591 {
 592         struct drm_file *file_priv = filp->private_data;
 593         unsigned int mask = 0;
 594
 595         poll_wait(filp, &file_priv->event_wait, wait);
 596
 597         if (!list_empty(&file_priv->event_list))
 598                 mask |= POLLIN | POLLRDNORM;
 599
 600         return mask;
 601 }
 602 EXPORT_SYMBOL(drm_poll);