10b61f8a4SDave Chinner // SPDX-License-Identifier: GPL-2.0 284be0ffcSDave Chinner /* 384be0ffcSDave Chinner * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc. 484be0ffcSDave Chinner * All Rights Reserved. 584be0ffcSDave Chinner */ 684be0ffcSDave Chinner #ifndef __XFS_INODE_FORK_H__ 784be0ffcSDave Chinner #define __XFS_INODE_FORK_H__ 884be0ffcSDave Chinner 984be0ffcSDave Chinner struct xfs_inode_log_item; 1084be0ffcSDave Chinner struct xfs_dinode; 1184be0ffcSDave Chinner 1284be0ffcSDave Chinner /* 1384be0ffcSDave Chinner * File incore extent information, present for each of data & attr forks. 1484be0ffcSDave Chinner */ 153ba738dfSChristoph Hellwig struct xfs_ifork { 163f8a4f1dSDave Chinner int64_t if_bytes; /* bytes in if_u1 */ 1784be0ffcSDave Chinner struct xfs_btree_block *if_broot; /* file's incore btree root */ 183f8a4f1dSDave Chinner unsigned int if_seq; /* fork mod counter */ 196bdcf26aSChristoph Hellwig int if_height; /* height of the extent tree */ 2084be0ffcSDave Chinner union { 216bdcf26aSChristoph Hellwig void *if_root; /* extent tree root */ 2284be0ffcSDave Chinner char *if_data; /* inline file data */ 2384be0ffcSDave Chinner } if_u1; 243f8a4f1dSDave Chinner short if_broot_bytes; /* bytes allocated for root */ 25f7e67b20SChristoph Hellwig int8_t if_format; /* format of this fork */ 26daf83964SChristoph Hellwig xfs_extnum_t if_nextents; /* # of extents in this fork */ 273ba738dfSChristoph Hellwig }; 2884be0ffcSDave Chinner 2984be0ffcSDave Chinner /* 30727e1acdSChandan Babu R * Worst-case increase in the fork extent count when we're adding a single 31727e1acdSChandan Babu R * extent to a fork and there's no possibility of splitting an existing mapping. 32727e1acdSChandan Babu R */ 33727e1acdSChandan Babu R #define XFS_IEXT_ADD_NOSPLIT_CNT (1) 34727e1acdSChandan Babu R 35727e1acdSChandan Babu R /* 3685ef08b5SChandan Babu R * Punching out an extent from the middle of an existing extent can cause the 3785ef08b5SChandan Babu R * extent count to increase by 1. 3885ef08b5SChandan Babu R * i.e. | Old extent | Hole | Old extent | 3985ef08b5SChandan Babu R */ 4085ef08b5SChandan Babu R #define XFS_IEXT_PUNCH_HOLE_CNT (1) 4185ef08b5SChandan Babu R 4285ef08b5SChandan Babu R /* 43f5d92749SChandan Babu R * Directory entry addition can cause the following, 44f5d92749SChandan Babu R * 1. Data block can be added/removed. 45f5d92749SChandan Babu R * A new extent can cause extent count to increase by 1. 46f5d92749SChandan Babu R * 2. Free disk block can be added/removed. 47f5d92749SChandan Babu R * Same behaviour as described above for Data block. 48f5d92749SChandan Babu R * 3. Dabtree blocks. 49f5d92749SChandan Babu R * XFS_DA_NODE_MAXDEPTH blocks can be added. Each of these can be new 50f5d92749SChandan Babu R * extents. Hence extent count can increase by XFS_DA_NODE_MAXDEPTH. 51f5d92749SChandan Babu R */ 52f5d92749SChandan Babu R #define XFS_IEXT_DIR_MANIP_CNT(mp) \ 53f5d92749SChandan Babu R ((XFS_DA_NODE_MAXDEPTH + 1 + 1) * (mp)->m_dir_geo->fsbcount) 54f5d92749SChandan Babu R 55f5d92749SChandan Babu R /* 563a19bb14SChandan Babu R * Adding/removing an xattr can cause XFS_DA_NODE_MAXDEPTH extents to 573a19bb14SChandan Babu R * be added. One extra extent for dabtree in case a local attr is 583a19bb14SChandan Babu R * large enough to cause a double split. It can also cause extent 593a19bb14SChandan Babu R * count to increase proportional to the size of a remote xattr's 603a19bb14SChandan Babu R * value. 613a19bb14SChandan Babu R */ 623a19bb14SChandan Babu R #define XFS_IEXT_ATTR_MANIP_CNT(rmt_blks) \ 633a19bb14SChandan Babu R (XFS_DA_NODE_MAXDEPTH + max(1, rmt_blks)) 643a19bb14SChandan Babu R 653a19bb14SChandan Babu R /* 66c442f308SChandan Babu R * A write to a sub-interval of an existing unwritten extent causes the original 67c442f308SChandan Babu R * extent to be split into 3 extents 68c442f308SChandan Babu R * i.e. | Unwritten | Real | Unwritten | 69c442f308SChandan Babu R * Hence extent count can increase by 2. 70c442f308SChandan Babu R */ 71c442f308SChandan Babu R #define XFS_IEXT_WRITE_UNWRITTEN_CNT (2) 72c442f308SChandan Babu R 73c442f308SChandan Babu R 74c442f308SChandan Babu R /* 755f1d5bbfSChandan Babu R * Moving an extent to data fork can cause a sub-interval of an existing extent 765f1d5bbfSChandan Babu R * to be unmapped. This will increase extent count by 1. Mapping in the new 775f1d5bbfSChandan Babu R * extent can increase the extent count by 1 again i.e. 785f1d5bbfSChandan Babu R * | Old extent | New extent | Old extent | 795f1d5bbfSChandan Babu R * Hence number of extents increases by 2. 805f1d5bbfSChandan Babu R */ 815f1d5bbfSChandan Babu R #define XFS_IEXT_REFLINK_END_COW_CNT (2) 825f1d5bbfSChandan Babu R 835f1d5bbfSChandan Babu R /* 84bcc561f2SChandan Babu R * Removing an initial range of source/donor file's extent and adding a new 85bcc561f2SChandan Babu R * extent (from donor/source file) in its place will cause extent count to 86bcc561f2SChandan Babu R * increase by 1. 87bcc561f2SChandan Babu R */ 88bcc561f2SChandan Babu R #define XFS_IEXT_SWAP_RMAP_CNT (1) 89bcc561f2SChandan Babu R 90bcc561f2SChandan Babu R /* 9184be0ffcSDave Chinner * Fork handling. 9284be0ffcSDave Chinner */ 9384be0ffcSDave Chinner 947821ea30SChristoph Hellwig #define XFS_IFORK_Q(ip) ((ip)->i_forkoff != 0) 957821ea30SChristoph Hellwig #define XFS_IFORK_BOFF(ip) ((int)((ip)->i_forkoff << 3)) 9684be0ffcSDave Chinner 9784be0ffcSDave Chinner #define XFS_IFORK_PTR(ip,w) \ 9884be0ffcSDave Chinner ((w) == XFS_DATA_FORK ? \ 9984be0ffcSDave Chinner &(ip)->i_df : \ 1003993baebSDarrick J. Wong ((w) == XFS_ATTR_FORK ? \ 1013993baebSDarrick J. Wong (ip)->i_afp : \ 1023993baebSDarrick J. Wong (ip)->i_cowfp)) 10384be0ffcSDave Chinner #define XFS_IFORK_DSIZE(ip) \ 104e9e2eae8SChristoph Hellwig (XFS_IFORK_Q(ip) ? XFS_IFORK_BOFF(ip) : XFS_LITINO((ip)->i_mount)) 10584be0ffcSDave Chinner #define XFS_IFORK_ASIZE(ip) \ 106e9e2eae8SChristoph Hellwig (XFS_IFORK_Q(ip) ? XFS_LITINO((ip)->i_mount) - XFS_IFORK_BOFF(ip) : 0) 10784be0ffcSDave Chinner #define XFS_IFORK_SIZE(ip,w) \ 10884be0ffcSDave Chinner ((w) == XFS_DATA_FORK ? \ 10984be0ffcSDave Chinner XFS_IFORK_DSIZE(ip) : \ 1103993baebSDarrick J. Wong ((w) == XFS_ATTR_FORK ? \ 1113993baebSDarrick J. Wong XFS_IFORK_ASIZE(ip) : \ 1123993baebSDarrick J. Wong 0)) 11384be0ffcSDave Chinner #define XFS_IFORK_MAXEXT(ip, w) \ 11484be0ffcSDave Chinner (XFS_IFORK_SIZE(ip, w) / sizeof(xfs_bmbt_rec_t)) 11584be0ffcSDave Chinner 116f7e67b20SChristoph Hellwig static inline bool xfs_ifork_has_extents(struct xfs_ifork *ifp) 117f7e67b20SChristoph Hellwig { 118f7e67b20SChristoph Hellwig return ifp->if_format == XFS_DINODE_FMT_EXTENTS || 119f7e67b20SChristoph Hellwig ifp->if_format == XFS_DINODE_FMT_BTREE; 120f7e67b20SChristoph Hellwig } 1212fe4f928SDarrick J. Wong 122daf83964SChristoph Hellwig static inline xfs_extnum_t xfs_ifork_nextents(struct xfs_ifork *ifp) 123daf83964SChristoph Hellwig { 124daf83964SChristoph Hellwig if (!ifp) 125daf83964SChristoph Hellwig return 0; 126daf83964SChristoph Hellwig return ifp->if_nextents; 127daf83964SChristoph Hellwig } 128daf83964SChristoph Hellwig 129f7e67b20SChristoph Hellwig static inline int8_t xfs_ifork_format(struct xfs_ifork *ifp) 130f7e67b20SChristoph Hellwig { 131f7e67b20SChristoph Hellwig if (!ifp) 132f7e67b20SChristoph Hellwig return XFS_DINODE_FMT_EXTENTS; 133f7e67b20SChristoph Hellwig return ifp->if_format; 134f7e67b20SChristoph Hellwig } 135f7e67b20SChristoph Hellwig 136e6a688c3SDave Chinner struct xfs_ifork *xfs_ifork_alloc(enum xfs_dinode_fmt format, 137e6a688c3SDave Chinner xfs_extnum_t nextents); 1383993baebSDarrick J. Wong struct xfs_ifork *xfs_iext_state_to_fork(struct xfs_inode *ip, int state); 1393993baebSDarrick J. Wong 1409229d18eSChristoph Hellwig int xfs_iformat_data_fork(struct xfs_inode *, struct xfs_dinode *); 1419229d18eSChristoph Hellwig int xfs_iformat_attr_fork(struct xfs_inode *, struct xfs_dinode *); 14278420281SDarrick J. Wong void xfs_iflush_fork(struct xfs_inode *, struct xfs_dinode *, 14384be0ffcSDave Chinner struct xfs_inode_log_item *, int); 144ef838512SChristoph Hellwig void xfs_idestroy_fork(struct xfs_ifork *ifp); 1453f8a4f1dSDave Chinner void xfs_idata_realloc(struct xfs_inode *ip, int64_t byte_diff, 1463f8a4f1dSDave Chinner int whichfork); 14784be0ffcSDave Chinner void xfs_iroot_realloc(struct xfs_inode *, int, int); 14884be0ffcSDave Chinner int xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int); 14984be0ffcSDave Chinner int xfs_iextents_copy(struct xfs_inode *, struct xfs_bmbt_rec *, 15084be0ffcSDave Chinner int); 1513f8a4f1dSDave Chinner void xfs_init_local_fork(struct xfs_inode *ip, int whichfork, 1523f8a4f1dSDave Chinner const void *data, int64_t size); 15384be0ffcSDave Chinner 1546bdcf26aSChristoph Hellwig xfs_extnum_t xfs_iext_count(struct xfs_ifork *ifp); 155b2b1712aSChristoph Hellwig void xfs_iext_insert(struct xfs_inode *, struct xfs_iext_cursor *cur, 1560254c2f2SChristoph Hellwig struct xfs_bmbt_irec *, int); 157b2b1712aSChristoph Hellwig void xfs_iext_remove(struct xfs_inode *, struct xfs_iext_cursor *, 158c38ccf59SChristoph Hellwig int); 15984be0ffcSDave Chinner void xfs_iext_destroy(struct xfs_ifork *); 16084be0ffcSDave Chinner 16193533c78SChristoph Hellwig bool xfs_iext_lookup_extent(struct xfs_inode *ip, 16293533c78SChristoph Hellwig struct xfs_ifork *ifp, xfs_fileoff_t bno, 163b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, 164b2b1712aSChristoph Hellwig struct xfs_bmbt_irec *gotp); 165dc56015fSChristoph Hellwig bool xfs_iext_lookup_extent_before(struct xfs_inode *ip, 166dc56015fSChristoph Hellwig struct xfs_ifork *ifp, xfs_fileoff_t *end, 167b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, 168b2b1712aSChristoph Hellwig struct xfs_bmbt_irec *gotp); 169b2b1712aSChristoph Hellwig bool xfs_iext_get_extent(struct xfs_ifork *ifp, 170b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, 17193533c78SChristoph Hellwig struct xfs_bmbt_irec *gotp); 172ca5d8e5bSChristoph Hellwig void xfs_iext_update_extent(struct xfs_inode *ip, int state, 173b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, 174b2b1712aSChristoph Hellwig struct xfs_bmbt_irec *gotp); 175b2b1712aSChristoph Hellwig 1766bdcf26aSChristoph Hellwig void xfs_iext_first(struct xfs_ifork *, struct xfs_iext_cursor *); 1776bdcf26aSChristoph Hellwig void xfs_iext_last(struct xfs_ifork *, struct xfs_iext_cursor *); 1786bdcf26aSChristoph Hellwig void xfs_iext_next(struct xfs_ifork *, struct xfs_iext_cursor *); 1796bdcf26aSChristoph Hellwig void xfs_iext_prev(struct xfs_ifork *, struct xfs_iext_cursor *); 180b2b1712aSChristoph Hellwig 181b2b1712aSChristoph Hellwig static inline bool xfs_iext_next_extent(struct xfs_ifork *ifp, 182b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp) 183b2b1712aSChristoph Hellwig { 184b2b1712aSChristoph Hellwig xfs_iext_next(ifp, cur); 185b2b1712aSChristoph Hellwig return xfs_iext_get_extent(ifp, cur, gotp); 186b2b1712aSChristoph Hellwig } 187b2b1712aSChristoph Hellwig 188b2b1712aSChristoph Hellwig static inline bool xfs_iext_prev_extent(struct xfs_ifork *ifp, 189b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp) 190b2b1712aSChristoph Hellwig { 191b2b1712aSChristoph Hellwig xfs_iext_prev(ifp, cur); 192b2b1712aSChristoph Hellwig return xfs_iext_get_extent(ifp, cur, gotp); 193b2b1712aSChristoph Hellwig } 194b2b1712aSChristoph Hellwig 195b2b1712aSChristoph Hellwig /* 196b2b1712aSChristoph Hellwig * Return the extent after cur in gotp without updating the cursor. 197b2b1712aSChristoph Hellwig */ 198b2b1712aSChristoph Hellwig static inline bool xfs_iext_peek_next_extent(struct xfs_ifork *ifp, 199b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp) 200b2b1712aSChristoph Hellwig { 201b2b1712aSChristoph Hellwig struct xfs_iext_cursor ncur = *cur; 202b2b1712aSChristoph Hellwig 203b2b1712aSChristoph Hellwig xfs_iext_next(ifp, &ncur); 204b2b1712aSChristoph Hellwig return xfs_iext_get_extent(ifp, &ncur, gotp); 205b2b1712aSChristoph Hellwig } 206b2b1712aSChristoph Hellwig 207b2b1712aSChristoph Hellwig /* 208b2b1712aSChristoph Hellwig * Return the extent before cur in gotp without updating the cursor. 209b2b1712aSChristoph Hellwig */ 210b2b1712aSChristoph Hellwig static inline bool xfs_iext_peek_prev_extent(struct xfs_ifork *ifp, 211b2b1712aSChristoph Hellwig struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *gotp) 212b2b1712aSChristoph Hellwig { 213b2b1712aSChristoph Hellwig struct xfs_iext_cursor ncur = *cur; 214b2b1712aSChristoph Hellwig 215b2b1712aSChristoph Hellwig xfs_iext_prev(ifp, &ncur); 216b2b1712aSChristoph Hellwig return xfs_iext_get_extent(ifp, &ncur, gotp); 217b2b1712aSChristoph Hellwig } 218b2b1712aSChristoph Hellwig 219b2b1712aSChristoph Hellwig #define for_each_xfs_iext(ifp, ext, got) \ 220b2b1712aSChristoph Hellwig for (xfs_iext_first((ifp), (ext)); \ 221b2b1712aSChristoph Hellwig xfs_iext_get_extent((ifp), (ext), (got)); \ 222b2b1712aSChristoph Hellwig xfs_iext_next((ifp), (ext))) 22393533c78SChristoph Hellwig 224*182696fbSDarrick J. Wong extern struct kmem_cache *xfs_ifork_cache; 22584be0ffcSDave Chinner 2263993baebSDarrick J. Wong extern void xfs_ifork_init_cow(struct xfs_inode *ip); 2273993baebSDarrick J. Wong 2287c7ba218SChristoph Hellwig int xfs_ifork_verify_local_data(struct xfs_inode *ip); 2297c7ba218SChristoph Hellwig int xfs_ifork_verify_local_attr(struct xfs_inode *ip); 230b9b7e1dcSChandan Babu R int xfs_iext_count_may_overflow(struct xfs_inode *ip, int whichfork, 231b9b7e1dcSChandan Babu R int nr_to_add); 2329cfb9b47SDarrick J. Wong 233b2197a36SChristoph Hellwig /* returns true if the fork has extents but they are not read in yet. */ 234b2197a36SChristoph Hellwig static inline bool xfs_need_iread_extents(struct xfs_ifork *ifp) 235b2197a36SChristoph Hellwig { 236b2197a36SChristoph Hellwig return ifp->if_format == XFS_DINODE_FMT_BTREE && ifp->if_height == 0; 237b2197a36SChristoph Hellwig } 238b2197a36SChristoph Hellwig 23984be0ffcSDave Chinner #endif /* __XFS_INODE_FORK_H__ */ 240