1/*
  2 * Copyright (c) 2000-2003,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_INODE_FORK_H__
 19#define	__XFS_INODE_FORK_H__
 20
 21struct xfs_inode_log_item;
 22struct xfs_dinode;
 23
 24/*
 25 * File incore extent information, present for each of data & attr forks.
 26 */
 27typedef struct xfs_ifork {
 28	int			if_bytes;	/* bytes in if_u1 */
 29	int			if_real_bytes;	/* bytes allocated in if_u1 */
 30	struct xfs_btree_block	*if_broot;	/* file's incore btree root */
 31	short			if_broot_bytes;	/* bytes allocated for root */
 32	unsigned char		if_flags;	/* per-fork flags */
 33	int			if_height;	/* height of the extent tree */
 34	union {
 35		void		*if_root;	/* extent tree root */
 36		char		*if_data;	/* inline file data */
 37	} if_u1;
 38} xfs_ifork_t;
 39
 40/*
 41 * Per-fork incore inode flags.
 42 */
 43#define	XFS_IFINLINE	0x01	/* Inline data is read in */
 44#define	XFS_IFEXTENTS	0x02	/* All extent pointers are read in */
 45#define	XFS_IFBROOT	0x04	/* i_broot points to the bmap b-tree root */
 46
 47/*
 48 * Fork handling.
 49 */
 50
 51#define XFS_IFORK_Q(ip)			((ip)->i_d.di_forkoff != 0)
 52#define XFS_IFORK_BOFF(ip)		((int)((ip)->i_d.di_forkoff << 3))
 53
 54#define XFS_IFORK_PTR(ip,w)		\
 55	((w) == XFS_DATA_FORK ? \
 56		&(ip)->i_df : \
 57		((w) == XFS_ATTR_FORK ? \
 58			(ip)->i_afp : \
 59			(ip)->i_cowfp))
 60#define XFS_IFORK_DSIZE(ip) \
 61	(XFS_IFORK_Q(ip) ? \
 62		XFS_IFORK_BOFF(ip) : \
 63		XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
 64#define XFS_IFORK_ASIZE(ip) \
 65	(XFS_IFORK_Q(ip) ? \
 66		XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
 67			XFS_IFORK_BOFF(ip) : \
 68		0)
 69#define XFS_IFORK_SIZE(ip,w) \
 70	((w) == XFS_DATA_FORK ? \
 71		XFS_IFORK_DSIZE(ip) : \
 72		((w) == XFS_ATTR_FORK ? \
 73			XFS_IFORK_ASIZE(ip) : \
 74			0))
 75#define XFS_IFORK_FORMAT(ip,w) \
 76	((w) == XFS_DATA_FORK ? \
 77		(ip)->i_d.di_format : \
 78		((w) == XFS_ATTR_FORK ? \
 79			(ip)->i_d.di_aformat : \
 80			(ip)->i_cformat))
 81#define XFS_IFORK_FMT_SET(ip,w,n) \
 82	((w) == XFS_DATA_FORK ? \
 83		((ip)->i_d.di_format = (n)) : \
 84		((w) == XFS_ATTR_FORK ? \
 85			((ip)->i_d.di_aformat = (n)) : \
 86			((ip)->i_cformat = (n))))
 87#define XFS_IFORK_NEXTENTS(ip,w) \
 88	((w) == XFS_DATA_FORK ? \
 89		(ip)->i_d.di_nextents : \
 90		((w) == XFS_ATTR_FORK ? \
 91			(ip)->i_d.di_anextents : \
 92			(ip)->i_cnextents))
 93#define XFS_IFORK_NEXT_SET(ip,w,n) \
 94	((w) == XFS_DATA_FORK ? \
 95		((ip)->i_d.di_nextents = (n)) : \
 96		((w) == XFS_ATTR_FORK ? \
 97			((ip)->i_d.di_anextents = (n)) : \
 98			((ip)->i_cnextents = (n))))
 99#define XFS_IFORK_MAXEXT(ip, w) \
100	(XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))
101
102struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state);
103
104int		xfs_iformat_fork(struct xfs_inode *, struct xfs_dinode *);
105void		xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *,
106				struct xfs_inode_log_item *, int);
107void		xfs_idestroy_fork(struct xfs_inode *, int);
108void		xfs_idata_realloc(struct xfs_inode *, int, int);
109void		xfs_iroot_realloc(struct xfs_inode *, int, int);
110int		xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
111int		xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *,
112				  int);
113void		xfs_init_local_fork(struct xfs_inode *, int, const void *, int);
114
115xfs_extnum_t	xfs_iext_count(struct xfs_ifork *ifp);
116void		xfs_iext_insert(struct xfs_inode *, struct xfs_iext_cursor *cur,
117			struct xfs_bmbt_irec *, int);
118void		xfs_iext_remove(struct xfs_inode *, struct xfs_iext_cursor *,
119			int);
120void		xfs_iext_destroy(struct xfs_ifork *);
121
122bool		xfs_iext_lookup_extent(struct xfs_inode *ip,
123			struct xfs_ifork *ifp, xfs_fileoff_t bno,
124			struct xfs_iext_cursor *cur,
125			struct xfs_bmbt_irec *gotp);
126bool		xfs_iext_lookup_extent_before(struct xfs_inode *ip,
127			struct xfs_ifork *ifp, xfs_fileoff_t *end,
128			struct xfs_iext_cursor *cur,
129			struct xfs_bmbt_irec *gotp);
130bool		xfs_iext_get_extent(struct xfs_ifork *ifp,
131			struct xfs_iext_cursor *cur,
132			struct xfs_bmbt_irec *gotp);
133void		xfs_iext_update_extent(struct xfs_inode *ip, int state,
134			struct xfs_iext_cursor *cur,
135			struct xfs_bmbt_irec *gotp);
136
137void		xfs_iext_first(struct xfs_ifork *, struct xfs_iext_cursor *);
138void		xfs_iext_last(struct xfs_ifork *, struct xfs_iext_cursor *);
139void		xfs_iext_next(struct xfs_ifork *, struct xfs_iext_cursor *);
140void		xfs_iext_prev(struct xfs_ifork *, struct xfs_iext_cursor *);
141
142static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp,
143		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
144{
145	xfs_iext_next(ifp, cur);
146	return xfs_iext_get_extent(ifp, cur, gotp);
147}
148
149static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp,
150		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
151{
152	xfs_iext_prev(ifp, cur);
153	return xfs_iext_get_extent(ifp, cur, gotp);
154}
155
156/*
157 * Return the extent after cur in gotp without updating the cursor.
158 */
159static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp,
160		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
161{
162	struct xfs_iext_cursor ncur = *cur;
163
164	xfs_iext_next(ifp, &ncur);
165	return xfs_iext_get_extent(ifp, &ncur, gotp);
166}
167
168/*
169 * Return the extent before cur in gotp without updating the cursor.
170 */
171static inline bool xfs_iext_peek_prev_extent(struct xfs_ifork *ifp,
172		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
173{
174	struct xfs_iext_cursor ncur = *cur;
175
176	xfs_iext_prev(ifp, &ncur);
177	return xfs_iext_get_extent(ifp, &ncur, gotp);
178}
179
180#define for_each_xfs_iext(ifp, ext, got)		\
181	for (xfs_iext_first((ifp), (ext));		\
182	     xfs_iext_get_extent((ifp), (ext), (got));	\
183	     xfs_iext_next((ifp), (ext)))
184
185extern struct kmem_zone	*xfs_ifork_zone;
186
187extern void xfs_ifork_init_cow(struct xfs_inode *ip);
188
189typedef xfs_failaddr_t (*xfs_ifork_verifier_t)(struct xfs_inode *);
190
191struct xfs_ifork_ops {
192	xfs_ifork_verifier_t	verify_symlink;
193	xfs_ifork_verifier_t	verify_dir;
194	xfs_ifork_verifier_t	verify_attr;
195};
196extern struct xfs_ifork_ops	xfs_default_ifork_ops;
197
198xfs_failaddr_t xfs_ifork_verify_data(struct xfs_inode *ip,
199		struct xfs_ifork_ops *ops);
200xfs_failaddr_t xfs_ifork_verify_attr(struct xfs_inode *ip,
201		struct xfs_ifork_ops *ops);
202
203#endif	/* __XFS_INODE_FORK_H__ */