Skip to contentSkip to conversation

smsdvb-debugfs.c: Fix error checking for debugfs_create_file

PATCH In review Osama Muhammad 2 participants 3 messages May 24, 2023 – May 28, 2023

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

PATCH 1/1 smsdvb-debugfs.c: Fix error checking for debugfs_create_file

This patch fixes the error checking in smsdvb-debugfs.c in debugfs_create_file. The correct way to check if an error occurred is using 'IS_ERR_OR_NULL' inline function.

---
 drivers/media/common/siano/smsdvb-debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/media/common/siano/smsdvb-debugfs.c +1 -1
index 8916bb644756..0f8750d7993c 100644
@@ -469,7 +469,7 @@ int smsdvb_debugfs_create(struct smsdvb_client_t *client)
 
 	d = debugfs_create_file("stats", S_IRUGO | S_IWUSR, client->debugfs,
 				client, &debugfs_stats_ops);
-	if (!d) {
+	if (IS_ERR_OR_NULL(d)) {
 		debugfs_remove(client->debugfs);
 		return -ENOMEM;
 	}
Signature · 1 line
2.34.1
#1 lore raw

Em Wed, 24 May 2023 21:42:10 +0500
Osama Muhammad <[email protected]> escreveu:

Quoted 14 lines

This patch fixes the error checking in smsdvb-debugfs.c in debugfs_create_file. The correct way to check if an error occurred is using 'IS_ERR_OR_NULL' inline function.

---
 drivers/media/common/siano/smsdvb-debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/media/common/siano/smsdvb-debugfs.c +0 -0
index 8916bb644756..0f8750d7993c 100644

drivers/media/common/siano/smsdvb-debugfs.c int smsdvb_debugfs_create(struct smsdvb_client_t *client) · line 474

Quoted 7 lines
drivers/media/common/siano/smsdvb-debugfs.c +1 -1
@@ -469,7 +469,7 @@ int smsdvb_debugfs_create(struct smsdvb_client_t *client)
 
 	d = debugfs_create_file("stats", S_IRUGO | S_IWUSR, client->debugfs,
 				client, &debugfs_stats_ops);
-	if (!d) {
+	if (IS_ERR_OR_NULL(d)) {
 		debugfs_remove(client->debugfs);
 		return -ENOMEM;

if IS_ERR, it is probably better to return PTR_ERR(d).

So, please change it accordingly, returning -ENOMEM only on NULL, e. g. something like (untested):

	if (IS_ERR_OR_NULL(d)) {
 		debugfs_remove(client->debugfs);
		if (!d)
	  		return -ENOMEM;
		return PTR_ERR(d);
	}

Regards,
Mauro

#2 lore raw

Hi,

After researching more into it I have come to know that the debugfs API will not return null on error but an ERR_PTR. The modern wisdom about it is to ignore the errors returned by the function as stated in the comment above the function debugfs_create_file.

Quoted 4 lines

* NOTE: it's expected that most callers should _ignore_ the errors returned
* by this function. Other debugfs functions handle the fact that the "dentry"
* passed to them could be an error and they don't crash in that case.
* Drivers should generally work fine even if debugfs fails to init anyway.

Here is the link to comment :-
https://elixir.bootlin.com/linux/latest/source/fs/debugfs/inode.c#L451

Considering this, I will send the revision of the patch by removing error checks. Please correct me if there are any concerns with this.

Thanks,
Osmten

Quoted 40 lines · Mauro Carvalho Chehab

Em Wed, 24 May 2023 21:42:10 +0500
Osama Muhammad <[email protected]> escreveu:

Quoted 14 lines

This patch fixes the error checking in smsdvb-debugfs.c in debugfs_create_file. The correct way to check if an error occurred is using 'IS_ERR_OR_NULL' inline function.

---
 drivers/media/common/siano/smsdvb-debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/media/common/siano/smsdvb-debugfs.c +0 -0
index 8916bb644756..0f8750d7993c 100644

drivers/media/common/siano/smsdvb-debugfs.c int smsdvb_debugfs_create(struct smsdvb_client_t *client) · line 474

Quoted 7 lines
drivers/media/common/siano/smsdvb-debugfs.c +1 -1
@@ -469,7 +469,7 @@ int smsdvb_debugfs_create(struct smsdvb_client_t *client)
 
      d = debugfs_create_file("stats", S_IRUGO | S_IWUSR, client->debugfs,
                              client, &debugfs_stats_ops);
-     if (!d) {
+     if (IS_ERR_OR_NULL(d)) {
              debugfs_remove(client->debugfs);
              return -ENOMEM;

if IS_ERR, it is probably better to return PTR_ERR(d).

So, please change it accordingly, returning -ENOMEM only on NULL, e. g. something like (untested):

        if (IS_ERR_OR_NULL(d)) {
                debugfs_remove(client->debugfs);
                if (!d)
                        return -ENOMEM;
                return PTR_ERR(d);
        }

Regards,
Mauro