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