[mirror_ubuntu-jammy-kernel.git] / fs / xfs / xfs_buf.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef __XFS_BUF_H__
#define __XFS_BUF_H__

#include <linux/list.h>
#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/fs.h>
#include <linux/dax.h>
#include <linux/uio.h>
#include <linux/list_lru.h>

/*
 *	Base types
 */
struct xfs_buf;

#define XFS_BUF_DADDR_NULL	((xfs_daddr_t) (-1LL))

#define XBF_READ	 (1 << 0) /* buffer intended for reading from device */
#define XBF_WRITE	 (1 << 1) /* buffer intended for writing to device */
#define XBF_READ_AHEAD	 (1 << 2) /* asynchronous read-ahead */
#define XBF_NO_IOACCT	 (1 << 3) /* bypass I/O accounting (non-LRU bufs) */
#define XBF_ASYNC	 (1 << 4) /* initiator will not wait for completion */
#define XBF_DONE	 (1 << 5) /* all pages in the buffer uptodate */
#define XBF_STALE	 (1 << 6) /* buffer has been staled, do not find it */
#define XBF_WRITE_FAIL	 (1 << 7) /* async writes have failed on this buffer */

/* buffer type flags for write callbacks */
#define _XBF_INODES	 (1 << 16)/* inode buffer */
#define _XBF_DQUOTS	 (1 << 17)/* dquot buffer */
#define _XBF_LOGRECOVERY	 (1 << 18)/* log recovery buffer */

/* flags used only internally */
#define _XBF_PAGES	 (1 << 20)/* backed by refcounted pages */
#define _XBF_KMEM	 (1 << 21)/* backed by heap memory */
#define _XBF_DELWRI_Q	 (1 << 22)/* buffer on a delwri queue */

/* flags used only as arguments to access routines */
#define XBF_TRYLOCK	 (1 << 30)/* lock requested, but do not wait */
#define XBF_UNMAPPED	 (1 << 31)/* do not map the buffer */

typedef unsigned int xfs_buf_flags_t;

#define XFS_BUF_FLAGS \
	{ XBF_READ,		"READ" }, \
	{ XBF_WRITE,		"WRITE" }, \
	{ XBF_READ_AHEAD,	"READ_AHEAD" }, \
	{ XBF_NO_IOACCT,	"NO_IOACCT" }, \
	{ XBF_ASYNC,		"ASYNC" }, \
	{ XBF_DONE,		"DONE" }, \
	{ XBF_STALE,		"STALE" }, \
	{ XBF_WRITE_FAIL,	"WRITE_FAIL" }, \
	{ _XBF_INODES,		"INODES" }, \
	{ _XBF_DQUOTS,		"DQUOTS" }, \
	{ _XBF_LOGRECOVERY,		"LOG_RECOVERY" }, \
	{ _XBF_PAGES,		"PAGES" }, \
	{ _XBF_KMEM,		"KMEM" }, \
	{ _XBF_DELWRI_Q,	"DELWRI_Q" }, \
	/* The following interface flags should never be set */ \
	{ XBF_TRYLOCK,		"TRYLOCK" }, \
	{ XBF_UNMAPPED,		"UNMAPPED" }

/*
 * Internal state flags.
 */
#define XFS_BSTATE_DISPOSE	 (1 << 0)	/* buffer being discarded */
#define XFS_BSTATE_IN_FLIGHT	 (1 << 1)	/* I/O in flight */

/*
 * The xfs_buftarg contains 2 notions of "sector size" -
 *
 * 1) The metadata sector size, which is the minimum unit and
 *    alignment of IO which will be performed by metadata operations.
 * 2) The device logical sector size
 *
 * The first is specified at mkfs time, and is stored on-disk in the
 * superblock's sb_sectsize.
 *
 * The latter is derived from the underlying device, and controls direct IO
 * alignment constraints.
 */
