github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-10-23 15:32:04 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

buffer: Document sb_bread(), sb_bread_unmovable() and sb_breadahead()

Browse Source 
Add kernel-doc for these three functions.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Link: https://patch.msgid.link/20260828205429.3678204-4-willy@infradead.org
Reviewed-by: Jan Kara <jack@suse.cz>
Signed-off-by: Christian Brauner (Amutable) <brauner@kernel.org>
This commit is contained in:
Matthew Wilcox (Oracle) 2026-08-28 21:54:23 +01:00 committed by Christian Brauner
parent 3732e5a987
commit f0a2efd6b1
No known key found for this signature in database
GPG Key ID: 91C61BC06578DCA2
1 changed files with 44 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
include/linux/buffer_head.h
View File

@ -364,20 +364,58 @@ static inline void bforget(struct buffer_head *bh)
__bforget(bh);
}
static inline struct buffer_head *
sb_bread(struct super_block *sb, sector_t block)
/**
* sb_bread - Read a block.
* @sb: The superblock to read from.
* @block: Block number in units of block size.
*
* 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 *sb_bread(struct super_block *sb, sector_t block)
{
return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
}
static inline struct buffer_head *
sb_bread_unmovable(struct super_block *sb, sector_t block)
/**
* sb_bread_unmovable - Read a block.
* @sb: The superblock to read from.
* @block: Block number in units of block size.
*
* Read a specified block, and return the buffer head that refers to it.
* The memory is allocated from the unmovable area so that pointers into
* it remain valid after compaction runs. 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 *sb_bread_unmovable(struct super_block *sb, sector_t block)
{
return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, 0);
}
static inline void
sb_breadahead(struct super_block *sb, sector_t block)
/**
* sb_breadahead - Start readahead.
* @sb: Superblock identifying the block device.
* @block: The block to read.
*
* Read this block. The I/O will be flagged as being readahead rather
* than immediate read, but (unlike the page cache), surrounding blocks
* will not be read.
*
* Context: May sleep in order to allocate memory.
*/
static inline
void sb_breadahead(struct super_block *sb, sector_t block)
{
__breadahead(sb->s_bdev, block, sb->s_blocksize);
}