1 /* SPDX-License-Identifier: GPL-2.0 */
3 * include/linux/buffer_head.h
5 * Everything to do with buffer_heads.
8 #ifndef _LINUX_BUFFER_HEAD_H
9 #define _LINUX_BUFFER_HEAD_H
11 #include <linux/types.h>
12 #include <linux/blk_types.h>
14 #include <linux/linkage.h>
15 #include <linux/pagemap.h>
16 #include <linux/wait.h>
17 #include <linux/atomic.h>
22 BH_Uptodate, /* Contains valid data */
23 BH_Dirty, /* Is dirty */
24 BH_Lock, /* Is locked */
25 BH_Req, /* Has been submitted for I/O */
27 BH_Mapped, /* Has a disk mapping */
28 BH_New, /* Disk mapping was newly created by get_block */
29 BH_Async_Read, /* Is under end_buffer_async_read I/O */
30 BH_Async_Write, /* Is under end_buffer_async_write I/O */
31 BH_Delay, /* Buffer is not yet allocated on disk */
32 BH_Boundary, /* Block is followed by a discontiguity */
33 BH_Write_EIO, /* I/O error on write */
34 BH_Unwritten, /* Buffer is allocated on disk but not written */
35 BH_Quiet, /* Buffer Error Prinks to be quiet */
36 BH_Meta, /* Buffer contains metadata */
37 BH_Prio, /* Buffer should be submitted with REQ_PRIO */
38 BH_Defer_Completion, /* Defer AIO completion to workqueue */
40 BH_PrivateStart,/* not a state bit, but the first bit available
41 * for private allocation by other entities
45 #define MAX_BUF_PER_PAGE (PAGE_SIZE / 512)
50 typedef void (bh_end_io_t)(struct buffer_head *bh, int uptodate);
53 * Historically, a buffer_head was used to map a single block
54 * within a page, and of course as the unit of I/O through the
55 * filesystem and block layers. Nowadays the basic I/O unit
56 * is the bio, and buffer_heads are used for extracting block
57 * mappings (via a get_block_t call), for tracking state within
58 * a page (via a page_mapping) and for wrapping bio submission
59 * for backward compatibility reasons (e.g. submit_bh).
62 unsigned long b_state; /* buffer state bitmap (see above) */
63 struct buffer_head *b_this_page;/* circular list of page's buffers */
65 struct page *b_page; /* the page this bh is mapped to */
66 struct folio *b_folio; /* the folio this bh is mapped to */
69 sector_t b_blocknr; /* start block number */
70 size_t b_size; /* size of mapping */
71 char *b_data; /* pointer to data within the page */
73 struct block_device *b_bdev;
74 bh_end_io_t *b_end_io; /* I/O completion */
75 void *b_private; /* reserved for b_end_io */
76 struct list_head b_assoc_buffers; /* associated with another mapping */
77 struct address_space *b_assoc_map; /* mapping this buffer is
79 atomic_t b_count; /* users using this buffer_head */
80 spinlock_t b_uptodate_lock; /* Used by the first bh in a page, to
81 * serialise IO completion of other
82 * buffers in the page */
86 * macro tricks to expand the set_buffer_foo(), clear_buffer_foo()
87 * and buffer_foo() functions.
88 * To avoid reset buffer flags that are already set, because that causes
89 * a costly cache line transition, check the flag first.
91 #define BUFFER_FNS(bit, name) \
92 static __always_inline void set_buffer_##name(struct buffer_head *bh) \
94 if (!test_bit(BH_##bit, &(bh)->b_state)) \
95 set_bit(BH_##bit, &(bh)->b_state); \
97 static __always_inline void clear_buffer_##name(struct buffer_head *bh) \
99 clear_bit(BH_##bit, &(bh)->b_state); \
101 static __always_inline int buffer_##name(const struct buffer_head *bh) \
103 return test_bit(BH_##bit, &(bh)->b_state); \
107 * test_set_buffer_foo() and test_clear_buffer_foo()
109 #define TAS_BUFFER_FNS(bit, name) \
110 static __always_inline int test_set_buffer_##name(struct buffer_head *bh) \
112 return test_and_set_bit(BH_##bit, &(bh)->b_state); \
114 static __always_inline int test_clear_buffer_##name(struct buffer_head *bh) \
116 return test_and_clear_bit(BH_##bit, &(bh)->b_state); \
120 * Emit the buffer bitops functions. Note that there are also functions
121 * of the form "mark_buffer_foo()". These are higher-level functions which
122 * do something in addition to setting a b_state bit.
124 BUFFER_FNS(Dirty, dirty)
125 TAS_BUFFER_FNS(Dirty, dirty)
126 BUFFER_FNS(Lock, locked)
128 TAS_BUFFER_FNS(Req, req)
129 BUFFER_FNS(Mapped, mapped)
131 BUFFER_FNS(Async_Read, async_read)
132 BUFFER_FNS(Async_Write, async_write)
133 BUFFER_FNS(Delay, delay)
134 BUFFER_FNS(Boundary, boundary)
135 BUFFER_FNS(Write_EIO, write_io_error)
136 BUFFER_FNS(Unwritten, unwritten)
137 BUFFER_FNS(Meta, meta)
138 BUFFER_FNS(Prio, prio)
139 BUFFER_FNS(Defer_Completion, defer_completion)
141 static __always_inline void set_buffer_uptodate(struct buffer_head *bh)
144 * If somebody else already set this uptodate, they will
145 * have done the memory barrier, and a reader will thus
146 * see *some* valid buffer state.
148 * Any other serialization (with IO errors or whatever that
149 * might clear the bit) has to come from other state (eg BH_Lock).
151 if (test_bit(BH_Uptodate, &bh->b_state))
155 * make it consistent with folio_mark_uptodate
156 * pairs with smp_load_acquire in buffer_uptodate
158 smp_mb__before_atomic();
159 set_bit(BH_Uptodate, &bh->b_state);
162 static __always_inline void clear_buffer_uptodate(struct buffer_head *bh)
164 clear_bit(BH_Uptodate, &bh->b_state);
167 static __always_inline int buffer_uptodate(const struct buffer_head *bh)
170 * make it consistent with folio_test_uptodate
171 * pairs with smp_mb__before_atomic in set_buffer_uptodate
173 return test_bit_acquire(BH_Uptodate, &bh->b_state);
176 static inline unsigned long bh_offset(const struct buffer_head *bh)
178 return (unsigned long)(bh)->b_data & (page_size(bh->b_page) - 1);
181 /* If we *know* page->private refers to buffer_heads */
182 #define page_buffers(page) \
184 BUG_ON(!PagePrivate(page)); \
185 ((struct buffer_head *)page_private(page)); \
187 #define page_has_buffers(page) PagePrivate(page)
188 #define folio_buffers(folio) folio_get_private(folio)
190 void buffer_check_dirty_writeback(struct folio *folio,
191 bool *dirty, bool *writeback);
197 void mark_buffer_dirty(struct buffer_head *bh);
198 void mark_buffer_write_io_error(struct buffer_head *bh);
199 void touch_buffer(struct buffer_head *bh);
200 void set_bh_page(struct buffer_head *bh,
201 struct page *page, unsigned long offset);
202 void folio_set_bh(struct buffer_head *bh, struct folio *folio,
203 unsigned long offset);
204 bool try_to_free_buffers(struct folio *);
205 struct buffer_head *folio_alloc_buffers(struct folio *folio, unsigned long size,
207 struct buffer_head *alloc_page_buffers(struct page *page, unsigned long size,
209 void create_empty_buffers(struct page *, unsigned long,
210 unsigned long b_state);
211 void folio_create_empty_buffers(struct folio *folio, unsigned long blocksize,
212 unsigned long b_state);
213 void end_buffer_read_sync(struct buffer_head *bh, int uptodate);
214 void end_buffer_write_sync(struct buffer_head *bh, int uptodate);
215 void end_buffer_async_write(struct buffer_head *bh, int uptodate);
217 /* Things to do with buffers at mapping->private_list */
218 void mark_buffer_dirty_inode(struct buffer_head *bh, struct inode *inode);
219 int inode_has_buffers(struct inode *);
220 void invalidate_inode_buffers(struct inode *);
221 int remove_inode_buffers(struct inode *inode);
222 int sync_mapping_buffers(struct address_space *mapping);
223 int generic_buffers_fsync_noflush(struct file *file, loff_t start, loff_t end,
225 int generic_buffers_fsync(struct file *file, loff_t start, loff_t end,
227 void clean_bdev_aliases(struct block_device *bdev, sector_t block,
229 static inline void clean_bdev_bh_alias(struct buffer_head *bh)
231 clean_bdev_aliases(bh->b_bdev, bh->b_blocknr, 1);
234 void mark_buffer_async_write(struct buffer_head *bh);
235 void __wait_on_buffer(struct buffer_head *);
236 wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
237 struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
239 struct buffer_head *__getblk_gfp(struct block_device *bdev, sector_t block,
240 unsigned size, gfp_t gfp);
241 void __brelse(struct buffer_head *);
242 void __bforget(struct buffer_head *);
243 void __breadahead(struct block_device *, sector_t block, unsigned int size);
244 struct buffer_head *__bread_gfp(struct block_device *,
245 sector_t block, unsigned size, gfp_t gfp);
246 void invalidate_bh_lrus(void);
247 void invalidate_bh_lrus_cpu(void);
248 bool has_bh_in_lru(int cpu, void *dummy);
249 struct buffer_head *alloc_buffer_head(gfp_t gfp_flags);
250 void free_buffer_head(struct buffer_head * bh);
251 void unlock_buffer(struct buffer_head *bh);
252 void __lock_buffer(struct buffer_head *bh);
253 int sync_dirty_buffer(struct buffer_head *bh);
254 int __sync_dirty_buffer(struct buffer_head *bh, blk_opf_t op_flags);
255 void write_dirty_buffer(struct buffer_head *bh, blk_opf_t op_flags);
256 void submit_bh(blk_opf_t, struct buffer_head *);
257 void write_boundary_block(struct block_device *bdev,
258 sector_t bblock, unsigned blocksize);
259 int bh_uptodate_or_lock(struct buffer_head *bh);
260 int __bh_read(struct buffer_head *bh, blk_opf_t op_flags, bool wait);
261 void __bh_read_batch(int nr, struct buffer_head *bhs[],
262 blk_opf_t op_flags, bool force_lock);
264 extern int buffer_heads_over_limit;
267 * Generic address_space_operations implementations for buffer_head-backed
270 void block_invalidate_folio(struct folio *folio, size_t offset, size_t length);
271 int block_write_full_page(struct page *page, get_block_t *get_block,
272 struct writeback_control *wbc);
273 int __block_write_full_folio(struct inode *inode, struct folio *folio,
274 get_block_t *get_block, struct writeback_control *wbc,
275 bh_end_io_t *handler);
276 int block_read_full_folio(struct folio *, get_block_t *);
277 bool block_is_partially_uptodate(struct folio *, size_t from, size_t count);
278 int block_write_begin(struct address_space *mapping, loff_t pos, unsigned len,
279 struct page **pagep, get_block_t *get_block);
280 int __block_write_begin(struct page *page, loff_t pos, unsigned len,
281 get_block_t *get_block);
282 int block_write_end(struct file *, struct address_space *,
283 loff_t, unsigned, unsigned,
284 struct page *, void *);
285 int generic_write_end(struct file *, struct address_space *,
286 loff_t, unsigned, unsigned,
287 struct page *, void *);
288 void folio_zero_new_buffers(struct folio *folio, size_t from, size_t to);
289 void clean_page_buffers(struct page *page);
290 int cont_write_begin(struct file *, struct address_space *, loff_t,
291 unsigned, struct page **, void **,
292 get_block_t *, loff_t *);
293 int generic_cont_expand_simple(struct inode *inode, loff_t size);
294 int block_commit_write(struct page *page, unsigned from, unsigned to);
295 int block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
296 get_block_t get_block);
297 /* Convert errno to return value from ->page_mkwrite() call */
298 static inline vm_fault_t block_page_mkwrite_return(int err)
301 return VM_FAULT_LOCKED;
302 if (err == -EFAULT || err == -EAGAIN)
303 return VM_FAULT_NOPAGE;
306 /* -ENOSPC, -EDQUOT, -EIO ... */
307 return VM_FAULT_SIGBUS;
309 sector_t generic_block_bmap(struct address_space *, sector_t, get_block_t *);
310 int block_truncate_page(struct address_space *, loff_t, get_block_t *);
312 #ifdef CONFIG_MIGRATION
313 extern int buffer_migrate_folio(struct address_space *,
314 struct folio *dst, struct folio *src, enum migrate_mode);
315 extern int buffer_migrate_folio_norefs(struct address_space *,
316 struct folio *dst, struct folio *src, enum migrate_mode);
318 #define buffer_migrate_folio NULL
319 #define buffer_migrate_folio_norefs NULL
322 void buffer_init(void);
328 static inline void get_bh(struct buffer_head *bh)
330 atomic_inc(&bh->b_count);
333 static inline void put_bh(struct buffer_head *bh)
335 smp_mb__before_atomic();
336 atomic_dec(&bh->b_count);
339 static inline void brelse(struct buffer_head *bh)
345 static inline void bforget(struct buffer_head *bh)
351 static inline struct buffer_head *
352 sb_bread(struct super_block *sb, sector_t block)
354 return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
357 static inline struct buffer_head *
358 sb_bread_unmovable(struct super_block *sb, sector_t block)
360 return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, 0);
364 sb_breadahead(struct super_block *sb, sector_t block)
366 __breadahead(sb->s_bdev, block, sb->s_blocksize);
369 static inline struct buffer_head *
370 sb_getblk(struct super_block *sb, sector_t block)
372 return __getblk_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
376 static inline struct buffer_head *
377 sb_getblk_gfp(struct super_block *sb, sector_t block, gfp_t gfp)
379 return __getblk_gfp(sb->s_bdev, block, sb->s_blocksize, gfp);
382 static inline struct buffer_head *
383 sb_find_get_block(struct super_block *sb, sector_t block)
385 return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
389 map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
391 set_buffer_mapped(bh);
392 bh->b_bdev = sb->s_bdev;
393 bh->b_blocknr = block;
394 bh->b_size = sb->s_blocksize;
397 static inline void wait_on_buffer(struct buffer_head *bh)
400 if (buffer_locked(bh))
401 __wait_on_buffer(bh);
404 static inline int trylock_buffer(struct buffer_head *bh)
406 return likely(!test_and_set_bit_lock(BH_Lock, &bh->b_state));
409 static inline void lock_buffer(struct buffer_head *bh)
412 if (!trylock_buffer(bh))
416 static inline struct buffer_head *getblk_unmovable(struct block_device *bdev,
420 return __getblk_gfp(bdev, block, size, 0);
423 static inline struct buffer_head *__getblk(struct block_device *bdev,
427 return __getblk_gfp(bdev, block, size, __GFP_MOVABLE);
430 static inline void bh_readahead(struct buffer_head *bh, blk_opf_t op_flags)
432 if (!buffer_uptodate(bh) && trylock_buffer(bh)) {
433 if (!buffer_uptodate(bh))
434 __bh_read(bh, op_flags, false);
440 static inline void bh_read_nowait(struct buffer_head *bh, blk_opf_t op_flags)
442 if (!bh_uptodate_or_lock(bh))
443 __bh_read(bh, op_flags, false);
446 /* Returns 1 if buffer uptodated, 0 on success, and -EIO on error. */
447 static inline int bh_read(struct buffer_head *bh, blk_opf_t op_flags)
449 if (bh_uptodate_or_lock(bh))
451 return __bh_read(bh, op_flags, true);
454 static inline void bh_read_batch(int nr, struct buffer_head *bhs[])
456 __bh_read_batch(nr, bhs, 0, true);
459 static inline void bh_readahead_batch(int nr, struct buffer_head *bhs[],
462 __bh_read_batch(nr, bhs, op_flags, false);
466 * __bread() - reads a specified block and returns the bh
467 * @bdev: the block_device to read from
468 * @block: number of block
469 * @size: size (in bytes) to read
471 * Reads a specified block, and returns buffer head that contains it.
472 * The page cache is allocated from movable area so that it can be migrated.
473 * It returns NULL if the block was unreadable.
475 static inline struct buffer_head *
476 __bread(struct block_device *bdev, sector_t block, unsigned size)
478 return __bread_gfp(bdev, block, size, __GFP_MOVABLE);
481 bool block_dirty_folio(struct address_space *mapping, struct folio *folio);
483 #else /* CONFIG_BLOCK */
485 static inline void buffer_init(void) {}
486 static inline bool try_to_free_buffers(struct folio *folio) { return true; }
487 static inline int inode_has_buffers(struct inode *inode) { return 0; }
488 static inline void invalidate_inode_buffers(struct inode *inode) {}
489 static inline int remove_inode_buffers(struct inode *inode) { return 1; }
490 static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
491 static inline void invalidate_bh_lrus_cpu(void) {}
492 static inline bool has_bh_in_lru(int cpu, void *dummy) { return false; }
493 #define buffer_heads_over_limit 0
495 #endif /* CONFIG_BLOCK */
496 #endif /* _LINUX_BUFFER_HEAD_H */