typedef struct xfs_buftarg {
	dev_t			bt_dev;
	struct block_device	*bt_bdev;
	struct dax_device	*bt_daxdev;
	struct xfs_mount	*bt_mount;
	unsigned int		bt_meta_sectorsize;
	size_t			bt_meta_sectormask;
	size_t			bt_logical_sectorsize;
	size_t			bt_logical_sectormask;

	/* LRU control structures */
	struct shrinker		bt_shrinker;
	struct list_lru		bt_lru;

	struct percpu_counter	bt_io_count;
	struct ratelimit_state	bt_ioerror_rl;
} xfs_buftarg_t;

#define XB_PAGES	2

struct xfs_buf_map {
	xfs_daddr_t		bm_bn;	/* block number for I/O */
	int			bm_len;	/* size of I/O */
};

#define DEFINE_SINGLE_BUF_MAP(map, blkno, numblk) \
	struct xfs_buf_map (map) = { .bm_bn = (blkno), .bm_len = (numblk) };

struct xfs_buf_ops {
	char *name;
	union {
		__be32 magic[2];	/* v4 and v5 on disk magic values */
		__be16 magic16[2];	/* v4 and v5 on disk magic values */
	};
	void (*verify_read)(struct xfs_buf *);
	void (*verify_write)(struct xfs_buf *);
	xfs_failaddr_t (*verify_struct)(struct xfs_buf *bp);
};

struct xfs_buf {
	/*
	 * first cacheline holds all the fields needed for an uncontended cache
	 * hit to be fully processed. The semaphore straddles the cacheline
	 * boundary, but the counter and lock sits on the first cacheline,
	 * which is the only bit that is touched if we hit the semaphore
	 * fast-path on locking.
	 */
	struct rhash_head	b_rhash_head;	/* pag buffer hash node */

	xfs_daddr_t		b_rhash_key;	/* buffer cache index */
	int			b_length;	/* size of buffer in BBs */
	atomic_t		b_hold;		/* reference count */
	atomic_t		b_lru_ref;	/* lru reclaim ref count */
	xfs_buf_flags_t		b_flags;	/* status flags */
	struct semaphore	b_sema;		/* semaphore for lockables */

	/*
	 * concurrent access to b_lru and b_lru_flags are protected by
	 * bt_lru_lock and not by b_sema
	 */
	struct list_head	b_lru;		/* lru list */
	spinlock_t		b_lock;		/* internal state lock */
	unsigned int		b_state;	/* internal state flags */
	int			b_io_error;	/* internal IO error state */
	wait_queue_head_t	b_waiters;	/* unpin waiters */
	struct list_head	b_list;
	struct xfs_perag	*b_pag;		/* contains rbtree root */
	struct xfs_mount	*b_mount;
	struct xfs_buftarg	*b_target;	/* buffer target (device) */
	void			*b_addr;	/* virtual address of buffer */
	struct work_struct	b_ioend_work;
	struct completion	b_iowait;	/* queue for I/O waiters */
	struct xfs_buf_log_item	*b_log_item;
	struct list_head	b_li_list;	/* Log items list head */
	struct xfs_trans	*b_transp;
	struct page		**b_pages;	/* array of page pointers */
	struct page		*b_page_array[XB_PAGES]; /* inline pages */
	struct xfs_buf_map	*b_maps;	/* compound buffer map */
	struct xfs_buf_map	__b_map;	/* inline compound buffer map */
	int			b_map_count;
	atomic_t		b_pin_count;	/* pin count */
	atomic_t		b_io_remaining;	/* #outstanding I/O requests */
	unsigned int		b_page_count;	/* size of page array */
	unsigned int		b_offset;	/* page offset of b_addr,
						   only for _XBF_KMEM buffers */
	int			b_error;	/* error code on I/O */

	/*
	 * async write failure retry count. Initialised to zero on the first
	 * failure, then when it exceeds the maximum configured without a
	 * success the write is considered to be failed permanently and the
	 * iodone handler will take appropriate action.
	 *
	 * For retry timeouts, we record the jiffie of the first failure. This
	 * means that we can change the retry timeout for buffers already under
	 * I/O and thus avoid getting stuck in a retry loop with a long timeout.
	 *
	 * last_error is used to ensure that we are getting repeated errors, not
	 * different errors. e.g. a block device might change ENOSPC to EIO when
	 * a failure timeout occurs, so we want to re-initialise the error
	 * retry behaviour appropriately when that happens.
	 */
	int			b_retries;
	unsigned long		b_first_retry_time; /* in jiffies */
	int			b_last_error;

