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