2 * Copyright (c) 2000-2003 Silicon Graphics, Inc. All Rights Reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * Further, this software is distributed without any warranty that it is
13 * free of the rightful claim of any third person regarding infringement
14 * or the like. Any license provided herein, whether implied or
15 * otherwise, applies only to this software file. Patent licenses, if
16 * any, provided herein do not apply to combinations of this program with
17 * other software, or any other product whatsoever.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write the Free Software Foundation, Inc., 59
21 * Temple Place - Suite 330, Boston MA 02111-1307, USA.
23 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24 * Mountain View, CA 94043, or:
28 * For further information regarding this notice, see:
30 * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
32 #ifndef __XFS_BMAP_H__
33 #define __XFS_BMAP_H__
42 * List of extents to be free "later".
43 * The list is kept sorted on xbf_startblock.
45 typedef struct xfs_bmap_free_item
47 xfs_fsblock_t xbfi_startblock;/* starting fs block number */
48 xfs_extlen_t xbfi_blockcount;/* number of blocks in extent */
49 struct xfs_bmap_free_item *xbfi_next; /* link to next entry */
50 } xfs_bmap_free_item_t;
53 * Header for free extent list.
55 typedef struct xfs_bmap_free
57 xfs_bmap_free_item_t *xbf_first; /* list of to-be-free extents */
58 int xbf_count; /* count of items on list */
59 int xbf_low; /* kludge: alloc in low mode */
62 #define XFS_BMAP_MAX_NMAP 4
67 #define XFS_BMAPI_WRITE 0x001 /* write operation: allocate space */
68 #define XFS_BMAPI_DELAY 0x002 /* delayed write operation */
69 #define XFS_BMAPI_ENTIRE 0x004 /* return entire extent, not trimmed */
70 #define XFS_BMAPI_METADATA 0x008 /* mapping metadata not user data */
71 #define XFS_BMAPI_EXACT 0x010 /* allocate only to spec'd bounds */
72 #define XFS_BMAPI_ATTRFORK 0x020 /* use attribute fork not data */
73 #define XFS_BMAPI_ASYNC 0x040 /* bunmapi xactions can be async */
74 #define XFS_BMAPI_RSVBLOCKS 0x080 /* OK to alloc. reserved data blocks */
75 #define XFS_BMAPI_PREALLOC 0x100 /* preallocation op: unwritten space */
76 #define XFS_BMAPI_IGSTATE 0x200 /* Ignore state - */
77 /* combine contig. space */
78 #define XFS_BMAPI_CONTIG 0x400 /* must allocate only one extent */
80 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_BMAPI_AFLAG)
81 int xfs_bmapi_aflag(int w);
82 #define XFS_BMAPI_AFLAG(w) xfs_bmapi_aflag(w)
84 #define XFS_BMAPI_AFLAG(w) ((w) == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 0)
88 * Special values for xfs_bmbt_irec_t br_startblock field.
90 #define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL)
91 #define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL)
93 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_BMAP_INIT)
94 void xfs_bmap_init(xfs_bmap_free_t *flp, xfs_fsblock_t *fbp);
95 #define XFS_BMAP_INIT(flp,fbp) xfs_bmap_init(flp,fbp)
97 #define XFS_BMAP_INIT(flp,fbp) \
98 ((flp)->xbf_first = NULL, (flp)->xbf_count = 0, \
99 (flp)->xbf_low = 0, *(fbp) = NULLFSBLOCK)
103 * Argument structure for xfs_bmap_alloc.
105 typedef struct xfs_bmalloca {
106 xfs_fsblock_t firstblock; /* i/o first block allocated */
107 xfs_fsblock_t rval; /* starting block of new extent */
108 xfs_fileoff_t off; /* offset in file filling in */
109 struct xfs_trans *tp; /* transaction pointer */
110 struct xfs_inode *ip; /* incore inode pointer */
111 struct xfs_bmbt_irec *prevp; /* extent before the new one */
112 struct xfs_bmbt_irec *gotp; /* extent after, or delayed */
113 xfs_extlen_t alen; /* i/o length asked/allocated */
114 xfs_extlen_t total; /* total blocks needed for xaction */
115 xfs_extlen_t minlen; /* mininum allocation size (blocks) */
116 xfs_extlen_t minleft; /* amount must be left after alloc */
117 char eof; /* set if allocating past last extent */
118 char wasdel; /* replacing a delayed allocation */
119 char userdata;/* set if is user data */
120 char low; /* low on space, using seq'l ags */
121 char aeof; /* allocated space at eof */
126 #if defined(XFS_BMAP_TRACE)
128 * Trace operations for bmap extent tracing
130 #define XFS_BMAP_KTRACE_DELETE 1
131 #define XFS_BMAP_KTRACE_INSERT 2
132 #define XFS_BMAP_KTRACE_PRE_UP 3
133 #define XFS_BMAP_KTRACE_POST_UP 4
135 #define XFS_BMAP_TRACE_SIZE 4096 /* size of global trace buffer */
136 #define XFS_BMAP_KTRACE_SIZE 32 /* size of per-inode trace buffer */
137 extern ktrace_t *xfs_bmap_trace_buf;
140 * Add bmap trace insert entries for all the contents of the extent list.
143 xfs_bmap_trace_exlist(
144 char *fname, /* function name */
145 struct xfs_inode *ip, /* incore inode pointer */
146 xfs_extnum_t cnt, /* count of entries in list */
147 int whichfork); /* data or attr fork */
149 #define xfs_bmap_trace_exlist(f,ip,c,w)
153 * Convert inode from non-attributed to attributed.
154 * Must not be in a transaction, ip must not be locked.
157 xfs_bmap_add_attrfork(
158 struct xfs_inode *ip, /* incore inode pointer */
159 int rsvd); /* flag for reserved block allocation */
162 * Add the extent to the list of extents to be free at transaction end.
163 * The list is maintained sorted (by block number).
167 xfs_fsblock_t bno, /* fs block number of extent */
168 xfs_filblks_t len, /* length of extent */
169 xfs_bmap_free_t *flist, /* list of extents */
170 struct xfs_mount *mp); /* mount point structure */
173 * Routine to clean up the free list data structure when
174 * an error occurs during a transaction.
178 xfs_bmap_free_t *flist); /* free list to clean up */
181 * Routine to check if a specified inode is swap capable.
184 xfs_bmap_check_swappable(
185 struct xfs_inode *ip); /* incore inode */
188 * Compute and fill in the value of the maximum depth of a bmap btree
189 * in this filesystem. Done once, during mount.
192 xfs_bmap_compute_maxlevels(
193 struct xfs_mount *mp, /* file system mount structure */
194 int whichfork); /* data or attr fork */
197 * Routine to be called at transaction's end by xfs_bmapi, xfs_bunmapi
198 * caller. Frees all the extents that need freeing, which must be done
199 * last due to locking considerations.
201 * Return 1 if the given transaction was committed and a new one allocated,
206 struct xfs_trans **tp, /* transaction pointer addr */
207 xfs_bmap_free_t *flist, /* i/o: list extents to free */
208 xfs_fsblock_t firstblock, /* controlled a.g. for allocs */
209 int *committed); /* xact committed or not */
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.
217 xfs_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 */
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.
231 xfs_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 */
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.
243 xfs_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 */
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.
256 struct xfs_inode *ip, /* incore inode */
257 int whichfork); /* data or attr fork */
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.
265 xfs_bmap_read_extents(
266 struct xfs_trans *tp, /* transaction pointer */
267 struct xfs_inode *ip, /* incore inode */
268 int whichfork); /* data or attr fork */
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").
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 */
295 xfs_bmap_free_t *flist); /* i/o: list extents to free */
298 * Map file blocks to filesystem blocks, simple version.
299 * One block only, read-only.
300 * For flags, only the XFS_BMAPI_ATTRFORK flag is examined.
301 * For the other flag values, the effect is as if XFS_BMAPI_METADATA
302 * was set and all the others were clear.
306 struct xfs_trans *tp, /* transaction pointer */
307 struct xfs_inode *ip, /* incore inode */
308 int whichfork, /* data or attr fork */
309 xfs_fsblock_t *fsb, /* output: mapped block */
310 xfs_fileoff_t bno); /* starting file offs. mapped */
313 * Unmap (remove) blocks from a file.
314 * If nexts is nonzero then the number of extents to remove is limited to
315 * that value. If not all extents in the block range can be removed then
320 struct xfs_trans *tp, /* transaction pointer */
321 struct xfs_inode *ip, /* incore inode */
322 xfs_fileoff_t bno, /* starting offset to unmap */
323 xfs_filblks_t len, /* length to unmap in file */
324 int flags, /* XFS_BMAPI_... */
325 xfs_extnum_t nexts, /* number of extents max */
326 xfs_fsblock_t *firstblock, /* first allocated block
327 controls a.g. for allocs */
328 xfs_bmap_free_t *flist, /* i/o: list extents to free */
329 int *done); /* set if not done yet */
332 * Fcntl interface to xfs_bmapi.
336 bhv_desc_t *bdp, /* XFS behavior descriptor*/
337 struct getbmap *bmv, /* user bmap structure */
338 void *ap, /* pointer to user's array */
339 int iflags); /* interface flags */
342 * Check the last inode extent to determine whether this allocation will result
343 * in blocks being allocated at the end of the file. When we allocate new data
344 * blocks at the end of the file which do not start at the previous data block,
345 * we will try to align the new blocks at stripe unit boundaries.
349 struct xfs_inode *ip,
355 * Check if the endoff is outside the last extent. If so the caller will grow
356 * the allocation to a stripe unit boundary
360 struct xfs_inode *ip,
361 xfs_fileoff_t endoff,
366 * Count fsblocks of the given fork.
369 xfs_bmap_count_blocks(
371 struct xfs_inode *ip,
376 * Check an extent list, which has just been read, for
377 * any bit in the extent flag field.
380 xfs_check_nostate_extents(
384 #endif /* __KERNEL__ */
386 #endif /* __XFS_BMAP_H__ */