Merge tag 'xfs-4.13-merge-5' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[muen/linux.git] / include / linux / buffer_head.h
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 <linux/atomic.h>
16
17 #ifdef CONFIG_BLOCK
18
19 enum 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 */
24         BH_Uptodate_Lock,/* Used by the first bh in a page, to serialise
25                           * IO completion of other buffers in the page
26                           */
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_Unwritten,   /* Buffer is allocated on disk but not written */
36         BH_Quiet,       /* Buffer Error Prinks to be quiet */
37         BH_Meta,        /* Buffer contains metadata */
38         BH_Prio,        /* Buffer should be submitted with REQ_PRIO */
39         BH_Defer_Completion, /* Defer AIO completion to workqueue */
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_SIZE / 512)
47
48 struct page;
49 struct buffer_head;
50 struct address_space;
51 typedef void (bh_end_io_t)(struct buffer_head *bh, int uptodate);
52
53 /*
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).
61  */
62 struct buffer_head {
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 */
66
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 */
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 */
75         struct address_space *b_assoc_map;      /* mapping this buffer is
76                                                    associated with */
77         atomic_t b_count;               /* users using this buffer_head */
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)                                           \
85 static __always_inline void set_buffer_##name(struct buffer_head *bh)   \
86 {                                                                       \
87         set_bit(BH_##bit, &(bh)->b_state);                              \
88 }                                                                       \
89 static __always_inline void clear_buffer_##name(struct buffer_head *bh) \
90 {                                                                       \
91         clear_bit(BH_##bit, &(bh)->b_state);                            \
92 }                                                                       \
93 static __always_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)                                       \
102 static __always_inline int test_set_buffer_##name(struct buffer_head *bh) \
103 {                                                                       \
104         return test_and_set_bit(BH_##bit, &(bh)->b_state);              \
105 }                                                                       \
106 static __always_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  */
116 BUFFER_FNS(Uptodate, uptodate)
117 BUFFER_FNS(Dirty, dirty)
118 TAS_BUFFER_FNS(Dirty, dirty)
119 BUFFER_FNS(Lock, locked)
120 BUFFER_FNS(Req, req)
121 TAS_BUFFER_FNS(Req, req)
122 BUFFER_FNS(Mapped, mapped)
123 BUFFER_FNS(New, new)
124 BUFFER_FNS(Async_Read, async_read)
125 BUFFER_FNS(Async_Write, async_write)
126 BUFFER_FNS(Delay, delay)
127 BUFFER_FNS(Boundary, boundary)
128 BUFFER_FNS(Write_EIO, write_io_error)
129 BUFFER_FNS(Unwritten, unwritten)
130 BUFFER_FNS(Meta, meta)
131 BUFFER_FNS(Prio, prio)
132 BUFFER_FNS(Defer_Completion, defer_completion)
133
134 #define bh_offset(bh)           ((unsigned long)(bh)->b_data & ~PAGE_MASK)
135
136 /* If we *know* page->private refers to buffer_heads */
137 #define page_buffers(page)                                      \
138         ({                                                      \
139                 BUG_ON(!PagePrivate(page));                     \
140                 ((struct buffer_head *)page_private(page));     \
141         })
142 #define page_has_buffers(page)  PagePrivate(page)
143
144 void buffer_check_dirty_writeback(struct page *page,
145                                      bool *dirty, bool *writeback);
146
147 /*
148  * Declarations
149  */
150
151 void mark_buffer_dirty(struct buffer_head *bh);
152 void mark_buffer_write_io_error(struct buffer_head *bh);
153 void init_buffer(struct buffer_head *, bh_end_io_t *, void *);
154 void touch_buffer(struct buffer_head *bh);
155 void set_bh_page(struct buffer_head *bh,
156                 struct page *page, unsigned long offset);
157 int try_to_free_buffers(struct page *);
158 struct buffer_head *alloc_page_buffers(struct page *page, unsigned long size,
159                 int retry);
160 void create_empty_buffers(struct page *, unsigned long,
161                         unsigned long b_state);
162 void end_buffer_read_sync(struct buffer_head *bh, int uptodate);
163 void end_buffer_write_sync(struct buffer_head *bh, int uptodate);
164 void end_buffer_async_write(struct buffer_head *bh, int uptodate);
165
166 /* Things to do with buffers at mapping->private_list */
167 void mark_buffer_dirty_inode(struct buffer_head *bh, struct inode *inode);
168 int inode_has_buffers(struct inode *);
169 void invalidate_inode_buffers(struct inode *);
170 int remove_inode_buffers(struct inode *inode);
171 int sync_mapping_buffers(struct address_space *mapping);
172 void clean_bdev_aliases(struct block_device *bdev, sector_t block,
173                         sector_t len);
174 static inline void clean_bdev_bh_alias(struct buffer_head *bh)
175 {
176         clean_bdev_aliases(bh->b_bdev, bh->b_blocknr, 1);
177 }
178
179 void mark_buffer_async_write(struct buffer_head *bh);
180 void __wait_on_buffer(struct buffer_head *);
181 wait_queue_head_t *bh_waitq_head(struct buffer_head *bh);
182 struct buffer_head *__find_get_block(struct block_device *bdev, sector_t block,
183                         unsigned size);
184 struct buffer_head *__getblk_gfp(struct block_device *bdev, sector_t block,
185                                   unsigned size, gfp_t gfp);
186 void __brelse(struct buffer_head *);
187 void __bforget(struct buffer_head *);
188 void __breadahead(struct block_device *, sector_t block, unsigned int size);
189 struct buffer_head *__bread_gfp(struct block_device *,
190                                 sector_t block, unsigned size, gfp_t gfp);
191 void invalidate_bh_lrus(void);
192 struct buffer_head *alloc_buffer_head(gfp_t gfp_flags);
193 void free_buffer_head(struct buffer_head * bh);
194 void unlock_buffer(struct buffer_head *bh);
195 void __lock_buffer(struct buffer_head *bh);
196 void ll_rw_block(int, int, int, struct buffer_head * bh[]);
197 int sync_dirty_buffer(struct buffer_head *bh);
198 int __sync_dirty_buffer(struct buffer_head *bh, int op_flags);
199 void write_dirty_buffer(struct buffer_head *bh, int op_flags);
200 int submit_bh(int, int, struct buffer_head *);
201 void write_boundary_block(struct block_device *bdev,
202                         sector_t bblock, unsigned blocksize);
203 int bh_uptodate_or_lock(struct buffer_head *bh);
204 int bh_submit_read(struct buffer_head *bh);
205 loff_t page_cache_seek_hole_data(struct inode *inode, loff_t offset,
206                                  loff_t length, int whence);
207
208 extern int buffer_heads_over_limit;
209
210 /*
211  * Generic address_space_operations implementations for buffer_head-backed
212  * address_spaces.
213  */
214 void block_invalidatepage(struct page *page, unsigned int offset,
215                           unsigned int length);
216 int block_write_full_page(struct page *page, get_block_t *get_block,
217                                 struct writeback_control *wbc);
218 int __block_write_full_page(struct inode *inode, struct page *page,
219                         get_block_t *get_block, struct writeback_control *wbc,
220                         bh_end_io_t *handler);
221 int block_read_full_page(struct page*, get_block_t*);
222 int block_is_partially_uptodate(struct page *page, unsigned long from,
223                                 unsigned long count);
224 int block_write_begin(struct address_space *mapping, loff_t pos, unsigned len,
225                 unsigned flags, struct page **pagep, get_block_t *get_block);
226 int __block_write_begin(struct page *page, loff_t pos, unsigned len,
227                 get_block_t *get_block);
228 int block_write_end(struct file *, struct address_space *,
229                                 loff_t, unsigned, unsigned,
230                                 struct page *, void *);
231 int generic_write_end(struct file *, struct address_space *,
232                                 loff_t, unsigned, unsigned,
233                                 struct page *, void *);
234 void page_zero_new_buffers(struct page *page, unsigned from, unsigned to);
235 int cont_write_begin(struct file *, struct address_space *, loff_t,
236                         unsigned, unsigned, struct page **, void **,
237                         get_block_t *, loff_t *);
238 int generic_cont_expand_simple(struct inode *inode, loff_t size);
239 int block_commit_write(struct page *page, unsigned from, unsigned to);
240 int block_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
241                                 get_block_t get_block);
242 /* Convert errno to return value from ->page_mkwrite() call */
243 static inline int block_page_mkwrite_return(int err)
244 {
245         if (err == 0)
246                 return VM_FAULT_LOCKED;
247         if (err == -EFAULT || err == -EAGAIN)
248                 return VM_FAULT_NOPAGE;
249         if (err == -ENOMEM)
250                 return VM_FAULT_OOM;
251         /* -ENOSPC, -EDQUOT, -EIO ... */
252         return VM_FAULT_SIGBUS;
253 }
254 sector_t generic_block_bmap(struct address_space *, sector_t, get_block_t *);
255 int block_truncate_page(struct address_space *, loff_t, get_block_t *);
256 int nobh_write_begin(struct address_space *, loff_t, unsigned, unsigned,
257                                 struct page **, void **, get_block_t*);
258 int nobh_write_end(struct file *, struct address_space *,
259                                 loff_t, unsigned, unsigned,
260                                 struct page *, void *);
261 int nobh_truncate_page(struct address_space *, loff_t, get_block_t *);
262 int nobh_writepage(struct page *page, get_block_t *get_block,
263                         struct writeback_control *wbc);
264
265 void buffer_init(void);
266
267 /*
268  * inline definitions
269  */
270
271 static inline void attach_page_buffers(struct page *page,
272                 struct buffer_head *head)
273 {
274         get_page(page);
275         SetPagePrivate(page);
276         set_page_private(page, (unsigned long)head);
277 }
278
279 static inline void get_bh(struct buffer_head *bh)
280 {
281         atomic_inc(&bh->b_count);
282 }
283
284 static inline void put_bh(struct buffer_head *bh)
285 {
286         smp_mb__before_atomic();
287         atomic_dec(&bh->b_count);
288 }
289
290 static inline void brelse(struct buffer_head *bh)
291 {
292         if (bh)
293                 __brelse(bh);
294 }
295
296 static inline void bforget(struct buffer_head *bh)
297 {
298         if (bh)
299                 __bforget(bh);
300 }
301
302 static inline struct buffer_head *
303 sb_bread(struct super_block *sb, sector_t block)
304 {
305         return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
306 }
307
308 static inline struct buffer_head *
309 sb_bread_unmovable(struct super_block *sb, sector_t block)
310 {
311         return __bread_gfp(sb->s_bdev, block, sb->s_blocksize, 0);
312 }
313
314 static inline void
315 sb_breadahead(struct super_block *sb, sector_t block)
316 {
317         __breadahead(sb->s_bdev, block, sb->s_blocksize);
318 }
319
320 static inline struct buffer_head *
321 sb_getblk(struct super_block *sb, sector_t block)
322 {
323         return __getblk_gfp(sb->s_bdev, block, sb->s_blocksize, __GFP_MOVABLE);
324 }
325
326
327 static inline struct buffer_head *
328 sb_getblk_gfp(struct super_block *sb, sector_t block, gfp_t gfp)
329 {
330         return __getblk_gfp(sb->s_bdev, block, sb->s_blocksize, gfp);
331 }
332
333 static inline struct buffer_head *
334 sb_find_get_block(struct super_block *sb, sector_t block)
335 {
336         return __find_get_block(sb->s_bdev, block, sb->s_blocksize);
337 }
338
339 static inline void
340 map_bh(struct buffer_head *bh, struct super_block *sb, sector_t block)
341 {
342         set_buffer_mapped(bh);
343         bh->b_bdev = sb->s_bdev;
344         bh->b_blocknr = block;
345         bh->b_size = sb->s_blocksize;
346 }
347
348 static inline void wait_on_buffer(struct buffer_head *bh)
349 {
350         might_sleep();
351         if (buffer_locked(bh))
352                 __wait_on_buffer(bh);
353 }
354
355 static inline int trylock_buffer(struct buffer_head *bh)
356 {
357         return likely(!test_and_set_bit_lock(BH_Lock, &bh->b_state));
358 }
359
360 static inline void lock_buffer(struct buffer_head *bh)
361 {
362         might_sleep();
363         if (!trylock_buffer(bh))
364                 __lock_buffer(bh);
365 }
366
367 static inline struct buffer_head *getblk_unmovable(struct block_device *bdev,
368                                                    sector_t block,
369                                                    unsigned size)
370 {
371         return __getblk_gfp(bdev, block, size, 0);
372 }
373
374 static inline struct buffer_head *__getblk(struct block_device *bdev,
375                                            sector_t block,
376                                            unsigned size)
377 {
378         return __getblk_gfp(bdev, block, size, __GFP_MOVABLE);
379 }
380
381 /**
382  *  __bread() - reads a specified block and returns the bh
383  *  @bdev: the block_device to read from
384  *  @block: number of block
385  *  @size: size (in bytes) to read
386  *
387  *  Reads a specified block, and returns buffer head that contains it.
388  *  The page cache is allocated from movable area so that it can be migrated.
389  *  It returns NULL if the block was unreadable.
390  */
391 static inline struct buffer_head *
392 __bread(struct block_device *bdev, sector_t block, unsigned size)
393 {
394         return __bread_gfp(bdev, block, size, __GFP_MOVABLE);
395 }
396
397 extern int __set_page_dirty_buffers(struct page *page);
398
399 #else /* CONFIG_BLOCK */
400
401 static inline void buffer_init(void) {}
402 static inline int try_to_free_buffers(struct page *page) { return 1; }
403 static inline int inode_has_buffers(struct inode *inode) { return 0; }
404 static inline void invalidate_inode_buffers(struct inode *inode) {}
405 static inline int remove_inode_buffers(struct inode *inode) { return 1; }
406 static inline int sync_mapping_buffers(struct address_space *mapping) { return 0; }
407
408 #endif /* CONFIG_BLOCK */
409 #endif /* _LINUX_BUFFER_HEAD_H */