[thirdparty/xfsprogs-dev.git] / libxfs / libxfs_io.h

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

#ifndef __LIBXFS_IO_H_
#define __LIBXFS_IO_H_

/*
 * Kernel equivalent buffer based I/O interface
 */

struct xfs_buf;
struct xfs_mount;
struct xfs_perag;

/*
 * IO verifier callbacks need the xfs_mount pointer, so we have to behave
 * somewhat like the kernel now for userspace IO in terms of having buftarg
 * based devices...
 */
struct xfs_buftarg {
	struct xfs_mount	*bt_mount;
	dev_t			dev;
};

extern void	libxfs_buftarg_init(struct xfs_mount *mp, dev_t ddev,
				    dev_t logdev, dev_t rtdev);

#define LIBXFS_BBTOOFF64(bbs)	(((xfs_off_t)(bbs)) << BBSHIFT)

#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 *);
};

typedef struct xfs_buf {
	struct cache_node	b_node;
	unsigned int		b_flags;
	xfs_daddr_t		b_bn;
	unsigned		b_bcount;
	unsigned int		b_length;
	struct xfs_buftarg	*b_target;
#define b_dev		b_target->dev
	pthread_mutex_t		b_lock;
	pthread_t		b_holder;
	unsigned int		b_recur;
	void			*b_log_item;
	void			*b_transp;
	void			*b_addr;
	int			b_error;
	const struct xfs_buf_ops *b_ops;
	struct xfs_perag	*b_pag;
	struct xfs_buf_map	*b_maps;
	struct xfs_buf_map	__b_map;
	int			b_nmaps;
#ifdef XFS_BUF_TRACING
	struct list_head	b_lock_list;
	const char		*b_func;
	const char		*b_file;
	int			b_line;
#endif
} xfs_buf_t;

bool xfs_verify_magic(struct xfs_buf *bp, __be32 dmagic);
bool xfs_verify_magic16(struct xfs_buf *bp, __be16 dmagic);

enum xfs_buf_flags_t {	/* b_flags bits */
	LIBXFS_B_EXIT		= 0x0001,	/* ==LIBXFS_EXIT_ON_FAILURE */
	LIBXFS_B_DIRTY		= 0x0002,	/* buffer has been modified */
	LIBXFS_B_STALE		= 0x0004,	/* buffer marked as invalid */
	LIBXFS_B_UPTODATE	= 0x0008,	/* buffer is sync'd to disk */
	LIBXFS_B_DISCONTIG	= 0x0010,	/* discontiguous buffer */
	LIBXFS_B_UNCHECKED	= 0x0020,	/* needs verification */
};

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

#define xfs_buf_offset(bp, offset)	((bp)->b_addr + (offset))
#define XFS_BUF_ADDR(bp)		((bp)->b_bn)
#define XFS_BUF_SIZE(bp)		((bp)->b_bcount)

#define XFS_BUF_SET_ADDR(bp,blk)	((bp)->b_bn = (blk))

#define XFS_BUF_SET_PRIORITY(bp,pri)	cache_node_set_priority( \
						libxfs_bcache, \
						(struct cache_node *)(bp), \
						(pri))
#define XFS_BUF_PRIORITY(bp)		(cache_node_get_priority( \
						(struct cache_node *)(bp)))
#define xfs_buf_set_ref(bp,ref)		((void) 0)
#define xfs_buf_ioerror(bp,err)		((bp)->b_error = (err))

#define xfs_daddr_to_agno(mp,d) \
	((xfs_agnumber_t)(XFS_BB_TO_FSBT(mp, d) / (mp)->m_sb.sb_agblocks))
#define xfs_daddr_to_agbno(mp,d) \
	((xfs_agblock_t)(XFS_BB_TO_FSBT(mp, d) % (mp)->m_sb.sb_agblocks))

/* Buffer Cache Interfaces */

extern struct cache	*libxfs_bcache;
extern struct cache_operations	libxfs_bcache_operations;

#define LIBXFS_GETBUF_TRYLOCK	(1 << 0)

#ifdef XFS_BUF_TRACING

#define libxfs_readbuf(dev, daddr, len, flags, ops) \
	libxfs_trace_readbuf(__FUNCTION__, __FILE__, __LINE__, \
			    (dev), (daddr), (len), (flags), (ops))
