Commit 3d5b3fbe authored by Jens Axboe's avatar Jens Axboe
Browse files

bio: improve kerneldoc documentation for bio_alloc_kiocb() 



We're missing a description for the 'nr_vecs' parameter. While in there,
clarify that freeing a bio allocated through this function must be done
from process context.

Fixes: 1cbbd31c4ada ("bio: add allocation cache abstraction")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarJens Axboe <axboe@kernel.dk>
parent 270a1c91

block/bio.c

+4 −1
Original line number Diff line number Diff line
@@ -1692,12 +1692,15 @@ EXPORT_SYMBOL(bioset_init_from_src); 
/**

 * bio_alloc_kiocb - Allocate a bio from bio_set based on kiocb

 * @kiocb:	kiocb describing the IO

 * @nr_iovecs:	number of iovecs to pre-allocate

 * @bs:		bio_set to allocate from

 *

 * Description:

 *    Like @bio_alloc_bioset, but pass in the kiocb. The kiocb is only

 *    used to check if we should dip into the per-cpu bio_set allocation

 *    cache. The allocation uses GFP_KERNEL internally.

 *    cache. The allocation uses GFP_KERNEL internally. On return, the

 *    bio is marked BIO_PERCPU_CACHEABLE, and the final put of the bio

 *    MUST be done from process context, not hard/soft IRQ.

 *

 */

struct bio *bio_alloc_kiocb(struct kiocb *kiocb, unsigned short nr_vecs,