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 static int drm_open_helper(struct inode *inode, struct file *filp,
43 struct drm_device * dev);
45 static int drm_setup(struct drm_device * dev)
50 if (dev->driver->firstopen) {
51 ret = dev->driver->firstopen(dev);
56 atomic_set(&dev->ioctl_count, 0);
57 atomic_set(&dev->vma_count, 0);
59 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
60 !drm_core_check_feature(dev, DRIVER_MODESET)) {
62 atomic_set(&dev->buf_alloc, 0);
64 i = drm_dma_setup(dev);
69 for (i = 0; i < ARRAY_SIZE(dev->counts); i++)
70 atomic_set(&dev->counts[i], 0);
72 dev->sigdata.lock = NULL;
75 dev->queue_reserved = 0;
77 dev->queuelist = NULL;
78 dev->context_flag = 0;
79 dev->interrupt_flag = 0;
81 dev->last_context = 0;
83 dev->last_checked = 0;
84 init_waitqueue_head(&dev->context_wait);
90 dev->buf_async = NULL;
91 init_waitqueue_head(&dev->buf_readers);
92 init_waitqueue_head(&dev->buf_writers);
97 * The kernel's context could be created here, but is now created
98 * in drm_dma_enqueue. This is more resource-efficient for
99 * hardware that does not do DMA, but may mean that
100 * drm_select_queue fails between the time the interrupt is
101 * initialized and the time the queues are initialized.
110 * \param inode device inode
111 * \param filp file pointer.
112 * \return zero on success or a negative number on failure.
114 * Searches the DRM device with the same minor number, calls open_helper(), and
115 * increments the device open count. If the open count was previous at zero,
116 * i.e., it's the first that the device is open, then calls setup().
118 int drm_open(struct inode *inode, struct file *filp)
120 struct drm_device *dev = NULL;
121 int minor_id = iminor(inode);
122 struct drm_minor *minor;
125 minor = idr_find(&drm_minors_idr, minor_id);
129 if (!(dev = minor->dev))
132 retcode = drm_open_helper(inode, filp, dev);
134 atomic_inc(&dev->counts[_DRM_STAT_OPENS]);
135 spin_lock(&dev->count_lock);
136 if (!dev->open_count++) {
137 spin_unlock(&dev->count_lock);
138 retcode = drm_setup(dev);
141 spin_unlock(&dev->count_lock);
144 mutex_lock(&dev->struct_mutex);
145 if (minor->type == DRM_MINOR_LEGACY) {
146 BUG_ON((dev->dev_mapping != NULL) &&
147 (dev->dev_mapping != inode->i_mapping));
148 if (dev->dev_mapping == NULL)
149 dev->dev_mapping = inode->i_mapping;
151 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 /* BKL pushdown: note that nothing else serializes idr_find() */
178 minor = idr_find(&drm_minors_idr, minor_id);
182 if (!(dev = minor->dev))
185 old_fops = filp->f_op;
186 filp->f_op = fops_get(&dev->driver->fops);
187 if (filp->f_op == NULL) {
188 filp->f_op = old_fops;
191 if (filp->f_op->open && (err = filp->f_op->open(inode, filp))) {
192 fops_put(filp->f_op);
193 filp->f_op = fops_get(old_fops);
203 * Check whether DRI will run on this CPU.
205 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
207 static int drm_cpu_valid(void)
209 #if defined(__i386__)
210 if (boot_cpu_data.x86 == 3)
211 return 0; /* No cmpxchg on a 386 */
213 #if defined(__sparc__) && !defined(__sparc_v9__)
214 return 0; /* No cmpxchg before v9 sparc. */
220 * Called whenever a process opens /dev/drm.
222 * \param inode device inode.
223 * \param filp file pointer.
225 * \return zero on success or a negative number on failure.
227 * Creates and initializes a drm_file structure for the file private data in \p
228 * filp and add it into the double linked list in \p dev.
230 static int drm_open_helper(struct inode *inode, struct file *filp,
231 struct drm_device * dev)
233 int minor_id = iminor(inode);
234 struct drm_file *priv;
237 if (filp->f_flags & O_EXCL)
238 return -EBUSY; /* No exclusive opens */
239 if (!drm_cpu_valid())
242 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor_id);
244 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
248 memset(priv, 0, sizeof(*priv));
249 filp->private_data = priv;
251 priv->uid = current_euid();
252 priv->pid = task_pid_nr(current);
253 priv->minor = idr_find(&drm_minors_idr, minor_id);
254 priv->ioctl_count = 0;
255 /* for compatibility root is always authenticated */
256 priv->authenticated = capable(CAP_SYS_ADMIN);
257 priv->lock_count = 0;
259 INIT_LIST_HEAD(&priv->lhead);
260 INIT_LIST_HEAD(&priv->fbs);
261 INIT_LIST_HEAD(&priv->event_list);
262 init_waitqueue_head(&priv->event_wait);
263 priv->event_space = 4096; /* set aside 4k for event buffer */
265 if (dev->driver->driver_features & DRIVER_GEM)
266 drm_gem_open(dev, priv);
268 if (dev->driver->open) {
269 ret = dev->driver->open(dev, priv);
275 /* if there is no current master make this fd it */
276 mutex_lock(&dev->struct_mutex);
277 if (!priv->minor->master) {
278 /* create a new master */
279 priv->minor->master = drm_master_create(priv->minor);
280 if (!priv->minor->master) {
281 mutex_unlock(&dev->struct_mutex);
287 /* take another reference for the copy in the local file priv */
288 priv->master = drm_master_get(priv->minor->master);
290 priv->authenticated = 1;
292 mutex_unlock(&dev->struct_mutex);
293 if (dev->driver->master_create) {
294 ret = dev->driver->master_create(dev, priv->master);
296 mutex_lock(&dev->struct_mutex);
297 /* drop both references if this fails */
298 drm_master_put(&priv->minor->master);
299 drm_master_put(&priv->master);
300 mutex_unlock(&dev->struct_mutex);
304 mutex_lock(&dev->struct_mutex);
305 if (dev->driver->master_set) {
306 ret = dev->driver->master_set(dev, priv, true);
308 /* drop both references if this fails */
309 drm_master_put(&priv->minor->master);
310 drm_master_put(&priv->master);
311 mutex_unlock(&dev->struct_mutex);
315 mutex_unlock(&dev->struct_mutex);
317 /* get a reference to the master */
318 priv->master = drm_master_get(priv->minor->master);
319 mutex_unlock(&dev->struct_mutex);
322 mutex_lock(&dev->struct_mutex);
323 list_add(&priv->lhead, &dev->filelist);
324 mutex_unlock(&dev->struct_mutex);
331 struct pci_dev *pci_dev;
332 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
334 dev->hose = pci_dev->sysdata;
335 pci_dev_put(pci_dev);
338 struct pci_bus *b = pci_bus_b(pci_root_buses.next);
340 dev->hose = b->sysdata;
348 filp->private_data = NULL;
353 int drm_fasync(int fd, struct file *filp, int on)
355 struct drm_file *priv = filp->private_data;
356 struct drm_device *dev = priv->minor->dev;
358 DRM_DEBUG("fd = %d, device = 0x%lx\n", fd,
359 (long)old_encode_dev(priv->minor->device));
360 return fasync_helper(fd, filp, on, &dev->buf_async);
362 EXPORT_SYMBOL(drm_fasync);
365 * Reclaim locked buffers; note that this may be a bad idea if the current
366 * context doesn't have the hw lock...
368 static void drm_reclaim_locked_buffers(struct drm_device *dev, struct file *f)
370 struct drm_file *file_priv = f->private_data;
372 if (drm_i_have_hw_lock(dev, file_priv)) {
373 dev->driver->reclaim_buffers_locked(dev, file_priv);
375 unsigned long _end = jiffies + 3 * DRM_HZ;
378 drm_idlelock_take(&file_priv->master->lock);
384 spin_lock_bh(&file_priv->master->lock.spinlock);
385 locked = file_priv->master->lock.idle_has_lock;
386 spin_unlock_bh(&file_priv->master->lock.spinlock);
390 } while (!time_after_eq(jiffies, _end));
393 DRM_ERROR("reclaim_buffers_locked() deadlock. Please rework this\n"
394 "\tdriver to use reclaim_buffers_idlelocked() instead.\n"
395 "\tI will go on reclaiming the buffers anyway.\n");
398 dev->driver->reclaim_buffers_locked(dev, file_priv);
399 drm_idlelock_release(&file_priv->master->lock);
403 static void drm_master_release(struct drm_device *dev, struct file *filp)
405 struct drm_file *file_priv = filp->private_data;
407 if (dev->driver->reclaim_buffers_locked &&
408 file_priv->master->lock.hw_lock)
409 drm_reclaim_locked_buffers(dev, filp);
411 if (dev->driver->reclaim_buffers_idlelocked &&
412 file_priv->master->lock.hw_lock) {
413 drm_idlelock_take(&file_priv->master->lock);
414 dev->driver->reclaim_buffers_idlelocked(dev, file_priv);
415 drm_idlelock_release(&file_priv->master->lock);
419 if (drm_i_have_hw_lock(dev, file_priv)) {
420 DRM_DEBUG("File %p released, freeing lock for context %d\n",
421 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
422 drm_lock_free(&file_priv->master->lock,
423 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
426 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
427 !dev->driver->reclaim_buffers_locked) {
428 dev->driver->reclaim_buffers(dev, file_priv);
432 static void drm_events_release(struct drm_file *file_priv)
434 struct drm_device *dev = file_priv->minor->dev;
435 struct drm_pending_event *e, *et;
436 struct drm_pending_vblank_event *v, *vt;
439 spin_lock_irqsave(&dev->event_lock, flags);
441 /* Remove pending flips */
442 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
443 if (v->base.file_priv == file_priv) {
444 list_del(&v->base.link);
445 drm_vblank_put(dev, v->pipe);
446 v->base.destroy(&v->base);
449 /* Remove unconsumed events */
450 list_for_each_entry_safe(e, et, &file_priv->event_list, link)
453 spin_unlock_irqrestore(&dev->event_lock, flags);
459 * \param inode device inode
460 * \param file_priv DRM file private.
461 * \return zero on success or a negative number on failure.
463 * If the hardware lock is held then free it, and take it again for the kernel
464 * context since it's necessary to reclaim buffers. Unlink the file private
465 * data from its list and free it. Decreases the open count and if it reaches
466 * zero calls drm_lastclose().
468 int drm_release(struct inode *inode, struct file *filp)
470 struct drm_file *file_priv = filp->private_data;
471 struct drm_device *dev = file_priv->minor->dev;
476 DRM_DEBUG("open_count = %d\n", dev->open_count);
478 if (dev->driver->preclose)
479 dev->driver->preclose(dev, file_priv);
481 /* ========================================================
482 * Begin inline drm_release
485 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
486 task_pid_nr(current),
487 (long)old_encode_dev(file_priv->minor->device),
490 /* if the master has gone away we can't do anything with the lock */
491 if (file_priv->minor->master)
492 drm_master_release(dev, filp);
494 drm_events_release(file_priv);
496 if (dev->driver->driver_features & DRIVER_GEM)
497 drm_gem_release(dev, file_priv);
499 if (dev->driver->driver_features & DRIVER_MODESET)
500 drm_fb_release(file_priv);
502 mutex_lock(&dev->ctxlist_mutex);
503 if (!list_empty(&dev->ctxlist)) {
504 struct drm_ctx_list *pos, *n;
506 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
507 if (pos->tag == file_priv &&
508 pos->handle != DRM_KERNEL_CONTEXT) {
509 if (dev->driver->context_dtor)
510 dev->driver->context_dtor(dev,
513 drm_ctxbitmap_free(dev, pos->handle);
515 list_del(&pos->head);
521 mutex_unlock(&dev->ctxlist_mutex);
523 mutex_lock(&dev->struct_mutex);
525 if (file_priv->is_master) {
526 struct drm_master *master = file_priv->master;
527 struct drm_file *temp;
528 list_for_each_entry(temp, &dev->filelist, lhead) {
529 if ((temp->master == file_priv->master) &&
531 temp->authenticated = 0;
535 * Since the master is disappearing, so is the
536 * possibility to lock.
539 if (master->lock.hw_lock) {
540 if (dev->sigdata.lock == master->lock.hw_lock)
541 dev->sigdata.lock = NULL;
542 master->lock.hw_lock = NULL;
543 master->lock.file_priv = NULL;
544 wake_up_interruptible_all(&master->lock.lock_queue);
547 if (file_priv->minor->master == file_priv->master) {
548 /* drop the reference held my the minor */
549 if (dev->driver->master_drop)
550 dev->driver->master_drop(dev, file_priv, true);
551 drm_master_put(&file_priv->minor->master);
555 /* drop the reference held my the file priv */
556 drm_master_put(&file_priv->master);
557 file_priv->is_master = 0;
558 list_del(&file_priv->lhead);
559 mutex_unlock(&dev->struct_mutex);
561 if (dev->driver->postclose)
562 dev->driver->postclose(dev, file_priv);
565 /* ========================================================
566 * End inline drm_release
569 atomic_inc(&dev->counts[_DRM_STAT_CLOSES]);
570 spin_lock(&dev->count_lock);
571 if (!--dev->open_count) {
572 if (atomic_read(&dev->ioctl_count)) {
573 DRM_ERROR("Device busy: %d\n",
574 atomic_read(&dev->ioctl_count));
575 spin_unlock(&dev->count_lock);
579 spin_unlock(&dev->count_lock);
581 return drm_lastclose(dev);
583 spin_unlock(&dev->count_lock);
589 EXPORT_SYMBOL(drm_release);
592 drm_dequeue_event(struct drm_file *file_priv,
593 size_t total, size_t max, struct drm_pending_event **out)
595 struct drm_device *dev = file_priv->minor->dev;
596 struct drm_pending_event *e;
600 spin_lock_irqsave(&dev->event_lock, flags);
603 if (list_empty(&file_priv->event_list))
605 e = list_first_entry(&file_priv->event_list,
606 struct drm_pending_event, link);
607 if (e->event->length + total > max)
610 file_priv->event_space += e->event->length;
616 spin_unlock_irqrestore(&dev->event_lock, flags);
620 ssize_t drm_read(struct file *filp, char __user *buffer,
621 size_t count, loff_t *offset)
623 struct drm_file *file_priv = filp->private_data;
624 struct drm_pending_event *e;
628 ret = wait_event_interruptible(file_priv->event_wait,
629 !list_empty(&file_priv->event_list));
634 while (drm_dequeue_event(file_priv, total, count, &e)) {
635 if (copy_to_user(buffer + total,
636 e->event, e->event->length)) {
641 total += e->event->length;
647 EXPORT_SYMBOL(drm_read);
649 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
651 struct drm_file *file_priv = filp->private_data;
652 unsigned int mask = 0;
654 poll_wait(filp, &file_priv->event_wait, wait);
656 if (!list_empty(&file_priv->event_list))
657 mask |= POLLIN | POLLRDNORM;
661 EXPORT_SYMBOL(drm_poll);