[mirror_ubuntu-bionic-kernel.git] / fs / xfs / xfs_inode_fork.h

/*
 * Copyright (c) 2000-2003,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_FORK_H__
#define	__XFS_INODE_FORK_H__

struct xfs_inode_log_item;

/*
 * The following xfs_ext_irec_t struct introduces a second (top) level
 * to the in-core extent allocation scheme. These structs are allocated
 * in a contiguous block, creating an indirection array where each entry
 * (irec) contains a pointer to a buffer of in-core extent records which
 * it manages. Each extent buffer is 4k in size, since 4k is the system
 * page size on Linux i386 and systems with larger page sizes don't seem
 * to gain much, if anything, by using their native page size as the
 * extent buffer size. Also, using 4k extent buffers everywhere provides
 * a consistent interface for CXFS across different platforms.
 *
 * There is currently no limit on the number of irec's (extent lists)
 * allowed, so heavily fragmented files may require an indirection array
 * which spans multiple system pages of memory. The number of extents
 * which would require this amount of contiguous memory is very large
 * and should not cause problems in the foreseeable future. However,
 * if the memory needed for the contiguous array ever becomes a problem,
 * it is possible that a third level of indirection may be required.
 */
typedef struct xfs_ext_irec {
	xfs_bmbt_rec_host_t *er_extbuf;	/* block of extent records */
	xfs_extnum_t	er_extoff;	/* extent offset in file */
	xfs_extnum_t	er_extcount;	/* number of extents in page/block */
} xfs_ext_irec_t;

/*
 * File incore extent information, present for each of data & attr forks.
 */
#define	XFS_IEXT_BUFSZ		4096
#define	XFS_LINEAR_EXTS		(XFS_IEXT_BUFSZ / (uint)sizeof(xfs_bmbt_rec_t))
#define	XFS_INLINE_EXTS		2
#define	XFS_INLINE_DATA		32
typedef struct xfs_ifork {
	int			if_bytes;	/* bytes in if_u1 */
	int			if_real_bytes;	/* bytes allocated in if_u1 */
	struct xfs_btree_block	*if_broot;	/* file's incore btree root */
	short			if_broot_bytes;	/* bytes allocated for root */
	unsigned char		if_flags;	/* per-fork flags */
	union {
		xfs_bmbt_rec_host_t *if_extents;/* linear map file exts */
		xfs_ext_irec_t	*if_ext_irec;	/* irec map file exts */
		char		*if_data;	/* inline file data */
	} if_u1;
	union {
		xfs_bmbt_rec_host_t if_inline_ext[XFS_INLINE_EXTS];
						/* very small file extents */
		char		if_inline_data[XFS_INLINE_DATA];
						/* very small file data */
		xfs_dev_t	if_rdev;	/* dev number if special */
		uuid_t		if_uuid;	/* mount point value */
	} if_u2;
} xfs_ifork_t;

/*
 * Per-fork incore inode flags.
 */
#define	XFS_IFINLINE	0x01	/* Inline data is read in */
#define	XFS_IFEXTENTS	0x02	/* All extent pointers are read in */
#define	XFS_IFBROOT	0x04	/* i_broot points to the bmap b-tree root */
#define	XFS_IFEXTIREC	0x08	/* Indirection array of extent blocks */

/*
 * Fork handling.
 */

#define XFS_IFORK_Q(ip)			((ip)->i_d.di_forkoff != 0)
#define XFS_IFORK_BOFF(ip)		((int)((ip)->i_d.di_forkoff << 3))

#define XFS_IFORK_PTR(ip,w)		\
	((w) == XFS_DATA_FORK ? \
		&(ip)->i_df : \
		(ip)->i_afp)
