1 // SPDX-License-Identifier: GPL-2.0-or-later
5 #include <linux/file.h>
6 #include <linux/uaccess.h>
8 #include <drm/drm_auth.h>
9 #include <drm/drm_crtc_helper.h>
10 #include <drm/drm_drv.h>
11 #include <drm/drm_file.h>
12 #include <drm/drm_lease.h>
13 #include <drm/drm_print.h>
15 #include "drm_crtc_internal.h"
16 #include "drm_internal.h"
18 #define drm_for_each_lessee(lessee, lessor) \
19 list_for_each_entry((lessee), &(lessor)->lessees, lessee_list)
21 static uint64_t drm_lease_idr_object;
24 * drm_lease_owner - return ancestor owner drm_master
25 * @master: drm_master somewhere within tree of lessees and lessors
29 * drm_master at the top of the tree (i.e, with lessor NULL
31 struct drm_master *drm_lease_owner(struct drm_master *master)
33 while (master->lessor != NULL)
34 master = master->lessor;
39 * _drm_find_lessee - find lessee by id (idr_mutex held)
40 * @master: drm_master of lessor
45 * drm_master of the lessee if valid, NULL otherwise
48 static struct drm_master*
49 _drm_find_lessee(struct drm_master *master, int lessee_id)
51 lockdep_assert_held(&master->dev->mode_config.idr_mutex);
52 return idr_find(&drm_lease_owner(master)->lessee_idr, lessee_id);
56 * _drm_lease_held_master - check to see if an object is leased (or owned) by master (idr_mutex held)
57 * @master: the master to check the lease status of
58 * @id: the id to check
60 * Checks if the specified master holds a lease on the object. Return
63 * true 'master' holds a lease on (or owns) the object
64 * false 'master' does not hold a lease.
66 static int _drm_lease_held_master(struct drm_master *master, int id)
68 lockdep_assert_held(&master->dev->mode_config.idr_mutex);
70 return idr_find(&master->leases, id) != NULL;
75 * _drm_has_leased - check to see if an object has been leased (idr_mutex held)
76 * @master: the master to check the lease status of
77 * @id: the id to check
79 * Checks if any lessee of 'master' holds a lease on 'id'. Return
82 * true Some lessee holds a lease on the object.
83 * false No lessee has a lease on the object.
85 static bool _drm_has_leased(struct drm_master *master, int id)
87 struct drm_master *lessee;
89 lockdep_assert_held(&master->dev->mode_config.idr_mutex);
90 drm_for_each_lessee(lessee, master)
91 if (_drm_lease_held_master(lessee, id))
97 * _drm_lease_held - check drm_mode_object lease status (idr_mutex held)
98 * @file_priv: the master drm_file
101 * Checks if the specified master holds a lease on the object. Return
104 * true 'master' holds a lease on (or owns) the object
105 * false 'master' does not hold a lease.
107 bool _drm_lease_held(struct drm_file *file_priv, int id)
109 if (!file_priv || !file_priv->master)
112 return _drm_lease_held_master(file_priv->master, id);
116 * drm_lease_held - check drm_mode_object lease status (idr_mutex not held)
117 * @file_priv: the master drm_file
120 * Checks if the specified master holds a lease on the object. Return
123 * true 'master' holds a lease on (or owns) the object
124 * false 'master' does not hold a lease.
126 bool drm_lease_held(struct drm_file *file_priv, int id)
128 struct drm_master *master;
131 if (!file_priv || !file_priv->master || !file_priv->master->lessor)
134 master = file_priv->master;
135 mutex_lock(&master->dev->mode_config.idr_mutex);
136 ret = _drm_lease_held_master(master, id);
137 mutex_unlock(&master->dev->mode_config.idr_mutex);
142 * drm_lease_filter_crtcs - restricted crtc set to leased values (idr_mutex not held)
143 * @file_priv: requestor file
144 * @crtcs_in: bitmask of crtcs to check
146 * Reconstructs a crtc mask based on the crtcs which are visible
147 * through the specified file.
149 uint32_t drm_lease_filter_crtcs(struct drm_file *file_priv, uint32_t crtcs_in)
151 struct drm_master *master;
152 struct drm_device *dev;
153 struct drm_crtc *crtc;
154 int count_in, count_out;
155 uint32_t crtcs_out = 0;
157 if (!file_priv || !file_priv->master || !file_priv->master->lessor)
160 master = file_priv->master;
163 count_in = count_out = 0;
164 mutex_lock(&master->dev->mode_config.idr_mutex);
165 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
166 if (_drm_lease_held_master(master, crtc->base.id)) {
167 uint32_t mask_in = 1ul << count_in;
169 if ((crtcs_in & mask_in) != 0) {
170 uint32_t mask_out = 1ul << count_out;
172 crtcs_out |= mask_out;
178 mutex_unlock(&master->dev->mode_config.idr_mutex);
183 * drm_lease_create - create a new drm_master with leased objects (idr_mutex not held)
184 * @lessor: lease holder (or owner) of objects
185 * @leases: objects to lease to the new drm_master
187 * Uses drm_master_create to allocate a new drm_master, then checks to
188 * make sure all of the desired objects can be leased, atomically
189 * leasing them to the new drmmaster.
191 * ERR_PTR(-EACCES) some other master holds the title to any object
192 * ERR_PTR(-ENOENT) some object is not a valid DRM object for this device
193 * ERR_PTR(-EBUSY) some other lessee holds title to this object
194 * ERR_PTR(-EEXIST) same object specified more than once in the provided list
195 * ERR_PTR(-ENOMEM) allocation failed
197 static struct drm_master *drm_lease_create(struct drm_master *lessor, struct idr *leases)
199 struct drm_device *dev = lessor->dev;
201 struct drm_master *lessee;
206 DRM_DEBUG_LEASE("lessor %d\n", lessor->lessee_id);
208 lessee = drm_master_create(lessor->dev);
210 DRM_DEBUG_LEASE("drm_master_create failed\n");
211 return ERR_PTR(-ENOMEM);
214 mutex_lock(&dev->mode_config.idr_mutex);
216 idr_for_each_entry(leases, entry, object) {
218 if (!idr_find(&dev->mode_config.object_idr, object))
220 else if (_drm_has_leased(lessor, object))
224 DRM_DEBUG_LEASE("object %d failed %d\n", object, error);
229 /* Insert the new lessee into the tree */
230 id = idr_alloc(&(drm_lease_owner(lessor)->lessee_idr), lessee, 1, 0, GFP_KERNEL);
236 lessee->lessee_id = id;
237 lessee->lessor = drm_master_get(lessor);
238 list_add_tail(&lessee->lessee_list, &lessor->lessees);
240 /* Move the leases over */
241 lessee->leases = *leases;
242 DRM_DEBUG_LEASE("new lessee %d %p, lessor %d %p\n", lessee->lessee_id, lessee, lessor->lessee_id, lessor);
244 mutex_unlock(&dev->mode_config.idr_mutex);
248 mutex_unlock(&dev->mode_config.idr_mutex);
250 drm_master_put(&lessee);
252 return ERR_PTR(error);
256 * drm_lease_destroy - a master is going away (idr_mutex not held)
257 * @master: the drm_master being destroyed
259 * All lessees will have been destroyed as they
260 * hold a reference on their lessor. Notify any
261 * lessor for this master so that it can check
262 * the list of lessees.
264 void drm_lease_destroy(struct drm_master *master)
266 struct drm_device *dev = master->dev;
268 mutex_lock(&dev->mode_config.idr_mutex);
270 DRM_DEBUG_LEASE("drm_lease_destroy %d\n", master->lessee_id);
272 /* This master is referenced by all lessees, hence it cannot be destroyed
273 * until all of them have been
275 WARN_ON(!list_empty(&master->lessees));
277 /* Remove this master from the lessee idr in the owner */
278 if (master->lessee_id != 0) {
279 DRM_DEBUG_LEASE("remove master %d from device list of lessees\n", master->lessee_id);
280 idr_remove(&(drm_lease_owner(master)->lessee_idr), master->lessee_id);
283 /* Remove this master from any lessee list it may be on */
284 list_del(&master->lessee_list);
286 mutex_unlock(&dev->mode_config.idr_mutex);
288 if (master->lessor) {
289 /* Tell the master to check the lessee list */
290 drm_sysfs_lease_event(dev);
291 drm_master_put(&master->lessor);
294 DRM_DEBUG_LEASE("drm_lease_destroy done %d\n", master->lessee_id);
298 * _drm_lease_revoke - revoke access to all leased objects (idr_mutex held)
299 * @top: the master losing its lease
301 static void _drm_lease_revoke(struct drm_master *top)
305 struct drm_master *master = top;
307 lockdep_assert_held(&top->dev->mode_config.idr_mutex);
310 * Walk the tree starting at 'top' emptying all leases. Because
311 * the tree is fully connected, we can do this without recursing
314 DRM_DEBUG_LEASE("revoke leases for %p %d\n", master, master->lessee_id);
316 /* Evacuate the lease */
317 idr_for_each_entry(&master->leases, entry, object)
318 idr_remove(&master->leases, object);
320 /* Depth-first list walk */
323 if (!list_empty(&master->lessees)) {
324 master = list_first_entry(&master->lessees, struct drm_master, lessee_list);
327 while (master != top && master == list_last_entry(&master->lessor->lessees, struct drm_master, lessee_list))
328 master = master->lessor;
334 master = list_next_entry(master, lessee_list);
340 * drm_lease_revoke - revoke access to all leased objects (idr_mutex not held)
341 * @top: the master losing its lease
343 void drm_lease_revoke(struct drm_master *top)
345 mutex_lock(&top->dev->mode_config.idr_mutex);
346 _drm_lease_revoke(top);
347 mutex_unlock(&top->dev->mode_config.idr_mutex);
350 static int validate_lease(struct drm_device *dev,
352 struct drm_mode_object **objects,
353 bool universal_planes)
357 int has_connector = -1;
360 /* we want to confirm that there is at least one crtc, plane
363 for (o = 0; o < object_count; o++) {
364 if (objects[o]->type == DRM_MODE_OBJECT_CRTC && has_crtc == -1) {
367 if (objects[o]->type == DRM_MODE_OBJECT_CONNECTOR && has_connector == -1)
370 if (universal_planes) {
371 if (objects[o]->type == DRM_MODE_OBJECT_PLANE && has_plane == -1)
375 if (has_crtc == -1 || has_connector == -1)
377 if (universal_planes && has_plane == -1)
382 static int fill_object_idr(struct drm_device *dev,
383 struct drm_file *lessor_priv,
388 struct drm_mode_object **objects;
391 bool universal_planes = READ_ONCE(lessor_priv->universal_planes);
393 objects = kcalloc(object_count, sizeof(struct drm_mode_object *),
398 /* step one - get references to all the mode objects
399 and check for validity. */
400 for (o = 0; o < object_count; o++) {
401 objects[o] = drm_mode_object_find(dev, lessor_priv,
403 DRM_MODE_OBJECT_ANY);
406 goto out_free_objects;
409 if (!drm_mode_object_lease_required(objects[o]->type)) {
410 DRM_DEBUG_KMS("invalid object for lease\n");
412 goto out_free_objects;
416 ret = validate_lease(dev, object_count, objects, universal_planes);
418 DRM_DEBUG_LEASE("lease validation failed\n");
419 goto out_free_objects;
422 /* add their IDs to the lease request - taking into account
424 for (o = 0; o < object_count; o++) {
425 struct drm_mode_object *obj = objects[o];
426 u32 object_id = objects[o]->id;
428 DRM_DEBUG_LEASE("Adding object %d to lease\n", object_id);
431 * We're using an IDR to hold the set of leased
432 * objects, but we don't need to point at the object's
433 * data structure from the lease as the main object_idr
434 * will be used to actually find that. Instead, all we
435 * really want is a 'leased/not-leased' result, for
436 * which any non-NULL pointer will work fine.
438 ret = idr_alloc(leases, &drm_lease_idr_object , object_id, object_id + 1, GFP_KERNEL);
440 DRM_DEBUG_LEASE("Object %d cannot be inserted into leases (%d)\n",
442 goto out_free_objects;
444 if (obj->type == DRM_MODE_OBJECT_CRTC && !universal_planes) {
445 struct drm_crtc *crtc = obj_to_crtc(obj);
447 ret = idr_alloc(leases, &drm_lease_idr_object, crtc->primary->base.id, crtc->primary->base.id + 1, GFP_KERNEL);
449 DRM_DEBUG_LEASE("Object primary plane %d cannot be inserted into leases (%d)\n",
451 goto out_free_objects;
454 ret = idr_alloc(leases, &drm_lease_idr_object, crtc->cursor->base.id, crtc->cursor->base.id + 1, GFP_KERNEL);
456 DRM_DEBUG_LEASE("Object cursor plane %d cannot be inserted into leases (%d)\n",
458 goto out_free_objects;
466 for (o = 0; o < object_count; o++) {
468 drm_mode_object_put(objects[o]);
475 * drm_mode_create_lease_ioctl - create a new lease
476 * @dev: the drm device
477 * @data: pointer to struct drm_mode_create_lease
478 * @lessor_priv: the file being manipulated
480 * The master associated with the specified file will have a lease
481 * created containing the objects specified in the ioctl structure.
482 * A file descriptor will be allocated for that and returned to the
485 int drm_mode_create_lease_ioctl(struct drm_device *dev,
486 void *data, struct drm_file *lessor_priv)
488 struct drm_mode_create_lease *cl = data;
492 struct drm_master *lessor = lessor_priv->master;
493 struct drm_master *lessee = NULL;
494 struct file *lessee_file = NULL;
495 struct file *lessor_file = lessor_priv->filp;
496 struct drm_file *lessee_priv;
498 uint32_t *object_ids;
500 /* Can't lease without MODESET */
501 if (!drm_core_check_feature(dev, DRIVER_MODESET))
504 /* Do not allow sub-leases */
505 if (lessor->lessor) {
506 DRM_DEBUG_LEASE("recursive leasing not allowed\n");
510 /* need some objects */
511 if (cl->object_count == 0) {
512 DRM_DEBUG_LEASE("no objects in lease\n");
516 if (cl->flags && (cl->flags & ~(O_CLOEXEC | O_NONBLOCK))) {
517 DRM_DEBUG_LEASE("invalid flags\n");
521 object_count = cl->object_count;
523 object_ids = memdup_user(u64_to_user_ptr(cl->object_ids),
524 array_size(object_count, sizeof(__u32)));
525 if (IS_ERR(object_ids))
526 return PTR_ERR(object_ids);
530 /* fill and validate the object idr */
531 ret = fill_object_idr(dev, lessor_priv, &leases,
532 object_count, object_ids);
535 DRM_DEBUG_LEASE("lease object lookup failed: %i\n", ret);
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.object_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);