#define libxfs_readbuf_map(dev, map, nmaps, flags, ops) \
	libxfs_trace_readbuf_map(__FUNCTION__, __FILE__, __LINE__, \
			    (dev), (map), (nmaps), (flags), (ops))
#define libxfs_writebuf(buf, flags) \
	libxfs_trace_writebuf(__FUNCTION__, __FILE__, __LINE__, \
			      (buf), (flags))
#define libxfs_getbuf(dev, daddr, len) \
	libxfs_trace_getbuf(__FUNCTION__, __FILE__, __LINE__, \
			    (dev), (daddr), (len))
#define libxfs_getbuf_map(dev, map, nmaps, flags) \
	libxfs_trace_getbuf_map(__FUNCTION__, __FILE__, __LINE__, \
			    (dev), (map), (nmaps), (flags))
#define libxfs_getbuf_flags(dev, daddr, len, flags) \
	libxfs_trace_getbuf_flags(__FUNCTION__, __FILE__, __LINE__, \
			    (dev), (daddr), (len), (flags))
#define libxfs_putbuf(buf) \
	libxfs_trace_putbuf(__FUNCTION__, __FILE__, __LINE__, (buf))

extern xfs_buf_t *libxfs_trace_readbuf(const char *, const char *, int,
			struct xfs_buftarg *, xfs_daddr_t, int, int,
			const struct xfs_buf_ops *);
extern xfs_buf_t *libxfs_trace_readbuf_map(const char *, const char *, int,
			struct xfs_buftarg *, struct xfs_buf_map *, int, int,
			const struct xfs_buf_ops *);
extern int	libxfs_trace_writebuf(const char *, const char *, int,
			xfs_buf_t *, int);
extern xfs_buf_t *libxfs_trace_getbuf(const char *, const char *, int,
			struct xfs_buftarg *, xfs_daddr_t, int);
extern xfs_buf_t *libxfs_trace_getbuf_map(const char *, const char *, int,
			struct xfs_buftarg *, struct xfs_buf_map *, int, int);
extern xfs_buf_t *libxfs_trace_getbuf_flags(const char *, const char *, int,
			struct xfs_buftarg *, xfs_daddr_t, int, unsigned int);
extern void	libxfs_trace_putbuf (const char *, const char *, int,
			xfs_buf_t *);

#else

extern xfs_buf_t *libxfs_readbuf(struct xfs_buftarg *, xfs_daddr_t, int, int,
			const struct xfs_buf_ops *);
extern xfs_buf_t *libxfs_readbuf_map(struct xfs_buftarg *, struct xfs_buf_map *,
			int, int, const struct xfs_buf_ops *);
extern int	libxfs_writebuf(xfs_buf_t *, int);
extern xfs_buf_t *libxfs_getbuf(struct xfs_buftarg *, xfs_daddr_t, int);
extern xfs_buf_t *libxfs_getbuf_map(struct xfs_buftarg *,
			struct xfs_buf_map *, int, int);
extern xfs_buf_t *libxfs_getbuf_flags(struct xfs_buftarg *, xfs_daddr_t,
			int, unsigned int);
extern void	libxfs_putbuf (xfs_buf_t *);

#endif

extern void	libxfs_readbuf_verify(struct xfs_buf *bp,
			const struct xfs_buf_ops *ops);
extern xfs_buf_t *libxfs_getsb(struct xfs_mount *, int);
extern void	libxfs_bcache_purge(void);
extern void	libxfs_bcache_free(void);
extern void	libxfs_bcache_flush(void);
extern void	libxfs_purgebuf(xfs_buf_t *);
extern int	libxfs_bcache_overflowed(void);

/* Buffer (Raw) Interfaces */
extern xfs_buf_t *libxfs_getbufr(struct xfs_buftarg *, xfs_daddr_t, int);
extern void	libxfs_putbufr(xfs_buf_t *);

extern int	libxfs_writebuf_int(xfs_buf_t *, int);
extern int	libxfs_writebufr(struct xfs_buf *);
extern int	libxfs_readbufr(struct xfs_buftarg *, xfs_daddr_t, xfs_buf_t *, int, int);
extern int	libxfs_readbufr_map(struct xfs_buftarg *, struct xfs_buf *, int);

