ext2: async get_block and support code
[linux-block.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>
15#include <asm/atomic.h>
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 */
35 BH_Ordered, /* ordered write */
36 BH_Eopnotsupp, /* operation not supported (barrier) */
33a266dd 37 BH_Unwritten, /* Buffer is allocated on disk but not written */
08bafc03 38 BH_Quiet, /* Buffer Error Prinks to be quiet */
1da177e4
LT
39
40 BH_PrivateStart,/* not a state bit, but the first bit available
41 * for private allocation by other entities
42 */
43};
44
45#define MAX_BUF_PER_PAGE (PAGE_CACHE_SIZE / 512)
46
47struct page;
48struct buffer_head;
49struct address_space;
50typedef void (bh_end_io_t)(struct buffer_head *bh, int uptodate);
51
52/*
205f87f6
BP
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).
1da177e4
LT
60 */
61struct buffer_head {
1da177e4
LT
62 unsigned long b_state; /* buffer state bitmap (see above) */
63 struct buffer_head *b_this_page;/* circular list of page's buffers */
64 struct page *b_page; /* the page this bh is mapped to */
1da177e4 65
205f87f6
BP
66 sector_t b_blocknr; /* start block number */
67 size_t b_size; /* size of mapping */
68 char *b_data; /* pointer to data within the page */
1da177e4
LT
69
70 struct block_device *b_bdev;
71 bh_end_io_t *b_end_io; /* I/O completion */
72 void *b_private; /* reserved for b_end_io */
73 struct list_head b_assoc_buffers; /* associated with another mapping */
58ff407b
JK
74 struct address_space *b_assoc_map; /* mapping this buffer is
75 associated with */
205f87f6 76 atomic_t b_count; /* users using this buffer_head */
1da177e4
LT
77};
78
79/*
80 * macro tricks to expand the set_buffer_foo(), clear_buffer_foo()
81 * and buffer_foo() functions.
82 */
83#define BUFFER_FNS(bit, name) \
84static inline void set_buffer_##name(struct buffer_head *bh) \
85{ \
86 set_bit(BH_##bit, &(bh)->b_state); \
87} \
88static inline void clear_buffer_##name(struct buffer_head *bh) \
89{ \
90 clear_bit(BH_##bit, &(bh)->b_state); \
91} \
92static inline int buffer_##name(const struct buffer_head *bh) \
93{ \
94 return test_bit(BH_##bit, &(bh)->b_state); \
95}
96
97/*
98 * test_set_buffer_foo() and test_clear_buffer_foo()
99 */
100#define TAS_BUFFER_FNS(bit, name) \
101static inline int test_set_buffer_##name(struct buffer_head *bh) \
102{ \
103 return test_and_set_bit(BH_##bit, &(bh)->b_state); \
104} \
105static inline int test_clear_buffer_##name(struct buffer_head *bh) \
106{ \
107 return test_and_clear_bit(BH_##bit, &(bh)->b_state); \
108} \
109
110/*
111 * Emit the buffer bitops functions. Note that there are also functions
112 * of the form "mark_buffer_foo()". These are higher-level functions which
113 * do something in addition to setting a b_state bit.
114 */
115BUFFER_FNS(Uptodate, uptodate)
116BUFFER_FNS(Dirty, dirty)
117TAS_BUFFER_FNS(Dirty, dirty)
118BUFFER_FNS(Lock, locked)
1da177e4
LT
119BUFFER_FNS(Req, req)
120TAS_BUFFER_FNS(Req, req)
121BUFFER_FNS(Mapped, mapped)
122BUFFER_FNS(New, new)
123BUFFER_FNS(Async_Read, async_read)
124BUFFER_FNS(Async_Write, async_write)
125BUFFER_FNS(Delay, delay)
126BUFFER_FNS(Boundary, boundary)
127BUFFER_FNS(Write_EIO, write_io_error)
128BUFFER_FNS(Ordered, ordered)
129BUFFER_FNS(Eopnotsupp, eopnotsupp)
33a266dd 130BUFFER_FNS(Unwritten, unwritten)
1da177e4
LT
131
132#define bh_offset(bh) ((unsigned long)(bh)->b_data & ~PAGE_MASK)
133#define touch_buffer(bh) mark_page_accessed(bh->b_page)
134
135/* If we *know* page->private refers to buffer_heads */
136#define page_buffers(page) \
137 ({ \
4c21e2f2
HD
138 BUG_ON(!PagePrivate(page)); \
139 ((struct buffer_head *)page_private(page)); \
1da177e4
LT
140 })
141#define page_has_buffers(page) PagePrivate(page)
142
143/*
144 * Declarations
145 */
146
b3c97528 147void mark_buffer_dirty(struct buffer_head *bh);
1da177e4
LT
148void init_buffer(struct buffer_head *, bh_end_io_t *, void *);
149void set_bh_page(struct buffer_head *bh,
150 struct page *page, unsigned long offset);
151int try_to_free_buffers(struct page *);
152struct buffer_head *alloc_page_buffers(struct page *page, unsigned long size,
153 int retry);
154void create_empty_buffers(struct page *, unsigned long,
155 unsigned long b_state);
156void end_buffer_read_sync(struct buffer_head *bh, int uptodate);
157void end_buffer_write_sync(struct buffer_head *bh, int uptodate);
35c80d5f 158void end_buffer_async_write(struct buffer_head *bh, int uptodate);
1da177e4
LT
159
160/* Things to do with buffers at mapping->private_list */
161void mark_buffer_dirty_inode(struct buffer_head *bh, struct inode *inode);
162int inode_has_buffers(struct inode *);
163void invalidate_inode_buffers(struct inode *);
164int remove_inode_buffers(struct inode *inode);
165int sync_mapping_buffers(struct address_space *mapping);
166void unmap_underlying_metadata(struct block_device *bdev, sector_t block);
167
168void mark_buffer_async_write(struct buffer_head *bh);
1da177e4 169void __wait_on_buffer(struct buffer_head *);
f80e69e7 170int __wait_on_buffer_async(struct buffer_head *, struct wait_bit_queue *);
1da177e4 171wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
3991d3bd
TK
172struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
173 unsigned size);
174struct buffer_head *__getblk(struct block_device *bdev, sector_t block,
175 unsigned size);
1da177e4
LT
176void __brelse(struct buffer_head *);
177void __bforget(struct buffer_head *);
3991d3bd 178void __breadahead(struct block_device *, sector_t block, unsigned int size);
2557c31c 179struct buffer_head *__bread_async(struct block_device *, sector_t block, unsigned size, struct wait_bit_queue *);
f9a14399 180void invalidate_bh_lrus(void);
dd0fc66f 181struct buffer_head *alloc_buffer_head(gfp_t gfp_flags);
1da177e4 182void free_buffer_head(struct buffer_head * bh);
b3c97528
HH
183void unlock_buffer(struct buffer_head *bh);
184void __lock_buffer(struct buffer_head *bh);
2557c31c 185int __lock_buffer_async(struct buffer_head *bh, struct wait_bit_queue *wait);
1da177e4
LT
186void ll_rw_block(int, int, struct buffer_head * bh[]);
187int sync_dirty_buffer(struct buffer_head *bh);
188int submit_bh(int, struct buffer_head *);
189void write_boundary_block(struct block_device *bdev,
190 sector_t bblock, unsigned blocksize);
389d1b08
AK
191int bh_uptodate_or_lock(struct buffer_head *bh);
192int bh_submit_read(struct buffer_head *bh);
1da177e4
LT
193
194extern int buffer_heads_over_limit;
195
196/*
197 * Generic address_space_operations implementations for buffer_head-backed
198 * address_spaces.
199 */
2ff28e22 200void block_invalidatepage(struct page *page, unsigned long offset);
1da177e4
LT
201int block_write_full_page(struct page *page, get_block_t *get_block,
202 struct writeback_control *wbc);
35c80d5f
CM
203int block_write_full_page_endio(struct page *page, get_block_t *get_block,
204 struct writeback_control *wbc, bh_end_io_t *handler);
1da177e4 205int block_read_full_page(struct page*, get_block_t*);
8ab22b9a
HH
206int block_is_partially_uptodate(struct page *page, read_descriptor_t *desc,
207 unsigned long from);
afddba49
NP
208int block_write_begin(struct file *, struct address_space *,
209 loff_t, unsigned, unsigned,
210 struct page **, void **, get_block_t*);
211int block_write_end(struct file *, struct address_space *,
212 loff_t, unsigned, unsigned,
213 struct page *, void *);
214int generic_write_end(struct file *, struct address_space *,
215 loff_t, unsigned, unsigned,
216 struct page *, void *);
217void page_zero_new_buffers(struct page *page, unsigned from, unsigned to);
1da177e4 218int block_prepare_write(struct page*, unsigned, unsigned, get_block_t*);
89e10787
NP
219int cont_write_begin(struct file *, struct address_space *, loff_t,
220 unsigned, unsigned, struct page **, void **,
221 get_block_t *, loff_t *);
05eb0b51 222int generic_cont_expand_simple(struct inode *inode, loff_t size);
1da177e4 223int block_commit_write(struct page *page, unsigned from, unsigned to);
c2ec175c 224int block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
54171690 225 get_block_t get_block);
3978d717 226void block_sync_page(struct page *);
1da177e4 227sector_t generic_block_bmap(struct address_space *, sector_t, get_block_t *);
1da177e4
LT
228int block_truncate_page(struct address_space *, loff_t, get_block_t *);
229int file_fsync(struct file *, struct dentry *, int);
03158cd7
NP
230int nobh_write_begin(struct file *, struct address_space *,
231 loff_t, unsigned, unsigned,
232 struct page **, void **, get_block_t*);
233int nobh_write_end(struct file *, struct address_space *,
234 loff_t, unsigned, unsigned,
235 struct page *, void *);
236int nobh_truncate_page(struct address_space *, loff_t, get_block_t *);
1da177e4
LT
237int nobh_writepage(struct page *page, get_block_t *get_block,
238 struct writeback_control *wbc);
239
b6cd0b77 240void buffer_init(void);
1da177e4
LT
241
242/*
243 * inline definitions
244 */
245
246static inline void attach_page_buffers(struct page *page,
247 struct buffer_head *head)
248{
249 page_cache_get(page);
250 SetPagePrivate(page);
4c21e2f2 251 set_page_private(page, (unsigned long)head);
1da177e4
LT
252}
253
254static inline void get_bh(struct buffer_head *bh)
255{
256 atomic_inc(&bh->b_count);
257}
258
259static inline void put_bh(struct buffer_head *bh)
260{
261 smp_mb__before_atomic_dec();
262 atomic_dec(&bh->b_count);
263}
264
265static inline void brelse(struct buffer_head *bh)
266{
267 if (bh)
268 __brelse(bh);
269}
270
271static inline void bforget(struct buffer_head *bh)
272{
273 if (bh)
274 __bforget(bh);
275}
276
2557c31c
JA
277static inline struct buffer_head *__bread(struct block_device *bdev,
278 sector_t block, unsigned size)
279{
280 return __bread_async(bdev, block, size, NULL);
281}
282
1da177e4
LT
283static inline struct buffer_head *
284sb_bread(struct super_block *sb, sector_t block)
285{
2557c31c
JA
286 return __bread_async(sb->s_bdev, block, sb->s_blocksize, NULL);
287}
288
289static inline struct buffer_head *
290sb_bread_async(struct super_block *sb, sector_t block, struct wait_bit_queue *w)
291{
292 return __bread_async(sb->s_bdev, block, sb->s_blocksize, w);
1da177e4
LT
293}
294
295static inline void
296sb_breadahead(struct super_block *sb, sector_t block)
297{
298 __breadahead(sb->s_bdev, block, sb->s_blocksize);
299}
300
301static inline struct buffer_head *
302sb_getblk(struct super_block *sb, sector_t block)
303{
304 return __getblk(sb->s_bdev, block, sb->s_blocksize);
305}
306
307static inline struct buffer_head *
308sb_find_get_block(struct super_block *sb, sector_t block)
309{
310 return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
311}
312
313static inline void
314map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
315{
316 set_buffer_mapped(bh);
317 bh->b_bdev = sb->s_bdev;
318 bh->b_blocknr = block;
b0cf2321 319 bh->b_size = sb->s_blocksize;
1da177e4
LT
320}
321
322/*
323 * Calling wait_on_buffer() for a zero-ref buffer is illegal, so we call into
324 * __wait_on_buffer() just to trip a debug check. Because debug code in inline
325 * functions is bloaty.
326 */
327static inline void wait_on_buffer(struct buffer_head *bh)
328{
329 might_sleep();
330 if (buffer_locked(bh) || atomic_read(&bh->b_count) == 0)
331 __wait_on_buffer(bh);
332}
333
f80e69e7
JA
334static inline int wait_on_buffer_async(struct buffer_head *bh,
335 struct wait_bit_queue *wait)
336{
337 if (buffer_locked(bh) || atomic_read(&bh->b_count) == 0)
338 return __wait_on_buffer_async(bh, wait);
339
340 return 0;
341}
342
ca5de404
NP
343static inline int trylock_buffer(struct buffer_head *bh)
344{
51b07fc3 345 return likely(!test_and_set_bit_lock(BH_Lock, &bh->b_state));
ca5de404
NP
346}
347
1da177e4
LT
348static inline void lock_buffer(struct buffer_head *bh)
349{
350 might_sleep();
ca5de404 351 if (!trylock_buffer(bh))
1da177e4
LT
352 __lock_buffer(bh);
353}
354
2557c31c
JA
355static inline int lock_buffer_async(struct buffer_head *bh,
356 struct wait_bit_queue *wait)
357{
358 if (!trylock_buffer(bh)) {
359 DEFINE_WAIT_BIT(wq_stack, &bh->b_state, BH_Lock);
360
361 if (!wait)
362 wait = &wq_stack;
363 else {
364 wait->key.flags = &bh->b_state;
365 wait->key.bit_nr = BH_Lock;
366 }
367
368 return __lock_buffer_async(bh, wait);
369 }
370
371 return 0;
372}
373
cf9a2ae8 374extern int __set_page_dirty_buffers(struct page *page);
9361401e
DH
375
376#else /* CONFIG_BLOCK */
377
378static inline void buffer_init(void) {}
379static inline int try_to_free_buffers(struct page *page) { return 1; }
9361401e
DH
380static inline int inode_has_buffers(struct inode *inode) { return 0; }
381static inline void invalidate_inode_buffers(struct inode *inode) {}
382static inline int remove_inode_buffers(struct inode *inode) { return 1; }
383static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
9361401e
DH
384
385#endif /* CONFIG_BLOCK */
1da177e4 386#endif /* _LINUX_BUFFER_HEAD_H */