]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/buffer_head.h
ext4: mark all metadata I/O with REQ_META
[mirror_ubuntu-bionic-kernel.git] / include / linux / buffer_head.h
CommitLineData
1da177e4
LT
1/*
2 * include/linux/buffer_head.h
3 *
4 * Everything to do with buffer_heads.
5 */
6
7#ifndef _LINUX_BUFFER_HEAD_H
8#define _LINUX_BUFFER_HEAD_H
9
10#include <linux/types.h>
11#include <linux/fs.h>
12#include <linux/linkage.h>
13#include <linux/pagemap.h>
14#include <linux/wait.h>
60063497 15#include <linux/atomic.h>
1da177e4 16
9361401e
DH
17#ifdef CONFIG_BLOCK
18
1da177e4
LT
19enum bh_state_bits {
20 BH_Uptodate, /* Contains valid data */
21 BH_Dirty, /* Is dirty */
22 BH_Lock, /* Is locked */
23 BH_Req, /* Has been submitted for I/O */
a3972203
NP
24 BH_Uptodate_Lock,/* Used by the first bh in a page, to serialise
25 * IO completion of other buffers in the page
26 */
1da177e4
LT
27
28 BH_Mapped, /* Has a disk mapping */
29 BH_New, /* Disk mapping was newly created by get_block */
30 BH_Async_Read, /* Is under end_buffer_async_read I/O */
31 BH_Async_Write, /* Is under end_buffer_async_write I/O */
32 BH_Delay, /* Buffer is not yet allocated on disk */
33 BH_Boundary, /* Block is followed by a discontiguity */
34 BH_Write_EIO, /* I/O error on write */
33a266dd 35 BH_Unwritten, /* Buffer is allocated on disk but not written */
08bafc03 36 BH_Quiet, /* Buffer Error Prinks to be quiet */
1da177e4
LT
37
38 BH_PrivateStart,/* not a state bit, but the first bit available
39 * for private allocation by other entities
40 */
41};
42
43#define MAX_BUF_PER_PAGE (PAGE_CACHE_SIZE / 512)
44
45struct page;
46struct buffer_head;
47struct address_space;
48typedef void (bh_end_io_t)(struct buffer_head *bh, int uptodate);
49
50/*
205f87f6
BP
51 * Historically, a buffer_head was used to map a single block
52 * within a page, and of course as the unit of I/O through the
53 * filesystem and block layers. Nowadays the basic I/O unit
54 * is the bio, and buffer_heads are used for extracting block
55 * mappings (via a get_block_t call), for tracking state within
56 * a page (via a page_mapping) and for wrapping bio submission
57 * for backward compatibility reasons (e.g. submit_bh).
1da177e4
LT
58 */
59struct buffer_head {
1da177e4
LT
60 unsigned long b_state; /* buffer state bitmap (see above) */
61 struct buffer_head *b_this_page;/* circular list of page's buffers */
62 struct page *b_page; /* the page this bh is mapped to */
1da177e4 63
205f87f6
BP
64 sector_t b_blocknr; /* start block number */
65 size_t b_size; /* size of mapping */
66 char *b_data; /* pointer to data within the page */
1da177e4
LT
67
68 struct block_device *b_bdev;
69 bh_end_io_t *b_end_io; /* I/O completion */
70 void *b_private; /* reserved for b_end_io */
71 struct list_head b_assoc_buffers; /* associated with another mapping */
58ff407b
JK
72 struct address_space *b_assoc_map; /* mapping this buffer is
73 associated with */
205f87f6 74 atomic_t b_count; /* users using this buffer_head */
1da177e4
LT
75};
76
77/*
78 * macro tricks to expand the set_buffer_foo(), clear_buffer_foo()
79 * and buffer_foo() functions.
80 */
81#define BUFFER_FNS(bit, name) \
82static inline void set_buffer_##name(struct buffer_head *bh) \
83{ \
84 set_bit(BH_##bit, &(bh)->b_state); \
85} \
86static inline void clear_buffer_##name(struct buffer_head *bh) \
87{ \
88 clear_bit(BH_##bit, &(bh)->b_state); \
89} \
90static inline int buffer_##name(const struct buffer_head *bh) \
91{ \
92 return test_bit(BH_##bit, &(bh)->b_state); \
93}
94
95/*
96 * test_set_buffer_foo() and test_clear_buffer_foo()
97 */
98#define TAS_BUFFER_FNS(bit, name) \
99static inline int test_set_buffer_##name(struct buffer_head *bh) \
100{ \
101 return test_and_set_bit(BH_##bit, &(bh)->b_state); \
102} \
103static inline int test_clear_buffer_##name(struct buffer_head *bh) \
104{ \
105 return test_and_clear_bit(BH_##bit, &(bh)->b_state); \
106} \
107
108/*
109 * Emit the buffer bitops functions. Note that there are also functions
110 * of the form "mark_buffer_foo()". These are higher-level functions which
111 * do something in addition to setting a b_state bit.
112 */
113BUFFER_FNS(Uptodate, uptodate)
114BUFFER_FNS(Dirty, dirty)
115TAS_BUFFER_FNS(Dirty, dirty)
116BUFFER_FNS(Lock, locked)
1da177e4
LT
117BUFFER_FNS(Req, req)
118TAS_BUFFER_FNS(Req, req)
119BUFFER_FNS(Mapped, mapped)
120BUFFER_FNS(New, new)
121BUFFER_FNS(Async_Read, async_read)
122BUFFER_FNS(Async_Write, async_write)
123BUFFER_FNS(Delay, delay)
124BUFFER_FNS(Boundary, boundary)
125BUFFER_FNS(Write_EIO, write_io_error)
33a266dd 126BUFFER_FNS(Unwritten, unwritten)
1da177e4
LT
127
128#define bh_offset(bh) ((unsigned long)(bh)->b_data & ~PAGE_MASK)
1da177e4
LT
129
130/* If we *know* page->private refers to buffer_heads */
131#define page_buffers(page) \
132 ({ \
4c21e2f2
HD
133 BUG_ON(!PagePrivate(page)); \
134 ((struct buffer_head *)page_private(page)); \
1da177e4
LT
135 })
136#define page_has_buffers(page) PagePrivate(page)
137
138/*
139 * Declarations
140 */
141
b3c97528 142void mark_buffer_dirty(struct buffer_head *bh);
1da177e4 143void init_buffer(struct buffer_head *, bh_end_io_t *, void *);
f0059afd 144void touch_buffer(struct buffer_head *bh);
1da177e4
LT
145void set_bh_page(struct buffer_head *bh,
146 struct page *page, unsigned long offset);
147int try_to_free_buffers(struct page *);
148struct buffer_head *alloc_page_buffers(struct page *page, unsigned long size,
149 int retry);
150void create_empty_buffers(struct page *, unsigned long,
151 unsigned long b_state);
152void end_buffer_read_sync(struct buffer_head *bh, int uptodate);
153void end_buffer_write_sync(struct buffer_head *bh, int uptodate);
35c80d5f 154void end_buffer_async_write(struct buffer_head *bh, int uptodate);
1da177e4
LT
155
156/* Things to do with buffers at mapping->private_list */
157void mark_buffer_dirty_inode(struct buffer_head *bh, struct inode *inode);
158int inode_has_buffers(struct inode *);
159void invalidate_inode_buffers(struct inode *);
160int remove_inode_buffers(struct inode *inode);
161int sync_mapping_buffers(struct address_space *mapping);
162void unmap_underlying_metadata(struct block_device *bdev, sector_t block);
163
164void mark_buffer_async_write(struct buffer_head *bh);
1da177e4
LT
165void __wait_on_buffer(struct buffer_head *);
166wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
3991d3bd
TK
167struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
168 unsigned size);
169struct buffer_head *__getblk(struct block_device *bdev, sector_t block,
170 unsigned size);
1da177e4
LT
171void __brelse(struct buffer_head *);
172void __bforget(struct buffer_head *);
3991d3bd
TK
173void __breadahead(struct block_device *, sector_t block, unsigned int size);
174struct buffer_head *__bread(struct block_device *, sector_t block, unsigned size);
f9a14399 175void invalidate_bh_lrus(void);
dd0fc66f 176struct buffer_head *alloc_buffer_head(gfp_t gfp_flags);
1da177e4 177void free_buffer_head(struct buffer_head * bh);
b3c97528
HH
178void unlock_buffer(struct buffer_head *bh);
179void __lock_buffer(struct buffer_head *bh);
1da177e4
LT
180void ll_rw_block(int, int, struct buffer_head * bh[]);
181int sync_dirty_buffer(struct buffer_head *bh);
87e99511 182int __sync_dirty_buffer(struct buffer_head *bh, int rw);
9cb569d6 183void write_dirty_buffer(struct buffer_head *bh, int rw);
1da177e4
LT
184int submit_bh(int, struct buffer_head *);
185void write_boundary_block(struct block_device *bdev,
186 sector_t bblock, unsigned blocksize);
389d1b08
AK
187int bh_uptodate_or_lock(struct buffer_head *bh);
188int bh_submit_read(struct buffer_head *bh);
1da177e4
LT
189
190extern int buffer_heads_over_limit;
191
192/*
193 * Generic address_space_operations implementations for buffer_head-backed
194 * address_spaces.
195 */
2ff28e22 196void block_invalidatepage(struct page *page, unsigned long offset);
1da177e4
LT
197int block_write_full_page(struct page *page, get_block_t *get_block,
198 struct writeback_control *wbc);
35c80d5f
CM
199int block_write_full_page_endio(struct page *page, get_block_t *get_block,
200 struct writeback_control *wbc, bh_end_io_t *handler);
1da177e4 201int block_read_full_page(struct page*, get_block_t*);
8ab22b9a
HH
202int block_is_partially_uptodate(struct page *page, read_descriptor_t *desc,
203 unsigned long from);
155130a4
CH
204int block_write_begin(struct address_space *mapping, loff_t pos, unsigned len,
205 unsigned flags, struct page **pagep, get_block_t *get_block);
6e1db88d
CH
206int __block_write_begin(struct page *page, loff_t pos, unsigned len,
207 get_block_t *get_block);
afddba49
NP
208int block_write_end(struct file *, struct address_space *,
209 loff_t, unsigned, unsigned,
210 struct page *, void *);
211int generic_write_end(struct file *, struct address_space *,
212 loff_t, unsigned, unsigned,
213 struct page *, void *);
214void page_zero_new_buffers(struct page *page, unsigned from, unsigned to);
89e10787
NP
215int cont_write_begin(struct file *, struct address_space *, loff_t,
216 unsigned, unsigned, struct page **, void **,
217 get_block_t *, loff_t *);
05eb0b51 218int generic_cont_expand_simple(struct inode *inode, loff_t size);
1da177e4 219int block_commit_write(struct page *page, unsigned from, unsigned to);
24da4fab
JK
220int __block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
221 get_block_t get_block);
c2ec175c 222int block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
54171690 223 get_block_t get_block);
24da4fab
JK
224/* Convert errno to return value from ->page_mkwrite() call */
225static inline int block_page_mkwrite_return(int err)
226{
227 if (err == 0)
228 return VM_FAULT_LOCKED;
229 if (err == -EFAULT)
230 return VM_FAULT_NOPAGE;
231 if (err == -ENOMEM)
232 return VM_FAULT_OOM;
ea13a864
JK
233 if (err == -EAGAIN)
234 return VM_FAULT_RETRY;
24da4fab
JK
235 /* -ENOSPC, -EDQUOT, -EIO ... */
236 return VM_FAULT_SIGBUS;
237}
1da177e4 238sector_t generic_block_bmap(struct address_space *, sector_t, get_block_t *);
1da177e4 239int block_truncate_page(struct address_space *, loff_t, get_block_t *);
ea0f04e5 240int nobh_write_begin(struct address_space *, loff_t, unsigned, unsigned,
03158cd7
NP
241 struct page **, void **, get_block_t*);
242int nobh_write_end(struct file *, struct address_space *,
243 loff_t, unsigned, unsigned,
244 struct page *, void *);
245int nobh_truncate_page(struct address_space *, loff_t, get_block_t *);
1da177e4
LT
246int nobh_writepage(struct page *page, get_block_t *get_block,
247 struct writeback_control *wbc);
248
b6cd0b77 249void buffer_init(void);
1da177e4
LT
250
251/*
252 * inline definitions
253 */
254
255static inline void attach_page_buffers(struct page *page,
256 struct buffer_head *head)
257{
258 page_cache_get(page);
259 SetPagePrivate(page);
4c21e2f2 260 set_page_private(page, (unsigned long)head);
1da177e4
LT
261}
262
263static inline void get_bh(struct buffer_head *bh)
264{
265 atomic_inc(&bh->b_count);
266}
267
268static inline void put_bh(struct buffer_head *bh)
269{
270 smp_mb__before_atomic_dec();
271 atomic_dec(&bh->b_count);
272}
273
274static inline void brelse(struct buffer_head *bh)
275{
276 if (bh)
277 __brelse(bh);
278}
279
280static inline void bforget(struct buffer_head *bh)
281{
282 if (bh)
283 __bforget(bh);
284}
285
286static inline struct buffer_head *
287sb_bread(struct super_block *sb, sector_t block)
288{
289 return __bread(sb->s_bdev, block, sb->s_blocksize);
290}
291
292static inline void
293sb_breadahead(struct super_block *sb, sector_t block)
294{
295 __breadahead(sb->s_bdev, block, sb->s_blocksize);
296}
297
298static inline struct buffer_head *
299sb_getblk(struct super_block *sb, sector_t block)
300{
301 return __getblk(sb->s_bdev, block, sb->s_blocksize);
302}
303
304static inline struct buffer_head *
305sb_find_get_block(struct super_block *sb, sector_t block)
306{
307 return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
308}
309
310static inline void
311map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
312{
313 set_buffer_mapped(bh);
314 bh->b_bdev = sb->s_bdev;
315 bh->b_blocknr = block;
b0cf2321 316 bh->b_size = sb->s_blocksize;
1da177e4
LT
317}
318
1da177e4
LT
319static inline void wait_on_buffer(struct buffer_head *bh)
320{
321 might_sleep();
a9877cc2 322 if (buffer_locked(bh))
1da177e4
LT
323 __wait_on_buffer(bh);
324}
325
ca5de404
NP
326static inline int trylock_buffer(struct buffer_head *bh)
327{
51b07fc3 328 return likely(!test_and_set_bit_lock(BH_Lock, &bh->b_state));
ca5de404
NP
329}
330
1da177e4
LT
331static inline void lock_buffer(struct buffer_head *bh)
332{
333 might_sleep();
ca5de404 334 if (!trylock_buffer(bh))
1da177e4
LT
335 __lock_buffer(bh);
336}
337
cf9a2ae8 338extern int __set_page_dirty_buffers(struct page *page);
9361401e
DH
339
340#else /* CONFIG_BLOCK */
341
342static inline void buffer_init(void) {}
343static inline int try_to_free_buffers(struct page *page) { return 1; }
9361401e
DH
344static inline int inode_has_buffers(struct inode *inode) { return 0; }
345static inline void invalidate_inode_buffers(struct inode *inode) {}
346static inline int remove_inode_buffers(struct inode *inode) { return 1; }
347static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
9361401e
DH
348
349#endif /* CONFIG_BLOCK */
1da177e4 350#endif /* _LINUX_BUFFER_HEAD_H */