Skip to contentSkip to conversation

mmc: core: Fix error checking

PATCH In review Yeqi Fu 3 participants 5 messages May 17, 2023 – May 24, 2023 MMC, SD and SDIO

lore
Share & tools
lore

Yeqi Fu

author
#0 lore raw

PATCH 1/1 mmc: core: Fix error checking

The functions debugfs_create_dir and debugfs_create_file_unsafe return ERR_PTR if an error occurs, and the appropriate way to verify for errors is to use the inline function IS_ERR. The patch will substitute the null-comparison with IS_ERR.

---
 drivers/mmc/core/block.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/mmc/core/block.c +2 -2
index 00c33edb9fb9..507bebc22636 100644
@@ -2908,7 +2908,7 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 			debugfs_create_file_unsafe("status", 0400, root,
 						   card,
 						   &mmc_dbg_card_status_fops);
-		if (!md->status_dentry)
+		if (IS_ERR(md->status_dentry))
 			return -EIO;
 	}
 
@@ -2916,7 +2916,7 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 		md->ext_csd_dentry =
 			debugfs_create_file("ext_csd", S_IRUSR, root, card,
 					    &mmc_dbg_ext_csd_fops);
-		if (!md->ext_csd_dentry)
+		if (IS_ERR(md->ext_csd_dentry))
 			return -EIO;
 	}
 
Signature · 1 line
2.37.2
#1 lore raw
Quoted 25 lines · Yeqi Fu

The functions debugfs_create_dir and debugfs_create_file_unsafe return ERR_PTR if an error occurs, and the appropriate way to verify for errors is to use the inline function IS_ERR. The patch will substitute the null-comparison with IS_ERR.

---
 drivers/mmc/core/block.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/mmc/core/block.c +1 -1
index 00c33edb9fb9..507bebc22636 100644
@@ -2908,7 +2908,7 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 			debugfs_create_file_unsafe("status", 0400, root,
 						   card,
 						   &mmc_dbg_card_status_fops);
-		if (!md->status_dentry)
+		if (IS_ERR(md->status_dentry))
 			return -EIO;
 	}
 

drivers/mmc/core/block.c static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md) · line 2922

Quoted 8 lines
drivers/mmc/core/block.c +1 -1
@@ -2916,7 +2916,7 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 		md->ext_csd_dentry =
 			debugfs_create_file("ext_csd", S_IRUSR, root, card,
 					    &mmc_dbg_ext_csd_fops);
-		if (!md->ext_csd_dentry)
+		if (IS_ERR(md->ext_csd_dentry))
 			return -EIO;
 	}
 

The patch is not wrong, but you also need to look at the bigger picture. In this case, the return value is not used. And debugfs API is designed so that return values can be ignored - for example, it is ok to pass NULL or an error code to debugfs_remove(). Generally we don't care if debugfs fails, because it is only for debugging, but it only uses memory resources so it essentially doesn't fail anyway - except when it is not compiled in.

So you could change mmc_blk_add_debugfs() to return void, and drop the error checks entirely.

The error checks in mmc_blk_remove_debugfs() also serve no purpose.

author
#2 lore raw

PATCH 1/1 mmc: core: Remove unnecessary error checks and change return type

The error checks in mmc_blk_add_debugfs() and mmc_blk_remove_debugfs() are extraneous. Therefore, this patch removes all error checks from both functions.
Additionally, mmc_blk_add_debugfs() has been changed to return void instead of an integer value that was never used. This simplifies the function and improves its clarity.

---
 drivers/mmc/core/block.c | 25 +++++++------------------
 1 file changed, 7 insertions(+), 18 deletions(-)
drivers/mmc/core/block.c +7 -18
index 00c33edb9fb9..81f33200b893 100644
@@ -2894,12 +2894,12 @@ static const struct file_operations mmc_dbg_ext_csd_fops = {
 	.llseek		= default_llseek,
 };
 
-static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
+static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 {
 	struct dentry *root;
 
 	if (!card->debugfs_root)
-		return 0;
+		return;
 
 	root = card->debugfs_root;
 
@@ -2908,19 +2908,13 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 			debugfs_create_file_unsafe("status", 0400, root,
 						   card,
 						   &mmc_dbg_card_status_fops);
-		if (!md->status_dentry)
-			return -EIO;
 	}
 
 	if (mmc_card_mmc(card)) {
 		md->ext_csd_dentry =
 			debugfs_create_file("ext_csd", S_IRUSR, root, card,
 					    &mmc_dbg_ext_csd_fops);
-		if (!md->ext_csd_dentry)
-			return -EIO;
 	}
