[linux-block.git] / fs / xfs / xfs_inode_item.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	__XFS_INODE_ITEM_H__
#define	__XFS_INODE_ITEM_H__

/*
 * This is the structure used to lay out an inode log item in the
 * log.  The size of the inline data/extents/b-tree root to be logged
 * (if any) is indicated in the ilf_dsize field.  Changes to this structure
 * must be added on to the end.
 *
 * Convention for naming inode log item versions :  The current version
 * is always named XFS_LI_INODE.  When an inode log item gets superseded,
 * add the latest version of IRIX that will generate logs with that item
 * to the version name.
 *
 * -Version 1 of this structure (XFS_LI_5_3_INODE) included up to the first
 *	union (ilf_u) field.  This was released with IRIX 5.3-XFS.
 * -Version 2 of this structure (XFS_LI_6_1_INODE) is currently the entire
 *	structure.  This was released with IRIX 6.0.1-XFS and IRIX 6.1.
 * -Version 3 of this structure (XFS_LI_INODE) is the same as version 2
 *	so a new structure definition wasn't necessary.  However, we had
 *	to add a new type because the inode cluster size changed from 4K
 *	to 8K and the version number had to be rev'ved to keep older kernels
 *	from trying to recover logs with the 8K buffers in them.  The logging
 *	code can handle recovery on different-sized clusters now so hopefully
 *	this'll be the last time we need to change the inode log item just
 *	for a change in the inode cluster size.  This new version was
 *	released with IRIX 6.2.
 */
typedef struct xfs_inode_log_format {
	unsigned short		ilf_type;	/* inode log item type */
	unsigned short		ilf_size;	/* size of this item */
	uint			ilf_fields;	/* flags for fields logged */
	ushort			ilf_asize;	/* size of attr d/ext/root */
	ushort			ilf_dsize;	/* size of data/ext/root */
	xfs_ino_t		ilf_ino;	/* inode number */
	union {
		xfs_dev_t	ilfu_rdev;	/* rdev value for dev inode*/
		uuid_t		ilfu_uuid;	/* mount point value */
	} ilf_u;
	__int64_t		ilf_blkno;	/* blkno of inode buffer */
	int			ilf_len;	/* len of inode buffer */
	int			ilf_boffset;	/* off of inode in buffer */
} xfs_inode_log_format_t;

/* Initial version shipped with IRIX 5.3-XFS */
typedef struct xfs_inode_log_format_v1 {
	unsigned short		ilf_type;	/* inode log item type */
	unsigned short		ilf_size;	/* size of this item */
	uint			ilf_fields;	/* flags for fields logged */
	uint			ilf_dsize;	/* size of data/ext/root */
	xfs_ino_t		ilf_ino;	/* inode number */
	union {
		xfs_dev_t	ilfu_rdev;	/* rdev value for dev inode*/
		uuid_t		ilfu_uuid;	/* mount point value */
	} ilf_u;
} xfs_inode_log_format_t_v1;

/*
 * Flags for xfs_trans_log_inode flags field.
 */
#define	XFS_ILOG_CORE	0x001	/* log standard inode fields */
#define	XFS_ILOG_DDATA	0x002	/* log i_df.if_data */
#define	XFS_ILOG_DEXT	0x004	/* log i_df.if_extents */
#define	XFS_ILOG_DBROOT	0x008	/* log i_df.i_broot */
#define	XFS_ILOG_DEV	0x010	/* log the dev field */
#define	XFS_ILOG_UUID	0x020	/* log the uuid field */
#define	XFS_ILOG_ADATA	0x040	/* log i_af.if_data */
#define	XFS_ILOG_AEXT	0x080	/* log i_af.if_extents */
#define	XFS_ILOG_ABROOT	0x100	/* log i_af.i_broot */

#define	XFS_ILOG_NONCORE	(XFS_ILOG_DDATA | XFS_ILOG_DEXT | \
				 XFS_ILOG_DBROOT | XFS_ILOG_DEV | \
				 XFS_ILOG_UUID | XFS_ILOG_ADATA | \
				 XFS_ILOG_AEXT | XFS_ILOG_ABROOT)

#define	XFS_ILOG_DFORK		(XFS_ILOG_DDATA | XFS_ILOG_DEXT | \
				 XFS_ILOG_DBROOT)

