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