#define XFS_IFORK_DSIZE(ip) \
	(XFS_IFORK_Q(ip) ? \
		XFS_IFORK_BOFF(ip) : \
		XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
#define XFS_IFORK_ASIZE(ip) \
	(XFS_IFORK_Q(ip) ? \
		XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
			XFS_IFORK_BOFF(ip) : \
		0)
#define XFS_IFORK_SIZE(ip,w) \
	((w) == XFS_DATA_FORK ? \
		XFS_IFORK_DSIZE(ip) : \
		XFS_IFORK_ASIZE(ip))
#define XFS_IFORK_FORMAT(ip,w) \
	((w) == XFS_DATA_FORK ? \
		(ip)->i_d.di_format : \
		(ip)->i_d.di_aformat)
#define XFS_IFORK_FMT_SET(ip,w,n) \
	((w) == XFS_DATA_FORK ? \
		((ip)->i_d.di_format = (n)) : \
		((ip)->i_d.di_aformat = (n)))
#define XFS_IFORK_NEXTENTS(ip,w) \
	((w) == XFS_DATA_FORK ? \
		(ip)->i_d.di_nextents : \
		(ip)->i_d.di_anextents)
#define XFS_IFORK_NEXT_SET(ip,w,n) \
	((w) == XFS_DATA_FORK ? \
		((ip)->i_d.di_nextents = (n)) : \
		((ip)->i_d.di_anextents = (n)))
#define XFS_IFORK_MAXEXT(ip, w) \
	(XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))

int		xfs_iformat_fork(struct xfs_inode *, struct xfs_dinode *);
void		xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *,
				struct xfs_inode_log_item *, int,
				struct xfs_buf *);
void		xfs_idestroy_fork(struct xfs_inode *, int);
void		xfs_idata_realloc(struct xfs_inode *, int, int);
void		xfs_iroot_realloc(struct xfs_inode *, int, int);
int		xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
int		xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *,
				  int);

struct xfs_bmbt_rec_host *
		xfs_iext_get_ext(struct xfs_ifork *, xfs_extnum_t);
void		xfs_iext_insert(struct xfs_inode *, xfs_extnum_t, xfs_extnum_t,
				struct xfs_bmbt_irec *, int);
void		xfs_iext_add(struct xfs_ifork *, xfs_extnum_t, int);
void		xfs_iext_add_indirect_multi(struct xfs_ifork *, int,
					    xfs_extnum_t, int);
void		xfs_iext_remove(struct xfs_inode *, xfs_extnum_t, int, int);
void		xfs_iext_remove_inline(struct xfs_ifork *, xfs_extnum_t, int);
void		xfs_iext_remove_direct(struct xfs_ifork *, xfs_extnum_t, int);
void		xfs_iext_remove_indirect(struct xfs_ifork *, xfs_extnum_t, int);
void		xfs_iext_realloc_direct(struct xfs_ifork *, int);
void		xfs_iext_direct_to_inline(struct xfs_ifork *, xfs_extnum_t);
void		xfs_iext_inline_to_direct(struct xfs_ifork *, int);
void		xfs_iext_destroy(struct xfs_ifork *);
struct xfs_bmbt_rec_host *
		xfs_iext_bno_to_ext(struct xfs_ifork *, xfs_fileoff_t, int *);
struct xfs_ext_irec *
		xfs_iext_bno_to_irec(struct xfs_ifork *, xfs_fileoff_t, int *);
struct xfs_ext_irec *
		xfs_iext_idx_to_irec(struct xfs_ifork *, xfs_extnum_t *, int *,
				     int);
void		xfs_iext_irec_init(struct xfs_ifork *);
struct xfs_ext_irec *
		xfs_iext_irec_new(struct xfs_ifork *, int);
void		xfs_iext_irec_remove(struct xfs_ifork *, int);
void		xfs_iext_irec_compact(struct xfs_ifork *);
void		xfs_iext_irec_compact_pages(struct xfs_ifork *);
void		xfs_iext_irec_compact_full(struct xfs_ifork *);
void		xfs_iext_irec_update_extoffs(struct xfs_ifork *, int, int);

extern struct kmem_zone	*xfs_ifork_zone;

