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/smp_lock.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 retcode = drm_open_helper(inode, filp, dev);
138 atomic_inc(&dev->counts[_DRM_STAT_OPENS]);
139 if (!dev->open_count++)
140 retcode = drm_setup(dev);
143 mutex_lock(&dev->struct_mutex);
144 if (minor->type == DRM_MINOR_LEGACY) {
145 if (dev->dev_mapping == NULL)
146 dev->dev_mapping = inode->i_mapping;
147 else if (dev->dev_mapping != inode->i_mapping)
150 mutex_unlock(&dev->struct_mutex);
155 EXPORT_SYMBOL(drm_open);
158 * File \c open operation.
160 * \param inode device inode.
161 * \param filp file pointer.
163 * Puts the dev->fops corresponding to the device minor number into
164 * \p filp, call the \c open method, and restore the file operations.
166 int drm_stub_open(struct inode *inode, struct file *filp)
168 struct drm_device *dev = NULL;
169 struct drm_minor *minor;
170 int minor_id = iminor(inode);
172 const struct file_operations *old_fops;
176 mutex_lock(&drm_global_mutex);
177 minor = idr_find(&drm_minors_idr, minor_id);
181 if (!(dev = minor->dev))
184 old_fops = filp->f_op;
185 filp->f_op = fops_get(&dev->driver->fops);
186 if (filp->f_op == NULL) {
187 filp->f_op = old_fops;
190 if (filp->f_op->open && (err = filp->f_op->open(inode, filp))) {
191 fops_put(filp->f_op);
192 filp->f_op = fops_get(old_fops);
197 mutex_unlock(&drm_global_mutex);
202 * Check whether DRI will run on this CPU.
204 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
206 static int drm_cpu_valid(void)
208 #if defined(__i386__)
209 if (boot_cpu_data.x86 == 3)
210 return 0; /* No cmpxchg on a 386 */
212 #if defined(__sparc__) && !defined(__sparc_v9__)
213 return 0; /* No cmpxchg before v9 sparc. */
219 * Called whenever a process opens /dev/drm.
221 * \param inode device inode.
222 * \param filp file pointer.
224 * \return zero on success or a negative number on failure.
226 * Creates and initializes a drm_file structure for the file private data in \p
227 * filp and add it into the double linked list in \p dev.
229 static int drm_open_helper(struct inode *inode, struct file *filp,
230 struct drm_device * dev)
232 int minor_id = iminor(inode);
233 struct drm_file *priv;
236 if (filp->f_flags & O_EXCL)
237 return -EBUSY; /* No exclusive opens */
238 if (!drm_cpu_valid())
241 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor_id);
243 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
247 filp->private_data = priv;
249 priv->uid = current_euid();
250 priv->pid = task_pid_nr(current);
251 priv->minor = idr_find(&drm_minors_idr, minor_id);
252 priv->ioctl_count = 0;
253 /* for compatibility root is always authenticated */
254 priv->authenticated = capable(CAP_SYS_ADMIN);
255 priv->lock_count = 0;
257 INIT_LIST_HEAD(&priv->lhead);
258 INIT_LIST_HEAD(&priv->fbs);
259 INIT_LIST_HEAD(&priv->event_list);
260 init_waitqueue_head(&priv->event_wait);
261 priv->event_space = 4096; /* set aside 4k for event buffer */
263 if (dev->driver->driver_features & DRIVER_GEM)
264 drm_gem_open(dev, priv);
266 if (dev->driver->open) {
267 ret = dev->driver->open(dev, priv);
273 /* if there is no current master make this fd it */
274 mutex_lock(&dev->struct_mutex);
275 if (!priv->minor->master) {
276 /* create a new master */
277 priv->minor->master = drm_master_create(priv->minor);
278 if (!priv->minor->master) {
279 mutex_unlock(&dev->struct_mutex);
285 /* take another reference for the copy in the local file priv */
286 priv->master = drm_master_get(priv->minor->master);
288 priv->authenticated = 1;
290 mutex_unlock(&dev->struct_mutex);
291 if (dev->driver->master_create) {
292 ret = dev->driver->master_create(dev, priv->master);
294 mutex_lock(&dev->struct_mutex);
295 /* drop both references if this fails */
296 drm_master_put(&priv->minor->master);
297 drm_master_put(&priv->master);
298 mutex_unlock(&dev->struct_mutex);
302 mutex_lock(&dev->struct_mutex);
303 if (dev->driver->master_set) {
304 ret = dev->driver->master_set(dev, priv, true);
306 /* drop both references if this fails */
307 drm_master_put(&priv->minor->master);
308 drm_master_put(&priv->master);
309 mutex_unlock(&dev->struct_mutex);
313 mutex_unlock(&dev->struct_mutex);
315 /* get a reference to the master */
316 priv->master = drm_master_get(priv->minor->master);
317 mutex_unlock(&dev->struct_mutex);
320 mutex_lock(&dev->struct_mutex);
321 list_add(&priv->lhead, &dev->filelist);
322 mutex_unlock(&dev->struct_mutex);
329 struct pci_dev *pci_dev;
330 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
332 dev->hose = pci_dev->sysdata;
333 pci_dev_put(pci_dev);
336 struct pci_bus *b = pci_bus_b(pci_root_buses.next);
338 dev->hose = b->sysdata;
346 filp->private_data = NULL;
351 int drm_fasync(int fd, struct file *filp, int on)
353 struct drm_file *priv = filp->private_data;
354 struct drm_device *dev = priv->minor->dev;
356 DRM_DEBUG("fd = %d, device = 0x%lx\n", fd,
357 (long)old_encode_dev(priv->minor->device));
358 return fasync_helper(fd, filp, on, &dev->buf_async);
360 EXPORT_SYMBOL(drm_fasync);
363 * Reclaim locked buffers; note that this may be a bad idea if the current
364 * context doesn't have the hw lock...
366 static void drm_reclaim_locked_buffers(struct drm_device *dev, struct file *f)
368 struct drm_file *file_priv = f->private_data;
370 if (drm_i_have_hw_lock(dev, file_priv)) {
371 dev->driver->reclaim_buffers_locked(dev, file_priv);
373 unsigned long _end = jiffies + 3 * DRM_HZ;
376 drm_idlelock_take(&file_priv->master->lock);
382 spin_lock_bh(&file_priv->master->lock.spinlock);
383 locked = file_priv->master->lock.idle_has_lock;
384 spin_unlock_bh(&file_priv->master->lock.spinlock);
388 } while (!time_after_eq(jiffies, _end));
391 DRM_ERROR("reclaim_buffers_locked() deadlock. Please rework this\n"
392 "\tdriver to use reclaim_buffers_idlelocked() instead.\n"
393 "\tI will go on reclaiming the buffers anyway.\n");
396 dev->driver->reclaim_buffers_locked(dev, file_priv);
397 drm_idlelock_release(&file_priv->master->lock);
401 static void drm_master_release(struct drm_device *dev, struct file *filp)
403 struct drm_file *file_priv = filp->private_data;
405 if (dev->driver->reclaim_buffers_locked &&
406 file_priv->master->lock.hw_lock)
407 drm_reclaim_locked_buffers(dev, filp);
409 if (dev->driver->reclaim_buffers_idlelocked &&
410 file_priv->master->lock.hw_lock) {
411 drm_idlelock_take(&file_priv->master->lock);
412 dev->driver->reclaim_buffers_idlelocked(dev, file_priv);
413 drm_idlelock_release(&file_priv->master->lock);
417 if (drm_i_have_hw_lock(dev, file_priv)) {
418 DRM_DEBUG("File %p released, freeing lock for context %d\n",
419 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
420 drm_lock_free(&file_priv->master->lock,
421 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
424 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
425 !dev->driver->reclaim_buffers_locked) {
426 dev->driver->reclaim_buffers(dev, file_priv);
430 static void drm_events_release(struct drm_file *file_priv)
432 struct drm_device *dev = file_priv->minor->dev;
433 struct drm_pending_event *e, *et;
434 struct drm_pending_vblank_event *v, *vt;
437 spin_lock_irqsave(&dev->event_lock, flags);
439 /* Remove pending flips */
440 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
441 if (v->base.file_priv == file_priv) {
442 list_del(&v->base.link);
443 drm_vblank_put(dev, v->pipe);
444 v->base.destroy(&v->base);
447 /* Remove unconsumed events */
448 list_for_each_entry_safe(e, et, &file_priv->event_list, link)
451 spin_unlock_irqrestore(&dev->event_lock, flags);
457 * \param inode device inode
458 * \param file_priv DRM file private.
459 * \return zero on success or a negative number on failure.
461 * If the hardware lock is held then free it, and take it again for the kernel
462 * context since it's necessary to reclaim buffers. Unlink the file private
463 * data from its list and free it. Decreases the open count and if it reaches
464 * zero calls drm_lastclose().
466 int drm_release(struct inode *inode, struct file *filp)
468 struct drm_file *file_priv = filp->private_data;
469 struct drm_device *dev = file_priv->minor->dev;
472 mutex_lock(&drm_global_mutex);
474 DRM_DEBUG("open_count = %d\n", dev->open_count);
476 if (dev->driver->preclose)
477 dev->driver->preclose(dev, file_priv);
479 /* ========================================================
480 * Begin inline drm_release
483 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
484 task_pid_nr(current),
485 (long)old_encode_dev(file_priv->minor->device),
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);
492 drm_events_release(file_priv);
494 if (dev->driver->driver_features & DRIVER_GEM)
495 drm_gem_release(dev, file_priv);
497 if (dev->driver->driver_features & DRIVER_MODESET)
498 drm_fb_release(file_priv);
500 mutex_lock(&dev->ctxlist_mutex);
501 if (!list_empty(&dev->ctxlist)) {
502 struct drm_ctx_list *pos, *n;
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,
511 drm_ctxbitmap_free(dev, pos->handle);
513 list_del(&pos->head);
519 mutex_unlock(&dev->ctxlist_mutex);
521 mutex_lock(&dev->struct_mutex);
523 if (file_priv->is_master) {
524 struct drm_master *master = file_priv->master;
525 struct drm_file *temp;
526 list_for_each_entry(temp, &dev->filelist, lhead) {
527 if ((temp->master == file_priv->master) &&
529 temp->authenticated = 0;
533 * Since the master is disappearing, so is the
534 * possibility to lock.
537 if (master->lock.hw_lock) {
538 if (dev->sigdata.lock == master->lock.hw_lock)
539 dev->sigdata.lock = NULL;
540 master->lock.hw_lock = NULL;
541 master->lock.file_priv = NULL;
542 wake_up_interruptible_all(&master->lock.lock_queue);
545 if (file_priv->minor->master == file_priv->master) {
546 /* drop the reference held my the minor */
547 if (dev->driver->master_drop)
548 dev->driver->master_drop(dev, file_priv, true);
549 drm_master_put(&file_priv->minor->master);
553 /* drop the reference held my the file priv */
554 drm_master_put(&file_priv->master);
555 file_priv->is_master = 0;
556 list_del(&file_priv->lhead);
557 mutex_unlock(&dev->struct_mutex);
559 if (dev->driver->postclose)
560 dev->driver->postclose(dev, file_priv);
563 /* ========================================================
564 * End inline drm_release
567 atomic_inc(&dev->counts[_DRM_STAT_CLOSES]);
568 if (!--dev->open_count) {
569 if (atomic_read(&dev->ioctl_count)) {
570 DRM_ERROR("Device busy: %d\n",
571 atomic_read(&dev->ioctl_count));
574 retcode = drm_lastclose(dev);
576 mutex_unlock(&drm_global_mutex);
580 EXPORT_SYMBOL(drm_release);
583 drm_dequeue_event(struct drm_file *file_priv,
584 size_t total, size_t max, struct drm_pending_event **out)
586 struct drm_device *dev = file_priv->minor->dev;
587 struct drm_pending_event *e;
591 spin_lock_irqsave(&dev->event_lock, flags);
594 if (list_empty(&file_priv->event_list))
596 e = list_first_entry(&file_priv->event_list,
597 struct drm_pending_event, link);
598 if (e->event->length + total > max)
601 file_priv->event_space += e->event->length;
607 spin_unlock_irqrestore(&dev->event_lock, flags);
611 ssize_t drm_read(struct file *filp, char __user *buffer,
612 size_t count, loff_t *offset)
614 struct drm_file *file_priv = filp->private_data;
615 struct drm_pending_event *e;
619 ret = wait_event_interruptible(file_priv->event_wait,
620 !list_empty(&file_priv->event_list));
625 while (drm_dequeue_event(file_priv, total, count, &e)) {
626 if (copy_to_user(buffer + total,
627 e->event, e->event->length)) {
632 total += e->event->length;
638 EXPORT_SYMBOL(drm_read);
640 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
642 struct drm_file *file_priv = filp->private_data;
643 unsigned int mask = 0;
645 poll_wait(filp, &file_priv->event_wait, wait);
647 if (!list_empty(&file_priv->event_list))
648 mask |= POLLIN | POLLRDNORM;
652 EXPORT_SYMBOL(drm_poll);