Fix dangling smgr_owner pointer when a fake relcache entry is freed.

hlinnaka · hlinnaka · commit 0f714c602cd2 · 2014-03-07T13:37:45.000+02:00
A fake relcache entry can "own" a SmgrRelation object, like a regular
relcache entry. But when it was free'd, the owner field in SmgrRelation
was not cleared, so it was left pointing to free'd memory.

Amazingly this apparently hasn't caused crashes in practice, or we would've
heard about it earlier. Andres found this with Valgrind.

Report and fix by Andres Freund, with minor modifications by me. Backpatch
to all supported versions.
diff --git a/src/backend/access/transam/xlogutils.c b/src/backend/access/transam/xlogutils.c
@@ -414,6 +414,9 @@ CreateFakeRelcacheEntry(RelFileNode rnode)
 void
 FreeFakeRelcacheEntry(Relation fakerel)
 {
+	/* make sure the fakerel is not referenced by the SmgrRelation anymore */
+	if (fakerel->rd_smgr != NULL)
+		smgrclearowner(&fakerel->rd_smgr, fakerel->rd_smgr);
 	pfree(fakerel);
 }
 
diff --git a/src/backend/storage/smgr/smgr.c b/src/backend/storage/smgr/smgr.c
@@ -197,6 +197,24 @@ smgrsetowner(SMgrRelation *owner, SMgrRelation reln)
 	*owner = reln;
 }
 
+/*
+ * smgrclearowner() -- Remove long-lived reference to an SMgrRelation object
+ *					   if one exists
+ */
+void
+smgrclearowner(SMgrRelation *owner, SMgrRelation reln)
+{
+	/* Do nothing if the SMgrRelation object is not owned by the owner */
+	if (reln->smgr_owner != owner)
+		return;
+
+	/* unset the owner's reference */
+	*owner = NULL;
+
+	/* unset our reference to the owner */
+	reln->smgr_owner = NULL;
+}
+
 /*
  *	smgrexists() -- Does the underlying file for a fork exist?
  */
diff --git a/src/include/storage/smgr.h b/src/include/storage/smgr.h
@@ -73,6 +73,7 @@ extern void smgrinit(void);
 extern SMgrRelation smgropen(RelFileNode rnode);
 extern bool smgrexists(SMgrRelation reln, ForkNumber forknum);
 extern void smgrsetowner(SMgrRelation *owner, SMgrRelation reln);
+extern void smgrclearowner(SMgrRelation *owner, SMgrRelation reln);
 extern void smgrclose(SMgrRelation reln);
 extern void smgrcloseall(void);
 extern void smgrclosenode(RelFileNode rnode);

Original file line number	Diff line number	Diff line change
`@@ -414,6 +414,9 @@ CreateFakeRelcacheEntry(RelFileNode rnode)`
`414`	`414`	`void`
`415`	`415`	`FreeFakeRelcacheEntry(Relation fakerel)`
`416`	`416`	`{`
	`417`	`+ /* make sure the fakerel is not referenced by the SmgrRelation anymore */`
	`418`	`+ if (fakerel->rd_smgr != NULL)`
	`419`	`+ smgrclearowner(&fakerel->rd_smgr, fakerel->rd_smgr);`
`417`	`420`	`pfree(fakerel);`
`418`	`421`	`}`
`419`	`422`