Commit 324ecaee authored by Matthew Wilcox (Oracle)'s avatar Matthew Wilcox (Oracle) Committed by Andrew Morton
Browse files

buffer: fix __bread and __bread_gfp kernel-doc 

The extra indentation confused the kernel-doc parser, so remove it.  Fix
some other wording while I'm here, and advise the user they need to call
brelse() on this buffer.

__bread_gfp() isn't used directly by filesystems, but the other wrappers
for it don't have documentation, so document it accordingly.

Link: https://lkml.kernel.org/r/20240416031754.4076917-5-willy@infradead.org


Co-developed-by: default avatarPankaj Raghav <p.raghav@samsung.com>
Signed-off-by: default avatarPankaj Raghav <p.raghav@samsung.com>
Signed-off-by: default avatarMatthew Wilcox (Oracle) <willy@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent b1888d14

fs/buffer.c

+22 −13
Original line number Diff line number Diff line
@@ -1453,19 +1453,28 @@ void __breadahead(struct block_device *bdev, sector_t block, unsigned size) 
EXPORT_SYMBOL(__breadahead);



/**

 *  __bread_gfp() - reads a specified block and returns the bh

 *  @bdev: the block_device to read from

 *  @block: number of block

 *  @size: size (in bytes) to read

 *  @gfp: page allocation flag

 * __bread_gfp() - Read a block.

 * @bdev: The block device to read from.

 * @block: Block number in units of block size.

 * @size: The block size of this device in bytes.

 * @gfp: Not page allocation flags; see below.

 *

 *  Reads a specified block, and returns buffer head that contains it.

 *  The page cache can be allocated from non-movable area

 *  not to prevent page migration if you set gfp to zero.

 *  It returns NULL if the block was unreadable.

 * You are not expected to call this function.  You should use one of

 * sb_bread(), sb_bread_unmovable() or __bread().

 *

 * Read a specified block, and return the buffer head that refers to it.

 * If @gfp is 0, the memory will be allocated using the block device's

 * default GFP flags.  If @gfp is __GFP_MOVABLE, the memory may be

 * allocated from a movable area.  Do not pass in a complete set of

 * GFP flags.

 *

 * The returned buffer head has its refcount increased.  The caller should

 * call brelse() when it has finished with the buffer.

 *

 * Context: May sleep waiting for I/O.

 * Return: NULL if the block was unreadable.

 */

struct buffer_head *

__bread_gfp(struct block_device *bdev, sector_t block,

struct buffer_head *__bread_gfp(struct block_device *bdev, sector_t block,

		unsigned size, gfp_t gfp)

{

	struct buffer_head *bh;

include/linux/buffer_head.h

+13 −9
Original line number Diff line number Diff line
@@ -437,17 +437,21 @@ static inline void bh_readahead_batch(int nr, struct buffer_head *bhs[], 
}



/**

 *  __bread() - reads a specified block and returns the bh

 *  @bdev: the block_device to read from

 *  @block: number of block

 *  @size: size (in bytes) to read

 * __bread() - Read a block.

 * @bdev: The block device to read from.

 * @block: Block number in units of block size.

 * @size: The block size of this device in bytes.

 *

 *  Reads a specified block, and returns buffer head that contains it.

 *  The page cache is allocated from movable area so that it can be migrated.

 *  It returns NULL if the block was unreadable.

 * Read a specified block, and return the buffer head that refers

 * to it.  The memory is allocated from the movable area so that it can

 * be migrated.  The returned buffer head has its refcount increased.

 * The caller should call brelse() when it has finished with the buffer.

 *

 * Context: May sleep waiting for I/O.

 * Return: NULL if the block was unreadable.

 */

static inline struct buffer_head *

__bread(struct block_device *bdev, sector_t block, unsigned size)

static inline struct buffer_head *__bread(struct block_device *bdev,

		sector_t block, unsigned size)

{

	return __bread_gfp(bdev, block, size, __GFP_MOVABLE);

}