xref: /linux/fs/xfs/xfs_buf_item.h (revision d75afeb3d302019527331520a2632b6614425b40)
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 extern kmem_zone_t	*xfs_buf_item_zone;
22 
23 /*
24  * This flag indicates that the buffer contains on disk inodes
25  * and requires special recovery handling.
26  */
27 #define	XFS_BLF_INODE_BUF	(1<<0)
28 /*
29  * This flag indicates that the buffer should not be replayed
30  * during recovery because its blocks are being freed.
31  */
32 #define	XFS_BLF_CANCEL		(1<<1)
33 
34 /*
35  * This flag indicates that the buffer contains on disk
36  * user or group dquots and may require special recovery handling.
37  */
38 #define	XFS_BLF_UDQUOT_BUF	(1<<2)
39 #define XFS_BLF_PDQUOT_BUF	(1<<3)
40 #define	XFS_BLF_GDQUOT_BUF	(1<<4)
41 
42 /*
43  * all buffers now need flags to tell recovery where the magic number
44  * is so that it can verify and calculate the CRCs on the buffer correctly
45  * once the changes have been replayed into the buffer.
46  */
47 #define XFS_BLF_BTREE_BUF	(1<<5)
48 #define XFS_BLF_AGF_BUF		(1<<6)
49 #define XFS_BLF_AGFL_BUF	(1<<7)
50 #define XFS_BLF_AGI_BUF		(1<<8)
51 #define XFS_BLF_DINO_BUF	(1<<9)
52 #define XFS_BLF_SYMLINK_BUF	(1<<10)
53 #define XFS_BLF_DIR_BLOCK_BUF	(1<<11)
54 #define XFS_BLF_DIR_DATA_BUF	(1<<12)
55 #define XFS_BLF_DIR_FREE_BUF	(1<<13)
56 #define XFS_BLF_DIR_LEAF1_BUF	(1<<14)
57 #define XFS_BLF_DIR_LEAFN_BUF	(1<<15)
58 #define XFS_BLF_DA_NODE_BUF	(1<<16)
59 #define XFS_BLF_ATTR_LEAF_BUF	(1<<17)
60 #define XFS_BLF_ATTR_RMT_BUF	(1<<18)
61 
62 #define XFS_BLF_TYPE_MASK	\
63 		(XFS_BLF_UDQUOT_BUF | \
64 		 XFS_BLF_PDQUOT_BUF | \
65 		 XFS_BLF_GDQUOT_BUF | \
66 		 XFS_BLF_BTREE_BUF | \
67 		 XFS_BLF_AGF_BUF | \
68 		 XFS_BLF_AGFL_BUF | \
69 		 XFS_BLF_AGI_BUF | \
70 		 XFS_BLF_DINO_BUF | \
71 		 XFS_BLF_SYMLINK_BUF | \
72 		 XFS_BLF_DIR_BLOCK_BUF | \
73 		 XFS_BLF_DIR_DATA_BUF | \
74 		 XFS_BLF_DIR_FREE_BUF | \
75 		 XFS_BLF_DIR_LEAF1_BUF | \
76 		 XFS_BLF_DIR_LEAFN_BUF | \
77 		 XFS_BLF_DA_NODE_BUF | \
78 		 XFS_BLF_ATTR_LEAF_BUF | \
79 		 XFS_BLF_ATTR_RMT_BUF)
80 
81 #define	XFS_BLF_CHUNK		128
82 #define	XFS_BLF_SHIFT		7
83 #define	BIT_TO_WORD_SHIFT	5
84 #define	NBWORD			(NBBY * sizeof(unsigned int))
85 
86 /*
87  * This is the structure used to lay out a buf log item in the
88  * log.  The data map describes which 128 byte chunks of the buffer
89  * have been logged.
90  */
91 #define XFS_BLF_DATAMAP_SIZE	((XFS_MAX_BLOCKSIZE / XFS_BLF_CHUNK) / NBWORD)
92 
93 typedef struct xfs_buf_log_format {
94 	unsigned short	blf_type;	/* buf log item type indicator */
95 	unsigned short	blf_size;	/* size of this item */
96 	ushort		blf_flags;	/* misc state */
97 	ushort		blf_len;	/* number of blocks in this buf */
98 	__int64_t	blf_blkno;	/* starting blkno of this buf */
99 	unsigned int	blf_map_size;	/* used size of data bitmap in words */
100 	unsigned int	blf_data_map[XFS_BLF_DATAMAP_SIZE]; /* dirty bitmap */
101 } xfs_buf_log_format_t;
102 
103 /*
104  * buf log item flags
105  */
106 #define	XFS_BLI_HOLD		0x01
107 #define	XFS_BLI_DIRTY		0x02
108 #define	XFS_BLI_STALE		0x04
109 #define	XFS_BLI_LOGGED		0x08
110 #define	XFS_BLI_INODE_ALLOC_BUF	0x10
111 #define XFS_BLI_STALE_INODE	0x20
112 #define	XFS_BLI_INODE_BUF	0x40
113 
114 #define XFS_BLI_FLAGS \
115 	{ XFS_BLI_HOLD,		"HOLD" }, \
116 	{ XFS_BLI_DIRTY,	"DIRTY" }, \
117 	{ XFS_BLI_STALE,	"STALE" }, \
118 	{ XFS_BLI_LOGGED,	"LOGGED" }, \
119 	{ XFS_BLI_INODE_ALLOC_BUF, "INODE_ALLOC" }, \
120 	{ XFS_BLI_STALE_INODE,	"STALE_INODE" }, \
121 	{ XFS_BLI_INODE_BUF,	"INODE_BUF" }
122 
123 
124 #ifdef __KERNEL__
125 
126 struct xfs_buf;
127 struct xfs_mount;
128 struct xfs_buf_log_item;
129 
130 /*
131  * This is the in core log item structure used to track information
132  * needed to log buffers.  It tracks how many times the lock has been
133  * locked, and which 128 byte chunks of the buffer are dirty.
134  */
135 typedef struct xfs_buf_log_item {
136 	xfs_log_item_t		bli_item;	/* common item structure */
137 	struct xfs_buf		*bli_buf;	/* real buffer pointer */
138 	unsigned int		bli_flags;	/* misc flags */
139 	unsigned int		bli_recur;	/* lock recursion count */
140 	atomic_t		bli_refcount;	/* cnt of tp refs */
141 	int			bli_format_count;	/* count of headers */
142 	struct xfs_buf_log_format *bli_formats;	/* array of in-log header ptrs */
143 	struct xfs_buf_log_format __bli_format;	/* embedded in-log header */
144 } xfs_buf_log_item_t;
145 
146 void	xfs_buf_item_init(struct xfs_buf *, struct xfs_mount *);
147 void	xfs_buf_item_relse(struct xfs_buf *);
148 void	xfs_buf_item_log(xfs_buf_log_item_t *, uint, uint);
149 uint	xfs_buf_item_dirty(xfs_buf_log_item_t *);
150 void	xfs_buf_attach_iodone(struct xfs_buf *,
151 			      void(*)(struct xfs_buf *, xfs_log_item_t *),
152 			      xfs_log_item_t *);
153 void	xfs_buf_iodone_callbacks(struct xfs_buf *);
154 void	xfs_buf_iodone(struct xfs_buf *, struct xfs_log_item *);
155 
156 #endif	/* __KERNEL__ */
157 
158 #endif	/* __XFS_BUF_ITEM_H__ */
159