extern int	libxfs_device_zero(struct xfs_buftarg *, xfs_daddr_t, uint);

extern int libxfs_bhash_size;

#define LIBXFS_BREAD	0x1
#define LIBXFS_BWRITE	0x2
#define LIBXFS_BZERO	0x4

extern void	libxfs_iomove (xfs_buf_t *, uint, int, void *, int);

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);
}

static inline int
xfs_buf_associate_memory(struct xfs_buf *bp, void *mem, size_t len)
{
	bp->b_addr = mem;
	bp->b_bcount = len;
	return 0;
}

#endif	/* __LIBXFS_IO_H__ */
Commit	Line	Data
959ef981	1	// SPDX-License-Identifier: GPL-2.0
b626fb59 DC	2	/*
	3	* Copyright (c) 2000-2005 Silicon Graphics, Inc.
	4	* All Rights Reserved.
b626fb59 DC	5	*/
	6
	7	#ifndef __LIBXFS_IO_H_
	8	#define __LIBXFS_IO_H_
	9
	10	/*
	11	* Kernel equivalent buffer based I/O interface
	12	*/
	13
	14	struct xfs_buf;
	15	struct xfs_mount;
	16	struct xfs_perag;
	17
	18	/*
	19	* IO verifier callbacks need the xfs_mount pointer, so we have to behave
	20	* somewhat like the kernel now for userspace IO in terms of having buftarg
	21	* based devices...
	22	*/
	23	struct xfs_buftarg {
	24	struct xfs_mount *bt_mount;
	25	dev_t dev;
	26	};
	27
	28	extern void libxfs_buftarg_init(struct xfs_mount *mp, dev_t ddev,
	29	dev_t logdev, dev_t rtdev);
	30
	31	#define LIBXFS_BBTOOFF64(bbs) (((xfs_off_t)(bbs)) << BBSHIFT)
	32
	33	#define XB_PAGES 2
	34	struct xfs_buf_map {
	35	xfs_daddr_t bm_bn; /* block number for I/O */
	36	int bm_len; /* size of I/O */
	37	};
	38
	39	#define DEFINE_SINGLE_BUF_MAP(map, blkno, numblk) \
	40	struct xfs_buf_map (map) = { .bm_bn = (blkno), .bm_len = (numblk) };
	41
	42	struct xfs_buf_ops {
a3fac935	43	char *name;
9e26de8f DW	44	union {
	45	__be32 magic[2]; /* v4 and v5 on disk magic values */
	46	__be16 magic16[2]; /* v4 and v5 on disk magic values */
	47	};
b626fb59 DC	48	void (verify_read)(struct xfs_buf );
b626fb59 DC	49	void (verify_write)(struct xfs_buf );
95d9582b	50	xfs_failaddr_t (verify_struct)(struct xfs_buf );
b626fb59 DC	51	};
	52
	53	typedef struct xfs_buf {
	54	struct cache_node b_node;
	55	unsigned int b_flags;
	56	xfs_daddr_t b_bn;
	57	unsigned b_bcount;
	58	unsigned int b_length;
	59	struct xfs_buftarg *b_target;
	60	#define b_dev b_target->dev
	61	pthread_mutex_t b_lock;
	62	pthread_t b_holder;
	63	unsigned int b_recur;
37d086ca	64	void *b_log_item;
cfc06b60	65	void *b_transp;
b626fb59 DC	66	void *b_addr;
	67	int b_error;
	68	const struct xfs_buf_ops *b_ops;
	69	struct xfs_perag *b_pag;
85428dd2	70	struct xfs_buf_map *b_maps;
2c6c6328	71	struct xfs_buf_map __b_map;
b626fb59 DC	72	int b_nmaps;
	73	#ifdef XFS_BUF_TRACING
	74	struct list_head b_lock_list;
	75	const char *b_func;
	76	const char *b_file;
	77	int b_line;
	78	#endif
	79	} xfs_buf_t;
	80
