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         /* for compatibility root is always authenticated */
 236         priv->always_authenticated = capable(CAP_SYS_ADMIN);
 237         priv->authenticated = priv->always_authenticated;
 238         priv->lock_count = 0;
 239
 240         INIT_LIST_HEAD(&priv->lhead);
 241         INIT_LIST_HEAD(&priv->fbs);
 242         mutex_init(&priv->fbs_lock);
 243         INIT_LIST_HEAD(&priv->event_list);
 244         init_waitqueue_head(&priv->event_wait);
 245         priv->event_space = 4096; /* set aside 4k for event buffer */
 246
 247         if (dev->driver->driver_features & DRIVER_GEM)
 248                 drm_gem_open(dev, priv);
 249
 250         if (drm_core_check_feature(dev, DRIVER_PRIME))
 251                 drm_prime_init_file_private(&priv->prime);
 252
 253         if (dev->driver->open) {
 254                 ret = dev->driver->open(dev, priv);
 255                 if (ret < 0)
 256                         goto out_prime_destroy;
 257         }
 258
 259         /* if there is no current master make this fd it, but do not create
 260          * any master object for render clients */
 261         mutex_lock(&dev->struct_mutex);
 262         if (!priv->minor->master && !drm_is_render_client(priv)) {
 263                 /* create a new master */
 264                 priv->minor->master = drm_master_create(priv->minor);
 265                 if (!priv->minor->master) {
 266                         mutex_unlock(&dev->struct_mutex);
 267                         ret = -ENOMEM;
 268                         goto out_close;
 269                 }
 270
 271                 priv->is_master = 1;
 272                 /* take another reference for the copy in the local file priv */
 273                 priv->master = drm_master_get(priv->minor->master);
 274
 275                 priv->authenticated = 1;
 276
 277                 mutex_unlock(&dev->struct_mutex);
 278                 if (dev->driver->master_create) {
 279                         ret = dev->driver->master_create(dev, priv->master);
 280                         if (ret) {
 281                                 mutex_lock(&dev->struct_mutex);
 282                                 /* drop both references if this fails */
 283                                 drm_master_put(&priv->minor->master);
 284                                 drm_master_put(&priv->master);
 285                                 mutex_unlock(&dev->struct_mutex);
 286                                 goto out_close;
 287                         }
 288                 }
 289                 mutex_lock(&dev->struct_mutex);
 290                 if (dev->driver->master_set) {
 291                         ret = dev->driver->master_set(dev, priv, true);
 292                         if (ret) {
 293                                 /* drop both references if this fails */
 294                                 drm_master_put(&priv->minor->master);
 295                                 drm_master_put(&priv->master);
 296                                 mutex_unlock(&dev->struct_mutex);
 297                                 goto out_close;
 298                         }
 299                 }
 300         } else if (!drm_is_render_client(priv)) {
 301                 /* get a reference to the master */
 302                 priv->master = drm_master_get(priv->minor->master);
 303         }
 304         mutex_unlock(&dev->struct_mutex);
 305
 306         mutex_lock(&dev->struct_mutex);
 307         list_add(&priv->lhead, &dev->filelist);
 308         mutex_unlock(&dev->struct_mutex);
 309
 310 #ifdef __alpha__
 311         /*
 312          * Default the hose
 313          */
 314         if (!dev->hose) {
 315                 struct pci_dev *pci_dev;
 316                 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
 317                 if (pci_dev) {
 318                         dev->hose = pci_dev->sysdata;
 319                         pci_dev_put(pci_dev);
 320                 }
 321                 if (!dev->hose) {
 322                         struct pci_bus *b = pci_bus_b(pci_root_buses.next);
 323                         if (b)
 324                                 dev->hose = b->sysdata;
 325                 }
 326         }
 327 #endif
 328
 329         return 0;
 330
 331 out_close:
 332         if (dev->driver->postclose)
 333                 dev->driver->postclose(dev, priv);
 334 out_prime_destroy:
 335         if (drm_core_check_feature(dev, DRIVER_PRIME))
 336                 drm_prime_destroy_file_private(&priv->prime);
 337         if (dev->driver->driver_features & DRIVER_GEM)
 338                 drm_gem_release(dev, priv);
 339 out_put_pid:
 340         put_pid(priv->pid);
 341         kfree(priv);
 342         filp->private_data = NULL;
 343         return ret;
 344 }
 345
 346 static void drm_master_release(struct drm_device *dev, struct file *filp)
 347 {
 348         struct drm_file *file_priv = filp->private_data;
 349
 350         if (drm_i_have_hw_lock(dev, file_priv)) {
 351                 DRM_DEBUG("File %p released, freeing lock for context %d\n",
 352                           filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
 353                 drm_lock_free(&file_priv->master->lock,
 354                               _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
 355         }
 356 }
 357
 358 static void drm_events_release(struct drm_file *file_priv)
 359 {
 360         struct drm_device *dev = file_priv->minor->dev;
 361         struct drm_pending_event *e, *et;
 362         struct drm_pending_vblank_event *v, *vt;
 363         unsigned long flags;
 364
 365         spin_lock_irqsave(&dev->event_lock, flags);
 366
 367         /* Remove pending flips */
 368         list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
 369                 if (v->base.file_priv == file_priv) {
 370                         list_del(&v->base.link);
 371                         drm_vblank_put(dev, v->pipe);
 372                         v->base.destroy(&v->base);
 373                 }
 374
 375         /* Remove unconsumed events */
 376         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 377                 list_del(&e->link);
 378                 e->destroy(e);
 379         }
 380
 381         spin_unlock_irqrestore(&dev->event_lock, flags);
 382 }
 383
 384 /**
 385  * drm_legacy_dev_reinit
 386  *
 387  * Reinitializes a legacy/ums drm device in it's lastclose function.
 388  */
 389 static void drm_legacy_dev_reinit(struct drm_device *dev)
 390 {
 391         if (drm_core_check_feature(dev, DRIVER_MODESET))
 392                 return;
 393
 394         dev->sigdata.lock = NULL;
 395
 396         dev->context_flag = 0;
 397         dev->last_context = 0;
 398         dev->if_version = 0;
 399 }
 400
 401 /**
 402  * Take down the DRM device.
 403  *
 404  * \param dev DRM device structure.
 405  *
 406  * Frees every resource in \p dev.
 407  *
 408  * \sa drm_device
 409  */
 410 int drm_lastclose(struct drm_device * dev)
 411 {
 412         struct drm_vma_entry *vma, *vma_temp;
 413
 414         DRM_DEBUG("\n");
 415
 416         if (dev->driver->lastclose)
 417                 dev->driver->lastclose(dev);
 418         DRM_DEBUG("driver lastclose completed\n");
 419
 420         if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
 421                 drm_irq_uninstall(dev);
 422
 423         mutex_lock(&dev->struct_mutex);
 424
 425         drm_agp_clear(dev);
 426
 427         drm_legacy_sg_cleanup(dev);
 428
 429         /* Clear vma list (only built for debugging) */
 430         list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
 431                 list_del(&vma->head);
 432                 kfree(vma);
 433         }
 434
 435         drm_legacy_dma_takedown(dev);
 436
 437         dev->dev_mapping = NULL;
 438         mutex_unlock(&dev->struct_mutex);
 439
 440         drm_legacy_dev_reinit(dev);
 441
 442         DRM_DEBUG("lastclose completed\n");
 443         return 0;
 444 }
 445
 446 /**
 447  * Release file.
 448  *
 449  * \param inode device inode
 450  * \param file_priv DRM file private.
 451  * \return zero on success or a negative number on failure.
 452  *
 453  * If the hardware lock is held then free it, and take it again for the kernel
 454  * context since it's necessary to reclaim buffers. Unlink the file private
 455  * data from its list and free it. Decreases the open count and if it reaches
 456  * zero calls drm_lastclose().
 457  */
 458 int drm_release(struct inode *inode, struct file *filp)
 459 {
 460         struct drm_file *file_priv = filp->private_data;
 461         struct drm_device *dev = file_priv->minor->dev;
 462         int retcode = 0;
 463
 464         mutex_lock(&drm_global_mutex);
 465
 466         DRM_DEBUG("open_count = %d\n", dev->open_count);
 467
 468         if (dev->driver->preclose)
 469                 dev->driver->preclose(dev, file_priv);
 470
 471         /* ========================================================
 472          * Begin inline drm_release
 473          */
 474
 475         DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
 476                   task_pid_nr(current),
 477                   (long)old_encode_dev(file_priv->minor->device),
 478                   dev->open_count);
 479
 480         /* Release any auth tokens that might point to this file_priv,
 481            (do that under the drm_global_mutex) */
 482         if (file_priv->magic)
 483                 (void) drm_remove_magic(file_priv->master, file_priv->magic);
 484
 485         /* if the master has gone away we can't do anything with the lock */
 486         if (file_priv->minor->master)
 487                 drm_master_release(dev, filp);
 488
 489         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 490                 drm_core_reclaim_buffers(dev, file_priv);
 491
 492         drm_events_release(file_priv);
 493
 494         if (dev->driver->driver_features & DRIVER_MODESET)
 495                 drm_fb_release(file_priv);
 496
 497         if (dev->driver->driver_features & DRIVER_GEM)
 498                 drm_gem_release(dev, file_priv);
 499
 500         mutex_lock(&dev->ctxlist_mutex);
 501         if (!list_empty(&dev->ctxlist)) {
 502                 struct drm_ctx_list *pos, *n;
 503
 504                 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
 505                         if (pos->tag == file_priv &&
 506                             pos->handle != DRM_KERNEL_CONTEXT) {
 507                                 if (dev->driver->context_dtor)
 508                                         dev->driver->context_dtor(dev,
 509                                                                   pos->handle);
 510
 511                                 drm_ctxbitmap_free(dev, pos->handle);
 512
 513                                 list_del(&pos->head);
 514                                 kfree(pos);
 515                         }
 516                 }
 517         }
 518         mutex_unlock(&dev->ctxlist_mutex);
 519
 520         mutex_lock(&dev->struct_mutex);
 521
 522         if (file_priv->is_master) {
 523                 struct drm_master *master = file_priv->master;
 524                 struct drm_file *temp;
 525                 list_for_each_entry(temp, &dev->filelist, lhead) {
 526                         if ((temp->master == file_priv->master) &&
 527                             (temp != file_priv))
 528                                 temp->authenticated = temp->always_authenticated;
 529                 }
 530
 531                 /**
 532                  * Since the master is disappearing, so is the
 533                  * possibility to lock.
 534                  */
 535
 536                 if (master->lock.hw_lock) {
 537                         if (dev->sigdata.lock == master->lock.hw_lock)
 538                                 dev->sigdata.lock = NULL;
 539                         master->lock.hw_lock = NULL;
 540                         master->lock.file_priv = NULL;
 541                         wake_up_interruptible_all(&master->lock.lock_queue);
 542                 }
 543
 544                 if (file_priv->minor->master == file_priv->master) {
 545                         /* drop the reference held my the minor */
 546                         if (dev->driver->master_drop)
 547                                 dev->driver->master_drop(dev, file_priv, true);
 548                         drm_master_put(&file_priv->minor->master);
 549                 }
 550         }
 551
 552         BUG_ON(dev->dev_mapping == NULL);
 553         iput(container_of(dev->dev_mapping, struct inode, i_data));
 554
 555         /* drop the reference held my the file priv */
 556         if (file_priv->master)
 557                 drm_master_put(&file_priv->master);
 558         file_priv->is_master = 0;
 559         list_del(&file_priv->lhead);
 560         mutex_unlock(&dev->struct_mutex);
 561
 562         if (dev->driver->postclose)
 563                 dev->driver->postclose(dev, file_priv);
 564
 565
 566         if (drm_core_check_feature(dev, DRIVER_PRIME))
 567                 drm_prime_destroy_file_private(&file_priv->prime);
 568
 569         put_pid(file_priv->pid);
 570         kfree(file_priv);
 571
 572         /* ========================================================
 573          * End inline drm_release
 574          */
 575
 576         if (!--dev->open_count) {
 577                 retcode = drm_lastclose(dev);
 578                 if (drm_device_is_unplugged(dev))
 579                         drm_put_dev(dev);
 580         }
 581         mutex_unlock(&drm_global_mutex);
 582
 583         return retcode;
 584 }
 585 EXPORT_SYMBOL(drm_release);
 586
 587 static bool
 588 drm_dequeue_event(struct drm_file *file_priv,
 589                   size_t total, size_t max, struct drm_pending_event **out)
 590 {
 591         struct drm_device *dev = file_priv->minor->dev;
 592         struct drm_pending_event *e;
 593         unsigned long flags;
 594         bool ret = false;
 595
 596         spin_lock_irqsave(&dev->event_lock, flags);
 597
 598         *out = NULL;
 599         if (list_empty(&file_priv->event_list))
 600                 goto out;
 601         e = list_first_entry(&file_priv->event_list,
 602                              struct drm_pending_event, link);
 603         if (e->event->length + total > max)
 604                 goto out;
 605
 606         file_priv->event_space += e->event->length;
 607         list_del(&e->link);
 608         *out = e;
 609         ret = true;
 610
 611 out:
 612         spin_unlock_irqrestore(&dev->event_lock, flags);
 613         return ret;
 614 }
 615
 616 ssize_t drm_read(struct file *filp, char __user *buffer,
 617                  size_t count, loff_t *offset)
 618 {
 619         struct drm_file *file_priv = filp->private_data;
 620         struct drm_pending_event *e;
 621         size_t total;
 622         ssize_t ret;
 623
 624         ret = wait_event_interruptible(file_priv->event_wait,
 625                                        !list_empty(&file_priv->event_list));
 626         if (ret < 0)
 627                 return ret;
 628
 629         total = 0;
 630         while (drm_dequeue_event(file_priv, total, count, &e)) {
 631                 if (copy_to_user(buffer + total,
 632                                  e->event, e->event->length)) {
 633                         total = -EFAULT;
 634                         break;
 635                 }
 636
 637                 total += e->event->length;
 638                 e->destroy(e);
 639         }
 640
 641         return total;
 642 }
 643 EXPORT_SYMBOL(drm_read);
 644
 645 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
 646 {
 647         struct drm_file *file_priv = filp->private_data;
 648         unsigned int mask = 0;
 649
 650         poll_wait(filp, &file_priv->event_wait, wait);
 651
 652         if (!list_empty(&file_priv->event_list))
 653                 mask |= POLLIN | POLLRDNORM;
 654
 655         return mask;
 656 }
 657 EXPORT_SYMBOL(drm_poll);