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