Skip to contentSkip to conversation

staging: unisys: Properly test debugfs_create_dir() return values

PATCH In review Fabio M. De Francesco 3 participants 9 messages Mar 22, 2022 – Mar 29, 2022 Staging

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: unisys: Properly test debugfs_create_dir() return values

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +2 -2
index 643432458105..58d03f3d3173 100644
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {
 		dev_err(&dev->device,
 			"%s debugfs_create_dir %s failed\n",
 			__func__, netdev->name);
-		err = -ENOMEM;
+		err = PTR_ERR(devdata->eth_debugfs_dir);
 		goto cleanup_register_netdev;
 	}
 
Signature · 1 line
2.34.1
#1 lore raw
Quoted 17 lines · Fabio M. De Francesco

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +0 -0
index 643432458105..58d03f3d3173 100644

drivers/staging/unisys/visornic/visornic_main.c static int visornic_probe(struct visor_device *dev) · line 1925

Quoted 5 lines
drivers/staging/unisys/visornic/visornic_main.c +1 -1
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {

Normally I would say to just delete the error handling. But in this case you can delete the whole devdata->eth_debugfs_dir and the related code. It's not used at all.

regards,
dan carpenter

#2 lore raw
Quoted 13 lines · Dan Carpenter
Quoted 12 lines · Fabio M. De Francesco

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Quoted 12 lines

drivers/staging/unisys/visornic/visornic_main.c static int visornic_probe(struct visor_device *dev) · line 1925

Quoted 10 lines
drivers/staging/unisys/visornic/visornic_main.c +1 -1
index 643432458105..58d03f3d3173 100644
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {

Normally I would say to just delete the error handling.

In the normal case checking debugfs functions for errors is not required. The users all have checks built in. The exception is when the driver dereferences devdata->eth_debugfs_dir itself. So when you make these kinds of changes do a grep for eth_debugfs_dir to make sure it's not dereferenced, but normally it is not.

But again, here, delete everything.

regards,
dan carpenter

#3 lore raw
In reply to Dan Carpenter
Quoted 28 lines · On marted? 22 marzo 2022 09:49:28 CET Dan Carpenter wrote:
Quoted 17 lines · Fabio M. De Francesco

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +0 -0
index 643432458105..58d03f3d3173 100644

drivers/staging/unisys/visornic/visornic_main.c static int visornic_probe(struct visor_device *dev) · line 1925

Quoted 5 lines
drivers/staging/unisys/visornic/visornic_main.c +1 -1
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {

Normally I would say to just delete the error handling. But in this case you can delete the whole devdata->eth_debugfs_dir and the related code. It's not used at all.

Quoted 3 lines

regards,
dan carpenter

Dear Dan,

I think that you are right and the whole thing should be deleted. There are a couple more of these kinds of bad error handling in the Unisys driver.

However, soon after sending this patch I noticed that David Kershner email account at unisys.com is not working anymore. Furthermore, I am recalling that in 2021 I made a conversion from IDA to XArray for the whole visorhba driver and nobody at Unisys replied. After one month in queue, Greg decided to apply my patches while noticing that nobody from Unisys cares.

In summation, probably I'll follow your suggestion for this case and the other bugs that I was about to fix but I'm not sure at all at the moment.

What I mean is: if people at Unisys don't care, why should I?

Thanks for your review, Dan.

Regards,

Fabio M. De Francesco

P.S.: I found this and the other bugs in this Unisys driver with the help of Smatch. Thank you for this precious tool :)

#4 lore raw
In reply to Fabio M. De Francesco
Quoted 17 lines · Fabio M. De Francesco

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +0 -0
index 643432458105..58d03f3d3173 100644

drivers/staging/unisys/visornic/visornic_main.c static int visornic_probe(struct visor_device *dev) · line 1925

Quoted 5 lines
drivers/staging/unisys/visornic/visornic_main.c +1 -1
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {

We really shouldn't be checking this value at all. There's no reason to check the return value of a debugfs_* call. Can you fix up the code to do that instead?

thanks,

greg k-h

#5 lore raw
Quoted 28 lines · On marted? 22 marzo 2022 09:47:29 CET Greg Kroah-Hartman wrote:
Quoted 17 lines · Fabio M. De Francesco

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +0 -0
index 643432458105..58d03f3d3173 100644

drivers/staging/unisys/visornic/visornic_main.c static int visornic_probe(struct visor_device *dev) · line 1925

Quoted 5 lines
drivers/staging/unisys/visornic/visornic_main.c +1 -1
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {

We really shouldn't be checking this value at all. There's no reason to check the return value of a debugfs_* call. Can you fix up the code to do that instead?

Quoted 4 lines

thanks,

greg k-h

Yes I'll do the work that you requested by this weekend, notwithstanding what I replied to Dan.

While I reiterate all my considerations, it seems that, if not the people from Unisys, someone else still cares about this driver :)

Thanks,

Fabio

#6 lore raw
In reply to Fabio M. De Francesco
Quoted 19 lines · Fabio M. De Francesco

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +0 -0
index 643432458105..58d03f3d3173 100644
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,

drivers/staging/unisys/visornic/visornic_main.c static int visornic_probe(struct visor_device *dev) · line 1931

Quoted 10 lines
drivers/staging/unisys/visornic/visornic_main.c +2 -2
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {
 		dev_err(&dev->device,
 			"%s debugfs_create_dir %s failed\n",
 			__func__, netdev->name);
-		err = -ENOMEM;
+		err = PTR_ERR(devdata->eth_debugfs_dir);
 		goto cleanup_register_netdev;
 	}

Also, why does this variable have to be saved off at all? It should only be used later when removing the directory, and we can just look it up at that point in time, right?

Also, what happens if the network device name changes?

thanks,

greg k-h

#7 lore raw
In reply to Fabio M. De Francesco
Quoted 33 lines · On martedì 22 marzo 2022 09:38:58 CEST Fabio M. De Francesco wrote:

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +2 -2
index 643432458105..58d03f3d3173 100644
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {
 		dev_err(&dev->device,
 			"%s debugfs_create_dir %s failed\n",
 			__func__, netdev->name);
-		err = -ENOMEM;
+		err = PTR_ERR(devdata->eth_debugfs_dir);
 		goto cleanup_register_netdev;
 	}
 
Signature · 1 line
2.34.1

Hi Greg, Dan,

Now I have time to rework this patch but, if I'm not misunderstanding, you asked for two contrasting works to do here...

Dan wrote that "[in] this case you can delete the whole devdata->eth_debugfs_dir and the related code.".

Greg wrote that "We really shouldn't be checking this value at all. There's no reason to check the return value of a debugfs_* call. Can you fix up the code to do that instead?".

I'm confused because they look like two incompatible requests. What should I do?

Thanks,

Fabio M. De Francesco

#8 lore raw
Quoted 39 lines · Fabio M. De Francesco
Quoted 33 lines · On martedì 22 marzo 2022 09:38:58 CEST Fabio M. De Francesco wrote:

debugfs_create_dir() returns a pointers to a dentry objects. On failures it returns errors. Currently the values returned to visornic_probe() seem to be tested for being equal to NULL in case of failures.

Properly test with "if (IS_ERR())" and then assign the correct error value to the "err" variable.

---
 drivers/staging/unisys/visornic/visornic_main.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/unisys/visornic/visornic_main.c +2 -2
index 643432458105..58d03f3d3173 100644
@@ -1922,11 +1922,11 @@ static int visornic_probe(struct visor_device *dev)
 	/* create debug/sysfs directories */
 	devdata->eth_debugfs_dir = debugfs_create_dir(netdev->name,
 						      visornic_debugfs_dir);
-	if (!devdata->eth_debugfs_dir) {
+	if (IS_ERR(devdata->eth_debugfs_dir)) {
 		dev_err(&dev->device,
 			"%s debugfs_create_dir %s failed\n",
 			__func__, netdev->name);
-		err = -ENOMEM;
+		err = PTR_ERR(devdata->eth_debugfs_dir);
 		goto cleanup_register_netdev;
 	}
 
Signature · 1 line
2.34.1

Hi Greg, Dan,

Now I have time to rework this patch but, if I'm not misunderstanding, you asked for two contrasting works to do here...

Quoted 8 lines

Dan wrote that "[in] this case you can delete the whole devdata->eth_debugfs_dir and the related code.".

Greg wrote that "We really shouldn't be checking this value at all. There's no reason to check the return value of a debugfs_* call. Can you fix up the code to do that instead?".

I'm confused because they look like two incompatible requests. What should I do?

Greg is saying delete the tests and the error handling. But I am saying delete the tests, the error handling, the devdata->eth_debugfs_dir related code and the call to debugfs_create_dir().

There is no conflict. Delete it all.

regards,
dan carpenter