1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright © 2017 Keith Packard <keithp@keithp.com>
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"
21 * DRM leases provide information about whether a DRM master may control a DRM
22 * mode setting object. This enables the creation of multiple DRM masters that
23 * manage subsets of display resources.
25 * The original DRM master of a device 'owns' the available drm resources. It
26 * may create additional DRM masters and 'lease' resources which it controls
27 * to the new DRM master. This gives the new DRM master control over the
28 * leased resources until the owner revokes the lease, or the new DRM master
29 * is closed. Some helpful terminology:
31 * - An 'owner' is a &struct drm_master that is not leasing objects from
32 * another &struct drm_master, and hence 'owns' the objects. The owner can be
33 * identified as the &struct drm_master for which &drm_master.lessor is NULL.
35 * - A 'lessor' is a &struct drm_master which is leasing objects to one or more
36 * other &struct drm_master. Currently, lessees are not allowed to
37 * create sub-leases, hence the lessor is the same as the owner.
39 * - A 'lessee' is a &struct drm_master which is leasing objects from some
40 * other &struct drm_master. Each lessee only leases resources from a single
41 * lessor recorded in &drm_master.lessor, and holds the set of objects that
42 * it is leasing in &drm_master.leases.
44 * - A 'lease' is a contract between the lessor and lessee that identifies
45 * which resources may be controlled by the lessee. All of the resources
46 * that are leased must be owned by or leased to the lessor, and lessors are
47 * not permitted to lease the same object to multiple lessees.
49 * The set of objects any &struct drm_master 'controls' is limited to the set
50 * of objects it leases (for lessees) or all objects (for owners).
52 * Objects not controlled by a &struct drm_master cannot be modified through
53 * the various state manipulating ioctls, and any state reported back to user
54 * space will be edited to make them appear idle and/or unusable. For
55 * instance, connectors always report 'disconnected', while encoders
56 * report no possible crtcs or clones.
58 * Since each lessee may lease objects from a single lessor, display resource
59 * leases form a tree of &struct drm_master. As lessees are currently not
60 * allowed to create sub-leases, the tree depth is limited to 1. All of
61 * these get activated simultaneously when the top level device owner changes
62 * through the SETMASTER or DROPMASTER IOCTL, so &drm_device.master points to
63 * the owner at the top of the lease tree (i.e. the &struct drm_master for which
64 * &drm_master.lessor is NULL). The full list of lessees that are leasing
65 * objects from the owner can be searched via the owner's
66 * &drm_master.lessee_idr.
69 #define drm_for_each_lessee(lessee, lessor) \
70 list_for_each_entry((lessee), &(lessor)->lessees, lessee_list)
72 static uint64_t drm_lease_idr_object;
74 struct drm_master *drm_lease_owner(struct drm_master *master)
76 while (master->lessor != NULL)
77 master = master->lessor;
81 static struct drm_master*
82 _drm_find_lessee(struct drm_master *master, int lessee_id)
84 lockdep_assert_held(&master->dev->mode_config.idr_mutex);
85 return idr_find(&drm_lease_owner(master)->lessee_idr, lessee_id);
88 static int _drm_lease_held_master(struct drm_master *master, int id)
90 lockdep_assert_held(&master->dev->mode_config.idr_mutex);
92 return idr_find(&master->leases, id) != NULL;
96 /* Checks if the given object has been leased to some lessee of drm_master */
97 static bool _drm_has_leased(struct drm_master *master, int id)
99 struct drm_master *lessee;
101 lockdep_assert_held(&master->dev->mode_config.idr_mutex);
102 drm_for_each_lessee(lessee, master)
103 if (_drm_lease_held_master(lessee, id))
108 /* Called with idr_mutex held */
109 bool _drm_lease_held(struct drm_file *file_priv, int id)
112 struct drm_master *master;
117 master = drm_file_get_master(file_priv);
120 ret = _drm_lease_held_master(master, id);
121 drm_master_put(&master);
126 bool drm_lease_held(struct drm_file *file_priv, int id)
128 struct drm_master *master;
134 master = drm_file_get_master(file_priv);
137 if (!master->lessor) {
141 mutex_lock(&master->dev->mode_config.idr_mutex);
142 ret = _drm_lease_held_master(master, id);
143 mutex_unlock(&master->dev->mode_config.idr_mutex);
146 drm_master_put(&master);
151 * Given a bitmask of crtcs to check, reconstructs a crtc mask based on the
152 * crtcs which are visible through the specified file.
154 uint32_t drm_lease_filter_crtcs(struct drm_file *file_priv, uint32_t crtcs_in)
156 struct drm_master *master;
157 struct drm_device *dev;
158 struct drm_crtc *crtc;
159 int count_in, count_out;
160 uint32_t crtcs_out = 0;
165 master = drm_file_get_master(file_priv);
168 if (!master->lessor) {
169 crtcs_out = crtcs_in;
174 count_in = count_out = 0;
175 mutex_lock(&master->dev->mode_config.idr_mutex);
176 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
177 if (_drm_lease_held_master(master, crtc->base.id)) {
178 uint32_t mask_in = 1ul << count_in;
180 if ((crtcs_in & mask_in) != 0) {
181 uint32_t mask_out = 1ul << count_out;
183 crtcs_out |= mask_out;
189 mutex_unlock(&master->dev->mode_config.idr_mutex);
192 drm_master_put(&master);
197 * Uses drm_master_create to allocate a new drm_master, then checks to
198 * make sure all of the desired objects can be leased, atomically
199 * leasing them to the new drmmaster.
201 * ERR_PTR(-EACCES) some other master holds the title to any object
202 * ERR_PTR(-ENOENT) some object is not a valid DRM object for this device
203 * ERR_PTR(-EBUSY) some other lessee holds title to this object
204 * ERR_PTR(-EEXIST) same object specified more than once in the provided list
205 * ERR_PTR(-ENOMEM) allocation failed
207 static struct drm_master *drm_lease_create(struct drm_master *lessor, struct idr *leases)
209 struct drm_device *dev = lessor->dev;
211 struct drm_master *lessee;
216 DRM_DEBUG_LEASE("lessor %d\n", lessor->lessee_id);
218 lessee = drm_master_create(lessor->dev);
220 DRM_DEBUG_LEASE("drm_master_create failed\n");
221 return ERR_PTR(-ENOMEM);
224 mutex_lock(&dev->mode_config.idr_mutex);
226 idr_for_each_entry(leases, entry, object) {
228 if (!idr_find(&dev->mode_config.object_idr, object))
230 else if (_drm_has_leased(lessor, object))
234 DRM_DEBUG_LEASE("object %d failed %d\n", object, error);
239 /* Insert the new lessee into the tree */
240 id = idr_alloc(&(drm_lease_owner(lessor)->lessee_idr), lessee, 1, 0, GFP_KERNEL);
246 lessee->lessee_id = id;
247 lessee->lessor = drm_master_get(lessor);
248 list_add_tail(&lessee->lessee_list, &lessor->lessees);
250 /* Move the leases over */
251 lessee->leases = *leases;
252 DRM_DEBUG_LEASE("new lessee %d %p, lessor %d %p\n", lessee->lessee_id, lessee, lessor->lessee_id, lessor);
254 mutex_unlock(&dev->mode_config.idr_mutex);
258 mutex_unlock(&dev->mode_config.idr_mutex);
260 drm_master_put(&lessee);
262 return ERR_PTR(error);
265 void drm_lease_destroy(struct drm_master *master)
267 struct drm_device *dev = master->dev;
269 mutex_lock(&dev->mode_config.idr_mutex);
271 DRM_DEBUG_LEASE("drm_lease_destroy %d\n", master->lessee_id);
273 /* This master is referenced by all lessees, hence it cannot be destroyed
274 * until all of them have been
276 WARN_ON(!list_empty(&master->lessees));
278 /* Remove this master from the lessee idr in the owner */
279 if (master->lessee_id != 0) {
280 DRM_DEBUG_LEASE("remove master %d from device list of lessees\n", master->lessee_id);
281 idr_remove(&(drm_lease_owner(master)->lessee_idr), master->lessee_id);
284 /* Remove this master from any lessee list it may be on */
285 list_del(&master->lessee_list);
287 mutex_unlock(&dev->mode_config.idr_mutex);
289 if (master->lessor) {
290 /* Tell the master to check the lessee list */
291 drm_sysfs_lease_event(dev);
292 drm_master_put(&master->lessor);
295 DRM_DEBUG_LEASE("drm_lease_destroy done %d\n", master->lessee_id);
298 static void _drm_lease_revoke(struct drm_master *top)
302 struct drm_master *master = top;
304 lockdep_assert_held(&top->dev->mode_config.idr_mutex);
307 * Walk the tree starting at 'top' emptying all leases. Because
308 * the tree is fully connected, we can do this without recursing
311 DRM_DEBUG_LEASE("revoke leases for %p %d\n", master, master->lessee_id);
313 /* Evacuate the lease */
314 idr_for_each_entry(&master->leases, entry, object)
315 idr_remove(&master->leases, object);
317 /* Depth-first list walk */
320 if (!list_empty(&master->lessees)) {
321 master = list_first_entry(&master->lessees, struct drm_master, lessee_list);
324 while (master != top && master == list_last_entry(&master->lessor->lessees, struct drm_master, lessee_list))
325 master = master->lessor;
331 master = list_next_entry(master, lessee_list);
336 void drm_lease_revoke(struct drm_master *top)
338 mutex_lock(&top->dev->mode_config.idr_mutex);
339 _drm_lease_revoke(top);
340 mutex_unlock(&top->dev->mode_config.idr_mutex);
343 static int validate_lease(struct drm_device *dev,
345 struct drm_mode_object **objects,
346 bool universal_planes)
350 int has_connector = -1;
353 /* we want to confirm that there is at least one crtc, plane
356 for (o = 0; o < object_count; o++) {
357 if (objects[o]->type == DRM_MODE_OBJECT_CRTC && has_crtc == -1) {
360 if (objects[o]->type == DRM_MODE_OBJECT_CONNECTOR && has_connector == -1)
363 if (universal_planes) {
364 if (objects[o]->type == DRM_MODE_OBJECT_PLANE && has_plane == -1)
368 if (has_crtc == -1 || has_connector == -1)
370 if (universal_planes && has_plane == -1)
375 static int fill_object_idr(struct drm_device *dev,
376 struct drm_file *lessor_priv,
381 struct drm_mode_object **objects;
384 bool universal_planes = READ_ONCE(lessor_priv->universal_planes);
386 objects = kcalloc(object_count, sizeof(struct drm_mode_object *),
391 /* step one - get references to all the mode objects
392 and check for validity. */
393 for (o = 0; o < object_count; o++) {
394 objects[o] = drm_mode_object_find(dev, lessor_priv,
396 DRM_MODE_OBJECT_ANY);
399 goto out_free_objects;
402 if (!drm_mode_object_lease_required(objects[o]->type)) {
403 DRM_DEBUG_KMS("invalid object for lease\n");
405 goto out_free_objects;
409 ret = validate_lease(dev, object_count, objects, universal_planes);
411 DRM_DEBUG_LEASE("lease validation failed\n");
412 goto out_free_objects;
415 /* add their IDs to the lease request - taking into account
417 for (o = 0; o < object_count; o++) {
418 struct drm_mode_object *obj = objects[o];
419 u32 object_id = objects[o]->id;
421 DRM_DEBUG_LEASE("Adding object %d to lease\n", object_id);
424 * We're using an IDR to hold the set of leased
425 * objects, but we don't need to point at the object's
426 * data structure from the lease as the main object_idr
427 * will be used to actually find that. Instead, all we
428 * really want is a 'leased/not-leased' result, for
429 * which any non-NULL pointer will work fine.
431 ret = idr_alloc(leases, &drm_lease_idr_object , object_id, object_id + 1, GFP_KERNEL);
433 DRM_DEBUG_LEASE("Object %d cannot be inserted into leases (%d)\n",
435 goto out_free_objects;
437 if (obj->type == DRM_MODE_OBJECT_CRTC && !universal_planes) {
438 struct drm_crtc *crtc = obj_to_crtc(obj);
440 ret = idr_alloc(leases, &drm_lease_idr_object, crtc->primary->base.id, crtc->primary->base.id + 1, GFP_KERNEL);
442 DRM_DEBUG_LEASE("Object primary plane %d cannot be inserted into leases (%d)\n",
444 goto out_free_objects;
447 ret = idr_alloc(leases, &drm_lease_idr_object, crtc->cursor->base.id, crtc->cursor->base.id + 1, GFP_KERNEL);
449 DRM_DEBUG_LEASE("Object cursor plane %d cannot be inserted into leases (%d)\n",
451 goto out_free_objects;
459 for (o = 0; o < object_count; o++) {
461 drm_mode_object_put(objects[o]);
468 * The master associated with the specified file will have a lease
469 * created containing the objects specified in the ioctl structure.
470 * A file descriptor will be allocated for that and returned to the
473 int drm_mode_create_lease_ioctl(struct drm_device *dev,
474 void *data, struct drm_file *lessor_priv)
476 struct drm_mode_create_lease *cl = data;
480 struct drm_master *lessor;
481 struct drm_master *lessee = NULL;
482 struct file *lessee_file = NULL;
483 struct file *lessor_file = lessor_priv->filp;
484 struct drm_file *lessee_priv;
486 uint32_t *object_ids;
488 /* Can't lease without MODESET */
489 if (!drm_core_check_feature(dev, DRIVER_MODESET))
492 /* need some objects */
493 if (cl->object_count == 0) {
494 DRM_DEBUG_LEASE("no objects in lease\n");
498 if (cl->flags && (cl->flags & ~(O_CLOEXEC | O_NONBLOCK))) {
499 DRM_DEBUG_LEASE("invalid flags\n");
503 lessor = drm_file_get_master(lessor_priv);
504 /* Do not allow sub-leases */
505 if (lessor->lessor) {
506 DRM_DEBUG_LEASE("recursive leasing not allowed\n");
511 object_count = cl->object_count;
513 object_ids = memdup_user(u64_to_user_ptr(cl->object_ids),
514 array_size(object_count, sizeof(__u32)));
515 if (IS_ERR(object_ids)) {
516 ret = PTR_ERR(object_ids);
522 /* fill and validate the object idr */
523 ret = fill_object_idr(dev, lessor_priv, &leases,
524 object_count, object_ids);
527 DRM_DEBUG_LEASE("lease object lookup failed: %i\n", ret);
528 idr_destroy(&leases);
532 /* Allocate a file descriptor for the lease */
533 fd = get_unused_fd_flags(cl->flags & (O_CLOEXEC | O_NONBLOCK));
535 idr_destroy(&leases);
540 DRM_DEBUG_LEASE("Creating lease\n");
541 /* lessee will take the ownership of leases */
542 lessee = drm_lease_create(lessor, &leases);
544 if (IS_ERR(lessee)) {
545 ret = PTR_ERR(lessee);
546 idr_destroy(&leases);
550 /* Clone the lessor file to create a new file for us */
551 DRM_DEBUG_LEASE("Allocating lease file\n");
552 lessee_file = file_clone_open(lessor_file);
553 if (IS_ERR(lessee_file)) {
554 ret = PTR_ERR(lessee_file);
558 lessee_priv = lessee_file->private_data;
559 /* Change the file to a master one */
560 drm_master_put(&lessee_priv->master);
561 lessee_priv->master = lessee;
562 lessee_priv->is_master = 1;
563 lessee_priv->authenticated = 1;
565 /* Pass fd back to userspace */
566 DRM_DEBUG_LEASE("Returning fd %d id %d\n", fd, lessee->lessee_id);
568 cl->lessee_id = lessee->lessee_id;
571 fd_install(fd, lessee_file);
573 drm_master_put(&lessor);
574 DRM_DEBUG_LEASE("drm_mode_create_lease_ioctl succeeded\n");
578 drm_master_put(&lessee);
584 drm_master_put(&lessor);
585 DRM_DEBUG_LEASE("drm_mode_create_lease_ioctl failed: %d\n", ret);
589 int drm_mode_list_lessees_ioctl(struct drm_device *dev,
590 void *data, struct drm_file *lessor_priv)
592 struct drm_mode_list_lessees *arg = data;
593 __u32 __user *lessee_ids = (__u32 __user *) (uintptr_t) (arg->lessees_ptr);
594 __u32 count_lessees = arg->count_lessees;
595 struct drm_master *lessor, *lessee;
602 /* Can't lease without MODESET */
603 if (!drm_core_check_feature(dev, DRIVER_MODESET))
606 lessor = drm_file_get_master(lessor_priv);
607 DRM_DEBUG_LEASE("List lessees for %d\n", lessor->lessee_id);
609 mutex_lock(&dev->mode_config.idr_mutex);
612 drm_for_each_lessee(lessee, lessor) {
613 /* Only list un-revoked leases */
614 if (!idr_is_empty(&lessee->leases)) {
615 if (count_lessees > count) {
616 DRM_DEBUG_LEASE("Add lessee %d\n", lessee->lessee_id);
617 ret = put_user(lessee->lessee_id, lessee_ids + count);
625 DRM_DEBUG_LEASE("Lessor leases to %d\n", count);
627 arg->count_lessees = count;
629 mutex_unlock(&dev->mode_config.idr_mutex);
630 drm_master_put(&lessor);
635 /* Return the list of leased objects for the specified lessee */
636 int drm_mode_get_lease_ioctl(struct drm_device *dev,
637 void *data, struct drm_file *lessee_priv)
639 struct drm_mode_get_lease *arg = data;
640 __u32 __user *object_ids = (__u32 __user *) (uintptr_t) (arg->objects_ptr);
641 __u32 count_objects = arg->count_objects;
642 struct drm_master *lessee;
643 struct idr *object_idr;
652 /* Can't lease without MODESET */
653 if (!drm_core_check_feature(dev, DRIVER_MODESET))
656 lessee = drm_file_get_master(lessee_priv);
657 DRM_DEBUG_LEASE("get lease for %d\n", lessee->lessee_id);
659 mutex_lock(&dev->mode_config.idr_mutex);
661 if (lessee->lessor == NULL)
662 /* owner can use all objects */
663 object_idr = &lessee->dev->mode_config.object_idr;
665 /* lessee can only use allowed object */
666 object_idr = &lessee->leases;
669 idr_for_each_entry(object_idr, entry, object) {
670 if (count_objects > count) {
671 DRM_DEBUG_LEASE("adding object %d\n", object);
672 ret = put_user(object, object_ids + count);
679 DRM_DEBUG("lease holds %d objects\n", count);
681 arg->count_objects = count;
683 mutex_unlock(&dev->mode_config.idr_mutex);
684 drm_master_put(&lessee);
690 * This removes all of the objects from the lease without
691 * actually getting rid of the lease itself; that way all
692 * references to it still work correctly
694 int drm_mode_revoke_lease_ioctl(struct drm_device *dev,
695 void *data, struct drm_file *lessor_priv)
697 struct drm_mode_revoke_lease *arg = data;
698 struct drm_master *lessor;
699 struct drm_master *lessee;
702 DRM_DEBUG_LEASE("revoke lease for %d\n", arg->lessee_id);
704 /* Can't lease without MODESET */
705 if (!drm_core_check_feature(dev, DRIVER_MODESET))
708 lessor = drm_file_get_master(lessor_priv);
709 mutex_lock(&dev->mode_config.idr_mutex);
711 lessee = _drm_find_lessee(lessor, arg->lessee_id);
719 /* Lease is not held by lessor */
720 if (lessee->lessor != lessor) {
725 _drm_lease_revoke(lessee);
728 mutex_unlock(&dev->mode_config.idr_mutex);
729 drm_master_put(&lessor);