	const struct xfs_buf_ops	*b_ops;
};

/* Finding and Reading Buffers */
struct xfs_buf *xfs_buf_incore(struct xfs_buftarg *target,
			   xfs_daddr_t blkno, size_t numblks,
			   xfs_buf_flags_t flags);

int xfs_buf_get_map(struct xfs_buftarg *target, struct xfs_buf_map *map,
		int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp);
int xfs_buf_read_map(struct xfs_buftarg *target, struct xfs_buf_map *map,
		int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp,
		const struct xfs_buf_ops *ops, xfs_failaddr_t fa);
void xfs_buf_readahead_map(struct xfs_buftarg *target,
			       struct xfs_buf_map *map, int nmaps,
			       const struct xfs_buf_ops *ops);

static inline int
xfs_buf_get(
	struct xfs_buftarg	*target,
	xfs_daddr_t		blkno,
	size_t			numblks,
	struct xfs_buf		**bpp)
{
	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);

	return xfs_buf_get_map(target, &map, 1, 0, bpp);
}

static inline int
xfs_buf_read(
	struct xfs_buftarg	*target,
	xfs_daddr_t		blkno,
	size_t			numblks,
	xfs_buf_flags_t		flags,
	struct xfs_buf		**bpp,
	const struct xfs_buf_ops *ops)
{
	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);

	return xfs_buf_read_map(target, &map, 1, flags, bpp, ops,
			__builtin_return_address(0));
}

static inline void
xfs_buf_readahead(
	struct xfs_buftarg	*target,
	xfs_daddr_t		blkno,
	size_t			numblks,
	const struct xfs_buf_ops *ops)
{
	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
	return xfs_buf_readahead_map(target, &map, 1, ops);
}

int xfs_buf_get_uncached(struct xfs_buftarg *target, size_t numblks, int flags,
		struct xfs_buf **bpp);
int xfs_buf_read_uncached(struct xfs_buftarg *target, xfs_daddr_t daddr,
			  size_t numblks, int flags, struct xfs_buf **bpp,
			  const struct xfs_buf_ops *ops);
int _xfs_buf_read(struct xfs_buf *bp, xfs_buf_flags_t flags);
void xfs_buf_hold(struct xfs_buf *bp);

/* Releasing Buffers */
extern void xfs_buf_rele(struct xfs_buf *);

/* Locking and Unlocking Buffers */
extern int xfs_buf_trylock(struct xfs_buf *);
extern void xfs_buf_lock(struct xfs_buf *);
extern void xfs_buf_unlock(struct xfs_buf *);
#define xfs_buf_islocked(bp) \
	((bp)->b_sema.count <= 0)

static inline void xfs_buf_relse(struct xfs_buf *bp)
{
	xfs_buf_unlock(bp);
	xfs_buf_rele(bp);
}

/* Buffer Read and Write Routines */
extern int xfs_bwrite(struct xfs_buf *bp);

extern void __xfs_buf_ioerror(struct xfs_buf *bp, int error,
		xfs_failaddr_t failaddr);
#define xfs_buf_ioerror(bp, err) __xfs_buf_ioerror((bp), (err), __this_address)
extern void xfs_buf_ioerror_alert(struct xfs_buf *bp, xfs_failaddr_t fa);
void xfs_buf_ioend_fail(struct xfs_buf *);
void xfs_buf_zero(struct xfs_buf *bp, size_t boff, size_t bsize);
void __xfs_buf_mark_corrupt(struct xfs_buf *bp, xfs_failaddr_t fa);
#define xfs_buf_mark_corrupt(bp) __xfs_buf_mark_corrupt((bp), __this_address)

/* Buffer Utility Routines */
extern void *xfs_buf_offset(struct xfs_buf *, size_t);
extern void xfs_buf_stale(struct xfs_buf *bp);

