]> git.ipfire.org Git - thirdparty/postgresql.git/commitdiff
Assert lack of hazardous buffer locks before possible catalog read.
authorNoah Misch <noah@leadboat.com>
Wed, 17 Dec 2025 00:13:54 +0000 (16:13 -0800)
committerNoah Misch <noah@leadboat.com>
Wed, 17 Dec 2025 00:13:55 +0000 (16:13 -0800)
Commit 0bada39c83a150079567a6e97b1a25a198f30ea3 fixed a bug of this kind,
which existed in all branches for six days before detection.  While the
probability of reaching the trouble was low, the disruption was extreme.  No
new backends could start, and service restoration needed an immediate
shutdown.  Hence, add this to catch the next bug like it.

The new check in RelationIdGetRelation() suffices to make autovacuum detect
the bug in commit 243e9b40f1b2dd09d6e5bf91ebf6e822a2cd3704 that led to commit
0bada39.  This also checks in a number of similar places.  It replaces each
Assert(IsTransactionState()) that pertained to a conditional catalog read.

Back-patch to v14 - v17.  This a back-patch of commit
f4ece891fc2f3f96f0571720a1ae30db8030681b (from before v18 branched) to
all supported branches, to accompany the back-patch of commits 243e9b4
and 0bada39.  For catalog indexes, the bttextcmp() behavior that
motivated IsCatalogTextUniqueIndexOid() was v18-specific.  Hence, this
back-patch doesn't need that or its correction from commit
4a4ee0c2c1e53401924101945ac3d517c0a8a559.

Reported-by: Alexander Lakhin <exclusion@gmail.com>
Discussion: https://postgr.es/m/20250410191830.0e.nmisch@google.com
Discussion: https://postgr.es/m/10ec0bc3-5933-1189-6bb8-5dec4114558e@gmail.com
Backpatch-through: 14-17

src/backend/storage/buffer/bufmgr.c
src/backend/storage/lmgr/lwlock.c
src/backend/utils/adt/pg_locale.c
src/backend/utils/cache/catcache.c
src/backend/utils/cache/inval.c
src/backend/utils/cache/relcache.c
src/backend/utils/mb/mbutils.c
src/include/storage/bufmgr.h
src/include/storage/lwlock.h
src/include/utils/relcache.h

index e007bd46e93a0281279ae4eb46d2a01878e1205e..ef14791e2daea6fa3e05107029f08bd5c84073cb 100644 (file)
@@ -37,6 +37,9 @@
 #include "access/xloginsert.h"
 #include "access/xlogutils.h"
 #include "catalog/catalog.h"
+#ifdef USE_ASSERT_CHECKING
+#include "catalog/pg_tablespace_d.h"
+#endif
 #include "catalog/storage.h"
 #include "catalog/storage_xlog.h"
 #include "executor/instrument.h"
@@ -498,6 +501,10 @@ static void RelationCopyStorageUsingBuffer(RelFileLocator srclocator,
                                                                                   ForkNumber forkNum, bool permanent);
 static void AtProcExit_Buffers(int code, Datum arg);
 static void CheckForBufferLeaks(void);
+#ifdef USE_ASSERT_CHECKING
+static void AssertNotCatalogBufferLock(LWLock *lock, LWLockMode mode,
+                                                                          void *unused_context);
+#endif
 static int     rlocator_comparator(const void *p1, const void *p2);
 static inline int buffertag_comparator(const BufferTag *ba, const BufferTag *bb);
 static inline int ckpt_buforder_comparator(const CkptSortItem *a, const CkptSortItem *b);
@@ -3225,6 +3232,66 @@ CheckForBufferLeaks(void)
 #endif
 }
 