-
-	return 0;
 }
 
 static void mmc_blk_remove_debugfs(struct mmc_card *card,
@@ -2929,22 +2923,17 @@ static void mmc_blk_remove_debugfs(struct mmc_card *card,
 	if (!card->debugfs_root)
 		return;
 
-	if (!IS_ERR_OR_NULL(md->status_dentry)) {
-		debugfs_remove(md->status_dentry);
-		md->status_dentry = NULL;
-	}
+	debugfs_remove(md->status_dentry);
+	md->status_dentry = NULL;
 
-	if (!IS_ERR_OR_NULL(md->ext_csd_dentry)) {
-		debugfs_remove(md->ext_csd_dentry);
-		md->ext_csd_dentry = NULL;
-	}
+	debugfs_remove(md->ext_csd_dentry);
+	md->ext_csd_dentry = NULL;
 }
 
 #else
 
-static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
+static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 {
-	return 0;
 }
 
 static void mmc_blk_remove_debugfs(struct mmc_card *card,
Signature · 1 line
2.37.2
Acked-by on v1 1/1
#3 lore raw

Re: [PATCH] mmc: core: Remove unnecessary error checks and change return type

Quoted 8 lines · Yeqi Fu

The error checks in mmc_blk_add_debugfs() and mmc_blk_remove_debugfs() are extraneous. Therefore, this patch removes all error checks from both functions.
Additionally, mmc_blk_add_debugfs() has been changed to return void instead of an integer value that was never used. This simplifies the function and improves its clarity.

Quoted 71 lines
---
 drivers/mmc/core/block.c | 25 +++++++------------------
 1 file changed, 7 insertions(+), 18 deletions(-)
drivers/mmc/core/block.c +7 -18
index 00c33edb9fb9..81f33200b893 100644
@@ -2894,12 +2894,12 @@ static const struct file_operations mmc_dbg_ext_csd_fops = {
 	.llseek		= default_llseek,
 };
 
-static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
+static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 {
 	struct dentry *root;
 
 	if (!card->debugfs_root)
-		return 0;
+		return;
 
 	root = card->debugfs_root;
 
@@ -2908,19 +2908,13 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 			debugfs_create_file_unsafe("status", 0400, root,
 						   card,
 						   &mmc_dbg_card_status_fops);
-		if (!md->status_dentry)
-			return -EIO;
 	}
 
 	if (mmc_card_mmc(card)) {
 		md->ext_csd_dentry =
 			debugfs_create_file("ext_csd", S_IRUSR, root, card,
 					    &mmc_dbg_ext_csd_fops);
-		if (!md->ext_csd_dentry)
-			return -EIO;
 	}
-
-	return 0;
 }
 
 static void mmc_blk_remove_debugfs(struct mmc_card *card,
@@ -2929,22 +2923,17 @@ static void mmc_blk_remove_debugfs(struct mmc_card *card,
 	if (!card->debugfs_root)
 		return;
 
-	if (!IS_ERR_OR_NULL(md->status_dentry)) {
-		debugfs_remove(md->status_dentry);
-		md->status_dentry = NULL;
-	}
+	debugfs_remove(md->status_dentry);
+	md->status_dentry = NULL;
 
-	if (!IS_ERR_OR_NULL(md->ext_csd_dentry)) {
-		debugfs_remove(md->ext_csd_dentry);
-		md->ext_csd_dentry = NULL;
-	}
+	debugfs_remove(md->ext_csd_dentry);
+	md->ext_csd_dentry = NULL;
 }
 
 #else
 
-static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
+static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 {
-	return 0;
 }
 
 static void mmc_blk_remove_debugfs(struct mmc_card *card,
#4 lore raw

Re: [PATCH] mmc: core: Remove unnecessary error checks and change return type

In reply to Yeqi Fu
Quoted 9 lines · Yeqi Fu

The error checks in mmc_blk_add_debugfs() and mmc_blk_remove_debugfs() are extraneous. Therefore, this patch removes all error checks from both functions.
Additionally, mmc_blk_add_debugfs() has been changed to return void instead of an integer value that was never used. This simplifies the function and improves its clarity.

Applied for next, thanks!

Kind regards
Uffe

Quoted 74 lines
---
 drivers/mmc/core/block.c | 25 +++++++------------------
 1 file changed, 7 insertions(+), 18 deletions(-)
drivers/mmc/core/block.c +7 -19
index 00c33edb9fb9..81f33200b893 100644
@@ -2894,12 +2894,12 @@ static const struct file_operations mmc_dbg_ext_csd_fops = {
        .llseek         = default_llseek,
 };
 
-static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
+static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 {
        struct dentry *root;
 
        if (!card->debugfs_root)
-               return 0;
+               return;
 
        root = card->debugfs_root;
 
@@ -2908,19 +2908,13 @@ static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
                        debugfs_create_file_unsafe("status", 0400, root,
                                                   card,
                                                   &mmc_dbg_card_status_fops);
-               if (!md->status_dentry)
-                       return -EIO;
        }
 
        if (mmc_card_mmc(card)) {
                md->ext_csd_dentry =
                        debugfs_create_file("ext_csd", S_IRUSR, root, card,
                                            &mmc_dbg_ext_csd_fops);
-               if (!md->ext_csd_dentry)
-                       return -EIO;
        }
-
-       return 0;
 }
 
 static void mmc_blk_remove_debugfs(struct mmc_card *card,
@@ -2929,22 +2923,17 @@ static void mmc_blk_remove_debugfs(struct mmc_card *card,
        if (!card->debugfs_root)
                return;
 
-       if (!IS_ERR_OR_NULL(md->status_dentry)) {
-               debugfs_remove(md->status_dentry);
-               md->status_dentry = NULL;
-       }
+       debugfs_remove(md->status_dentry);
+       md->status_dentry = NULL;
 
-       if (!IS_ERR_OR_NULL(md->ext_csd_dentry)) {
-               debugfs_remove(md->ext_csd_dentry);
-               md->ext_csd_dentry = NULL;
-       }
+       debugfs_remove(md->ext_csd_dentry);
+       md->ext_csd_dentry = NULL;
 }
 
 #else
 
-static int mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
+static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
 {
-       return 0;
 }
 
 static void mmc_blk_remove_debugfs(struct mmc_card *card,
--

2.37.2