Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
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
18extern struct kmem_cache *xfs_buf_cache;
19
20/*
21 * Base types
22 */
23struct xfs_buf;
24
25#define XFS_BUF_DADDR_NULL ((xfs_daddr_t) (-1LL))
26
27#define XBF_READ (1u << 0) /* buffer intended for reading from device */
28#define XBF_WRITE (1u << 1) /* buffer intended for writing to device */
29#define XBF_READ_AHEAD (1u << 2) /* asynchronous read-ahead */
30#define XBF_NO_IOACCT (1u << 3) /* bypass I/O accounting (non-LRU bufs) */
31#define XBF_ASYNC (1u << 4) /* initiator will not wait for completion */
32#define XBF_DONE (1u << 5) /* all pages in the buffer uptodate */
33#define XBF_STALE (1u << 6) /* buffer has been staled, do not find it */
34#define XBF_WRITE_FAIL (1u << 7) /* async writes have failed on this buffer */
35
36/* buffer type flags for write callbacks */
37#define _XBF_INODES (1u << 16)/* inode buffer */
38#define _XBF_DQUOTS (1u << 17)/* dquot buffer */
39#define _XBF_LOGRECOVERY (1u << 18)/* log recovery buffer */
40
41/* flags used only internally */
42#define _XBF_PAGES (1u << 20)/* backed by refcounted pages */
43#define _XBF_KMEM (1u << 21)/* backed by heap memory */
44#define _XBF_DELWRI_Q (1u << 22)/* buffer on a delwri queue */
45
46/* flags used only as arguments to access routines */
47/*
48 * Online fsck is scanning the buffer cache for live buffers. Do not warn
49 * about length mismatches during lookups and do not return stale buffers.
50 */
51#define XBF_LIVESCAN (1u << 28)
52#define XBF_INCORE (1u << 29)/* lookup only, return if found in cache */
53#define XBF_TRYLOCK (1u << 30)/* lock requested, but do not wait */
54#define XBF_UNMAPPED (1u << 31)/* do not map the buffer */
55
56
57typedef unsigned int xfs_buf_flags_t;
58
59#define XFS_BUF_FLAGS \
60 { XBF_READ, "READ" }, \
61 { XBF_WRITE, "WRITE" }, \
62 { XBF_READ_AHEAD, "READ_AHEAD" }, \
63 { XBF_NO_IOACCT, "NO_IOACCT" }, \
64 { XBF_ASYNC, "ASYNC" }, \
65 { XBF_DONE, "DONE" }, \
66 { XBF_STALE, "STALE" }, \
67 { XBF_WRITE_FAIL, "WRITE_FAIL" }, \
68 { _XBF_INODES, "INODES" }, \
69 { _XBF_DQUOTS, "DQUOTS" }, \
70 { _XBF_LOGRECOVERY, "LOG_RECOVERY" }, \
71 { _XBF_PAGES, "PAGES" }, \
72 { _XBF_KMEM, "KMEM" }, \
73 { _XBF_DELWRI_Q, "DELWRI_Q" }, \
74 /* The following interface flags should never be set */ \
75 { XBF_LIVESCAN, "LIVESCAN" }, \
76 { XBF_INCORE, "INCORE" }, \
77 { XBF_TRYLOCK, "TRYLOCK" }, \
78 { XBF_UNMAPPED, "UNMAPPED" }
79
80/*
81 * Internal state flags.
82 */
83#define XFS_BSTATE_DISPOSE (1 << 0) /* buffer being discarded */
84#define XFS_BSTATE_IN_FLIGHT (1 << 1) /* I/O in flight */
85
86struct xfs_buf_cache {
87 spinlock_t bc_lock;
88 struct rhashtable bc_hash;
89};
90
91int xfs_buf_cache_init(struct xfs_buf_cache *bch);
92void xfs_buf_cache_destroy(struct xfs_buf_cache *bch);
93
94/*
95 * The xfs_buftarg contains 2 notions of "sector size" -
96 *
97 * 1) The metadata sector size, which is the minimum unit and
98 * alignment of IO which will be performed by metadata operations.
99 * 2) The device logical sector size
100 *
101 * The first is specified at mkfs time, and is stored on-disk in the
102 * superblock's sb_sectsize.
103 *
104 * The latter is derived from the underlying device, and controls direct IO
105 * alignment constraints.
106 */
107struct xfs_buftarg {
108 dev_t bt_dev;
109 struct file *bt_bdev_file;
110 struct block_device *bt_bdev;
111 struct dax_device *bt_daxdev;
112 struct file *bt_file;
113 u64 bt_dax_part_off;
114 struct xfs_mount *bt_mount;
115 unsigned int bt_meta_sectorsize;
116 size_t bt_meta_sectormask;
117 size_t bt_logical_sectorsize;
118 size_t bt_logical_sectormask;
119
120 /* LRU control structures */
121 struct shrinker *bt_shrinker;
122 struct list_lru bt_lru;
123
124 struct percpu_counter bt_io_count;
125 struct ratelimit_state bt_ioerror_rl;
126
127 /* Atomic write unit values */
128 unsigned int bt_bdev_awu_min;
129 unsigned int bt_bdev_awu_max;
130
131 /* built-in cache, if we're not using the perag one */
132 struct xfs_buf_cache bt_cache[];
133};
134
135#define XB_PAGES 2
136
137struct xfs_buf_map {
138 xfs_daddr_t bm_bn; /* block number for I/O */
139 int bm_len; /* size of I/O */
140 unsigned int bm_flags;
141};
142
143/*
144 * Online fsck is scanning the buffer cache for live buffers. Do not warn
145 * about length mismatches during lookups and do not return stale buffers.
146 */
147#define XBM_LIVESCAN (1U << 0)
148
149#define DEFINE_SINGLE_BUF_MAP(map, blkno, numblk) \
150 struct xfs_buf_map (map) = { .bm_bn = (blkno), .bm_len = (numblk) };
151
152struct xfs_buf_ops {
153 char *name;
154 union {
155 __be32 magic[2]; /* v4 and v5 on disk magic values */
156 __be16 magic16[2]; /* v4 and v5 on disk magic values */
157 };
158 void (*verify_read)(struct xfs_buf *);
159 void (*verify_write)(struct xfs_buf *);
160 xfs_failaddr_t (*verify_struct)(struct xfs_buf *bp);
161};
162
163struct xfs_buf {
164 /*
165 * first cacheline holds all the fields needed for an uncontended cache
166 * hit to be fully processed. The semaphore straddles the cacheline
167 * boundary, but the counter and lock sits on the first cacheline,
168 * which is the only bit that is touched if we hit the semaphore
169 * fast-path on locking.
170 */
171 struct rhash_head b_rhash_head; /* pag buffer hash node */
172
173 xfs_daddr_t b_rhash_key; /* buffer cache index */
174 int b_length; /* size of buffer in BBs */
175 atomic_t b_hold; /* reference count */
176 atomic_t b_lru_ref; /* lru reclaim ref count */
177 xfs_buf_flags_t b_flags; /* status flags */
178 struct semaphore b_sema; /* semaphore for lockables */
179
180 /*
181 * concurrent access to b_lru and b_lru_flags are protected by
182 * bt_lru_lock and not by b_sema
183 */
184 struct list_head b_lru; /* lru list */
185 spinlock_t b_lock; /* internal state lock */
186 unsigned int b_state; /* internal state flags */
187 int b_io_error; /* internal IO error state */
188 wait_queue_head_t b_waiters; /* unpin waiters */
189 struct list_head b_list;
190 struct xfs_perag *b_pag; /* contains rbtree root */
191 struct xfs_mount *b_mount;
192 struct xfs_buftarg *b_target; /* buffer target (device) */
193 void *b_addr; /* virtual address of buffer */
194 struct work_struct b_ioend_work;
195 struct completion b_iowait; /* queue for I/O waiters */
196 struct xfs_buf_log_item *b_log_item;
197 struct list_head b_li_list; /* Log items list head */
198 struct xfs_trans *b_transp;
199 struct page **b_pages; /* array of page pointers */
200 struct page *b_page_array[XB_PAGES]; /* inline pages */
201 struct xfs_buf_map *b_maps; /* compound buffer map */
202 struct xfs_buf_map __b_map; /* inline compound buffer map */
203 int b_map_count;
204 atomic_t b_pin_count; /* pin count */
205 atomic_t b_io_remaining; /* #outstanding I/O requests */
206 unsigned int b_page_count; /* size of page array */
207 unsigned int b_offset; /* page offset of b_addr,
208 only for _XBF_KMEM buffers */
209 int b_error; /* error code on I/O */
210
211 /*
212 * async write failure retry count. Initialised to zero on the first
213 * failure, then when it exceeds the maximum configured without a
214 * success the write is considered to be failed permanently and the
215 * iodone handler will take appropriate action.
216 *
217 * For retry timeouts, we record the jiffy of the first failure. This
218 * means that we can change the retry timeout for buffers already under
219 * I/O and thus avoid getting stuck in a retry loop with a long timeout.
220 *
221 * last_error is used to ensure that we are getting repeated errors, not
222 * different errors. e.g. a block device might change ENOSPC to EIO when
223 * a failure timeout occurs, so we want to re-initialise the error
224 * retry behaviour appropriately when that happens.
225 */
226 int b_retries;
227 unsigned long b_first_retry_time; /* in jiffies */
228 int b_last_error;
229
230 const struct xfs_buf_ops *b_ops;
231 struct rcu_head b_rcu;
232};
233
234/* Finding and Reading Buffers */
235int xfs_buf_get_map(struct xfs_buftarg *target, struct xfs_buf_map *map,
236 int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp);
237int xfs_buf_read_map(struct xfs_buftarg *target, struct xfs_buf_map *map,
238 int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp,
239 const struct xfs_buf_ops *ops, xfs_failaddr_t fa);
240void xfs_buf_readahead_map(struct xfs_buftarg *target,
241 struct xfs_buf_map *map, int nmaps,
242 const struct xfs_buf_ops *ops);
243
244static inline int
245xfs_buf_incore(
246 struct xfs_buftarg *target,
247 xfs_daddr_t blkno,
248 size_t numblks,
249 xfs_buf_flags_t flags,
250 struct xfs_buf **bpp)
251{
252 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
253
254 return xfs_buf_get_map(target, &map, 1, XBF_INCORE | flags, bpp);
255}
256
257static inline int
258xfs_buf_get(
259 struct xfs_buftarg *target,
260 xfs_daddr_t blkno,
261 size_t numblks,
262 struct xfs_buf **bpp)
263{
264 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
265
266 return xfs_buf_get_map(target, &map, 1, 0, bpp);
267}
268
269static inline int
270xfs_buf_read(
271 struct xfs_buftarg *target,
272 xfs_daddr_t blkno,
273 size_t numblks,
274 xfs_buf_flags_t flags,
275 struct xfs_buf **bpp,
276 const struct xfs_buf_ops *ops)
277{
278 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
279
280 return xfs_buf_read_map(target, &map, 1, flags, bpp, ops,
281 __builtin_return_address(0));
282}
283
284static inline void
285xfs_buf_readahead(
286 struct xfs_buftarg *target,
287 xfs_daddr_t blkno,
288 size_t numblks,
289 const struct xfs_buf_ops *ops)
290{
291 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
292 return xfs_buf_readahead_map(target, &map, 1, ops);
293}
294
295int xfs_buf_get_uncached(struct xfs_buftarg *target, size_t numblks,
296 xfs_buf_flags_t flags, struct xfs_buf **bpp);
297int xfs_buf_read_uncached(struct xfs_buftarg *target, xfs_daddr_t daddr,
298 size_t numblks, xfs_buf_flags_t flags, struct xfs_buf **bpp,
299 const struct xfs_buf_ops *ops);
300int _xfs_buf_read(struct xfs_buf *bp, xfs_buf_flags_t flags);
301void xfs_buf_hold(struct xfs_buf *bp);
302
303/* Releasing Buffers */
304extern void xfs_buf_rele(struct xfs_buf *);
305
306/* Locking and Unlocking Buffers */
307extern int xfs_buf_trylock(struct xfs_buf *);
308extern void xfs_buf_lock(struct xfs_buf *);
309extern void xfs_buf_unlock(struct xfs_buf *);
310#define xfs_buf_islocked(bp) \
311 ((bp)->b_sema.count <= 0)
312
313static inline void xfs_buf_relse(struct xfs_buf *bp)
314{
315 xfs_buf_unlock(bp);
316 xfs_buf_rele(bp);
317}
318
319/* Buffer Read and Write Routines */
320extern int xfs_bwrite(struct xfs_buf *bp);
321
322extern void __xfs_buf_ioerror(struct xfs_buf *bp, int error,
323 xfs_failaddr_t failaddr);
324#define xfs_buf_ioerror(bp, err) __xfs_buf_ioerror((bp), (err), __this_address)
325extern void xfs_buf_ioerror_alert(struct xfs_buf *bp, xfs_failaddr_t fa);
326void xfs_buf_ioend_fail(struct xfs_buf *);
327void xfs_buf_zero(struct xfs_buf *bp, size_t boff, size_t bsize);
328void __xfs_buf_mark_corrupt(struct xfs_buf *bp, xfs_failaddr_t fa);
329#define xfs_buf_mark_corrupt(bp) __xfs_buf_mark_corrupt((bp), __this_address)
330
331/* Buffer Utility Routines */
332extern void *xfs_buf_offset(struct xfs_buf *, size_t);
333extern void xfs_buf_stale(struct xfs_buf *bp);
334
335/* Delayed Write Buffer Routines */
336extern void xfs_buf_delwri_cancel(struct list_head *);
337extern bool xfs_buf_delwri_queue(struct xfs_buf *, struct list_head *);
338void xfs_buf_delwri_queue_here(struct xfs_buf *bp, struct list_head *bl);
339extern int xfs_buf_delwri_submit(struct list_head *);
340extern int xfs_buf_delwri_submit_nowait(struct list_head *);
341extern int xfs_buf_delwri_pushbuf(struct xfs_buf *, struct list_head *);
342
343static inline xfs_daddr_t xfs_buf_daddr(struct xfs_buf *bp)
344{
345 return bp->b_maps[0].bm_bn;
346}
347
348void xfs_buf_set_ref(struct xfs_buf *bp, int lru_ref);
349
350/*
351 * If the buffer is already on the LRU, do nothing. Otherwise set the buffer
352 * up with a reference count of 0 so it will be tossed from the cache when
353 * released.
354 */
355static inline void xfs_buf_oneshot(struct xfs_buf *bp)
356{
357 if (!list_empty(&bp->b_lru) || atomic_read(&bp->b_lru_ref) > 1)
358 return;
359 atomic_set(&bp->b_lru_ref, 0);
360}
361
362static inline int xfs_buf_ispinned(struct xfs_buf *bp)
363{
364 return atomic_read(&bp->b_pin_count);
365}
366
367static inline int
368xfs_buf_verify_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
369{
370 return xfs_verify_cksum(bp->b_addr, BBTOB(bp->b_length),
371 cksum_offset);
372}
373
374static inline void
375xfs_buf_update_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
376{
377 xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length),
378 cksum_offset);
379}
380
381/*
382 * Handling of buftargs.
383 */
384struct xfs_buftarg *xfs_alloc_buftarg(struct xfs_mount *mp,
385 struct file *bdev_file);
386extern void xfs_free_buftarg(struct xfs_buftarg *);
387extern void xfs_buftarg_wait(struct xfs_buftarg *);
388extern void xfs_buftarg_drain(struct xfs_buftarg *);
389extern int xfs_setsize_buftarg(struct xfs_buftarg *, unsigned int);
390
391#define xfs_getsize_buftarg(buftarg) block_size((buftarg)->bt_bdev)
392#define xfs_readonly_buftarg(buftarg) bdev_read_only((buftarg)->bt_bdev)
393
394int xfs_buf_reverify(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
395bool xfs_verify_magic(struct xfs_buf *bp, __be32 dmagic);
396bool xfs_verify_magic16(struct xfs_buf *bp, __be16 dmagic);
397
398/* for xfs_buf_mem.c only: */
399int xfs_init_buftarg(struct xfs_buftarg *btp, size_t logical_sectorsize,
400 const char *descr);
401void xfs_destroy_buftarg(struct xfs_buftarg *btp);
402
403#endif /* __XFS_BUF_H__ */
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
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 * Base types
20 */
21struct xfs_buf;
22
23#define XFS_BUF_DADDR_NULL ((xfs_daddr_t) (-1LL))
24
25#define XBF_READ (1 << 0) /* buffer intended for reading from device */
26#define XBF_WRITE (1 << 1) /* buffer intended for writing to device */
27#define XBF_READ_AHEAD (1 << 2) /* asynchronous read-ahead */
28#define XBF_NO_IOACCT (1 << 3) /* bypass I/O accounting (non-LRU bufs) */
29#define XBF_ASYNC (1 << 4) /* initiator will not wait for completion */
30#define XBF_DONE (1 << 5) /* all pages in the buffer uptodate */
31#define XBF_STALE (1 << 6) /* buffer has been staled, do not find it */
32#define XBF_WRITE_FAIL (1 << 7) /* async writes have failed on this buffer */
33
34/* buffer type flags for write callbacks */
35#define _XBF_INODES (1 << 16)/* inode buffer */
36#define _XBF_DQUOTS (1 << 17)/* dquot buffer */
37#define _XBF_LOGRECOVERY (1 << 18)/* log recovery buffer */
38
39/* flags used only internally */
40#define _XBF_PAGES (1 << 20)/* backed by refcounted pages */
41#define _XBF_KMEM (1 << 21)/* backed by heap memory */
42#define _XBF_DELWRI_Q (1 << 22)/* buffer on a delwri queue */
43
44/* flags used only as arguments to access routines */
45#define XBF_TRYLOCK (1 << 30)/* lock requested, but do not wait */
46#define XBF_UNMAPPED (1 << 31)/* do not map the buffer */
47
48typedef unsigned int xfs_buf_flags_t;
49
50#define XFS_BUF_FLAGS \
51 { XBF_READ, "READ" }, \
52 { XBF_WRITE, "WRITE" }, \
53 { XBF_READ_AHEAD, "READ_AHEAD" }, \
54 { XBF_NO_IOACCT, "NO_IOACCT" }, \
55 { XBF_ASYNC, "ASYNC" }, \
56 { XBF_DONE, "DONE" }, \
57 { XBF_STALE, "STALE" }, \
58 { XBF_WRITE_FAIL, "WRITE_FAIL" }, \
59 { _XBF_INODES, "INODES" }, \
60 { _XBF_DQUOTS, "DQUOTS" }, \
61 { _XBF_LOGRECOVERY, "LOG_RECOVERY" }, \
62 { _XBF_PAGES, "PAGES" }, \
63 { _XBF_KMEM, "KMEM" }, \
64 { _XBF_DELWRI_Q, "DELWRI_Q" }, \
65 /* The following interface flags should never be set */ \
66 { XBF_TRYLOCK, "TRYLOCK" }, \
67 { XBF_UNMAPPED, "UNMAPPED" }
68
69/*
70 * Internal state flags.
71 */
72#define XFS_BSTATE_DISPOSE (1 << 0) /* buffer being discarded */
73#define XFS_BSTATE_IN_FLIGHT (1 << 1) /* I/O in flight */
74
75/*
76 * The xfs_buftarg contains 2 notions of "sector size" -
77 *
78 * 1) The metadata sector size, which is the minimum unit and
79 * alignment of IO which will be performed by metadata operations.
80 * 2) The device logical sector size
81 *
82 * The first is specified at mkfs time, and is stored on-disk in the
83 * superblock's sb_sectsize.
84 *
85 * The latter is derived from the underlying device, and controls direct IO
86 * alignment constraints.
87 */
88typedef struct xfs_buftarg {
89 dev_t bt_dev;
90 struct block_device *bt_bdev;
91 struct dax_device *bt_daxdev;
92 struct xfs_mount *bt_mount;
93 unsigned int bt_meta_sectorsize;
94 size_t bt_meta_sectormask;
95 size_t bt_logical_sectorsize;
96 size_t bt_logical_sectormask;
97
98 /* LRU control structures */
99 struct shrinker bt_shrinker;
100 struct list_lru bt_lru;
101
102 struct percpu_counter bt_io_count;
103 struct ratelimit_state bt_ioerror_rl;
104} xfs_buftarg_t;
105
106#define XB_PAGES 2
107
108struct xfs_buf_map {
109 xfs_daddr_t bm_bn; /* block number for I/O */
110 int bm_len; /* size of I/O */
111};
112
113#define DEFINE_SINGLE_BUF_MAP(map, blkno, numblk) \
114 struct xfs_buf_map (map) = { .bm_bn = (blkno), .bm_len = (numblk) };
115
116struct xfs_buf_ops {
117 char *name;
118 union {
119 __be32 magic[2]; /* v4 and v5 on disk magic values */
120 __be16 magic16[2]; /* v4 and v5 on disk magic values */
121 };
122 void (*verify_read)(struct xfs_buf *);
123 void (*verify_write)(struct xfs_buf *);
124 xfs_failaddr_t (*verify_struct)(struct xfs_buf *bp);
125};
126
127struct xfs_buf {
128 /*
129 * first cacheline holds all the fields needed for an uncontended cache
130 * hit to be fully processed. The semaphore straddles the cacheline
131 * boundary, but the counter and lock sits on the first cacheline,
132 * which is the only bit that is touched if we hit the semaphore
133 * fast-path on locking.
134 */
135 struct rhash_head b_rhash_head; /* pag buffer hash node */
136 xfs_daddr_t b_bn; /* block number of buffer */
137 int b_length; /* size of buffer in BBs */
138 atomic_t b_hold; /* reference count */
139 atomic_t b_lru_ref; /* lru reclaim ref count */
140 xfs_buf_flags_t b_flags; /* status flags */
141 struct semaphore b_sema; /* semaphore for lockables */
142
143 /*
144 * concurrent access to b_lru and b_lru_flags are protected by
145 * bt_lru_lock and not by b_sema
146 */
147 struct list_head b_lru; /* lru list */
148 spinlock_t b_lock; /* internal state lock */
149 unsigned int b_state; /* internal state flags */
150 int b_io_error; /* internal IO error state */
151 wait_queue_head_t b_waiters; /* unpin waiters */
152 struct list_head b_list;
153 struct xfs_perag *b_pag; /* contains rbtree root */
154 struct xfs_mount *b_mount;
155 struct xfs_buftarg *b_target; /* buffer target (device) */
156 void *b_addr; /* virtual address of buffer */
157 struct work_struct b_ioend_work;
158 struct completion b_iowait; /* queue for I/O waiters */
159 struct xfs_buf_log_item *b_log_item;
160 struct list_head b_li_list; /* Log items list head */
161 struct xfs_trans *b_transp;
162 struct page **b_pages; /* array of page pointers */
163 struct page *b_page_array[XB_PAGES]; /* inline pages */
164 struct xfs_buf_map *b_maps; /* compound buffer map */
165 struct xfs_buf_map __b_map; /* inline compound buffer map */
166 int b_map_count;
167 atomic_t b_pin_count; /* pin count */
168 atomic_t b_io_remaining; /* #outstanding I/O requests */
169 unsigned int b_page_count; /* size of page array */
170 unsigned int b_offset; /* page offset of b_addr,
171 only for _XBF_KMEM buffers */
172 int b_error; /* error code on I/O */
173
174 /*
175 * async write failure retry count. Initialised to zero on the first
176 * failure, then when it exceeds the maximum configured without a
177 * success the write is considered to be failed permanently and the
178 * iodone handler will take appropriate action.
179 *
180 * For retry timeouts, we record the jiffie of the first failure. This
181 * means that we can change the retry timeout for buffers already under
182 * I/O and thus avoid getting stuck in a retry loop with a long timeout.
183 *
184 * last_error is used to ensure that we are getting repeated errors, not
185 * different errors. e.g. a block device might change ENOSPC to EIO when
186 * a failure timeout occurs, so we want to re-initialise the error
187 * retry behaviour appropriately when that happens.
188 */
189 int b_retries;
190 unsigned long b_first_retry_time; /* in jiffies */
191 int b_last_error;
192
193 const struct xfs_buf_ops *b_ops;
194};
195
196/* Finding and Reading Buffers */
197struct xfs_buf *xfs_buf_incore(struct xfs_buftarg *target,
198 xfs_daddr_t blkno, size_t numblks,
199 xfs_buf_flags_t flags);
200
201int xfs_buf_get_map(struct xfs_buftarg *target, struct xfs_buf_map *map,
202 int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp);
203int xfs_buf_read_map(struct xfs_buftarg *target, struct xfs_buf_map *map,
204 int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp,
205 const struct xfs_buf_ops *ops, xfs_failaddr_t fa);
206void xfs_buf_readahead_map(struct xfs_buftarg *target,
207 struct xfs_buf_map *map, int nmaps,
208 const struct xfs_buf_ops *ops);
209
210static inline int
211xfs_buf_get(
212 struct xfs_buftarg *target,
213 xfs_daddr_t blkno,
214 size_t numblks,
215 struct xfs_buf **bpp)
216{
217 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
218
219 return xfs_buf_get_map(target, &map, 1, 0, bpp);
220}
221
222static inline int
223xfs_buf_read(
224 struct xfs_buftarg *target,
225 xfs_daddr_t blkno,
226 size_t numblks,
227 xfs_buf_flags_t flags,
228 struct xfs_buf **bpp,
229 const struct xfs_buf_ops *ops)
230{
231 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
232
233 return xfs_buf_read_map(target, &map, 1, flags, bpp, ops,
234 __builtin_return_address(0));
235}
236
237static inline void
238xfs_buf_readahead(
239 struct xfs_buftarg *target,
240 xfs_daddr_t blkno,
241 size_t numblks,
242 const struct xfs_buf_ops *ops)
243{
244 DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
245 return xfs_buf_readahead_map(target, &map, 1, ops);
246}
247
248int xfs_buf_get_uncached(struct xfs_buftarg *target, size_t numblks, int flags,
249 struct xfs_buf **bpp);
250int xfs_buf_read_uncached(struct xfs_buftarg *target, xfs_daddr_t daddr,
251 size_t numblks, int flags, struct xfs_buf **bpp,
252 const struct xfs_buf_ops *ops);
253int _xfs_buf_read(struct xfs_buf *bp, xfs_buf_flags_t flags);
254void xfs_buf_hold(struct xfs_buf *bp);
255
256/* Releasing Buffers */
257extern void xfs_buf_rele(struct xfs_buf *);
258
259/* Locking and Unlocking Buffers */
260extern int xfs_buf_trylock(struct xfs_buf *);
261extern void xfs_buf_lock(struct xfs_buf *);
262extern void xfs_buf_unlock(struct xfs_buf *);
263#define xfs_buf_islocked(bp) \
264 ((bp)->b_sema.count <= 0)
265
266static inline void xfs_buf_relse(struct xfs_buf *bp)
267{
268 xfs_buf_unlock(bp);
269 xfs_buf_rele(bp);
270}
271
272/* Buffer Read and Write Routines */
273extern int xfs_bwrite(struct xfs_buf *bp);
274
275extern void __xfs_buf_ioerror(struct xfs_buf *bp, int error,
276 xfs_failaddr_t failaddr);
277#define xfs_buf_ioerror(bp, err) __xfs_buf_ioerror((bp), (err), __this_address)
278extern void xfs_buf_ioerror_alert(struct xfs_buf *bp, xfs_failaddr_t fa);
279void xfs_buf_ioend_fail(struct xfs_buf *);
280void xfs_buf_zero(struct xfs_buf *bp, size_t boff, size_t bsize);
281void __xfs_buf_mark_corrupt(struct xfs_buf *bp, xfs_failaddr_t fa);
282#define xfs_buf_mark_corrupt(bp) __xfs_buf_mark_corrupt((bp), __this_address)
283
284/* Buffer Utility Routines */
285extern void *xfs_buf_offset(struct xfs_buf *, size_t);
286extern void xfs_buf_stale(struct xfs_buf *bp);
287
288/* Delayed Write Buffer Routines */
289extern void xfs_buf_delwri_cancel(struct list_head *);
290extern bool xfs_buf_delwri_queue(struct xfs_buf *, struct list_head *);
291extern int xfs_buf_delwri_submit(struct list_head *);
292extern int xfs_buf_delwri_submit_nowait(struct list_head *);
293extern int xfs_buf_delwri_pushbuf(struct xfs_buf *, struct list_head *);
294
295/* Buffer Daemon Setup Routines */
296extern int xfs_buf_init(void);
297extern void xfs_buf_terminate(void);
298
299/*
300 * These macros use the IO block map rather than b_bn. b_bn is now really
301 * just for the buffer cache index for cached buffers. As IO does not use b_bn
302 * anymore, uncached buffers do not use b_bn at all and hence must modify the IO
303 * map directly. Uncached buffers are not allowed to be discontiguous, so this
304 * is safe to do.
305 *
306 * In future, uncached buffers will pass the block number directly to the io
307 * request function and hence these macros will go away at that point.
308 */
309#define XFS_BUF_ADDR(bp) ((bp)->b_maps[0].bm_bn)
310#define XFS_BUF_SET_ADDR(bp, bno) ((bp)->b_maps[0].bm_bn = (xfs_daddr_t)(bno))
311
312void xfs_buf_set_ref(struct xfs_buf *bp, int lru_ref);
313
314/*
315 * If the buffer is already on the LRU, do nothing. Otherwise set the buffer
316 * up with a reference count of 0 so it will be tossed from the cache when
317 * released.
318 */
319static inline void xfs_buf_oneshot(struct xfs_buf *bp)
320{
321 if (!list_empty(&bp->b_lru) || atomic_read(&bp->b_lru_ref) > 1)
322 return;
323 atomic_set(&bp->b_lru_ref, 0);
324}
325
326static inline int xfs_buf_ispinned(struct xfs_buf *bp)
327{
328 return atomic_read(&bp->b_pin_count);
329}
330
331static inline int
332xfs_buf_verify_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
333{
334 return xfs_verify_cksum(bp->b_addr, BBTOB(bp->b_length),
335 cksum_offset);
336}
337
338static inline void
339xfs_buf_update_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
340{
341 xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length),
342 cksum_offset);
343}
344
345/*
346 * Handling of buftargs.
347 */
348extern struct xfs_buftarg *xfs_alloc_buftarg(struct xfs_mount *,
349 struct block_device *, struct dax_device *);
350extern void xfs_free_buftarg(struct xfs_buftarg *);
351extern void xfs_buftarg_wait(struct xfs_buftarg *);
352extern void xfs_buftarg_drain(struct xfs_buftarg *);
353extern int xfs_setsize_buftarg(struct xfs_buftarg *, unsigned int);
354
355#define xfs_getsize_buftarg(buftarg) block_size((buftarg)->bt_bdev)
356#define xfs_readonly_buftarg(buftarg) bdev_read_only((buftarg)->bt_bdev)
357
358static inline int
359xfs_buftarg_dma_alignment(struct xfs_buftarg *bt)
360{
361 return queue_dma_alignment(bt->bt_bdev->bd_disk->queue);
362}
363
364int xfs_buf_reverify(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
365bool xfs_verify_magic(struct xfs_buf *bp, __be32 dmagic);
366bool xfs_verify_magic16(struct xfs_buf *bp, __be16 dmagic);
367
368#endif /* __XFS_BUF_H__ */