#define	XFS_ILOG_AFORK		(XFS_ILOG_ADATA | XFS_ILOG_AEXT | \
				 XFS_ILOG_ABROOT)

#define	XFS_ILOG_ALL		(XFS_ILOG_CORE | XFS_ILOG_DDATA | \
				 XFS_ILOG_DEXT | XFS_ILOG_DBROOT | \
				 XFS_ILOG_DEV | XFS_ILOG_UUID | \
				 XFS_ILOG_ADATA | XFS_ILOG_AEXT | \
				 XFS_ILOG_ABROOT)

#define	XFS_ILI_HOLD		0x1
#define	XFS_ILI_IOLOCKED_EXCL	0x2
#define	XFS_ILI_IOLOCKED_SHARED	0x4

#define	XFS_ILI_IOLOCKED_ANY   (XFS_ILI_IOLOCKED_EXCL | XFS_ILI_IOLOCKED_SHARED)


#ifdef __KERNEL__

struct xfs_buf;
struct xfs_bmbt_rec_64;
struct xfs_inode;
struct xfs_mount;


typedef struct xfs_inode_log_item {
	xfs_log_item_t		ili_item;	   /* common portion */
	struct xfs_inode	*ili_inode;	   /* inode ptr */
	xfs_lsn_t		ili_flush_lsn;	   /* lsn at last flush */
	xfs_lsn_t		ili_last_lsn;	   /* lsn at last transaction */
	unsigned short		ili_ilock_recur;   /* lock recursion count */
	unsigned short		ili_iolock_recur;  /* lock recursion count */
	unsigned short		ili_flags;	   /* misc flags */
	unsigned short		ili_logged;	   /* flushed logged data */
	unsigned int		ili_last_fields;   /* fields when flushed */
	struct xfs_bmbt_rec_64	*ili_extents_buf;  /* array of logged
						      data exts */
	struct xfs_bmbt_rec_64	*ili_aextents_buf; /* array of logged
						      attr exts */
	unsigned int            ili_pushbuf_flag;  /* one bit used in push_ail */

#ifdef DEBUG
	uint64_t                ili_push_owner;    /* one who sets pushbuf_flag
						      above gets to push the buf */
#endif
#ifdef XFS_TRANS_DEBUG
	int			ili_root_size;
	char			*ili_orig_root;
#endif
	xfs_inode_log_format_t	ili_format;	   /* logged structure */
} xfs_inode_log_item_t;


#define	XFS_ILOG_FDATA(w)	xfs_ilog_fdata(w)
static inline int xfs_ilog_fdata(int w)
{
	return (w == XFS_DATA_FORK ? XFS_ILOG_DDATA : XFS_ILOG_ADATA);
}

#endif	/* __KERNEL__ */

#define	XFS_ILOG_FBROOT(w)	xfs_ilog_fbroot(w)
static inline int xfs_ilog_fbroot(int w)
{
	return (w == XFS_DATA_FORK ? XFS_ILOG_DBROOT : XFS_ILOG_ABROOT);
}

#define	XFS_ILOG_FEXT(w)	xfs_ilog_fext(w)
static inline int xfs_ilog_fext(int w)
{
	return (w == XFS_DATA_FORK ? XFS_ILOG_DEXT : XFS_ILOG_AEXT);
}

#ifdef __KERNEL__

extern void xfs_inode_item_init(struct xfs_inode *, struct xfs_mount *);
extern void xfs_inode_item_destroy(struct xfs_inode *);
extern void xfs_iflush_done(struct xfs_buf *, xfs_inode_log_item_t *);
extern void xfs_istale_done(struct xfs_buf *, xfs_inode_log_item_t *);
extern void xfs_iflush_abort(struct xfs_inode *);

#endif	/* __KERNEL__ */

