2 * Copyright © 2017 Keith Packard <keithp@keithp.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
16 #include "drm_internal.h"
17 #include "drm_legacy.h"
18 #include "drm_crtc_internal.h"
19 #include <drm/drm_lease.h>
20 #include <drm/drm_auth.h>
21 #include <drm/drm_crtc_helper.h>
23 #define drm_for_each_lessee(lessee, lessor) \
24 list_for_each_entry((lessee), &(lessor)->lessees, lessee_list)
26 static uint64_t drm_lease_idr_object
;
29 * drm_lease_owner - return ancestor owner drm_master
30 * @master: drm_master somewhere within tree of lessees and lessors
34 * drm_master at the top of the tree (i.e, with lessor NULL
36 struct drm_master
*drm_lease_owner(struct drm_master
*master
)
38 while (master
->lessor
!= NULL
)
39 master
= master
->lessor
;
42 EXPORT_SYMBOL(drm_lease_owner
);
45 * _drm_find_lessee - find lessee by id (idr_mutex held)
46 * @master: drm_master of lessor
51 * drm_master of the lessee if valid, NULL otherwise
54 static struct drm_master
*
55 _drm_find_lessee(struct drm_master
*master
, int lessee_id
)
57 lockdep_assert_held(&master
->dev
->mode_config
.idr_mutex
);
58 return idr_find(&drm_lease_owner(master
)->lessee_idr
, lessee_id
);
62 * _drm_lease_held_master - check to see if an object is leased (or owned) by master (idr_mutex held)
63 * @master: the master to check the lease status of
64 * @id: the id to check
66 * Checks if the specified master holds a lease on the object. Return
69 * true 'master' holds a lease on (or owns) the object
70 * false 'master' does not hold a lease.
72 static int _drm_lease_held_master(struct drm_master
*master
, int id
)
74 lockdep_assert_held(&master
->dev
->mode_config
.idr_mutex
);
76 return idr_find(&master
->leases
, id
) != NULL
;
81 * _drm_has_leased - check to see if an object has been leased (idr_mutex held)
82 * @master: the master to check the lease status of
83 * @id: the id to check
85 * Checks if any lessee of 'master' holds a lease on 'id'. Return
88 * true Some lessee holds a lease on the object.
89 * false No lessee has a lease on the object.
91 static bool _drm_has_leased(struct drm_master
*master
, int id
)
93 struct drm_master
*lessee
;
95 lockdep_assert_held(&master
->dev
->mode_config
.idr_mutex
);
96 drm_for_each_lessee(lessee
, master
)
97 if (_drm_lease_held_master(lessee
, id
))
103 * _drm_lease_held - check drm_mode_object lease status (idr_mutex held)
104 * @file_priv: the master drm_file
107 * Checks if the specified master holds a lease on the object. Return
110 * true 'master' holds a lease on (or owns) the object
111 * false 'master' does not hold a lease.
113 bool _drm_lease_held(struct drm_file
*file_priv
, int id
)
115 if (file_priv
== NULL
|| file_priv
->master
== NULL
)
118 return _drm_lease_held_master(file_priv
->master
, id
);
120 EXPORT_SYMBOL(_drm_lease_held
);
123 * drm_lease_held - check drm_mode_object lease status (idr_mutex not held)
124 * @file_priv: the master drm_file
127 * Checks if the specified master holds a lease on the object. Return
130 * true 'master' holds a lease on (or owns) the object
131 * false 'master' does not hold a lease.
133 bool drm_lease_held(struct drm_file
*file_priv
, int id
)
135 struct drm_master
*master
;
138 if (file_priv
== NULL
|| file_priv
->master
== NULL
)
141 master
= file_priv
->master
;
142 mutex_lock(&master
->dev
->mode_config
.idr_mutex
);
143 ret
= _drm_lease_held_master(master
, id
);
144 mutex_unlock(&master
->dev
->mode_config
.idr_mutex
);
147 EXPORT_SYMBOL(drm_lease_held
);
150 * drm_lease_filter_crtcs - restricted crtc set to leased values (idr_mutex not held)
151 * @file_priv: requestor file
152 * @crtcs_in: bitmask of crtcs to check
154 * Reconstructs a crtc mask based on the crtcs which are visible
155 * through the specified file.
157 uint32_t drm_lease_filter_crtcs(struct drm_file
*file_priv
, uint32_t crtcs_in
)
159 struct drm_master
*master
;
160 struct drm_device
*dev
;
161 struct drm_crtc
*crtc
;
162 int count_in
, count_out
;
163 uint32_t crtcs_out
= 0;
165 if (file_priv
== NULL
|| file_priv
->master
== NULL
)
168 master
= file_priv
->master
;
171 count_in
= count_out
= 0;
172 mutex_lock(&master
->dev
->mode_config
.idr_mutex
);
173 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
, head
) {
174 if (_drm_lease_held_master(master
, crtc
->base
.id
)) {
175 uint32_t mask_in
= 1ul << count_in
;
176 if ((crtcs_in
& mask_in
) != 0) {
177 uint32_t mask_out
= 1ul << count_out
;
178 crtcs_out
|= mask_out
;
184 mutex_unlock(&master
->dev
->mode_config
.idr_mutex
);
187 EXPORT_SYMBOL(drm_lease_filter_crtcs
);
190 * drm_lease_create - create a new drm_master with leased objects (idr_mutex not held)
191 * @lessor: lease holder (or owner) of objects
192 * @leases: objects to lease to the new drm_master
194 * Uses drm_master_create to allocate a new drm_master, then checks to
195 * make sure all of the desired objects can be leased, atomically
196 * leasing them to the new drmmaster.
198 * ERR_PTR(-EACCESS) some other master holds the title to any object
199 * ERR_PTR(-ENOENT) some object is not a valid DRM object for this device
200 * ERR_PTR(-EBUSY) some other lessee holds title to this object
201 * ERR_PTR(-EEXIST) same object specified more than once in the provided list
202 * ERR_PTR(-ENOMEM) allocation failed
204 static struct drm_master
*drm_lease_create(struct drm_master
*lessor
, struct idr
*leases
)
206 struct drm_device
*dev
= lessor
->dev
;
208 struct drm_master
*lessee
;
213 DRM_DEBUG_LEASE("lessor %d\n", lessor
->lessee_id
);
215 lessee
= drm_master_create(lessor
->dev
);
217 DRM_DEBUG_LEASE("drm_master_create failed\n");
218 return ERR_PTR(-ENOMEM
);
221 mutex_lock(&dev
->mode_config
.idr_mutex
);
223 idr_for_each_entry(leases
, entry
, object
) {
225 if (!idr_find(&dev
->mode_config
.crtc_idr
, object
))
227 else if (!_drm_lease_held_master(lessor
, object
))
229 else if (_drm_has_leased(lessor
, object
))
233 DRM_DEBUG_LEASE("object %d failed %d\n", object
, error
);
238 /* Insert the new lessee into the tree */
239 id
= idr_alloc(&(drm_lease_owner(lessor
)->lessee_idr
), lessee
, 1, 0, GFP_KERNEL
);
245 lessee
->lessee_id
= id
;
246 lessee
->lessor
= drm_master_get(lessor
);
247 list_add_tail(&lessee
->lessee_list
, &lessor
->lessees
);
249 /* Move the leases over */
250 lessee
->leases
= *leases
;
251 DRM_DEBUG_LEASE("new lessee %d %p, lessor %d %p\n", lessee
->lessee_id
, lessee
, lessor
->lessee_id
, lessor
);
253 mutex_unlock(&dev
->mode_config
.idr_mutex
);
257 mutex_unlock(&dev
->mode_config
.idr_mutex
);
259 drm_master_put(&lessee
);
261 return ERR_PTR(error
);
265 * drm_lease_destroy - a master is going away (idr_mutex not held)
266 * @master: the drm_master being destroyed
268 * All lessees will have been destroyed as they
269 * hold a reference on their lessor. Notify any
270 * lessor for this master so that it can check
271 * the list of lessees.
273 void drm_lease_destroy(struct drm_master
*master
)
275 struct drm_device
*dev
= master
->dev
;
277 mutex_lock(&dev
->mode_config
.idr_mutex
);
279 DRM_DEBUG_LEASE("drm_lease_destroy %d\n", master
->lessee_id
);
281 /* This master is referenced by all lessees, hence it cannot be destroyed
282 * until all of them have been
284 WARN_ON(!list_empty(&master
->lessees
));
286 /* Remove this master from the lessee idr in the owner */
287 if (master
->lessee_id
!= 0) {
288 DRM_DEBUG_LEASE("remove master %d from device list of lessees\n", master
->lessee_id
);
289 idr_remove(&(drm_lease_owner(master
)->lessee_idr
), master
->lessee_id
);
292 /* Remove this master from any lessee list it may be on */
293 list_del(&master
->lessee_list
);
295 mutex_unlock(&dev
->mode_config
.idr_mutex
);
297 if (master
->lessor
) {
298 /* Tell the master to check the lessee list */
299 drm_sysfs_lease_event(dev
);
300 drm_master_put(&master
->lessor
);
303 DRM_DEBUG_LEASE("drm_lease_destroy done %d\n", master
->lessee_id
);
307 * _drm_lease_revoke - revoke access to all leased objects (idr_mutex held)
308 * @top: the master losing its lease
310 static void _drm_lease_revoke(struct drm_master
*top
)
314 struct drm_master
*master
= top
;
316 lockdep_assert_held(&top
->dev
->mode_config
.idr_mutex
);
319 * Walk the tree starting at 'top' emptying all leases. Because
320 * the tree is fully connected, we can do this without recursing
323 DRM_DEBUG_LEASE("revoke leases for %p %d\n", master
, master
->lessee_id
);
325 /* Evacuate the lease */
326 idr_for_each_entry(&master
->leases
, entry
, object
)
327 idr_remove(&master
->leases
, object
);
329 /* Depth-first list walk */
332 if (!list_empty(&master
->lessees
)) {
333 master
= list_first_entry(&master
->lessees
, struct drm_master
, lessee_list
);
336 while (master
!= top
&& master
== list_last_entry(&master
->lessor
->lessees
, struct drm_master
, lessee_list
))
337 master
= master
->lessor
;
343 master
= list_next_entry(master
, lessee_list
);
349 * drm_lease_revoke - revoke access to all leased objects (idr_mutex not held)
350 * @top: the master losing its lease
352 void drm_lease_revoke(struct drm_master
*top
)
354 mutex_lock(&top
->dev
->mode_config
.idr_mutex
);
355 _drm_lease_revoke(top
);
356 mutex_unlock(&top
->dev
->mode_config
.idr_mutex
);
359 static int validate_lease(struct drm_device
*dev
,
360 struct drm_file
*lessor_priv
,
362 struct drm_mode_object
**objects
)
366 int has_connector
= -1;
369 /* we want to confirm that there is at least one crtc, plane
372 for (o
= 0; o
< object_count
; o
++) {
373 if (objects
[o
]->type
== DRM_MODE_OBJECT_CRTC
&& has_crtc
== -1) {
376 if (objects
[o
]->type
== DRM_MODE_OBJECT_CONNECTOR
&& has_connector
== -1)
379 if (lessor_priv
->universal_planes
) {
380 if (objects
[o
]->type
== DRM_MODE_OBJECT_PLANE
&& has_plane
== -1)
384 if (has_crtc
== -1 || has_connector
== -1)
386 if (lessor_priv
->universal_planes
&& has_plane
== -1)
391 static int fill_object_idr(struct drm_device
*dev
,
392 struct drm_file
*lessor_priv
,
397 struct drm_mode_object
**objects
;
400 objects
= kcalloc(object_count
, sizeof(struct drm_mode_object
*),
405 /* step one - get references to all the mode objects
406 and check for validity. */
407 for (o
= 0; o
< object_count
; o
++) {
408 if ((int) object_ids
[o
] < 0) {
410 goto out_free_objects
;
413 objects
[o
] = drm_mode_object_find(dev
, lessor_priv
,
415 DRM_MODE_OBJECT_ANY
);
418 goto out_free_objects
;
421 if (!drm_mode_object_lease_required(objects
[o
]->type
)) {
423 goto out_free_objects
;
427 ret
= validate_lease(dev
, lessor_priv
, object_count
, objects
);
429 goto out_free_objects
;
431 /* add their IDs to the lease request - taking into account
433 for (o
= 0; o
< object_count
; o
++) {
434 struct drm_mode_object
*obj
= objects
[o
];
435 u32 object_id
= objects
[o
]->id
;
436 DRM_DEBUG_LEASE("Adding object %d to lease\n", object_id
);
439 * We're using an IDR to hold the set of leased
440 * objects, but we don't need to point at the object's
441 * data structure from the lease as the main crtc_idr
442 * will be used to actually find that. Instead, all we
443 * really want is a 'leased/not-leased' result, for
444 * which any non-NULL pointer will work fine.
446 ret
= idr_alloc(leases
, &drm_lease_idr_object
, object_id
, object_id
+ 1, GFP_KERNEL
);
448 DRM_DEBUG_LEASE("Object %d cannot be inserted into leases (%d)\n",
450 goto out_free_objects
;
452 if (obj
->type
== DRM_MODE_OBJECT_CRTC
&& !lessor_priv
->universal_planes
) {
453 struct drm_crtc
*crtc
= obj_to_crtc(obj
);
454 ret
= idr_alloc(leases
, &drm_lease_idr_object
, crtc
->primary
->base
.id
, crtc
->primary
->base
.id
+ 1, GFP_KERNEL
);
456 DRM_DEBUG_LEASE("Object primary plane %d cannot be inserted into leases (%d)\n",
458 goto out_free_objects
;
461 ret
= idr_alloc(leases
, &drm_lease_idr_object
, crtc
->cursor
->base
.id
, crtc
->cursor
->base
.id
+ 1, GFP_KERNEL
);
463 DRM_DEBUG_LEASE("Object cursor plane %d cannot be inserted into leases (%d)\n",
465 goto out_free_objects
;
473 for (o
= 0; o
< object_count
; o
++) {
475 drm_mode_object_put(objects
[o
]);
482 * drm_mode_create_lease_ioctl - create a new lease
483 * @dev: the drm device
484 * @data: pointer to struct drm_mode_create_lease
485 * @lessor_priv: the file being manipulated
487 * The master associated with the specified file will have a lease
488 * created containing the objects specified in the ioctl structure.
489 * A file descriptor will be allocated for that and returned to the
492 int drm_mode_create_lease_ioctl(struct drm_device
*dev
,
493 void *data
, struct drm_file
*lessor_priv
)
495 struct drm_mode_create_lease
*cl
= data
;
499 struct drm_master
*lessor
= lessor_priv
->master
;
500 struct drm_master
*lessee
= NULL
;
501 struct file
*lessee_file
= NULL
;
502 struct file
*lessor_file
= lessor_priv
->filp
;
503 struct drm_file
*lessee_priv
;
505 uint32_t *object_ids
;
507 /* Can't lease without MODESET */
508 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
511 /* Do not allow sub-leases */
515 /* need some objects */
516 if (cl
->object_count
== 0)
519 if (cl
->flags
&& (cl
->flags
& ~(O_CLOEXEC
| O_NONBLOCK
)))
522 object_count
= cl
->object_count
;
524 object_ids
= memdup_user(u64_to_user_ptr(cl
->object_ids
),
525 array_size(object_count
, sizeof(__u32
)));
526 if (IS_ERR(object_ids
))
527 return PTR_ERR(object_ids
);
531 /* fill and validate the object idr */
532 ret
= fill_object_idr(dev
, lessor_priv
, &leases
,
533 object_count
, object_ids
);
536 idr_destroy(&leases
);
540 /* Allocate a file descriptor for the lease */
541 fd
= get_unused_fd_flags(cl
->flags
& (O_CLOEXEC
| O_NONBLOCK
));
543 idr_destroy(&leases
);
547 DRM_DEBUG_LEASE("Creating lease\n");
548 /* lessee will take the ownership of leases */
549 lessee
= drm_lease_create(lessor
, &leases
);
551 if (IS_ERR(lessee
)) {
552 ret
= PTR_ERR(lessee
);
553 idr_destroy(&leases
);
557 /* Clone the lessor file to create a new file for us */
558 DRM_DEBUG_LEASE("Allocating lease file\n");
559 lessee_file
= file_clone_open(lessor_file
);
560 if (IS_ERR(lessee_file
)) {
561 ret
= PTR_ERR(lessee_file
);
565 lessee_priv
= lessee_file
->private_data
;
566 /* Change the file to a master one */
567 drm_master_put(&lessee_priv
->master
);
568 lessee_priv
->master
= lessee
;
569 lessee_priv
->is_master
= 1;
570 lessee_priv
->authenticated
= 1;
572 /* Pass fd back to userspace */
573 DRM_DEBUG_LEASE("Returning fd %d id %d\n", fd
, lessee
->lessee_id
);
575 cl
->lessee_id
= lessee
->lessee_id
;
578 fd_install(fd
, lessee_file
);
580 DRM_DEBUG_LEASE("drm_mode_create_lease_ioctl succeeded\n");
584 drm_master_put(&lessee
);
589 DRM_DEBUG_LEASE("drm_mode_create_lease_ioctl failed: %d\n", ret
);
594 * drm_mode_list_lessees_ioctl - list lessee ids
595 * @dev: the drm device
596 * @data: pointer to struct drm_mode_list_lessees
597 * @lessor_priv: the file being manipulated
599 * Starting from the master associated with the specified file,
600 * the master with the provided lessee_id is found, and then
601 * an array of lessee ids associated with leases from that master
605 int drm_mode_list_lessees_ioctl(struct drm_device
*dev
,
606 void *data
, struct drm_file
*lessor_priv
)
608 struct drm_mode_list_lessees
*arg
= data
;
609 __u32 __user
*lessee_ids
= (__u32 __user
*) (uintptr_t) (arg
->lessees_ptr
);
610 __u32 count_lessees
= arg
->count_lessees
;
611 struct drm_master
*lessor
= lessor_priv
->master
, *lessee
;
618 /* Can't lease without MODESET */
619 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
622 DRM_DEBUG_LEASE("List lessees for %d\n", lessor
->lessee_id
);
624 mutex_lock(&dev
->mode_config
.idr_mutex
);
627 drm_for_each_lessee(lessee
, lessor
) {
628 /* Only list un-revoked leases */
629 if (!idr_is_empty(&lessee
->leases
)) {
630 if (count_lessees
> count
) {
631 DRM_DEBUG_LEASE("Add lessee %d\n", lessee
->lessee_id
);
632 ret
= put_user(lessee
->lessee_id
, lessee_ids
+ count
);
640 DRM_DEBUG_LEASE("Lessor leases to %d\n", count
);
642 arg
->count_lessees
= count
;
644 mutex_unlock(&dev
->mode_config
.idr_mutex
);
650 * drm_mode_get_lease_ioctl - list leased objects
651 * @dev: the drm device
652 * @data: pointer to struct drm_mode_get_lease
653 * @lessee_priv: the file being manipulated
655 * Return the list of leased objects for the specified lessee
658 int drm_mode_get_lease_ioctl(struct drm_device
*dev
,
659 void *data
, struct drm_file
*lessee_priv
)
661 struct drm_mode_get_lease
*arg
= data
;
662 __u32 __user
*object_ids
= (__u32 __user
*) (uintptr_t) (arg
->objects_ptr
);
663 __u32 count_objects
= arg
->count_objects
;
664 struct drm_master
*lessee
= lessee_priv
->master
;
665 struct idr
*object_idr
;
674 /* Can't lease without MODESET */
675 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
678 DRM_DEBUG_LEASE("get lease for %d\n", lessee
->lessee_id
);
680 mutex_lock(&dev
->mode_config
.idr_mutex
);
682 if (lessee
->lessor
== NULL
)
683 /* owner can use all objects */
684 object_idr
= &lessee
->dev
->mode_config
.crtc_idr
;
686 /* lessee can only use allowed object */
687 object_idr
= &lessee
->leases
;
690 idr_for_each_entry(object_idr
, entry
, object
) {
691 if (count_objects
> count
) {
692 DRM_DEBUG_LEASE("adding object %d\n", object
);
693 ret
= put_user(object
, object_ids
+ count
);
700 DRM_DEBUG("lease holds %d objects\n", count
);
702 arg
->count_objects
= count
;
704 mutex_unlock(&dev
->mode_config
.idr_mutex
);
710 * drm_mode_revoke_lease_ioctl - revoke lease
711 * @dev: the drm device
712 * @data: pointer to struct drm_mode_revoke_lease
713 * @lessor_priv: the file being manipulated
715 * This removes all of the objects from the lease without
716 * actually getting rid of the lease itself; that way all
717 * references to it still work correctly
719 int drm_mode_revoke_lease_ioctl(struct drm_device
*dev
,
720 void *data
, struct drm_file
*lessor_priv
)
722 struct drm_mode_revoke_lease
*arg
= data
;
723 struct drm_master
*lessor
= lessor_priv
->master
;
724 struct drm_master
*lessee
;
727 DRM_DEBUG_LEASE("revoke lease for %d\n", arg
->lessee_id
);
729 /* Can't lease without MODESET */
730 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
733 mutex_lock(&dev
->mode_config
.idr_mutex
);
735 lessee
= _drm_find_lessee(lessor
, arg
->lessee_id
);
743 /* Lease is not held by lessor */
744 if (lessee
->lessor
!= lessor
) {
749 _drm_lease_revoke(lessee
);
752 mutex_unlock(&dev
->mode_config
.idr_mutex
);