9e26de8f DW	81	bool xfs_verify_magic(struct xfs_buf *bp, __be32 dmagic);
9e26de8f DW	82	bool xfs_verify_magic16(struct xfs_buf *bp, __be16 dmagic);
c08793bd	83
b626fb59 DC	84	enum xfs_buf_flags_t { /* b_flags bits */
	85	LIBXFS_B_EXIT = 0x0001, /* ==LIBXFS_EXIT_ON_FAILURE */
	86	LIBXFS_B_DIRTY = 0x0002, /* buffer has been modified */
	87	LIBXFS_B_STALE = 0x0004, /* buffer marked as invalid */
	88	LIBXFS_B_UPTODATE = 0x0008, /* buffer is sync'd to disk */
	89	LIBXFS_B_DISCONTIG = 0x0010, /* discontiguous buffer */
	90	LIBXFS_B_UNCHECKED = 0x0020, /* needs verification */
	91	};
	92
	93	#define XFS_BUF_DADDR_NULL ((xfs_daddr_t) (-1LL))
	94
92acb899	95	#define xfs_buf_offset(bp, offset) ((bp)->b_addr + (offset))
b626fb59 DC	96	#define XFS_BUF_ADDR(bp) ((bp)->b_bn)
b626fb59 DC	97	#define XFS_BUF_SIZE(bp) ((bp)->b_bcount)
b626fb59 DC	98
b626fb59 DC	99	#define XFS_BUF_SET_ADDR(bp,blk) ((bp)->b_bn = (blk))
b626fb59	100
b626fb59 DC	101	#define XFS_BUF_SET_PRIORITY(bp,pri) cache_node_set_priority( \
	102	libxfs_bcache, \
	103	(struct cache_node *)(bp), \
	104	(pri))
	105	#define XFS_BUF_PRIORITY(bp) (cache_node_get_priority( \
	106	(struct cache_node *)(bp)))
	107	#define xfs_buf_set_ref(bp,ref) ((void) 0)
	108	#define xfs_buf_ioerror(bp,err) ((bp)->b_error = (err))
	109
	110	#define xfs_daddr_to_agno(mp,d) \
	111	((xfs_agnumber_t)(XFS_BB_TO_FSBT(mp, d) / (mp)->m_sb.sb_agblocks))
	112	#define xfs_daddr_to_agbno(mp,d) \
	113	((xfs_agblock_t)(XFS_BB_TO_FSBT(mp, d) % (mp)->m_sb.sb_agblocks))
	114
	115	/* Buffer Cache Interfaces */
	116
	117	extern struct cache *libxfs_bcache;
	118	extern struct cache_operations libxfs_bcache_operations;
	119
	120	#define LIBXFS_GETBUF_TRYLOCK (1 << 0)
	121
	122	#ifdef XFS_BUF_TRACING
	123
	124	#define libxfs_readbuf(dev, daddr, len, flags, ops) \
	125	libxfs_trace_readbuf(__FUNCTION__, __FILE__, __LINE__, \
	126	(dev), (daddr), (len), (flags), (ops))
	127	#define libxfs_readbuf_map(dev, map, nmaps, flags, ops) \
	128	libxfs_trace_readbuf_map(__FUNCTION__, __FILE__, __LINE__, \
	129	(dev), (map), (nmaps), (flags), (ops))
	130	#define libxfs_writebuf(buf, flags) \
	131	libxfs_trace_writebuf(__FUNCTION__, __FILE__, __LINE__, \
	132	(buf), (flags))
	133	#define libxfs_getbuf(dev, daddr, len) \
	134	libxfs_trace_getbuf(__FUNCTION__, __FILE__, __LINE__, \
	135	(dev), (daddr), (len))
	136	#define libxfs_getbuf_map(dev, map, nmaps, flags) \
	137	libxfs_trace_getbuf_map(__FUNCTION__, __FILE__, __LINE__, \
	138	(dev), (map), (nmaps), (flags))
	139	#define libxfs_getbuf_flags(dev, daddr, len, flags) \
	140	libxfs_trace_getbuf_flags(__FUNCTION__, __FILE__, __LINE__, \
	141	(dev), (daddr), (len), (flags))
	142	#define libxfs_putbuf(buf) \
	143	libxfs_trace_putbuf(__FUNCTION__, __FILE__, __LINE__, (buf))
	144
	145	extern xfs_buf_t libxfs_trace_readbuf(const char , const char *, int,
	146	struct xfs_buftarg *, xfs_daddr_t, int, int,
	147	const struct xfs_buf_ops *);
	148	extern xfs_buf_t libxfs_trace_readbuf_map(const char , const char *, int,
	149	struct xfs_buftarg , struct xfs_buf_map , int, int,
	150	const struct xfs_buf_ops *);
	151	extern int libxfs_trace_writebuf(const char , const char , int,
	152	xfs_buf_t *, int);
	153	extern xfs_buf_t libxfs_trace_getbuf(const char , const char *, int,
	154	struct xfs_buftarg *, xfs_daddr_t, int);
	155	extern xfs_buf_t libxfs_trace_getbuf_map(const char , const char *, int,
	156	struct xfs_buftarg , struct xfs_buf_map , int, int);
	157	extern xfs_buf_t libxfs_trace_getbuf_flags(const char , const char *, int,
	158	struct xfs_buftarg *, xfs_daddr_t, int, unsigned int);
	159	extern void libxfs_trace_putbuf (const char , const char , int,
	160	xfs_buf_t *);
	161
	162	#else
	163
	164	extern xfs_buf_t libxfs_readbuf(struct xfs_buftarg , xfs_daddr_t, int, int,
165	const struct xfs_buf_ops *);
166	extern xfs_buf_t libxfs_readbuf_map(struct xfs_buftarg , struct xfs_buf_map *,
167	int, int, const struct xfs_buf_ops *);
168	extern int libxfs_writebuf(xfs_buf_t *, int);
169	extern xfs_buf_t libxfs_getbuf(struct xfs_buftarg , xfs_daddr_t, int);
170	extern xfs_buf_t libxfs_getbuf_map(struct xfs_buftarg ,
171	struct xfs_buf_map *, int, int);
172	extern xfs_buf_t libxfs_getbuf_flags(struct xfs_buftarg , xfs_daddr_t,
173	int, unsigned int);
174	extern void libxfs_putbuf (xfs_buf_t *);
175
176	#endif
177
178	extern void libxfs_readbuf_verify(struct xfs_buf *bp,
179	const struct xfs_buf_ops *ops);
180	extern xfs_buf_t libxfs_getsb(struct xfs_mount , int);
181	extern void libxfs_bcache_purge(void);
864028ed	182	extern void libxfs_bcache_free(void);
b626fb59 DC	183	extern void libxfs_bcache_flush(void);
	184	extern void libxfs_purgebuf(xfs_buf_t *);
	185	extern int libxfs_bcache_overflowed(void);
