Skip to contentSkip to conversation

s390: kernel: no need to check return value of debugfs_create functions

PATCH Applied Greg Kroah-Hartman 2 participants 5 messages Jan 22, 2019 – Jan 25, 2019 s390

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 s390: kernel: no need to check return value of debugfs_create functions

When calling debugfs functions, there is no need to ever check the return value. The function can work or not, but the code logic should never do something different based on this.

Cc Martin Schwidefsky <[email protected]>
Cc Heiko Carstens <[email protected]>
Cc Kees Cook <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Hendrik Brueckner <[email protected]>
---
 arch/s390/kernel/debug.c    | 6 ------
 arch/s390/kernel/kdebugfs.c | 2 --
 arch/s390/kernel/sysinfo.c  | 2 --
 3 files changed, 10 deletions(-)
arch/s390/kernel/debug.c +0 -6
index d374f9b218b4..0ebf08c3b35e 100644
@@ -1056,12 +1056,6 @@ int debug_register_view(debug_info_t *id, struct debug_view *view)
 		mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
 	pde = debugfs_create_file(view->name, mode, id->debugfs_root_entry,
 				  id, &debug_file_ops);
-	if (!pde) {
-		pr_err("Registering view %s/%s failed due to out of "
-		       "memory\n", id->name, view->name);
-		rc = -1;
-		goto out;
-	}
 	spin_lock_irqsave(&id->lock, flags);
 	for (i = 0; i < DEBUG_MAX_VIEWS; i++) {
 		if (!id->views[i])
arch/s390/kernel/kdebugfs.c +0 -2
index 2c46bd6c6fd2..33130c7daf55 100644
@@ -9,8 +9,6 @@ EXPORT_SYMBOL(arch_debugfs_dir);
 static int __init arch_kdebugfs_init(void)
 {
 	arch_debugfs_dir = debugfs_create_dir("s390", NULL);
-	if (IS_ERR(arch_debugfs_dir))
-		arch_debugfs_dir = NULL;
 	return 0;
 }
 postcore_initcall(arch_kdebugfs_init);
arch/s390/kernel/sysinfo.c +0 -2
index 12f80d1f0415..2ac3c9b56a13 100644
@@ -545,8 +545,6 @@ static __init int stsi_init_debugfs(void)
 	int lvl, i;
 
 	stsi_root = debugfs_create_dir("stsi", arch_debugfs_dir);
-	if (IS_ERR_OR_NULL(stsi_root))
-		return 0;
 	lvl = stsi(NULL, 0, 0, 0);
 	if (lvl > 0)
 		stsi_0_0_0 = lvl;
Signature · 1 line
2.20.1
#1 lore raw
Quoted 21 lines · Greg Kroah-Hartman

When calling debugfs functions, there is no need to ever check the return value. The function can work or not, but the code logic should never do something different based on this.

Cc Martin Schwidefsky <[email protected]>
Cc Heiko Carstens <[email protected]>
Cc Kees Cook <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Hendrik Brueckner <[email protected]>
---
 arch/s390/kernel/debug.c    | 6 ------
 arch/s390/kernel/kdebugfs.c | 2 --
 arch/s390/kernel/sysinfo.c  | 2 --
 3 files changed, 10 deletions(-)
arch/s390/kernel/sysinfo.c +0 -0
index 12f80d1f0415..2ac3c9b56a13 100644

arch/s390/kernel/sysinfo.c static __init int stsi_init_debugfs(void) · line 549

Quoted 5 lines
arch/s390/kernel/sysinfo.c +0 -2
@@ -545,8 +545,6 @@ static __init int stsi_init_debugfs(void)
 	int lvl, i;
 
 	stsi_root = debugfs_create_dir("stsi", arch_debugfs_dir);
-	if (IS_ERR_OR_NULL(stsi_root))
-		return 0;

No objections, however will you also change the odd behaviour that e.g. debugfs_create_file() returns -ENODEV instead of (the expected) NULL pointer if CONFIG_DEBUGFS is disabled?

I do remember this since it caused at least one crash ;)

19cdd08ba155 ("[S390] qdio: fix broken pointer in case of CONFIG_DEBUG_FS is disabled").

#2 lore raw
Quoted 24 lines · Heiko Carstens
Quoted 23 lines · Greg Kroah-Hartman

When calling debugfs functions, there is no need to ever check the return value. The function can work or not, but the code logic should never do something different based on this.

Cc Martin Schwidefsky <[email protected]>
Cc Heiko Carstens <[email protected]>
Cc Kees Cook <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Hendrik Brueckner <[email protected]>
---
 arch/s390/kernel/debug.c    | 6 ------
 arch/s390/kernel/kdebugfs.c | 2 --
 arch/s390/kernel/sysinfo.c  | 2 --
 3 files changed, 10 deletions(-)
