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