Change some bogus PageGetLSN calls to BufferGetLSNAtomic

alvherre · alvherre · commit 38a23790e13c · 2018-01-09T17:07:36.000-03:00
As src/backend/access/transam/README says, PageGetLSN may only be called by processes holding either exclusive lock on buffer, or a shared lock on buffer plus buffer header lock. Therefore any place that only holds a shared buffer lock must use BufferGetLSNAtomic instead of PageGetLSN, which internally obtains buffer header lock prior to reading the LSN. A few callsites failed to comply with this rule. This was detected by running all tests under a new (not committed) assertion that verifies PageGetLSN locking contract. All but one of the callsites that failed the assertion are fixed by this patch. Remaining callsites were inspected manually and determined not to need any change. The exception (unfixed callsite) is in TestForOldSnapshot, which only has a Page argument, making it impossible to access the corresponding Buffer from it. Fixing that seems a much larger patch that will have to be done separately; and that's just as well, since it was only introduced in 9.6 and other bugs are much older. Some of these bugs are ancient; backpatch all the way back to 9.3. Authors: Jacob Champion, Asim Praveen, Ashwin Agrawal Reviewed-by: Michaël Paquier Discussion: https://postgr.es/m/CABAq_6GXgQDVu3u12mK9O5Xt5abBZWQ0V40LZCE+oUf95XyNFg@mail.gmail.com
diff --git a/src/backend/access/gist/gist.c b/src/backend/access/gist/gist.c
@@ -566,7 +566,8 @@ gistdoinsert(Relation r, IndexTuple itup, Size freespace, GISTSTATE *giststate)
 		}
 
 		stack->page = (Page) BufferGetPage(stack->buffer);
-		stack->lsn = PageGetLSN(stack->page);
+		stack->lsn = xlocked ?
+			PageGetLSN(stack->page) : BufferGetLSNAtomic(stack->buffer);
 		Assert(!RelationNeedsWAL(state.r) || !XLogRecPtrIsInvalid(stack->lsn));
 
 		/*
@@ -816,7 +817,7 @@ gistFindPath(Relation r, BlockNumber child, OffsetNumber *downlinkoffnum)
 			break;
 		}
 
-		top->lsn = PageGetLSN(page);
+		top->lsn = BufferGetLSNAtomic(buffer);
 
 		/*
 		 * If F_FOLLOW_RIGHT is set, the page to the right doesn't have a
diff --git a/src/backend/access/gist/gistvacuum.c b/src/backend/access/gist/gistvacuum.c
@@ -257,7 +257,7 @@ gistbulkdelete(PG_FUNCTION_ARGS)
 
 				ptr = (GistBDItem *) palloc(sizeof(GistBDItem));
 				ptr->blkno = ItemPointerGetBlockNumber(&(idxtuple->t_tid));
-				ptr->parentlsn = PageGetLSN(page);
+				ptr->parentlsn = BufferGetLSNAtomic(buffer);
 				ptr->next = stack->next;
 				stack->next = ptr;
 
diff --git a/src/backend/access/nbtree/nbtsearch.c b/src/backend/access/nbtree/nbtsearch.c
@@ -1157,7 +1157,7 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum)
 	 * safe to apply LP_DEAD hints to the page later.  This allows us to drop
 	 * the pin for MVCC scans, which allows vacuum to avoid blocking.
 	 */
-	so->currPos.lsn = PageGetLSN(page);
+	so->currPos.lsn = BufferGetLSNAtomic(so->currPos.buf);
 
 	/*
 	 * we must save the page's right-link while scanning it; this tells us
diff --git a/src/backend/access/nbtree/nbtutils.c b/src/backend/access/nbtree/nbtutils.c
@@ -1770,7 +1770,7 @@ _bt_killitems(IndexScanDesc scan)
 			return;
 
 		page = BufferGetPage(buf);
-		if (PageGetLSN(page) == so->currPos.lsn)
+		if (BufferGetLSNAtomic(buf) == so->currPos.lsn)
 			so->currPos.buf = buf;
 		else
 		{

Original file line number	Diff line number	Diff line change
`@@ -566,7 +566,8 @@ gistdoinsert(Relation r, IndexTuple itup, Size freespace, GISTSTATE *giststate)`
`566`	`566`	`}`
`567`	`567`
`568`	`568`	`stack->page = (Page) BufferGetPage(stack->buffer);`
`569`		`- stack->lsn = PageGetLSN(stack->page);`
	`569`	`+ stack->lsn = xlocked ?`
	`570`	`+ PageGetLSN(stack->page) : BufferGetLSNAtomic(stack->buffer);`
`570`	`571`	`Assert(!RelationNeedsWAL(state.r) \|\| !XLogRecPtrIsInvalid(stack->lsn));`
`571`	`572`
`572`	`573`	`/*`
`@@ -816,7 +817,7 @@ gistFindPath(Relation r, BlockNumber child, OffsetNumber *downlinkoffnum)`
`816`	`817`	`break;`
`817`	`818`	`}`
`818`	`819`
`819`		`- top->lsn = PageGetLSN(page);`
	`820`	`+ top->lsn = BufferGetLSNAtomic(buffer);`
`820`	`821`
`821`	`822`	`/*`
`822`	`823`	`* If F_FOLLOW_RIGHT is set, the page to the right doesn't have a`
Original file line number	Diff line number	Diff line change
`@@ -1770,7 +1770,7 @@ _bt_killitems(IndexScanDesc scan)`
`1770`	`1770`	`return;`
`1771`	`1771`
`1772`	`1772`	`page = BufferGetPage(buf);`
`1773`		`- if (PageGetLSN(page) == so->currPos.lsn)`
	`1773`	`+ if (BufferGetLSNAtomic(buf) == so->currPos.lsn)`
`1774`	`1774`	`so->currPos.buf = buf;`
`1775`	`1775`	`else`
`1776`	`1776`	`{`