arch/s390/kernel/sysinfo.c +0 -0
index 12f80d1f0415..2ac3c9b56a13 100644
@@ -545,8 +545,6 @@ static __init int stsi_init_debugfs(void)
 	int lvl, i;
 
Quoted 7 lines

arch/s390/kernel/sysinfo.c static __init int stsi_init_debugfs(void) · line 549

Quoted 3 lines
arch/s390/kernel/sysinfo.c +0 -2
 	stsi_root = debugfs_create_dir("stsi", arch_debugfs_dir);
-	if (IS_ERR_OR_NULL(stsi_root))
-		return 0;

No objections, however will you also change the odd behaviour that e.g. debugfs_create_file() returns -ENODEV instead of (the expected) NULL pointer if CONFIG_DEBUGFS is disabled?

Nope. That is intentional.

Quoted 1 line

I do remember this since it caused at least one crash ;)

Which is why you shouldn't care about the return value of these functions :)

Quoted 1 line

19cdd08ba155 ("[S390] qdio: fix broken pointer in case of CONFIG_DEBUG_FS is disabled").

Odd, what crashes when passed an error pointer? What was someone trying to do with those pointers? The only thing you can do with a return value from a debugfs function is to pass it back into another debugfs call. Sounds like someone wasn't doing that :(

Given that that patch was from 2.6.29, I think we are safe...

thanks,

greg k-h

#3 lore raw
Quoted 40 lines · Greg Kroah-Hartman
Quoted 24 lines · Heiko Carstens
Quoted 23 lines · Greg Kroah-Hartman

When calling debugfs functions, there is no need to ever check the return value. The function can work or not, but the code logic should never do something different based on this.

Cc Martin Schwidefsky <[email protected]>
Cc Heiko Carstens <[email protected]>
Cc Kees Cook <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Hendrik Brueckner <[email protected]>
---
 arch/s390/kernel/debug.c    | 6 ------
 arch/s390/kernel/kdebugfs.c | 2 --
 arch/s390/kernel/sysinfo.c  | 2 --
 3 files changed, 10 deletions(-)
arch/s390/kernel/sysinfo.c +0 -0
index 12f80d1f0415..2ac3c9b56a13 100644
@@ -545,8 +545,6 @@ static __init int stsi_init_debugfs(void)
 	int lvl, i;
 
Quoted 7 lines

arch/s390/kernel/sysinfo.c static __init int stsi_init_debugfs(void) · line 549

Quoted 3 lines
arch/s390/kernel/sysinfo.c +0 -2
 	stsi_root = debugfs_create_dir("stsi", arch_debugfs_dir);
-	if (IS_ERR_OR_NULL(stsi_root))
-		return 0;

No objections, however will you also change the odd behaviour that e.g. debugfs_create_file() returns -ENODEV instead of (the expected) NULL pointer if CONFIG_DEBUGFS is disabled?

Nope. That is intentional.

Quoted 1 line

I do remember this since it caused at least one crash ;)

Which is why you shouldn't care about the return value of these functions :)

Quoted 6 lines
Quoted 1 line

19cdd08ba155 ("[S390] qdio: fix broken pointer in case of CONFIG_DEBUG_FS is disabled").

Odd, what crashes when passed an error pointer? What was someone trying to do with those pointers? The only thing you can do with a return value from a debugfs function is to pass it back into another debugfs call. Sounds like someone wasn't doing that :(

I think it used to be this code that crashed:

static void remove_debugfs_entry(struct qdio_q *q)

{
	int i;

	for (i = 0; i < MAX_DEBUGFS_QUEUES; i++) {
		if (!debugfs_queues[i])
			continue;
----->		if (debugfs_queues[i]->d_inode->i_private == q) {
			debugfs_remove(debugfs_queues[i]);
			debugfs_queues[i] = NULL;
		}
	}
}

Which looks like a layering violation anyway. However this code is gone, so everything should be fine.

#4 lore raw
In reply to Greg Kroah-Hartman
Quoted 11 lines · Greg Kroah-Hartman

When calling debugfs functions, there is no need to ever check the return value. The function can work or not, but the code logic should never do something different based on this.

Cc Martin Schwidefsky <[email protected]>
Cc Heiko Carstens <[email protected]>
Cc Kees Cook <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Hendrik Brueckner <[email protected]>
Quoted 5 lines
---
 arch/s390/kernel/debug.c    | 6 ------
 arch/s390/kernel/kdebugfs.c | 2 --
 arch/s390/kernel/sysinfo.c  | 2 --
 3 files changed, 10 deletions(-)

Applied, thanks!