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