block: fix memory leak in bio_clone()
Subsystems (2)
PATCH 1/1 block: fix memory leak in bio_clone()
If bio_integrity_clone() fails, bio_clone() returns NULL without freeing the newly allocated bio.
--- fs/bio.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)
fs/bio.c +3 -1
@@ -465,8 +465,10 @@ struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask) ret =bio_integrity_clone (b, bio, fs_bio_set); -if (ret <0 ) +if (ret <0 ) { +bio_put (bio);return NULL ; + } }return b;
-- 1.5.4.rc3
Sorry, there was a typo in the previous patch..
=============
From: Li Zefan <[email protected]>
Subject: [PATCH] block: fix memory leak in bio_clone()
If bio_integrity_clone() fails, bio_clone() returns NULL without freeing the newly allocated bio.
--- fs/bio.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)
fs/bio.c +3 -1
@@ -465,8 +465,10 @@ struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask) ret =bio_integrity_clone (b, bio, fs_bio_set); -if (ret <0 ) +if (ret <0 ) { +bio_put (b);return NULL ; + } }return b;
Signature · 1 line
1.5.4.rc3
Quoted 15 lines · Li Zefan
If
bio_integrity_clone()fails,bio_clone()returns NULL without freeing the newly allocated bio.Signed-off-by Li Zefan <[email protected]>--- fs/bio.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)fs/bio.c +0
-0@@ -465,8 +465,10 @@ struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask) ret =bio_integrity_clone (b, bio, fs_bio_set);
fs/bio.c struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
Quoted 10 lines
fs/bio.c +3
-2-if (ret <0 ) +if (ret <0 ) { +bio_put (bio);return NULL ; + } }return b; -- 1.5.4.rc3
Good spotting. But it looks like there are actually several problems there. bio_integrity_clone() is mempool backed. Currently that ret < 0 can never trigger, since bio_integrity_clone() has hard-wired __GFP_WAIT as the mempool mask. So the leak will not occur, but it does mean that it isn't honoring the gfp_mask passed in to bio_clone(), which is the first bug. The second bug is that it should be using its own bioset, as it is illegal to do multiple __GFP_WAIT allocations on a single mempool and always expect progress.
Signature · 1 line
Jens Axboe
Quoted 24 lines · Jens Axboe
Quoted 23 lines · Li Zefan
If
bio_integrity_clone()fails,bio_clone()returns NULL without freeing the newly allocated bio.Signed-off-by Li Zefan <[email protected]>--- fs/bio.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)fs/bio.c +3
-1@@ -465,8 +465,10 @@ struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask) ret =bio_integrity_clone (b, bio, fs_bio_set); -if (ret <0 ) +if (ret <0 ) { +bio_put (bio);return NULL ; + } }
Quoted 6 lines
fs/bio.c struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
Quoted 2 lines
fs/bio.c +0
-1return b; -- 1.5.4.rc3Good spotting. But it looks like there are actually several problems there.
bio_integrity_clone()is mempool backed. Currently that ret < 0 can never trigger, sincebio_integrity_clone()has hard-wired__GFP_WAIT
Do you mean GFP_NOIO?
Quoted 2 lines
as the mempool mask. So the leak will not occur, but it does mean that it isn't honoring the
gfp_maskpassed in tobio_clone(), which is the
I noticed there was a patch to do this, and seems you planed to merge it into .29?
"[PATCH] Add gfp_mask to bio_integrity_clone()"
http://lkml.org/lkml/2008/10/30/11
Quoted 4 lines
first bug. The second bug is that it should be using its own bioset, as it is illegal to do multiple
__GFP_WAITallocations on a single mempool and always expect progress.
Quoted 25 lines · Li Zefan
Quoted 24 lines · Jens Axboe
Quoted 23 lines · Li Zefan
If
bio_integrity_clone()fails,bio_clone()returns NULL without freeing the newly allocated bio.Signed-off-by Li Zefan <[email protected]>--- fs/bio.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)fs/bio.c +3
-1@@ -465,8 +465,10 @@ struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask) ret =bio_integrity_clone (b, bio, fs_bio_set); -if (ret <0 ) +if (ret <0 ) { +bio_put (bio);return NULL ; + } }
Quoted 8 lines
Quoted 6 lines
fs/bio.c struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
Quoted 2 lines
fs/bio.c +0
-1return b; -- 1.5.4.rc3Good spotting. But it looks like there are actually several problems there.
bio_integrity_clone()is mempool backed. Currently that ret < 0 can never trigger, sincebio_integrity_clone()has hard-wired__GFP_WAITDo you mean
GFP_NOIO?
The __GFP_WAIT part of GFP_NOIO is the important bit :-)
Quoted 9 lines
Quoted 2 lines
as the mempool mask. So the leak will not occur, but it does mean that it isn't honoring the
gfp_maskpassed in tobio_clone(), which is theI noticed there was a patch to do this, and seems you planed to merge it into .29?
"[PATCH] Add
gfp_masktobio_integrity_clone()"
Hmm strange, apparently that never got queued up and I had forgotten all about that issue until your email. I'll add it asap.
Quoted 3 lines
Quoted 3 lines
first bug. The second bug is that it should be using its own bioset, as it is illegal to do multiple
__GFP_WAITallocations on a single mempool and always expect progress.
That one still stands.
Signature · 1 line
Jens Axboe
Quoted 5 lines
Quoted 5 lines
Quoted 2 lines
as the mempool mask. So the leak will not occur, but it does mean that it isn't honoring the
gfp_maskpassed in tobio_clone(), which is theI noticed there was a patch to do this, and seems you planed to merge it into .29?
Quoted 7 lines
Quoted 3 lines
"[PATCH] Add
gfp_masktobio_integrity_clone()"Hmm strange, apparently that never got queued up and I had forgotten all about that issue until your email. I'll add it asap.
I found bio_integrity_clone() is not using the gfp_mask passed by bio_clone(), so I googled it in LKML before I fix it. :)
Quoted 6 lines
Quoted 3 lines
Quoted 3 lines
first bug. The second bug is that it should be using its own bioset, as it is illegal to do multiple
__GFP_WAITallocations on a single mempool and always expect progress.That one still stands.
Yes, and I'd leave it to you or Martin. ;)
Quoted 7 lines · Li Zefan
Quoted 7 lines
Quoted 7 lines
Quoted 2 lines
as the mempool mask. So the leak will not occur, but it does mean that it isn't honoring the
gfp_maskpassed in tobio_clone(), which is theI noticed there was a patch to do this, and seems you planed to merge it into .29?
"[PATCH] Add
gfp_masktobio_integrity_clone()"
Quoted 8 lines
Quoted 5 lines
Quoted 1 line
Hmm strange, apparently that never got queued up and I had forgotten all about that issue until your email. I'll add it asap.
I found
bio_integrity_clone()is not using thegfp_maskpassed bybio_clone(), so I googled it in LKML before I fix it. :)
I've got both patches queued up now:
http://git.kernel.dk/?p=linux-2.6-block.git;a=shortlog;h=refs/heads/for-linus
Quoted 8 lines
Quoted 6 lines
Quoted 3 lines
Quoted 3 lines
first bug. The second bug is that it should be using its own bioset, as it is illegal to do multiple
__GFP_WAITallocations on a single mempool and always expect progress.That one still stands.
Yes, and I'd leave it to you or Martin. ;)
I'll let Martin sort that out, it can easily wait for the next release.
Signature · 1 line
Jens Axboe
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
"Jens" == Jens Axboe <[email protected]> writes:
Jens> So the leak will not occur, but it does mean that it isn't Jens> honoring the gfp_mask passed in to bio_clone(), which is the first Jens> bug.
bio_integrity_clone() had no mask because all callers of it used GFP_NOIO explicitly.
But as you now recall there is a patch queued that adds the mask :)
Jens> The second bug is that it should be using its own bioset, as it is Jens> illegal to do multiple __GFP_WAIT allocations on a single mempool Jens> and always expect progress.
So how do you propose I go about this?
The original intent was to contain all the integrity blah inside the bio_set to make it completely transparent to the caller. That's why the bip mempool is hanging off of the bio_set. But obviously two bvecs are needed per bio, one to describe data and to describe the integrity buffer.
Having two bvec mempools per bio_set seems icky. I guess what you are suggesting is that we could have a dedicated bio_integrity_set akin to the bio_split_pool. That removes the caller's option of passing a dedicated bio_set to the clone command, though. Will that have forward progress implications for stacking drivers?
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
Quoted 12 lines · Martin K. Petersen
Jens> The second bug is that it should be using its own bioset, as it is Jens> illegal to do multiple
__GFP_WAITallocations on a single mempool Jens> and always expect progress.So how do you propose I go about this?
The original intent was to contain all the integrity blah inside the
bio_setto make it completely transparent to the caller. That's why the bip mempool is hanging off of thebio_set. But obviously two bvecs are needed per bio, one to describe data and to describe the integrity buffer.
Quoted 5 lines
Having two bvec mempools per
bio_setseems icky. I guess what you are suggesting is that we could have a dedicatedbio_integrity_setakin to thebio_split_pool. That removes the caller's option of passing a dedicatedbio_setto the clone command, though. Will that have forward progress implications for stacking drivers?
I was just wondering why you wanted to pass the bio_set in to bio_integrity_clone(), why would the caller care?
Even two mempools isn't that bad. You can reuse the slab of course, and the mempool should only have a single entry preallocated. But I agree, it should not be in the bio_set. A dedicated bio_set for the integrity stuff would be the way to go, and that should provide you all the forward progress guarantees you need.
Signature · 1 line
Jens Axboe
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
"Jens" == Jens Axboe <[email protected]> writes:
Jens> A dedicated bio_set for the integrity stuff would be the way to Jens> go, and that should provide you all the forward progress Jens> guarantees you need.
Ok. Against your for-linus branch...
--- fs/bio-integrity.c | 85 +++++++++++++++------------------------------------- fs/bio.c | 9 +---- include/linux/bio.h | 18 ++--------- 3 files changed, 32 insertions(+), 80 deletions(-)
fs/bio-integrity.c +26 -59
@@ -26,23 +26,23 @@#include <linux/workqueue.h> static struct kmem_cache *bio_integrity_slab__read_mostly ; +static mempool_t *bio_integrity_pool; +static struct bio_set *integrity_bio_set;static struct workqueue_struct *kintegrityd_wq;/** -* bio_integrity_alloc_bioset - Allocate integrity payload and attach it to bio +* bio_integrity_alloc - Allocate integrity payload and attach it to bio * @bio: bio to attach integrity metadata to * @gfp_mask: Memory allocation mask * @nr_vecs: Number of integrity metadata scatter-gather elements -* @bs: bio_set to allocate from * * Description: This function prepares a bio for attaching integrity * metadata. nr_vecs specifies the maximum number of pages containing * integrity metadata that can be attached. */ -struct bio_integrity_payload *bio_integrity_alloc_bioset (struct bio *bio, -gfp_t gfp_mask, -unsigned int nr_vecs, -struct bio_set *bs) +struct bio_integrity_payload *bio_integrity_alloc (struct bio *bio, +gfp_t gfp_mask, +unsigned int nr_vecs) {struct bio_integrity_payload *bip;struct bio_vec *iv;
@@ -50,7 +50,7 @@ struct bio_integrity_payload *bio_integrity_alloc_bioset(struct bio *bio,BUG_ON (bio ==NULL ); - bip =mempool_alloc (bs->bio_integrity_pool, gfp_mask); + bip =mempool_alloc (bio_integrity_pool, gfp_mask);if (unlikely (bip ==NULL )) {printk (KERN_ERR "%s: could not alloc bip\n" , __func__);return NULL ;
@@ -58,10 +58,10 @@ struct bio_integrity_payload *bio_integrity_alloc_bioset(struct bio *bio,memset (bip,0 ,sizeof (*bip)); - iv =bvec_alloc_bs (gfp_mask, nr_vecs, &idx, bs); + iv =bvec_alloc_bs (gfp_mask, nr_vecs, &idx, integrity_bio_set);if (unlikely (iv ==NULL )) {printk (KERN_ERR "%s: could not alloc bip_vec\n" , __func__); -mempool_free (bip, bs->bio_integrity_pool); +mempool_free (bip, bio_integrity_pool);return NULL ; }
@@ -72,35 +72,16 @@ struct bio_integrity_payload *bio_integrity_alloc_bioset(struct bio *bio,return bip; } -EXPORT_SYMBOL (bio_integrity_alloc_bioset); - -/** -* bio_integrity_alloc - Allocate integrity payload and attach it to bio -* @bio: bio to attach integrity metadata to -* @gfp_mask: Memory allocation mask -* @nr_vecs: Number of integrity metadata scatter-gather elements -* -* Description: This function prepares a bio for attaching integrity -* metadata. nr_vecs specifies the maximum number of pages containing -* integrity metadata that can be attached. -*/ -struct bio_integrity_payload *bio_integrity_alloc (struct bio *bio, -gfp_t gfp_mask, -unsigned int nr_vecs) -{ -return bio_integrity_alloc_bioset (bio, gfp_mask, nr_vecs, fs_bio_set); -}EXPORT_SYMBOL (bio_integrity_alloc);/** * bio_integrity_free - Free bio integrity payload * @bio: bio containing bip to be freed -* @bs: bio_set this bio was allocated from * * Description: Used to free the integrity portion of a bio. Usually * called from bio_free(). */ -void bio_integrity_free (struct bio *bio,struct bio_set *bs) +void bio_integrity_free (struct bio *bio) {struct bio_integrity_payload *bip = bio->bi_integrity;
@@ -111,8 +92,8 @@ void bio_integrity_free(struct bio *bio, struct bio_set *bs) && bip->bip_buf != NULL)kfree (bip->bip_buf); -bvec_free_bs (bs, bip->bip_vec, bip->bip_pool); -mempool_free (bip, bs->bio_integrity_pool); +bvec_free_bs (integrity_bio_set, bip->bip_vec, bip->bip_pool); +mempool_free (bip, bio_integrity_pool); bio->bi_integrity =NULL ; }
@@ -686,19 +667,17 @@ EXPORT_SYMBOL(bio_integrity_split);* @bio: New bio * @bio_src: Original bio * @gfp_mask: Memory allocation mask -* @bs: bio_set to allocate bip from * * Description: Called to allocate a bip when cloning a bio */ -int bio_integrity_clone (struct bio *bio,struct bio *bio_src, -gfp_t gfp_mask,struct bio_set *bs) +int bio_integrity_clone (struct bio *bio,struct bio *bio_src,gfp_t gfp_mask) {struct bio_integrity_payload *bip_src = bio_src->bi_integrity;struct bio_integrity_payload *bip;BUG_ON (bip_src ==NULL ); - bip =bio_integrity_alloc_bioset (bio, gfp_mask, bip_src->bip_vcnt, bs); + bip =bio_integrity_alloc (bio, gfp_mask, bip_src->bip_vcnt);if (bip ==NULL )return -EIO ;
@@ -714,37 +693,25 @@ int bio_integrity_clone(struct bio *bio, struct bio *bio_src, }EXPORT_SYMBOL (bio_integrity_clone); -int bioset_integrity_create (struct bio_set *bs,int pool_size) +static int __init bio_integrity_init (void ) { - bs->bio_integrity_pool =mempool_create_slab_pool (pool_size, - bio_integrity_slab); -if (!bs->bio_integrity_pool) -return -1 ; - -return 0 ; -} -EXPORT_SYMBOL (bioset_integrity_create); + kintegrityd_wq =create_workqueue ("kintegrityd" ); -void bioset_integrity_free (struct bio_set *bs) -{ -if (bs->bio_integrity_pool) -mempool_destroy (bs->bio_integrity_pool); -} -EXPORT_SYMBOL (bioset_integrity_free); +if (!kintegrityd_wq) +panic ("Failed to create kintegrityd\n" ); -void __init bio_integrity_init_slab (void ) -{ bio_integrity_slab =KMEM_CACHE (bio_integrity_payload,SLAB_HWCACHE_ALIGN |SLAB_PANIC ); -} -static int __init integrity_init (void ) -{ - kintegrityd_wq =create_workqueue ("kintegrityd" ); + bio_integrity_pool =mempool_create_slab_pool (BIO_POOL_SIZE , + bio_integrity_slab); +if (!bio_integrity_pool) +panic ("bio_integrity: can't allocate bip pool\n" ); -if (!kintegrityd_wq) -panic ("Failed to create kintegrityd\n" ); + integrity_bio_set =bioset_create (BIO_POOL_SIZE ,0 ); +if (!integrity_bio_set) +panic ("bio_integrity: can't allocate bio_set\n" );return 0 ; } -subsys_initcall (integrity_init); +subsys_initcall (bio_integrity_init);
fs/bio.c +2 -7
@@ -248,7 +248,7 @@ void bio_free(struct bio *bio, struct bio_set *bs)bvec_free_bs (bs, bio->bi_io_vec,BIO_POOL_IDX (bio));if (bio_integrity (bio)) -bio_integrity_free (bio, bs); +bio_integrity_free (bio);/* * If we have front padding, adjust the bio pointer before freeing
@@ -463,7 +463,7 @@ struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)if (bio_integrity (bio)) {int ret; - ret =bio_integrity_clone (b, bio, gfp_mask, fs_bio_set); + ret =bio_integrity_clone (b, bio, gfp_mask);if (ret <0 ) {bio_put (b);
@@ -1526,7 +1526,6 @@ void bioset_free(struct bio_set *bs)if (bs->bio_pool)mempool_destroy (bs->bio_pool); -bioset_integrity_free (bs);biovec_free_pools (bs);bio_put_slab (bs);
@@ -1567,9 +1566,6 @@ struct bio_set *bioset_create(unsigned int pool_size, unsigned int front_pad)if (!bs->bio_pool) goto bad; -if (bioset_integrity_create (bs, pool_size)) - goto bad; -if (!biovec_create_pools (bs, pool_size))return bs;
@@ -1600,7 +1596,6 @@ static int __init init_bio(void)if (!bio_slabs)panic ("bio: can't allocate bios\n" ); -bio_integrity_init_slab ();biovec_init_slabs (); fs_bio_set =bioset_create (BIO_POOL_SIZE ,0 );
include/linux/bio.h +4 -14
@@ -426,9 +426,6 @@ struct bio_set {unsigned int front_pad;mempool_t *bio_pool; -#if defined(CONFIG_BLK_DEV_INTEGRITY ) -mempool_t *bio_integrity_pool; -#endif mempool_t *bvec_pool; };
@@ -519,9 +516,8 @@ static inline int bio_has_data(struct bio *bio)#define bio_integrity (bio) (bio->bi_integrity != NULL) -extern struct bio_integrity_payload *bio_integrity_alloc_bioset (struct bio *,gfp_t ,unsigned int ,struct bio_set *);extern struct bio_integrity_payload *bio_integrity_alloc (struct bio *,gfp_t ,unsigned int ); -extern void bio_integrity_free (struct bio *,struct bio_set *); +extern void bio_integrity_free (struct bio *);extern int bio_integrity_add_page (struct bio *,struct page *,unsigned int ,unsigned int );extern int bio_integrity_enabled (struct bio *bio);extern int bio_integrity_set_tag (struct bio *,void *,unsigned int );
@@ -531,27 +527,21 @@ extern void bio_integrity_endio(struct bio *, int);extern void bio_integrity_advance (struct bio *,unsigned int );extern void bio_integrity_trim (struct bio *,unsigned int ,unsigned int );extern void bio_integrity_split (struct bio *,struct bio_pair *,int ); -extern int bio_integrity_clone (struct bio *,struct bio *,gfp_t ,struct bio_set *); -extern int bioset_integrity_create (struct bio_set *,int ); -extern void bioset_integrity_free (struct bio_set *); -extern void bio_integrity_init_slab (void ); +extern int bio_integrity_clone (struct bio *,struct bio *,gfp_t );#else /* CONFIG_BLK_DEV_INTEGRITY */ #define bio_integrity (a) (0) -#define bioset_integrity_create (a, b) (0)#define bio_integrity_prep (a) (0)#define bio_integrity_enabled (a) (0) -#define bio_integrity_clone (a, b, c,d ) (0) -#define bioset_integrity_free (a) do { } while (0) -#define bio_integrity_free (a, b) do { } while (0) +#define bio_integrity_clone (a, b, c) (0) +#define bio_integrity_free (a) do { } while (0)#define bio_integrity_endio (a, b) do { } while (0)#define bio_integrity_advance (a, b) do { } while (0)#define bio_integrity_trim (a, b, c) do { } while (0)#define bio_integrity_split (a, b, c) do { } while (0)#define bio_integrity_set_tag (a, b, c) do { } while (0)#define bio_integrity_get_tag (a, b, c) do { } while (0) -#define bio_integrity_init_slab (a) do { } while (0)#endif /* CONFIG_BLK_DEV_INTEGRITY */
Quoted 9 lines · Martin K. Petersen
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
"Jens" == Jens Axboe <[email protected]> writes:
Jens> A dedicated
bio_setfor the integrity stuff would be the way to Jens> go, and that should provide you all the forward progress Jens> guarantees you need.Ok. Against your for-linus branch...
Signed-off-by Martin K. Petersen <[email protected]>
Great, that's also a lot less invasive and ifdef'y. Applied for 2.6.30.
Signature · 1 line
Jens Axboe