#endif	/* __XFS_INODE_FORK_H__ */
Commit	Line	Data
5c4d97d0 DC	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
	21	struct xfs_inode_log_item;
	22
	23	/*
	24	* The following xfs_ext_irec_t struct introduces a second (top) level
	25	* to the in-core extent allocation scheme. These structs are allocated
	26	* in a contiguous block, creating an indirection array where each entry
	27	* (irec) contains a pointer to a buffer of in-core extent records which
	28	* it manages. Each extent buffer is 4k in size, since 4k is the system
	29	* page size on Linux i386 and systems with larger page sizes don't seem
	30	* to gain much, if anything, by using their native page size as the
	31	* extent buffer size. Also, using 4k extent buffers everywhere provides
	32	* a consistent interface for CXFS across different platforms.
	33	*
	34	* There is currently no limit on the number of irec's (extent lists)
	35	* allowed, so heavily fragmented files may require an indirection array
	36	* which spans multiple system pages of memory. The number of extents
	37	* which would require this amount of contiguous memory is very large
	38	* and should not cause problems in the foreseeable future. However,
	39	* if the memory needed for the contiguous array ever becomes a problem,
	40	* it is possible that a third level of indirection may be required.
	41	*/
	42	typedef struct xfs_ext_irec {
	43	xfs_bmbt_rec_host_t er_extbuf; / block of extent records */
	44	xfs_extnum_t er_extoff; /* extent offset in file */
	45	xfs_extnum_t er_extcount; /* number of extents in page/block */
	46	} xfs_ext_irec_t;
	47
	48	/*
	49	* File incore extent information, present for each of data & attr forks.
	50	*/
	51	#define XFS_IEXT_BUFSZ 4096
	52	#define XFS_LINEAR_EXTS (XFS_IEXT_BUFSZ / (uint)sizeof(xfs_bmbt_rec_t))
	53	#define XFS_INLINE_EXTS 2
	54	#define XFS_INLINE_DATA 32
	55	typedef struct xfs_ifork {
	56	int if_bytes; /* bytes in if_u1 */
	57	int if_real_bytes; /* bytes allocated in if_u1 */
	58	struct xfs_btree_block if_broot; / file's incore btree root */
	59	short if_broot_bytes; /* bytes allocated for root */
	60	unsigned char if_flags; /* per-fork flags */
	61	union {
	62	xfs_bmbt_rec_host_t if_extents;/ linear map file exts */
	63	xfs_ext_irec_t if_ext_irec; / irec map file exts */
	64	char if_data; / inline file data */
65	} if_u1;
66	union {
67	xfs_bmbt_rec_host_t if_inline_ext[XFS_INLINE_EXTS];
68	/* very small file extents */
69	char if_inline_data[XFS_INLINE_DATA];
70	/* very small file data */
71	xfs_dev_t if_rdev; /* dev number if special */
72	uuid_t if_uuid; /* mount point value */
73	} if_u2;
74	} xfs_ifork_t;
75
76	/*
77	* Per-fork incore inode flags.
78	*/
79	#define XFS_IFINLINE 0x01 /* Inline data is read in */
80	#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
81	#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
82	#define XFS_IFEXTIREC 0x08 /* Indirection array of extent blocks */
83
84	/*
85	* Fork handling.
86	*/
87
88	#define XFS_IFORK_Q(ip) ((ip)->i_d.di_forkoff != 0)
89	#define XFS_IFORK_BOFF(ip) ((int)((ip)->i_d.di_forkoff << 3))
90
91	#define XFS_IFORK_PTR(ip,w) \
92	((w) == XFS_DATA_FORK ? \
93	&(ip)->i_df : \
94	(ip)->i_afp)
95	#define XFS_IFORK_DSIZE(ip) \
96	(XFS_IFORK_Q(ip) ? \
97	XFS_IFORK_BOFF(ip) : \
98	XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
99	#define XFS_IFORK_ASIZE(ip) \
100	(XFS_IFORK_Q(ip) ? \
101	XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
102	XFS_IFORK_BOFF(ip) : \
103	0)
104	#define XFS_IFORK_SIZE(ip,w) \
105	((w) == XFS_DATA_FORK ? \
106	XFS_IFORK_DSIZE(ip) : \
107	XFS_IFORK_ASIZE(ip))
108	#define XFS_IFORK_FORMAT(ip,w) \
109	((w) == XFS_DATA_FORK ? \
110	(ip)->i_d.di_format : \
111	(ip)->i_d.di_aformat)
112	#define XFS_IFORK_FMT_SET(ip,w,n) \
113	((w) == XFS_DATA_FORK ? \
114	((ip)->i_d.di_format = (n)) : \
115	((ip)->i_d.di_aformat = (n)))
116	#define XFS_IFORK_NEXTENTS(ip,w) \
117	((w) == XFS_DATA_FORK ? \
118	(ip)->i_d.di_nextents : \
119	(ip)->i_d.di_anextents)
120	#define XFS_IFORK_NEXT_SET(ip,w,n) \
121	((w) == XFS_DATA_FORK ? \
122	((ip)->i_d.di_nextents = (n)) : \
123	((ip)->i_d.di_anextents = (n)))
124	#define XFS_IFORK_MAXEXT(ip, w) \
125	(XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))
126
127	int xfs_iformat_fork(struct xfs_inode , struct xfs_dinode );
128	void xfs_iflush_fork(struct xfs_inode , struct xfs_dinode ,
129	struct xfs_inode_log_item *, int,
130	struct xfs_buf *);
131	void xfs_idestroy_fork(struct xfs_inode *, int);
132	void xfs_idata_realloc(struct xfs_inode *, int, int);
133	void xfs_iroot_realloc(struct xfs_inode *, int, int);
134	int xfs_iread_extents(struct xfs_trans , struct xfs_inode , int);
135	int xfs_iextents_copy(struct xfs_inode , struct xfs_bmbt_rec ,
136	int);
137
138	struct xfs_bmbt_rec_host *
139	xfs_iext_get_ext(struct xfs_ifork *, xfs_extnum_t);
140	void xfs_iext_insert(struct xfs_inode *, xfs_extnum_t, xfs_extnum_t,
141	struct xfs_bmbt_irec *, int);
142	void xfs_iext_add(struct xfs_ifork *, xfs_extnum_t, int);
143	void xfs_iext_add_indirect_multi(struct xfs_ifork *, int,
144	xfs_extnum_t, int);
145	void xfs_iext_remove(struct xfs_inode *, xfs_extnum_t, int, int);
146	void xfs_iext_remove_inline(struct xfs_ifork *, xfs_extnum_t, int);
147	void xfs_iext_remove_direct(struct xfs_ifork *, xfs_extnum_t, int);
148	void xfs_iext_remove_indirect(struct xfs_ifork *, xfs_extnum_t, int);
149	void xfs_iext_realloc_direct(struct xfs_ifork *, int);
150	void xfs_iext_direct_to_inline(struct xfs_ifork *, xfs_extnum_t);
151	void xfs_iext_inline_to_direct(struct xfs_ifork *, int);
152	void xfs_iext_destroy(struct xfs_ifork *);
153	struct xfs_bmbt_rec_host *
154	xfs_iext_bno_to_ext(struct xfs_ifork , xfs_fileoff_t, int );
155	struct xfs_ext_irec *
156	xfs_iext_bno_to_irec(struct xfs_ifork , xfs_fileoff_t, int );
157	struct xfs_ext_irec *
158	xfs_iext_idx_to_irec(struct xfs_ifork , xfs_extnum_t , int *,
159	int);
160	void xfs_iext_irec_init(struct xfs_ifork *);
161	struct xfs_ext_irec *
162	xfs_iext_irec_new(struct xfs_ifork *, int);
163	void xfs_iext_irec_remove(struct xfs_ifork *, int);
164	void xfs_iext_irec_compact(struct xfs_ifork *);
165	void xfs_iext_irec_compact_pages(struct xfs_ifork *);
166	void xfs_iext_irec_compact_full(struct xfs_ifork *);
167	void xfs_iext_irec_update_extoffs(struct xfs_ifork *, int, int);
168
169	extern struct kmem_zone *xfs_ifork_zone;
170
171	#endif /* __XFS_INODE_FORK_H__ */