nfsd: take file and mnt write in nfs4_upgrade_open
[GitHub/mt8127/android_kernel_alcatel_ttab.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 */
1da177e4
LT
38
39 BH_PrivateStart,/* not a state bit, but the first bit available
40 * for private allocation by other entities
41 */
42};
43
44#define MAX_BUF_PER_PAGE (PAGE_CACHE_SIZE / 512)
45
46struct page;
47struct buffer_head;
48struct address_space;
49typedef void (bh_end_io_t)(struct buffer_head *bh, int uptodate);
50
51/*
205f87f6
BP
52 * Historically, a buffer_head was used to map a single block
53 * within a page, and of course as the unit of I/O through the
54 * filesystem and block layers. Nowadays the basic I/O unit
55 * is the bio, and buffer_heads are used for extracting block
56 * mappings (via a get_block_t call), for tracking state within
57 * a page (via a page_mapping) and for wrapping bio submission
58 * for backward compatibility reasons (e.g. submit_bh).
1da177e4
LT
59 */
60struct buffer_head {
1da177e4
LT
61 unsigned long b_state; /* buffer state bitmap (see above) */
62 struct buffer_head *b_this_page;/* circular list of page's buffers */
63 struct page *b_page; /* the page this bh is mapped to */
1da177e4 64
205f87f6
BP
65 sector_t b_blocknr; /* start block number */
66 size_t b_size; /* size of mapping */
67 char *b_data; /* pointer to data within the page */
1da177e4
LT
68
69 struct block_device *b_bdev;
70 bh_end_io_t *b_end_io; /* I/O completion */
71 void *b_private; /* reserved for b_end_io */
72 struct list_head b_assoc_buffers; /* associated with another mapping */
58ff407b
JK
73 struct address_space *b_assoc_map; /* mapping this buffer is
74 associated with */
205f87f6 75 atomic_t b_count; /* users using this buffer_head */
1da177e4
LT
76};
77
78/*
79 * macro tricks to expand the set_buffer_foo(), clear_buffer_foo()
80 * and buffer_foo() functions.
81 */
82#define BUFFER_FNS(bit, name) \
83static inline void set_buffer_##name(struct buffer_head *bh) \
84{ \
85 set_bit(BH_##bit, &(bh)->b_state); \
86} \
87static inline void clear_buffer_##name(struct buffer_head *bh) \
88{ \
89 clear_bit(BH_##bit, &(bh)->b_state); \
90} \
91static inline int buffer_##name(const struct buffer_head *bh) \
92{ \
93 return test_bit(BH_##bit, &(bh)->b_state); \
94}
95
96/*
97 * test_set_buffer_foo() and test_clear_buffer_foo()
98 */
99#define TAS_BUFFER_FNS(bit, name) \
100static inline int test_set_buffer_##name(struct buffer_head *bh) \
101{ \
102 return test_and_set_bit(BH_##bit, &(bh)->b_state); \
103} \
104static inline int test_clear_buffer_##name(struct buffer_head *bh) \
105{ \
106 return test_and_clear_bit(BH_##bit, &(bh)->b_state); \
107} \
108
109/*
110 * Emit the buffer bitops functions. Note that there are also functions
111 * of the form "mark_buffer_foo()". These are higher-level functions which
112 * do something in addition to setting a b_state bit.
113 */
114BUFFER_FNS(Uptodate, uptodate)
115BUFFER_FNS(Dirty, dirty)
116TAS_BUFFER_FNS(Dirty, dirty)
117BUFFER_FNS(Lock, locked)
118TAS_BUFFER_FNS(Lock, locked)
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);
f98393a6 168void invalidate_bdev(struct block_device *);
1da177e4
LT
169int sync_blockdev(struct block_device *bdev);
170void __wait_on_buffer(struct buffer_head *);
171wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
172int fsync_bdev(struct block_device *);
173struct super_block *freeze_bdev(struct block_device *);
174void thaw_bdev(struct block_device *, struct super_block *);
175int fsync_super(struct super_block *);
176int fsync_no_super(struct block_device *);
3991d3bd
TK
177struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
178 unsigned size);
179struct buffer_head *__getblk(struct block_device *bdev, sector_t block,
180 unsigned size);
1da177e4
LT
181void __brelse(struct buffer_head *);
182void __bforget(struct buffer_head *);
3991d3bd
TK
183void __breadahead(struct block_device *, sector_t block, unsigned int size);
184struct buffer_head *__bread(struct block_device *, sector_t block, unsigned size);
f9a14399 185void invalidate_bh_lrus(void);
dd0fc66f 186struct buffer_head *alloc_buffer_head(gfp_t gfp_flags);
1da177e4 187void free_buffer_head(struct buffer_head * bh);
b3c97528
HH
188void unlock_buffer(struct buffer_head *bh);
189void __lock_buffer(struct buffer_head *bh);
1da177e4
LT
190void ll_rw_block(int, int, struct buffer_head * bh[]);
191int sync_dirty_buffer(struct buffer_head *bh);
192int submit_bh(int, struct buffer_head *);
193void write_boundary_block(struct block_device *bdev,
194 sector_t bblock, unsigned blocksize);
389d1b08
AK
195int bh_uptodate_or_lock(struct buffer_head *bh);
196int bh_submit_read(struct buffer_head *bh);
1da177e4
LT
197
198extern int buffer_heads_over_limit;
199
200/*
201 * Generic address_space_operations implementations for buffer_head-backed
202 * address_spaces.
203 */
2ff28e22 204void block_invalidatepage(struct page *page, unsigned long offset);
1da177e4
LT
205int block_write_full_page(struct page *page, get_block_t *get_block,
206 struct writeback_control *wbc);
207int block_read_full_page(struct page*, get_block_t*);
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);
54171690
DC
224int block_page_mkwrite(struct vm_area_struct *vma, struct page *page,
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
277static inline struct buffer_head *
278sb_bread(struct super_block *sb, sector_t block)
279{
280 return __bread(sb->s_bdev, block, sb->s_blocksize);
281}
282
283static inline void
284sb_breadahead(struct super_block *sb, sector_t block)
285{
286 __breadahead(sb->s_bdev, block, sb->s_blocksize);
287}
288
289static inline struct buffer_head *
290sb_getblk(struct super_block *sb, sector_t block)
291{
292 return __getblk(sb->s_bdev, block, sb->s_blocksize);
293}
294
295static inline struct buffer_head *
296sb_find_get_block(struct super_block *sb, sector_t block)
297{
298 return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
299}
300
301static inline void
302map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
303{
304 set_buffer_mapped(bh);
305 bh->b_bdev = sb->s_bdev;
306 bh->b_blocknr = block;
b0cf2321 307 bh->b_size = sb->s_blocksize;
1da177e4
LT
308}
309
310/*
311 * Calling wait_on_buffer() for a zero-ref buffer is illegal, so we call into
312 * __wait_on_buffer() just to trip a debug check. Because debug code in inline
313 * functions is bloaty.
314 */
315static inline void wait_on_buffer(struct buffer_head *bh)
316{
317 might_sleep();
318 if (buffer_locked(bh) || atomic_read(&bh->b_count) == 0)
319 __wait_on_buffer(bh);
320}
321
322static inline void lock_buffer(struct buffer_head *bh)
323{
324 might_sleep();
325 if (test_set_buffer_locked(bh))
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; }
335static inline int sync_blockdev(struct block_device *bdev) { return 0; }
336static inline int inode_has_buffers(struct inode *inode) { return 0; }
337static inline void invalidate_inode_buffers(struct inode *inode) {}
338static inline int remove_inode_buffers(struct inode *inode) { return 1; }
339static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
f98393a6 340static inline void invalidate_bdev(struct block_device *bdev) {}
9361401e
DH
341
342
343#endif /* CONFIG_BLOCK */
1da177e4 344#endif /* _LINUX_BUFFER_HEAD_H */