1
2
3
4
5
6#ifndef __XFS_BUF_H__
7#define __XFS_BUF_H__
8
9#include <linux/list.h>
10#include <linux/types.h>
11#include <linux/spinlock.h>
12#include <linux/mm.h>
13#include <linux/fs.h>
14#include <linux/dax.h>
15#include <linux/uio.h>
16#include <linux/list_lru.h>
17
18
19
20
21
22#define XFS_BUF_DADDR_NULL ((xfs_daddr_t) (-1LL))
23
24typedef enum {
25 XBRW_READ = 1,
26 XBRW_WRITE = 2,
27 XBRW_ZERO = 3,
28} xfs_buf_rw_t;
29
30#define XBF_READ (1 << 0)
31#define XBF_WRITE (1 << 1)
32#define XBF_READ_AHEAD (1 << 2)
33#define XBF_NO_IOACCT (1 << 3)
34#define XBF_ASYNC (1 << 4)
35#define XBF_DONE (1 << 5)
36#define XBF_STALE (1 << 6)
37#define XBF_WRITE_FAIL (1 << 24)
38
39
40#define XBF_SYNCIO (1 << 10)
41#define XBF_FUA (1 << 11)
42#define XBF_FLUSH (1 << 12)
43
44
45#define XBF_TRYLOCK (1 << 16)
46#define XBF_UNMAPPED (1 << 17)
47
48
49#define _XBF_PAGES (1 << 20)
50#define _XBF_KMEM (1 << 21)
51#define _XBF_DELWRI_Q (1 << 22)
52#define _XBF_COMPOUND (1 << 23)
53
54typedef unsigned int xfs_buf_flags_t;
55
56#define XFS_BUF_FLAGS \
57 { XBF_READ, "READ" }, \
58 { XBF_WRITE, "WRITE" }, \
59 { XBF_READ_AHEAD, "READ_AHEAD" }, \
60 { XBF_NO_IOACCT, "NO_IOACCT" }, \
61 { XBF_ASYNC, "ASYNC" }, \
62 { XBF_DONE, "DONE" }, \
63 { XBF_STALE, "STALE" }, \
64 { XBF_WRITE_FAIL, "WRITE_FAIL" }, \
65 { XBF_SYNCIO, "SYNCIO" }, \
66 { XBF_FUA, "FUA" }, \
67 { XBF_FLUSH, "FLUSH" }, \
68 { XBF_TRYLOCK, "TRYLOCK" }, \
69 { XBF_UNMAPPED, "UNMAPPED" }, \
70 { _XBF_PAGES, "PAGES" }, \
71 { _XBF_KMEM, "KMEM" }, \
72 { _XBF_DELWRI_Q, "DELWRI_Q" }, \
73 { _XBF_COMPOUND, "COMPOUND" }
74
75
76
77
78
79#define XFS_BSTATE_DISPOSE (1 << 0)
80#define XFS_BSTATE_IN_FLIGHT (1 << 1)
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95typedef struct xfs_buftarg {
96 dev_t bt_dev;
97 struct block_device *bt_bdev;
98 struct dax_device *bt_daxdev;
99 struct xfs_mount *bt_mount;
100 unsigned int bt_meta_sectorsize;
101 size_t bt_meta_sectormask;
102 size_t bt_logical_sectorsize;
103 size_t bt_logical_sectormask;
104
105
106 struct shrinker bt_shrinker;
107 struct list_lru bt_lru;
108
109 struct percpu_counter bt_io_count;
110} xfs_buftarg_t;
111
112struct xfs_buf;
113typedef void (*xfs_buf_iodone_t)(struct xfs_buf *);
114
115
116#define XB_PAGES 2
117
118struct xfs_buf_map {
119 xfs_daddr_t bm_bn;
120 int bm_len;
121};
122
123#define DEFINE_SINGLE_BUF_MAP(map, blkno, numblk) \
124 struct xfs_buf_map (map) = { .bm_bn = (blkno), .bm_len = (numblk) };
125
126struct xfs_buf_ops {
127 char *name;
128 void (*verify_read)(struct xfs_buf *);
129 void (*verify_write)(struct xfs_buf *);
130 xfs_failaddr_t (*verify_struct)(struct xfs_buf *bp);
131};
132
133typedef struct xfs_buf {
134
135
136
137
138
139
140
141 struct rhash_head b_rhash_head;
142 xfs_daddr_t b_bn;
143 int b_length;
144 atomic_t b_hold;
145 atomic_t b_lru_ref;
146 xfs_buf_flags_t b_flags;
147 struct semaphore b_sema;
148
149
150
151
152
153 struct list_head b_lru;
154 spinlock_t b_lock;
155 unsigned int b_state;
156 int b_io_error;
157 wait_queue_head_t b_waiters;
158 struct list_head b_list;
159 struct xfs_perag *b_pag;
160 xfs_buftarg_t *b_target;
161 void *b_addr;
162 struct work_struct b_ioend_work;
163 struct workqueue_struct *b_ioend_wq;
164 xfs_buf_iodone_t b_iodone;
165 struct completion b_iowait;
166 void *b_log_item;
167 struct list_head b_li_list;
168 struct xfs_trans *b_transp;
169 struct page **b_pages;
170 struct page *b_page_array[XB_PAGES];
171 struct xfs_buf_map *b_maps;
172 struct xfs_buf_map __b_map;
173 int b_map_count;
174 int b_io_length;
175 atomic_t b_pin_count;
176 atomic_t b_io_remaining;
177 unsigned int b_page_count;
178 unsigned int b_offset;
179 int b_error;
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196 int b_retries;
197 unsigned long b_first_retry_time;
198 int b_last_error;
199
200 const struct xfs_buf_ops *b_ops;
201} xfs_buf_t;
202
203
204struct xfs_buf *xfs_buf_incore(struct xfs_buftarg *target,
205 xfs_daddr_t blkno, size_t numblks,
206 xfs_buf_flags_t flags);
207
208struct xfs_buf *_xfs_buf_alloc(struct xfs_buftarg *target,
209 struct xfs_buf_map *map, int nmaps,
210 xfs_buf_flags_t flags);
211
212static inline struct xfs_buf *
213xfs_buf_alloc(
214 struct xfs_buftarg *target,
215 xfs_daddr_t blkno,
216 size_t numblks,
217 xfs_buf_flags_t flags)
218{
219 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
220 return _xfs_buf_alloc(target, &map, 1, flags);
221}
222
223struct xfs_buf *xfs_buf_get_map(struct xfs_buftarg *target,
224 struct xfs_buf_map *map, int nmaps,
225 xfs_buf_flags_t flags);
226struct xfs_buf *xfs_buf_read_map(struct xfs_buftarg *target,
227 struct xfs_buf_map *map, int nmaps,
228 xfs_buf_flags_t flags,
229 const struct xfs_buf_ops *ops);
230void xfs_buf_readahead_map(struct xfs_buftarg *target,
231 struct xfs_buf_map *map, int nmaps,
232 const struct xfs_buf_ops *ops);
233
234static inline struct xfs_buf *
235xfs_buf_get(
236 struct xfs_buftarg *target,
237 xfs_daddr_t blkno,
238 size_t numblks,
239 xfs_buf_flags_t flags)
240{
241 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
242 return xfs_buf_get_map(target, &map, 1, flags);
243}
244
245static inline struct xfs_buf *
246xfs_buf_read(
247 struct xfs_buftarg *target,
248 xfs_daddr_t blkno,
249 size_t numblks,
250 xfs_buf_flags_t flags,
251 const struct xfs_buf_ops *ops)
252{
253 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
254 return xfs_buf_read_map(target, &map, 1, flags, ops);
255}
256
257static inline void
258xfs_buf_readahead(
259 struct xfs_buftarg *target,
260 xfs_daddr_t blkno,
261 size_t numblks,
262 const struct xfs_buf_ops *ops)
263{
264 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
265 return xfs_buf_readahead_map(target, &map, 1, ops);
266}
267
268void xfs_buf_set_empty(struct xfs_buf *bp, size_t numblks);
269int xfs_buf_associate_memory(struct xfs_buf *bp, void *mem, size_t length);
270
271struct xfs_buf *xfs_buf_get_uncached(struct xfs_buftarg *target, size_t numblks,
272 int flags);
273int xfs_buf_read_uncached(struct xfs_buftarg *target, xfs_daddr_t daddr,
274 size_t numblks, int flags, struct xfs_buf **bpp,
275 const struct xfs_buf_ops *ops);
276void xfs_buf_hold(struct xfs_buf *bp);
277
278
279extern void xfs_buf_free(xfs_buf_t *);
280extern void xfs_buf_rele(xfs_buf_t *);
281
282
283extern int xfs_buf_trylock(xfs_buf_t *);
284extern void xfs_buf_lock(xfs_buf_t *);
285extern void xfs_buf_unlock(xfs_buf_t *);
286#define xfs_buf_islocked(bp) \
287 ((bp)->b_sema.count <= 0)
288
289
290extern int xfs_bwrite(struct xfs_buf *bp);
291extern void xfs_buf_ioend(struct xfs_buf *bp);
292extern void __xfs_buf_ioerror(struct xfs_buf *bp, int error,
293 xfs_failaddr_t failaddr);
294#define xfs_buf_ioerror(bp, err) __xfs_buf_ioerror((bp), (err), __this_address)
295extern void xfs_buf_ioerror_alert(struct xfs_buf *, const char *func);
296
297extern int __xfs_buf_submit(struct xfs_buf *bp, bool);
298static inline int xfs_buf_submit(struct xfs_buf *bp)
299{
300 bool wait = bp->b_flags & XBF_ASYNC ? false : true;
301 return __xfs_buf_submit(bp, wait);
302}
303
304extern void xfs_buf_iomove(xfs_buf_t *, size_t, size_t, void *,
305 xfs_buf_rw_t);
306#define xfs_buf_zero(bp, off, len) \
307 xfs_buf_iomove((bp), (off), (len), NULL, XBRW_ZERO)
308
309
310extern void *xfs_buf_offset(struct xfs_buf *, size_t);
311extern void xfs_buf_stale(struct xfs_buf *bp);
312
313
314extern void xfs_buf_delwri_cancel(struct list_head *);
315extern bool xfs_buf_delwri_queue(struct xfs_buf *, struct list_head *);
316extern int xfs_buf_delwri_submit(struct list_head *);
317extern int xfs_buf_delwri_submit_nowait(struct list_head *);
318extern int xfs_buf_delwri_pushbuf(struct xfs_buf *, struct list_head *);
319
320
321extern int xfs_buf_init(void);
322extern void xfs_buf_terminate(void);
323
324
325
326
327
328
329
330
331
332
333
334#define XFS_BUF_ADDR(bp) ((bp)->b_maps[0].bm_bn)
335#define XFS_BUF_SET_ADDR(bp, bno) ((bp)->b_maps[0].bm_bn = (xfs_daddr_t)(bno))
336
337void xfs_buf_set_ref(struct xfs_buf *bp, int lru_ref);
338
339
340
341
342
343
344static inline void xfs_buf_oneshot(struct xfs_buf *bp)
345{
346 if (!list_empty(&bp->b_lru) || atomic_read(&bp->b_lru_ref) > 1)
347 return;
348 atomic_set(&bp->b_lru_ref, 0);
349}
350
351static inline int xfs_buf_ispinned(struct xfs_buf *bp)
352{
353 return atomic_read(&bp->b_pin_count);
354}
355
356static inline void xfs_buf_relse(xfs_buf_t *bp)
357{
358 xfs_buf_unlock(bp);
359 xfs_buf_rele(bp);
360}
361
362static inline int
363xfs_buf_verify_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
364{
365 return xfs_verify_cksum(bp->b_addr, BBTOB(bp->b_length),
366 cksum_offset);
367}
368
369static inline void
370xfs_buf_update_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
371{
372 xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length),
373 cksum_offset);
374}
375
376
377
378
379extern xfs_buftarg_t *xfs_alloc_buftarg(struct xfs_mount *,
380 struct block_device *, struct dax_device *);
381extern void xfs_free_buftarg(struct xfs_buftarg *);
382extern void xfs_wait_buftarg(xfs_buftarg_t *);
383extern int xfs_setsize_buftarg(xfs_buftarg_t *, unsigned int);
384
385#define xfs_getsize_buftarg(buftarg) block_size((buftarg)->bt_bdev)
386#define xfs_readonly_buftarg(buftarg) bdev_read_only((buftarg)->bt_bdev)
387
388int xfs_buf_ensure_ops(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
389
390#endif
391