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