]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - libxfs/xfs_bmap.h
xfs: return work remaining at the end of a bunmapi operation
[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 */
46 xfs_extnum_t idx; /* current extent index */
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 */
2cf6d225 71};
2bd0ea18 72
dfc130f3 73#define XFS_BMAP_MAX_NMAP 4
2bd0ea18
NS
74
75/*
a2ceac1f 76 * Flags for xfs_bmapi_*
2bd0ea18 77 */
a2ceac1f
DC
78#define XFS_BMAPI_ENTIRE 0x001 /* return entire extent, not trimmed */
79#define XFS_BMAPI_METADATA 0x002 /* mapping metadata not user data */
80#define XFS_BMAPI_ATTRFORK 0x004 /* use attribute fork not data */
81#define XFS_BMAPI_PREALLOC 0x008 /* preallocation op: unwritten space */
82#define XFS_BMAPI_IGSTATE 0x010 /* Ignore state - */
2bd0ea18 83 /* combine contig. space */
a2ceac1f 84#define XFS_BMAPI_CONTIG 0x020 /* must allocate only one extent */
56b2de80
DC
85/*
86 * unwritten extent conversion - this needs write cache flushing and no additional
87 * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
88 * from written to unwritten, otherwise convert from unwritten to written.
89 */
a2ceac1f 90#define XFS_BMAPI_CONVERT 0x040
56b2de80 91
9542ae13
DC
92/*
93 * allocate zeroed extents - this requires all newly allocated user data extents
94 * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
95 * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
96 * during the allocation range to zeroed written extents.
97 */
98#define XFS_BMAPI_ZERO 0x080
99
34621a47
DW
100/*
101 * Map the inode offset to the block given in ap->firstblock. Primarily
102 * used for reflink. The range must be in a hole, and this flag cannot be
103 * turned on with PREALLOC or CONVERT, and cannot be used on the attr fork.
36b16da8
DW
104 *
105 * For bunmapi, this flag unmaps the range without adjusting quota, reducing
106 * refcount, or freeing the blocks.
34621a47
DW
107 */
108#define XFS_BMAPI_REMAP 0x100
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
DC
114 { XFS_BMAPI_PREALLOC, "PREALLOC" }, \
115 { XFS_BMAPI_IGSTATE, "IGSTATE" }, \
116 { XFS_BMAPI_CONTIG, "CONTIG" }, \
9542ae13 117 { XFS_BMAPI_CONVERT, "CONVERT" }, \
34621a47
DW
118 { XFS_BMAPI_ZERO, "ZERO" }, \
119 { XFS_BMAPI_REMAP, "REMAP" }
56b2de80 120
2bd0ea18 121
f302e9e4
NS
122static inline int xfs_bmapi_aflag(int w)
123{
124 return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
125}
2bd0ea18
NS
126
127/*
128 * Special values for xfs_bmbt_irec_t br_startblock field.
129 */
dfc130f3
RC
130#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
131#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
2bd0ea18 132
23aab3f9 133/*
56b2de80 134 * Flags for xfs_bmap_add_extent*.
23aab3f9 135 */
56b2de80
DC
136#define BMAP_LEFT_CONTIG (1 << 0)
137#define BMAP_RIGHT_CONTIG (1 << 1)
138#define BMAP_LEFT_FILLING (1 << 2)
139#define BMAP_RIGHT_FILLING (1 << 3)
140#define BMAP_LEFT_DELAY (1 << 4)
141#define BMAP_RIGHT_DELAY (1 << 5)
142#define BMAP_LEFT_VALID (1 << 6)
143#define BMAP_RIGHT_VALID (1 << 7)
144#define BMAP_ATTRFORK (1 << 8)
145
146#define XFS_BMAP_EXT_FLAGS \
147 { BMAP_LEFT_CONTIG, "LC" }, \
148 { BMAP_RIGHT_CONTIG, "RC" }, \
149 { BMAP_LEFT_FILLING, "LF" }, \
150 { BMAP_RIGHT_FILLING, "RF" }, \
151 { BMAP_ATTRFORK, "ATTR" }
23aab3f9 152
ff105f75
DC
153
154/*
155 * This macro is used to determine how many extents will be shifted
156 * in one write transaction. We could require two splits,
157 * an extent move on the first and an extent merge on the second,
158 * So it is proper that one extent is shifted inside write transaction
159 * at a time.
160 */
161#define XFS_BMAP_MAX_SHIFT_EXTENTS 1
162
19ebedcf
DC
163enum shift_direction {
164 SHIFT_LEFT = 0,
165 SHIFT_RIGHT,
166};
167
1e2ecde4 168#ifdef DEBUG
a2ceac1f
DC
169void xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
170 int whichfork, unsigned long caller_ip);
5e656dbb 171#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
56b2de80
DC
172 xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
173#else
5e656dbb 174#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
56b2de80 175#endif
23aab3f9 176
a2ceac1f 177int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
3f17ed4b 178void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
f33cea1a 179void xfs_bmap_add_free(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
85aec44f
DW
180 xfs_fsblock_t bno, xfs_filblks_t len,
181 struct xfs_owner_info *oinfo);
a2ceac1f
DC
182void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
183int xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
184 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
185int xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
186 xfs_fileoff_t *last_block, int whichfork);
ff105f75
DC
187int xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
188 int whichfork);
a2ceac1f
DC
189int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
190int xfs_bmap_read_extents(struct xfs_trans *tp, struct xfs_inode *ip,
191 int whichfork);
192int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
193 xfs_filblks_t len, struct xfs_bmbt_irec *mval,
194 int *nmap, int flags);
a2ceac1f
DC
195int xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
196 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
197 xfs_fsblock_t *firstblock, xfs_extlen_t total,
198 struct xfs_bmbt_irec *mval, int *nmap,
f33cea1a 199 struct xfs_defer_ops *dfops);
3d36acda
DW
200int __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
201 xfs_fileoff_t bno, xfs_filblks_t *rlen, int flags,
202 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
203 struct xfs_defer_ops *dfops);
a2ceac1f
DC
204int xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
205 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
206 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
f33cea1a 207 struct xfs_defer_ops *dfops, int *done);
a2ceac1f
DC
208int xfs_check_nostate_extents(struct xfs_ifork *ifp, xfs_extnum_t idx,
209 xfs_extnum_t num);
210uint xfs_default_attroffset(struct xfs_inode *ip);
ff105f75 211int xfs_bmap_shift_extents(struct xfs_trans *tp, struct xfs_inode *ip,
19ebedcf
DC
212 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
213 int *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
f33cea1a 214 struct xfs_defer_ops *dfops, enum shift_direction direction,
19ebedcf
DC
215 int num_exts);
216int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
4488e421
CH
217struct xfs_bmbt_rec_host *
218 xfs_bmap_search_extents(struct xfs_inode *ip, xfs_fileoff_t bno,
219 int fork, int *eofp, xfs_extnum_t *lastxp,
220 struct xfs_bmbt_irec *gotp, struct xfs_bmbt_irec *prevp);
221int xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, xfs_fileoff_t aoff,
222 xfs_filblks_t len, struct xfs_bmbt_irec *got,
223 struct xfs_bmbt_irec *prev, xfs_extnum_t *lastx, int eof);
56b2de80 224
e515cca1
DC
225struct xfs_bmbt_rec_host *
226 xfs_bmap_search_extents(struct xfs_inode *ip, xfs_fileoff_t bno,
227 int fork, int *eofp, xfs_extnum_t *lastxp,
228 struct xfs_bmbt_irec *gotp,
229 struct xfs_bmbt_irec *prevp);
230
231
34f8f3e1
DW
232enum xfs_bmap_intent_type {
233 XFS_BMAP_MAP = 1,
234 XFS_BMAP_UNMAP,
235};
236
237struct xfs_bmap_intent {
238 struct list_head bi_list;
239 enum xfs_bmap_intent_type bi_type;
240 struct xfs_inode *bi_owner;
241 int bi_whichfork;
242 struct xfs_bmbt_irec bi_bmap;
243};
244
aeb88300
DW
245int xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_defer_ops *dfops,
246 struct xfs_inode *ip, enum xfs_bmap_intent_type type,
247 int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
248 xfs_filblks_t blockcount, xfs_exntst_t state);
249int xfs_bmap_map_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
250 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
251int xfs_bmap_unmap_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
252 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
253
2bd0ea18 254#endif /* __XFS_BMAP_H__ */