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