b626fb59 DC	186
	187	/* Buffer (Raw) Interfaces */
	188	extern xfs_buf_t libxfs_getbufr(struct xfs_buftarg , xfs_daddr_t, int);
	189	extern void libxfs_putbufr(xfs_buf_t *);
	190
	191	extern int libxfs_writebuf_int(xfs_buf_t *, int);
	192	extern int libxfs_writebufr(struct xfs_buf *);
	193	extern int libxfs_readbufr(struct xfs_buftarg , xfs_daddr_t, xfs_buf_t , int, int);
	194	extern int libxfs_readbufr_map(struct xfs_buftarg , struct xfs_buf , int);
	195
9542ae13 DC	196	extern int libxfs_device_zero(struct xfs_buftarg *, xfs_daddr_t, uint);
9542ae13 DC	197
b626fb59 DC	198	extern int libxfs_bhash_size;
	199
	200	#define LIBXFS_BREAD 0x1
	201	#define LIBXFS_BWRITE 0x2
	202	#define LIBXFS_BZERO 0x4
	203
	204	extern void libxfs_iomove (xfs_buf_t , uint, int, void , int);
	205
	206	static inline int
	207	xfs_buf_verify_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
	208	{
	209	return xfs_verify_cksum(bp->b_addr, BBTOB(bp->b_length),
	210	cksum_offset);
	211	}
	212
	213	static inline void
	214	xfs_buf_update_cksum(struct xfs_buf *bp, unsigned long cksum_offset)
	215	{
	216	xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length),
	217	cksum_offset);
	218	}
	219
fc9f709f ES	220	static inline int
	221	xfs_buf_associate_memory(struct xfs_buf bp, void mem, size_t len)
	222	{
	223	bp->b_addr = mem;
	224	bp->b_bcount = len;
	225	return 0;
	226	}
	227
b626fb59	228	#endif /* __LIBXFS_IO_H__ */