1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2000-2006 Silicon Graphics, Inc. 4 * All Rights Reserved. 5 */ 6 #ifndef __XFS_BMAP_H__ 7 #define __XFS_BMAP_H__ 8 9 struct getbmap; 10 struct xfs_bmbt_irec; 11 struct xfs_ifork; 12 struct xfs_inode; 13 struct xfs_mount; 14 struct xfs_trans; 15 16 extern kmem_zone_t *xfs_bmap_free_item_zone; 17 18 /* 19 * Argument structure for xfs_bmap_alloc. 20 */ 21 struct xfs_bmalloca { 22 struct xfs_trans *tp; /* transaction pointer */ 23 struct xfs_inode *ip; /* incore inode pointer */ 24 struct xfs_bmbt_irec prev; /* extent before the new one */ 25 struct xfs_bmbt_irec got; /* extent after, or delayed */ 26 27 xfs_fileoff_t offset; /* offset in file filling in */ 28 xfs_extlen_t length; /* i/o length asked/allocated */ 29 xfs_fsblock_t blkno; /* starting block of new extent */ 30 31 struct xfs_btree_cur *cur; /* btree cursor */ 32 struct xfs_iext_cursor icur; /* incore extent cursor */ 33 int nallocs;/* number of extents alloc'd */ 34 int logflags;/* flags for transaction logging */ 35 36 xfs_extlen_t total; /* total blocks needed for xaction */ 37 xfs_extlen_t minlen; /* minimum allocation size (blocks) */ 38 xfs_extlen_t minleft; /* amount must be left after alloc */ 39 bool eof; /* set if allocating past last extent */ 40 bool wasdel; /* replacing a delayed allocation */ 41 bool aeof; /* allocated space at eof */ 42 bool conv; /* overwriting unwritten extents */ 43 int datatype;/* data type being allocated */ 44 int flags; 45 }; 46 47 /* 48 * List of extents to be free "later". 49 * The list is kept sorted on xbf_startblock. 50 */ 51 struct xfs_extent_free_item 52 { 53 xfs_fsblock_t xefi_startblock;/* starting fs block number */ 54 xfs_extlen_t xefi_blockcount;/* number of blocks in extent */ 55 struct list_head xefi_list; 56 struct xfs_owner_info xefi_oinfo; /* extent owner */ 57 bool xefi_skip_discard; 58 }; 59 60 #define XFS_BMAP_MAX_NMAP 4 61 62 /* 63 * Flags for xfs_bmapi_* 64 */ 65 #define XFS_BMAPI_ENTIRE 0x001 /* return entire extent, not trimmed */ 66 #define XFS_BMAPI_METADATA 0x002 /* mapping metadata not user data */ 67 #define XFS_BMAPI_ATTRFORK 0x004 /* use attribute fork not data */ 68 #define XFS_BMAPI_PREALLOC 0x008 /* preallocation op: unwritten space */ 69 #define XFS_BMAPI_CONTIG 0x020 /* must allocate only one extent */ 70 /* 71 * unwritten extent conversion - this needs write cache flushing and no additional 72 * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts 73 * from written to unwritten, otherwise convert from unwritten to written. 74 */ 75 #define XFS_BMAPI_CONVERT 0x040 76 77 /* 78 * allocate zeroed extents - this requires all newly allocated user data extents 79 * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set. 80 * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found 81 * during the allocation range to zeroed written extents. 82 */ 83 #define XFS_BMAPI_ZERO 0x080 84 85 /* 86 * Map the inode offset to the block given in ap->firstblock. Primarily 87 * used for reflink. The range must be in a hole, and this flag cannot be 88 * turned on with PREALLOC or CONVERT, and cannot be used on the attr fork. 89 * 90 * For bunmapi, this flag unmaps the range without adjusting quota, reducing 91 * refcount, or freeing the blocks. 92 */ 93 #define XFS_BMAPI_REMAP 0x100 94 95 /* Map something in the CoW fork. */ 96 #define XFS_BMAPI_COWFORK 0x200 97 98 /* Only convert delalloc space, don't allocate entirely new extents */ 99 #define XFS_BMAPI_DELALLOC 0x400 100 101 /* Only convert unwritten extents, don't allocate new blocks */ 102 #define XFS_BMAPI_CONVERT_ONLY 0x800 103 104 /* Skip online discard of freed extents */ 105 #define XFS_BMAPI_NODISCARD 0x1000 106 107 /* Do not update the rmap btree. Used for reconstructing bmbt from rmapbt. */ 108 #define XFS_BMAPI_NORMAP 0x2000 109 110 #define XFS_BMAPI_FLAGS \ 111 { XFS_BMAPI_ENTIRE, "ENTIRE" }, \ 112 { XFS_BMAPI_METADATA, "METADATA" }, \ 113 { XFS_BMAPI_ATTRFORK, "ATTRFORK" }, \ 114 { XFS_BMAPI_PREALLOC, "PREALLOC" }, \ 115 { XFS_BMAPI_CONTIG, "CONTIG" }, \ 116 { XFS_BMAPI_CONVERT, "CONVERT" }, \ 117 { XFS_BMAPI_ZERO, "ZERO" }, \ 118 { XFS_BMAPI_REMAP, "REMAP" }, \ 119 { XFS_BMAPI_COWFORK, "COWFORK" }, \ 120 { XFS_BMAPI_DELALLOC, "DELALLOC" }, \ 121 { XFS_BMAPI_CONVERT_ONLY, "CONVERT_ONLY" }, \ 122 { XFS_BMAPI_NODISCARD, "NODISCARD" }, \ 123 { XFS_BMAPI_NORMAP, "NORMAP" } 124 125 126 static inline int xfs_bmapi_aflag(int w) 127 { 128 return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK : 129 (w == XFS_COW_FORK ? XFS_BMAPI_COWFORK : 0)); 130 } 131 132 static 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; 139 } 140 141 /* 142 * Special values for xfs_bmbt_irec_t br_startblock field. 143 */ 144 #define DELAYSTARTBLOCK ((xfs_fsblock_t)-1LL) 145 #define HOLESTARTBLOCK ((xfs_fsblock_t)-2LL) 146 147 /* 148 * Flags for xfs_bmap_add_extent*. 149 */ 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) 159 #define BMAP_COWFORK (1 << 9) 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" }, \ 166 { BMAP_ATTRFORK, "ATTR" }, \ 167 { BMAP_COWFORK, "COW" } 168 169 170 /* 171 * Return true if the extent is a real, allocated extent, or false if it is a 172 * delayed allocation, and unwritten extent or a hole. 173 */ 174 static inline bool xfs_bmap_is_real_extent(struct xfs_bmbt_irec *irec) 175 { 176 return irec->br_state != XFS_EXT_UNWRITTEN && 177 irec->br_startblock != HOLESTARTBLOCK && 178 irec->br_startblock != DELAYSTARTBLOCK && 179 !isnullstartblock(irec->br_startblock); 180 } 181 182 void xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno, 183 xfs_filblks_t len); 184 void xfs_trim_extent_eof(struct xfs_bmbt_irec *, struct xfs_inode *); 185 int xfs_bmap_add_attrfork(struct xfs_inode *ip, int size, int rsvd); 186 void xfs_bmap_local_to_extents_empty(struct xfs_inode *ip, int whichfork); 187 void __xfs_bmap_add_free(struct xfs_trans *tp, xfs_fsblock_t bno, 188 xfs_filblks_t len, struct xfs_owner_info *oinfo, 189 bool skip_discard); 190 void xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork); 191 int xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip, 192 xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork); 193 int xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip, 194 xfs_fileoff_t *last_block, int whichfork); 195 int xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused, 196 int whichfork); 197 int xfs_bmap_one_block(struct xfs_inode *ip, int whichfork); 198 int xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno, 199 xfs_filblks_t len, struct xfs_bmbt_irec *mval, 200 int *nmap, int flags); 201 int xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip, 202 xfs_fileoff_t bno, xfs_filblks_t len, int flags, 203 xfs_extlen_t total, struct xfs_bmbt_irec *mval, int *nmap); 204 int __xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip, 205 xfs_fileoff_t bno, xfs_filblks_t *rlen, int flags, 206 xfs_extnum_t nexts); 207 int xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip, 208 xfs_fileoff_t bno, xfs_filblks_t len, int flags, 209 xfs_extnum_t nexts, int *done); 210 int xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork, 211 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got, 212 struct xfs_bmbt_irec *del); 213 void xfs_bmap_del_extent_cow(struct xfs_inode *ip, 214 struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got, 215 struct xfs_bmbt_irec *del); 216 uint xfs_default_attroffset(struct xfs_inode *ip); 217 int xfs_bmap_collapse_extents(struct xfs_trans *tp, struct xfs_inode *ip, 218 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb, 219 bool *done); 220 int xfs_bmap_can_insert_extents(struct xfs_inode *ip, xfs_fileoff_t off, 221 xfs_fileoff_t shift); 222 int xfs_bmap_insert_extents(struct xfs_trans *tp, struct xfs_inode *ip, 223 xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb, 224 bool *done, xfs_fileoff_t stop_fsb); 225 int xfs_bmap_split_extent(struct xfs_inode *ip, xfs_fileoff_t split_offset); 226 int xfs_bmapi_reserve_delalloc(struct xfs_inode *ip, int whichfork, 227 xfs_fileoff_t off, xfs_filblks_t len, xfs_filblks_t prealloc, 228 struct xfs_bmbt_irec *got, struct xfs_iext_cursor *cur, 229 int eof); 230 231 static inline void 232 xfs_bmap_add_free( 233 struct xfs_trans *tp, 234 xfs_fsblock_t bno, 235 xfs_filblks_t len, 236 struct xfs_owner_info *oinfo) 237 { 238 __xfs_bmap_add_free(tp, bno, len, oinfo, false); 239 } 240 241 enum xfs_bmap_intent_type { 242 XFS_BMAP_MAP = 1, 243 XFS_BMAP_UNMAP, 244 }; 245 246 struct xfs_bmap_intent { 247 struct list_head bi_list; 248 enum xfs_bmap_intent_type bi_type; 249 struct xfs_inode *bi_owner; 250 int bi_whichfork; 251 struct xfs_bmbt_irec bi_bmap; 252 }; 253 254 int xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_inode *ip, 255 enum xfs_bmap_intent_type type, int whichfork, 256 xfs_fileoff_t startoff, xfs_fsblock_t startblock, 257 xfs_filblks_t *blockcount, xfs_exntst_t state); 258 int xfs_bmap_map_extent(struct xfs_trans *tp, struct xfs_inode *ip, 259 struct xfs_bmbt_irec *imap); 260 int xfs_bmap_unmap_extent(struct xfs_trans *tp, struct xfs_inode *ip, 261 struct xfs_bmbt_irec *imap); 262 263 static inline int xfs_bmap_fork_to_state(int whichfork) 264 { 265 switch (whichfork) { 266 case XFS_ATTR_FORK: 267 return BMAP_ATTRFORK; 268 case XFS_COW_FORK: 269 return BMAP_COWFORK; 270 default: 271 return 0; 272 } 273 } 274 275 xfs_failaddr_t xfs_bmap_validate_extent(struct xfs_inode *ip, int whichfork, 276 struct xfs_bmbt_irec *irec); 277 278 int xfs_bmapi_remap(struct xfs_trans *tp, struct xfs_inode *ip, 279 xfs_fileoff_t bno, xfs_filblks_t len, xfs_fsblock_t startblock, 280 int flags); 281 282 #endif /* __XFS_BMAP_H__ */ 283