Branch data Line data Source code
1 : : /*
2 : : * Created: Tue Feb 2 08:37:54 1999 by faith@valinux.com
3 : : *
4 : : * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 : : * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6 : : * All Rights Reserved.
7 : : *
8 : : * Author Rickard E. (Rik) Faith <faith@valinux.com>
9 : : * Author Gareth Hughes <gareth@valinux.com>
10 : : *
11 : : * Permission is hereby granted, free of charge, to any person obtaining a
12 : : * copy of this software and associated documentation files (the "Software"),
13 : : * to deal in the Software without restriction, including without limitation
14 : : * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 : : * and/or sell copies of the Software, and to permit persons to whom the
16 : : * Software is furnished to do so, subject to the following conditions:
17 : : *
18 : : * The above copyright notice and this permission notice (including the next
19 : : * paragraph) shall be included in all copies or substantial portions of the
20 : : * Software.
21 : : *
22 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 : : * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26 : : * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27 : : * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28 : : * OTHER DEALINGS IN THE SOFTWARE.
29 : : */
30 : :
31 : : #include <linux/slab.h>
32 : :
33 : : #include <drm/drm_auth.h>
34 : : #include <drm/drm_drv.h>
35 : : #include <drm/drm_file.h>
36 : : #include <drm/drm_lease.h>
37 : : #include <drm/drm_print.h>
38 : :
39 : : #include "drm_internal.h"
40 : : #include "drm_legacy.h"
41 : :
42 : : /**
43 : : * DOC: master and authentication
44 : : *
45 : : * &struct drm_master is used to track groups of clients with open
46 : : * primary/legacy device nodes. For every &struct drm_file which has had at
47 : : * least once successfully became the device master (either through the
48 : : * SET_MASTER IOCTL, or implicitly through opening the primary device node when
49 : : * no one else is the current master that time) there exists one &drm_master.
50 : : * This is noted in &drm_file.is_master. All other clients have just a pointer
51 : : * to the &drm_master they are associated with.
52 : : *
53 : : * In addition only one &drm_master can be the current master for a &drm_device.
54 : : * It can be switched through the DROP_MASTER and SET_MASTER IOCTL, or
55 : : * implicitly through closing/openeing the primary device node. See also
56 : : * drm_is_current_master().
57 : : *
58 : : * Clients can authenticate against the current master (if it matches their own)
59 : : * using the GETMAGIC and AUTHMAGIC IOCTLs. Together with exchanging masters,
60 : : * this allows controlled access to the device for an entire group of mutually
61 : : * trusted clients.
62 : : */
63 : :
64 : 0 : int drm_getmagic(struct drm_device *dev, void *data, struct drm_file *file_priv)
65 : : {
66 : 0 : struct drm_auth *auth = data;
67 : 0 : int ret = 0;
68 : :
69 : 0 : mutex_lock(&dev->master_mutex);
70 [ # # ]: 0 : if (!file_priv->magic) {
71 : 0 : ret = idr_alloc(&file_priv->master->magic_map, file_priv,
72 : : 1, 0, GFP_KERNEL);
73 [ # # ]: 0 : if (ret >= 0)
74 : 0 : file_priv->magic = ret;
75 : : }
76 : 0 : auth->magic = file_priv->magic;
77 : 0 : mutex_unlock(&dev->master_mutex);
78 : :
79 : 0 : DRM_DEBUG("%u\n", auth->magic);
80 : :
81 : 0 : return ret < 0 ? ret : 0;
82 : : }
83 : :
84 : 0 : int drm_authmagic(struct drm_device *dev, void *data,
85 : : struct drm_file *file_priv)
86 : : {
87 : 0 : struct drm_auth *auth = data;
88 : 0 : struct drm_file *file;
89 : :
90 : 0 : DRM_DEBUG("%u\n", auth->magic);
91 : :
92 : 0 : mutex_lock(&dev->master_mutex);
93 : 0 : file = idr_find(&file_priv->master->magic_map, auth->magic);
94 [ # # ]: 0 : if (file) {
95 : 0 : file->authenticated = 1;
96 : 0 : idr_replace(&file_priv->master->magic_map, NULL, auth->magic);
97 : : }
98 : 0 : mutex_unlock(&dev->master_mutex);
99 : :
100 [ # # ]: 0 : return file ? 0 : -EINVAL;
101 : : }
102 : :
103 : 0 : struct drm_master *drm_master_create(struct drm_device *dev)
104 : : {
105 : 0 : struct drm_master *master;
106 : :
107 : 0 : master = kzalloc(sizeof(*master), GFP_KERNEL);
108 [ # # ]: 0 : if (!master)
109 : : return NULL;
110 : :
111 : 0 : kref_init(&master->refcount);
112 : 0 : drm_master_legacy_init(master);
113 : 0 : idr_init(&master->magic_map);
114 : 0 : master->dev = dev;
115 : :
116 : : /* initialize the tree of output resource lessees */
117 : 0 : INIT_LIST_HEAD(&master->lessees);
118 : 0 : INIT_LIST_HEAD(&master->lessee_list);
119 : 0 : idr_init(&master->leases);
120 : 0 : idr_init(&master->lessee_idr);
121 : :
122 : 0 : return master;
123 : : }
124 : :
125 : 0 : static int drm_set_master(struct drm_device *dev, struct drm_file *fpriv,
126 : : bool new_master)
127 : : {
128 : 0 : int ret = 0;
129 : :
130 : 0 : dev->master = drm_master_get(fpriv->master);
131 : 0 : if (dev->driver->master_set) {
132 : 0 : ret = dev->driver->master_set(dev, fpriv, new_master);
133 [ # # ]: 0 : if (unlikely(ret != 0)) {
134 : 0 : drm_master_put(&dev->master);
135 : : }
136 : : }
137 : :
138 : 0 : return ret;
139 : : }
140 : :
141 : 0 : static int drm_new_set_master(struct drm_device *dev, struct drm_file *fpriv)
142 : : {
143 : 0 : struct drm_master *old_master;
144 : 0 : int ret;
145 : :
146 : 0 : lockdep_assert_held_once(&dev->master_mutex);
147 : :
148 [ # # ]: 0 : WARN_ON(fpriv->is_master);
149 : 0 : old_master = fpriv->master;
150 : 0 : fpriv->master = drm_master_create(dev);
151 [ # # ]: 0 : if (!fpriv->master) {
152 : 0 : fpriv->master = old_master;
153 : 0 : return -ENOMEM;
154 : : }
155 : :
156 [ # # ]: 0 : if (dev->driver->master_create) {
157 : 0 : ret = dev->driver->master_create(dev, fpriv->master);
158 [ # # ]: 0 : if (ret)
159 : 0 : goto out_err;
160 : : }
161 : 0 : fpriv->is_master = 1;
162 : 0 : fpriv->authenticated = 1;
163 : :
164 : 0 : ret = drm_set_master(dev, fpriv, true);
165 [ # # ]: 0 : if (ret)
166 : 0 : goto out_err;
167 : :
168 [ # # ]: 0 : if (old_master)
169 : 0 : drm_master_put(&old_master);
170 : :
171 : : return 0;
172 : :
173 : 0 : out_err:
174 : : /* drop references and restore old master on failure */
175 : 0 : drm_master_put(&fpriv->master);
176 : 0 : fpriv->master = old_master;
177 : 0 : fpriv->is_master = 0;
178 : :
179 : 0 : return ret;
180 : : }
181 : :
182 : 0 : int drm_setmaster_ioctl(struct drm_device *dev, void *data,
183 : : struct drm_file *file_priv)
184 : : {
185 : 0 : int ret = 0;
186 : :
187 : 0 : mutex_lock(&dev->master_mutex);
188 [ # # ]: 0 : if (drm_is_current_master(file_priv))
189 : 0 : goto out_unlock;
190 : :
191 [ # # ]: 0 : if (dev->master) {
192 : 0 : ret = -EINVAL;
193 : 0 : goto out_unlock;
194 : : }
195 : :
196 [ # # ]: 0 : if (!file_priv->master) {
197 : 0 : ret = -EINVAL;
198 : 0 : goto out_unlock;
199 : : }
200 : :
201 [ # # ]: 0 : if (!file_priv->is_master) {
202 : 0 : ret = drm_new_set_master(dev, file_priv);
203 : 0 : goto out_unlock;
204 : : }
205 : :
206 [ # # ]: 0 : if (file_priv->master->lessor != NULL) {
207 : 0 : DRM_DEBUG_LEASE("Attempt to set lessee %d as master\n", file_priv->master->lessee_id);
208 : 0 : ret = -EINVAL;
209 : 0 : goto out_unlock;
210 : : }
211 : :
212 : 0 : ret = drm_set_master(dev, file_priv, false);
213 : 0 : out_unlock:
214 : 0 : mutex_unlock(&dev->master_mutex);
215 : 0 : return ret;
216 : : }
217 : :
218 : 0 : static void drm_drop_master(struct drm_device *dev,
219 : : struct drm_file *fpriv)
220 : : {
221 [ # # ]: 0 : if (dev->driver->master_drop)
222 : 0 : dev->driver->master_drop(dev, fpriv);
223 : 0 : drm_master_put(&dev->master);
224 : 0 : }
225 : :
226 : 0 : int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
227 : : struct drm_file *file_priv)
228 : : {
229 : 0 : int ret = -EINVAL;
230 : :
231 : 0 : mutex_lock(&dev->master_mutex);
232 [ # # ]: 0 : if (!drm_is_current_master(file_priv))
233 : 0 : goto out_unlock;
234 : :
235 [ # # ]: 0 : if (!dev->master)
236 : 0 : goto out_unlock;
237 : :
238 [ # # ]: 0 : if (file_priv->master->lessor != NULL) {
239 : 0 : DRM_DEBUG_LEASE("Attempt to drop lessee %d as master\n", file_priv->master->lessee_id);
240 : 0 : ret = -EINVAL;
241 : 0 : goto out_unlock;
242 : : }
243 : :
244 : 0 : ret = 0;
245 : 0 : drm_drop_master(dev, file_priv);
246 : 0 : out_unlock:
247 : 0 : mutex_unlock(&dev->master_mutex);
248 : 0 : return ret;
249 : : }
250 : :
251 : 0 : int drm_master_open(struct drm_file *file_priv)
252 : : {
253 : 0 : struct drm_device *dev = file_priv->minor->dev;
254 : 0 : int ret = 0;
255 : :
256 : : /* if there is no current master make this fd it, but do not create
257 : : * any master object for render clients */
258 : 0 : mutex_lock(&dev->master_mutex);
259 [ # # ]: 0 : if (!dev->master)
260 : 0 : ret = drm_new_set_master(dev, file_priv);
261 : : else
262 : 0 : file_priv->master = drm_master_get(dev->master);
263 : 0 : mutex_unlock(&dev->master_mutex);
264 : :
265 : 0 : return ret;
266 : : }
267 : :
268 : 0 : void drm_master_release(struct drm_file *file_priv)
269 : : {
270 : 0 : struct drm_device *dev = file_priv->minor->dev;
271 : 0 : struct drm_master *master = file_priv->master;
272 : :
273 : 0 : mutex_lock(&dev->master_mutex);
274 [ # # ]: 0 : if (file_priv->magic)
275 : 0 : idr_remove(&file_priv->master->magic_map, file_priv->magic);
276 : :
277 [ # # ]: 0 : if (!drm_is_current_master(file_priv))
278 : 0 : goto out;
279 : :
280 [ # # ]: 0 : drm_legacy_lock_master_cleanup(dev, master);
281 : :
282 [ # # ]: 0 : if (dev->master == file_priv->master)
283 : 0 : drm_drop_master(dev, file_priv);
284 : 0 : out:
285 [ # # # # ]: 0 : if (drm_core_check_feature(dev, DRIVER_MODESET) && file_priv->is_master) {
286 : : /* Revoke any leases held by this or lessees, but only if
287 : : * this is the "real" master
288 : : */
289 : 0 : drm_lease_revoke(master);
290 : : }
291 : :
292 : : /* drop the master reference held by the file priv */
293 [ # # ]: 0 : if (file_priv->master)
294 : 0 : drm_master_put(&file_priv->master);
295 : 0 : mutex_unlock(&dev->master_mutex);
296 : 0 : }
297 : :
298 : : /**
299 : : * drm_is_current_master - checks whether @priv is the current master
300 : : * @fpriv: DRM file private
301 : : *
302 : : * Checks whether @fpriv is current master on its device. This decides whether a
303 : : * client is allowed to run DRM_MASTER IOCTLs.
304 : : *
305 : : * Most of the modern IOCTL which require DRM_MASTER are for kernel modesetting
306 : : * - the current master is assumed to own the non-shareable display hardware.
307 : : */
308 : 0 : bool drm_is_current_master(struct drm_file *fpriv)
309 : : {
310 [ # # # # ]: 0 : return fpriv->is_master && drm_lease_owner(fpriv->master) == fpriv->minor->dev->master;
311 : : }
312 : : EXPORT_SYMBOL(drm_is_current_master);
313 : :
314 : : /**
315 : : * drm_master_get - reference a master pointer
316 : : * @master: &struct drm_master
317 : : *
318 : : * Increments the reference count of @master and returns a pointer to @master.
319 : : */
320 : 0 : struct drm_master *drm_master_get(struct drm_master *master)
321 : : {
322 : 0 : kref_get(&master->refcount);
323 [ # # ]: 0 : return master;
324 : : }
325 : : EXPORT_SYMBOL(drm_master_get);
326 : :
327 : 0 : static void drm_master_destroy(struct kref *kref)
328 : : {
329 : 0 : struct drm_master *master = container_of(kref, struct drm_master, refcount);
330 : 0 : struct drm_device *dev = master->dev;
331 : :
332 [ # # ]: 0 : if (drm_core_check_feature(dev, DRIVER_MODESET))
333 : 0 : drm_lease_destroy(master);
334 : :
335 [ # # ]: 0 : if (dev->driver->master_destroy)
336 : 0 : dev->driver->master_destroy(dev, master);
337 : :
338 : 0 : drm_legacy_master_rmmaps(dev, master);
339 : :
340 : 0 : idr_destroy(&master->magic_map);
341 : 0 : idr_destroy(&master->leases);
342 : 0 : idr_destroy(&master->lessee_idr);
343 : :
344 : 0 : kfree(master->unique);
345 : 0 : kfree(master);
346 : 0 : }
347 : :
348 : : /**
349 : : * drm_master_put - unreference and clear a master pointer
350 : : * @master: pointer to a pointer of &struct drm_master
351 : : *
352 : : * This decrements the &drm_master behind @master and sets it to NULL.
353 : : */
354 : 0 : void drm_master_put(struct drm_master **master)
355 : : {
356 : 0 : kref_put(&(*master)->refcount, drm_master_destroy);
357 : 0 : *master = NULL;
358 : 0 : }
359 : : EXPORT_SYMBOL(drm_master_put);
360 : :
361 : : /* Used by drm_client and drm_fb_helper */
362 : 0 : bool drm_master_internal_acquire(struct drm_device *dev)
363 : : {
364 : 0 : mutex_lock(&dev->master_mutex);
365 [ # # ]: 0 : if (dev->master) {
366 : 0 : mutex_unlock(&dev->master_mutex);
367 : 0 : return false;
368 : : }
369 : :
370 : : return true;
371 : : }
372 : : EXPORT_SYMBOL(drm_master_internal_acquire);
373 : :
374 : : /* Used by drm_client and drm_fb_helper */
375 : 0 : void drm_master_internal_release(struct drm_device *dev)
376 : : {
377 : 0 : mutex_unlock(&dev->master_mutex);
378 : 0 : }
379 : : EXPORT_SYMBOL(drm_master_internal_release);
|