[net-next-2.6.git] / fs / xfs / xfs_buf_item.h

/*
 * Copyright (c) 2000-2001,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	__XFS_BUF_ITEM_H__
#define	__XFS_BUF_ITEM_H__

/*
 * This is the structure used to lay out a buf log item in the
 * log.  The data map describes which 128 byte chunks of the buffer
 * have been logged.
 * For 6.2 and beyond, this is XFS_LI_BUF.  We use this to log everything.
 */
typedef struct xfs_buf_log_format_t {
	unsigned short	blf_type;	/* buf log item type indicator */
	unsigned short	blf_size;	/* size of this item */
	ushort		blf_flags;	/* misc state */
	ushort		blf_len;	/* number of blocks in this buf */
	__int64_t	blf_blkno;	/* starting blkno of this buf */
	unsigned int	blf_map_size;	/* size of data bitmap in words */
	unsigned int	blf_data_map[1];/* variable size bitmap of */
					/*   regions of buffer in this item */
} xfs_buf_log_format_t;

/*
 * This flag indicates that the buffer contains on disk inodes
 * and requires special recovery handling.
 */
#define	XFS_BLI_INODE_BUF	0x1
/*
 * This flag indicates that the buffer should not be replayed
 * during recovery because its blocks are being freed.
 */
#define	XFS_BLI_CANCEL		0x2
/*
 * This flag indicates that the buffer contains on disk
 * user or group dquots and may require special recovery handling.
 */
#define	XFS_BLI_UDQUOT_BUF	0x4
#define XFS_BLI_PDQUOT_BUF	0x8
#define	XFS_BLI_GDQUOT_BUF	0x10

#define	XFS_BLI_CHUNK		128
#define	XFS_BLI_SHIFT		7
#define	BIT_TO_WORD_SHIFT	5
#define	NBWORD			(NBBY * sizeof(unsigned int))

/*
 * buf log item flags
 */
#define	XFS_BLI_HOLD		0x01
#define	XFS_BLI_DIRTY		0x02
#define	XFS_BLI_STALE		0x04
#define	XFS_BLI_LOGGED		0x08
#define	XFS_BLI_INODE_ALLOC_BUF	0x10
#define XFS_BLI_STALE_INODE	0x20


#ifdef __KERNEL__

struct xfs_buf;
struct ktrace;
struct xfs_mount;
struct xfs_buf_log_item;

#if defined(XFS_BLI_TRACE)
#define	XFS_BLI_TRACE_SIZE	32

void	xfs_buf_item_trace(char *, struct xfs_buf_log_item *);
#else
#define	xfs_buf_item_trace(id, bip)
#endif

/*
 * This is the in core log item structure used to track information
 * needed to log buffers.  It tracks how many times the lock has been
 * locked, and which 128 byte chunks of the buffer are dirty.
 */
typedef struct xfs_buf_log_item {
	xfs_log_item_t		bli_item;	/* common item structure */
	struct xfs_buf		*bli_buf;	/* real buffer pointer */
	unsigned int		bli_flags;	/* misc flags */
	unsigned int		bli_recur;	/* lock recursion count */
	atomic_t		bli_refcount;	/* cnt of tp refs */
#ifdef XFS_BLI_TRACE
	struct ktrace		*bli_trace;	/* event trace buf */
#endif
#ifdef XFS_TRANS_DEBUG
	char			*bli_orig;	/* original buffer copy */
	char			*bli_logged;	/* bytes logged (bitmap) */
#endif
	xfs_buf_log_format_t	bli_format;	/* in-log header */
} xfs_buf_log_item_t;

/*
 * This structure is used during recovery to record the buf log
 * items which have been canceled and should not be replayed.
 */
typedef struct xfs_buf_cancel {
	xfs_daddr_t		bc_blkno;
	uint			bc_len;
	int			bc_refcount;
	struct xfs_buf_cancel	*bc_next;
} xfs_buf_cancel_t;

void	xfs_buf_item_init(struct xfs_buf *, struct xfs_mount *);
void	xfs_buf_item_relse(struct xfs_buf *);
void	xfs_buf_item_log(xfs_buf_log_item_t *, uint, uint);
uint	xfs_buf_item_dirty(xfs_buf_log_item_t *);
void	xfs_buf_attach_iodone(struct xfs_buf *,
			      void(*)(struct xfs_buf *, xfs_log_item_t *),
			      xfs_log_item_t *);
void	xfs_buf_iodone_callbacks(struct xfs_buf *);
void	xfs_buf_iodone(struct xfs_buf *, xfs_buf_log_item_t *);

#ifdef XFS_TRANS_DEBUG
void
xfs_buf_item_flush_log_debug(
	struct xfs_buf *bp,
	uint	first,
	uint	last);
#else
#define	xfs_buf_item_flush_log_debug(bp, first, last)
#endif

#endif	/* __KERNEL__ */

