xfs: fix perag iteration raciness
v3 cover xfs: fix perag iteration raciness
v3:
- Code style, Fixes: and RvB: tags.
v2: https://lore.kernel.org/linux-xfs/[email protected]/
- Factoring and patch granularity.
v1: https://lore.kernel.org/linux-xfs/[email protected]/
Brian Foster (4):
xfs: fold perag loop iteration logic into helper function
xfs: rename the next_agno perag iteration variable
xfs: terminate perag iteration reliably on agcount
xfs: fix perag reference leak on iteration race with growfs
fs/xfs/libxfs/xfs_ag.h | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-)
Signature · 1 line
2.31.1
PATCH v3 1/4 xfs: fold perag loop iteration logic into helper function
Fold the loop iteration logic into a helper in preparation for further fixups. No functional change in this patch.
--- fs/xfs/libxfs/xfs_ag.h | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-)
fs/xfs/libxfs/xfs_ag.h +13 -3
@@ -124,12 +124,22 @@ void xfs_perag_put(struct xfs_perag *pag);* for_each_perag_from() because they terminate at sb_agcount where there are * no perag structures in tree beyond end_agno. */ +static inline struct xfs_perag * +xfs_perag_next ( +struct xfs_perag *pag, +xfs_agnumber_t *next_agno) +{ +struct xfs_mount *mp = pag->pag_mount; + + *next_agno = pag->pag_agno +1 ; +xfs_perag_put (pag); +return xfs_perag_get (mp, *next_agno); +} +#define for_each_perag_range (mp, next_agno, end_agno, pag) \ for ((pag) = xfs_perag_get((mp), (next_agno)); \ (pag) != NULL && (next_agno) <= (end_agno); \ - (next_agno) = (pag)->pag_agno + 1, \ - xfs_perag_put(pag), \ - (pag) = xfs_perag_get((mp), (next_agno))) + (pag) = xfs_perag_next((pag), &(next_agno)))#define for_each_perag_from (mp, next_agno, pag) \ for_each_perag_range((mp), (next_agno), (mp)->m_sb.sb_agcount, (pag))
Signature · 1 line
2.31.1
PATCH v3 2/4 xfs: rename the next_agno perag iteration variable
In reply to Brian FosterRename the next_agno variable to be consistent across the several iteration macros and shorten line length.
--- fs/xfs/libxfs/xfs_ag.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)
fs/xfs/libxfs/xfs_ag.h +9 -9
@@ -127,22 +127,22 @@ void xfs_perag_put(struct xfs_perag *pag);static inline struct xfs_perag *xfs_perag_next (struct xfs_perag *pag, -xfs_agnumber_t *next_agno) +xfs_agnumber_t *agno) {struct xfs_mount *mp = pag->pag_mount; - *next_agno = pag->pag_agno +1 ; + *agno = pag->pag_agno +1 ;xfs_perag_put (pag); -return xfs_perag_get (mp, *next_agno); +return xfs_perag_get (mp, *agno); } -#define for_each_perag_range (mp, next_agno, end_agno, pag) \ - for ((pag) = xfs_perag_get((mp), (next_agno)); \ - (pag) != NULL && (next_agno) <= (end_agno); \ - (pag) = xfs_perag_next((pag), &(next_agno))) +#define for_each_perag_range (mp, agno, end_agno, pag) \ + for ((pag) = xfs_perag_get((mp), (agno)); \ + (pag) != NULL && (agno) <= (end_agno); \ + (pag) = xfs_perag_next((pag), &(agno))) -#define for_each_perag_from (mp, next_agno, pag) \ - for_each_perag_range((mp), (next_agno), (mp)->m_sb.sb_agcount, (pag)) +#define for_each_perag_from (mp, agno, pag) \ + for_each_perag_range((mp), (agno), (mp)->m_sb.sb_agcount, (pag))#define for_each_perag (mp, agno, pag) \
Signature · 1 line
2.31.1
PATCH v3 3/4 xfs: terminate perag iteration reliably on agcount
In reply to Brian FosterThe for_each_perag_from() iteration macro relies on sb_agcount to process every perag currently within EOFS from a given starting point. It's perfectly valid to have perag structures beyond sb_agcount, however, such as if a growfs is in progress. If a perag loop happens to race with growfs in this manner, it will actually attempt to process the post-EOFS perag where ->pag_agno == sb_agcount. This is reproduced by xfs/104 and manifests as the following assert failure in superblock write verifier context:
XFS: Assertion failed: agno < mp->m_sb.sb_agcount, file: fs/xfs/libxfs/xfs_types.c, line: 22
Update the corresponding macro to only process perags that are within the current sb_agcount.
--- fs/xfs/libxfs/xfs_ag.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
fs/xfs/libxfs/xfs_ag.h +1 -1
@@ -142,7 +142,7 @@ xfs_perag_next( (pag) = xfs_perag_next((pag), &(agno)))#define for_each_perag_from (mp, agno, pag) \ - for_each_perag_range((mp), (agno), (mp)->m_sb.sb_agcount, (pag)) + for_each_perag_range((mp), (agno), (mp)->m_sb.sb_agcount - 1, (pag))#define for_each_perag (mp, agno, pag) \
Signature · 1 line
2.31.1
PATCH v3 4/4 xfs: fix perag reference leak on iteration race with growfs
In reply to Brian FosterThe for_each_perag*() set of macros are hacky in that some (i.e. those based on sb_agcount) rely on the assumption that perag iteration terminates naturally with a NULL perag at the specified end_agno. Others allow for the final AG to have a valid perag and require the calling function to clean up any potential leftover xfs_perag reference on termination of the loop.
Aside from providing a subtly inconsistent interface, the former variant is racy with growfs because growfs can create discoverable post-eofs perags before the final superblock update that completes the grow operation and increases sb_agcount. This leads to the following assert failure (reproduced by xfs/104) in the perag free path during unmount:
XFS: Assertion failed: atomic_read(&pag->pag_ref) == 0, file: fs/xfs/libxfs/xfs_ag.c, line: 195
This occurs because one of the many for_each_perag() loops in the code that is expected to terminate with a NULL pag (and thus has no post-loop xfs_perag_put() check) raced with a growfs and found a non-NULL post-EOFS perag, but terminated naturally based on the end_agno check without releasing the post-EOFS perag.
Rework the iteration logic to lift the agno check from the main for loop conditional to the iteration helper function. The for loop now purely terminates on a NULL pag and xfs_perag_next() avoids taking a reference to any perag beyond end_agno in the first place.
--- fs/xfs/libxfs/xfs_ag.h | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-)
fs/xfs/libxfs/xfs_ag.h +6 -10
@@ -116,30 +116,26 @@ void xfs_perag_put(struct xfs_perag *pag);/* * Perag iteration APIs -* -* XXX: for_each_perag_range() usage really needs an iterator to clean up when -* we terminate at end_agno because we may have taken a reference to the perag -* beyond end_agno. Right now callers have to be careful to catch and clean that -* up themselves. This is not necessary for the callers of for_each_perag() and -* for_each_perag_from() because they terminate at sb_agcount where there are -* no perag structures in tree beyond end_agno. */ static inline struct xfs_perag *xfs_perag_next (struct xfs_perag *pag, -xfs_agnumber_t *agno) +xfs_agnumber_t *agno, +xfs_agnumber_t end_agno) {struct xfs_mount *mp = pag->pag_mount; *agno = pag->pag_agno +1 ;xfs_perag_put (pag); +if (*agno > end_agno) +return NULL ;return xfs_perag_get (mp, *agno); }#define for_each_perag_range (mp, agno, end_agno, pag) \ for ((pag) = xfs_perag_get((mp), (agno)); \ - (pag) != NULL && (agno) <= (end_agno); \ - (pag) = xfs_perag_next((pag), &(agno))) + (pag) != NULL; \ + (pag) = xfs_perag_next((pag), &(agno), (end_agno)))#define for_each_perag_from (mp, agno, pag) \ for_each_perag_range((mp), (agno), (mp)->m_sb.sb_agcount - 1, (pag))
Signature · 1 line
2.31.1
Darrick J. Wong
AppliedQuoted 5 lines · Brian Foster
v3:
- Code style, Fixes: and RvB: tags.
v2: https://lore.kernel.org/linux-xfs/[email protected]/
- Factoring and patch granularity.
v1: https://lore.kernel.org/linux-xfs/[email protected]/
Applied, thanks!
--D
Quoted 13 lines
Brian Foster (4):
xfs: fold perag loop iteration logic into helper function
xfs: rename thenext_agnoperag iteration variable
xfs: terminate perag iteration reliably on agcount
xfs: fix perag reference leak on iteration race with growfsfs/xfs/libxfs/xfs_ag.h | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-)Signature · 1 line
2.31.1