/* Delayed Write Buffer Routines */
extern void xfs_buf_delwri_cancel(struct list_head *);
extern bool xfs_buf_delwri_queue(struct xfs_buf *, struct list_head *);
extern int xfs_buf_delwri_submit(struct list_head *);
extern int xfs_buf_delwri_submit_nowait(struct list_head *);
extern int xfs_buf_delwri_pushbuf(struct xfs_buf *, struct list_head *);

/* Buffer Daemon Setup Routines */
extern int xfs_buf_init(void);
extern void xfs_buf_terminate(void);

static inline xfs_daddr_t xfs_buf_daddr(struct xfs_buf *bp)
{
	return bp->b_maps[0].bm_bn;
}

void xfs_buf_set_ref(struct xfs_buf *bp, int lru_ref);

/*
 * If the buffer is already on the LRU, do nothing. Otherwise set the buffer
 * up with a reference count of 0 so it will be tossed from the cache when
 * released.
 */
static inline void xfs_buf_oneshot(struct xfs_buf *bp)
{
	if (!list_empty(&bp->b_lru) || atomic_read(&bp->b_lru_ref) > 1)
		return;
	atomic_set(&bp->b_lru_ref, 0);
}

static inline int xfs_buf_ispinned(struct xfs_buf *bp)
{
	return atomic_read(&bp->b_pin_count);
}

static inline int
xfs_buf_verify_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
{
	return xfs_verify_cksum(bp->b_addr, BBTOB(bp->b_length),
				cksum_offset);
}

static inline void
xfs_buf_update_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
{
	xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length),
			 cksum_offset);
}

/*
 *	Handling of buftargs.
 */
extern struct xfs_buftarg *xfs_alloc_buftarg(struct xfs_mount *,
		struct block_device *, struct dax_device *);
extern void xfs_free_buftarg(struct xfs_buftarg *);
extern void xfs_buftarg_wait(struct xfs_buftarg *);
extern void xfs_buftarg_drain(struct xfs_buftarg *);
extern int xfs_setsize_buftarg(struct xfs_buftarg *, unsigned int);

#define xfs_getsize_buftarg(buftarg)	block_size((buftarg)->bt_bdev)
#define xfs_readonly_buftarg(buftarg)	bdev_read_only((buftarg)->bt_bdev)

