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