Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   =?UTF-8?q?Micha=C5=82=20Winiarski?= <michal.winiarski@intel.com>
To:     <dri-devel@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>,
        <intel-gfx@lists.freedesktop.org>
CC:     David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>,
        "Maarten Lankhorst" <maarten.lankhorst@linux.intel.com>,
        Maxime Ripard <mripard@kernel.org>,
        Thomas Zimmermann <tzimmermann@suse.de>,
        Simon Ser <contact@emersion.fr>,
        Matthew Wilcox <willy@infradead.org>,
        Oded Gabbay <ogabbay@kernel.org>,
        =?UTF-8?q?Micha=C5=82=20Winiarski?= <michal.winiarski@intel.com>
Subject: [PATCH v3] drm: Use XArray instead of IDR for minors
Date:   Mon, 7 Nov 2022 18:48:11 +0100
Message-ID: <20221107174811.246135-1-michal.winiarski@intel.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TXY4VTkwWVRrTm9LSm50aThxc0pwMzZsb1Q2ZFZhN0kwU1FwVUpleVh1T3ND?=
 =?utf-8?B?WHREQ0JRWHZnUjBXSGhZK3ZJdlJnQVEwV0twV2oxZFYxZ3Fid1V5YjFCcGEz?=
 =?utf-8?B?M2hYQmNtelZ0SmhmWjRSc1pZZ1haK3BVZlhjNUhQZWNKNEJWUEY5S3RtVDBo?=
 =?utf-8?B?d0dJZFBheUZBalZaRkN0ZlRYaVBZa2tlblh6Zk5Ud21DZlVaS25kTGZ1ZWJx?=
 =?utf-8?B?c1QvdzhiYi9samFnam9VZVR0aWt5czIvcFArMDhTSTRTc0VEaU9HSWN6cmx2?=
 =?utf-8?B?U3JkRlBpc0ZHSmFHcEs4d3JQOGhMQ3B1VGREUy8wMEpURi9oYit0YldPWkpI?=
 =?utf-8?B?U0hNL0lhMFRseStDRnFoc1JXdm5WZFdZQURlNVVrVVdDeVJEVWJHY3NkWXpJ?=
 =?utf-8?B?SHpJUms5MGV6MTZ5Z2p3RHl0T3RRVGlIbFRuQmpPcWlIMCsyam93L3czK2tj?=
 =?utf-8?B?UlQvZzY1RE5qZFJPaENXb0tDNHJJQ0gzejhIc0JnWllscXdoK1VPdDF5U1ZW?=
 =?utf-8?B?U3lVeTIwQ1U5cEJwOWF0MlQxbkJoaWZXMlhTWHd3bVFOVCtuaGdCQ1pKb2sz?=
 =?utf-8?B?bjFESnlnUDFUTVFuSVJqMEM5QjErenNuU2FHQ1ZVQnhYYlNteHB1d1JRbm9H?=
 =?utf-8?B?R04xSmU2YWd1a0pYc2MxREhGVmhhSm54S1NxWG5ESUt3L1VGTEhlK1N6Szcv?=
 =?utf-8?B?U3JtV3hHTWhoOWV2T2lHdkY0Yi9mWDFYcUQxVzRsUkVzNis0ait2Q0Y0NnVa?=
 =?utf-8?B?MW83b2xibUdhUXVmdUF5L0tUYmFPSXNMQ0lPeDdTclN3d2JyS3k4eVFpcVlU?=
 =?utf-8?B?aEhoUUZiS1BJMDVua01DQW9ndUM3aDR4RUpGOTRqVFpKaDZWMjNUQkN1U1J4?=
 =?utf-8?B?MVlCOGNuNFR1Z21sT1pqOGtiYUx0eEJoajBUdEUzWUs2UCtuWkd2K0Z0c0hP?=
 =?utf-8?B?LzNFa3Jodmw0RnRMa0F0Z0k5d3hGa2w4UmwyMDQ1Z3NRamZwMDhTWWpwSENw?=
 =?utf-8?B?b2huRnhMM1I4L1RpcGlSRGNkcnJNcGJsQXBleG9JM3N5WE1SbjdLcHNZUFl2?=
 =?utf-8?B?aktWd0NubFRZdVRmNUJlbFNyREsyY1g1UUZ2bWhSUG9jY2t2MjBzQ0Y2UlRI?=
 =?utf-8?B?SHZtZm85YWIxbHdET05JbFJLQXJlcnRVZWIzTTAzdjFlNGpBOTAvUUo4aVcx?=
 =?utf-8?B?UVBFV3NPdjI4RWdnYVRRQ2Jxc0ttNUV2VXBsVG91R21OUExHdnRXOCtsaGFj?=
 =?utf-8?B?Z0hEVHQ0bTdvVTEzOW5abkl6aHZJamF1OTFEcEJkYTh0VldDNUs2empkMGlD?=
 =?utf-8?B?Y3lBRHVMdU82WWhlUkU3Tm40Q29QZTlBeldTajMrM2VJQnpTaWpZZVcycFBt?=
 =?utf-8?B?bXA0OE51bWttRFFuRlF2Nm9wV1ZxZ1R2Nk1COUl4UmtKUXNVNjRETkFFVnIw?=
 =?utf-8?B?NTczdGlKeDRSc3NhOUg2WEVFUXI1VTFUdm9Xa0VZeVhURm55Y0lJZ21qUkUv?=
 =?utf-8?B?VzdOejNSTVVDM0hDR1R1bVA4WllvWU9IcktpRXFKOVBRNHFvbDlQYjBNbEhW?=
 =?utf-8?B?RzRSbW5kTnRuckRWb1NNR2xKUWNJdVZ3SW5SRjNrOGgzQnNpdWpDQ3gyY2Fi?=
 =?utf-8?B?bS9YUnNuRzh4R3hDMTRwUzliK3hHb0d1c2ZGa2VoVGlJUDgvNXpTdHZBY0Q5?=
 =?utf-8?B?MTlNK25VWWdPbXZyeFJMRVpjMWNmTWI1TGZaaEFLdngxQzBnL2xGRlhLR3c4?=
 =?utf-8?B?WnFRdWxNbUhSeXR2M2kvMUxCR1lrRkVkeG85TzdkakUzenRCRW1TbEtiajRC?=
 =?utf-8?B?dzhpV2gzUmM0Z3d6MXB1b1lpd2FHcmVjSTFyMXJIR3hYVE1YWml6KytUTmc2?=
 =?utf-8?B?MmdFWlA4WUZjVHN2ZVpxa2NEMmpMckp2MTEzaHd2ZE1NZ1RzWnpDSFlkeDBj?=
 =?utf-8?B?aXl3Q0JBS1hyVnE3SnlDZnJmcFhsL0x3ZkNrSExqL0x0RG9qMzlFNG5FdjVh?=
 =?utf-8?B?UHZzeEtrK0Exc2RoMHpHYTYzcnJsVXZid1REdCtuK09Wb2xDQTdqQmdOL1lT?=
 =?utf-8?B?WWlJWWFBTytNSys1RmU1MXQvVVpuTmErOUgwODI2WHFpWGtzS1Q1cmI4Zkpz?=
 =?utf-8?B?SnZsSnRNYTQvVUJXNFBQNVIrQkNqb01ydzBQWloyc2g3UkRYWkx4WlpkdHF4?=
 =?utf-8?B?S1E9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 1b7f7f19-6671-4ca5-b53b-08dac0e84572