int xfs_buf_reverify(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
bool xfs_verify_magic(struct xfs_buf *bp, __be32 dmagic);
bool xfs_verify_magic16(struct xfs_buf *bp, __be16 dmagic);

#endif	/* __XFS_BUF_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
1da177e4	2	/*
7b718769 NS	3	* Copyright (c) 2000-2005 Silicon Graphics, Inc.
7b718769 NS	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>
1da177e4 LT	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	*/
b01d1461	21	struct xfs_buf;
1da177e4	22
ce8e922c NS	23	#define XFS_BUF_DADDR_NULL ((xfs_daddr_t) (-1LL))
ce8e922c NS	24
6fb8a90a CM	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 */
c891c30a	28	#define XBF_NO_IOACCT (1 << 3) /* bypass I/O accounting (non-LRU bufs) */
6fb8a90a CM	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 */
ce89755c	32	#define XBF_WRITE_FAIL (1 << 7) /* async writes have failed on this buffer */
1d5ae5df	33
f593bf14 DC	34	/* buffer type flags for write callbacks */
f593bf14 DC	35	#define _XBF_INODES (1 << 16)/* inode buffer */
0c7e5afb	36	#define _XBF_DQUOTS (1 << 17)/* dquot buffer */
9fe5c77c	37	#define _XBF_LOGRECOVERY (1 << 18)/* log recovery buffer */
1da177e4	38
807cbbdb	39	/* flags used only internally */
6fb8a90a CM	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 */
6ab455ee	43
f593bf14 DC	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
807cbbdb	48	typedef unsigned int xfs_buf_flags_t;
1da177e4	49
0b1b213f CH	50	#define XFS_BUF_FLAGS \
	51	{ XBF_READ, "READ" }, \
	52	{ XBF_WRITE, "WRITE" }, \
1d5ae5df	53	{ XBF_READ_AHEAD, "READ_AHEAD" }, \
1247ec4c	54	{ XBF_NO_IOACCT, "NO_IOACCT" }, \
0b1b213f CH	55	{ XBF_ASYNC, "ASYNC" }, \
0b1b213f CH	56	{ XBF_DONE, "DONE" }, \
0b1b213f	57	{ XBF_STALE, "STALE" }, \
ac8809f9	58	{ XBF_WRITE_FAIL, "WRITE_FAIL" }, \
f593bf14	59	{ _XBF_INODES, "INODES" }, \
0c7e5afb	60	{ _XBF_DQUOTS, "DQUOTS" }, \
9fe5c77c	61	{ _XBF_LOGRECOVERY, "LOG_RECOVERY" }, \
0b1b213f	62	{ _XBF_PAGES, "PAGES" }, \
0e6e847f	63	{ _XBF_KMEM, "KMEM" }, \
f593bf14 DC	64	{ _XBF_DELWRI_Q, "DELWRI_Q" }, \
	65	/* The following interface flags should never be set */ \
	66	{ XBF_TRYLOCK, "TRYLOCK" }, \
	67	{ XBF_UNMAPPED, "UNMAPPED" }
ac8809f9	68
a4082357 DC	69	/*
	70	* Internal state flags.
	71	*/
	72	#define XFS_BSTATE_DISPOSE (1 << 0) /* buffer being discarded */
63db7c81	73	#define XFS_BSTATE_IN_FLIGHT (1 << 1) /* I/O in flight */
0b1b213f	74
7c71ee78 ES	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	*/
1da177e4	88	typedef struct xfs_buftarg {
ce8e922c NS	89	dev_t bt_dev;
ce8e922c NS	90	struct block_device *bt_bdev;
486aff5e	91	struct dax_device *bt_daxdev;
ebad861b	92	struct xfs_mount *bt_mount;
6da54179 ES	93	unsigned int bt_meta_sectorsize;
6da54179 ES	94	size_t bt_meta_sectormask;
7c71ee78 ES	95	size_t bt_logical_sectorsize;
7c71ee78 ES	96	size_t bt_logical_sectormask;
ce8e922c	97
ff57ab21 DC	98	/* LRU control structures */
ff57ab21 DC	99	struct shrinker bt_shrinker;
e80dfa19	100	struct list_lru bt_lru;
9c7504aa BF	101
9c7504aa BF	102	struct percpu_counter bt_io_count;
f9bccfcc	103	struct ratelimit_state bt_ioerror_rl;
1da177e4 LT	104	} xfs_buftarg_t;
1da177e4 LT	105
ce8e922c	106	#define XB_PAGES 2
1da177e4	107
cbb7baab DC	108	struct xfs_buf_map {
	109	xfs_daddr_t bm_bn; /* block number for I/O */
	110	int bm_len; /* size of I/O */
	111	};
	112
3e85c868 DC	113	#define DEFINE_SINGLE_BUF_MAP(map, blkno, numblk) \
	114	struct xfs_buf_map (map) = { .bm_bn = (blkno), .bm_len = (numblk) };
	115
1813dd64	116	struct xfs_buf_ops {
233135b7	117	char *name;
15baadf7 DW	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	};
1813dd64 DC	122	void (verify_read)(struct xfs_buf );
1813dd64 DC	123	void (verify_write)(struct xfs_buf );
b5572597	124	xfs_failaddr_t (verify_struct)(struct xfs_buf bp);
1813dd64 DC	125	};
1813dd64 DC	126
e8222613	127	struct xfs_buf {
50f59e8e DC	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	*/
6031e73a	135	struct rhash_head b_rhash_head; /* pag buffer hash node */
8cf07f3d	136
4c7f65ae	137	xfs_daddr_t b_rhash_key; /* buffer cache index */
4e94b71b	138	int b_length; /* size of buffer in BBs */
50f59e8e	139	atomic_t b_hold; /* reference count */
430cbeb8	140	atomic_t b_lru_ref; /* lru reclaim ref count */
50f59e8e	141	xfs_buf_flags_t b_flags; /* status flags */
ce8e922c	142	struct semaphore b_sema; /* semaphore for lockables */
50f59e8e	143
6fb8a90a CM	144	/*
	145	* concurrent access to b_lru and b_lru_flags are protected by
	146	* bt_lru_lock and not by b_sema
	147	*/
430cbeb8	148	struct list_head b_lru; /* lru list */
a4082357 DC	149	spinlock_t b_lock; /* internal state lock */
a4082357 DC	150	unsigned int b_state; /* internal state flags */
61be9c52	151	int b_io_error; /* internal IO error state */
ce8e922c NS	152	wait_queue_head_t b_waiters; /* unpin waiters */
ce8e922c NS	153	struct list_head b_list;
74f75a0c	154	struct xfs_perag b_pag; / contains rbtree root */
dbd329f1	155	struct xfs_mount *b_mount;
10fb9ac1	156	struct xfs_buftarg b_target; / buffer target (device) */
ce8e922c	157	void b_addr; / virtual address of buffer */
b29c70f5	158	struct work_struct b_ioend_work;
b4dd330b	159	struct completion b_iowait; /* queue for I/O waiters */
e99b4bd0	160	struct xfs_buf_log_item *b_log_item;
643c8c05	161	struct list_head b_li_list; /* Log items list head */
bf9d9013	162	struct xfs_trans *b_transp;
ce8e922c NS	163	struct page *b_pages; / array of page pointers */
ce8e922c NS	164	struct page b_page_array[XB_PAGES]; / inline pages */
3e85c868	165	struct xfs_buf_map b_maps; / compound buffer map */
d44d9bc6	166	struct xfs_buf_map __b_map; /* inline compound buffer map */
3e85c868	167	int b_map_count;
50f59e8e DC	168	atomic_t b_pin_count; /* pin count */
	169	atomic_t b_io_remaining; /* #outstanding I/O requests */
	170	unsigned int b_page_count; /* size of page array */
54cd3aa6 CH	171	unsigned int b_offset; /* page offset of b_addr,
54cd3aa6 CH	172	only for _XBF_KMEM buffers */
2451337d	173	int b_error; /* error code on I/O */
a5ea70d2 CM	174
	175	/*
	176	* async write failure retry count. Initialised to zero on the first
	177	* failure, then when it exceeds the maximum configured without a
	178	* success the write is considered to be failed permanently and the
	179	* iodone handler will take appropriate action.
	180	*
	181	* For retry timeouts, we record the jiffie of the first failure. This
	182	* means that we can change the retry timeout for buffers already under
	183	* I/O and thus avoid getting stuck in a retry loop with a long timeout.
	184	*
	185	* last_error is used to ensure that we are getting repeated errors, not
	186	* different errors. e.g. a block device might change ENOSPC to EIO when
	187	* a failure timeout occurs, so we want to re-initialise the error
	188	* retry behaviour appropriately when that happens.
	189	*/
	190	int b_retries;
	191	unsigned long b_first_retry_time; /* in jiffies */
	192	int b_last_error;
	193
1813dd64	194	const struct xfs_buf_ops *b_ops;
e8222613	195	};
1da177e4	196
1da177e4	197	/* Finding and Reading Buffers */
8925a3dc DC	198	struct xfs_buf xfs_buf_incore(struct xfs_buftarg target,
	199	xfs_daddr_t blkno, size_t numblks,
	200	xfs_buf_flags_t flags);