+#ifdef USE_ASSERT_CHECKING
+/*
+ * Check for exclusive-locked catalog buffers.  This is the core of
+ * AssertCouldGetRelation().
+ *
+ * A backend would self-deadlock on LWLocks if the catalog scan read the
+ * exclusive-locked buffer.  The main threat is exclusive-locked buffers of
+ * catalogs used in relcache, because a catcache search on any catalog may
+ * build that catalog's relcache entry.  We don't have an inventory of
+ * catalogs relcache uses, so just check buffers of most catalogs.
+ *
+ * It's better to minimize waits while holding an exclusive buffer lock, so it
+ * would be nice to broaden this check not to be catalog-specific.  However,
+ * bttextcmp() accesses pg_collation, and non-core opclasses might similarly
+ * read tables.  That is deadlock-free as long as there's no loop in the
+ * dependency graph: modifying table A may cause an opclass to read table B,
+ * but it must not cause a read of table A.
+ */
+void
+AssertBufferLocksPermitCatalogRead(void)
+{
+       ForEachLWLockHeldByMe(AssertNotCatalogBufferLock, NULL);
+}
+
+static void
+AssertNotCatalogBufferLock(LWLock *lock, LWLockMode mode,
+                                                  void *unused_context)
+{
+       BufferDesc *bufHdr;
+       BufferTag       tag;
+       Oid                     relid;
+
+       if (mode != LW_EXCLUSIVE)
+               return;
+
+       if (!((BufferDescPadded *) lock > BufferDescriptors &&
+                 (BufferDescPadded *) lock < BufferDescriptors + NBuffers))
+               return;                                 /* not a buffer lock */
+
+       bufHdr = (BufferDesc *)
+               ((char *) lock - offsetof(BufferDesc, content_lock));
+       tag = bufHdr->tag;
+
+       /*
+        * This relNumber==relid assumption holds until a catalog experiences
+        * VACUUM FULL or similar.  After a command like that, relNumber will be
+        * in the normal (non-catalog) range, and we lose the ability to detect
+        * hazardous access to that catalog.  Calling RelidByRelfilenumber() would
+        * close that gap, but RelidByRelfilenumber() might then deadlock with a
+        * held lock.
+        */
+       relid = tag.relNumber;
+
+       Assert(!IsCatalogRelationOid(relid));
+       /* Shared rels are always catalogs: detect even after VACUUM FULL. */
+       Assert(tag.spcOid != GLOBALTABLESPACE_OID);
+}
+#endif
+
+
 /*
  * Helper routine to issue warnings when a buffer is unexpectedly pinned
  */
index 15c2f8a2ca99cbd3bf501020f0567da0c94daa30..3fae2a157abfa34efd14781cf4e8efddc000b7f1 100644 (file)
@@ -1910,6 +1910,21 @@ LWLockReleaseAll(void)
 }
 
 
+/*
+ * ForEachLWLockHeldByMe - run a callback for each held lock
+ *
+ * This is meant as debug support only.
+ */
+void
+ForEachLWLockHeldByMe(void (*callback) (LWLock *, LWLockMode, void *),
+                                         void *context)
+{
+       int                     i;
+
+       for (i = 0; i < num_held_lwlocks; i++)
+               callback(held_lwlocks[i].lock, held_lwlocks[i].mode, context);
+}
+
 /*
  * LWLockHeldByMe - test whether my process holds a lock in any mode
  *
index 111a7888779d34a12982517500445d9ae1538ef5..df0c84cf37181b5697fdc9cdd404e5b493ffff63 100644 (file)
@@ -67,6 +67,7 @@
 #include "utils/lsyscache.h"
 #include "utils/memutils.h"
 #include "utils/pg_locale.h"
+#include "utils/relcache.h"
 #include "utils/syscache.h"
 
 #ifdef USE_ICU
@@ -1222,6 +1223,8 @@ lookup_collation_cache(Oid collation, bool set_flags)
        Assert(OidIsValid(collation));
        Assert(collation != DEFAULT_COLLATION_OID);
 
+       AssertCouldGetRelation();
+
        if (collation_cache == NULL)
        {
                /* First time through, initialize the hash table */
index 6550f966df7e9c8a3031de5cf1a71fabc838f526..5690a36755c4525984a41150d09e5af191c97fd3 100644 (file)
@@ -999,12 +999,41 @@ RehashCatCacheLists(CatCache *cp)
        cp->cc_lbucket = newbucket;
 }
 
+/*
+ *             ConditionalCatalogCacheInitializeCache
+ *
+ * Call CatalogCacheInitializeCache() if not yet done.
+ */
+pg_attribute_always_inline
+static void
+ConditionalCatalogCacheInitializeCache(CatCache *cache)
+{
+#ifdef USE_ASSERT_CHECKING
+       /*
+        * TypeCacheRelCallback() runs outside transactions and relies on TYPEOID
+        * for hashing.  This isn't ideal.  Since lookup_type_cache() both
+        * registers the callback and searches TYPEOID, reaching trouble likely
+        * requires OOM at an unlucky moment.
+        *
+        * InvalidateAttoptCacheCallback() runs outside transactions and likewise
+        * relies on ATTNUM.  InitPostgres() initializes ATTNUM, so it's reliable.
+        */
+       if (!(cache->id == TYPEOID || cache->id == ATTNUM) ||
+               IsTransactionState())
+               AssertCouldGetRelation();
+       else
+               Assert(cache->cc_tupdesc != NULL);
+#endif
+
+       if (unlikely(cache->cc_tupdesc == NULL))
+               CatalogCacheInitializeCache(cache);
+}
+
 /*
  *             CatalogCacheInitializeCache
  *
  * This function does final initialization of a catcache: obtain the tuple
- * descriptor and set up the hash and equality function links.  We assume
- * that the relcache entry can be opened at this point!
+ * descriptor and set up the hash and equality function links.
  */
 #ifdef CACHEDEBUG
 #define CatalogCacheInitializeCache_DEBUG1 \