#endif	/* __XFS_INODE_ITEM_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000,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_INODE_ITEM_H__
	19	#define __XFS_INODE_ITEM_H__
	20
	21	/*
	22	* This is the structure used to lay out an inode log item in the
	23	* log. The size of the inline data/extents/b-tree root to be logged
	24	* (if any) is indicated in the ilf_dsize field. Changes to this structure
	25	* must be added on to the end.
	26	*
	27	* Convention for naming inode log item versions : The current version
	28	* is always named XFS_LI_INODE. When an inode log item gets superseded,
	29	* add the latest version of IRIX that will generate logs with that item
	30	* to the version name.
	31	*
	32	* -Version 1 of this structure (XFS_LI_5_3_INODE) included up to the first
	33	* union (ilf_u) field. This was released with IRIX 5.3-XFS.
	34	* -Version 2 of this structure (XFS_LI_6_1_INODE) is currently the entire
	35	* structure. This was released with IRIX 6.0.1-XFS and IRIX 6.1.
	36	* -Version 3 of this structure (XFS_LI_INODE) is the same as version 2
	37	* so a new structure definition wasn't necessary. However, we had
	38	* to add a new type because the inode cluster size changed from 4K
	39	* to 8K and the version number had to be rev'ved to keep older kernels
	40	* from trying to recover logs with the 8K buffers in them. The logging
	41	* code can handle recovery on different-sized clusters now so hopefully
	42	* this'll be the last time we need to change the inode log item just
	43	* for a change in the inode cluster size. This new version was
	44	* released with IRIX 6.2.
	45	*/
	46	typedef struct xfs_inode_log_format {
	47	unsigned short ilf_type; /* inode log item type */
	48	unsigned short ilf_size; /* size of this item */
	49	uint ilf_fields; /* flags for fields logged */
	50	ushort ilf_asize; /* size of attr d/ext/root */
	51	ushort ilf_dsize; /* size of data/ext/root */
	52	xfs_ino_t ilf_ino; /* inode number */
	53	union {
	54	xfs_dev_t ilfu_rdev; /* rdev value for dev inode*/
	55	uuid_t ilfu_uuid; /* mount point value */
	56	} ilf_u;
	57	__int64_t ilf_blkno; /* blkno of inode buffer */
	58	int ilf_len; /* len of inode buffer */
	59	int ilf_boffset; /* off of inode in buffer */
	60	} xfs_inode_log_format_t;
	61
	62	/* Initial version shipped with IRIX 5.3-XFS */
	63	typedef struct xfs_inode_log_format_v1 {
	64	unsigned short ilf_type; /* inode log item type */
	65	unsigned short ilf_size; /* size of this item */
	66	uint ilf_fields; /* flags for fields logged */
	67	uint ilf_dsize; /* size of data/ext/root */
	68	xfs_ino_t ilf_ino; /* inode number */
	69	union {
	70	xfs_dev_t ilfu_rdev; /* rdev value for dev inode*/
	71	uuid_t ilfu_uuid; /* mount point value */
	72	} ilf_u;
	73	} xfs_inode_log_format_t_v1;
	74
	75	/*
	76	* Flags for xfs_trans_log_inode flags field.
	77	*/
	78	#define XFS_ILOG_CORE 0x001 /* log standard inode fields */
	79	#define XFS_ILOG_DDATA 0x002 /* log i_df.if_data */
	80	#define XFS_ILOG_DEXT 0x004 /* log i_df.if_extents */