X-MS-Exchange-CrossTenant-AuthSource: DM4PR11MB5373.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Nov 2022 17:48:25.7687
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: QXAGAALCzC4dtuPaMpquC6EV1ffvez+Uk4Sn1HNixhIlIy8CnnzkrXj4OnHNIDmOoVB4fCAQmRVgv5l5RD11p3FEEQcSyxkG9PtjOc0H5T8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO1PR11MB4916
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,
        SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

IDR is deprecated, and since XArray manages its own state with internal
locking, it simplifies the locking on DRM side.
Additionally, don't use the IRQ-safe variant, since operating on drm
minor is not done in IRQ context.

Signed-off-by: Michał Winiarski <michal.winiarski@intel.com>
Suggested-by: Matthew Wilcox <willy@infradead.org>
---
This was originally sent as v4/v5 in larger series:
https://lore.kernel.org/dri-devel/20220911211443.581481-2-michal.winiarski@intel.com/
v1 -> v2:
Fixed locking and corrected some misuse of XArray API (Matthew Wilcox)
v2 -> v3:
Store correct pointer, use xa_store rather than xa_cmpxchg (Oded Gabbay)

 drivers/gpu/drm/drm_drv.c | 51 ++++++++++++++-------------------------
 1 file changed, 18 insertions(+), 33 deletions(-)

diff --git a/drivers/gpu/drm/drm_drv.c b/drivers/gpu/drm/drm_drv.c
index 8214a0b1ab7f..bdcdfeac76bf 100644
--- a/drivers/gpu/drm/drm_drv.c
+++ b/drivers/gpu/drm/drm_drv.c
@@ -34,6 +34,7 @@
 #include <linux/pseudo_fs.h>
 #include <linux/slab.h>
 #include <linux/srcu.h>
+#include <linux/xarray.h>
 
 #include <drm/drm_cache.h>
 #include <drm/drm_client.h>
@@ -53,8 +54,7 @@ MODULE_AUTHOR("Gareth Hughes, Leif Delgass, José Fonseca, Jon Smirl");
 MODULE_DESCRIPTION("DRM shared core routines");
 MODULE_LICENSE("GPL and additional rights");
 