@@ -1139,8 +1168,7 @@ CatalogCacheInitializeCache(CatCache *cache)
 void
 InitCatCachePhase2(CatCache *cache, bool touch_index)
 {
-       if (cache->cc_tupdesc == NULL)
-               CatalogCacheInitializeCache(cache);
+       ConditionalCatalogCacheInitializeCache(cache);
 
        if (touch_index &&
                cache->id != AMOID &&
@@ -1319,16 +1347,12 @@ SearchCatCacheInternal(CatCache *cache,
        dlist_head *bucket;
        CatCTup    *ct;
 
-       /* Make sure we're in an xact, even if this ends up being a cache hit */
-       Assert(IsTransactionState());
-
        Assert(cache->cc_nkeys == nkeys);
 
        /*
         * one-time startup overhead for each cache
         */
-       if (unlikely(cache->cc_tupdesc == NULL))
-               CatalogCacheInitializeCache(cache);
+       ConditionalCatalogCacheInitializeCache(cache);
 
 #ifdef CATCACHE_STATS
        cache->cc_searches++;
@@ -1607,8 +1631,7 @@ GetCatCacheHashValue(CatCache *cache,
        /*
         * one-time startup overhead for each cache
         */
-       if (cache->cc_tupdesc == NULL)
-               CatalogCacheInitializeCache(cache);
+       ConditionalCatalogCacheInitializeCache(cache);
 
        /*
         * calculate the hash value
@@ -1659,8 +1682,7 @@ SearchCatCacheList(CatCache *cache,
        /*
         * one-time startup overhead for each cache
         */
-       if (unlikely(cache->cc_tupdesc == NULL))
-               CatalogCacheInitializeCache(cache);
+       ConditionalCatalogCacheInitializeCache(cache);
 
        Assert(nkeys > 0 && nkeys < cache->cc_nkeys);
 
@@ -2314,8 +2336,7 @@ PrepareToInvalidateCacheTuple(Relation relation,
                        continue;
 
                /* Just in case cache hasn't finished initialization yet... */
-               if (ccp->cc_tupdesc == NULL)
-                       CatalogCacheInitializeCache(ccp);
+               ConditionalCatalogCacheInitializeCache(ccp);
 
                hashvalue = CatalogCacheComputeTupleHashValue(ccp, ccp->cc_nkeys, tuple);
                dbid = ccp->cc_relisshared ? (Oid) 0 : MyDatabaseId;
index 4d3dd6cd15a55a9f06504a5309aad56c1282e5f9..140848c2d73f5f45b49e5004201d7caea962ff7a 100644 (file)
@@ -631,7 +631,8 @@ PrepareInvalidationState(void)
 {
        TransInvalidationInfo *myInfo;
 
-       Assert(IsTransactionState());
+       /* PrepareToInvalidateCacheTuple() needs relcache */
+       AssertCouldGetRelation();
        /* Can't queue transactional message while collecting inplace messages. */
        Assert(inplaceInvalInfo == NULL);
 
@@ -700,7 +701,7 @@ PrepareInplaceInvalidationState(void)
 {
        InvalidationInfo *myInfo;
 
-       Assert(IsTransactionState());
+       AssertCouldGetRelation();
        /* limit of one inplace update under assembly */
        Assert(inplaceInvalInfo == NULL);
 
@@ -863,6 +864,12 @@ InvalidateSystemCaches(void)
 void
 AcceptInvalidationMessages(void)
 {
+#ifdef USE_ASSERT_CHECKING
+       /* message handlers shall access catalogs only during transactions */
+       if (IsTransactionState())
+               AssertCouldGetRelation();
+#endif
+
        ReceiveSharedInvalidMessages(LocalExecuteInvalidationMessage,
                                                                 InvalidateSystemCaches);
 
@@ -1326,6 +1333,9 @@ CacheInvalidateHeapTupleCommon(Relation relation,
        Oid                     databaseId;
        Oid                     relationId;
 
+       /* PrepareToInvalidateCacheTuple() needs relcache */
+       AssertCouldGetRelation();
+
        /* Do nothing during bootstrap */
        if (IsBootstrapProcessingMode())
                return;
index 34c3cfa8e8ccab395d207f70c2b1a8f9f7bf3685..3140f00ea44d9bb336b0d7250bef14dba96eb789 100644 (file)
@@ -2028,6 +2028,23 @@ formrdesc(const char *relationName, Oid relationReltype,
        relation->rd_isvalid = true;
 }
 
+#ifdef USE_ASSERT_CHECKING
+/*
+ *             AssertCouldGetRelation
+ *
+ *             Check safety of calling RelationIdGetRelation().
+ *
+ *             In code that reads catalogs in the event of a cache miss, call this
+ *             before checking the cache.
+ */
+void
+AssertCouldGetRelation(void)
+{
+       Assert(IsTransactionState());
+       AssertBufferLocksPermitCatalogRead();
+}
+#endif
+
 
 /* ----------------------------------------------------------------
  *                              Relation Descriptor Lookup Interface
@@ -2055,8 +2072,7 @@ RelationIdGetRelation(Oid relationId)
 {
        Relation        rd;
 
-       /* Make sure we're in an xact, even if this ends up being a cache hit */
-       Assert(IsTransactionState());
+       AssertCouldGetRelation();
 
        /*
         * first try to find reldesc in the cache
index 1ccdf9da5b0f2915063b83700e8e806eb54f992b..33ad7ae77747b212a6b6f4fcc3cfcacde1d0f8fe 100644 (file)
@@ -39,6 +39,7 @@
 #include "mb/pg_wchar.h"
 #include "utils/builtins.h"
 #include "utils/memutils.h"
+#include "utils/relcache.h"
 #include "utils/syscache.h"
 #include "varatt.h"
 
@@ -311,7 +312,7 @@ InitializeClientEncoding(void)
        {
                Oid                     utf8_to_server_proc;
 
-               Assert(IsTransactionState());
+               AssertCouldGetRelation();
                utf8_to_server_proc =
                        FindDefaultConversionProc(PG_UTF8,
                                                                          current_server_encoding);
index b379c76e2732e669e9d321b70bd480c68850e8ec..166524c50e06c1d62763e16c352cfc89329cb4e9 100644 (file)
@@ -205,6 +205,9 @@ extern Buffer ExtendBufferedRelTo(BufferManagerRelation bmr,
 
 extern void InitBufferPoolAccess(void);
 extern void AtEOXact_Buffers(bool isCommit);
+#ifdef USE_ASSERT_CHECKING
+extern void AssertBufferLocksPermitCatalogRead(void);
+#endif
 extern void PrintBufferLeakWarning(Buffer buffer);
 extern void CheckPointBuffers(int flags);
 extern BlockNumber BufferGetBlockNumber(Buffer buffer);
index 34169e5889e4f6d369b1e066e9cac1987c8489f4..cab38447d48cc01880b321d421862c4acd725968 100644 (file)
@@ -131,6 +131,8 @@ extern bool LWLockAcquireOrWait(LWLock *lock, LWLockMode mode);
 extern void LWLockRelease(LWLock *lock);
 extern void LWLockReleaseClearVar(LWLock *lock, uint64 *valptr, uint64 val);
 extern void LWLockReleaseAll(void);
+extern void ForEachLWLockHeldByMe(void (*callback) (LWLock *, LWLockMode, void *),
+                                                                 void *context);
 extern bool LWLockHeldByMe(LWLock *lock);
 extern bool LWLockAnyHeldByMe(LWLock *lock, int nlocks, size_t stride);
 extern bool LWLockHeldByMeInMode(LWLock *lock, LWLockMode mode);
index 38524641f470414ef4a9f844d2702b1b55677c8b..10a91c986d1f1faf3aba3729fea61f19a2ec44b5 100644 (file)
@@ -37,6 +37,14 @@ typedef Relation *RelationPtr;
 /*
  * Routines to open (lookup) and close a relcache entry
  */
+#ifdef USE_ASSERT_CHECKING
+extern void AssertCouldGetRelation(void);
+#else
+static inline void
+AssertCouldGetRelation(void)
+{
+}
+#endif
 extern Relation RelationIdGetRelation(Oid relationId);
 extern void RelationClose(Relation relation);