Fix bio_alloc() and bio_kmalloc() documentation
PATCH 1/1 Fix bio_alloc() and bio_kmalloc() documentation
Commit 451a9ebf accidentally broke bio_alloc() and bio_kmalloc() comments by (almost) swapping them.
This patch fixes that, by placing the comments in the right place.
Signed-off-by Alberto Bertogli <[email protected]>
---
I'm not completely sure the mempool part is in the right place. If it's not, let me know and I'll fix the patch.
Thanks a lot,
Alberto
fs/bio.c | 26 +++++++++++++------------- 1 files changed, 13 insertions(+), 13 deletions(-)
fs/bio.c +13 -13
@@ -325,8 +325,16 @@ static void bio_fs_destructor(struct bio *bio)* @gfp_mask: allocation mask to use * @nr_iovecs: number of iovecs * -* Allocate a new bio with @nr_iovecs bvecs. If @gfp_mask -* contains __GFP_WAIT, the allocation is guaranteed to succeed. +* bio_alloc will allocate a bio and associated bio_vec array that can hold +* at least @nr_iovecs entries. Allocations will be done from the +* fs_bio_set. Also see @bio_alloc_bioset and @bio_kmalloc. +* +* If %__GFP_WAIT is set, then bio_alloc will always be able to allocate +* a bio. This is due to the mempool guarantees. To make this work, callers +* must never allocate more than 1 bio at a time from this pool. Callers +* that need to allocate more than 1 bio must always submit the previously +* allocated bio for IO before attempting to allocate a new one. Failure to +* do so can cause livelocks under memory pressure. * * RETURNS: * Pointer to new bio on success, NULL on failure.
@@ -350,21 +358,13 @@ static void bio_kmalloc_destructor(struct bio *bio) }/** -* bio_alloc - allocate a bio for I/O +* bio_kmalloc - allocate a bio for I/O using kmalloc() * @gfp_mask: the GFP_ mask given to the slab allocator * @nr_iovecs: number of iovecs to pre-allocate * * Description: -* bio_alloc will allocate a bio and associated bio_vec array that can hold -* at least @nr_iovecs entries. Allocations will be done from the -* fs_bio_set. Also see @bio_alloc_bioset. -* -* If %__GFP_WAIT is set, then bio_alloc will always be able to allocate -* a bio. This is due to the mempool guarantees. To make this work, callers -* must never allocate more than 1 bio at a time from this pool. Callers -* that need to allocate more than 1 bio must always submit the previously -* allocated bio for IO before attempting to allocate a new one. Failure to -* do so can cause livelocks under memory pressure. +* Allocate a new bio with @nr_iovecs bvecs. If @gfp_mask contains +* %__GFP_WAIT, the allocation is guaranteed to succeed. * **/ struct bio *bio_kmalloc (gfp_t gfp_mask,int nr_iovecs)
Signature · 1 line
1.6.3.3
Quoted 6 lines · Alberto Bertogli
Commit
451a9ebfaccidentally brokebio_alloc()andbio_kmalloc()comments by (almost) swapping them.This patch fixes that, by placing the comments in the right place.
Signed-off-by Alberto Bertogli <[email protected]>
Oops,
Acked-by Tejun Heo <[email protected]>
Thank you.
Signature · 1 line
tejun
Jens Axboe
AppliedQuoted 4 lines · Alberto Bertogli
Commit
451a9ebfaccidentally brokebio_alloc()andbio_kmalloc()comments by (almost) swapping them.This patch fixes that, by placing the comments in the right place.
Thanks, applied to for-linus.
Signature · 1 line
Jens Axboe