Skip to contentSkip to conversation

remoteproc: core: Fixes for rproc cdev and add

PATCH Applied Siddharth Gupta 3 participants 11 messages Jun 15, 2021 – Jun 23, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v4 cover remoteproc: core: Fixes for rproc cdev and add

This patch series contains stability fixes and error handling for remoteproc.

The changes included in this series do the following:
Patch 1: Fixes the creation of the rproc character device. Patch 2: Validates rproc as the first step of rproc_add(). Patch 3: Fixes rproc cdev remove and the order of dev_del() and cdev_del(). Patch 4: Adds error handling in rproc_add().

v3 -> v4:
- Moved stable from CC to CC in sign-off area.

v2 -> v3:
- Removed extra file that got added by mistake.

v1 -> v2:
- Added extra patch which addresses Bjorn's comments on patch 3 from v1.
- Fixed commit text for patch 2 (s/calling making/making).

Siddharth Gupta (4):
remoteproc: core: Move cdev add before device add
remoteproc: core: Move validate before device add
remoteproc: core: Fix cdev remove and rproc del
remoteproc: core: Cleanup device in case of failure

 drivers/remoteproc/remoteproc_cdev.c |  2 +-
 drivers/remoteproc/remoteproc_core.c | 27 ++++++++++++++++++---------
 2 files changed, 19 insertions(+), 10 deletions(-)
Signature · 2 lines
Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#1 lore raw

PATCH v4 1/4 remoteproc: core: Move cdev add before device add

When cdev_add is called after device_add has been called there is no way for the userspace to know about the addition of a cdev as cdev_add itself doesn't trigger a uevent notification, or for the kernel to know about the change to devt. This results in two problems:
- mknod is never called for the cdev and hence no cdev appears on devtmpfs.
- sysfs links to the new cdev are not established.

The cdev needs to be added and devt assigned before device_add() is called in order for the relevant sysfs and devtmpfs entries to be created and the uevent to be properly populated.

---
 drivers/remoteproc/remoteproc_core.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/remoteproc/remoteproc_core.c +5 -5
index 6348aaa..9ad8c5f 100644
@@ -2333,6 +2333,11 @@ int rproc_add(struct rproc *rproc)
 	struct device *dev = &rproc->dev;
 	int ret;
 
+	/* add char device for this remoteproc */
+	ret = rproc_char_device_add(rproc);
+	if (ret < 0)
+		return ret;
+
 	ret = device_add(dev);
 	if (ret < 0)
 		return ret;
@@ -2346,11 +2351,6 @@ int rproc_add(struct rproc *rproc)
 	/* create debugfs entries */
 	rproc_create_debug_dir(rproc);
 
