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;
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 if (drm_device_is_unplugged(dev))
135 retcode = drm_open_helper(inode, filp, dev);
137 atomic_inc(&dev->counts[_DRM_STAT_OPENS]);
138 if (!dev->open_count++)
139 retcode = drm_setup(dev);
142 mutex_lock(&dev->struct_mutex);
143 if (dev->dev_mapping == NULL)
144 dev->dev_mapping = &inode->i_data;
145 /* ihold ensures nobody can remove inode with our i_data */
146 ihold(container_of(dev->dev_mapping, struct inode, i_data));
147 inode->i_mapping = dev->dev_mapping;
148 filp->f_mapping = dev->dev_mapping;
149 mutex_unlock(&dev->struct_mutex);
154 EXPORT_SYMBOL(drm_open);
157 * File \c open operation.
159 * \param inode device inode.
160 * \param filp file pointer.
162 * Puts the dev->fops corresponding to the device minor number into
163 * \p filp, call the \c open method, and restore the file operations.
165 int drm_stub_open(struct inode *inode, struct file *filp)
167 struct drm_device *dev = NULL;
168 struct drm_minor *minor;
169 int minor_id = iminor(inode);
171 const struct file_operations *old_fops;
175 mutex_lock(&drm_global_mutex);
176 minor = idr_find(&drm_minors_idr, minor_id);
180 if (!(dev = minor->dev))
183 if (drm_device_is_unplugged(dev))
186 old_fops = filp->f_op;
187 filp->f_op = fops_get(dev->driver->fops);
188 if (filp->f_op == NULL) {
189 filp->f_op = old_fops;
192 if (filp->f_op->open && (err = filp->f_op->open(inode, filp))) {
193 fops_put(filp->f_op);
194 filp->f_op = fops_get(old_fops);
199 mutex_unlock(&drm_global_mutex);
204 * Check whether DRI will run on this CPU.
206 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
208 static int drm_cpu_valid(void)
210 #if defined(__i386__)
211 if (boot_cpu_data.x86 == 3)
212 return 0; /* No cmpxchg on a 386 */
214 #if defined(__sparc__) && !defined(__sparc_v9__)
215 return 0; /* No cmpxchg before v9 sparc. */
221 * Called whenever a process opens /dev/drm.
223 * \param inode device inode.
224 * \param filp file pointer.
226 * \return zero on success or a negative number on failure.
228 * Creates and initializes a drm_file structure for the file private data in \p
229 * filp and add it into the double linked list in \p dev.
231 static int drm_open_helper(struct inode *inode, struct file *filp,
232 struct drm_device * dev)
234 int minor_id = iminor(inode);
235 struct drm_file *priv;
238 if (filp->f_flags & O_EXCL)
239 return -EBUSY; /* No exclusive opens */
240 if (!drm_cpu_valid())
242 if (dev->switch_power_state != DRM_SWITCH_POWER_ON)
245 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor_id);
247 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
251 filp->private_data = priv;
253 priv->uid = current_euid();
254 priv->pid = get_pid(task_pid(current));
255 priv->minor = idr_find(&drm_minors_idr, minor_id);
256 priv->ioctl_count = 0;
257 /* for compatibility root is always authenticated */
258 priv->authenticated = capable(CAP_SYS_ADMIN);
259 priv->lock_count = 0;
261 INIT_LIST_HEAD(&priv->lhead);
262 INIT_LIST_HEAD(&priv->fbs);
263 INIT_LIST_HEAD(&priv->event_list);
264 init_waitqueue_head(&priv->event_wait);
265 priv->event_space = 4096; /* set aside 4k for event buffer */
267 if (dev->driver->driver_features & DRIVER_GEM)
268 drm_gem_open(dev, priv);
270 if (drm_core_check_feature(dev, DRIVER_PRIME))
271 drm_prime_init_file_private(&priv->prime);
273 if (dev->driver->open) {
274 ret = dev->driver->open(dev, priv);
280 /* if there is no current master make this fd it */
281 mutex_lock(&dev->struct_mutex);
282 if (!priv->minor->master) {
283 /* create a new master */
284 priv->minor->master = drm_master_create(priv->minor);
285 if (!priv->minor->master) {
286 mutex_unlock(&dev->struct_mutex);
292 /* take another reference for the copy in the local file priv */
293 priv->master = drm_master_get(priv->minor->master);
295 priv->authenticated = 1;
297 mutex_unlock(&dev->struct_mutex);
298 if (dev->driver->master_create) {
299 ret = dev->driver->master_create(dev, priv->master);
301 mutex_lock(&dev->struct_mutex);
302 /* drop both references if this fails */
303 drm_master_put(&priv->minor->master);
304 drm_master_put(&priv->master);
305 mutex_unlock(&dev->struct_mutex);
309 mutex_lock(&dev->struct_mutex);
310 if (dev->driver->master_set) {
311 ret = dev->driver->master_set(dev, priv, true);
313 /* drop both references if this fails */
314 drm_master_put(&priv->minor->master);
315 drm_master_put(&priv->master);
316 mutex_unlock(&dev->struct_mutex);
320 mutex_unlock(&dev->struct_mutex);
322 /* get a reference to the master */
323 priv->master = drm_master_get(priv->minor->master);
324 mutex_unlock(&dev->struct_mutex);
327 mutex_lock(&dev->struct_mutex);
328 list_add(&priv->lhead, &dev->filelist);
329 mutex_unlock(&dev->struct_mutex);
336 struct pci_dev *pci_dev;
337 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
339 dev->hose = pci_dev->sysdata;
340 pci_dev_put(pci_dev);
343 struct pci_bus *b = pci_bus_b(pci_root_buses.next);
345 dev->hose = b->sysdata;
353 filp->private_data = NULL;
358 int drm_fasync(int fd, struct file *filp, int on)
360 struct drm_file *priv = filp->private_data;
361 struct drm_device *dev = priv->minor->dev;
363 DRM_DEBUG("fd = %d, device = 0x%lx\n", fd,
364 (long)old_encode_dev(priv->minor->device));
365 return fasync_helper(fd, filp, on, &dev->buf_async);
367 EXPORT_SYMBOL(drm_fasync);
369 static void drm_master_release(struct drm_device *dev, struct file *filp)
371 struct drm_file *file_priv = filp->private_data;
373 if (drm_i_have_hw_lock(dev, file_priv)) {
374 DRM_DEBUG("File %p released, freeing lock for context %d\n",
375 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
376 drm_lock_free(&file_priv->master->lock,
377 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
381 static void drm_events_release(struct drm_file *file_priv)
383 struct drm_device *dev = file_priv->minor->dev;
384 struct drm_pending_event *e, *et;
385 struct drm_pending_vblank_event *v, *vt;
388 spin_lock_irqsave(&dev->event_lock, flags);
390 /* Remove pending flips */
391 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
392 if (v->base.file_priv == file_priv) {
393 list_del(&v->base.link);
394 drm_vblank_put(dev, v->pipe);
395 v->base.destroy(&v->base);
398 /* Remove unconsumed events */
399 list_for_each_entry_safe(e, et, &file_priv->event_list, link)
402 spin_unlock_irqrestore(&dev->event_lock, flags);
408 * \param inode device inode
409 * \param file_priv DRM file private.
410 * \return zero on success or a negative number on failure.
412 * If the hardware lock is held then free it, and take it again for the kernel
413 * context since it's necessary to reclaim buffers. Unlink the file private
414 * data from its list and free it. Decreases the open count and if it reaches
415 * zero calls drm_lastclose().
417 int drm_release(struct inode *inode, struct file *filp)
419 struct drm_file *file_priv = filp->private_data;
420 struct drm_device *dev = file_priv->minor->dev;
423 mutex_lock(&drm_global_mutex);
425 DRM_DEBUG("open_count = %d\n", dev->open_count);
427 if (dev->driver->preclose)
428 dev->driver->preclose(dev, file_priv);
430 /* ========================================================
431 * Begin inline drm_release
434 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
435 task_pid_nr(current),
436 (long)old_encode_dev(file_priv->minor->device),
439 /* Release any auth tokens that might point to this file_priv,
440 (do that under the drm_global_mutex) */
441 if (file_priv->magic)
442 (void) drm_remove_magic(file_priv->master, file_priv->magic);
444 /* if the master has gone away we can't do anything with the lock */
445 if (file_priv->minor->master)
446 drm_master_release(dev, filp);
448 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
449 drm_core_reclaim_buffers(dev, file_priv);
451 drm_events_release(file_priv);
453 if (dev->driver->driver_features & DRIVER_MODESET)
454 drm_fb_release(file_priv);
456 if (dev->driver->driver_features & DRIVER_GEM)
457 drm_gem_release(dev, file_priv);
459 mutex_lock(&dev->ctxlist_mutex);
460 if (!list_empty(&dev->ctxlist)) {
461 struct drm_ctx_list *pos, *n;
463 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
464 if (pos->tag == file_priv &&
465 pos->handle != DRM_KERNEL_CONTEXT) {
466 if (dev->driver->context_dtor)
467 dev->driver->context_dtor(dev,
470 drm_ctxbitmap_free(dev, pos->handle);
472 list_del(&pos->head);
478 mutex_unlock(&dev->ctxlist_mutex);
480 mutex_lock(&dev->struct_mutex);
482 if (file_priv->is_master) {
483 struct drm_master *master = file_priv->master;
484 struct drm_file *temp;
485 list_for_each_entry(temp, &dev->filelist, lhead) {
486 if ((temp->master == file_priv->master) &&
488 temp->authenticated = 0;
492 * Since the master is disappearing, so is the
493 * possibility to lock.
496 if (master->lock.hw_lock) {
497 if (dev->sigdata.lock == master->lock.hw_lock)
498 dev->sigdata.lock = NULL;
499 master->lock.hw_lock = NULL;
500 master->lock.file_priv = NULL;
501 wake_up_interruptible_all(&master->lock.lock_queue);
504 if (file_priv->minor->master == file_priv->master) {
505 /* drop the reference held my the minor */
506 if (dev->driver->master_drop)
507 dev->driver->master_drop(dev, file_priv, true);
508 drm_master_put(&file_priv->minor->master);
512 BUG_ON(dev->dev_mapping == NULL);
513 iput(container_of(dev->dev_mapping, struct inode, i_data));
515 /* drop the reference held my the file priv */
516 drm_master_put(&file_priv->master);
517 file_priv->is_master = 0;
518 list_del(&file_priv->lhead);
519 mutex_unlock(&dev->struct_mutex);
521 if (dev->driver->postclose)
522 dev->driver->postclose(dev, file_priv);
524 if (drm_core_check_feature(dev, DRIVER_PRIME))
525 drm_prime_destroy_file_private(&file_priv->prime);
527 put_pid(file_priv->pid);
530 /* ========================================================
531 * End inline drm_release
534 atomic_inc(&dev->counts[_DRM_STAT_CLOSES]);
535 if (!--dev->open_count) {
536 if (atomic_read(&dev->ioctl_count)) {
537 DRM_ERROR("Device busy: %d\n",
538 atomic_read(&dev->ioctl_count));
541 retcode = drm_lastclose(dev);
542 if (drm_device_is_unplugged(dev))
545 mutex_unlock(&drm_global_mutex);
549 EXPORT_SYMBOL(drm_release);
552 drm_dequeue_event(struct drm_file *file_priv,
553 size_t total, size_t max, struct drm_pending_event **out)
555 struct drm_device *dev = file_priv->minor->dev;
556 struct drm_pending_event *e;
560 spin_lock_irqsave(&dev->event_lock, flags);
563 if (list_empty(&file_priv->event_list))
565 e = list_first_entry(&file_priv->event_list,
566 struct drm_pending_event, link);
567 if (e->event->length + total > max)
570 file_priv->event_space += e->event->length;
576 spin_unlock_irqrestore(&dev->event_lock, flags);
580 ssize_t drm_read(struct file *filp, char __user *buffer,
581 size_t count, loff_t *offset)
583 struct drm_file *file_priv = filp->private_data;
584 struct drm_pending_event *e;
588 ret = wait_event_interruptible(file_priv->event_wait,
589 !list_empty(&file_priv->event_list));
594 while (drm_dequeue_event(file_priv, total, count, &e)) {
595 if (copy_to_user(buffer + total,
596 e->event, e->event->length)) {
601 total += e->event->length;
607 EXPORT_SYMBOL(drm_read);
609 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
611 struct drm_file *file_priv = filp->private_data;
612 unsigned int mask = 0;
614 poll_wait(filp, &file_priv->event_wait, wait);
616 if (!list_empty(&file_priv->event_list))
617 mask |= POLLIN | POLLRDNORM;
621 EXPORT_SYMBOL(drm_poll);