Loading...
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 * The following xfs_ext_irec_t struct introduces a second (top) level
26 * to the in-core extent allocation scheme. These structs are allocated
27 * in a contiguous block, creating an indirection array where each entry
28 * (irec) contains a pointer to a buffer of in-core extent records which
29 * it manages. Each extent buffer is 4k in size, since 4k is the system
30 * page size on Linux i386 and systems with larger page sizes don't seem
31 * to gain much, if anything, by using their native page size as the
32 * extent buffer size. Also, using 4k extent buffers everywhere provides
33 * a consistent interface for CXFS across different platforms.
34 *
35 * There is currently no limit on the number of irec's (extent lists)
36 * allowed, so heavily fragmented files may require an indirection array
37 * which spans multiple system pages of memory. The number of extents
38 * which would require this amount of contiguous memory is very large
39 * and should not cause problems in the foreseeable future. However,
40 * if the memory needed for the contiguous array ever becomes a problem,
41 * it is possible that a third level of indirection may be required.
42 */
43typedef struct xfs_ext_irec {
44 xfs_bmbt_rec_host_t *er_extbuf; /* block of extent records */
45 xfs_extnum_t er_extoff; /* extent offset in file */
46 xfs_extnum_t er_extcount; /* number of extents in page/block */
47} xfs_ext_irec_t;
48
49/*
50 * File incore extent information, present for each of data & attr forks.
51 */
52#define XFS_IEXT_BUFSZ 4096
53#define XFS_LINEAR_EXTS (XFS_IEXT_BUFSZ / (uint)sizeof(xfs_bmbt_rec_t))
54#define XFS_INLINE_EXTS 2
55#define XFS_INLINE_DATA 32
56typedef struct xfs_ifork {
57 int if_bytes; /* bytes in if_u1 */
58 int if_real_bytes; /* bytes allocated in if_u1 */
59 struct xfs_btree_block *if_broot; /* file's incore btree root */
60 short if_broot_bytes; /* bytes allocated for root */
61 unsigned char if_flags; /* per-fork flags */
62 union {
63 xfs_bmbt_rec_host_t *if_extents;/* linear map file exts */
64 xfs_ext_irec_t *if_ext_irec; /* irec map file exts */
65 char *if_data; /* inline file data */
66 } if_u1;
67 union {
68 xfs_bmbt_rec_host_t if_inline_ext[XFS_INLINE_EXTS];
69 /* very small file extents */
70 char if_inline_data[XFS_INLINE_DATA];
71 /* very small file data */
72 xfs_dev_t if_rdev; /* dev number if special */
73 uuid_t if_uuid; /* mount point value */
74 } if_u2;
75} xfs_ifork_t;
76
77/*
78 * Per-fork incore inode flags.
79 */
80#define XFS_IFINLINE 0x01 /* Inline data is read in */
81#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
82#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
83#define XFS_IFEXTIREC 0x08 /* Indirection array of extent blocks */
84
85/*
86 * Fork handling.
87 */
88
89#define XFS_IFORK_Q(ip) ((ip)->i_d.di_forkoff != 0)
90#define XFS_IFORK_BOFF(ip) ((int)((ip)->i_d.di_forkoff << 3))
91
92#define XFS_IFORK_PTR(ip,w) \
93 ((w) == XFS_DATA_FORK ? \
94 &(ip)->i_df : \
95 ((w) == XFS_ATTR_FORK ? \
96 (ip)->i_afp : \
97 (ip)->i_cowfp))
98#define XFS_IFORK_DSIZE(ip) \
99 (XFS_IFORK_Q(ip) ? \
100 XFS_IFORK_BOFF(ip) : \
101 XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
102#define XFS_IFORK_ASIZE(ip) \
103 (XFS_IFORK_Q(ip) ? \
104 XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
105 XFS_IFORK_BOFF(ip) : \
106 0)
107#define XFS_IFORK_SIZE(ip,w) \
108 ((w) == XFS_DATA_FORK ? \
109 XFS_IFORK_DSIZE(ip) : \
110 ((w) == XFS_ATTR_FORK ? \
111 XFS_IFORK_ASIZE(ip) : \
112 0))
113#define XFS_IFORK_FORMAT(ip,w) \
114 ((w) == XFS_DATA_FORK ? \
115 (ip)->i_d.di_format : \
116 ((w) == XFS_ATTR_FORK ? \
117 (ip)->i_d.di_aformat : \
118 (ip)->i_cformat))
119#define XFS_IFORK_FMT_SET(ip,w,n) \
120 ((w) == XFS_DATA_FORK ? \
121 ((ip)->i_d.di_format = (n)) : \
122 ((w) == XFS_ATTR_FORK ? \
123 ((ip)->i_d.di_aformat = (n)) : \
124 ((ip)->i_cformat = (n))))
125#define XFS_IFORK_NEXTENTS(ip,w) \
126 ((w) == XFS_DATA_FORK ? \
127 (ip)->i_d.di_nextents : \
128 ((w) == XFS_ATTR_FORK ? \
129 (ip)->i_d.di_anextents : \
130 (ip)->i_cnextents))
131#define XFS_IFORK_NEXT_SET(ip,w,n) \
132 ((w) == XFS_DATA_FORK ? \
133 ((ip)->i_d.di_nextents = (n)) : \
134 ((w) == XFS_ATTR_FORK ? \
135 ((ip)->i_d.di_anextents = (n)) : \
136 ((ip)->i_cnextents = (n))))
137#define XFS_IFORK_MAXEXT(ip, w) \
138 (XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))
139
140struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state);
141
142int xfs_iformat_fork(struct xfs_inode *, struct xfs_dinode *);
143void xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *,
144 struct xfs_inode_log_item *, int);
145void xfs_idestroy_fork(struct xfs_inode *, int);
146void xfs_idata_realloc(struct xfs_inode *, int, int);
147void xfs_iroot_realloc(struct xfs_inode *, int, int);
148int xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
149int xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *,
150 int);
151void xfs_init_local_fork(struct xfs_inode *, int, const void *, int);
152
153struct xfs_bmbt_rec_host *
154 xfs_iext_get_ext(struct xfs_ifork *, xfs_extnum_t);
155xfs_extnum_t xfs_iext_count(struct xfs_ifork *);
156void xfs_iext_insert(struct xfs_inode *, xfs_extnum_t, xfs_extnum_t,
157 struct xfs_bmbt_irec *, int);
158void xfs_iext_add(struct xfs_ifork *, xfs_extnum_t, int);
159void xfs_iext_add_indirect_multi(struct xfs_ifork *, int,
160 xfs_extnum_t, int);
161void xfs_iext_remove(struct xfs_inode *, xfs_extnum_t, int, int);
162void xfs_iext_remove_inline(struct xfs_ifork *, xfs_extnum_t, int);
163void xfs_iext_remove_direct(struct xfs_ifork *, xfs_extnum_t, int);
164void xfs_iext_remove_indirect(struct xfs_ifork *, xfs_extnum_t, int);
165void xfs_iext_realloc_direct(struct xfs_ifork *, int);
166void xfs_iext_direct_to_inline(struct xfs_ifork *, xfs_extnum_t);
167void xfs_iext_inline_to_direct(struct xfs_ifork *, int);
168void xfs_iext_destroy(struct xfs_ifork *);
169struct xfs_bmbt_rec_host *
170 xfs_iext_bno_to_ext(struct xfs_ifork *, xfs_fileoff_t, int *);
171struct xfs_ext_irec *
172 xfs_iext_bno_to_irec(struct xfs_ifork *, xfs_fileoff_t, int *);
173struct xfs_ext_irec *
174 xfs_iext_idx_to_irec(struct xfs_ifork *, xfs_extnum_t *, int *,
175 int);
176void xfs_iext_irec_init(struct xfs_ifork *);
177struct xfs_ext_irec *
178 xfs_iext_irec_new(struct xfs_ifork *, int);
179void xfs_iext_irec_remove(struct xfs_ifork *, int);
180void xfs_iext_irec_compact(struct xfs_ifork *);
181void xfs_iext_irec_compact_pages(struct xfs_ifork *);
182void xfs_iext_irec_compact_full(struct xfs_ifork *);
183void xfs_iext_irec_update_extoffs(struct xfs_ifork *, int, int);
184
185bool xfs_iext_lookup_extent(struct xfs_inode *ip,
186 struct xfs_ifork *ifp, xfs_fileoff_t bno,
187 xfs_extnum_t *idxp, struct xfs_bmbt_irec *gotp);
188bool xfs_iext_get_extent(struct xfs_ifork *ifp, xfs_extnum_t idx,
189 struct xfs_bmbt_irec *gotp);
190
191extern struct kmem_zone *xfs_ifork_zone;
192
193extern void xfs_ifork_init_cow(struct xfs_inode *ip);
194
195#endif /* __XFS_INODE_FORK_H__ */
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6#ifndef __XFS_INODE_FORK_H__
7#define __XFS_INODE_FORK_H__
8
9struct xfs_inode_log_item;
10struct xfs_dinode;
11
12/*
13 * File incore extent information, present for each of data & attr forks.
14 */
15struct xfs_ifork {
16 int if_bytes; /* bytes in if_u1 */
17 unsigned int if_seq; /* fork mod counter */
18 struct xfs_btree_block *if_broot; /* file's incore btree root */
19 short if_broot_bytes; /* bytes allocated for root */
20 unsigned char if_flags; /* per-fork flags */
21 int if_height; /* height of the extent tree */
22 union {
23 void *if_root; /* extent tree root */
24 char *if_data; /* inline file data */
25 } if_u1;
26};
27
28/*
29 * Per-fork incore inode flags.
30 */
31#define XFS_IFINLINE 0x01 /* Inline data is read in */
32#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
33#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
34
35/*
36 * Fork handling.
37 */
38
39#define XFS_IFORK_Q(ip) ((ip)->i_d.di_forkoff != 0)
40#define XFS_IFORK_BOFF(ip) ((int)((ip)->i_d.di_forkoff << 3))
41
42#define XFS_IFORK_PTR(ip,w) \
43 ((w) == XFS_DATA_FORK ? \
44 &(ip)->i_df : \
45 ((w) == XFS_ATTR_FORK ? \
46 (ip)->i_afp : \
47 (ip)->i_cowfp))
48#define XFS_IFORK_DSIZE(ip) \
49 (XFS_IFORK_Q(ip) ? \
50 XFS_IFORK_BOFF(ip) : \
51 XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version))
52#define XFS_IFORK_ASIZE(ip) \
53 (XFS_IFORK_Q(ip) ? \
54 XFS_LITINO((ip)->i_mount, (ip)->i_d.di_version) - \
55 XFS_IFORK_BOFF(ip) : \
56 0)
57#define XFS_IFORK_SIZE(ip,w) \
58 ((w) == XFS_DATA_FORK ? \
59 XFS_IFORK_DSIZE(ip) : \
60 ((w) == XFS_ATTR_FORK ? \
61 XFS_IFORK_ASIZE(ip) : \
62 0))
63#define XFS_IFORK_FORMAT(ip,w) \
64 ((w) == XFS_DATA_FORK ? \
65 (ip)->i_d.di_format : \
66 ((w) == XFS_ATTR_FORK ? \
67 (ip)->i_d.di_aformat : \
68 (ip)->i_cformat))
69#define XFS_IFORK_FMT_SET(ip,w,n) \
70 ((w) == XFS_DATA_FORK ? \
71 ((ip)->i_d.di_format = (n)) : \
72 ((w) == XFS_ATTR_FORK ? \
73 ((ip)->i_d.di_aformat = (n)) : \
74 ((ip)->i_cformat = (n))))
75#define XFS_IFORK_NEXTENTS(ip,w) \
76 ((w) == XFS_DATA_FORK ? \
77 (ip)->i_d.di_nextents : \
78 ((w) == XFS_ATTR_FORK ? \
79 (ip)->i_d.di_anextents : \
80 (ip)->i_cnextents))
81#define XFS_IFORK_NEXT_SET(ip,w,n) \
82 ((w) == XFS_DATA_FORK ? \
83 ((ip)->i_d.di_nextents = (n)) : \
84 ((w) == XFS_ATTR_FORK ? \
85 ((ip)->i_d.di_anextents = (n)) : \
86 ((ip)->i_cnextents = (n))))
87#define XFS_IFORK_MAXEXT(ip, w) \
88 (XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t))
89
90struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state);
91
92int xfs_iformat_fork(struct xfs_inode *, struct xfs_dinode *);
93void xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *,
94 struct xfs_inode_log_item *, int);
95void xfs_idestroy_fork(struct xfs_inode *, int);
96void xfs_idata_realloc(struct xfs_inode *, int, int);
97void xfs_iroot_realloc(struct xfs_inode *, int, int);
98int xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
99int xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *,
100 int);
101void xfs_init_local_fork(struct xfs_inode *, int, const void *, int);
102
103xfs_extnum_t xfs_iext_count(struct xfs_ifork *ifp);
104void xfs_iext_insert(struct xfs_inode *, struct xfs_iext_cursor *cur,
105 struct xfs_bmbt_irec *, int);
106void xfs_iext_remove(struct xfs_inode *, struct xfs_iext_cursor *,
107 int);
108void xfs_iext_destroy(struct xfs_ifork *);
109
110bool xfs_iext_lookup_extent(struct xfs_inode *ip,
111 struct xfs_ifork *ifp, xfs_fileoff_t bno,
112 struct xfs_iext_cursor *cur,
113 struct xfs_bmbt_irec *gotp);
114bool xfs_iext_lookup_extent_before(struct xfs_inode *ip,
115 struct xfs_ifork *ifp, xfs_fileoff_t *end,
116 struct xfs_iext_cursor *cur,
117 struct xfs_bmbt_irec *gotp);
118bool xfs_iext_get_extent(struct xfs_ifork *ifp,
119 struct xfs_iext_cursor *cur,
120 struct xfs_bmbt_irec *gotp);
121void xfs_iext_update_extent(struct xfs_inode *ip, int state,
122 struct xfs_iext_cursor *cur,
123 struct xfs_bmbt_irec *gotp);
124
125void xfs_iext_first(struct xfs_ifork *, struct xfs_iext_cursor *);
126void xfs_iext_last(struct xfs_ifork *, struct xfs_iext_cursor *);
127void xfs_iext_next(struct xfs_ifork *, struct xfs_iext_cursor *);
128void xfs_iext_prev(struct xfs_ifork *, struct xfs_iext_cursor *);
129
130static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp,
131 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
132{
133 xfs_iext_next(ifp, cur);
134 return xfs_iext_get_extent(ifp, cur, gotp);
135}
136
137static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp,
138 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
139{
140 xfs_iext_prev(ifp, cur);
141 return xfs_iext_get_extent(ifp, cur, gotp);
142}
143
144/*
145 * Return the extent after cur in gotp without updating the cursor.
146 */
147static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp,
148 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
149{
150 struct xfs_iext_cursor ncur = *cur;
151
152 xfs_iext_next(ifp, &ncur);
153 return xfs_iext_get_extent(ifp, &ncur, gotp);
154}
155
156/*
157 * Return the extent before cur in gotp without updating the cursor.
158 */
159static inline bool xfs_iext_peek_prev_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_prev(ifp, &ncur);
165 return xfs_iext_get_extent(ifp, &ncur, gotp);
166}
167
168#define for_each_xfs_iext(ifp, ext, got) \
169 for (xfs_iext_first((ifp), (ext)); \
170 xfs_iext_get_extent((ifp), (ext), (got)); \
171 xfs_iext_next((ifp), (ext)))
172
173extern struct kmem_zone *xfs_ifork_zone;
174
175extern void xfs_ifork_init_cow(struct xfs_inode *ip);
176
177typedef xfs_failaddr_t (*xfs_ifork_verifier_t)(struct xfs_inode *);
178
179struct xfs_ifork_ops {
180 xfs_ifork_verifier_t verify_symlink;
181 xfs_ifork_verifier_t verify_dir;
182 xfs_ifork_verifier_t verify_attr;
183};
184extern struct xfs_ifork_ops xfs_default_ifork_ops;
185
186xfs_failaddr_t xfs_ifork_verify_data(struct xfs_inode *ip,
187 struct xfs_ifork_ops *ops);
188xfs_failaddr_t xfs_ifork_verify_attr(struct xfs_inode *ip,
189 struct xfs_ifork_ops *ops);
190
191#endif /* __XFS_INODE_FORK_H__ */