-	/* add char device for this remoteproc */
-	ret = rproc_char_device_add(rproc);
-	if (ret < 0)
-		return ret;
-
 	/* if rproc is marked always-on, request it to boot */
 	if (rproc->auto_boot) {
 		ret = rproc_trigger_auto_boot(rproc);
Signature · 2 lines
Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#2 lore raw

PATCH v4 2/4 remoteproc: core: Move validate before device add

In reply to Siddharth Gupta

We can validate whether the remoteproc is correctly setup before making the cdev_add and device_add calls. This saves us the trouble of cleaning up later on.

---
 drivers/remoteproc/remoteproc_core.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/remoteproc/remoteproc_core.c +4 -4
index 9ad8c5f..b65fce3 100644
@@ -2333,16 +2333,16 @@ int rproc_add(struct rproc *rproc)
 	struct device *dev = &rproc->dev;
 	int ret;
 
-	/* add char device for this remoteproc */
-	ret = rproc_char_device_add(rproc);
+	ret = rproc_validate(rproc);
 	if (ret < 0)
 		return ret;
 
-	ret = device_add(dev);
+	/* add char device for this remoteproc */
+	ret = rproc_char_device_add(rproc);
 	if (ret < 0)
 		return ret;
 
-	ret = rproc_validate(rproc);
+	ret = device_add(dev);
 	if (ret < 0)
 		return ret;
 
Signature · 2 lines
Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#3 lore raw

Re: [PATCH v4 2/4] remoteproc: core: Move validate before device add

Quoted 11 lines · Siddharth Gupta

We can validate whether the remoteproc is correctly setup before making the cdev_add and device_add calls. This saves us the trouble of cleaning up later on.

---
 drivers/remoteproc/remoteproc_core.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Why is this relevant for stable? What commit does this fix? Please put a Fixes: tag for that.

thanks,

greg k-h

#4 lore raw

PATCH v4 3/4 remoteproc: core: Fix cdev remove and rproc del

In reply to Siddharth Gupta

The rproc_char_device_remove() call currently unmaps the cdev region instead of simply deleting the cdev that was added as a part of the rproc_char_device_add() call. This change fixes that behaviour, and also fixes the order in which device_del() and cdev_del() need to be called.

---
 drivers/remoteproc/remoteproc_cdev.c | 2 +-
 drivers/remoteproc/remoteproc_core.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
drivers/remoteproc/remoteproc_cdev.c +1 -1
index 0b8a84c..4ad98b0 100644
@@ -124,7 +124,7 @@ int rproc_char_device_add(struct rproc *rproc)
 
 void rproc_char_device_remove(struct rproc *rproc)
 {
-	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1, "remoteproc");
+	cdev_del(&rproc->cdev);
 }
 
 void __init rproc_init_cdev(void)
drivers/remoteproc/remoteproc_core.c +1 -1
index b65fce3..b874280 100644
@@ -2619,7 +2619,6 @@ int rproc_del(struct rproc *rproc)
 	mutex_unlock(&rproc->lock);
 
 	rproc_delete_debug_dir(rproc);
-	rproc_char_device_remove(rproc);
 
 	/* the rproc is downref'ed as soon as it's removed from the klist */
 	mutex_lock(&rproc_list_mutex);
@@ -2630,6 +2629,7 @@ int rproc_del(struct rproc *rproc)
 	synchronize_rcu();
 
 	device_del(&rproc->dev);
+	rproc_char_device_remove(rproc);
 
 	return 0;
 }
Signature · 2 lines
Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#5 lore raw

Re: [PATCH v4 3/4] remoteproc: core: Fix cdev remove and rproc del

Quoted 8 lines · Siddharth Gupta

The rproc_char_device_remove() call currently unmaps the cdev region instead of simply deleting the cdev that was added as a part of the rproc_char_device_add() call. This change fixes that behaviour, and also fixes the order in which device_del() and cdev_del() need to be called.

Is this really needed for stable? What bug does this solve? ANd again,
fixes: ?

#6 lore raw

PATCH v4 4/4 remoteproc: core: Cleanup device in case of failure

In reply to Siddharth Gupta

When a failure occurs in rproc_add() it returns an error, but does not cleanup after itself. This change adds the failure path in such cases.

---
 drivers/remoteproc/remoteproc_core.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/remoteproc/remoteproc_core.c +12 -3
index b874280..d823f70 100644
@@ -2343,8 +2343,10 @@ int rproc_add(struct rproc *rproc)
 		return ret;
 
 	ret = device_add(dev);
-	if (ret < 0)
-		return ret;
+	if (ret < 0) {
+		put_device(dev);
+		goto rproc_remove_cdev;
+	}
 
 	dev_info(dev, "%s is available\n", rproc->name);
 
@@ -2355,7 +2357,7 @@ int rproc_add(struct rproc *rproc)
 	if (rproc->auto_boot) {
 		ret = rproc_trigger_auto_boot(rproc);
 		if (ret < 0)
-			return ret;
+			goto rproc_remove_dev;
 	}
 
 	/* expose to rproc_get_by_phandle users */
