]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - libxfs/xfs_bmap.h
xfs: add repair helpers for the reference count btree
[thirdparty/xfsprogs-dev.git] / libxfs / xfs_bmap.h
CommitLineData
2bd0ea18 1/*
5e656dbb 2 * Copyright (c) 2000-2006 Silicon Graphics, Inc.
f302e9e4 3 * All Rights Reserved.
5000d01d 4 *
f302e9e4
NS
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
2bd0ea18 7 * published by the Free Software Foundation.
5000d01d 8 *
f302e9e4
NS
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.
5000d01d 13 *
f302e9e4
NS
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
2bd0ea18
NS
17 */
18#ifndef __XFS_BMAP_H__
dfc130f3 19#define __XFS_BMAP_H__
2bd0ea18
NS
20
21struct getbmap;
22struct xfs_bmbt_irec;
5e656dbb 23struct xfs_ifork;
2bd0ea18
NS
24struct xfs_inode;
25struct xfs_mount;
26struct xfs_trans;
27
5e656dbb
BN
28extern kmem_zone_t *xfs_bmap_free_item_zone;
29
19ebedcf
DC
30/*
31 * Argument structure for xfs_bmap_alloc.
32 */
33struct xfs_bmalloca {
34 xfs_fsblock_t *firstblock; /* i/o first block allocated */
f33cea1a 35 struct xfs_defer_ops *dfops; /* bmap freelist */
19ebedcf
DC
36 struct xfs_trans *tp; /* transaction pointer */
37 struct xfs_inode *ip; /* incore inode pointer */
38 struct xfs_bmbt_irec prev; /* extent before the new one */
39 struct xfs_bmbt_irec got; /* extent after, or delayed */
40
41 xfs_fileoff_t offset; /* offset in file filling in */
42 xfs_extlen_t length; /* i/o length asked/allocated */
43 xfs_fsblock_t blkno; /* starting block of new extent */
44
45 struct xfs_btree_cur *cur; /* btree cursor */
9788e059 46 struct xfs_iext_cursor icur; /* incore extent cursor */
19ebedcf
DC
47 int nallocs;/* number of extents alloc'd */
48 int logflags;/* flags for transaction logging */
49
50 xfs_extlen_t total; /* total blocks needed for xaction */
51 xfs_extlen_t minlen; /* minimum allocation size (blocks) */
52 xfs_extlen_t minleft; /* amount must be left after alloc */
53 bool eof; /* set if allocating past last extent */
54 bool wasdel; /* replacing a delayed allocation */
19ebedcf
DC
55 bool aeof; /* allocated space at eof */
56 bool conv; /* overwriting unwritten extents */
1fccd5c8 57 int datatype;/* data type being allocated */
19ebedcf
DC
58 int flags;
59};
60
2bd0ea18
NS
61/*
62 * List of extents to be free "later".
63 * The list is kept sorted on xbf_startblock.
64 */
6f530e9a 65struct xfs_extent_free_item
2bd0ea18 66{
6f530e9a
DW
67 xfs_fsblock_t xefi_startblock;/* starting fs block number */
68 xfs_extlen_t xefi_blockcount;/* number of blocks in extent */
69 struct list_head xefi_list;
85aec44f 70 struct xfs_owner_info xefi_oinfo; /* extent owner */
3a13f959 71 bool xefi_skip_discard;
2cf6d225 72};
2bd0ea18 73
dfc130f3 74#define XFS_BMAP_MAX_NMAP 4
2bd0ea18
NS
75
76/*
a2ceac1f 77 * Flags for xfs_bmapi_*
2bd0ea18 78 */
a2ceac1f
DC
79#define XFS_BMAPI_ENTIRE 0x001 /* return entire extent, not trimmed */
80#define XFS_BMAPI_METADATA 0x002 /* mapping metadata not user data */
81#define XFS_BMAPI_ATTRFORK 0x004 /* use attribute fork not data */
82#define XFS_BMAPI_PREALLOC 0x008 /* preallocation op: unwritten space */
83#define XFS_BMAPI_IGSTATE 0x010 /* Ignore state - */
2bd0ea18 84 /* combine contig. space */
a2ceac1f 85#define XFS_BMAPI_CONTIG 0x020 /* must allocate only one extent */
56b2de80
DC
86/*
87 * unwritten extent conversion - this needs write cache flushing and no additional
88 * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
89 * from written to unwritten, otherwise convert from unwritten to written.
90 */
a2ceac1f 91#define XFS_BMAPI_CONVERT 0x040
56b2de80 92
9542ae13
DC
93/*
94 * allocate zeroed extents - this requires all newly allocated user data extents
95 * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
96 * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
97 * during the allocation range to zeroed written extents.
98 */
99#define XFS_BMAPI_ZERO 0x080
100
34621a47
DW
101/*
102 * Map the inode offset to the block given in ap->firstblock. Primarily
103 * used for reflink. The range must be in a hole, and this flag cannot be
104 * turned on with PREALLOC or CONVERT, and cannot be used on the attr fork.
36b16da8
DW
105 *
106 * For bunmapi, this flag unmaps the range without adjusting quota, reducing
107 * refcount, or freeing the blocks.
34621a47
DW
108 */
109#define XFS_BMAPI_REMAP 0x100
110
cb8a004a
DW
111/* Map something in the CoW fork. */
112#define XFS_BMAPI_COWFORK 0x200
113
7075a23f
CH
114/* Only convert delalloc space, don't allocate entirely new extents */
115#define XFS_BMAPI_DELALLOC 0x400
116
8e87c884
CH
117/* Only convert unwritten extents, don't allocate new blocks */
118#define XFS_BMAPI_CONVERT_ONLY 0x800
119
3a13f959
BF
120/* Skip online discard of freed extents */
121#define XFS_BMAPI_NODISCARD 0x1000
122
56b2de80 123#define XFS_BMAPI_FLAGS \
56b2de80
DC
124 { XFS_BMAPI_ENTIRE, "ENTIRE" }, \
125 { XFS_BMAPI_METADATA, "METADATA" }, \
126 { XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
56b2de80
DC
127 { XFS_BMAPI_PREALLOC, "PREALLOC" }, \
128 { XFS_BMAPI_IGSTATE, "IGSTATE" }, \
129 { XFS_BMAPI_CONTIG, "CONTIG" }, \
9542ae13 130 { XFS_BMAPI_CONVERT, "CONVERT" }, \
34621a47 131 { XFS_BMAPI_ZERO, "ZERO" }, \
cb8a004a 132 { XFS_BMAPI_REMAP, "REMAP" }, \
7075a23f 133 { XFS_BMAPI_COWFORK, "COWFORK" }, \
8e87c884 134 { XFS_BMAPI_DELALLOC, "DELALLOC" }, \
3a13f959
BF
135 { XFS_BMAPI_CONVERT_ONLY, "CONVERT_ONLY" }, \
136 { XFS_BMAPI_NODISCARD, "NODISCARD" }
56b2de80 137
2bd0ea18 138
f302e9e4
NS
139static inline int xfs_bmapi_aflag(int w)
140{
cb8a004a
DW
141 return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK :
142 (w == XFS_COW_FORK ? XFS_BMAPI_COWFORK : 0));
143}
144
145static inline int xfs_bmapi_whichfork(int bmapi_flags)
146{
147 if (bmapi_flags & XFS_BMAPI_COWFORK)
148 return XFS_COW_FORK;
149 else if (bmapi_flags & XFS_BMAPI_ATTRFORK)
150 return XFS_ATTR_FORK;
151 return XFS_DATA_FORK;
f302e9e4 152}
2bd0ea18
NS
153
154/*
155 * Special values for xfs_bmbt_irec_t br_startblock field.
156 */
dfc130f3
RC
157#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
158#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
2bd0ea18 159
23aab3f9 160/*
56b2de80 161 * Flags for xfs_bmap_add_extent*.
23aab3f9 162 */
56b2de80
DC
163#define BMAP_LEFT_CONTIG (1 << 0)
164#define BMAP_RIGHT_CONTIG (1 << 1)
165#define BMAP_LEFT_FILLING (1 << 2)
166#define BMAP_RIGHT_FILLING (1 << 3)
167#define BMAP_LEFT_DELAY (1 << 4)
168#define BMAP_RIGHT_DELAY (1 << 5)
169#define BMAP_LEFT_VALID (1 << 6)
170#define BMAP_RIGHT_VALID (1 << 7)
171#define BMAP_ATTRFORK (1 << 8)
cb8a004a 172#define BMAP_COWFORK (1 << 9)
56b2de80
DC
173
174#define XFS_BMAP_EXT_FLAGS \
175 { BMAP_LEFT_CONTIG, "LC" }, \
176 { BMAP_RIGHT_CONTIG, "RC" }, \
177 { BMAP_LEFT_FILLING, "LF" }, \
178 { BMAP_RIGHT_FILLING, "RF" }, \
cb8a004a
DW
179 { BMAP_ATTRFORK, "ATTR" }, \
180 { BMAP_COWFORK, "COW" }
23aab3f9 181
ff105f75 182
cd83dc79
CH
183/*
184 * Return true if the extent is a real, allocated extent, or false if it is a
185 * delayed allocation, and unwritten extent or a hole.
186 */
187static inline bool xfs_bmap_is_real_extent(struct xfs_bmbt_irec *irec)
188{
189 return irec->br_state != XFS_EXT_UNWRITTEN &&
190 irec->br_startblock != HOLESTARTBLOCK &&
191 irec->br_startblock != DELAYSTARTBLOCK &&
192 !isnullstartblock(irec->br_startblock);
193}
194
b3fd8db7
DW
195void xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno,
196 xfs_filblks_t len);
ca75eb20 197void xfs_trim_extent_eof(struct xfs_bmbt_irec *, struct xfs_inode *);
a2ceac1f 198int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
3f17ed4b 199void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
3a13f959 200void __xfs_bmap_add_free(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
85aec44f 201 xfs_fsblock_t bno, xfs_filblks_t len,
3a13f959 202 struct xfs_owner_info *oinfo, bool skip_discard);
a2ceac1f
DC
203void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
204int xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
205 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
206int xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
207 xfs_fileoff_t *last_block, int whichfork);
ff105f75
DC
208int xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
209 int whichfork);
a2ceac1f 210int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
a2ceac1f
DC
211int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
212 xfs_filblks_t len, struct xfs_bmbt_irec *mval,
213 int *nmap, int flags);
a2ceac1f
DC
214int xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
215 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
216 xfs_fsblock_t *firstblock, xfs_extlen_t total,
217 struct xfs_bmbt_irec *mval, int *nmap,
f33cea1a 218 struct xfs_defer_ops *dfops);
3d36acda
DW
219int __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
220 xfs_fileoff_t bno, xfs_filblks_t *rlen, int flags,
221 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
222 struct xfs_defer_ops *dfops);
a2ceac1f
DC
223int xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
224 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
225 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
f33cea1a 226 struct xfs_defer_ops *dfops, int *done);
ece930fa 227int xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork,
9788e059
CH
228 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
229 struct xfs_bmbt_irec *del);
230void xfs_bmap_del_extent_cow(struct xfs_inode *ip,
231 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
ece930fa 232 struct xfs_bmbt_irec *del);
a2ceac1f 233uint xfs_default_attroffset(struct xfs_inode *ip);
a9f5d25e 234int xfs_bmap_collapse_extents(struct xfs_trans *tp, struct xfs_inode *ip,
19ebedcf 235 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
1421de38 236 bool *done, xfs_fsblock_t *firstblock,
a9f5d25e
CH
237 struct xfs_defer_ops *dfops);
238int xfs_bmap_insert_extents(struct xfs_trans *tp, struct xfs_inode *ip,
239 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
240 bool *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
241 struct xfs_defer_ops *dfops);
19ebedcf 242int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
cc66acaf 243int xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, int whichfork,
f7b1a8b1 244 xfs_fileoff_t off, xfs_filblks_t len, xfs_filblks_t prealloc,
9788e059
CH
245 struct xfs_bmbt_irec *got, struct xfs_iext_cursor *cur,
246 int eof);
56b2de80 247
3a13f959
BF
248static inline void
249xfs_bmap_add_free(
250 struct xfs_mount *mp,
251 struct xfs_defer_ops *dfops,
252 xfs_fsblock_t bno,
253 xfs_filblks_t len,
254 struct xfs_owner_info *oinfo)
255{
256 __xfs_bmap_add_free(mp, dfops, bno, len, oinfo, false);
257}
258
259static inline void
260xfs_bmap_add_free_nodiscard(
261 struct xfs_mount *mp,
262 struct xfs_defer_ops *dfops,
263 xfs_fsblock_t bno,
264 xfs_filblks_t len,
265 struct xfs_owner_info *oinfo)
266{
267 __xfs_bmap_add_free(mp, dfops, bno, len, oinfo, true);
268}
269
34f8f3e1
DW
270enum xfs_bmap_intent_type {
271 XFS_BMAP_MAP = 1,
272 XFS_BMAP_UNMAP,
273};
274
275struct xfs_bmap_intent {
276 struct list_head bi_list;
277 enum xfs_bmap_intent_type bi_type;
278 struct xfs_inode *bi_owner;
279 int bi_whichfork;
280 struct xfs_bmbt_irec bi_bmap;
281};
282
aeb88300
DW
283int xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_defer_ops *dfops,
284 struct xfs_inode *ip, enum xfs_bmap_intent_type type,
285 int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
594956fa 286 xfs_filblks_t *blockcount, xfs_exntst_t state);
aeb88300
DW
287int xfs_bmap_map_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
288 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
289int xfs_bmap_unmap_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
290 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
291
7bd43334
CH
292static inline int xfs_bmap_fork_to_state(int whichfork)
293{
294 switch (whichfork) {
295 case XFS_ATTR_FORK:
296 return BMAP_ATTRFORK;
297 case XFS_COW_FORK:
298 return BMAP_COWFORK;
299 default:
300 return 0;
301 }
302}
303
0cf6a3a9
DW
304xfs_failaddr_t xfs_bmap_validate_extent(struct xfs_inode *ip, int whichfork,
305 struct xfs_bmbt_irec *irec);
306
2bd0ea18 307#endif /* __XFS_BMAP_H__ */