blob: 6ff70cda451cbe6011a118ac6a612eaf79dfd3a5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Olaf Weber3e57ecf2006-06-09 14:48:12 +10002 * Copyright (c) 2000-2006 Silicon Graphics, Inc.
Nathan Scott7b718762005-11-02 14:58:39 +11003 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_BMAP_H__
19#define __XFS_BMAP_H__
20
21struct getbmap;
22struct xfs_bmbt_irec;
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +110023struct xfs_ifork;
Linus Torvalds1da177e2005-04-16 15:20:36 -070024struct xfs_inode;
25struct xfs_mount;
26struct xfs_trans;
27
David Chinnera8272ce2007-11-23 16:28:09 +110028extern kmem_zone_t *xfs_bmap_free_item_zone;
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030/*
Olaf Weber3e57ecf2006-06-09 14:48:12 +100031 * DELTA: describe a change to the in-core extent list.
32 *
33 * Internally the use of xed_blockount is somewhat funky.
34 * xed_blockcount contains an offset much of the time because this
35 * makes merging changes easier. (xfs_fileoff_t and xfs_filblks_t are
36 * the same underlying type).
37 */
38typedef struct xfs_extdelta
39{
40 xfs_fileoff_t xed_startoff; /* offset of range */
41 xfs_filblks_t xed_blockcount; /* blocks in range */
42} xfs_extdelta_t;
43
44/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * List of extents to be free "later".
46 * The list is kept sorted on xbf_startblock.
47 */
48typedef struct xfs_bmap_free_item
49{
50 xfs_fsblock_t xbfi_startblock;/* starting fs block number */
51 xfs_extlen_t xbfi_blockcount;/* number of blocks in extent */
52 struct xfs_bmap_free_item *xbfi_next; /* link to next entry */
53} xfs_bmap_free_item_t;
54
55/*
56 * Header for free extent list.
57 */
58typedef struct xfs_bmap_free
59{
60 xfs_bmap_free_item_t *xbf_first; /* list of to-be-free extents */
61 int xbf_count; /* count of items on list */
62 int xbf_low; /* kludge: alloc in low mode */
63} xfs_bmap_free_t;
64
65#define XFS_BMAP_MAX_NMAP 4
66
67/*
68 * Flags for xfs_bmapi
69 */
70#define XFS_BMAPI_WRITE 0x001 /* write operation: allocate space */
71#define XFS_BMAPI_DELAY 0x002 /* delayed write operation */
72#define XFS_BMAPI_ENTIRE 0x004 /* return entire extent, not trimmed */
73#define XFS_BMAPI_METADATA 0x008 /* mapping metadata not user data */
74#define XFS_BMAPI_EXACT 0x010 /* allocate only to spec'd bounds */
75#define XFS_BMAPI_ATTRFORK 0x020 /* use attribute fork not data */
76#define XFS_BMAPI_ASYNC 0x040 /* bunmapi xactions can be async */
77#define XFS_BMAPI_RSVBLOCKS 0x080 /* OK to alloc. reserved data blocks */
78#define XFS_BMAPI_PREALLOC 0x100 /* preallocation op: unwritten space */
79#define XFS_BMAPI_IGSTATE 0x200 /* Ignore state - */
80 /* combine contig. space */
81#define XFS_BMAPI_CONTIG 0x400 /* must allocate only one extent */
Nathan Scottdd9f4382006-01-11 15:28:28 +110082/* XFS_BMAPI_DIRECT_IO 0x800 */
83#define XFS_BMAPI_CONVERT 0x1000 /* unwritten extent conversion - */
84 /* need write cache flushing and no */
85 /* additional allocation alignments */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#define XFS_BMAPI_AFLAG(w) xfs_bmapi_aflag(w)
Nathan Scotta844f452005-11-02 14:38:42 +110088static inline int xfs_bmapi_aflag(int w)
89{
90 return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0);
91}
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93/*
94 * Special values for xfs_bmbt_irec_t br_startblock field.
95 */
96#define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
97#define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099#define XFS_BMAP_INIT(flp,fbp) xfs_bmap_init(flp,fbp)
Nathan Scotta844f452005-11-02 14:38:42 +1100100static inline void xfs_bmap_init(xfs_bmap_free_t *flp, xfs_fsblock_t *fbp)
101{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 ((flp)->xbf_first = NULL, (flp)->xbf_count = 0, \
Nathan Scotta844f452005-11-02 14:38:42 +1100103 (flp)->xbf_low = 0, *(fbp) = NULLFSBLOCK);
104}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106/*
107 * Argument structure for xfs_bmap_alloc.
108 */
109typedef struct xfs_bmalloca {
110 xfs_fsblock_t firstblock; /* i/o first block allocated */
111 xfs_fsblock_t rval; /* starting block of new extent */
112 xfs_fileoff_t off; /* offset in file filling in */
113 struct xfs_trans *tp; /* transaction pointer */
114 struct xfs_inode *ip; /* incore inode pointer */
115 struct xfs_bmbt_irec *prevp; /* extent before the new one */
116 struct xfs_bmbt_irec *gotp; /* extent after, or delayed */
117 xfs_extlen_t alen; /* i/o length asked/allocated */
118 xfs_extlen_t total; /* total blocks needed for xaction */
119 xfs_extlen_t minlen; /* mininum allocation size (blocks) */
120 xfs_extlen_t minleft; /* amount must be left after alloc */
121 char eof; /* set if allocating past last extent */
122 char wasdel; /* replacing a delayed allocation */
123 char userdata;/* set if is user data */
124 char low; /* low on space, using seq'l ags */
Nathan Scottdd9f4382006-01-11 15:28:28 +1100125 char aeof; /* allocated space at eof */
126 char conv; /* overwriting unwritten extents */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127} xfs_bmalloca_t;
128
129#ifdef __KERNEL__
130
131#if defined(XFS_BMAP_TRACE)
132/*
133 * Trace operations for bmap extent tracing
134 */
135#define XFS_BMAP_KTRACE_DELETE 1
136#define XFS_BMAP_KTRACE_INSERT 2
137#define XFS_BMAP_KTRACE_PRE_UP 3
138#define XFS_BMAP_KTRACE_POST_UP 4
139
140#define XFS_BMAP_TRACE_SIZE 4096 /* size of global trace buffer */
141#define XFS_BMAP_KTRACE_SIZE 32 /* size of per-inode trace buffer */
142extern ktrace_t *xfs_bmap_trace_buf;
143
144/*
145 * Add bmap trace insert entries for all the contents of the extent list.
146 */
147void
148xfs_bmap_trace_exlist(
Eric Sandeen3a59c942007-07-11 11:09:47 +1000149 const char *fname, /* function name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 struct xfs_inode *ip, /* incore inode pointer */
151 xfs_extnum_t cnt, /* count of entries in list */
152 int whichfork); /* data or attr fork */
Eric Sandeen3a59c942007-07-11 11:09:47 +1000153#define XFS_BMAP_TRACE_EXLIST(ip,c,w) \
Harvey Harrison34a622b2008-04-10 12:19:21 +1000154 xfs_bmap_trace_exlist(__func__,ip,c,w)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155#else
Eric Sandeen3a59c942007-07-11 11:09:47 +1000156#define XFS_BMAP_TRACE_EXLIST(ip,c,w)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#endif
158
159/*
160 * Convert inode from non-attributed to attributed.
161 * Must not be in a transaction, ip must not be locked.
162 */
163int /* error code */
164xfs_bmap_add_attrfork(
165 struct xfs_inode *ip, /* incore inode pointer */
Nathan Scottd8cc8902005-11-02 10:34:53 +1100166 int size, /* space needed for new attribute */
167 int rsvd); /* flag for reserved block allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169/*
170 * Add the extent to the list of extents to be free at transaction end.
171 * The list is maintained sorted (by block number).
172 */
173void
174xfs_bmap_add_free(
175 xfs_fsblock_t bno, /* fs block number of extent */
176 xfs_filblks_t len, /* length of extent */
177 xfs_bmap_free_t *flist, /* list of extents */
178 struct xfs_mount *mp); /* mount point structure */
179
180/*
181 * Routine to clean up the free list data structure when
182 * an error occurs during a transaction.
183 */
184void
185xfs_bmap_cancel(
186 xfs_bmap_free_t *flist); /* free list to clean up */
187
188/*
189 * Compute and fill in the value of the maximum depth of a bmap btree
190 * in this filesystem. Done once, during mount.
191 */
192void
193xfs_bmap_compute_maxlevels(
194 struct xfs_mount *mp, /* file system mount structure */
195 int whichfork); /* data or attr fork */
196
197/*
198 * Routine to be called at transaction's end by xfs_bmapi, xfs_bunmapi
199 * caller. Frees all the extents that need freeing, which must be done
200 * last due to locking considerations.
201 *
202 * Return 1 if the given transaction was committed and a new one allocated,
203 * and 0 otherwise.
204 */
205int /* error */
206xfs_bmap_finish(
207 struct xfs_trans **tp, /* transaction pointer addr */
208 xfs_bmap_free_t *flist, /* i/o: list extents to free */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 int *committed); /* xact committed or not */
210
211/*
212 * Returns the file-relative block number of the first unused block in the file.
213 * This is the lowest-address hole if the file has holes, else the first block
214 * past the end of file.
215 */
216int /* error */
217xfs_bmap_first_unused(
218 struct xfs_trans *tp, /* transaction pointer */
219 struct xfs_inode *ip, /* incore inode */
220 xfs_extlen_t len, /* size of hole to find */
221 xfs_fileoff_t *unused, /* unused block num */
222 int whichfork); /* data or attr fork */
223
224/*
225 * Returns the file-relative block number of the last block + 1 before
226 * last_block (input value) in the file.
227 * This is not based on i_size, it is based on the extent list.
228 * Returns 0 for local files, as they do not have an extent list.
229 */
230int /* error */
231xfs_bmap_last_before(
232 struct xfs_trans *tp, /* transaction pointer */
233 struct xfs_inode *ip, /* incore inode */
234 xfs_fileoff_t *last_block, /* last block */
235 int whichfork); /* data or attr fork */
236
237/*
238 * Returns the file-relative block number of the first block past eof in
239 * the file. This is not based on i_size, it is based on the extent list.
240 * Returns 0 for local files, as they do not have an extent list.
241 */
242int /* error */
243xfs_bmap_last_offset(
244 struct xfs_trans *tp, /* transaction pointer */
245 struct xfs_inode *ip, /* incore inode */
246 xfs_fileoff_t *unused, /* last block num */
247 int whichfork); /* data or attr fork */
248
249/*
250 * Returns whether the selected fork of the inode has exactly one
251 * block or not. For the data fork we check this matches di_size,
252 * implying the file's range is 0..bsize-1.
253 */
254int
255xfs_bmap_one_block(
256 struct xfs_inode *ip, /* incore inode */
257 int whichfork); /* data or attr fork */
258
259/*
260 * Read in the extents to iu_extents.
261 * All inode fields are set up by caller, we just traverse the btree
262 * and copy the records in.
263 */
264int /* error */
265xfs_bmap_read_extents(
266 struct xfs_trans *tp, /* transaction pointer */
267 struct xfs_inode *ip, /* incore inode */
268 int whichfork); /* data or attr fork */
269
270/*
271 * Map file blocks to filesystem blocks.
272 * File range is given by the bno/len pair.
273 * Adds blocks to file if a write ("flags & XFS_BMAPI_WRITE" set)
274 * into a hole or past eof.
275 * Only allocates blocks from a single allocation group,
276 * to avoid locking problems.
277 * The returned value in "firstblock" from the first call in a transaction
278 * must be remembered and presented to subsequent calls in "firstblock".
279 * An upper bound for the number of blocks to be allocated is supplied to
280 * the first call in "total"; if no allocation group has that many free
281 * blocks then the call will fail (return NULLFSBLOCK in "firstblock").
282 */
283int /* error */
284xfs_bmapi(
285 struct xfs_trans *tp, /* transaction pointer */
286 struct xfs_inode *ip, /* incore inode */
287 xfs_fileoff_t bno, /* starting file offs. mapped */
288 xfs_filblks_t len, /* length to map in file */
289 int flags, /* XFS_BMAPI_... */
290 xfs_fsblock_t *firstblock, /* first allocated block
291 controls a.g. for allocs */
292 xfs_extlen_t total, /* total blocks needed */
293 struct xfs_bmbt_irec *mval, /* output: map values */
294 int *nmap, /* i/o: mval size/count */
Olaf Weber3e57ecf2006-06-09 14:48:12 +1000295 xfs_bmap_free_t *flist, /* i/o: list extents to free */
296 xfs_extdelta_t *delta); /* o: change made to incore
297 extents */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299/*
300 * Map file blocks to filesystem blocks, simple version.
301 * One block only, read-only.
302 * For flags, only the XFS_BMAPI_ATTRFORK flag is examined.
303 * For the other flag values, the effect is as if XFS_BMAPI_METADATA
304 * was set and all the others were clear.
305 */
306int /* error */
307xfs_bmapi_single(
308 struct xfs_trans *tp, /* transaction pointer */
309 struct xfs_inode *ip, /* incore inode */
310 int whichfork, /* data or attr fork */
311 xfs_fsblock_t *fsb, /* output: mapped block */
312 xfs_fileoff_t bno); /* starting file offs. mapped */
313
314/*
315 * Unmap (remove) blocks from a file.
316 * If nexts is nonzero then the number of extents to remove is limited to
317 * that value. If not all extents in the block range can be removed then
318 * *done is set.
319 */
320int /* error */
321xfs_bunmapi(
322 struct xfs_trans *tp, /* transaction pointer */
323 struct xfs_inode *ip, /* incore inode */
324 xfs_fileoff_t bno, /* starting offset to unmap */
325 xfs_filblks_t len, /* length to unmap in file */
326 int flags, /* XFS_BMAPI_... */
327 xfs_extnum_t nexts, /* number of extents max */
328 xfs_fsblock_t *firstblock, /* first allocated block
329 controls a.g. for allocs */
330 xfs_bmap_free_t *flist, /* i/o: list extents to free */
Olaf Weber3e57ecf2006-06-09 14:48:12 +1000331 xfs_extdelta_t *delta, /* o: change made to incore
332 extents */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 int *done); /* set if not done yet */
334
335/*
336 * Fcntl interface to xfs_bmapi.
337 */
338int /* error code */
339xfs_getbmap(
Christoph Hellwig993386c2007-08-28 16:12:30 +1000340 xfs_inode_t *ip,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 struct getbmap *bmv, /* user bmap structure */
342 void __user *ap, /* pointer to user's array */
343 int iflags); /* interface flags */
344
345/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 * Check if the endoff is outside the last extent. If so the caller will grow
347 * the allocation to a stripe unit boundary
348 */
349int
350xfs_bmap_eof(
351 struct xfs_inode *ip,
352 xfs_fileoff_t endoff,
353 int whichfork,
354 int *eof);
355
356/*
357 * Count fsblocks of the given fork.
358 */
359int
360xfs_bmap_count_blocks(
361 xfs_trans_t *tp,
362 struct xfs_inode *ip,
363 int whichfork,
364 int *count);
365
366/*
367 * Check an extent list, which has just been read, for
368 * any bit in the extent flag field.
369 */
370int
371xfs_check_nostate_extents(
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100372 struct xfs_ifork *ifp,
373 xfs_extnum_t idx,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 xfs_extnum_t num);
375
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100376/*
Mandy Kirkconnell4b4fa252006-03-31 13:03:58 +1000377 * Search the extent records for the entry containing block bno.
378 * If bno lies in a hole, point to the next entry. If bno lies
379 * past eof, *eofp will be set, and *prevp will contain the last
380 * entry (null if none). Else, *lastxp will be set to the index
381 * of the found entry; *gotp will contain the entry.
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100382 */
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000383xfs_bmbt_rec_host_t *
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100384xfs_bmap_search_multi_extents(struct xfs_ifork *, xfs_fileoff_t, int *,
385 xfs_extnum_t *, xfs_bmbt_irec_t *, xfs_bmbt_irec_t *);
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387#endif /* __KERNEL__ */
388
389#endif /* __XFS_BMAP_H__ */