81	#define XFS_ILOG_DBROOT 0x008 /* log i_df.i_broot */
82	#define XFS_ILOG_DEV 0x010 /* log the dev field */
83	#define XFS_ILOG_UUID 0x020 /* log the uuid field */
84	#define XFS_ILOG_ADATA 0x040 /* log i_af.if_data */
85	#define XFS_ILOG_AEXT 0x080 /* log i_af.if_extents */
86	#define XFS_ILOG_ABROOT 0x100 /* log i_af.i_broot */
87
88	#define XFS_ILOG_NONCORE (XFS_ILOG_DDATA \| XFS_ILOG_DEXT \| \
89	XFS_ILOG_DBROOT \| XFS_ILOG_DEV \| \
90	XFS_ILOG_UUID \| XFS_ILOG_ADATA \| \
91	XFS_ILOG_AEXT \| XFS_ILOG_ABROOT)
92
93	#define XFS_ILOG_DFORK (XFS_ILOG_DDATA \| XFS_ILOG_DEXT \| \
94	XFS_ILOG_DBROOT)
95
96	#define XFS_ILOG_AFORK (XFS_ILOG_ADATA \| XFS_ILOG_AEXT \| \
97	XFS_ILOG_ABROOT)
98
99	#define XFS_ILOG_ALL (XFS_ILOG_CORE \| XFS_ILOG_DDATA \| \
100	XFS_ILOG_DEXT \| XFS_ILOG_DBROOT \| \
101	XFS_ILOG_DEV \| XFS_ILOG_UUID \| \
102	XFS_ILOG_ADATA \| XFS_ILOG_AEXT \| \
103	XFS_ILOG_ABROOT)
104
105	#define XFS_ILI_HOLD 0x1
106	#define XFS_ILI_IOLOCKED_EXCL 0x2
107	#define XFS_ILI_IOLOCKED_SHARED 0x4
108
109	#define XFS_ILI_IOLOCKED_ANY (XFS_ILI_IOLOCKED_EXCL \| XFS_ILI_IOLOCKED_SHARED)
110
111
112	#ifdef __KERNEL__
113
114	struct xfs_buf;
115	struct xfs_bmbt_rec_64;
116	struct xfs_inode;
117	struct xfs_mount;
118
119
120	typedef struct xfs_inode_log_item {
121	xfs_log_item_t ili_item; /* common portion */
122	struct xfs_inode ili_inode; / inode ptr */
123	xfs_lsn_t ili_flush_lsn; /* lsn at last flush */
124	xfs_lsn_t ili_last_lsn; /* lsn at last transaction */
125	unsigned short ili_ilock_recur; /* lock recursion count */
126	unsigned short ili_iolock_recur; /* lock recursion count */
127	unsigned short ili_flags; /* misc flags */
128	unsigned short ili_logged; /* flushed logged data */
129	unsigned int ili_last_fields; /* fields when flushed */
130	struct xfs_bmbt_rec_64 ili_extents_buf; / array of logged
131	data exts */
132	struct xfs_bmbt_rec_64 ili_aextents_buf; / array of logged
133	attr exts */
134	unsigned int ili_pushbuf_flag; /* one bit used in push_ail */
135
136	#ifdef DEBUG
137	uint64_t ili_push_owner; /* one who sets pushbuf_flag
138	above gets to push the buf */
139	#endif
140	#ifdef XFS_TRANS_DEBUG
141	int ili_root_size;
142	char *ili_orig_root;
143	#endif
144	xfs_inode_log_format_t ili_format; /* logged structure */
145	} xfs_inode_log_item_t;
146
147
1da177e4	148	#define XFS_ILOG_FDATA(w) xfs_ilog_fdata(w)
a844f451 NS	149	static inline int xfs_ilog_fdata(int w)
	150	{
	151	return (w == XFS_DATA_FORK ? XFS_ILOG_DDATA : XFS_ILOG_ADATA);
	152	}
1da177e4 LT	153
	154	#endif /* __KERNEL__ */
	155
1da177e4	156	#define XFS_ILOG_FBROOT(w) xfs_ilog_fbroot(w)
a844f451 NS	157	static inline int xfs_ilog_fbroot(int w)
	158	{
	159	return (w == XFS_DATA_FORK ? XFS_ILOG_DBROOT : XFS_ILOG_ABROOT);
	160	}
	161
1da177e4	162	#define XFS_ILOG_FEXT(w) xfs_ilog_fext(w)
a844f451 NS	163	static inline int xfs_ilog_fext(int w)
	164	{
	165	return (w == XFS_DATA_FORK ? XFS_ILOG_DEXT : XFS_ILOG_AEXT);
	166	}
1da177e4 LT	167
	168	#ifdef __KERNEL__
	169
a844f451 NS	170	extern void xfs_inode_item_init(struct xfs_inode , struct xfs_mount );
	171	extern void xfs_inode_item_destroy(struct xfs_inode *);
	172	extern void xfs_iflush_done(struct xfs_buf , xfs_inode_log_item_t );
	173	extern void xfs_istale_done(struct xfs_buf , xfs_inode_log_item_t );
	174	extern void xfs_iflush_abort(struct xfs_inode *);
1da177e4 LT	175
	176	#endif /* __KERNEL__ */
	177
	178	#endif /* __XFS_INODE_ITEM_H__ */