Fix error handling in add_disk
PATCH 1/1 Fix error handling in add_disk
Fix error handling in add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.
---
block/genhd.c +32 -8
@@ -472,11 +472,11 @@ static char *bdevt_str(dev_t devt, char *buf)* range must be nonzero * The hash chain is sorted on range, so that subranges can override. */ -void blk_register_region (dev_t devt,unsigned long range,struct module *module, +int blk_register_region (dev_t devt,unsigned long range,struct module *module,struct kobject *(*probe)(dev_t ,int *,void *),int (*lock)(dev_t ,void *),void *data) { -kobj_map (bdev_map, devt, range, module, probe, lock, data); +return kobj_map (bdev_map, devt, range, module, probe, lock, data); }EXPORT_SYMBOL (blk_register_region);
@@ -511,9 +511,9 @@ static int exact_lock(dev_t devt, void *data)* This function registers the partitioning information in @disk * with the kernel. * -* FIXME: error handling +* TODO: Remove WARN_ON()'s when all the callers handle the error. */ -void add_disk (struct gendisk *disk) +int add_disk (struct gendisk *disk) {struct backing_dev_info *bdi;dev_t devt;
@@ -531,7 +531,7 @@ void add_disk(struct gendisk *disk) retval =blk_alloc_devt (&disk->part0, &devt);if (retval) {WARN_ON (1 ); -return ; + goto err_out; }disk_to_dev (disk)->devt = devt;
@@ -541,16 +541,40 @@ void add_disk(struct gendisk *disk) disk->major =MAJOR (devt); disk->first_minor =MINOR (devt); -blk_register_region (disk_devt (disk), disk->minors,NULL , + retval =blk_register_region (disk_devt (disk), disk->minors,NULL , exact_match, exact_lock, disk); +if (retval) { +WARN_ON (1 ); + goto err_free_devt; + } +register_disk (disk); -blk_register_queue (disk); + + retval =blk_register_queue (disk); +if (retval) { +WARN_ON (1 ); + goto err_free_region; + } bdi = &disk->queue->backing_dev_info;bdi_register_dev (bdi,disk_devt (disk)); retval =sysfs_create_link (&disk_to_dev (disk)->kobj, &bdi->dev->kobj,"bdi" ); -WARN_ON (retval); +if (retval) { +WARN_ON (1 ); + goto err_free_queue; + } + +return 0 ; + +err_free_queue: +blk_unregister_queue (disk); +err_free_region: +blk_unregister_region (disk_devt (disk), disk->minors); +err_free_devt: +blk_free_devt (disk_devt (disk)); +err_out: +return retval; }EXPORT_SYMBOL (add_disk);
include/linux/genhd.h +2 -2
@@ -339,7 +339,7 @@ static inline void part_dec_in_flight(struct hd_struct *part)extern void part_round_stats (int cpu,struct hd_struct *part);/* block/genhd.c */ -extern void add_disk (struct gendisk *disk); +extern int add_disk (struct gendisk *disk);extern void del_gendisk (struct gendisk *gp);extern void unlink_gendisk (struct gendisk *gp);extern struct gendisk *get_gendisk (dev_t dev,int *partno);
@@ -534,7 +534,7 @@ extern struct gendisk *alloc_disk_node(int minors, int node_id);extern struct gendisk *alloc_disk (int minors);extern struct kobject *get_disk (struct gendisk *disk);extern void put_disk (struct gendisk *disk); -extern void blk_register_region(dev_t devt, unsigned long range, +extern int blk_register_region(dev_t devt, unsigned long range, struct module *module, struct kobject *(*probe)(dev_t, int *, void *), int (*lock)(dev_t, void *),
Quoted 3 lines · On Wed, 17 Jun 2009 12:31:10 +0530 Nikanth Karthikesan <[email protected]> wrote:
Fix error handling in
add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.
I have a vague ancestral memory that some of the unchecked errors which you're now checking for actually do happen in practice, and that this "fix" will end up breaking currently-working setups.
Or maybe I'm thinking of a similar but different piece of code (maybe it was the partition code?).
Still, I think it would be prudent to initially make this patch continue to ignore the errors. So add the warnings, but don't change the response to errors. Then we can get the change distributed for a bit of testing and if that all looks good then we can add the control flow changes later.
Quoted 12 lines
(quoted diff) +5
-1retval = blk_alloc_devt(&disk->part0, &devt); if (retval) { WARN_ON(1); - return; + goto err_out; } + if (retval) { + WARN_ON(1); + goto err_free_devt; + }
Review
Quoted 10 lines
(quoted diff) +8
-1+ if (retval) { + WARN_ON(1); + goto err_free_region; + } - WARN_ON(retval); + if (retval) { + WARN_ON(1); + goto err_free_queue; + }
These all can be coded as
if (WARN_ON(retval)) goto foo;
Quoted 10 lines · On Wednesday 24 June 2009 02:53:57 Andrew Morton wrote:
On Wed, 17 Jun 2009 12:31:10 +0530
Quoted 2 lines · Nikanth Karthikesan
Fix error handling in
add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.I have a vague ancestral memory that some of the unchecked errors which you're now checking for actually do happen in practice, and that this "fix" will end up breaking currently-working setups.
Quoted 9 lines
Or maybe I'm thinking of a similar but different piece of code (maybe it was the partition code?).
Still, I think it would be prudent to initially make this patch continue to ignore the errors. So add the warnings, but don't change the response to errors. Then we can get the change distributed for a bit of testing and if that all looks good then we can add the control flow changes later.
add_disk and blk_register_region are functions returning void masking the error, which this patch changes. So no caller check for it's return value! And hence errors are ignored, and nothing breaks.
Quoted 25 lines
Quoted 12 lines
(quoted diff) +5
-1retval = blk_alloc_devt(&disk->part0, &devt); if (retval) { WARN_ON(1); - return; + goto err_out; } + if (retval) { + WARN_ON(1); + goto err_free_devt; + }Review
Quoted 10 lines
(quoted diff) +8
-1+ if (retval) { + WARN_ON(1); + goto err_free_region; + } - WARN_ON(retval); + if (retval) { + WARN_ON(1); + goto err_free_queue; + }These all can be coded as
Quoted 2 lines
if (WARN_ON(retval)) goto foo;
done.
Thanks
Nikanth
Fix error handling in add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.
---
block/genhd.c +28 -11
@@ -472,11 +472,11 @@ static char *bdevt_str(dev_t devt, char *buf)* range must be nonzero * The hash chain is sorted on range, so that subranges can override. */ -void blk_register_region (dev_t devt,unsigned long range,struct module *module, +int blk_register_region (dev_t devt,unsigned long range,struct module *module,struct kobject *(*probe)(dev_t ,int *,void *),int (*lock)(dev_t ,void *),void *data) { -kobj_map (bdev_map, devt, range, module, probe, lock, data); +return kobj_map (bdev_map, devt, range, module, probe, lock, data); }EXPORT_SYMBOL (blk_register_region);
@@ -511,9 +511,9 @@ static int exact_lock(dev_t devt, void *data)* This function registers the partitioning information in @disk * with the kernel. * -* FIXME: error handling +* TODO: Remove WARN_ON()'s when all the callers handle the error. */ -void add_disk (struct gendisk *disk) +int add_disk (struct gendisk *disk) {struct backing_dev_info *bdi;dev_t devt;
@@ -529,10 +529,9 @@ void add_disk(struct gendisk *disk) disk->flags |=GENHD_FL_UP ; retval =blk_alloc_devt (&disk->part0, &devt); -if (retval) { -WARN_ON (1 ); -return ; - } +if (WARN_ON (retval)) + goto err_out; +disk_to_dev (disk)->devt = devt;/* ->major and ->first_minor aren't supposed to be
@@ -541,16 +540,34 @@ void add_disk(struct gendisk *disk) disk->major =MAJOR (devt); disk->first_minor =MINOR (devt); -blk_register_region (disk_devt (disk), disk->minors,NULL , + retval =blk_register_region (disk_devt (disk), disk->minors,NULL , exact_match, exact_lock, disk); +if (WARN_ON (retval)) + goto err_free_devt; +register_disk (disk); -blk_register_queue (disk); + + retval =blk_register_queue (disk); +if (WARN_ON (retval)) + goto err_free_region; bdi = &disk->queue->backing_dev_info;bdi_register_dev (bdi,disk_devt (disk)); retval =sysfs_create_link (&disk_to_dev (disk)->kobj, &bdi->dev->kobj,"bdi" ); -WARN_ON (retval); +if (WARN_ON (retval)) + goto err_free_queue; + +return 0 ; + +err_free_queue: +blk_unregister_queue (disk); +err_free_region: +blk_unregister_region (disk_devt (disk), disk->minors); +err_free_devt: +blk_free_devt (disk_devt (disk)); +err_out: +return retval; }EXPORT_SYMBOL (add_disk);
include/linux/genhd.h +2 -2
@@ -339,7 +339,7 @@ static inline void part_dec_in_flight(struct hd_struct *part)extern void part_round_stats (int cpu,struct hd_struct *part);/* block/genhd.c */ -extern void add_disk (struct gendisk *disk); +extern int add_disk (struct gendisk *disk);extern void del_gendisk (struct gendisk *gp);extern void unlink_gendisk (struct gendisk *gp);extern struct gendisk *get_gendisk (dev_t dev,int *partno);
@@ -534,7 +534,7 @@ extern struct gendisk *alloc_disk_node(int minors, int node_id);extern struct gendisk *alloc_disk (int minors);extern struct kobject *get_disk (struct gendisk *disk);extern void put_disk (struct gendisk *disk); -extern void blk_register_region(dev_t devt, unsigned long range, +extern int blk_register_region(dev_t devt, unsigned long range, struct module *module, struct kobject *(*probe)(dev_t, int *, void *), int (*lock)(dev_t, void *),
Quoted 21 lines · On Wed, 24 Jun 2009 12:18:13 +0530 Nikanth Karthikesan <[email protected]> wrote:
Quoted 10 lines · On Wednesday 24 June 2009 02:53:57 Andrew Morton wrote:
On Wed, 17 Jun 2009 12:31:10 +0530
Quoted 2 lines · Nikanth Karthikesan
Fix error handling in
add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.I have a vague ancestral memory that some of the unchecked errors which you're now checking for actually do happen in practice, and that this "fix" will end up breaking currently-working setups.
Quoted 9 lines
Or maybe I'm thinking of a similar but different piece of code (maybe it was the partition code?).
Still, I think it would be prudent to initially make this patch continue to ignore the errors. So add the warnings, but don't change the response to errors. Then we can get the change distributed for a bit of testing and if that all looks good then we can add the control flow changes later.
Quoted 2 lines
add_diskandblk_register_regionare functions returning void masking the error
ugh, we're bad.
Quoted 2 lines
which this patch changes. So no caller check for it's return value! And hence errors are ignored, and nothing breaks.
It _does_ change behaviour. add_disk() can now bale out if, for example, sysfs_create_link() failed. As it commonly does, due to various screwups.
Quoted 28 lines
Quoted 25 lines
Quoted 12 lines
(quoted diff) +5
-1retval = blk_alloc_devt(&disk->part0, &devt); if (retval) { WARN_ON(1); - return; + goto err_out; } + if (retval) { + WARN_ON(1); + goto err_free_devt; + }Review
Quoted 10 lines
(quoted diff) +8
-1+ if (retval) { + WARN_ON(1); + goto err_free_region; + } - WARN_ON(retval); + if (retval) { + WARN_ON(1); + goto err_free_queue; + }These all can be coded as
Quoted 2 lines
if (WARN_ON(retval)) goto foo;
Quoted 8 lines
done.
Thanks
NikanthFix error handling in
add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.
The changelog hasn't been updated to reflect this discussion. There's information missing here.
Also, why was this patch written? Have you observed some behaviour which this patch improved or corrected?
I applaud the effort, but it's obviously incomplete. Do you intend to add further error checking and handling in this area?
Quoted 24 lines · On Thursday 25 June 2009 08:41:54 Andrew Morton wrote:
Quoted 14 lines · On Wed, 24 Jun 2009 12:18:13 +0530 Nikanth Karthikesan <[email protected]> wrote:
Quoted 13 lines · On Wednesday 24 June 2009 02:53:57 Andrew Morton wrote:
On Wed, 17 Jun 2009 12:31:10 +0530
Quoted 2 lines · Nikanth Karthikesan
Fix error handling in
add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.I have a vague ancestral memory that some of the unchecked errors which you're now checking for actually do happen in practice, and that this "fix" will end up breaking currently-working setups.
Or maybe I'm thinking of a similar but different piece of code (maybe it was the partition code?).
Quoted 8 lines
Quoted 5 lines
Still, I think it would be prudent to initially make this patch continue to ignore the errors. So add the warnings, but don't change the response to errors. Then we can get the change distributed for a bit of testing and if that all looks good then we can add the control flow changes later.
add_diskandblk_register_regionare functions returning void masking the error
Quoted 9 lines
ugh, we're bad.
Quoted 2 lines
which this patch changes. So no caller check for it's return value! And hence errors are ignored, and nothing breaks.
It _does_ change behaviour.
add_disk()can now bale out if, for example,sysfs_create_link()failed. As it commonly does, due to various screwups.
ah, yes. This patch does mofiy behaviour. :(
Quoted 37 lines
Quoted 28 lines
Quoted 25 lines
Quoted 12 lines
(quoted diff) +5
-1retval = blk_alloc_devt(&disk->part0, &devt); if (retval) { WARN_ON(1); - return; + goto err_out; } + if (retval) { + WARN_ON(1); + goto err_free_devt; + }Review
Quoted 10 lines
(quoted diff) +8
-1+ if (retval) { + WARN_ON(1); + goto err_free_region; + } - WARN_ON(retval); + if (retval) { + WARN_ON(1); + goto err_free_queue; + }These all can be coded as
Quoted 2 lines
if (WARN_ON(retval)) goto foo;Quoted 8 lines
done.
Thanks
NikanthFix error handling in
add_disk. Also add WARN_ON()'s in case of error, which can be removed once the callers handle the error.
Quoted 7 lines
The changelog hasn't been updated to reflect this discussion. There's information missing here.
Also, why was this patch written? Have you observed some behaviour which this patch improved or corrected?
No. I am just trying to cleanup.
Quoted 2 lines
I applaud the effort, but it's obviously incomplete. Do you intend to add further error checking and handling in this area?
I was intending to fix the callers one by one. But it seems to be better to do it in one go. I would work on it and send complete patches. Till then could we add few more WARN_ON's and return error code for the case where add_disk fails completely?
Thanks
Nikanth
Add WARN_ON's in case of errors during add_disk. Also return error code when add_disk fails completely. As akpm suggested, in case of partial failure, dont change the current behaviour and return success.
---
block/genhd.c +14 -9
@@ -472,11 +472,11 @@ static char *bdevt_str(dev_t devt, char *buf)* range must be nonzero * The hash chain is sorted on range, so that subranges can override. */ -void blk_register_region (dev_t devt,unsigned long range,struct module *module, +int blk_register_region (dev_t devt,unsigned long range,struct module *module,struct kobject *(*probe)(dev_t ,int *,void *),int (*lock)(dev_t ,void *),void *data) { -kobj_map (bdev_map, devt, range, module, probe, lock, data); +return kobj_map (bdev_map, devt, range, module, probe, lock, data); }EXPORT_SYMBOL (blk_register_region);
@@ -513,7 +513,7 @@ static int exact_lock(dev_t devt, void *data)* * FIXME: error handling */ -void add_disk (struct gendisk *disk) +int add_disk (struct gendisk *disk) {struct backing_dev_info *bdi;dev_t devt;
@@ -529,10 +529,9 @@ void add_disk(struct gendisk *disk) disk->flags |=GENHD_FL_UP ; retval =blk_alloc_devt (&disk->part0, &devt); -if (retval) { -WARN_ON (1 ); -return ; - } +if (WARN_ON (retval)) +return retval; +disk_to_dev (disk)->devt = devt;/* ->major and ->first_minor aren't supposed to be
@@ -541,16 +540,22 @@ void add_disk(struct gendisk *disk) disk->major =MAJOR (devt); disk->first_minor =MINOR (devt); -blk_register_region (disk_devt (disk), disk->minors,NULL , + retval =blk_register_region (disk_devt (disk), disk->minors,NULL , exact_match, exact_lock, disk); +WARN_ON (retval); +register_disk (disk); -blk_register_queue (disk); + + retval =blk_register_queue (disk); +WARN_ON (retval); bdi = &disk->queue->backing_dev_info;bdi_register_dev (bdi,disk_devt (disk)); retval =sysfs_create_link (&disk_to_dev (disk)->kobj, &bdi->dev->kobj,"bdi" );WARN_ON (retval); + +return 0 ; }EXPORT_SYMBOL (add_disk);
include/linux/genhd.h +2 -2
@@ -339,7 +339,7 @@ static inline void part_dec_in_flight(struct hd_struct *part)extern void part_round_stats (int cpu,struct hd_struct *part);/* block/genhd.c */ -extern void add_disk (struct gendisk *disk); +extern int add_disk (struct gendisk *disk);extern void del_gendisk (struct gendisk *gp);extern void unlink_gendisk (struct gendisk *gp);extern struct gendisk *get_gendisk (dev_t dev,int *partno);
@@ -534,7 +534,7 @@ extern struct gendisk *alloc_disk_node(int minors, int node_id);extern struct gendisk *alloc_disk (int minors);extern struct kobject *get_disk (struct gendisk *disk);extern void put_disk (struct gendisk *disk); -extern void blk_register_region(dev_t devt, unsigned long range, +extern int blk_register_region(dev_t devt, unsigned long range, struct module *module, struct kobject *(*probe)(dev_t, int *, void *), int (*lock)(dev_t, void *),