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

/*
 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#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;
	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;

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_PTR(bp)			((char *)(bp)->b_addr)
#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_COUNT(bp)		((bp)->b_bcount)
#define XFS_BUF_TARGET(bp)		((bp)->b_dev)
#define XFS_BUF_SET_PTR(bp,p,cnt)	({	\
	(bp)->b_addr = (char *)(p);		\
	XFS_BUF_SET_COUNT(bp,cnt);		\
})

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

#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_flush(void);
extern void	libxfs_purgebuf(xfs_buf_t *);
extern int	libxfs_bcache_overflowed(void);
extern int	libxfs_bcache_usage(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);
}

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