mtd: ubi: Fix some initialisation failure cases
Subsystems (2)
cover mtd: ubi: Fix some initialisation failure cases
ubi currently fails to initialise if debugfs is enabled at build time but disabled at boot time (CONFIG_DEBUG_FS is enabled and debugfs=off is set on the kernel command line). Errors from debugfs should always be ignored but this wasn't done everywhere.
While fixing this I also noticed that a recent change to ubi removed some cleanup from the ubi_init() failure path that I think is still needed.
This series should fix both problems.
Ben.
Ben Hutchings (2):
mtd: ubi: Restore missing cleanup on ubi_init() failure path
mtd: ubi: Ignore all debugfs initialisation failures
drivers/mtd/ubi/build.c | 15 ++++++--------- drivers/mtd/ubi/debug.c | 33 +++++++-------------------------- drivers/mtd/ubi/debug.h | 4 ++-- 3 files changed, 15 insertions(+), 37 deletions(-)
Signature · 6 lines
2.39.2 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
PATCH 1/2 mtd: ubi: Restore missing cleanup on ubi_init() failure path
We need to clean-up debugfs and ubiblock if we fail after initialising them.
--- drivers/mtd/ubi/build.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/mtd/ubi/build.c +4 -1
@@ -1372,7 +1372,7 @@ static int __init ubi_init(void)/* See comment above re-ubi_is_module(). */ if (ubi_is_module ()) - goto out_slab; + goto out_debugfs; }register_mtd_user (&ubi_mtd_notifier);
@@ -1387,6 +1387,9 @@ static int __init ubi_init(void) out_mtd_notifier:unregister_mtd_user (&ubi_mtd_notifier); +ubiblock_exit (); +out_debugfs: +ubi_debugfs_exit (); out_slab:kmem_cache_destroy (ubi_wl_entry_slab); out_dev_unreg:
Signature · 6 lines
2.39.2 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
PATCH 2/2 mtd: ubi: Ignore all debugfs initialisation failures
In reply to Ben HutchingsDrivers should never stop initialising or probing because of a failure to create debugfs entries. Such failures are harmless and could be the intended result of setting the kernel parameter debugfs=off.
This was partially fixed in 2019, but some error checks were missed and another one was been added since.
--- drivers/mtd/ubi/build.c | 10 ++-------- drivers/mtd/ubi/debug.c | 33 +++++++-------------------------- drivers/mtd/ubi/debug.h | 4 ++-- 3 files changed, 11 insertions(+), 36 deletions(-)
drivers/mtd/ubi/build.c +2 -8
@@ -1018,9 +1018,7 @@ int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,if (err) goto out_detach; - err =ubi_debugfs_init_dev (ubi); -if (err) - goto out_uif; +ubi_debugfs_init_dev (ubi); ubi->bgt_thread =kthread_create (ubi_thread, ubi,"%s" , ubi->bgt_name);if (IS_ERR (ubi->bgt_thread)) {
@@ -1064,7 +1062,6 @@ int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, out_debugfs:ubi_debugfs_exit_dev (ubi); -out_uif:uif_close (ubi); out_detach:ubi_wl_close (ubi);
@@ -1362,9 +1359,7 @@ static int __init ubi_init(void) goto out_dev_unreg; } - err =ubi_debugfs_init (); -if (err) - goto out_slab; +ubi_debugfs_init (); err =ubiblock_init ();if (err) {
@@ -1390,7 +1385,6 @@ static int __init ubi_init(void)ubiblock_exit (); out_debugfs:ubi_debugfs_exit (); -out_slab:kmem_cache_destroy (ubi_wl_entry_slab); out_dev_unreg:misc_deregister (&ubi_ctrl_cdev);
drivers/mtd/ubi/debug.c +7 -26
@@ -248,13 +248,6 @@ static void dfs_create_fault_entry(struct dentry *parent)struct dentry *dir; dir =debugfs_create_dir ("fault_inject" , parent); -if (IS_ERR_OR_NULL (dir)) { -int err = dir ?PTR_ERR (dir) : -ENODEV ; - -pr_warn ("UBI error: cannot create \"fault_inject\" debugfs directory, error %d\n" , - err); -return ; - }fault_create_debugfs_attr ("emulate_eccerr" , dir, &fault_eccerr_attr);
@@ -291,28 +284,18 @@ static void dfs_create_fault_entry(struct dentry *parent)/** * ubi_debugfs_init - create UBI debugfs directory. * -* Create UBI debugfs directory. Returns zero in case of success and a negative -* error code in case of failure. +* Try to create UBI debugfs directory. */ -int ubi_debugfs_init (void ) +void ubi_debugfs_init (void ) {if (!IS_ENABLED (CONFIG_DEBUG_FS )) -return 0 ; +return ; dfs_rootdir =debugfs_create_dir ("ubi" ,NULL ); -if (IS_ERR_OR_NULL (dfs_rootdir)) { -int err = dfs_rootdir ?PTR_ERR (dfs_rootdir) : -ENODEV ; - -pr_err ("UBI error: cannot create \"ubi\" debugfs directory, error %d\n" , - err); -return err; - }#ifdef CONFIG_MTD_UBI_FAULT_INJECTION dfs_create_fault_entry (dfs_rootdir);#endif - -return 0 ; }/**
@@ -585,10 +568,9 @@ static const struct file_operations eraseblk_count_fops = {* ubi_debugfs_init_dev - initialize debugfs for an UBI device. * @ubi: UBI device description object * -* This function creates all debugfs files for UBI device @ubi. Returns zero in -* case of success and a negative error code in case of failure. +* This function tries to create all debugfs files for UBI device @ubi. */ -int ubi_debugfs_init_dev (struct ubi_device *ubi) +void ubi_debugfs_init_dev (struct ubi_device *ubi) {unsigned long ubi_num = ubi->ubi_num;struct ubi_debug_info *d = &ubi->dbg;
@@ -596,13 +578,13 @@ int ubi_debugfs_init_dev(struct ubi_device *ubi)int n;if (!IS_ENABLED (CONFIG_DEBUG_FS )) -return 0 ; +return ; n =snprintf (d->dfs_dir_name,UBI_DFS_DIR_LEN +1 ,UBI_DFS_DIR_NAME , ubi->ubi_num);if (n >UBI_DFS_DIR_LEN ) {/* The array size is too small */ -return -EINVAL ; +return ; } d->dfs_dir =debugfs_create_dir (d->dfs_dir_name, dfs_rootdir);
@@ -653,7 +635,6 @@ int ubi_debugfs_init_dev(struct ubi_device *ubi) (void *)ubi_num, &dfs_fops);#endif -return 0 ; }/**
drivers/mtd/ubi/debug.h +2 -2
@@ -47,9 +47,9 @@ void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type);void ubi_dump_mkvol_req (const struct ubi_mkvol_req *req);int ubi_self_check_all_ff (struct ubi_device *ubi,int pnum,int offset,int len); -int ubi_debugfs_init (void ); +void ubi_debugfs_init (void );void ubi_debugfs_exit (void ); -int ubi_debugfs_init_dev (struct ubi_device *ubi); +void ubi_debugfs_init_dev (struct ubi_device *ubi);void ubi_debugfs_exit_dev (struct ubi_device *ubi);/**
Signature · 6 lines
2.39.2 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
Zhihao Cheng
reviewerRe: [PATCH 2/2] mtd: ubi: Ignore all debugfs initialisation failures
Quoted 64 lines · Ben Hutchings
Drivers should never stop initialising or probing because of a failure to create debugfs entries. Such failures are harmless and could be the intended result of setting the kernel parameter debugfs=off.
This was partially fixed in 2019, but some error checks were missed and another one was been added since.
Signed-off-by Ben Hutchings <[email protected]>Fixes 2a734bb8d502 ("UBI: use debugfs for the extra checks knobs")Fixes c2d73ba892ea ("mtd: no need to check return value of ...")Fixes 6931fb44858c ("ubi: Use the fault injection framework to enhance ...")--- drivers/mtd/ubi/build.c | 10 ++-------- drivers/mtd/ubi/debug.c | 33 +++++++-------------------------- drivers/mtd/ubi/debug.h | 4 ++-- 3 files changed, 11 insertions(+), 36 deletions(-)drivers/mtd/ubi/build.c +2
-8@@ -1018,9 +1018,7 @@ int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,if (err) goto out_detach; - err =ubi_debugfs_init_dev (ubi); -if (err) - goto out_uif; +ubi_debugfs_init_dev (ubi); ubi->bgt_thread =kthread_create (ubi_thread, ubi,"%s" , ubi->bgt_name);if (IS_ERR (ubi->bgt_thread)) {@@ -1064,7 +1062,6 @@ int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, out_debugfs:ubi_debugfs_exit_dev (ubi); -out_uif:uif_close (ubi); out_detach:ubi_wl_close (ubi);@@ -1362,9 +1359,7 @@ static int __init ubi_init(void) goto out_dev_unreg; } - err =ubi_debugfs_init (); -if (err) - goto out_slab; +ubi_debugfs_init (); err =ubiblock_init ();if (err) {@@ -1390,7 +1385,6 @@ static int __init ubi_init(void)ubiblock_exit (); out_debugfs:ubi_debugfs_exit (); -out_slab:kmem_cache_destroy (ubi_wl_entry_slab); out_dev_unreg:misc_deregister (&ubi_ctrl_cdev);drivers/mtd/ubi/debug.c +0
-0
drivers/mtd/ubi/debug.c static void dfs_create_fault_entry(struct dentry *parent) · line 257
Quoted 10 lines
drivers/mtd/ubi/debug.c +0
-7@@ -248,13 +248,6 @@ static void dfs_create_fault_entry(struct dentry *parent)struct dentry *dir; dir =debugfs_create_dir ("fault_inject" , parent); -if (IS_ERR_OR_NULL (dir)) { -int err = dir ?PTR_ERR (dir) : -ENODEV ; - -pr_warn ("UBI error: cannot create \"fault_inject\" debugfs directory, error %d\n" , - err); -return ; - }
I think we can keep this error path, sub dirs won't be created by following functions if dir is assigned as error code. so ubi could return in advance and prints a warning message to notify user that fault injection debugfs initialization is failed.
Quoted 16 lines
drivers/mtd/ubi/debug.c +2
-4fault_create_debugfs_attr ("emulate_eccerr" , dir, &fault_eccerr_attr);@@ -291,28 +284,18 @@ static void dfs_create_fault_entry(struct dentry *parent)/** * ubi_debugfs_init - create UBI debugfs directory. * -* Create UBI debugfs directory. Returns zero in case of success and a negative -* error code in case of failure. +* Try to create UBI debugfs directory. */ -int ubi_debugfs_init (void ) +void ubi_debugfs_init (void ) {if (!IS_ENABLED (CONFIG_DEBUG_FS )) -return 0 ;
drivers/mtd/ubi/debug.c static void dfs_create_fault_entry(struct dentry *parent) · line 309
Quoted 10 lines
drivers/mtd/ubi/debug.c +1
-7+return ; dfs_rootdir =debugfs_create_dir ("ubi" ,NULL ); -if (IS_ERR_OR_NULL (dfs_rootdir)) { -int err = dfs_rootdir ?PTR_ERR (dfs_rootdir) : -ENODEV ; - -pr_err ("UBI error: cannot create \"ubi\" debugfs directory, error %d\n" , - err); -return err; - }
Similar to previous, also replace 'pr_err' with 'pr_warn'.
drivers/mtd/ubi/debug.c static void dfs_create_fault_entry(struct dentry *parent) · line 299
Quoted 7 lines
drivers/mtd/ubi/debug.c +0
-2#ifdef CONFIG_MTD_UBI_FAULT_INJECTION dfs_create_fault_entry (dfs_rootdir);#endif - -return 0 ; }
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
Zhihao Cheng
reviewerQuoted 5 lines · Ben Hutchings
ubi currently fails to initialise if debugfs is enabled at build time but disabled at boot time (
CONFIG_DEBUG_FSis enabled and debugfs=off is set on the kernel command line). Errors from debugfs should always be ignored but this wasn't done everywhere.
Quoted 7 lines
While fixing this I also noticed that a recent change to ubi removed some cleanup from the
ubi_init()failure path that I think is still needed.This series should fix both problems.
Ben.
Hi, Ben. I have a same patch with your first one, I have merge our patchset into a new series [1]
[1] https://lore.kernel.org/linux-mtd/[email protected]/
Quoted 10 lines
Ben Hutchings (2):
mtd: ubi: Restore missing cleanup onubi_init()failure path
mtd: ubi: Ignore all debugfs initialisation failuresdrivers/mtd/ubi/build.c | 15 ++++++--------- drivers/mtd/ubi/debug.c | 33 +++++++-------------------------- drivers/mtd/ubi/debug.h | 4 ++-- 3 files changed, 15 insertions(+), 37 deletions(-)
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
Quoted 10 lines · Zhihao Cheng
Quoted 9 lines · Ben Hutchings
ubi currently fails to initialise if debugfs is enabled at build time but disabled at boot time (
CONFIG_DEBUG_FSis enabled and debugfs=off is set on the kernel command line). Errors from debugfs should always be ignored but this wasn't done everywhere.While fixing this I also noticed that a recent change to ubi removed some cleanup from the
ubi_init()failure path that I think is still needed.
Quoted 7 lines
Quoted 3 lines
This series should fix both problems.
Ben.
Hi, Ben. I have a same patch with your first one, I have merge our patchset into a new series [1]
[1] https://lore.kernel.org/linux-mtd/[email protected]/
[...]
Thank you!
Ben.
Signature · 5 lines
Ben Hutchings · Senior Embedded Software Engineer, Essensium-Mind · mind.be ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/