#endif	/* __XFS_BUF_ITEM_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	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.
1da177e4	13	*
7b718769 NS	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
1da177e4 LT	17	*/
	18	#ifndef __XFS_BUF_ITEM_H__
	19	#define __XFS_BUF_ITEM_H__
	20
	21	/*
	22	* This is the structure used to lay out a buf log item in the
	23	* log. The data map describes which 128 byte chunks of the buffer
804195b6	24	* have been logged.
1da177e4 LT	25	* For 6.2 and beyond, this is XFS_LI_BUF. We use this to log everything.
	26	*/
	27	typedef struct xfs_buf_log_format_t {
	28	unsigned short blf_type; /* buf log item type indicator */
	29	unsigned short blf_size; /* size of this item */
	30	ushort blf_flags; /* misc state */
	31	ushort blf_len; /* number of blocks in this buf */
	32	__int64_t blf_blkno; /* starting blkno of this buf */
	33	unsigned int blf_map_size; /* size of data bitmap in words */
	34	unsigned int blf_data_map[1];/* variable size bitmap of */
	35	/* regions of buffer in this item */
	36	} xfs_buf_log_format_t;
	37
	38	/*
	39	* This flag indicates that the buffer contains on disk inodes
	40	* and requires special recovery handling.
	41	*/
	42	#define XFS_BLI_INODE_BUF 0x1
	43	/*
	44	* This flag indicates that the buffer should not be replayed
	45	* during recovery because its blocks are being freed.
	46	*/
	47	#define XFS_BLI_CANCEL 0x2
	48	/*
	49	* This flag indicates that the buffer contains on disk
	50	* user or group dquots and may require special recovery handling.
	51	*/
	52	#define XFS_BLI_UDQUOT_BUF 0x4
c8ad20ff	53	#define XFS_BLI_PDQUOT_BUF 0x8
1da177e4 LT	54	#define XFS_BLI_GDQUOT_BUF 0x10
	55
	56	#define XFS_BLI_CHUNK 128
	57	#define XFS_BLI_SHIFT 7
	58	#define BIT_TO_WORD_SHIFT 5
	59	#define NBWORD (NBBY * sizeof(unsigned int))
	60
	61	/*
	62	* buf log item flags
	63	*/
	64	#define XFS_BLI_HOLD 0x01
	65	#define XFS_BLI_DIRTY 0x02
	66	#define XFS_BLI_STALE 0x04
	67	#define XFS_BLI_LOGGED 0x08
	68	#define XFS_BLI_INODE_ALLOC_BUF 0x10
	69	#define XFS_BLI_STALE_INODE 0x20
	70
	71
	72	#ifdef __KERNEL__
	73
	74	struct xfs_buf;
	75	struct ktrace;
	76	struct xfs_mount;
	77	struct xfs_buf_log_item;
	78
	79	#if defined(XFS_BLI_TRACE)
	80	#define XFS_BLI_TRACE_SIZE 32
	81
	82	void xfs_buf_item_trace(char , struct xfs_buf_log_item );
	83	#else
	84	#define xfs_buf_item_trace(id, bip)
	85	#endif
	86
	87	/*
	88	* This is the in core log item structure used to track information
	89	* needed to log buffers. It tracks how many times the lock has been
	90	* locked, and which 128 byte chunks of the buffer are dirty.
	91	*/
	92	typedef struct xfs_buf_log_item {
	93	xfs_log_item_t bli_item; /* common item structure */
	94	struct xfs_buf bli_buf; / real buffer pointer */
	95	unsigned int bli_flags; /* misc flags */
	96	unsigned int bli_recur; /* lock recursion count */
	97	atomic_t bli_refcount; /* cnt of tp refs */
	98	#ifdef XFS_BLI_TRACE
	99	struct ktrace bli_trace; / event trace buf */
	100	#endif
	101	#ifdef XFS_TRANS_DEBUG
	102	char bli_orig; / original buffer copy */
	103	char bli_logged; / bytes logged (bitmap) */
	104	#endif
	105	xfs_buf_log_format_t bli_format; /* in-log header */
	106	} xfs_buf_log_item_t;
	107
	108	/*
	109	* This structure is used during recovery to record the buf log
	110	* items which have been canceled and should not be replayed.
	111	*/
	112	typedef struct xfs_buf_cancel {
	113	xfs_daddr_t bc_blkno;
	114	uint bc_len;
	115	int bc_refcount;
	116	struct xfs_buf_cancel *bc_next;
	117	} xfs_buf_cancel_t;
118
119	void xfs_buf_item_init(struct xfs_buf , struct xfs_mount );
120	void xfs_buf_item_relse(struct xfs_buf *);
121	void xfs_buf_item_log(xfs_buf_log_item_t *, uint, uint);
122	uint xfs_buf_item_dirty(xfs_buf_log_item_t *);
123	void xfs_buf_attach_iodone(struct xfs_buf *,
124	void()(struct xfs_buf , xfs_log_item_t *),
125	xfs_log_item_t *);
126	void xfs_buf_iodone_callbacks(struct xfs_buf *);
127	void xfs_buf_iodone(struct xfs_buf , xfs_buf_log_item_t );
128
129	#ifdef XFS_TRANS_DEBUG
130	void
131	xfs_buf_item_flush_log_debug(
132	struct xfs_buf *bp,
133	uint first,
134	uint last);
135	#else
136	#define xfs_buf_item_flush_log_debug(bp, first, last)
137	#endif
138
139	#endif /* __KERNEL__ */
140
141	#endif /* __XFS_BUF_ITEM_H__ */