]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - libxfs/xfs_bmap.h
xfs: sanity-check the unused space before trying to use it
[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 */
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
cb8a004a
DW
110/* Map something in the CoW fork. */
111#define XFS_BMAPI_COWFORK 0x200
112
7075a23f
CH
113/* Only convert delalloc space, don't allocate entirely new extents */
114#define XFS_BMAPI_DELALLOC 0x400
115
8e87c884
CH
116/* Only convert unwritten extents, don't allocate new blocks */
117#define XFS_BMAPI_CONVERT_ONLY 0x800
118
56b2de80 119#define XFS_BMAPI_FLAGS \
56b2de80
DC
120 { XFS_BMAPI_ENTIRE, "ENTIRE" }, \
121 { XFS_BMAPI_METADATA, "METADATA" }, \
122 { XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
56b2de80
DC
123 { XFS_BMAPI_PREALLOC, "PREALLOC" }, \
124 { XFS_BMAPI_IGSTATE, "IGSTATE" }, \
125 { XFS_BMAPI_CONTIG, "CONTIG" }, \
9542ae13 126 { XFS_BMAPI_CONVERT, "CONVERT" }, \
34621a47 127 { XFS_BMAPI_ZERO, "ZERO" }, \
cb8a004a 128 { XFS_BMAPI_REMAP, "REMAP" }, \
7075a23f 129 { XFS_BMAPI_COWFORK, "COWFORK" }, \
8e87c884
CH
130 { XFS_BMAPI_DELALLOC, "DELALLOC" }, \
131 { XFS_BMAPI_CONVERT_ONLY, "CONVERT_ONLY" }
56b2de80 132
2bd0ea18 133
f302e9e4
NS
134static inline int xfs_bmapi_aflag(int w)
135{
cb8a004a
DW
136 return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK :
137 (w == XFS_COW_FORK ? XFS_BMAPI_COWFORK : 0));
138}
139
140static inline int xfs_bmapi_whichfork(int bmapi_flags)
141{
142 if (bmapi_flags & XFS_BMAPI_COWFORK)
143 return XFS_COW_FORK;
144 else if (bmapi_flags & XFS_BMAPI_ATTRFORK)
145 return XFS_ATTR_FORK;
146 return XFS_DATA_FORK;
f302e9e4 147}
2bd0ea18
NS
148
149/*
150 * Special values for xfs_bmbt_irec_t br_startblock field.
151 */
dfc130f3
RC
152#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
153#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
2bd0ea18 154
23aab3f9 155/*
56b2de80 156 * Flags for xfs_bmap_add_extent*.
23aab3f9 157 */
56b2de80
DC
158#define BMAP_LEFT_CONTIG (1 << 0)
159#define BMAP_RIGHT_CONTIG (1 << 1)
160#define BMAP_LEFT_FILLING (1 << 2)
161#define BMAP_RIGHT_FILLING (1 << 3)
162#define BMAP_LEFT_DELAY (1 << 4)
163#define BMAP_RIGHT_DELAY (1 << 5)
164#define BMAP_LEFT_VALID (1 << 6)
165#define BMAP_RIGHT_VALID (1 << 7)
166#define BMAP_ATTRFORK (1 << 8)
cb8a004a 167#define BMAP_COWFORK (1 << 9)
56b2de80
DC
168
169#define XFS_BMAP_EXT_FLAGS \
170 { BMAP_LEFT_CONTIG, "LC" }, \
171 { BMAP_RIGHT_CONTIG, "RC" }, \
172 { BMAP_LEFT_FILLING, "LF" }, \
173 { BMAP_RIGHT_FILLING, "RF" }, \
cb8a004a
DW
174 { BMAP_ATTRFORK, "ATTR" }, \
175 { BMAP_COWFORK, "COW" }
23aab3f9 176
ff105f75 177
cd83dc79
CH
178/*
179 * Return true if the extent is a real, allocated extent, or false if it is a
180 * delayed allocation, and unwritten extent or a hole.
181 */
182static inline bool xfs_bmap_is_real_extent(struct xfs_bmbt_irec *irec)
183{
184 return irec->br_state != XFS_EXT_UNWRITTEN &&
185 irec->br_startblock != HOLESTARTBLOCK &&
186 irec->br_startblock != DELAYSTARTBLOCK &&
187 !isnullstartblock(irec->br_startblock);
188}
189
b3fd8db7
DW
190void xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno,
191 xfs_filblks_t len);
ca75eb20 192void xfs_trim_extent_eof(struct xfs_bmbt_irec *, struct xfs_inode *);
a2ceac1f 193int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
3f17ed4b 194void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
f33cea1a 195void xfs_bmap_add_free(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
85aec44f
DW
196 xfs_fsblock_t bno, xfs_filblks_t len,
197 struct xfs_owner_info *oinfo);
a2ceac1f
DC
198void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
199int xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
200 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
201int xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
202 xfs_fileoff_t *last_block, int whichfork);
ff105f75
DC
203int xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
204 int whichfork);
a2ceac1f 205int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
a2ceac1f
DC
206int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
207 xfs_filblks_t len, struct xfs_bmbt_irec *mval,
208 int *nmap, int flags);
a2ceac1f
DC
209int xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
210 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
211 xfs_fsblock_t *firstblock, xfs_extlen_t total,
212 struct xfs_bmbt_irec *mval, int *nmap,
f33cea1a 213 struct xfs_defer_ops *dfops);
3d36acda
DW
214int __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
215 xfs_fileoff_t bno, xfs_filblks_t *rlen, int flags,
216 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
217 struct xfs_defer_ops *dfops);
a2ceac1f
DC
218int xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
219 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
220 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
f33cea1a 221 struct xfs_defer_ops *dfops, int *done);
ece930fa 222int xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork,
9788e059
CH
223 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
224 struct xfs_bmbt_irec *del);
225void xfs_bmap_del_extent_cow(struct xfs_inode *ip,
226 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
ece930fa 227 struct xfs_bmbt_irec *del);
a2ceac1f 228uint xfs_default_attroffset(struct xfs_inode *ip);
a9f5d25e 229int xfs_bmap_collapse_extents(struct xfs_trans *tp, struct xfs_inode *ip,
19ebedcf 230 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
a9f5d25e
CH
231 bool *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
232 struct xfs_defer_ops *dfops);
233int xfs_bmap_insert_extents(struct xfs_trans *tp, struct xfs_inode *ip,
234 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
235 bool *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
236 struct xfs_defer_ops *dfops);
19ebedcf 237int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
cc66acaf 238int xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, int whichfork,
f7b1a8b1 239 xfs_fileoff_t off, xfs_filblks_t len, xfs_filblks_t prealloc,
9788e059
CH
240 struct xfs_bmbt_irec *got, struct xfs_iext_cursor *cur,
241 int eof);
56b2de80 242
34f8f3e1
DW
243enum xfs_bmap_intent_type {
244 XFS_BMAP_MAP = 1,
245 XFS_BMAP_UNMAP,
246};
247
248struct xfs_bmap_intent {
249 struct list_head bi_list;
250 enum xfs_bmap_intent_type bi_type;
251 struct xfs_inode *bi_owner;
252 int bi_whichfork;
253 struct xfs_bmbt_irec bi_bmap;
254};
255
aeb88300
DW
256int xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_defer_ops *dfops,
257 struct xfs_inode *ip, enum xfs_bmap_intent_type type,
258 int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
594956fa 259 xfs_filblks_t *blockcount, xfs_exntst_t state);
aeb88300
DW
260int xfs_bmap_map_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
261 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
262int xfs_bmap_unmap_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
263 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
264
7bd43334
CH
265static inline int xfs_bmap_fork_to_state(int whichfork)
266{
267 switch (whichfork) {
268 case XFS_ATTR_FORK:
269 return BMAP_ATTRFORK;
270 case XFS_COW_FORK:
271 return BMAP_COWFORK;
272 default:
273 return 0;
274 }
275}
276
2bd0ea18 277#endif /* __XFS_BMAP_H__ */