Restore smgrtruncate() prototype in back-branches.

macdice · macdice · commit a1d17a894731 · 2025-01-08T10:48:57.000+13:00
It's possible that external code is calling smgrtruncate(). Any external callers might like to consider the recent changes to RelationTruncate(), but commit 38c579b should not have changed the function prototype in the back-branches, per ABI stability policy. Restore smgrtruncate()'s traditional argument list in the back-branches, but make it a wrapper for a new function smgrtruncate2(). The three callers in core can use smgrtruncate2() directly. In master (18-to-be), smgrtruncate2() is effectively renamed to smgrtruncate(), so this wart is cleaned up. Reviewed-by: Michael Paquier <michael@paquier.xyz> Discussion: https://postgr.es/m/CA%2BhUKG%2BThae6x6%2BjmQiuALQBT2Ae1ChjMh1%3DkMvJ8y_SBJZrvA%40mail.gmail.com
diff --git a/contrib/pg_visibility/pg_visibility.c b/contrib/pg_visibility/pg_visibility.c
@@ -429,7 +429,7 @@ pg_truncate_visibility_map(PG_FUNCTION_ARGS)
 	}
 
 	if (BlockNumberIsValid(block))
-		smgrtruncate(RelationGetSmgr(rel), &fork, 1, &old_block, &block);
+		smgrtruncate2(RelationGetSmgr(rel), &fork, 1, &old_block, &block);
 
 	END_CRIT_SECTION();
 	MyProc->delayChkpt = false;
diff --git a/src/backend/catalog/storage.c b/src/backend/catalog/storage.c
@@ -409,7 +409,7 @@ RelationTruncate(Relation rel, BlockNumber nblocks)
 	 * longer exist after truncation is complete, and then truncate the
 	 * corresponding files on disk.
 	 */
-	smgrtruncate(RelationGetSmgr(rel), forks, nforks, old_blocks, blocks);
+	smgrtruncate2(RelationGetSmgr(rel), forks, nforks, old_blocks, blocks);
 
 	END_CRIT_SECTION();
 
@@ -1070,7 +1070,7 @@ smgr_redo(XLogReaderState *record)
 		if (nforks > 0)
 		{
 			START_CRIT_SECTION();
-			smgrtruncate(reln, forks, nforks, old_blocks, blocks);
+			smgrtruncate2(reln, forks, nforks, old_blocks, blocks);
 			END_CRIT_SECTION();
 		}
 
diff --git a/src/backend/storage/smgr/smgr.c b/src/backend/storage/smgr/smgr.c
@@ -544,6 +544,26 @@ smgrnblocks(SMgrRelation reln, ForkNumber forknum)
  *	smgrtruncate() -- Truncate the given forks of supplied relation to
  *					  each specified numbers of blocks
  *
+ * Backward-compatible version of smgrtruncate2() for the benefit of external
+ * callers.  This version isn't used in PostgreSQL core code, and can't be
+ * used in a critical section.
+ */
+void
+smgrtruncate(SMgrRelation reln, ForkNumber *forknum, int nforks,
+			 BlockNumber *nblocks)
+{
+	BlockNumber old_nblocks[MAX_FORKNUM + 1];
+
+	for (int i = 0; i < nforks; ++i)
+		old_nblocks[i] = smgrnblocks(reln, forknum[i]);
+
+	return smgrtruncate2(reln, forknum, nforks, old_nblocks, nblocks);
+}
+
+/*
+ * smgrtruncate2() -- Truncate the given forks of supplied relation to
+ *					  each specified numbers of blocks
+ *
  * The truncation is done immediately, so this can't be rolled back.
  *
  * The caller must hold AccessExclusiveLock on the relation, to ensure that
@@ -555,8 +575,8 @@ smgrnblocks(SMgrRelation reln, ForkNumber forknum)
  * to this relation should be called in between.
  */
 void
-smgrtruncate(SMgrRelation reln, ForkNumber *forknum, int nforks,
-			 BlockNumber *old_nblocks, BlockNumber *nblocks)
+smgrtruncate2(SMgrRelation reln, ForkNumber *forknum, int nforks,
+			  BlockNumber *old_nblocks, BlockNumber *nblocks)
 {
 	int			i;
 
diff --git a/src/include/storage/smgr.h b/src/include/storage/smgr.h
@@ -102,8 +102,10 @@ extern void smgrwriteback(SMgrRelation reln, ForkNumber forknum,
 						  BlockNumber blocknum, BlockNumber nblocks);
 extern BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum);
 extern void smgrtruncate(SMgrRelation reln, ForkNumber *forknum, int nforks,
-						 BlockNumber *old_nblocks,
 						 BlockNumber *nblocks);
+extern void smgrtruncate2(SMgrRelation reln, ForkNumber *forknum, int nforks,
+						  BlockNumber *old_nblocks,
+						  BlockNumber *nblocks);
 extern void smgrimmedsync(SMgrRelation reln, ForkNumber forknum);
 extern void AtEOXact_SMgr(void);
 

Original file line number	Diff line number	Diff line change
`@@ -429,7 +429,7 @@ pg_truncate_visibility_map(PG_FUNCTION_ARGS)`
`429`	`429`	`}`
`430`	`430`
`431`	`431`	`if (BlockNumberIsValid(block))`
`432`		`- smgrtruncate(RelationGetSmgr(rel), &fork, 1, &old_block, &block);`
	`432`	`+ smgrtruncate2(RelationGetSmgr(rel), &fork, 1, &old_block, &block);`
`433`	`433`
`434`	`434`	`END_CRIT_SECTION();`
`435`	`435`	`MyProc->delayChkpt = false;`
Original file line number	Diff line number	Diff line change
`@@ -409,7 +409,7 @@ RelationTruncate(Relation rel, BlockNumber nblocks)`
`409`	`409`	`* longer exist after truncation is complete, and then truncate the`
`410`	`410`	`* corresponding files on disk.`
`411`	`411`	`*/`
`412`		`- smgrtruncate(RelationGetSmgr(rel), forks, nforks, old_blocks, blocks);`
	`412`	`+ smgrtruncate2(RelationGetSmgr(rel), forks, nforks, old_blocks, blocks);`
`413`	`413`
`414`	`414`	`END_CRIT_SECTION();`
`415`	`415`
`@@ -1070,7 +1070,7 @@ smgr_redo(XLogReaderState *record)`
`1070`	`1070`	`if (nforks > 0)`
`1071`	`1071`	`{`
`1072`	`1072`	`START_CRIT_SECTION();`
`1073`		`- smgrtruncate(reln, forks, nforks, old_blocks, blocks);`
	`1073`	`+ smgrtruncate2(reln, forks, nforks, old_blocks, blocks);`
`1074`	`1074`	`END_CRIT_SECTION();`
`1075`	`1075`	`}`
`1076`	`1076`