Export filemap_write_and_wait_range
[deliverable/linux.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);
1da177e4
LT
158
159/* Things to do with buffers at mapping->private_list */
160void mark_buffer_dirty_inode(struct buffer_head *bh, struct inode *inode);
161int inode_has_buffers(struct inode *);
162void invalidate_inode_buffers(struct inode *);
163int remove_inode_buffers(struct inode *inode);
164int sync_mapping_buffers(struct address_space *mapping);
165void unmap_underlying_metadata(struct block_device *bdev, sector_t block);
166
167void mark_buffer_async_write(struct buffer_head *bh);
1da177e4
LT
168void __wait_on_buffer(struct buffer_head *);
169wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
3991d3bd
TK
170struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
171 unsigned size);
172struct buffer_head *__getblk(struct block_device *bdev, sector_t block,
173 unsigned size);
1da177e4
LT
174void __brelse(struct buffer_head *);
175void __bforget(struct buffer_head *);
3991d3bd
TK
176void __breadahead(struct block_device *, sector_t block, unsigned int size);
177struct buffer_head *__bread(struct block_device *, sector_t block, unsigned size);
f9a14399 178void invalidate_bh_lrus(void);
dd0fc66f 179struct buffer_head *alloc_buffer_head(gfp_t gfp_flags);
1da177e4 180void free_buffer_head(struct buffer_head * bh);
b3c97528
HH
181void unlock_buffer(struct buffer_head *bh);
182void __lock_buffer(struct buffer_head *bh);
1da177e4
LT
183void ll_rw_block(int, int, struct buffer_head * bh[]);
184int sync_dirty_buffer(struct buffer_head *bh);
185int submit_bh(int, struct buffer_head *);
186void write_boundary_block(struct block_device *bdev,
187 sector_t bblock, unsigned blocksize);
389d1b08
AK
188int bh_uptodate_or_lock(struct buffer_head *bh);
189int bh_submit_read(struct buffer_head *bh);
1da177e4
LT
190
191extern int buffer_heads_over_limit;
192
193/*
194 * Generic address_space_operations implementations for buffer_head-backed
195 * address_spaces.
196 */
2ff28e22 197void block_invalidatepage(struct page *page, unsigned long offset);
1da177e4
LT
198int block_write_full_page(struct page *page, get_block_t *get_block,
199 struct writeback_control *wbc);
200int block_read_full_page(struct page*, get_block_t*);
8ab22b9a
HH
201int block_is_partially_uptodate(struct page *page, read_descriptor_t *desc,
202 unsigned long from);
afddba49
NP
203int block_write_begin(struct file *, struct address_space *,
204 loff_t, unsigned, unsigned,
205 struct page **, void **, get_block_t*);
206int block_write_end(struct file *, struct address_space *,
207 loff_t, unsigned, unsigned,
208 struct page *, void *);
209int generic_write_end(struct file *, struct address_space *,
210 loff_t, unsigned, unsigned,
211 struct page *, void *);
212void page_zero_new_buffers(struct page *page, unsigned from, unsigned to);
1da177e4 213int block_prepare_write(struct page*, unsigned, unsigned, get_block_t*);
89e10787
NP
214int cont_write_begin(struct file *, struct address_space *, loff_t,
215 unsigned, unsigned, struct page **, void **,
216 get_block_t *, loff_t *);
05eb0b51 217int generic_cont_expand_simple(struct inode *inode, loff_t size);
1da177e4 218int block_commit_write(struct page *page, unsigned from, unsigned to);
c2ec175c 219int block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
54171690 220 get_block_t get_block);
3978d717 221void block_sync_page(struct page *);
1da177e4 222sector_t generic_block_bmap(struct address_space *, sector_t, get_block_t *);
1da177e4
LT
223int block_truncate_page(struct address_space *, loff_t, get_block_t *);
224int file_fsync(struct file *, struct dentry *, int);
03158cd7
NP
225int nobh_write_begin(struct file *, struct address_space *,
226 loff_t, unsigned, unsigned,
227 struct page **, void **, get_block_t*);
228int nobh_write_end(struct file *, struct address_space *,
229 loff_t, unsigned, unsigned,
230 struct page *, void *);
231int nobh_truncate_page(struct address_space *, loff_t, get_block_t *);
1da177e4
LT
232int nobh_writepage(struct page *page, get_block_t *get_block,
233 struct writeback_control *wbc);
234
b6cd0b77 235void buffer_init(void);
1da177e4
LT
236
237/*
238 * inline definitions
239 */
240
241static inline void attach_page_buffers(struct page *page,
242 struct buffer_head *head)
243{
244 page_cache_get(page);
245 SetPagePrivate(page);
4c21e2f2 246 set_page_private(page, (unsigned long)head);
1da177e4
LT
247}
248
249static inline void get_bh(struct buffer_head *bh)
250{
251 atomic_inc(&bh->b_count);
252}
253
254static inline void put_bh(struct buffer_head *bh)
255{
256 smp_mb__before_atomic_dec();
257 atomic_dec(&bh->b_count);
258}
259
260static inline void brelse(struct buffer_head *bh)
261{
262 if (bh)
263 __brelse(bh);
264}
265
266static inline void bforget(struct buffer_head *bh)
267{
268 if (bh)
269 __bforget(bh);
270}
271
272static inline struct buffer_head *
273sb_bread(struct super_block *sb, sector_t block)
274{
275 return __bread(sb->s_bdev, block, sb->s_blocksize);
276}
277
278static inline void
279sb_breadahead(struct super_block *sb, sector_t block)
280{
281 __breadahead(sb->s_bdev, block, sb->s_blocksize);
282}
283
284static inline struct buffer_head *
285sb_getblk(struct super_block *sb, sector_t block)
286{
287 return __getblk(sb->s_bdev, block, sb->s_blocksize);
288}
289
290static inline struct buffer_head *
291sb_find_get_block(struct super_block *sb, sector_t block)
292{
293 return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
294}
295
296static inline void
297map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
298{
299 set_buffer_mapped(bh);
300 bh->b_bdev = sb->s_bdev;
301 bh->b_blocknr = block;
b0cf2321 302 bh->b_size = sb->s_blocksize;
1da177e4
LT
303}
304
305/*
306 * Calling wait_on_buffer() for a zero-ref buffer is illegal, so we call into
307 * __wait_on_buffer() just to trip a debug check. Because debug code in inline
308 * functions is bloaty.
309 */
310static inline void wait_on_buffer(struct buffer_head *bh)
311{
312 might_sleep();
313 if (buffer_locked(bh) || atomic_read(&bh->b_count) == 0)
314 __wait_on_buffer(bh);
315}
316
ca5de404
NP
317static inline int trylock_buffer(struct buffer_head *bh)
318{
51b07fc3 319 return likely(!test_and_set_bit_lock(BH_Lock, &bh->b_state));
ca5de404
NP
320}
321
1da177e4
LT
322static inline void lock_buffer(struct buffer_head *bh)
323{
324 might_sleep();
ca5de404 325 if (!trylock_buffer(bh))
1da177e4
LT
326 __lock_buffer(bh);
327}
328
cf9a2ae8 329extern int __set_page_dirty_buffers(struct page *page);
9361401e
DH
330
331#else /* CONFIG_BLOCK */
332
333static inline void buffer_init(void) {}
334static inline int try_to_free_buffers(struct page *page) { return 1; }
9361401e
DH
335static inline int inode_has_buffers(struct inode *inode) { return 0; }
336static inline void invalidate_inode_buffers(struct inode *inode) {}
337static inline int remove_inode_buffers(struct inode *inode) { return 1; }
338static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
9361401e
DH
339
340#endif /* CONFIG_BLOCK */
1da177e4 341#endif /* _LINUX_BUFFER_HEAD_H */
This page took 0.57962 seconds and 5 git commands to generate.