1/*
2 * Copyright (c) 2000-2001,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#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
24 * have been logged.  This structure works only on buffers that
25 * reside up to the first TB in the filesystem.  These buffers are
26 * generated only by pre-6.2 systems and are known as XFS_LI_6_1_BUF.
27 */
28typedef struct xfs_buf_log_format_v1 {
29	unsigned short	blf_type;	/* buf log item type indicator */
30	unsigned short	blf_size;	/* size of this item */
31	__int32_t	blf_blkno;	/* starting blkno of this buf */
32	ushort		blf_flags;	/* misc state */
33	ushort		blf_len;	/* number of blocks in this buf */
34	unsigned int	blf_map_size;	/* size of data bitmap in words */
35	unsigned int	blf_data_map[1];/* variable size bitmap of */
36					/*   regions of buffer in this item */
37} xfs_buf_log_format_v1_t;
38
39/*
40 * This is a form of the above structure with a 64 bit blkno field.
41 * For 6.2 and beyond, this is XFS_LI_BUF.  We use this to log everything.
42 */
43typedef struct xfs_buf_log_format_t {
44	unsigned short	blf_type;	/* buf log item type indicator */
45	unsigned short	blf_size;	/* size of this item */
46	ushort		blf_flags;	/* misc state */
47	ushort		blf_len;	/* number of blocks in this buf */
48	__int64_t	blf_blkno;	/* starting blkno of this buf */
49	unsigned int	blf_map_size;	/* size of data bitmap in words */
50	unsigned int	blf_data_map[1];/* variable size bitmap of */
51					/*   regions of buffer in this item */
52} xfs_buf_log_format_t;
53
54/*
55 * This flag indicates that the buffer contains on disk inodes
56 * and requires special recovery handling.
57 */
58#define	XFS_BLI_INODE_BUF	0x1
59/*
60 * This flag indicates that the buffer should not be replayed
61 * during recovery because its blocks are being freed.
62 */
63#define	XFS_BLI_CANCEL		0x2
64/*
65 * This flag indicates that the buffer contains on disk
66 * user or group dquots and may require special recovery handling.
67 */
68#define	XFS_BLI_UDQUOT_BUF	0x4
69#define XFS_BLI_PDQUOT_BUF	0x8
70#define	XFS_BLI_GDQUOT_BUF	0x10
71
72#define	XFS_BLI_CHUNK		128
73#define	XFS_BLI_SHIFT		7
74#define	BIT_TO_WORD_SHIFT	5
75#define	NBWORD			(NBBY * sizeof(unsigned int))
76
77/*
78 * buf log item flags
79 */
80#define	XFS_BLI_HOLD		0x01
81#define	XFS_BLI_DIRTY		0x02
82#define	XFS_BLI_STALE		0x04
83#define	XFS_BLI_LOGGED		0x08
84#define	XFS_BLI_INODE_ALLOC_BUF	0x10
85#define XFS_BLI_STALE_INODE	0x20
86
87
88#ifdef __KERNEL__
89
90struct xfs_buf;
91struct ktrace;
92struct xfs_mount;
93struct xfs_buf_log_item;
94
95#if defined(XFS_BLI_TRACE)
96#define	XFS_BLI_TRACE_SIZE	32
97
98void	xfs_buf_item_trace(char *, struct xfs_buf_log_item *);
99#else
100#define	xfs_buf_item_trace(id, bip)
101#endif
102
103/*
104 * This is the in core log item structure used to track information
105 * needed to log buffers.  It tracks how many times the lock has been
106 * locked, and which 128 byte chunks of the buffer are dirty.
107 */
108typedef struct xfs_buf_log_item {
109	xfs_log_item_t		bli_item;	/* common item structure */
110	struct xfs_buf		*bli_buf;	/* real buffer pointer */
111	unsigned int		bli_flags;	/* misc flags */
112	unsigned int		bli_recur;	/* lock recursion count */
113	atomic_t		bli_refcount;	/* cnt of tp refs */
114#ifdef XFS_BLI_TRACE
115	struct ktrace		*bli_trace;	/* event trace buf */
116#endif
117#ifdef XFS_TRANS_DEBUG
118	char			*bli_orig;	/* original buffer copy */
119	char			*bli_logged;	/* bytes logged (bitmap) */
120#endif
121	xfs_buf_log_format_t	bli_format;	/* in-log header */
122} xfs_buf_log_item_t;
123
124/*
125 * This structure is used during recovery to record the buf log
126 * items which have been canceled and should not be replayed.
127 */
128typedef struct xfs_buf_cancel {
129	xfs_daddr_t		bc_blkno;
130	uint			bc_len;
131	int			bc_refcount;
132	struct xfs_buf_cancel	*bc_next;
133} xfs_buf_cancel_t;
134
135void	xfs_buf_item_init(struct xfs_buf *, struct xfs_mount *);
136void	xfs_buf_item_relse(struct xfs_buf *);
137void	xfs_buf_item_log(xfs_buf_log_item_t *, uint, uint);
138uint	xfs_buf_item_dirty(xfs_buf_log_item_t *);
139void	xfs_buf_attach_iodone(struct xfs_buf *,
140			      void(*)(struct xfs_buf *, xfs_log_item_t *),
141			      xfs_log_item_t *);
142void	xfs_buf_iodone_callbacks(struct xfs_buf *);
143void	xfs_buf_iodone(struct xfs_buf *, xfs_buf_log_item_t *);
144
145#ifdef XFS_TRANS_DEBUG
146void
147xfs_buf_item_flush_log_debug(
148	struct xfs_buf *bp,
149	uint	first,
150	uint	last);
151#else
152#define	xfs_buf_item_flush_log_debug(bp, first, last)
153#endif
154
155#endif	/* __KERNEL__ */
156
157#endif	/* __XFS_BUF_ITEM_H__ */
158