3e85c868	201
3848b5f6 DW	202	int xfs_buf_get_map(struct xfs_buftarg target, struct xfs_buf_map map,
3848b5f6 DW	203	int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp);
4ed8e27b DW	204	int xfs_buf_read_map(struct xfs_buftarg target, struct xfs_buf_map map,
4ed8e27b DW	205	int nmaps, xfs_buf_flags_t flags, struct xfs_buf **bpp,
cdbcf82b	206	const struct xfs_buf_ops *ops, xfs_failaddr_t fa);
6dde2707	207	void xfs_buf_readahead_map(struct xfs_buftarg *target,
c3f8fc73	208	struct xfs_buf_map *map, int nmaps,
1813dd64	209	const struct xfs_buf_ops *ops);
6dde2707	210
841263e9	211	static inline int
6dde2707 DC	212	xfs_buf_get(
	213	struct xfs_buftarg *target,
	214	xfs_daddr_t blkno,
841263e9 DW	215	size_t numblks,
841263e9 DW	216	struct xfs_buf **bpp)
6dde2707 DC	217	{
6dde2707 DC	218	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
3848b5f6	219
841263e9	220	return xfs_buf_get_map(target, &map, 1, 0, bpp);
6dde2707 DC	221	}
6dde2707 DC	222
0e3eccce	223	static inline int
6dde2707 DC	224	xfs_buf_read(
	225	struct xfs_buftarg *target,
	226	xfs_daddr_t blkno,
	227	size_t numblks,
c3f8fc73	228	xfs_buf_flags_t flags,
0e3eccce	229	struct xfs_buf **bpp,
1813dd64	230	const struct xfs_buf_ops *ops)
6dde2707 DC	231	{
6dde2707 DC	232	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
4ed8e27b	233
cdbcf82b DW	234	return xfs_buf_read_map(target, &map, 1, flags, bpp, ops,
cdbcf82b DW	235	__builtin_return_address(0));
6dde2707 DC	236	}
	237
	238	static inline void
	239	xfs_buf_readahead(
	240	struct xfs_buftarg *target,
	241	xfs_daddr_t blkno,
c3f8fc73	242	size_t numblks,
1813dd64	243	const struct xfs_buf_ops *ops)
6dde2707 DC	244	{
6dde2707 DC	245	DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
1813dd64	246	return xfs_buf_readahead_map(target, &map, 1, ops);
6dde2707	247	}
e70b73f8	248
2842b6db DW	249	int xfs_buf_get_uncached(struct xfs_buftarg *target, size_t numblks, int flags,
2842b6db DW	250	struct xfs_buf **bpp);
ba372674 DC	251	int xfs_buf_read_uncached(struct xfs_buftarg *target, xfs_daddr_t daddr,
	252	size_t numblks, int flags, struct xfs_buf **bpp,
	253	const struct xfs_buf_ops *ops);
