]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - libxfs/xfs_bmap.h
fs: xfs: libxfs: constify xfs_nameops structures
[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
cb8a004a
DW
110/* Map something in the CoW fork. */
111#define XFS_BMAPI_COWFORK 0x200
112
56b2de80 113#define XFS_BMAPI_FLAGS \
56b2de80
DC
114 { XFS_BMAPI_ENTIRE, "ENTIRE" }, \
115 { XFS_BMAPI_METADATA, "METADATA" }, \
116 { XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \
56b2de80
DC
117 { XFS_BMAPI_PREALLOC, "PREALLOC" }, \
118 { XFS_BMAPI_IGSTATE, "IGSTATE" }, \
119 { XFS_BMAPI_CONTIG, "CONTIG" }, \
9542ae13 120 { XFS_BMAPI_CONVERT, "CONVERT" }, \
34621a47 121 { XFS_BMAPI_ZERO, "ZERO" }, \
cb8a004a
DW
122 { XFS_BMAPI_REMAP, "REMAP" }, \
123 { XFS_BMAPI_COWFORK, "COWFORK" }
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
DC
169
170/*
171 * This macro is used to determine how many extents will be shifted
172 * in one write transaction. We could require two splits,
173 * an extent move on the first and an extent merge on the second,
174 * So it is proper that one extent is shifted inside write transaction
175 * at a time.
176 */
177#define XFS_BMAP_MAX_SHIFT_EXTENTS 1
178
19ebedcf
DC
179enum shift_direction {
180 SHIFT_LEFT = 0,
181 SHIFT_RIGHT,
182};
183
1e2ecde4 184#ifdef DEBUG
a2ceac1f
DC
185void xfs_bmap_trace_exlist(struct xfs_inode *ip, xfs_extnum_t cnt,
186 int whichfork, unsigned long caller_ip);
5e656dbb 187#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
56b2de80
DC
188 xfs_bmap_trace_exlist(ip,c,w, _THIS_IP_)
189#else
5e656dbb 190#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
56b2de80 191#endif
23aab3f9 192
b3fd8db7
DW
193void xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno,
194 xfs_filblks_t len);
a2ceac1f 195int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd);
3f17ed4b 196void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork);
f33cea1a 197void xfs_bmap_add_free(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
85aec44f
DW
198 xfs_fsblock_t bno, xfs_filblks_t len,
199 struct xfs_owner_info *oinfo);
a2ceac1f
DC
200void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
201int xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
202 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
203int xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
204 xfs_fileoff_t *last_block, int whichfork);
ff105f75
DC
205int xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
206 int whichfork);
a2ceac1f
DC
207int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork);
208int xfs_bmap_read_extents(struct xfs_trans *tp, struct xfs_inode *ip,
209 int whichfork);
210int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
211 xfs_filblks_t len, struct xfs_bmbt_irec *mval,
212 int *nmap, int flags);
a2ceac1f
DC
213int xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
214 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
215 xfs_fsblock_t *firstblock, xfs_extlen_t total,
216 struct xfs_bmbt_irec *mval, int *nmap,
f33cea1a 217 struct xfs_defer_ops *dfops);
3d36acda
DW
218int __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
219 xfs_fileoff_t bno, xfs_filblks_t *rlen, int flags,
220 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
221 struct xfs_defer_ops *dfops);
a2ceac1f
DC
222int xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
223 xfs_fileoff_t bno, xfs_filblks_t len, int flags,
224 xfs_extnum_t nexts, xfs_fsblock_t *firstblock,
f33cea1a 225 struct xfs_defer_ops *dfops, int *done);
ece930fa
CH
226int xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork,
227 xfs_extnum_t *idx, struct xfs_bmbt_irec *got,
228 struct xfs_bmbt_irec *del);
229void xfs_bmap_del_extent_cow(struct xfs_inode *ip, xfs_extnum_t *idx,
230 struct xfs_bmbt_irec *got, struct xfs_bmbt_irec *del);
a2ceac1f
DC
231int xfs_check_nostate_extents(struct xfs_ifork *ifp, xfs_extnum_t idx,
232 xfs_extnum_t num);
233uint xfs_default_attroffset(struct xfs_inode *ip);
ff105f75 234int xfs_bmap_shift_extents(struct xfs_trans *tp, struct xfs_inode *ip,
19ebedcf
DC
235 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
236 int *done, xfs_fileoff_t stop_fsb, xfs_fsblock_t *firstblock,
f33cea1a 237 struct xfs_defer_ops *dfops, enum shift_direction direction,
19ebedcf
DC
238 int num_exts);
239int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset);
cc66acaf
DW
240int xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, int whichfork,
241 xfs_fileoff_t aoff, xfs_filblks_t len,
d41d2303 242 struct xfs_bmbt_irec *got, xfs_extnum_t *lastx, int eof);
56b2de80 243
34f8f3e1
DW
244enum xfs_bmap_intent_type {
245 XFS_BMAP_MAP = 1,
246 XFS_BMAP_UNMAP,
247};
248
249struct xfs_bmap_intent {
250 struct list_head bi_list;
251 enum xfs_bmap_intent_type bi_type;
252 struct xfs_inode *bi_owner;
253 int bi_whichfork;
254 struct xfs_bmbt_irec bi_bmap;
255};
256
aeb88300
DW
257int xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_defer_ops *dfops,
258 struct xfs_inode *ip, enum xfs_bmap_intent_type type,
259 int whichfork, xfs_fileoff_t startoff, xfs_fsblock_t startblock,
260 xfs_filblks_t blockcount, xfs_exntst_t state);
261int xfs_bmap_map_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
262 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
263int xfs_bmap_unmap_extent(struct xfs_mount *mp, struct xfs_defer_ops *dfops,
264 struct xfs_inode *ip, struct xfs_bmbt_irec *imap);
265
2bd0ea18 266#endif /* __XFS_BMAP_H__ */