]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/buffer_head.h
Merge branch 'for-4.4' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq
[mirror_ubuntu-zesty-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 */
877f962c
TT
37 BH_Meta, /* Buffer contains metadata */
38 BH_Prio, /* Buffer should be submitted with REQ_PRIO */
7b7a8665 39 BH_Defer_Completion, /* Defer AIO completion to workqueue */
1da177e4
LT
40
41 BH_PrivateStart,/* not a state bit, but the first bit available
42 * for private allocation by other entities
43 */
44};
45
46#define MAX_BUF_PER_PAGE (PAGE_CACHE_SIZE / 512)
47
48struct page;
49struct buffer_head;
50struct address_space;
51typedef void (bh_end_io_t)(struct buffer_head *bh, int uptodate);
52
53/*
205f87f6
BP
54 * Historically, a buffer_head was used to map a single block
55 * within a page, and of course as the unit of I/O through the
56 * filesystem and block layers. Nowadays the basic I/O unit
57 * is the bio, and buffer_heads are used for extracting block
58 * mappings (via a get_block_t call), for tracking state within
59 * a page (via a page_mapping) and for wrapping bio submission
60 * for backward compatibility reasons (e.g. submit_bh).
1da177e4
LT
61 */
62struct buffer_head {
1da177e4
LT
63 unsigned long b_state; /* buffer state bitmap (see above) */
64 struct buffer_head *b_this_page;/* circular list of page's buffers */
65 struct page *b_page; /* the page this bh is mapped to */
1da177e4 66
205f87f6
BP
67 sector_t b_blocknr; /* start block number */
68 size_t b_size; /* size of mapping */
69 char *b_data; /* pointer to data within the page */
1da177e4
LT
70
71 struct block_device *b_bdev;
72 bh_end_io_t *b_end_io; /* I/O completion */
73 void *b_private; /* reserved for b_end_io */
74 struct list_head b_assoc_buffers; /* associated with another mapping */
58ff407b
JK
75 struct address_space *b_assoc_map; /* mapping this buffer is
76 associated with */
205f87f6 77 atomic_t b_count; /* users using this buffer_head */
1da177e4
LT
78};
79
80/*
81 * macro tricks to expand the set_buffer_foo(), clear_buffer_foo()
82 * and buffer_foo() functions.
83 */
84#define BUFFER_FNS(bit, name) \
85static inline void set_buffer_##name(struct buffer_head *bh) \
86{ \
87 set_bit(BH_##bit, &(bh)->b_state); \
88} \
89static inline void clear_buffer_##name(struct buffer_head *bh) \
90{ \
91 clear_bit(BH_##bit, &(bh)->b_state); \
92} \
93static inline int buffer_##name(const struct buffer_head *bh) \
94{ \
95 return test_bit(BH_##bit, &(bh)->b_state); \
96}
97
98/*
99 * test_set_buffer_foo() and test_clear_buffer_foo()
100 */
101#define TAS_BUFFER_FNS(bit, name) \
102static inline int test_set_buffer_##name(struct buffer_head *bh) \
103{ \
104 return test_and_set_bit(BH_##bit, &(bh)->b_state); \
105} \
106static inline int test_clear_buffer_##name(struct buffer_head *bh) \
107{ \
108 return test_and_clear_bit(BH_##bit, &(bh)->b_state); \
109} \
110
111/*
112 * Emit the buffer bitops functions. Note that there are also functions
113 * of the form "mark_buffer_foo()". These are higher-level functions which
114 * do something in addition to setting a b_state bit.
115 */
116BUFFER_FNS(Uptodate, uptodate)
117BUFFER_FNS(Dirty, dirty)
118TAS_BUFFER_FNS(Dirty, dirty)
119BUFFER_FNS(Lock, locked)
1da177e4
LT
120BUFFER_FNS(Req, req)
121TAS_BUFFER_FNS(Req, req)
122BUFFER_FNS(Mapped, mapped)
123BUFFER_FNS(New, new)
124BUFFER_FNS(Async_Read, async_read)
125BUFFER_FNS(Async_Write, async_write)
126BUFFER_FNS(Delay, delay)
127BUFFER_FNS(Boundary, boundary)
128BUFFER_FNS(Write_EIO, write_io_error)
33a266dd 129BUFFER_FNS(Unwritten, unwritten)
877f962c
TT
130BUFFER_FNS(Meta, meta)
131BUFFER_FNS(Prio, prio)
7b7a8665 132BUFFER_FNS(Defer_Completion, defer_completion)
1da177e4
LT
133
134#define bh_offset(bh) ((unsigned long)(bh)->b_data & ~PAGE_MASK)
1da177e4
LT
135
136/* If we *know* page->private refers to buffer_heads */
137#define page_buffers(page) \
138 ({ \
4c21e2f2
HD
139 BUG_ON(!PagePrivate(page)); \
140 ((struct buffer_head *)page_private(page)); \
1da177e4
LT
141 })
142#define page_has_buffers(page) PagePrivate(page)
143
b4597226
MG
144void buffer_check_dirty_writeback(struct page *page,
145 bool *dirty, bool *writeback);
146
1da177e4
LT
147/*
148 * Declarations
149 */
150
b3c97528 151void mark_buffer_dirty(struct buffer_head *bh);
1da177e4 152void init_buffer(struct buffer_head *, bh_end_io_t *, void *);
f0059afd 153void touch_buffer(struct buffer_head *bh);
1da177e4
LT
154void set_bh_page(struct buffer_head *bh,
155 struct page *page, unsigned long offset);
156int try_to_free_buffers(struct page *);
157struct buffer_head *alloc_page_buffers(struct page *page, unsigned long size,
158 int retry);
159void create_empty_buffers(struct page *, unsigned long,
160 unsigned long b_state);
161void end_buffer_read_sync(struct buffer_head *bh, int uptodate);
162void end_buffer_write_sync(struct buffer_head *bh, int uptodate);
35c80d5f 163void end_buffer_async_write(struct buffer_head *bh, int uptodate);
1da177e4
LT
164
165/* Things to do with buffers at mapping->private_list */
166void mark_buffer_dirty_inode(struct buffer_head *bh, struct inode *inode);
167int inode_has_buffers(struct inode *);
168void invalidate_inode_buffers(struct inode *);
169int remove_inode_buffers(struct inode *inode);
170int sync_mapping_buffers(struct address_space *mapping);
171void unmap_underlying_metadata(struct block_device *bdev, sector_t block);
172
173void mark_buffer_async_write(struct buffer_head *bh);
1da177e4
LT
174void __wait_on_buffer(struct buffer_head *);
175wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
3991d3bd
TK
176struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
177 unsigned size);
3b5e6454
GK
178struct buffer_head *__getblk_gfp(struct block_device *bdev, sector_t block,
179 unsigned size, gfp_t gfp);
1da177e4
LT
180void __brelse(struct buffer_head *);
181void __bforget(struct buffer_head *);
3991d3bd 182void __breadahead(struct block_device *, sector_t block, unsigned int size);
3b5e6454
GK
183struct buffer_head *__bread_gfp(struct block_device *,
184 sector_t block, unsigned size, gfp_t gfp);
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);
87e99511 192int __sync_dirty_buffer(struct buffer_head *bh, int rw);
9cb569d6 193void write_dirty_buffer(struct buffer_head *bh, int rw);
71368511 194int _submit_bh(int rw, struct buffer_head *bh, unsigned long bio_flags);
1da177e4
LT
195int submit_bh(int, struct buffer_head *);
196void write_boundary_block(struct block_device *bdev,
197 sector_t bblock, unsigned blocksize);
389d1b08
AK
198int bh_uptodate_or_lock(struct buffer_head *bh);
199int bh_submit_read(struct buffer_head *bh);
1da177e4
LT
200
201extern int buffer_heads_over_limit;
202
203/*
204 * Generic address_space_operations implementations for buffer_head-backed
205 * address_spaces.
206 */
d47992f8
LC
207void block_invalidatepage(struct page *page, unsigned int offset,
208 unsigned int length);
1da177e4
LT
209int block_write_full_page(struct page *page, get_block_t *get_block,
210 struct writeback_control *wbc);
211int block_read_full_page(struct page*, get_block_t*);
c186afb4
AV
212int block_is_partially_uptodate(struct page *page, unsigned long from,
213 unsigned long count);
155130a4
CH
214int block_write_begin(struct address_space *mapping, loff_t pos, unsigned len,
215 unsigned flags, struct page **pagep, get_block_t *get_block);
6e1db88d
CH
216int __block_write_begin(struct page *page, loff_t pos, unsigned len,
217 get_block_t *get_block);
afddba49
NP
218int block_write_end(struct file *, struct address_space *,
219 loff_t, unsigned, unsigned,
220 struct page *, void *);
221int generic_write_end(struct file *, struct address_space *,
222 loff_t, unsigned, unsigned,
223 struct page *, void *);
224void page_zero_new_buffers(struct page *page, unsigned from, unsigned to);
89e10787
NP
225int cont_write_begin(struct file *, struct address_space *, loff_t,
226 unsigned, unsigned, struct page **, void **,
227 get_block_t *, loff_t *);
05eb0b51 228int generic_cont_expand_simple(struct inode *inode, loff_t size);
1da177e4 229int block_commit_write(struct page *page, unsigned from, unsigned to);
24da4fab
JK
230int __block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
231 get_block_t get_block);
c2ec175c 232int block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
54171690 233 get_block_t get_block);
24da4fab
JK
234/* Convert errno to return value from ->page_mkwrite() call */
235static inline int block_page_mkwrite_return(int err)
236{
237 if (err == 0)
238 return VM_FAULT_LOCKED;
239 if (err == -EFAULT)
240 return VM_FAULT_NOPAGE;
241 if (err == -ENOMEM)
242 return VM_FAULT_OOM;
ea13a864
JK
243 if (err == -EAGAIN)
244 return VM_FAULT_RETRY;
24da4fab
JK
245 /* -ENOSPC, -EDQUOT, -EIO ... */
246 return VM_FAULT_SIGBUS;
247}
1da177e4 248sector_t generic_block_bmap(struct address_space *, sector_t, get_block_t *);
1da177e4 249int block_truncate_page(struct address_space *, loff_t, get_block_t *);
ea0f04e5 250int nobh_write_begin(struct address_space *, loff_t, unsigned, unsigned,
03158cd7
NP
251 struct page **, void **, get_block_t*);
252int nobh_write_end(struct file *, struct address_space *,
253 loff_t, unsigned, unsigned,
254 struct page *, void *);
255int nobh_truncate_page(struct address_space *, loff_t, get_block_t *);
1da177e4
LT
256int nobh_writepage(struct page *page, get_block_t *get_block,
257 struct writeback_control *wbc);
258
b6cd0b77 259void buffer_init(void);
1da177e4
LT
260
261/*
262 * inline definitions
263 */
264
265static inline void attach_page_buffers(struct page *page,
266 struct buffer_head *head)
267{
268 page_cache_get(page);
269 SetPagePrivate(page);
4c21e2f2 270 set_page_private(page, (unsigned long)head);
1da177e4
LT
271}
272
273static inline void get_bh(struct buffer_head *bh)
274{
275 atomic_inc(&bh->b_count);
276}
277
278static inline void put_bh(struct buffer_head *bh)
279{
4e857c58 280 smp_mb__before_atomic();
1da177e4
LT
281 atomic_dec(&bh->b_count);
282}
283
284static inline void brelse(struct buffer_head *bh)
285{
286 if (bh)
287 __brelse(bh);
288}
289
290static inline void bforget(struct buffer_head *bh)
291{
292 if (bh)
293 __bforget(bh);
294}
295
296static inline struct buffer_head *
297sb_bread(struct super_block *sb, sector_t block)
298{
3b5e6454
GK
299 return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
300}
301
302static inline struct buffer_head *
303sb_bread_unmovable(struct super_block *sb, sector_t block)
304{
305 return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, 0);
1da177e4
LT
306}
307
308static inline void
309sb_breadahead(struct super_block *sb, sector_t block)
310{
311 __breadahead(sb->s_bdev, block, sb->s_blocksize);
312}
313
314static inline struct buffer_head *
315sb_getblk(struct super_block *sb, sector_t block)
316{
3b5e6454 317 return __getblk_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
1da177e4
LT
318}
319
bd7ade3c
NB
320
321static inline struct buffer_head *
322sb_getblk_gfp(struct super_block *sb, sector_t block, gfp_t gfp)
323{
324 return __getblk_gfp(sb->s_bdev, block, sb->s_blocksize, gfp);
325}
326
1da177e4
LT
327static inline struct buffer_head *
328sb_find_get_block(struct super_block *sb, sector_t block)
329{
330 return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
331}
332
333static inline void
334map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
335{
336 set_buffer_mapped(bh);
337 bh->b_bdev = sb->s_bdev;
338 bh->b_blocknr = block;
b0cf2321 339 bh->b_size = sb->s_blocksize;
1da177e4
LT
340}
341
1da177e4
LT
342static inline void wait_on_buffer(struct buffer_head *bh)
343{
344 might_sleep();
a9877cc2 345 if (buffer_locked(bh))
1da177e4
LT
346 __wait_on_buffer(bh);
347}
348
ca5de404
NP
349static inline int trylock_buffer(struct buffer_head *bh)
350{
51b07fc3 351 return likely(!test_and_set_bit_lock(BH_Lock, &bh->b_state));
ca5de404
NP
352}
353
1da177e4
LT
354static inline void lock_buffer(struct buffer_head *bh)
355{
356 might_sleep();
ca5de404 357 if (!trylock_buffer(bh))
1da177e4
LT
358 __lock_buffer(bh);
359}
360
3b5e6454
GK
361static inline struct buffer_head *getblk_unmovable(struct block_device *bdev,
362 sector_t block,
363 unsigned size)
364{
365 return __getblk_gfp(bdev, block, size, 0);
366}
367
368static inline struct buffer_head *__getblk(struct block_device *bdev,
369 sector_t block,
370 unsigned size)
371{
372 return __getblk_gfp(bdev, block, size, __GFP_MOVABLE);
373}
374
375/**
376 * __bread() - reads a specified block and returns the bh
377 * @bdev: the block_device to read from
378 * @block: number of block
379 * @size: size (in bytes) to read
380 *
381 * Reads a specified block, and returns buffer head that contains it.
382 * The page cache is allocated from movable area so that it can be migrated.
383 * It returns NULL if the block was unreadable.
384 */
385static inline struct buffer_head *
386__bread(struct block_device *bdev, sector_t block, unsigned size)
387{
388 return __bread_gfp(bdev, block, size, __GFP_MOVABLE);
389}
390
cf9a2ae8 391extern int __set_page_dirty_buffers(struct page *page);
9361401e
DH
392
393#else /* CONFIG_BLOCK */
394
395static inline void buffer_init(void) {}
396static inline int try_to_free_buffers(struct page *page) { return 1; }
9361401e
DH
397static inline int inode_has_buffers(struct inode *inode) { return 0; }
398static inline void invalidate_inode_buffers(struct inode *inode) {}
399static inline int remove_inode_buffers(struct inode *inode) { return 1; }
400static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
9361401e
DH
401
402#endif /* CONFIG_BLOCK */
1da177e4 403#endif /* _LINUX_BUFFER_HEAD_H */