@@ -2364,6 +2366,13 @@ int rproc_add(struct rproc *rproc)
 	mutex_unlock(&rproc_list_mutex);
 
 	return 0;
+
+rproc_remove_dev:
+	rproc_delete_debug_dir(rproc);
+	device_del(dev);
+rproc_remove_cdev:
+	rproc_char_device_remove(rproc);
+	return ret;
 }
 EXPORT_SYMBOL(rproc_add);
 
Signature · 2 lines
Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#7 lore raw

Re: [PATCH v4 4/4] remoteproc: core: Cleanup device in case of failure

Quoted 9 lines · Siddharth Gupta

When a failure occurs in rproc_add() it returns an error, but does not cleanup after itself. This change adds the failure path in such cases.

---
 drivers/remoteproc/remoteproc_core.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

Why is this needed for stable kernels? And again, a Fixes: tag?

#8 lore raw

Re: [PATCH v4 4/4] remoteproc: core: Cleanup device in case of failure

Quoted 11 lines · Greg KH
Quoted 9 lines · Siddharth Gupta

When a failure occurs in rproc_add() it returns an error, but does not cleanup after itself. This change adds the failure path in such cases.

---
  drivers/remoteproc/remoteproc_core.c | 15 ++++++++++++---
  1 file changed, 12 insertions(+), 3 deletions(-)

Why is this needed for stable kernels? And again, a Fixes: tag?

Patch 2 and patch 3 are leading up to fix rproc_add() in case of a failure. This means we'll have errors with use after free unless we call device_del() or cdev_del(), also the sysfs and devtempfs nodes will also not be removed.

Thanks,
Sid

#9 lore raw

Re: [PATCH v4 4/4] remoteproc: core: Cleanup device in case of failure

Quoted 12 lines · Siddharth Gupta
Quoted 10 lines · Greg KH
Quoted 9 lines · Siddharth Gupta

When a failure occurs in rproc_add() it returns an error, but does not cleanup after itself. This change adds the failure path in such cases.

---
  drivers/remoteproc/remoteproc_core.c | 15 ++++++++++++---
  1 file changed, 12 insertions(+), 3 deletions(-)
Quoted 6 lines
Quoted 1 line

Why is this needed for stable kernels? And again, a Fixes: tag?

Patch 2 and patch 3 are leading up to fix rproc_add() in case of a failure. This means we'll have errors with use after free unless we call device_del() or cdev_del(), also the sysfs and devtempfs nodes will also not be removed.

Then please explain that better in the changelogs. At it is, no one knows this.

greg k-h

#10 lore raw
In reply to Siddharth Gupta
This series was applied to andersson/remoteproc.git (refs/heads/for-next):

Hello:

This series was applied to andersson/remoteproc.git (refs/heads/for-next):

Quoted 9 lines · On Tue, 15 Jun 2021 12:03:40 -0700 you wrote:

This patch series contains stability fixes and error handling for remoteproc.

The changes included in this series do the following:
Patch 1: Fixes the creation of the rproc character device. Patch 2: Validates rproc as the first step of rproc_add(). Patch 3: Fixes rproc cdev remove and the order of dev_del() and cdev_del(). Patch 4: Adds error handling in rproc_add().

[...]

Here is the summary with links:
- [v4,1/4] remoteproc: core: Move cdev add before device add

    https://git.kernel.org/andersson/remoteproc/c/c6659ee893e2
  - [v4,2/4] remoteproc: core: Move validate before device add
    https://git.kernel.org/andersson/remoteproc/c/519346ecabd3
  - [v4,3/4] remoteproc: core: Fix cdev remove and rproc del
    https://git.kernel.org/andersson/remoteproc/c/930eec0be20c

- [v4,4/4] remoteproc: core: Cleanup device in case of failure
https://git.kernel.org/andersson/remoteproc/c/7dbdb8bd7c02

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html