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