blob: eb6a02f786972fb9b0dc9ab7d6ec581427f92a7c [file] [log] [blame]
Daniel Vetterbcb877e2016-01-11 22:40:55 +01001/*
Dave Airlieb5e89ed2005-09-25 14:28:13 +10002 * \file drm_fops.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * File operations for DRM
Dave Airlieb5e89ed2005-09-25 14:28:13 +10004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * \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
David Howells760285e2012-10-02 18:01:07 +010037#include <drm/drmP.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/poll.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
Paul Gortmakere0cd3602011-08-30 11:04:30 -040040#include <linux/module.h>
David Herrmanne7b960702014-07-24 12:10:04 +020041#include "drm_legacy.h"
Daniel Vetter67d0ec42014-09-10 12:43:53 +020042#include "drm_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
David Herrmann0d639882014-02-24 15:53:25 +010044/* from BKL pushdown */
Arnd Bergmann58374712010-07-10 23:51:39 +020045DEFINE_MUTEX(drm_global_mutex);
46
Daniel Vetterbcb877e2016-01-11 22:40:55 +010047/**
48 * DOC: file operations
49 *
50 * Drivers must define the file operations structure that forms the DRM
51 * userspace API entry point, even though most of those operations are
52 * implemented in the DRM core. The mandatory functions are drm_open(),
53 * drm_read(), drm_ioctl() and drm_compat_ioctl if CONFIG_COMPAT is enabled.
54 * Drivers which implement private ioctls that require 32/64 bit compatibility
55 * support must provided their onw .compat_ioctl() handler that processes
56 * private ioctls and calls drm_compat_ioctl() for core ioctls.
57 *
58 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
59 * events are a generic and extensible means to send asynchronous events to
60 * userspace through the file descriptor. They are used to send vblank event and
61 * page flip completions by the KMS API. But drivers can also use it for their
62 * own needs, e.g. to signal completion of rendering.
63 *
64 * The memory mapping implementation will vary depending on how the driver
65 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
66 * function, modern drivers should use one of the provided memory-manager
67 * specific implementations. For GEM-based drivers this is drm_gem_mmap().
68 *
69 * No other file operations are supported by the DRM userspace API. Overall the
70 * following is an example #file_operations structure:
71 *
72 * static const example_drm_fops = {
73 * .owner = THIS_MODULE,
74 * .open = drm_open,
75 * .release = drm_release,
76 * .unlocked_ioctl = drm_ioctl,
77 * #ifdef CONFIG_COMPAT
78 * .compat_ioctl = drm_compat_ioctl,
79 * #endif
80 * .poll = drm_poll,
81 * .read = drm_read,
82 * .llseek = no_llseek,
83 * .mmap = drm_gem_mmap,
84 * };
85 */
86
Ilija Hadzic1dcc0ce2014-04-28 10:23:57 -040087static int drm_open_helper(struct file *filp, struct drm_minor *minor);
Dave Airliec94f7022005-07-07 21:03:38 +100088
Dave Airlie84b1fd12007-07-11 15:53:27 +100089static int drm_setup(struct drm_device * dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090{
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 int ret;
92
Daniel Vetter7d14bb6b2013-08-08 15:41:15 +020093 if (dev->driver->firstopen &&
94 !drm_core_check_feature(dev, DRIVER_MODESET)) {
Dave Airlie22eae942005-11-10 22:16:34 +110095 ret = dev->driver->firstopen(dev);
Dave Airlieb5e89ed2005-09-25 14:28:13 +100096 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 return ret;
98 }
99
Daniel Vetterf336ab72013-08-08 15:41:35 +0200100 ret = drm_legacy_dma_setup(dev);
101 if (ret < 0)
102 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000105 DRM_DEBUG("\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 return 0;
107}
108
109/**
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100110 * drm_open - open method for DRM file
111 * @inode: device inode
112 * @filp: file pointer.
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000113 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100114 * This function must be used by drivers as their .open() #file_operations
115 * method. It looks up the correct DRM device and instantiates all the per-file
116 * resources for it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100118 * RETURNS:
119 *
120 * 0 on success or negative errno value on falure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000122int drm_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
David Herrmann1616c522014-01-29 10:49:19 +0100124 struct drm_device *dev;
Dave Airlie2c14f282008-04-21 16:47:32 +1000125 struct drm_minor *minor;
David Herrmann1616c522014-01-29 10:49:19 +0100126 int retcode;
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000127 int need_setup = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
David Herrmann1616c522014-01-29 10:49:19 +0100129 minor = drm_minor_acquire(iminor(inode));
130 if (IS_ERR(minor))
131 return PTR_ERR(minor);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000132
David Herrmann1616c522014-01-29 10:49:19 +0100133 dev = minor->dev;
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000134 if (!dev->open_count++)
135 need_setup = 1;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800136
David Herrmann6796cb12014-01-03 14:24:19 +0100137 /* share address_space across all char-devs of a single device */
138 filp->f_mapping = dev->anon_inode->i_mapping;
Dave Airlied985c102006-01-02 21:32:48 +1100139
Ilija Hadzic1dcc0ce2014-04-28 10:23:57 -0400140 retcode = drm_open_helper(filp, minor);
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000141 if (retcode)
142 goto err_undo;
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000143 if (need_setup) {
144 retcode = drm_setup(dev);
145 if (retcode)
146 goto err_undo;
147 }
148 return 0;
149
150err_undo:
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000151 dev->open_count--;
David Herrmann1616c522014-01-29 10:49:19 +0100152 drm_minor_release(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 return retcode;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000154}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155EXPORT_SYMBOL(drm_open);
156
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100157/*
Dave Airlied985c102006-01-02 21:32:48 +1100158 * Check whether DRI will run on this CPU.
159 *
160 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
161 */
162static int drm_cpu_valid(void)
163{
Dave Airlied985c102006-01-02 21:32:48 +1100164#if defined(__sparc__) && !defined(__sparc_v9__)
165 return 0; /* No cmpxchg before v9 sparc. */
166#endif
167 return 1;
168}
169
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100170/*
Thomas Hellstroma0af2e52015-12-02 09:24:46 -0800171 * drm_new_set_master - Allocate a new master object and become master for the
172 * associated master realm.
173 *
174 * @dev: The associated device.
175 * @fpriv: File private identifying the client.
176 *
177 * This function must be called with dev::struct_mutex held.
178 * Returns negative error code on failure. Zero on success.
179 */
180int drm_new_set_master(struct drm_device *dev, struct drm_file *fpriv)
181{
182 struct drm_master *old_master;
183 int ret;
184
185 lockdep_assert_held_once(&dev->master_mutex);
186
187 /* create a new master */
188 fpriv->minor->master = drm_master_create(fpriv->minor);
189 if (!fpriv->minor->master)
190 return -ENOMEM;
191
192 /* take another reference for the copy in the local file priv */
193 old_master = fpriv->master;
194 fpriv->master = drm_master_get(fpriv->minor->master);
195
196 if (dev->driver->master_create) {
197 ret = dev->driver->master_create(dev, fpriv->master);
198 if (ret)
199 goto out_err;
200 }
201 if (dev->driver->master_set) {
202 ret = dev->driver->master_set(dev, fpriv, true);
203 if (ret)
204 goto out_err;
205 }
206
207 fpriv->is_master = 1;
208 fpriv->allowed_master = 1;
209 fpriv->authenticated = 1;
210 if (old_master)
211 drm_master_put(&old_master);
212
213 return 0;
214
215out_err:
216 /* drop both references and restore old master on failure */
217 drm_master_put(&fpriv->minor->master);
218 drm_master_put(&fpriv->master);
219 fpriv->master = old_master;
220
221 return ret;
222}
223
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100224/*
Dave Airlied985c102006-01-02 21:32:48 +1100225 * Called whenever a process opens /dev/drm.
226 *
Dave Airlied985c102006-01-02 21:32:48 +1100227 * \param filp file pointer.
David Herrmannf4aede22014-01-29 10:18:02 +0100228 * \param minor acquired minor-object.
Dave Airlied985c102006-01-02 21:32:48 +1100229 * \return zero on success or a negative number on failure.
230 *
231 * Creates and initializes a drm_file structure for the file private data in \p
232 * filp and add it into the double linked list in \p dev.
233 */
Ilija Hadzic1dcc0ce2014-04-28 10:23:57 -0400234static int drm_open_helper(struct file *filp, struct drm_minor *minor)
Dave Airlied985c102006-01-02 21:32:48 +1100235{
David Herrmannf4aede22014-01-29 10:18:02 +0100236 struct drm_device *dev = minor->dev;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000237 struct drm_file *priv;
Dave Airlied985c102006-01-02 21:32:48 +1100238 int ret;
239
240 if (filp->f_flags & O_EXCL)
241 return -EBUSY; /* No exclusive opens */
242 if (!drm_cpu_valid())
243 return -EINVAL;
Dave Airlie13bb9cc2012-09-12 15:55:05 +1000244 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
Dave Airlie5bcf7192010-12-07 09:20:40 +1000245 return -EINVAL;
Dave Airlied985c102006-01-02 21:32:48 +1100246
David Herrmannf4aede22014-01-29 10:18:02 +0100247 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
Dave Airlied985c102006-01-02 21:32:48 +1100248
Julia Lawall6ebc22e2010-05-13 21:58:56 +0200249 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
Dave Airlied985c102006-01-02 21:32:48 +1100250 if (!priv)
251 return -ENOMEM;
252
Dave Airlied985c102006-01-02 21:32:48 +1100253 filp->private_data = priv;
Eric Anholt6c340ea2007-08-25 20:23:09 +1000254 priv->filp = filp;
David Howells2df68b42008-09-02 11:03:14 +1000255 priv->uid = current_euid();
Eric W. Biederman5fce5e02012-02-07 16:47:26 -0800256 priv->pid = get_pid(task_pid(current));
David Herrmannf4aede22014-01-29 10:18:02 +0100257 priv->minor = minor;
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900258
Dave Airlied985c102006-01-02 21:32:48 +1100259 /* for compatibility root is always authenticated */
David Herrmann3cb01a92014-07-22 17:12:26 +0200260 priv->authenticated = capable(CAP_SYS_ADMIN);
Dave Airlied985c102006-01-02 21:32:48 +1100261 priv->lock_count = 0;
262
Dave Airliebd1b3312007-05-26 05:01:51 +1000263 INIT_LIST_HEAD(&priv->lhead);
Dave Airlief453ba02008-11-07 14:05:41 -0800264 INIT_LIST_HEAD(&priv->fbs);
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100265 mutex_init(&priv->fbs_lock);
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100266 INIT_LIST_HEAD(&priv->blobs);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000267 INIT_LIST_HEAD(&priv->event_list);
268 init_waitqueue_head(&priv->event_wait);
269 priv->event_space = 4096; /* set aside 4k for event buffer */
Dave Airliebd1b3312007-05-26 05:01:51 +1000270
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000271 mutex_init(&priv->event_read_lock);
272
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200273 if (drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700274 drm_gem_open(dev, priv);
275
Dave Airlie32488772011-11-25 15:21:02 +0000276 if (drm_core_check_feature(dev, DRIVER_PRIME))
277 drm_prime_init_file_private(&priv->prime);
278
Dave Airlied985c102006-01-02 21:32:48 +1100279 if (dev->driver->open) {
280 ret = dev->driver->open(dev, priv);
281 if (ret < 0)
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900282 goto out_prime_destroy;
Dave Airlied985c102006-01-02 21:32:48 +1100283 }
284
David Herrmann17931262013-08-25 18:29:00 +0200285 /* if there is no current master make this fd it, but do not create
286 * any master object for render clients */
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100287 mutex_lock(&dev->master_mutex);
Thomas Hellstrom43683052014-03-13 11:07:44 +0100288 if (drm_is_primary_client(priv) && !priv->minor->master) {
Dave Airlie7c1c2872008-11-28 14:22:24 +1000289 /* create a new master */
Thomas Hellstroma0af2e52015-12-02 09:24:46 -0800290 ret = drm_new_set_master(dev, priv);
291 if (ret)
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900292 goto out_close;
Thomas Hellstrom43683052014-03-13 11:07:44 +0100293 } else if (drm_is_primary_client(priv)) {
Dave Airlie7c1c2872008-11-28 14:22:24 +1000294 /* get a reference to the master */
295 priv->master = drm_master_get(priv->minor->master);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000296 }
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100297 mutex_unlock(&dev->master_mutex);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000298
299 mutex_lock(&dev->struct_mutex);
Dave Airliebd1b3312007-05-26 05:01:51 +1000300 list_add(&priv->lhead, &dev->filelist);
Dave Airlie30e2fb12006-02-02 19:37:46 +1100301 mutex_unlock(&dev->struct_mutex);
Dave Airlied985c102006-01-02 21:32:48 +1100302
303#ifdef __alpha__
304 /*
305 * Default the hose
306 */
307 if (!dev->hose) {
308 struct pci_dev *pci_dev;
309 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
310 if (pci_dev) {
311 dev->hose = pci_dev->sysdata;
312 pci_dev_put(pci_dev);
313 }
314 if (!dev->hose) {
Yijing Wang59c1ad3b2014-02-13 21:14:00 +0800315 struct pci_bus *b = list_entry(pci_root_buses.next,
316 struct pci_bus, node);
Dave Airlied985c102006-01-02 21:32:48 +1100317 if (b)
318 dev->hose = b->sysdata;
319 }
320 }
321#endif
322
323 return 0;
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900324
325out_close:
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100326 mutex_unlock(&dev->master_mutex);
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900327 if (dev->driver->postclose)
328 dev->driver->postclose(dev, priv);
329out_prime_destroy:
330 if (drm_core_check_feature(dev, DRIVER_PRIME))
331 drm_prime_destroy_file_private(&priv->prime);
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200332 if (drm_core_check_feature(dev, DRIVER_GEM))
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900333 drm_gem_release(dev, priv);
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900334 put_pid(priv->pid);
Eric Anholt9a298b22009-03-24 12:23:04 -0700335 kfree(priv);
Dave Airlied985c102006-01-02 21:32:48 +1100336 filp->private_data = NULL;
337 return ret;
338}
339
Dave Airlie7c1c2872008-11-28 14:22:24 +1000340static void drm_master_release(struct drm_device *dev, struct file *filp)
341{
342 struct drm_file *file_priv = filp->private_data;
343
David Herrmannbb6d8222014-08-29 12:12:46 +0200344 if (drm_legacy_i_have_hw_lock(dev, file_priv)) {
Dave Airlie7c1c2872008-11-28 14:22:24 +1000345 DRM_DEBUG("File %p released, freeing lock for context %d\n",
346 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
David Herrmannbb6d8222014-08-29 12:12:46 +0200347 drm_legacy_lock_free(&file_priv->master->lock,
348 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
Dave Airlie7c1c2872008-11-28 14:22:24 +1000349 }
Dave Airlie7c1c2872008-11-28 14:22:24 +1000350}
351
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000352static void drm_events_release(struct drm_file *file_priv)
353{
354 struct drm_device *dev = file_priv->minor->dev;
355 struct drm_pending_event *e, *et;
356 struct drm_pending_vblank_event *v, *vt;
357 unsigned long flags;
358
359 spin_lock_irqsave(&dev->event_lock, flags);
360
361 /* Remove pending flips */
362 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
363 if (v->base.file_priv == file_priv) {
364 list_del(&v->base.link);
365 drm_vblank_put(dev, v->pipe);
366 v->base.destroy(&v->base);
367 }
368
369 /* Remove unconsumed events */
YoungJun Cho1dda6802013-10-29 20:30:26 +0900370 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
371 list_del(&e->link);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000372 e->destroy(e);
YoungJun Cho1dda6802013-10-29 20:30:26 +0900373 }
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000374
375 spin_unlock_irqrestore(&dev->event_lock, flags);
376}
377
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100378/*
David Herrmann1c8887d2013-10-02 11:23:36 +0200379 * drm_legacy_dev_reinit
380 *
381 * Reinitializes a legacy/ums drm device in it's lastclose function.
382 */
383static void drm_legacy_dev_reinit(struct drm_device *dev)
384{
David Herrmann1c8887d2013-10-02 11:23:36 +0200385 if (drm_core_check_feature(dev, DRIVER_MODESET))
386 return;
387
David Herrmann1c8887d2013-10-02 11:23:36 +0200388 dev->sigdata.lock = NULL;
389
390 dev->context_flag = 0;
391 dev->last_context = 0;
392 dev->if_version = 0;
393}
394
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100395/*
David Herrmann1c8887d2013-10-02 11:23:36 +0200396 * Take down the DRM device.
397 *
398 * \param dev DRM device structure.
399 *
400 * Frees every resource in \p dev.
401 *
402 * \sa drm_device
403 */
404int drm_lastclose(struct drm_device * dev)
405{
David Herrmann1c8887d2013-10-02 11:23:36 +0200406 DRM_DEBUG("\n");
407
408 if (dev->driver->lastclose)
409 dev->driver->lastclose(dev);
410 DRM_DEBUG("driver lastclose completed\n");
411
412 if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
413 drm_irq_uninstall(dev);
414
415 mutex_lock(&dev->struct_mutex);
416
417 drm_agp_clear(dev);
418
419 drm_legacy_sg_cleanup(dev);
David Herrmann03decbe2014-08-29 12:12:29 +0200420 drm_legacy_vma_flush(dev);
David Herrmann1c8887d2013-10-02 11:23:36 +0200421 drm_legacy_dma_takedown(dev);
422
David Herrmann1c8887d2013-10-02 11:23:36 +0200423 mutex_unlock(&dev->struct_mutex);
424
425 drm_legacy_dev_reinit(dev);
426
427 DRM_DEBUG("lastclose completed\n");
428 return 0;
429}
430
431/**
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100432 * drm_release - release method for DRM file
433 * @inode: device inode
434 * @filp: file pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100436 * This function must be used by drivers as their .release() #file_operations
437 * method. It frees any resources associated with the open file, and if this is
438 * the last open file for the DRM device also proceeds to call drm_lastclose().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100440 * RETURNS:
441 *
442 * Always succeeds and returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000444int drm_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
Eric Anholt6c340ea2007-08-25 20:23:09 +1000446 struct drm_file *file_priv = filp->private_data;
David Herrmann1616c522014-01-29 10:49:19 +0100447 struct drm_minor *minor = file_priv->minor;
448 struct drm_device *dev = minor->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 int retcode = 0;
450
Arnd Bergmann58374712010-07-10 23:51:39 +0200451 mutex_lock(&drm_global_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000453 DRM_DEBUG("open_count = %d\n", dev->open_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Chris Wilsondff01de2014-07-24 14:23:10 +0100455 mutex_lock(&dev->struct_mutex);
456 list_del(&file_priv->lhead);
David Herrmann32e7b942015-05-04 21:01:30 +0200457 if (file_priv->magic)
458 idr_remove(&file_priv->master->magic_map, file_priv->magic);
Chris Wilsondff01de2014-07-24 14:23:10 +0100459 mutex_unlock(&dev->struct_mutex);
460
Dave Airlie22eae942005-11-10 22:16:34 +1100461 if (dev->driver->preclose)
Eric Anholt6c340ea2007-08-25 20:23:09 +1000462 dev->driver->preclose(dev, file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
464 /* ========================================================
465 * Begin inline drm_release
466 */
467
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000468 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700469 task_pid_nr(current),
David Herrmann58178782014-01-29 13:12:31 +0100470 (long)old_encode_dev(file_priv->minor->kdev->devt),
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000471 dev->open_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Dave Airlie7c1c2872008-11-28 14:22:24 +1000473 /* if the master has gone away we can't do anything with the lock */
474 if (file_priv->minor->master)
475 drm_master_release(dev, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Daniel Vetter67cb4b42011-10-26 00:31:26 +0200477 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
Daniel Vettera2661622014-09-11 07:41:51 +0200478 drm_legacy_reclaim_buffers(dev, file_priv);
Daniel Vetter67cb4b42011-10-26 00:31:26 +0200479
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000480 drm_events_release(file_priv);
481
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100482 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500483 drm_fb_release(file_priv);
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100484 drm_property_destroy_user_blobs(dev, file_priv);
485 }
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500486
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200487 if (drm_core_check_feature(dev, DRIVER_GEM))
Prathyush4e47e022012-04-14 17:22:13 +0530488 drm_gem_release(dev, file_priv);
489
David Herrmanne7b960702014-07-24 12:10:04 +0200490 drm_legacy_ctxbitmap_flush(dev, file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100492 mutex_lock(&dev->master_mutex);
Dave Airliebd1b3312007-05-26 05:01:51 +1000493
Dave Airlie7963e9d2014-08-08 07:30:53 +1000494 if (file_priv->is_master) {
Thomas Hellstromfda714c2009-03-02 11:10:56 +0100495 struct drm_master *master = file_priv->master;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000496
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100497 /*
Thomas Hellstromfda714c2009-03-02 11:10:56 +0100498 * Since the master is disappearing, so is the
499 * possibility to lock.
500 */
David Herrmann3cb01a92014-07-22 17:12:26 +0200501 mutex_lock(&dev->struct_mutex);
Thomas Hellstromfda714c2009-03-02 11:10:56 +0100502 if (master->lock.hw_lock) {
503 if (dev->sigdata.lock == master->lock.hw_lock)
504 dev->sigdata.lock = NULL;
505 master->lock.hw_lock = NULL;
506 master->lock.file_priv = NULL;
507 wake_up_interruptible_all(&master->lock.lock_queue);
508 }
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100509 mutex_unlock(&dev->struct_mutex);
Thomas Hellstromfda714c2009-03-02 11:10:56 +0100510
Dave Airlie7c1c2872008-11-28 14:22:24 +1000511 if (file_priv->minor->master == file_priv->master) {
512 /* drop the reference held my the minor */
Thomas Hellstrom862302f2009-12-02 18:15:25 +0000513 if (dev->driver->master_drop)
514 dev->driver->master_drop(dev, file_priv, true);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000515 drm_master_put(&file_priv->minor->master);
516 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 }
Dave Airlie7c1c2872008-11-28 14:22:24 +1000518
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100519 /* drop the master reference held by the file priv */
David Herrmann17931262013-08-25 18:29:00 +0200520 if (file_priv->master)
521 drm_master_put(&file_priv->master);
Dave Airlie7963e9d2014-08-08 07:30:53 +1000522 file_priv->is_master = 0;
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100523 mutex_unlock(&dev->master_mutex);
524
Dave Airlie22eae942005-11-10 22:16:34 +1100525 if (dev->driver->postclose)
Eric Anholt6c340ea2007-08-25 20:23:09 +1000526 dev->driver->postclose(dev, file_priv);
Dave Airlie32488772011-11-25 15:21:02 +0000527
Daniel Vetter319c9332013-08-15 00:02:46 +0200528
Dave Airlie32488772011-11-25 15:21:02 +0000529 if (drm_core_check_feature(dev, DRIVER_PRIME))
530 drm_prime_destroy_file_private(&file_priv->prime);
531
Ville Syrjäläddde4372014-08-06 14:02:50 +0300532 WARN_ON(!list_empty(&file_priv->event_list));
533
Eric W. Biederman5fce5e02012-02-07 16:47:26 -0800534 put_pid(file_priv->pid);
Eric Anholt9a298b22009-03-24 12:23:04 -0700535 kfree(file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
537 /* ========================================================
538 * End inline drm_release
539 */
540
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000541 if (!--dev->open_count) {
Daniel Vetter43d13372013-12-11 11:35:08 +0100542 retcode = drm_lastclose(dev);
Dave Airlie2c07a212012-02-20 14:18:07 +0000543 if (drm_device_is_unplugged(dev))
544 drm_put_dev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 }
Arnd Bergmann58374712010-07-10 23:51:39 +0200546 mutex_unlock(&drm_global_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
David Herrmann1616c522014-01-29 10:49:19 +0100548 drm_minor_release(minor);
549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 return retcode;
551}
552EXPORT_SYMBOL(drm_release);
553
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100554/**
555 * drm_read - read method for DRM file
556 * @filp: file pointer
557 * @buffer: userspace destination pointer for the read
558 * @count: count in bytes to read
559 * @offset: offset to read
560 *
561 * This function must be used by drivers as their .read() #file_operations
562 * method iff they use DRM events for asynchronous signalling to userspace.
563 * Since events are used by the KMS API for vblank and page flip completion this
564 * means all modern display drivers must use it.
565 *
566 * @offset is ignore, DRM events are read like a pipe. Therefore drivers also
567 * must set the .llseek() #file_operation to no_llseek(). Polling support is
568 * provided by drm_poll().
569 *
570 * This function will only ever read a full event. Therefore userspace must
571 * supply a big enough buffer to fit any event to ensure forward progress. Since
572 * the maximum event space is currently 4K it's recommended to just use that for
573 * safety.
574 *
575 * RETURNS:
576 *
577 * Number of bytes read (always aligned to full events, and can be 0) or a
578 * negative error code on failure.
579 */
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000580ssize_t drm_read(struct file *filp, char __user *buffer,
581 size_t count, loff_t *offset)
582{
583 struct drm_file *file_priv = filp->private_data;
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000584 struct drm_device *dev = file_priv->minor->dev;
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000585 ssize_t ret;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000586
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000587 if (!access_ok(VERIFY_WRITE, buffer, count))
588 return -EFAULT;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000589
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000590 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
591 if (ret)
592 return ret;
593
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000594 for (;;) {
Chris Wilson83eb64c2015-11-25 14:39:02 +0000595 struct drm_pending_event *e = NULL;
596
597 spin_lock_irq(&dev->event_lock);
598 if (!list_empty(&file_priv->event_list)) {
599 e = list_first_entry(&file_priv->event_list,
600 struct drm_pending_event, link);
601 file_priv->event_space += e->event->length;
602 list_del(&e->link);
603 }
604 spin_unlock_irq(&dev->event_lock);
605
606 if (e == NULL) {
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000607 if (ret)
608 break;
609
610 if (filp->f_flags & O_NONBLOCK) {
611 ret = -EAGAIN;
612 break;
613 }
614
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000615 mutex_unlock(&file_priv->event_read_lock);
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000616 ret = wait_event_interruptible(file_priv->event_wait,
617 !list_empty(&file_priv->event_list));
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000618 if (ret >= 0)
619 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
620 if (ret)
621 return ret;
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000622 } else {
Chris Wilson83eb64c2015-11-25 14:39:02 +0000623 unsigned length = e->event->length;
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000624
Chris Wilson83eb64c2015-11-25 14:39:02 +0000625 if (length > count - ret) {
626put_back_event:
627 spin_lock_irq(&dev->event_lock);
628 file_priv->event_space -= length;
629 list_add(&e->link, &file_priv->event_list);
630 spin_unlock_irq(&dev->event_lock);
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000631 break;
632 }
633
Chris Wilson83eb64c2015-11-25 14:39:02 +0000634 if (copy_to_user(buffer + ret, e->event, length)) {
635 if (ret == 0)
636 ret = -EFAULT;
637 goto put_back_event;
638 }
639
640 ret += length;
Takashi Iwaia0a0bde2014-12-04 11:56:42 +0100641 e->destroy(e);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000642 }
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000643 }
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000644 mutex_unlock(&file_priv->event_read_lock);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000645
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000646 return ret;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000647}
648EXPORT_SYMBOL(drm_read);
649
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100650/**
651 * drm_poll - poll method for DRM file
652 * @filp: file pointer
653 * @wait: poll waiter table
654 *
655 * This function must be used by drivers as their .read() #file_operations
656 * method iff they use DRM events for asynchronous signalling to userspace.
657 * Since events are used by the KMS API for vblank and page flip completion this
658 * means all modern display drivers must use it.
659 *
660 * See also drm_read().
661 *
662 * RETURNS:
663 *
664 * Mask of POLL flags indicating the current status of the file.
665 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
667{
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000668 struct drm_file *file_priv = filp->private_data;
669 unsigned int mask = 0;
670
671 poll_wait(filp, &file_priv->event_wait, wait);
672
673 if (!list_empty(&file_priv->event_list))
674 mask |= POLLIN | POLLRDNORM;
675
676 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000678EXPORT_SYMBOL(drm_poll);
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100679
680/**
Daniel Vetter4020b222016-01-28 12:01:04 +0100681 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
682 * @dev: DRM device
683 * @file_priv: DRM file private data
684 * @p: tracking structure for the pending event
685 * @e: actual event data to deliver to userspace
686 *
687 * This function prepares the passed in event for eventual delivery. If the event
688 * doesn't get delivered (because the IOCTL fails later on, before queuing up
689 * anything) then the even must be cancelled and freed using
690 * drm_event_cancel_free(). Successfully initialized events should be sent out
691 * using drm_send_event() or drm_send_event_locked() to signal completion of the
692 * asynchronous event to userspace.
693 *
694 * If callers embedded @p into a larger structure it must be allocated with
695 * kmalloc and @p must be the first member element.
696 *
697 * This is the locked version of drm_event_reserve_init() for callers which
698 * already hold dev->event_lock.
699 *
700 * RETURNS:
701 *
702 * 0 on success or a negative error code on failure.
703 */
704int drm_event_reserve_init_locked(struct drm_device *dev,
705 struct drm_file *file_priv,
706 struct drm_pending_event *p,
707 struct drm_event *e)
708{
709 if (file_priv->event_space < e->length)
710 return -ENOMEM;
711
712 file_priv->event_space -= e->length;
713
714 p->event = e;
715 p->file_priv = file_priv;
716
717 /* we *could* pass this in as arg, but everyone uses kfree: */
718 p->destroy = (void (*) (struct drm_pending_event *)) kfree;
719
720 return 0;
721}
722EXPORT_SYMBOL(drm_event_reserve_init_locked);
723
724/**
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100725 * drm_event_reserve_init - init a DRM event and reserve space for it
726 * @dev: DRM device
727 * @file_priv: DRM file private data
728 * @p: tracking structure for the pending event
729 * @e: actual event data to deliver to userspace
730 *
731 * This function prepares the passed in event for eventual delivery. If the event
732 * doesn't get delivered (because the IOCTL fails later on, before queuing up
733 * anything) then the even must be cancelled and freed using
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100734 * drm_event_cancel_free(). Successfully initialized events should be sent out
735 * using drm_send_event() or drm_send_event_locked() to signal completion of the
736 * asynchronous event to userspace.
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100737 *
738 * If callers embedded @p into a larger structure it must be allocated with
739 * kmalloc and @p must be the first member element.
740 *
Daniel Vetter4020b222016-01-28 12:01:04 +0100741 * Callers which already hold dev->event_lock should use
742 * drm_event_reserve_init() instead.
743 *
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100744 * RETURNS:
745 *
746 * 0 on success or a negative error code on failure.
747 */
748int drm_event_reserve_init(struct drm_device *dev,
749 struct drm_file *file_priv,
750 struct drm_pending_event *p,
751 struct drm_event *e)
752{
753 unsigned long flags;
Daniel Vetter4020b222016-01-28 12:01:04 +0100754 int ret;
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100755
756 spin_lock_irqsave(&dev->event_lock, flags);
Daniel Vetter4020b222016-01-28 12:01:04 +0100757 ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100758 spin_unlock_irqrestore(&dev->event_lock, flags);
Daniel Vetter4020b222016-01-28 12:01:04 +0100759
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100760 return ret;
761}
762EXPORT_SYMBOL(drm_event_reserve_init);
763
764/**
765 * drm_event_cancel_free - free a DRM event and release it's space
766 * @dev: DRM device
767 * @p: tracking structure for the pending event
768 *
769 * This function frees the event @p initialized with drm_event_reserve_init()
770 * and releases any allocated space.
771 */
772void drm_event_cancel_free(struct drm_device *dev,
773 struct drm_pending_event *p)
774{
775 unsigned long flags;
776 spin_lock_irqsave(&dev->event_lock, flags);
777 p->file_priv->event_space += p->event->length;
778 spin_unlock_irqrestore(&dev->event_lock, flags);
779 p->destroy(p);
780}
781EXPORT_SYMBOL(drm_event_cancel_free);
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100782
783/**
784 * drm_send_event_locked - send DRM event to file descriptor
785 * @dev: DRM device
786 * @e: DRM event to deliver
787 *
788 * This function sends the event @e, initialized with drm_event_reserve_init(),
789 * to its associated userspace DRM file. Callers must already hold
790 * dev->event_lock, see drm_send_event() for the unlocked version.
791 */
792void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
793{
794 assert_spin_locked(&dev->event_lock);
795
796 list_add_tail(&e->link,
797 &e->file_priv->event_list);
798 wake_up_interruptible(&e->file_priv->event_wait);
799}
800EXPORT_SYMBOL(drm_send_event_locked);
801
802/**
803 * drm_send_event - send DRM event to file descriptor
804 * @dev: DRM device
805 * @e: DRM event to deliver
806 *
807 * This function sends the event @e, initialized with drm_event_reserve_init(),
808 * to its associated userspace DRM file. This function acquires dev->event_lock,
809 * see drm_send_event_locked() for callers which already hold this lock.
810 */
811void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
812{
813 unsigned long irqflags;
814
815 spin_lock_irqsave(&dev->event_lock, irqflags);
816 drm_send_event_locked(dev, e);
817 spin_unlock_irqrestore(&dev->event_lock, irqflags);
818}
819EXPORT_SYMBOL(drm_send_event);