26e32875	254	int _xfs_buf_read(struct xfs_buf *bp, xfs_buf_flags_t flags);
e70b73f8	255	void xfs_buf_hold(struct xfs_buf *bp);
1da177e4 LT	256
1da177e4 LT	257	/* Releasing Buffers */
e8222613	258	extern void xfs_buf_rele(struct xfs_buf *);
1da177e4 LT	259
1da177e4 LT	260	/* Locking and Unlocking Buffers */
e8222613 DC	261	extern int xfs_buf_trylock(struct xfs_buf *);
	262	extern void xfs_buf_lock(struct xfs_buf *);
	263	extern void xfs_buf_unlock(struct xfs_buf *);
0c842ad4 CH	264	#define xfs_buf_islocked(bp) \
0c842ad4 CH	265	((bp)->b_sema.count <= 0)
1da177e4	266
e8222613	267	static inline void xfs_buf_relse(struct xfs_buf *bp)
f593bf14 DC	268	{
	269	xfs_buf_unlock(bp);
	270	xfs_buf_rele(bp);
	271	}
	272
1da177e4	273	/* Buffer Read and Write Routines */
c2b006c1	274	extern int xfs_bwrite(struct xfs_buf *bp);
f593bf14	275
31ca03c9 DW	276	extern void __xfs_buf_ioerror(struct xfs_buf *bp, int error,
	277	xfs_failaddr_t failaddr);
	278	#define xfs_buf_ioerror(bp, err) __xfs_buf_ioerror((bp), (err), __this_address)