-static DEFINE_SPINLOCK(drm_minor_lock);
-static struct idr drm_minors_idr;
+static DEFINE_XARRAY_ALLOC(drm_minors_xa);
 
 /*
  * If the drm core fails to init for whatever reason,
@@ -98,21 +98,19 @@ static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
 static void drm_minor_alloc_release(struct drm_device *dev, void *data)
 {
 	struct drm_minor *minor = data;
-	unsigned long flags;
 
 	WARN_ON(dev != minor->dev);
 
 	put_device(minor->kdev);
 
-	spin_lock_irqsave(&drm_minor_lock, flags);
-	idr_remove(&drm_minors_idr, minor->index);
-	spin_unlock_irqrestore(&drm_minor_lock, flags);
+	xa_erase(&drm_minors_xa, minor->index);
 }
 
+#define DRM_MINOR_LIMIT(t) ({ typeof(t) _t = (t); XA_LIMIT(64 * _t, 64 * _t + 63); })
+
 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
 {
 	struct drm_minor *minor;
-	unsigned long flags;
 	int r;
 
 	minor = drmm_kzalloc(dev, sizeof(*minor), GFP_KERNEL);
@@ -122,21 +120,10 @@ static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
 	minor->type = type;
 	minor->dev = dev;
 
-	idr_preload(GFP_KERNEL);
-	spin_lock_irqsave(&drm_minor_lock, flags);
-	r = idr_alloc(&drm_minors_idr,
-		      NULL,
-		      64 * type,
-		      64 * (type + 1),
-		      GFP_NOWAIT);
-	spin_unlock_irqrestore(&drm_minor_lock, flags);
-	idr_preload_end();
-
+	r = xa_alloc(&drm_minors_xa, &minor->index, NULL, DRM_MINOR_LIMIT(type), GFP_KERNEL);
 	if (r < 0)
 		return r;
 
-	minor->index = r;
-
 	r = drmm_add_action_or_reset(dev, drm_minor_alloc_release, minor);
 	if (r)
 		return r;
@@ -152,7 +139,7 @@ static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
 static int drm_minor_register(struct drm_device *dev, unsigned int type)
 {
 	struct drm_minor *minor;
-	unsigned long flags;
+	void *entry;
 	int ret;
 
 	DRM_DEBUG("\n");
@@ -172,9 +159,12 @@ static int drm_minor_register(struct drm_device *dev, unsigned int type)
 		goto err_debugfs;
 
 	/* replace NULL with @minor so lookups will succeed from now on */
-	spin_lock_irqsave(&drm_minor_lock, flags);
-	idr_replace(&drm_minors_idr, minor, minor->index);
-	spin_unlock_irqrestore(&drm_minor_lock, flags);
+	entry = xa_store(&drm_minors_xa, minor->index, minor, GFP_KERNEL);
+	if (xa_is_err(entry)) {
+		ret = xa_err(entry);
+		goto err_debugfs;
+	}
+	WARN_ON(entry);
 
 	DRM_DEBUG("new minor registered %d\n", minor->index);
 	return 0;
@@ -187,16 +177,13 @@ static int drm_minor_register(struct drm_device *dev, unsigned int type)
 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
 {
 	struct drm_minor *minor;
-	unsigned long flags;
 
 	minor = *drm_minor_get_slot(dev, type);
 	if (!minor || !device_is_registered(minor->kdev))
 		return;
 
 	/* replace @minor with NULL so lookups will fail from now on */
-	spin_lock_irqsave(&drm_minor_lock, flags);
-	idr_replace(&drm_minors_idr, NULL, minor->index);
-	spin_unlock_irqrestore(&drm_minor_lock, flags);
+	xa_store(&drm_minors_xa, minor->index, NULL, GFP_KERNEL);
 
 	device_del(minor->kdev);
 	dev_set_drvdata(minor->kdev, NULL); /* safety belt */
@@ -215,13 +202,12 @@ static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
 {
 	struct drm_minor *minor;
-	unsigned long flags;
 
-	spin_lock_irqsave(&drm_minor_lock, flags);
-	minor = idr_find(&drm_minors_idr, minor_id);
+	xa_lock(&drm_minors_xa);
+	minor = xa_load(&drm_minors_xa, minor_id);
 	if (minor)
 		drm_dev_get(minor->dev);
-	spin_unlock_irqrestore(&drm_minor_lock, flags);
+	xa_unlock(&drm_minors_xa);
 
 	if (!minor) {
 		return ERR_PTR(-ENODEV);
@@ -1037,7 +1023,7 @@ static void drm_core_exit(void)
 	unregister_chrdev(DRM_MAJOR, "drm");
 	debugfs_remove(drm_debugfs_root);
 	drm_sysfs_destroy();
-	idr_destroy(&drm_minors_idr);
+	WARN_ON(!xa_empty(&drm_minors_xa));
 	drm_connector_ida_destroy();
 }
 
@@ -1046,7 +1032,6 @@ static int __init drm_core_init(void)
 	int ret;
 
 	drm_connector_ida_init();
-	idr_init(&drm_minors_idr);
 	drm_memcpy_init_early();
 
 	ret = drm_sysfs_init();
-- 
2.38.1