3 * File operations for DRM
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Daryll Strauss <daryll@valinux.com>
7 * \author Gareth Hughes <gareth@valinux.com>
11 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
13 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
14 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
15 * All Rights Reserved.
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:
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
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.
38 #include <linux/poll.h>
39 #include <linux/slab.h>
40 #include <linux/module.h>
42 /* from BKL pushdown: note that nothing else serializes idr_find() */
43 DEFINE_MUTEX(drm_global_mutex);
44 EXPORT_SYMBOL(drm_global_mutex);
46 static int drm_open_helper(struct inode *inode, struct file *filp,
47 struct drm_device * dev);
49 static int drm_setup(struct drm_device * dev)
54 if (dev->driver->firstopen) {
55 ret = dev->driver->firstopen(dev);
60 atomic_set(&dev->ioctl_count, 0);
61 atomic_set(&dev->vma_count, 0);
63 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
64 !drm_core_check_feature(dev, DRIVER_MODESET)) {
66 atomic_set(&dev->buf_alloc, 0);
68 i = drm_dma_setup(dev);
73 for (i = 0; i < ARRAY_SIZE(dev->counts); i++)
74 atomic_set(&dev->counts[i], 0);
76 dev->sigdata.lock = NULL;
79 dev->queue_reserved = 0;
81 dev->queuelist = NULL;
82 dev->context_flag = 0;
83 dev->interrupt_flag = 0;
85 dev->last_context = 0;
87 dev->last_checked = 0;
88 init_waitqueue_head(&dev->context_wait);
94 dev->buf_async = NULL;
95 init_waitqueue_head(&dev->buf_readers);
96 init_waitqueue_head(&dev->buf_writers);
101 * The kernel's context could be created here, but is now created
102 * in drm_dma_enqueue. This is more resource-efficient for
103 * hardware that does not do DMA, but may mean that
104 * drm_select_queue fails between the time the interrupt is
105 * initialized and the time the queues are initialized.
114 * \param inode device inode
115 * \param filp file pointer.
116 * \return zero on success or a negative number on failure.
118 * Searches the DRM device with the same minor number, calls open_helper(), and
119 * increments the device open count. If the open count was previous at zero,
120 * i.e., it's the first that the device is open, then calls setup().
122 int drm_open(struct inode *inode, struct file *filp)
124 struct drm_device *dev = NULL;
125 int minor_id = iminor(inode);
126 struct drm_minor *minor;
129 minor = idr_find(&drm_minors_idr, minor_id);
133 if (!(dev = minor->dev))
136 if (drm_device_is_unplugged(dev))
139 retcode = drm_open_helper(inode, filp, dev);
141 atomic_inc(&dev->counts[_DRM_STAT_OPENS]);
142 if (!dev->open_count++)
143 retcode = drm_setup(dev);
146 mutex_lock(&dev->struct_mutex);
147 if (minor->type == DRM_MINOR_LEGACY) {
148 if (dev->dev_mapping == NULL)
149 dev->dev_mapping = inode->i_mapping;
150 else if (dev->dev_mapping != inode->i_mapping)
153 mutex_unlock(&dev->struct_mutex);
158 EXPORT_SYMBOL(drm_open);
161 * File \c open operation.
163 * \param inode device inode.
164 * \param filp file pointer.
166 * Puts the dev->fops corresponding to the device minor number into
167 * \p filp, call the \c open method, and restore the file operations.
169 int drm_stub_open(struct inode *inode, struct file *filp)
171 struct drm_device *dev = NULL;
172 struct drm_minor *minor;
173 int minor_id = iminor(inode);
175 const struct file_operations *old_fops;
179 mutex_lock(&drm_global_mutex);
180 minor = idr_find(&drm_minors_idr, minor_id);
184 if (!(dev = minor->dev))
187 if (drm_device_is_unplugged(dev))
190 old_fops = filp->f_op;
191 filp->f_op = fops_get(dev->driver->fops);
192 if (filp->f_op == NULL) {
193 filp->f_op = old_fops;
196 if (filp->f_op->open && (err = filp->f_op->open(inode, filp))) {
197 fops_put(filp->f_op);
198 filp->f_op = fops_get(old_fops);
203 mutex_unlock(&drm_global_mutex);
208 * Check whether DRI will run on this CPU.
210 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
212 static int drm_cpu_valid(void)
214 #if defined(__i386__)
215 if (boot_cpu_data.x86 == 3)
216 return 0; /* No cmpxchg on a 386 */
218 #if defined(__sparc__) && !defined(__sparc_v9__)
219 return 0; /* No cmpxchg before v9 sparc. */
225 * Called whenever a process opens /dev/drm.
227 * \param inode device inode.
228 * \param filp file pointer.
230 * \return zero on success or a negative number on failure.
232 * Creates and initializes a drm_file structure for the file private data in \p
233 * filp and add it into the double linked list in \p dev.
235 static int drm_open_helper(struct inode *inode, struct file *filp,
236 struct drm_device * dev)
238 int minor_id = iminor(inode);
239 struct drm_file *priv;
242 if (filp->f_flags & O_EXCL)
243 return -EBUSY; /* No exclusive opens */
244 if (!drm_cpu_valid())
246 if (dev->switch_power_state != DRM_SWITCH_POWER_ON)
249 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor_id);
251 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
255 filp->private_data = priv;
257 priv->uid = current_euid();
258 priv->pid = task_pid_nr(current);
259 priv->minor = idr_find(&drm_minors_idr, minor_id);
260 priv->ioctl_count = 0;
261 /* for compatibility root is always authenticated */
262 priv->authenticated = capable(CAP_SYS_ADMIN);
263 priv->lock_count = 0;
265 INIT_LIST_HEAD(&priv->lhead);
266 INIT_LIST_HEAD(&priv->fbs);
267 INIT_LIST_HEAD(&priv->event_list);
268 init_waitqueue_head(&priv->event_wait);
269 priv->event_space = 4096; /* set aside 4k for event buffer */
271 if (dev->driver->driver_features & DRIVER_GEM)
272 drm_gem_open(dev, priv);
274 if (dev->driver->open) {
275 ret = dev->driver->open(dev, priv);
281 /* if there is no current master make this fd it */
282 mutex_lock(&dev->struct_mutex);
283 if (!priv->minor->master) {
284 /* create a new master */
285 priv->minor->master = drm_master_create(priv->minor);
286 if (!priv->minor->master) {
287 mutex_unlock(&dev->struct_mutex);
293 /* take another reference for the copy in the local file priv */
294 priv->master = drm_master_get(priv->minor->master);
296 priv->authenticated = 1;
298 mutex_unlock(&dev->struct_mutex);
299 if (dev->driver->master_create) {
300 ret = dev->driver->master_create(dev, priv->master);
302 mutex_lock(&dev->struct_mutex);
303 /* drop both references if this fails */
304 drm_master_put(&priv->minor->master);
305 drm_master_put(&priv->master);
306 mutex_unlock(&dev->struct_mutex);
310 mutex_lock(&dev->struct_mutex);
311 if (dev->driver->master_set) {
312 ret = dev->driver->master_set(dev, priv, true);
314 /* drop both references if this fails */
315 drm_master_put(&priv->minor->master);
316 drm_master_put(&priv->master);
317 mutex_unlock(&dev->struct_mutex);
321 mutex_unlock(&dev->struct_mutex);
323 /* get a reference to the master */
324 priv->master = drm_master_get(priv->minor->master);
325 mutex_unlock(&dev->struct_mutex);
328 mutex_lock(&dev->struct_mutex);
329 list_add(&priv->lhead, &dev->filelist);
330 mutex_unlock(&dev->struct_mutex);
337 struct pci_dev *pci_dev;
338 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
340 dev->hose = pci_dev->sysdata;
341 pci_dev_put(pci_dev);
344 struct pci_bus *b = pci_bus_b(pci_root_buses.next);
346 dev->hose = b->sysdata;
354 filp->private_data = NULL;
359 int drm_fasync(int fd, struct file *filp, int on)
361 struct drm_file *priv = filp->private_data;
362 struct drm_device *dev = priv->minor->dev;
364 DRM_DEBUG("fd = %d, device = 0x%lx\n", fd,
365 (long)old_encode_dev(priv->minor->device));
366 return fasync_helper(fd, filp, on, &dev->buf_async);
368 EXPORT_SYMBOL(drm_fasync);
371 * Reclaim locked buffers; note that this may be a bad idea if the current
372 * context doesn't have the hw lock...
374 static void drm_reclaim_locked_buffers(struct drm_device *dev, struct file *f)
376 struct drm_file *file_priv = f->private_data;
378 if (drm_i_have_hw_lock(dev, file_priv)) {
379 dev->driver->reclaim_buffers_locked(dev, file_priv);
381 unsigned long _end = jiffies + 3 * DRM_HZ;
384 drm_idlelock_take(&file_priv->master->lock);
390 spin_lock_bh(&file_priv->master->lock.spinlock);
391 locked = file_priv->master->lock.idle_has_lock;
392 spin_unlock_bh(&file_priv->master->lock.spinlock);
396 } while (!time_after_eq(jiffies, _end));
399 DRM_ERROR("reclaim_buffers_locked() deadlock. Please rework this\n"
400 "\tdriver to use reclaim_buffers_idlelocked() instead.\n"
401 "\tI will go on reclaiming the buffers anyway.\n");
404 dev->driver->reclaim_buffers_locked(dev, file_priv);
405 drm_idlelock_release(&file_priv->master->lock);
409 static void drm_master_release(struct drm_device *dev, struct file *filp)
411 struct drm_file *file_priv = filp->private_data;
413 if (dev->driver->reclaim_buffers_locked &&
414 file_priv->master->lock.hw_lock)
415 drm_reclaim_locked_buffers(dev, filp);
417 if (dev->driver->reclaim_buffers_idlelocked &&
418 file_priv->master->lock.hw_lock) {
419 drm_idlelock_take(&file_priv->master->lock);
420 dev->driver->reclaim_buffers_idlelocked(dev, file_priv);
421 drm_idlelock_release(&file_priv->master->lock);
425 if (drm_i_have_hw_lock(dev, file_priv)) {
426 DRM_DEBUG("File %p released, freeing lock for context %d\n",
427 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
428 drm_lock_free(&file_priv->master->lock,
429 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
432 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
433 !dev->driver->reclaim_buffers_locked) {
434 dev->driver->reclaim_buffers(dev, file_priv);
438 static void drm_events_release(struct drm_file *file_priv)
440 struct drm_device *dev = file_priv->minor->dev;
441 struct drm_pending_event *e, *et;
442 struct drm_pending_vblank_event *v, *vt;
445 spin_lock_irqsave(&dev->event_lock, flags);
447 /* Remove pending flips */
448 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
449 if (v->base.file_priv == file_priv) {
450 list_del(&v->base.link);
451 drm_vblank_put(dev, v->pipe);
452 v->base.destroy(&v->base);
455 /* Remove unconsumed events */
456 list_for_each_entry_safe(e, et, &file_priv->event_list, link)
459 spin_unlock_irqrestore(&dev->event_lock, flags);
465 * \param inode device inode
466 * \param file_priv DRM file private.
467 * \return zero on success or a negative number on failure.
469 * If the hardware lock is held then free it, and take it again for the kernel
470 * context since it's necessary to reclaim buffers. Unlink the file private
471 * data from its list and free it. Decreases the open count and if it reaches
472 * zero calls drm_lastclose().
474 int drm_release(struct inode *inode, struct file *filp)
476 struct drm_file *file_priv = filp->private_data;
477 struct drm_device *dev = file_priv->minor->dev;
480 mutex_lock(&drm_global_mutex);
482 DRM_DEBUG("open_count = %d\n", dev->open_count);
484 if (dev->driver->preclose)
485 dev->driver->preclose(dev, file_priv);
487 /* ========================================================
488 * Begin inline drm_release
491 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
492 task_pid_nr(current),
493 (long)old_encode_dev(file_priv->minor->device),
496 /* Release any auth tokens that might point to this file_priv,
497 (do that under the drm_global_mutex) */
498 if (file_priv->magic)
499 (void) drm_remove_magic(file_priv->master, file_priv->magic);
501 /* if the master has gone away we can't do anything with the lock */
502 if (file_priv->minor->master)
503 drm_master_release(dev, filp);
505 drm_events_release(file_priv);
507 if (dev->driver->driver_features & DRIVER_GEM)
508 drm_gem_release(dev, file_priv);
510 if (dev->driver->driver_features & DRIVER_MODESET)
511 drm_fb_release(file_priv);
513 mutex_lock(&dev->ctxlist_mutex);
514 if (!list_empty(&dev->ctxlist)) {
515 struct drm_ctx_list *pos, *n;
517 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
518 if (pos->tag == file_priv &&
519 pos->handle != DRM_KERNEL_CONTEXT) {
520 if (dev->driver->context_dtor)
521 dev->driver->context_dtor(dev,
524 drm_ctxbitmap_free(dev, pos->handle);
526 list_del(&pos->head);
532 mutex_unlock(&dev->ctxlist_mutex);
534 mutex_lock(&dev->struct_mutex);
536 if (file_priv->is_master) {
537 struct drm_master *master = file_priv->master;
538 struct drm_file *temp;
539 list_for_each_entry(temp, &dev->filelist, lhead) {
540 if ((temp->master == file_priv->master) &&
542 temp->authenticated = 0;
546 * Since the master is disappearing, so is the
547 * possibility to lock.
550 if (master->lock.hw_lock) {
551 if (dev->sigdata.lock == master->lock.hw_lock)
552 dev->sigdata.lock = NULL;
553 master->lock.hw_lock = NULL;
554 master->lock.file_priv = NULL;
555 wake_up_interruptible_all(&master->lock.lock_queue);
558 if (file_priv->minor->master == file_priv->master) {
559 /* drop the reference held my the minor */
560 if (dev->driver->master_drop)
561 dev->driver->master_drop(dev, file_priv, true);
562 drm_master_put(&file_priv->minor->master);
566 /* drop the reference held my the file priv */
567 drm_master_put(&file_priv->master);
568 file_priv->is_master = 0;
569 list_del(&file_priv->lhead);
570 mutex_unlock(&dev->struct_mutex);
572 if (dev->driver->postclose)
573 dev->driver->postclose(dev, file_priv);
576 /* ========================================================
577 * End inline drm_release
580 atomic_inc(&dev->counts[_DRM_STAT_CLOSES]);
581 if (!--dev->open_count) {
582 if (atomic_read(&dev->ioctl_count)) {
583 DRM_ERROR("Device busy: %d\n",
584 atomic_read(&dev->ioctl_count));
587 retcode = drm_lastclose(dev);
588 if (drm_device_is_unplugged(dev))
591 mutex_unlock(&drm_global_mutex);
595 EXPORT_SYMBOL(drm_release);
598 drm_dequeue_event(struct drm_file *file_priv,
599 size_t total, size_t max, struct drm_pending_event **out)
601 struct drm_device *dev = file_priv->minor->dev;
602 struct drm_pending_event *e;
606 spin_lock_irqsave(&dev->event_lock, flags);
609 if (list_empty(&file_priv->event_list))
611 e = list_first_entry(&file_priv->event_list,
612 struct drm_pending_event, link);
613 if (e->event->length + total > max)
616 file_priv->event_space += e->event->length;
622 spin_unlock_irqrestore(&dev->event_lock, flags);
626 ssize_t drm_read(struct file *filp, char __user *buffer,
627 size_t count, loff_t *offset)
629 struct drm_file *file_priv = filp->private_data;
630 struct drm_pending_event *e;
634 ret = wait_event_interruptible(file_priv->event_wait,
635 !list_empty(&file_priv->event_list));
640 while (drm_dequeue_event(file_priv, total, count, &e)) {
641 if (copy_to_user(buffer + total,
642 e->event, e->event->length)) {
647 total += e->event->length;
653 EXPORT_SYMBOL(drm_read);
655 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
657 struct drm_file *file_priv = filp->private_data;
658 unsigned int mask = 0;
660 poll_wait(filp, &file_priv->event_wait, wait);
662 if (!list_empty(&file_priv->event_list))
663 mask |= POLLIN | POLLRDNORM;
667 EXPORT_SYMBOL(drm_poll);