cdbcf82b	279	extern void xfs_buf_ioerror_alert(struct xfs_buf *bp, xfs_failaddr_t fa);
54b3b1f6	280	void xfs_buf_ioend_fail(struct xfs_buf *);
f9a196ee	281	void xfs_buf_zero(struct xfs_buf *bp, size_t boff, size_t bsize);
8d57c216 DW	282	void __xfs_buf_mark_corrupt(struct xfs_buf *bp, xfs_failaddr_t fa);
8d57c216 DW	283	#define xfs_buf_mark_corrupt(bp) __xfs_buf_mark_corrupt((bp), __this_address)
ce8e922c	284
1da177e4	285	/* Buffer Utility Routines */
88ee2df7	286	extern void xfs_buf_offset(struct xfs_buf , size_t);
5cfd28b6	287	extern void xfs_buf_stale(struct xfs_buf *bp);
1da177e4	288
1da177e4	289	/* Delayed Write Buffer Routines */
20e8a063	290	extern void xfs_buf_delwri_cancel(struct list_head *);
43ff2122 CH	291	extern bool xfs_buf_delwri_queue(struct xfs_buf , struct list_head );
	292	extern int xfs_buf_delwri_submit(struct list_head *);
	293	extern int xfs_buf_delwri_submit_nowait(struct list_head *);
7912e7fe	294	extern int xfs_buf_delwri_pushbuf(struct xfs_buf , struct list_head );
1da177e4 LT	295
1da177e4 LT	296	/* Buffer Daemon Setup Routines */
ce8e922c NS	297	extern int xfs_buf_init(void);
ce8e922c NS	298	extern void xfs_buf_terminate(void);
1da177e4	299
04fcad80 DC	300	static inline xfs_daddr_t xfs_buf_daddr(struct xfs_buf *bp)
	301	{
	302	return bp->b_maps[0].bm_bn;
	303	}
	304
7561d27e	305	void xfs_buf_set_ref(struct xfs_buf *bp, int lru_ref);
ce8e922c	306
879de98e DC	307	/*
	308	* If the buffer is already on the LRU, do nothing. Otherwise set the buffer
	309	* up with a reference count of 0 so it will be tossed from the cache when
	310	* released.
	311	*/
	312	static inline void xfs_buf_oneshot(struct xfs_buf *bp)
	313	{
	314	if (!list_empty(&bp->b_lru) \|\| atomic_read(&bp->b_lru_ref) > 1)
	315	return;
	316	atomic_set(&bp->b_lru_ref, 0);
	317	}
	318
811e64c7 CS	319	static inline int xfs_buf_ispinned(struct xfs_buf *bp)
	320	{
	321	return atomic_read(&bp->b_pin_count);
	322	}
ce8e922c	323
51582170 ES	324	static inline int
	325	xfs_buf_verify_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
	326	{
	327	return xfs_verify_cksum(bp->b_addr, BBTOB(bp->b_length),
	328	cksum_offset);
	329	}
	330
f1dbcd7e ES	331	static inline void
	332	xfs_buf_update_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
	333	{
	334	xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length),
	335	cksum_offset);
	336	}
	337
1da177e4 LT	338	/*
	339	* Handling of buftargs.
	340	*/
10fb9ac1 BF	341	extern struct xfs_buftarg xfs_alloc_buftarg(struct xfs_mount ,
10fb9ac1 BF	342	struct block_device , struct dax_device );
a1f69417	343	extern void xfs_free_buftarg(struct xfs_buftarg *);
8321ddb2	344	extern void xfs_buftarg_wait(struct xfs_buftarg *);
10fb9ac1 BF	345	extern void xfs_buftarg_drain(struct xfs_buftarg *);
10fb9ac1 BF	346	extern int xfs_setsize_buftarg(struct xfs_buftarg *, unsigned int);
d808f617	347
ce8e922c NS	348	#define xfs_getsize_buftarg(buftarg) block_size((buftarg)->bt_bdev)
	349	#define xfs_readonly_buftarg(buftarg) bdev_read_only((buftarg)->bt_bdev)
	350
75d02303	351	int xfs_buf_reverify(struct xfs_buf bp, const struct xfs_buf_ops ops);
15baadf7 DW	352	bool xfs_verify_magic(struct xfs_buf *bp, __be32 dmagic);
15baadf7 DW	353	bool xfs_verify_magic16(struct xfs_buf *bp, __be16 dmagic);
1aff5696	354
1da177e4	355	#endif /* __XFS_BUF_H__ */