drivers/gpu/drm/drm_fops.c

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