Loading...
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 int64_t if_bytes; /* bytes in if_data */
17 struct xfs_btree_block *if_broot; /* file's incore btree root */
18 unsigned int if_seq; /* fork mod counter */
19 int if_height; /* height of the extent tree */
20 void *if_data; /* extent tree root or
21 inline data */
22 xfs_extnum_t if_nextents; /* # of extents in this fork */
23 short if_broot_bytes; /* bytes allocated for root */
24 int8_t if_format; /* format of this fork */
25 uint8_t if_needextents; /* extents have not been read */
26};
27
28/*
29 * Worst-case increase in the fork extent count when we're adding a single
30 * extent to a fork and there's no possibility of splitting an existing mapping.
31 */
32#define XFS_IEXT_ADD_NOSPLIT_CNT (1)
33
34/*
35 * Punching out an extent from the middle of an existing extent can cause the
36 * extent count to increase by 1.
37 * i.e. | Old extent | Hole | Old extent |
38 */
39#define XFS_IEXT_PUNCH_HOLE_CNT (1)
40
41/*
42 * Adding/removing an xattr can cause XFS_DA_NODE_MAXDEPTH extents to
43 * be added. One extra extent for dabtree in case a local attr is
44 * large enough to cause a double split. It can also cause extent
45 * count to increase proportional to the size of a remote xattr's
46 * value.
47 */
48#define XFS_IEXT_ATTR_MANIP_CNT(rmt_blks) \
49 (XFS_DA_NODE_MAXDEPTH + max(1, rmt_blks))
50
51/*
52 * A write to a sub-interval of an existing unwritten extent causes the original
53 * extent to be split into 3 extents
54 * i.e. | Unwritten | Real | Unwritten |
55 * Hence extent count can increase by 2.
56 */
57#define XFS_IEXT_WRITE_UNWRITTEN_CNT (2)
58
59
60/*
61 * Moving an extent to data fork can cause a sub-interval of an existing extent
62 * to be unmapped. This will increase extent count by 1. Mapping in the new
63 * extent can increase the extent count by 1 again i.e.
64 * | Old extent | New extent | Old extent |
65 * Hence number of extents increases by 2.
66 */
67#define XFS_IEXT_REFLINK_END_COW_CNT (2)
68
69/*
70 * Removing an initial range of source/donor file's extent and adding a new
71 * extent (from donor/source file) in its place will cause extent count to
72 * increase by 1.
73 */
74#define XFS_IEXT_SWAP_RMAP_CNT (1)
75
76/*
77 * Fork handling.
78 */
79#define XFS_IFORK_MAXEXT(ip, w) \
80 (xfs_inode_fork_size(ip, w) / sizeof(xfs_bmbt_rec_t))
81
82static inline bool xfs_ifork_has_extents(struct xfs_ifork *ifp)
83{
84 return ifp->if_format == XFS_DINODE_FMT_EXTENTS ||
85 ifp->if_format == XFS_DINODE_FMT_BTREE;
86}
87
88static inline xfs_extnum_t xfs_ifork_nextents(struct xfs_ifork *ifp)
89{
90 if (!ifp)
91 return 0;
92 return ifp->if_nextents;
93}
94
95static inline int8_t xfs_ifork_format(struct xfs_ifork *ifp)
96{
97 if (!ifp)
98 return XFS_DINODE_FMT_EXTENTS;
99 return ifp->if_format;
100}
101
102static inline xfs_extnum_t xfs_iext_max_nextents(bool has_large_extent_counts,
103 int whichfork)
104{
105 switch (whichfork) {
106 case XFS_DATA_FORK:
107 case XFS_COW_FORK:
108 if (has_large_extent_counts)
109 return XFS_MAX_EXTCNT_DATA_FORK_LARGE;
110 return XFS_MAX_EXTCNT_DATA_FORK_SMALL;
111
112 case XFS_ATTR_FORK:
113 if (has_large_extent_counts)
114 return XFS_MAX_EXTCNT_ATTR_FORK_LARGE;
115 return XFS_MAX_EXTCNT_ATTR_FORK_SMALL;
116
117 default:
118 ASSERT(0);
119 return 0;
120 }
121}
122
123static inline xfs_extnum_t
124xfs_dfork_data_extents(
125 struct xfs_dinode *dip)
126{
127 if (xfs_dinode_has_large_extent_counts(dip))
128 return be64_to_cpu(dip->di_big_nextents);
129
130 return be32_to_cpu(dip->di_nextents);
131}
132
133static inline xfs_extnum_t
134xfs_dfork_attr_extents(
135 struct xfs_dinode *dip)
136{
137 if (xfs_dinode_has_large_extent_counts(dip))
138 return be32_to_cpu(dip->di_big_anextents);
139
140 return be16_to_cpu(dip->di_anextents);
141}
142
143static inline xfs_extnum_t
144xfs_dfork_nextents(
145 struct xfs_dinode *dip,
146 int whichfork)
147{
148 switch (whichfork) {
149 case XFS_DATA_FORK:
150 return xfs_dfork_data_extents(dip);
151 case XFS_ATTR_FORK:
152 return xfs_dfork_attr_extents(dip);
153 default:
154 ASSERT(0);
155 break;
156 }
157
158 return 0;
159}
160
161void xfs_ifork_zap_attr(struct xfs_inode *ip);
162void xfs_ifork_init_attr(struct xfs_inode *ip, enum xfs_dinode_fmt format,
163 xfs_extnum_t nextents);
164struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state);
165
166int xfs_iformat_data_fork(struct xfs_inode *, struct xfs_dinode *);
167int xfs_iformat_attr_fork(struct xfs_inode *, struct xfs_dinode *);
168void xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *,
169 struct xfs_inode_log_item *, int);
170void xfs_idestroy_fork(struct xfs_ifork *ifp);
171void * xfs_idata_realloc(struct xfs_inode *ip, int64_t byte_diff,
172 int whichfork);
173void xfs_iroot_realloc(struct xfs_inode *, int, int);
174int xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
175int xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *,
176 int);
177void xfs_init_local_fork(struct xfs_inode *ip, int whichfork,
178 const void *data, int64_t size);
179
180xfs_extnum_t xfs_iext_count(struct xfs_ifork *ifp);
181void xfs_iext_insert_raw(struct xfs_ifork *ifp,
182 struct xfs_iext_cursor *cur,
183 struct xfs_bmbt_irec *irec);
184void xfs_iext_insert(struct xfs_inode *, struct xfs_iext_cursor *cur,
185 struct xfs_bmbt_irec *, int);
186void xfs_iext_remove(struct xfs_inode *, struct xfs_iext_cursor *,
187 int);
188void xfs_iext_destroy(struct xfs_ifork *);
189
190bool xfs_iext_lookup_extent(struct xfs_inode *ip,
191 struct xfs_ifork *ifp, xfs_fileoff_t bno,
192 struct xfs_iext_cursor *cur,
193 struct xfs_bmbt_irec *gotp);
194bool xfs_iext_lookup_extent_before(struct xfs_inode *ip,
195 struct xfs_ifork *ifp, xfs_fileoff_t *end,
196 struct xfs_iext_cursor *cur,
197 struct xfs_bmbt_irec *gotp);
198bool xfs_iext_get_extent(struct xfs_ifork *ifp,
199 struct xfs_iext_cursor *cur,
200 struct xfs_bmbt_irec *gotp);
201void xfs_iext_update_extent(struct xfs_inode *ip, int state,
202 struct xfs_iext_cursor *cur,
203 struct xfs_bmbt_irec *gotp);
204
205void xfs_iext_first(struct xfs_ifork *, struct xfs_iext_cursor *);
206void xfs_iext_last(struct xfs_ifork *, struct xfs_iext_cursor *);
207void xfs_iext_next(struct xfs_ifork *, struct xfs_iext_cursor *);
208void xfs_iext_prev(struct xfs_ifork *, struct xfs_iext_cursor *);
209
210static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp,
211 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
212{
213 xfs_iext_next(ifp, cur);
214 return xfs_iext_get_extent(ifp, cur, gotp);
215}
216
217static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp,
218 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
219{
220 xfs_iext_prev(ifp, cur);
221 return xfs_iext_get_extent(ifp, cur, gotp);
222}
223
224/*
225 * Return the extent after cur in gotp without updating the cursor.
226 */
227static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp,
228 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
229{
230 struct xfs_iext_cursor ncur = *cur;
231
232 xfs_iext_next(ifp, &ncur);
233 return xfs_iext_get_extent(ifp, &ncur, gotp);
234}
235
236/*
237 * Return the extent before cur in gotp without updating the cursor.
238 */
239static inline bool xfs_iext_peek_prev_extent(struct xfs_ifork *ifp,
240 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp)
241{
242 struct xfs_iext_cursor ncur = *cur;
243
244 xfs_iext_prev(ifp, &ncur);
245 return xfs_iext_get_extent(ifp, &ncur, gotp);
246}
247
248#define for_each_xfs_iext(ifp, ext, got) \
249 for (xfs_iext_first((ifp), (ext)); \
250 xfs_iext_get_extent((ifp), (ext), (got)); \
251 xfs_iext_next((ifp), (ext)))
252
253extern struct kmem_cache *xfs_ifork_cache;
254
255extern void xfs_ifork_init_cow(struct xfs_inode *ip);
256
257int xfs_ifork_verify_local_data(struct xfs_inode *ip);
258int xfs_ifork_verify_local_attr(struct xfs_inode *ip);
259int xfs_iext_count_may_overflow(struct xfs_inode *ip, int whichfork,
260 int nr_to_add);
261int xfs_iext_count_upgrade(struct xfs_trans *tp, struct xfs_inode *ip,
262 uint nr_to_add);
263
264/* returns true if the fork has extents but they are not read in yet. */
265static inline bool xfs_need_iread_extents(const struct xfs_ifork *ifp)
266{
267 /* see xfs_iformat_{data,attr}_fork() for needextents semantics */
268 return smp_load_acquire(&ifp->if_needextents) != 0;
269}
270
271#endif /* __XFS_INODE_FORK_H__ */
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__ */